Documentation tweaks.
[official-gcc.git] / gcc / doc / invoke.texi
blob4dc935d98c0f8d1e4879ce5112e10c33bb536695
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 struct foo
6830   char a[] = "abcd1234";
6831   strcpy (a, a + 4);
6833 @end smallexample
6834 The @option{-Wrestrict} is included in @option{-Wall}.
6836 @item -Wnested-externs @r{(C and Objective-C only)}
6837 @opindex Wnested-externs
6838 @opindex Wno-nested-externs
6839 Warn if an @code{extern} declaration is encountered within a function.
6841 @item -Wno-inherited-variadic-ctor
6842 @opindex Winherited-variadic-ctor
6843 @opindex Wno-inherited-variadic-ctor
6844 Suppress warnings about use of C++11 inheriting constructors when the
6845 base class inherited from has a C variadic constructor; the warning is
6846 on by default because the ellipsis is not inherited.
6848 @item -Winline
6849 @opindex Winline
6850 @opindex Wno-inline
6851 Warn if a function that is declared as inline cannot be inlined.
6852 Even with this option, the compiler does not warn about failures to
6853 inline functions declared in system headers.
6855 The compiler uses a variety of heuristics to determine whether or not
6856 to inline a function.  For example, the compiler takes into account
6857 the size of the function being inlined and the amount of inlining
6858 that has already been done in the current function.  Therefore,
6859 seemingly insignificant changes in the source program can cause the
6860 warnings produced by @option{-Winline} to appear or disappear.
6862 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6863 @opindex Wno-invalid-offsetof
6864 @opindex Winvalid-offsetof
6865 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6866 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6867 to a non-standard-layout type is undefined.  In existing C++ implementations,
6868 however, @code{offsetof} typically gives meaningful results.
6869 This flag is for users who are aware that they are
6870 writing nonportable code and who have deliberately chosen to ignore the
6871 warning about it.
6873 The restrictions on @code{offsetof} may be relaxed in a future version
6874 of the C++ standard.
6876 @item -Wint-in-bool-context
6877 @opindex Wint-in-bool-context
6878 @opindex Wno-int-in-bool-context
6879 Warn for suspicious use of integer values where boolean values are expected,
6880 such as conditional expressions (?:) using non-boolean integer constants in
6881 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6882 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6883 for all kinds of multiplications regardless of the data type.
6884 This warning is enabled by @option{-Wall}.
6886 @item -Wno-int-to-pointer-cast
6887 @opindex Wno-int-to-pointer-cast
6888 @opindex Wint-to-pointer-cast
6889 Suppress warnings from casts to pointer type of an integer of a
6890 different size. In C++, casting to a pointer type of smaller size is
6891 an error. @option{Wint-to-pointer-cast} is enabled by default.
6894 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6895 @opindex Wno-pointer-to-int-cast
6896 @opindex Wpointer-to-int-cast
6897 Suppress warnings from casts from a pointer to an integer type of a
6898 different size.
6900 @item -Winvalid-pch
6901 @opindex Winvalid-pch
6902 @opindex Wno-invalid-pch
6903 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6904 the search path but cannot be used.
6906 @item -Wlong-long
6907 @opindex Wlong-long
6908 @opindex Wno-long-long
6909 Warn if @code{long long} type is used.  This is enabled by either
6910 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6911 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6913 @item -Wvariadic-macros
6914 @opindex Wvariadic-macros
6915 @opindex Wno-variadic-macros
6916 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6917 alternate syntax is used in ISO C99 mode.  This is enabled by either
6918 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6919 messages, use @option{-Wno-variadic-macros}.
6921 @item -Wvarargs
6922 @opindex Wvarargs
6923 @opindex Wno-varargs
6924 Warn upon questionable usage of the macros used to handle variable
6925 arguments like @code{va_start}.  This is default.  To inhibit the
6926 warning messages, use @option{-Wno-varargs}.
6928 @item -Wvector-operation-performance
6929 @opindex Wvector-operation-performance
6930 @opindex Wno-vector-operation-performance
6931 Warn if vector operation is not implemented via SIMD capabilities of the
6932 architecture.  Mainly useful for the performance tuning.
6933 Vector operation can be implemented @code{piecewise}, which means that the
6934 scalar operation is performed on every vector element; 
6935 @code{in parallel}, which means that the vector operation is implemented
6936 using scalars of wider type, which normally is more performance efficient;
6937 and @code{as a single scalar}, which means that vector fits into a
6938 scalar type.
6940 @item -Wno-virtual-move-assign
6941 @opindex Wvirtual-move-assign
6942 @opindex Wno-virtual-move-assign
6943 Suppress warnings about inheriting from a virtual base with a
6944 non-trivial C++11 move assignment operator.  This is dangerous because
6945 if the virtual base is reachable along more than one path, it is
6946 moved multiple times, which can mean both objects end up in the
6947 moved-from state.  If the move assignment operator is written to avoid
6948 moving from a moved-from object, this warning can be disabled.
6950 @item -Wvla
6951 @opindex Wvla
6952 @opindex Wno-vla
6953 Warn if a variable-length array is used in the code.
6954 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6955 the variable-length array.
6957 @item -Wvla-larger-than=@var{n}
6958 If this option is used, the compiler will warn on uses of
6959 variable-length arrays where the size is either unbounded, or bounded
6960 by an argument that can be larger than @var{n} bytes.  This is similar
6961 to how @option{-Walloca-larger-than=@var{n}} works, but with
6962 variable-length arrays.
6964 Note that GCC may optimize small variable-length arrays of a known
6965 value into plain arrays, so this warning may not get triggered for
6966 such arrays.
6968 This warning is not enabled by @option{-Wall}, and is only active when
6969 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6971 See also @option{-Walloca-larger-than=@var{n}}.
6973 @item -Wvolatile-register-var
6974 @opindex Wvolatile-register-var
6975 @opindex Wno-volatile-register-var
6976 Warn if a register variable is declared volatile.  The volatile
6977 modifier does not inhibit all optimizations that may eliminate reads
6978 and/or writes to register variables.  This warning is enabled by
6979 @option{-Wall}.
6981 @item -Wdisabled-optimization
6982 @opindex Wdisabled-optimization
6983 @opindex Wno-disabled-optimization
6984 Warn if a requested optimization pass is disabled.  This warning does
6985 not generally indicate that there is anything wrong with your code; it
6986 merely indicates that GCC's optimizers are unable to handle the code
6987 effectively.  Often, the problem is that your code is too big or too
6988 complex; GCC refuses to optimize programs when the optimization
6989 itself is likely to take inordinate amounts of time.
6991 @item -Wpointer-sign @r{(C and Objective-C only)}
6992 @opindex Wpointer-sign
6993 @opindex Wno-pointer-sign
6994 Warn for pointer argument passing or assignment with different signedness.
6995 This option is only supported for C and Objective-C@.  It is implied by
6996 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6997 @option{-Wno-pointer-sign}.
6999 @item -Wstack-protector
7000 @opindex Wstack-protector
7001 @opindex Wno-stack-protector
7002 This option is only active when @option{-fstack-protector} is active.  It
7003 warns about functions that are not protected against stack smashing.
7005 @item -Woverlength-strings
7006 @opindex Woverlength-strings
7007 @opindex Wno-overlength-strings
7008 Warn about string constants that are longer than the ``minimum
7009 maximum'' length specified in the C standard.  Modern compilers
7010 generally allow string constants that are much longer than the
7011 standard's minimum limit, but very portable programs should avoid
7012 using longer strings.
7014 The limit applies @emph{after} string constant concatenation, and does
7015 not count the trailing NUL@.  In C90, the limit was 509 characters; in
7016 C99, it was raised to 4095.  C++98 does not specify a normative
7017 minimum maximum, so we do not diagnose overlength strings in C++@.
7019 This option is implied by @option{-Wpedantic}, and can be disabled with
7020 @option{-Wno-overlength-strings}.
7022 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
7023 @opindex Wunsuffixed-float-constants
7025 Issue a warning for any floating constant that does not have
7026 a suffix.  When used together with @option{-Wsystem-headers} it
7027 warns about such constants in system header files.  This can be useful
7028 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
7029 from the decimal floating-point extension to C99.
7031 @item -Wno-designated-init @r{(C and Objective-C only)}
7032 Suppress warnings when a positional initializer is used to initialize
7033 a structure that has been marked with the @code{designated_init}
7034 attribute.
7036 @item -Whsa
7037 Issue a warning when HSAIL cannot be emitted for the compiled function or
7038 OpenMP construct.
7040 @end table
7042 @node Debugging Options
7043 @section Options for Debugging Your Program
7044 @cindex options, debugging
7045 @cindex debugging information options
7047 To tell GCC to emit extra information for use by a debugger, in almost 
7048 all cases you need only to add @option{-g} to your other options.
7050 GCC allows you to use @option{-g} with
7051 @option{-O}.  The shortcuts taken by optimized code may occasionally
7052 be surprising: some variables you declared may not exist
7053 at all; flow of control may briefly move where you did not expect it;
7054 some statements may not be executed because they compute constant
7055 results or their values are already at hand; some statements may
7056 execute in different places because they have been moved out of loops.
7057 Nevertheless it is possible to debug optimized output.  This makes
7058 it reasonable to use the optimizer for programs that might have bugs.
7060 If you are not using some other optimization option, consider
7061 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
7062 With no @option{-O} option at all, some compiler passes that collect
7063 information useful for debugging do not run at all, so that
7064 @option{-Og} may result in a better debugging experience.
7066 @table @gcctabopt
7067 @item -g
7068 @opindex g
7069 Produce debugging information in the operating system's native format
7070 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
7071 information.
7073 On most systems that use stabs format, @option{-g} enables use of extra
7074 debugging information that only GDB can use; this extra information
7075 makes debugging work better in GDB but probably makes other debuggers
7076 crash or
7077 refuse to read the program.  If you want to control for certain whether
7078 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
7079 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
7081 @item -ggdb
7082 @opindex ggdb
7083 Produce debugging information for use by GDB@.  This means to use the
7084 most expressive format available (DWARF, stabs, or the native format
7085 if neither of those are supported), including GDB extensions if at all
7086 possible.
7088 @item -gdwarf
7089 @itemx -gdwarf-@var{version}
7090 @opindex gdwarf
7091 Produce debugging information in DWARF format (if that is supported).
7092 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7093 for most targets is 4.  DWARF Version 5 is only experimental.
7095 Note that with DWARF Version 2, some ports require and always
7096 use some non-conflicting DWARF 3 extensions in the unwind tables.
7098 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7099 for maximum benefit.
7101 GCC no longer supports DWARF Version 1, which is substantially
7102 different than Version 2 and later.  For historical reasons, some
7103 other DWARF-related options such as
7104 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7105 in their names, but apply to all currently-supported versions of DWARF.
7107 @item -gstabs
7108 @opindex gstabs
7109 Produce debugging information in stabs format (if that is supported),
7110 without GDB extensions.  This is the format used by DBX on most BSD
7111 systems.  On MIPS, Alpha and System V Release 4 systems this option
7112 produces stabs debugging output that is not understood by DBX@.
7113 On System V Release 4 systems this option requires the GNU assembler.
7115 @item -gstabs+
7116 @opindex gstabs+
7117 Produce debugging information in stabs format (if that is supported),
7118 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7119 use of these extensions is likely to make other debuggers crash or
7120 refuse to read the program.
7122 @item -gxcoff
7123 @opindex gxcoff
7124 Produce debugging information in XCOFF format (if that is supported).
7125 This is the format used by the DBX debugger on IBM RS/6000 systems.
7127 @item -gxcoff+
7128 @opindex gxcoff+
7129 Produce debugging information in XCOFF format (if that is supported),
7130 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7131 use of these extensions is likely to make other debuggers crash or
7132 refuse to read the program, and may cause assemblers other than the GNU
7133 assembler (GAS) to fail with an error.
7135 @item -gvms
7136 @opindex gvms
7137 Produce debugging information in Alpha/VMS debug format (if that is
7138 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7140 @item -g@var{level}
7141 @itemx -ggdb@var{level}
7142 @itemx -gstabs@var{level}
7143 @itemx -gxcoff@var{level}
7144 @itemx -gvms@var{level}
7145 Request debugging information and also use @var{level} to specify how
7146 much information.  The default level is 2.
7148 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7149 @option{-g}.
7151 Level 1 produces minimal information, enough for making backtraces in
7152 parts of the program that you don't plan to debug.  This includes
7153 descriptions of functions and external variables, and line number
7154 tables, but no information about local variables.
7156 Level 3 includes extra information, such as all the macro definitions
7157 present in the program.  Some debuggers support macro expansion when
7158 you use @option{-g3}.
7160 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7161 confusion with @option{-gdwarf-@var{level}}.
7162 Instead use an additional @option{-g@var{level}} option to change the
7163 debug level for DWARF.
7165 @item -feliminate-unused-debug-symbols
7166 @opindex feliminate-unused-debug-symbols
7167 Produce debugging information in stabs format (if that is supported),
7168 for only symbols that are actually used.
7170 @item -femit-class-debug-always
7171 @opindex femit-class-debug-always
7172 Instead of emitting debugging information for a C++ class in only one
7173 object file, emit it in all object files using the class.  This option
7174 should be used only with debuggers that are unable to handle the way GCC
7175 normally emits debugging information for classes because using this
7176 option increases the size of debugging information by as much as a
7177 factor of two.
7179 @item -fno-merge-debug-strings
7180 @opindex fmerge-debug-strings
7181 @opindex fno-merge-debug-strings
7182 Direct the linker to not merge together strings in the debugging
7183 information that are identical in different object files.  Merging is
7184 not supported by all assemblers or linkers.  Merging decreases the size
7185 of the debug information in the output file at the cost of increasing
7186 link processing time.  Merging is enabled by default.
7188 @item -fdebug-prefix-map=@var{old}=@var{new}
7189 @opindex fdebug-prefix-map
7190 When compiling files residing in directory @file{@var{old}}, record
7191 debugging information describing them as if the files resided in
7192 directory @file{@var{new}} instead.  This can be used to replace a
7193 build-time path with an install-time path in the debug info.  It can
7194 also be used to change an absolute path to a relative path by using
7195 @file{.} for @var{new}.  This can give more reproducible builds, which
7196 are location independent, but may require an extra command to tell GDB
7197 where to find the source files. See also @option{-ffile-prefix-map}.
7199 @item -fvar-tracking
7200 @opindex fvar-tracking
7201 Run variable tracking pass.  It computes where variables are stored at each
7202 position in code.  Better debugging information is then generated
7203 (if the debugging information format supports this information).
7205 It is enabled by default when compiling with optimization (@option{-Os},
7206 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7207 the debug info format supports it.
7209 @item -fvar-tracking-assignments
7210 @opindex fvar-tracking-assignments
7211 @opindex fno-var-tracking-assignments
7212 Annotate assignments to user variables early in the compilation and
7213 attempt to carry the annotations over throughout the compilation all the
7214 way to the end, in an attempt to improve debug information while
7215 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7217 It can be enabled even if var-tracking is disabled, in which case
7218 annotations are created and maintained, but discarded at the end.
7219 By default, this flag is enabled together with @option{-fvar-tracking},
7220 except when selective scheduling is enabled.
7222 @item -gsplit-dwarf
7223 @opindex gsplit-dwarf
7224 Separate as much DWARF debugging information as possible into a
7225 separate output file with the extension @file{.dwo}.  This option allows
7226 the build system to avoid linking files with debug information.  To
7227 be useful, this option requires a debugger capable of reading @file{.dwo}
7228 files.
7230 @item -gpubnames
7231 @opindex gpubnames
7232 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7234 @item -ggnu-pubnames
7235 @opindex ggnu-pubnames
7236 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7237 suitable for conversion into a GDB@ index.  This option is only useful
7238 with a linker that can produce GDB@ index version 7.
7240 @item -fdebug-types-section
7241 @opindex fdebug-types-section
7242 @opindex fno-debug-types-section
7243 When using DWARF Version 4 or higher, type DIEs can be put into
7244 their own @code{.debug_types} section instead of making them part of the
7245 @code{.debug_info} section.  It is more efficient to put them in a separate
7246 comdat sections since the linker can then remove duplicates.
7247 But not all DWARF consumers support @code{.debug_types} sections yet
7248 and on some objects @code{.debug_types} produces larger instead of smaller
7249 debugging information.
7251 @item -grecord-gcc-switches
7252 @itemx -gno-record-gcc-switches
7253 @opindex grecord-gcc-switches
7254 @opindex gno-record-gcc-switches
7255 This switch causes the command-line options used to invoke the
7256 compiler that may affect code generation to be appended to the
7257 DW_AT_producer attribute in DWARF debugging information.  The options
7258 are concatenated with spaces separating them from each other and from
7259 the compiler version.  
7260 It is enabled by default.
7261 See also @option{-frecord-gcc-switches} for another
7262 way of storing compiler options into the object file.  
7264 @item -gstrict-dwarf
7265 @opindex gstrict-dwarf
7266 Disallow using extensions of later DWARF standard version than selected
7267 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7268 DWARF extensions from later standard versions is allowed.
7270 @item -gno-strict-dwarf
7271 @opindex gno-strict-dwarf
7272 Allow using extensions of later DWARF standard version than selected with
7273 @option{-gdwarf-@var{version}}.
7275 @item -gas-loc-support
7276 @opindex gas-loc-support
7277 Inform the compiler that the assembler supports @code{.loc} directives.
7278 It may then use them for the assembler to generate DWARF2+ line number
7279 tables.
7281 This is generally desirable, because assembler-generated line-number
7282 tables are a lot more compact than those the compiler can generate
7283 itself.
7285 This option will be enabled by default if, at GCC configure time, the
7286 assembler was found to support such directives.
7288 @item -gno-as-loc-support
7289 @opindex gno-as-loc-support
7290 Force GCC to generate DWARF2+ line number tables internally, if DWARF2+
7291 line number tables are to be generated.
7293 @item gas-locview-support
7294 @opindex gas-locview-support
7295 Inform the compiler that the assembler supports @code{view} assignment
7296 and reset assertion checking in @code{.loc} directives.
7298 This option will be enabled by default if, at GCC configure time, the
7299 assembler was found to support them.
7301 @item gno-as-locview-support
7302 Force GCC to assign view numbers internally, if
7303 @option{-gvariable-location-views} are explicitly requested.
7305 @item -gcolumn-info
7306 @itemx -gno-column-info
7307 @opindex gcolumn-info
7308 @opindex gno-column-info
7309 Emit location column information into DWARF debugging information, rather
7310 than just file and line.
7311 This option is enabled by default.
7313 @item -gstatement-frontiers
7314 @itemx -gno-statement-frontiers
7315 @opindex gstatement-frontiers
7316 @opindex gno-statement-frontiers
7317 This option causes GCC to create markers in the internal representation
7318 at the beginning of statements, and to keep them roughly in place
7319 throughout compilation, using them to guide the output of @code{is_stmt}
7320 markers in the line number table.  This is enabled by default when
7321 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7322 @dots{}), and outputting DWARF 2 debug information at the normal level.
7324 @item -gvariable-location-views
7325 @itemx -gvariable-location-views=incompat5
7326 @itemx -gno-variable-location-views
7327 @opindex gvariable-location-views
7328 @opindex gvariable-location-views=incompat5
7329 @opindex gno-variable-location-views
7330 Augment variable location lists with progressive view numbers implied
7331 from the line number table.  This enables debug information consumers to
7332 inspect state at certain points of the program, even if no instructions
7333 associated with the corresponding source locations are present at that
7334 point.  If the assembler lacks support for view numbers in line number
7335 tables, this will cause the compiler to emit the line number table,
7336 which generally makes them somewhat less compact.  The augmented line
7337 number tables and location lists are fully backward-compatible, so they
7338 can be consumed by debug information consumers that are not aware of
7339 these augmentations, but they won't derive any benefit from them either.
7341 This is enabled by default when outputting DWARF 2 debug information at
7342 the normal level, as long as there is assembler support,
7343 @option{-fvar-tracking-assignments} is enabled and
7344 @option{-gstrict-dwarf} is not.  When assembler support is not
7345 available, this may still be enabled, but it will force GCC to output
7346 internal line number tables, and if
7347 @option{-ginternal-reset-location-views} is not enabled, that will most
7348 certainly lead to silently mismatching location views.
7350 There is a proposed representation for view numbers that is not backward
7351 compatible with the location list format introduced in DWARF 5, that can
7352 be enabled with @option{-gvariable-location-views=incompat5}.  This
7353 option may be removed in the future, is only provided as a reference
7354 implementation of the proposed representation.  Debug information
7355 consumers are not expected to support this extended format, and they
7356 would be rendered unable to decode location lists using it.
7358 @item -ginternal-reset-location-views
7359 @itemx -gnointernal-reset-location-views
7360 @opindex ginternal-reset-location-views
7361 @opindex gno-internal-reset-location-views
7362 Attempt to determine location views that can be omitted from location
7363 view lists.  This requires the compiler to have very accurate insn
7364 length estimates, which isn't always the case, and it may cause
7365 incorrect view lists to be generated silently when using an assembler
7366 that does not support location view lists.  The GNU assembler will flag
7367 any such error as a @code{view number mismatch}.  This is only enabled
7368 on ports that define a reliable estimation function.
7370 @item -ginline-points
7371 @itemx -gno-inline-points
7372 @opindex ginline-points
7373 @opindex gno-inline-points
7374 Generate extended debug information for inlined functions.  Location
7375 view tracking markers are inserted at inlined entry points, so that
7376 address and view numbers can be computed and output in debug
7377 information.  This can be enabled independently of location views, in
7378 which case the view numbers won't be output, but it can only be enabled
7379 along with statement frontiers, and it is only enabled by default if
7380 location views are enabled.
7382 @item -gz@r{[}=@var{type}@r{]}
7383 @opindex gz
7384 Produce compressed debug sections in DWARF format, if that is supported.
7385 If @var{type} is not given, the default type depends on the capabilities
7386 of the assembler and linker used.  @var{type} may be one of
7387 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7388 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7389 compression in traditional GNU format).  If the linker doesn't support
7390 writing compressed debug sections, the option is rejected.  Otherwise,
7391 if the assembler does not support them, @option{-gz} is silently ignored
7392 when producing object files.
7394 @item -femit-struct-debug-baseonly
7395 @opindex femit-struct-debug-baseonly
7396 Emit debug information for struct-like types
7397 only when the base name of the compilation source file
7398 matches the base name of file in which the struct is defined.
7400 This option substantially reduces the size of debugging information,
7401 but at significant potential loss in type information to the debugger.
7402 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7403 See @option{-femit-struct-debug-detailed} for more detailed control.
7405 This option works only with DWARF debug output.
7407 @item -femit-struct-debug-reduced
7408 @opindex femit-struct-debug-reduced
7409 Emit debug information for struct-like types
7410 only when the base name of the compilation source file
7411 matches the base name of file in which the type is defined,
7412 unless the struct is a template or defined in a system header.
7414 This option significantly reduces the size of debugging information,
7415 with some potential loss in type information to the debugger.
7416 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7417 See @option{-femit-struct-debug-detailed} for more detailed control.
7419 This option works only with DWARF debug output.
7421 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7422 @opindex femit-struct-debug-detailed
7423 Specify the struct-like types
7424 for which the compiler generates debug information.
7425 The intent is to reduce duplicate struct debug information
7426 between different object files within the same program.
7428 This option is a detailed version of
7429 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7430 which serves for most needs.
7432 A specification has the syntax@*
7433 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7435 The optional first word limits the specification to
7436 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7437 A struct type is used directly when it is the type of a variable, member.
7438 Indirect uses arise through pointers to structs.
7439 That is, when use of an incomplete struct is valid, the use is indirect.
7440 An example is
7441 @samp{struct one direct; struct two * indirect;}.
7443 The optional second word limits the specification to
7444 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7445 Generic structs are a bit complicated to explain.
7446 For C++, these are non-explicit specializations of template classes,
7447 or non-template classes within the above.
7448 Other programming languages have generics,
7449 but @option{-femit-struct-debug-detailed} does not yet implement them.
7451 The third word specifies the source files for those
7452 structs for which the compiler should emit debug information.
7453 The values @samp{none} and @samp{any} have the normal meaning.
7454 The value @samp{base} means that
7455 the base of name of the file in which the type declaration appears
7456 must match the base of the name of the main compilation file.
7457 In practice, this means that when compiling @file{foo.c}, debug information
7458 is generated for types declared in that file and @file{foo.h},
7459 but not other header files.
7460 The value @samp{sys} means those types satisfying @samp{base}
7461 or declared in system or compiler headers.
7463 You may need to experiment to determine the best settings for your application.
7465 The default is @option{-femit-struct-debug-detailed=all}.
7467 This option works only with DWARF debug output.
7469 @item -fno-dwarf2-cfi-asm
7470 @opindex fdwarf2-cfi-asm
7471 @opindex fno-dwarf2-cfi-asm
7472 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7473 instead of using GAS @code{.cfi_*} directives.
7475 @item -fno-eliminate-unused-debug-types
7476 @opindex feliminate-unused-debug-types
7477 @opindex fno-eliminate-unused-debug-types
7478 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7479 output for types that are nowhere used in the source file being compiled.
7480 Sometimes it is useful to have GCC emit debugging
7481 information for all types declared in a compilation
7482 unit, regardless of whether or not they are actually used
7483 in that compilation unit, for example 
7484 if, in the debugger, you want to cast a value to a type that is
7485 not actually used in your program (but is declared).  More often,
7486 however, this results in a significant amount of wasted space.
7487 @end table
7489 @node Optimize Options
7490 @section Options That Control Optimization
7491 @cindex optimize options
7492 @cindex options, optimization
7494 These options control various sorts of optimizations.
7496 Without any optimization option, the compiler's goal is to reduce the
7497 cost of compilation and to make debugging produce the expected
7498 results.  Statements are independent: if you stop the program with a
7499 breakpoint between statements, you can then assign a new value to any
7500 variable or change the program counter to any other statement in the
7501 function and get exactly the results you expect from the source
7502 code.
7504 Turning on optimization flags makes the compiler attempt to improve
7505 the performance and/or code size at the expense of compilation time
7506 and possibly the ability to debug the program.
7508 The compiler performs optimization based on the knowledge it has of the
7509 program.  Compiling multiple files at once to a single output file mode allows
7510 the compiler to use information gained from all of the files when compiling
7511 each of them.
7513 Not all optimizations are controlled directly by a flag.  Only
7514 optimizations that have a flag are listed in this section.
7516 Most optimizations are only enabled if an @option{-O} level is set on
7517 the command line.  Otherwise they are disabled, even if individual
7518 optimization flags are specified.
7520 Depending on the target and how GCC was configured, a slightly different
7521 set of optimizations may be enabled at each @option{-O} level than
7522 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7523 to find out the exact set of optimizations that are enabled at each level.
7524 @xref{Overall Options}, for examples.
7526 @table @gcctabopt
7527 @item -O
7528 @itemx -O1
7529 @opindex O
7530 @opindex O1
7531 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7532 more memory for a large function.
7534 With @option{-O}, the compiler tries to reduce code size and execution
7535 time, without performing any optimizations that take a great deal of
7536 compilation time.
7538 @option{-O} turns on the following optimization flags:
7539 @gccoptlist{
7540 -fauto-inc-dec @gol
7541 -fbranch-count-reg @gol
7542 -fcombine-stack-adjustments @gol
7543 -fcompare-elim @gol
7544 -fcprop-registers @gol
7545 -fdce @gol
7546 -fdefer-pop @gol
7547 -fdelayed-branch @gol
7548 -fdse @gol
7549 -fforward-propagate @gol
7550 -fguess-branch-probability @gol
7551 -fif-conversion2 @gol
7552 -fif-conversion @gol
7553 -finline-functions-called-once @gol
7554 -fipa-pure-const @gol
7555 -fipa-profile @gol
7556 -fipa-reference @gol
7557 -fmerge-constants @gol
7558 -fmove-loop-invariants @gol
7559 -fomit-frame-pointer @gol
7560 -freorder-blocks @gol
7561 -fshrink-wrap @gol
7562 -fshrink-wrap-separate @gol
7563 -fsplit-wide-types @gol
7564 -fssa-backprop @gol
7565 -fssa-phiopt @gol
7566 -ftree-bit-ccp @gol
7567 -ftree-ccp @gol
7568 -ftree-ch @gol
7569 -ftree-coalesce-vars @gol
7570 -ftree-copy-prop @gol
7571 -ftree-dce @gol
7572 -ftree-dominator-opts @gol
7573 -ftree-dse @gol
7574 -ftree-forwprop @gol
7575 -ftree-fre @gol
7576 -ftree-phiprop @gol
7577 -ftree-sink @gol
7578 -ftree-slsr @gol
7579 -ftree-sra @gol
7580 -ftree-pta @gol
7581 -ftree-ter @gol
7582 -funit-at-a-time}
7584 @item -O2
7585 @opindex O2
7586 Optimize even more.  GCC performs nearly all supported optimizations
7587 that do not involve a space-speed tradeoff.
7588 As compared to @option{-O}, this option increases both compilation time
7589 and the performance of the generated code.
7591 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7592 also turns on the following optimization flags:
7593 @gccoptlist{-fthread-jumps @gol
7594 -falign-functions  -falign-jumps @gol
7595 -falign-loops  -falign-labels @gol
7596 -fcaller-saves @gol
7597 -fcrossjumping @gol
7598 -fcse-follow-jumps  -fcse-skip-blocks @gol
7599 -fdelete-null-pointer-checks @gol
7600 -fdevirtualize -fdevirtualize-speculatively @gol
7601 -fexpensive-optimizations @gol
7602 -fgcse  -fgcse-lm  @gol
7603 -fhoist-adjacent-loads @gol
7604 -finline-small-functions @gol
7605 -findirect-inlining @gol
7606 -fipa-cp @gol
7607 -fipa-bit-cp @gol
7608 -fipa-vrp @gol
7609 -fipa-sra @gol
7610 -fipa-icf @gol
7611 -fisolate-erroneous-paths-dereference @gol
7612 -flra-remat @gol
7613 -foptimize-sibling-calls @gol
7614 -foptimize-strlen @gol
7615 -fpartial-inlining @gol
7616 -fpeephole2 @gol
7617 -freorder-blocks-algorithm=stc @gol
7618 -freorder-blocks-and-partition -freorder-functions @gol
7619 -frerun-cse-after-loop  @gol
7620 -fsched-interblock  -fsched-spec @gol
7621 -fschedule-insns  -fschedule-insns2 @gol
7622 -fstore-merging @gol
7623 -fstrict-aliasing @gol
7624 -ftree-builtin-call-dce @gol
7625 -ftree-switch-conversion -ftree-tail-merge @gol
7626 -fcode-hoisting @gol
7627 -ftree-pre @gol
7628 -ftree-vrp @gol
7629 -fipa-ra}
7631 Please note the warning under @option{-fgcse} about
7632 invoking @option{-O2} on programs that use computed gotos.
7634 @item -O3
7635 @opindex O3
7636 Optimize yet more.  @option{-O3} turns on all optimizations specified
7637 by @option{-O2} and also turns on the following optimization flags:
7638 @gccoptlist{-finline-functions @gol
7639 -funswitch-loops @gol
7640 -fpredictive-commoning @gol
7641 -fgcse-after-reload @gol
7642 -ftree-loop-vectorize @gol
7643 -ftree-loop-distribution @gol
7644 -ftree-loop-distribute-patterns @gol
7645 -floop-interchange @gol
7646 -fsplit-paths @gol
7647 -ftree-slp-vectorize @gol
7648 -fvect-cost-model @gol
7649 -ftree-partial-pre @gol
7650 -fpeel-loops @gol
7651 -fipa-cp-clone}
7653 @item -O0
7654 @opindex O0
7655 Reduce compilation time and make debugging produce the expected
7656 results.  This is the default.
7658 @item -Os
7659 @opindex Os
7660 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7661 do not typically increase code size.  It also performs further
7662 optimizations designed to reduce code size.
7664 @option{-Os} disables the following optimization flags:
7665 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7666 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7667 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7669 @item -Ofast
7670 @opindex Ofast
7671 Disregard strict standards compliance.  @option{-Ofast} enables all
7672 @option{-O3} optimizations.  It also enables optimizations that are not
7673 valid for all standard-compliant programs.
7674 It turns on @option{-ffast-math} and the Fortran-specific
7675 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7676 specified, and @option{-fno-protect-parens}.
7678 @item -Og
7679 @opindex Og
7680 Optimize debugging experience.  @option{-Og} enables optimizations
7681 that do not interfere with debugging. It should be the optimization
7682 level of choice for the standard edit-compile-debug cycle, offering
7683 a reasonable level of optimization while maintaining fast compilation
7684 and a good debugging experience.
7685 @end table
7687 If you use multiple @option{-O} options, with or without level numbers,
7688 the last such option is the one that is effective.
7690 Options of the form @option{-f@var{flag}} specify machine-independent
7691 flags.  Most flags have both positive and negative forms; the negative
7692 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7693 below, only one of the forms is listed---the one you typically 
7694 use.  You can figure out the other form by either removing @samp{no-}
7695 or adding it.
7697 The following options control specific optimizations.  They are either
7698 activated by @option{-O} options or are related to ones that are.  You
7699 can use the following flags in the rare cases when ``fine-tuning'' of
7700 optimizations to be performed is desired.
7702 @table @gcctabopt
7703 @item -fno-defer-pop
7704 @opindex fno-defer-pop
7705 Always pop the arguments to each function call as soon as that function
7706 returns.  For machines that must pop arguments after a function call,
7707 the compiler normally lets arguments accumulate on the stack for several
7708 function calls and pops them all at once.
7710 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7712 @item -fforward-propagate
7713 @opindex fforward-propagate
7714 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7715 instructions and checks if the result can be simplified.  If loop unrolling
7716 is active, two passes are performed and the second is scheduled after
7717 loop unrolling.
7719 This option is enabled by default at optimization levels @option{-O},
7720 @option{-O2}, @option{-O3}, @option{-Os}.
7722 @item -ffp-contract=@var{style}
7723 @opindex ffp-contract
7724 @option{-ffp-contract=off} disables floating-point expression contraction.
7725 @option{-ffp-contract=fast} enables floating-point expression contraction
7726 such as forming of fused multiply-add operations if the target has
7727 native support for them.
7728 @option{-ffp-contract=on} enables floating-point expression contraction
7729 if allowed by the language standard.  This is currently not implemented
7730 and treated equal to @option{-ffp-contract=off}.
7732 The default is @option{-ffp-contract=fast}.
7734 @item -fomit-frame-pointer
7735 @opindex fomit-frame-pointer
7736 Omit the frame pointer in functions that don't need one.  This avoids the
7737 instructions to save, set up and restore the frame pointer; on many targets
7738 it also makes an extra register available.
7740 On some targets this flag has no effect because the standard calling sequence
7741 always uses a frame pointer, so it cannot be omitted.
7743 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7744 is used in all functions.  Several targets always omit the frame pointer in
7745 leaf functions.
7747 Enabled by default at @option{-O} and higher.
7749 @item -foptimize-sibling-calls
7750 @opindex foptimize-sibling-calls
7751 Optimize sibling and tail recursive calls.
7753 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7755 @item -foptimize-strlen
7756 @opindex foptimize-strlen
7757 Optimize various standard C string functions (e.g. @code{strlen},
7758 @code{strchr} or @code{strcpy}) and
7759 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7761 Enabled at levels @option{-O2}, @option{-O3}.
7763 @item -fno-inline
7764 @opindex fno-inline
7765 Do not expand any functions inline apart from those marked with
7766 the @code{always_inline} attribute.  This is the default when not
7767 optimizing.
7769 Single functions can be exempted from inlining by marking them
7770 with the @code{noinline} attribute.
7772 @item -finline-small-functions
7773 @opindex finline-small-functions
7774 Integrate functions into their callers when their body is smaller than expected
7775 function call code (so overall size of program gets smaller).  The compiler
7776 heuristically decides which functions are simple enough to be worth integrating
7777 in this way.  This inlining applies to all functions, even those not declared
7778 inline.
7780 Enabled at level @option{-O2}.
7782 @item -findirect-inlining
7783 @opindex findirect-inlining
7784 Inline also indirect calls that are discovered to be known at compile
7785 time thanks to previous inlining.  This option has any effect only
7786 when inlining itself is turned on by the @option{-finline-functions}
7787 or @option{-finline-small-functions} options.
7789 Enabled at level @option{-O2}.
7791 @item -finline-functions
7792 @opindex finline-functions
7793 Consider all functions for inlining, even if they are not declared inline.
7794 The compiler heuristically decides which functions are worth integrating
7795 in this way.
7797 If all calls to a given function are integrated, and the function is
7798 declared @code{static}, then the function is normally not output as
7799 assembler code in its own right.
7801 Enabled at level @option{-O3}.
7803 @item -finline-functions-called-once
7804 @opindex finline-functions-called-once
7805 Consider all @code{static} functions called once for inlining into their
7806 caller even if they are not marked @code{inline}.  If a call to a given
7807 function is integrated, then the function is not output as assembler code
7808 in its own right.
7810 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7812 @item -fearly-inlining
7813 @opindex fearly-inlining
7814 Inline functions marked by @code{always_inline} and functions whose body seems
7815 smaller than the function call overhead early before doing
7816 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7817 makes profiling significantly cheaper and usually inlining faster on programs
7818 having large chains of nested wrapper functions.
7820 Enabled by default.
7822 @item -fipa-sra
7823 @opindex fipa-sra
7824 Perform interprocedural scalar replacement of aggregates, removal of
7825 unused parameters and replacement of parameters passed by reference
7826 by parameters passed by value.
7828 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7830 @item -finline-limit=@var{n}
7831 @opindex finline-limit
7832 By default, GCC limits the size of functions that can be inlined.  This flag
7833 allows coarse control of this limit.  @var{n} is the size of functions that
7834 can be inlined in number of pseudo instructions.
7836 Inlining is actually controlled by a number of parameters, which may be
7837 specified individually by using @option{--param @var{name}=@var{value}}.
7838 The @option{-finline-limit=@var{n}} option sets some of these parameters
7839 as follows:
7841 @table @gcctabopt
7842 @item max-inline-insns-single
7843 is set to @var{n}/2.
7844 @item max-inline-insns-auto
7845 is set to @var{n}/2.
7846 @end table
7848 See below for a documentation of the individual
7849 parameters controlling inlining and for the defaults of these parameters.
7851 @emph{Note:} there may be no value to @option{-finline-limit} that results
7852 in default behavior.
7854 @emph{Note:} pseudo instruction represents, in this particular context, an
7855 abstract measurement of function's size.  In no way does it represent a count
7856 of assembly instructions and as such its exact meaning might change from one
7857 release to an another.
7859 @item -fno-keep-inline-dllexport
7860 @opindex fno-keep-inline-dllexport
7861 This is a more fine-grained version of @option{-fkeep-inline-functions},
7862 which applies only to functions that are declared using the @code{dllexport}
7863 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7864 Functions}.
7866 @item -fkeep-inline-functions
7867 @opindex fkeep-inline-functions
7868 In C, emit @code{static} functions that are declared @code{inline}
7869 into the object file, even if the function has been inlined into all
7870 of its callers.  This switch does not affect functions using the
7871 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7872 inline functions into the object file.
7874 @item -fkeep-static-functions
7875 @opindex fkeep-static-functions
7876 Emit @code{static} functions into the object file, even if the function
7877 is never used.
7879 @item -fkeep-static-consts
7880 @opindex fkeep-static-consts
7881 Emit variables declared @code{static const} when optimization isn't turned
7882 on, even if the variables aren't referenced.
7884 GCC enables this option by default.  If you want to force the compiler to
7885 check if a variable is referenced, regardless of whether or not
7886 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7888 @item -fmerge-constants
7889 @opindex fmerge-constants
7890 Attempt to merge identical constants (string constants and floating-point
7891 constants) across compilation units.
7893 This option is the default for optimized compilation if the assembler and
7894 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7895 behavior.
7897 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7899 @item -fmerge-all-constants
7900 @opindex fmerge-all-constants
7901 Attempt to merge identical constants and identical variables.
7903 This option implies @option{-fmerge-constants}.  In addition to
7904 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7905 arrays or initialized constant variables with integral or floating-point
7906 types.  Languages like C or C++ require each variable, including multiple
7907 instances of the same variable in recursive calls, to have distinct locations,
7908 so using this option results in non-conforming
7909 behavior.
7911 @item -fmodulo-sched
7912 @opindex fmodulo-sched
7913 Perform swing modulo scheduling immediately before the first scheduling
7914 pass.  This pass looks at innermost loops and reorders their
7915 instructions by overlapping different iterations.
7917 @item -fmodulo-sched-allow-regmoves
7918 @opindex fmodulo-sched-allow-regmoves
7919 Perform more aggressive SMS-based modulo scheduling with register moves
7920 allowed.  By setting this flag certain anti-dependences edges are
7921 deleted, which triggers the generation of reg-moves based on the
7922 life-range analysis.  This option is effective only with
7923 @option{-fmodulo-sched} enabled.
7925 @item -fno-branch-count-reg
7926 @opindex fno-branch-count-reg
7927 Avoid running a pass scanning for opportunities to use ``decrement and
7928 branch'' instructions on a count register instead of generating sequences
7929 of instructions that decrement a register, compare it against zero, and
7930 then branch based upon the result.  This option is only meaningful on
7931 architectures that support such instructions, which include x86, PowerPC,
7932 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7933 doesn't remove the decrement and branch instructions from the generated
7934 instruction stream introduced by other optimization passes.
7936 Enabled by default at @option{-O1} and higher.
7938 The default is @option{-fbranch-count-reg}.
7940 @item -fno-function-cse
7941 @opindex fno-function-cse
7942 Do not put function addresses in registers; make each instruction that
7943 calls a constant function contain the function's address explicitly.
7945 This option results in less efficient code, but some strange hacks
7946 that alter the assembler output may be confused by the optimizations
7947 performed when this option is not used.
7949 The default is @option{-ffunction-cse}
7951 @item -fno-zero-initialized-in-bss
7952 @opindex fno-zero-initialized-in-bss
7953 If the target supports a BSS section, GCC by default puts variables that
7954 are initialized to zero into BSS@.  This can save space in the resulting
7955 code.
7957 This option turns off this behavior because some programs explicitly
7958 rely on variables going to the data section---e.g., so that the
7959 resulting executable can find the beginning of that section and/or make
7960 assumptions based on that.
7962 The default is @option{-fzero-initialized-in-bss}.
7964 @item -fthread-jumps
7965 @opindex fthread-jumps
7966 Perform optimizations that check to see if a jump branches to a
7967 location where another comparison subsumed by the first is found.  If
7968 so, the first branch is redirected to either the destination of the
7969 second branch or a point immediately following it, depending on whether
7970 the condition is known to be true or false.
7972 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7974 @item -fsplit-wide-types
7975 @opindex fsplit-wide-types
7976 When using a type that occupies multiple registers, such as @code{long
7977 long} on a 32-bit system, split the registers apart and allocate them
7978 independently.  This normally generates better code for those types,
7979 but may make debugging more difficult.
7981 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7982 @option{-Os}.
7984 @item -fcse-follow-jumps
7985 @opindex fcse-follow-jumps
7986 In common subexpression elimination (CSE), scan through jump instructions
7987 when the target of the jump is not reached by any other path.  For
7988 example, when CSE encounters an @code{if} statement with an
7989 @code{else} clause, CSE follows the jump when the condition
7990 tested is false.
7992 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7994 @item -fcse-skip-blocks
7995 @opindex fcse-skip-blocks
7996 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7997 follow jumps that conditionally skip over blocks.  When CSE
7998 encounters a simple @code{if} statement with no else clause,
7999 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
8000 body of the @code{if}.
8002 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8004 @item -frerun-cse-after-loop
8005 @opindex frerun-cse-after-loop
8006 Re-run common subexpression elimination after loop optimizations are
8007 performed.
8009 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8011 @item -fgcse
8012 @opindex fgcse
8013 Perform a global common subexpression elimination pass.
8014 This pass also performs global constant and copy propagation.
8016 @emph{Note:} When compiling a program using computed gotos, a GCC
8017 extension, you may get better run-time performance if you disable
8018 the global common subexpression elimination pass by adding
8019 @option{-fno-gcse} to the command line.
8021 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8023 @item -fgcse-lm
8024 @opindex fgcse-lm
8025 When @option{-fgcse-lm} is enabled, global common subexpression elimination
8026 attempts to move loads that are only killed by stores into themselves.  This
8027 allows a loop containing a load/store sequence to be changed to a load outside
8028 the loop, and a copy/store within the loop.
8030 Enabled by default when @option{-fgcse} is enabled.
8032 @item -fgcse-sm
8033 @opindex fgcse-sm
8034 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8035 global common subexpression elimination.  This pass attempts to move
8036 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8037 loops containing a load/store sequence can be changed to a load before
8038 the loop and a store after the loop.
8040 Not enabled at any optimization level.
8042 @item -fgcse-las
8043 @opindex fgcse-las
8044 When @option{-fgcse-las} is enabled, the global common subexpression
8045 elimination pass eliminates redundant loads that come after stores to the
8046 same memory location (both partial and full redundancies).
8048 Not enabled at any optimization level.
8050 @item -fgcse-after-reload
8051 @opindex fgcse-after-reload
8052 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8053 pass is performed after reload.  The purpose of this pass is to clean up
8054 redundant spilling.
8056 @item -faggressive-loop-optimizations
8057 @opindex faggressive-loop-optimizations
8058 This option tells the loop optimizer to use language constraints to
8059 derive bounds for the number of iterations of a loop.  This assumes that
8060 loop code does not invoke undefined behavior by for example causing signed
8061 integer overflows or out-of-bound array accesses.  The bounds for the
8062 number of iterations of a loop are used to guide loop unrolling and peeling
8063 and loop exit test optimizations.
8064 This option is enabled by default.
8066 @item -funconstrained-commons
8067 @opindex funconstrained-commons
8068 This option tells the compiler that variables declared in common blocks
8069 (e.g. Fortran) may later be overridden with longer trailing arrays. This
8070 prevents certain optimizations that depend on knowing the array bounds.
8072 @item -fcrossjumping
8073 @opindex fcrossjumping
8074 Perform cross-jumping transformation.
8075 This transformation unifies equivalent code and saves code size.  The
8076 resulting code may or may not perform better than without cross-jumping.
8078 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8080 @item -fauto-inc-dec
8081 @opindex fauto-inc-dec
8082 Combine increments or decrements of addresses with memory accesses.
8083 This pass is always skipped on architectures that do not have
8084 instructions to support this.  Enabled by default at @option{-O} and
8085 higher on architectures that support this.
8087 @item -fdce
8088 @opindex fdce
8089 Perform dead code elimination (DCE) on RTL@.
8090 Enabled by default at @option{-O} and higher.
8092 @item -fdse
8093 @opindex fdse
8094 Perform dead store elimination (DSE) on RTL@.
8095 Enabled by default at @option{-O} and higher.
8097 @item -fif-conversion
8098 @opindex fif-conversion
8099 Attempt to transform conditional jumps into branch-less equivalents.  This
8100 includes use of conditional moves, min, max, set flags and abs instructions, and
8101 some tricks doable by standard arithmetics.  The use of conditional execution
8102 on chips where it is available is controlled by @option{-fif-conversion2}.
8104 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8106 @item -fif-conversion2
8107 @opindex fif-conversion2
8108 Use conditional execution (where available) to transform conditional jumps into
8109 branch-less equivalents.
8111 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8113 @item -fdeclone-ctor-dtor
8114 @opindex fdeclone-ctor-dtor
8115 The C++ ABI requires multiple entry points for constructors and
8116 destructors: one for a base subobject, one for a complete object, and
8117 one for a virtual destructor that calls operator delete afterwards.
8118 For a hierarchy with virtual bases, the base and complete variants are
8119 clones, which means two copies of the function.  With this option, the
8120 base and complete variants are changed to be thunks that call a common
8121 implementation.
8123 Enabled by @option{-Os}.
8125 @item -fdelete-null-pointer-checks
8126 @opindex fdelete-null-pointer-checks
8127 Assume that programs cannot safely dereference null pointers, and that
8128 no code or data element resides at address zero.
8129 This option enables simple constant
8130 folding optimizations at all optimization levels.  In addition, other
8131 optimization passes in GCC use this flag to control global dataflow
8132 analyses that eliminate useless checks for null pointers; these assume
8133 that a memory access to address zero always results in a trap, so
8134 that if a pointer is checked after it has already been dereferenced,
8135 it cannot be null.
8137 Note however that in some environments this assumption is not true.
8138 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8139 for programs that depend on that behavior.
8141 This option is enabled by default on most targets.  On Nios II ELF, it
8142 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
8144 Passes that use the dataflow information
8145 are enabled independently at different optimization levels.
8147 @item -fdevirtualize
8148 @opindex fdevirtualize
8149 Attempt to convert calls to virtual functions to direct calls.  This
8150 is done both within a procedure and interprocedurally as part of
8151 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8152 propagation (@option{-fipa-cp}).
8153 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8155 @item -fdevirtualize-speculatively
8156 @opindex fdevirtualize-speculatively
8157 Attempt to convert calls to virtual functions to speculative direct calls.
8158 Based on the analysis of the type inheritance graph, determine for a given call
8159 the set of likely targets. If the set is small, preferably of size 1, change
8160 the call into a conditional deciding between direct and indirect calls.  The
8161 speculative calls enable more optimizations, such as inlining.  When they seem
8162 useless after further optimization, they are converted back into original form.
8164 @item -fdevirtualize-at-ltrans
8165 @opindex fdevirtualize-at-ltrans
8166 Stream extra information needed for aggressive devirtualization when running
8167 the link-time optimizer in local transformation mode.  
8168 This option enables more devirtualization but
8169 significantly increases the size of streamed data. For this reason it is
8170 disabled by default.
8172 @item -fexpensive-optimizations
8173 @opindex fexpensive-optimizations
8174 Perform a number of minor optimizations that are relatively expensive.
8176 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8178 @item -free
8179 @opindex free
8180 Attempt to remove redundant extension instructions.  This is especially
8181 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8182 registers after writing to their lower 32-bit half.
8184 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8185 @option{-O3}, @option{-Os}.
8187 @item -fno-lifetime-dse
8188 @opindex fno-lifetime-dse
8189 In C++ the value of an object is only affected by changes within its
8190 lifetime: when the constructor begins, the object has an indeterminate
8191 value, and any changes during the lifetime of the object are dead when
8192 the object is destroyed.  Normally dead store elimination will take
8193 advantage of this; if your code relies on the value of the object
8194 storage persisting beyond the lifetime of the object, you can use this
8195 flag to disable this optimization.  To preserve stores before the
8196 constructor starts (e.g. because your operator new clears the object
8197 storage) but still treat the object as dead after the destructor you,
8198 can use @option{-flifetime-dse=1}.  The default behavior can be
8199 explicitly selected with @option{-flifetime-dse=2}.
8200 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8202 @item -flive-range-shrinkage
8203 @opindex flive-range-shrinkage
8204 Attempt to decrease register pressure through register live range
8205 shrinkage.  This is helpful for fast processors with small or moderate
8206 size register sets.
8208 @item -fira-algorithm=@var{algorithm}
8209 @opindex fira-algorithm
8210 Use the specified coloring algorithm for the integrated register
8211 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8212 specifies Chow's priority coloring, or @samp{CB}, which specifies
8213 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8214 for all architectures, but for those targets that do support it, it is
8215 the default because it generates better code.
8217 @item -fira-region=@var{region}
8218 @opindex fira-region
8219 Use specified regions for the integrated register allocator.  The
8220 @var{region} argument should be one of the following:
8222 @table @samp
8224 @item all
8225 Use all loops as register allocation regions.
8226 This can give the best results for machines with a small and/or
8227 irregular register set.
8229 @item mixed
8230 Use all loops except for loops with small register pressure 
8231 as the regions.  This value usually gives
8232 the best results in most cases and for most architectures,
8233 and is enabled by default when compiling with optimization for speed
8234 (@option{-O}, @option{-O2}, @dots{}).
8236 @item one
8237 Use all functions as a single region.  
8238 This typically results in the smallest code size, and is enabled by default for
8239 @option{-Os} or @option{-O0}.
8241 @end table
8243 @item -fira-hoist-pressure
8244 @opindex fira-hoist-pressure
8245 Use IRA to evaluate register pressure in the code hoisting pass for
8246 decisions to hoist expressions.  This option usually results in smaller
8247 code, but it can slow the compiler down.
8249 This option is enabled at level @option{-Os} for all targets.
8251 @item -fira-loop-pressure
8252 @opindex fira-loop-pressure
8253 Use IRA to evaluate register pressure in loops for decisions to move
8254 loop invariants.  This option usually results in generation
8255 of faster and smaller code on machines with large register files (>= 32
8256 registers), but it can slow the compiler down.
8258 This option is enabled at level @option{-O3} for some targets.
8260 @item -fno-ira-share-save-slots
8261 @opindex fno-ira-share-save-slots
8262 Disable sharing of stack slots used for saving call-used hard
8263 registers living through a call.  Each hard register gets a
8264 separate stack slot, and as a result function stack frames are
8265 larger.
8267 @item -fno-ira-share-spill-slots
8268 @opindex fno-ira-share-spill-slots
8269 Disable sharing of stack slots allocated for pseudo-registers.  Each
8270 pseudo-register that does not get a hard register gets a separate
8271 stack slot, and as a result function stack frames are larger.
8273 @item -flra-remat
8274 @opindex flra-remat
8275 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8276 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8277 values if it is profitable.
8279 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8281 @item -fdelayed-branch
8282 @opindex fdelayed-branch
8283 If supported for the target machine, attempt to reorder instructions
8284 to exploit instruction slots available after delayed branch
8285 instructions.
8287 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8289 @item -fschedule-insns
8290 @opindex fschedule-insns
8291 If supported for the target machine, attempt to reorder instructions to
8292 eliminate execution stalls due to required data being unavailable.  This
8293 helps machines that have slow floating point or memory load instructions
8294 by allowing other instructions to be issued until the result of the load
8295 or floating-point instruction is required.
8297 Enabled at levels @option{-O2}, @option{-O3}.
8299 @item -fschedule-insns2
8300 @opindex fschedule-insns2
8301 Similar to @option{-fschedule-insns}, but requests an additional pass of
8302 instruction scheduling after register allocation has been done.  This is
8303 especially useful on machines with a relatively small number of
8304 registers and where memory load instructions take more than one cycle.
8306 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8308 @item -fno-sched-interblock
8309 @opindex fno-sched-interblock
8310 Don't schedule instructions across basic blocks.  This is normally
8311 enabled by default when scheduling before register allocation, i.e.@:
8312 with @option{-fschedule-insns} or at @option{-O2} or higher.
8314 @item -fno-sched-spec
8315 @opindex fno-sched-spec
8316 Don't allow speculative motion of non-load instructions.  This is normally
8317 enabled by default when scheduling before register allocation, i.e.@:
8318 with @option{-fschedule-insns} or at @option{-O2} or higher.
8320 @item -fsched-pressure
8321 @opindex fsched-pressure
8322 Enable register pressure sensitive insn scheduling before register
8323 allocation.  This only makes sense when scheduling before register
8324 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8325 @option{-O2} or higher.  Usage of this option can improve the
8326 generated code and decrease its size by preventing register pressure
8327 increase above the number of available hard registers and subsequent
8328 spills in register allocation.
8330 @item -fsched-spec-load
8331 @opindex fsched-spec-load
8332 Allow speculative motion of some load instructions.  This only makes
8333 sense when scheduling before register allocation, i.e.@: with
8334 @option{-fschedule-insns} or at @option{-O2} or higher.
8336 @item -fsched-spec-load-dangerous
8337 @opindex fsched-spec-load-dangerous
8338 Allow speculative motion of more load instructions.  This only makes
8339 sense when scheduling before register allocation, i.e.@: with
8340 @option{-fschedule-insns} or at @option{-O2} or higher.
8342 @item -fsched-stalled-insns
8343 @itemx -fsched-stalled-insns=@var{n}
8344 @opindex fsched-stalled-insns
8345 Define how many insns (if any) can be moved prematurely from the queue
8346 of stalled insns into the ready list during the second scheduling pass.
8347 @option{-fno-sched-stalled-insns} means that no insns are moved
8348 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8349 on how many queued insns can be moved prematurely.
8350 @option{-fsched-stalled-insns} without a value is equivalent to
8351 @option{-fsched-stalled-insns=1}.
8353 @item -fsched-stalled-insns-dep
8354 @itemx -fsched-stalled-insns-dep=@var{n}
8355 @opindex fsched-stalled-insns-dep
8356 Define how many insn groups (cycles) are examined for a dependency
8357 on a stalled insn that is a candidate for premature removal from the queue
8358 of stalled insns.  This has an effect only during the second scheduling pass,
8359 and only if @option{-fsched-stalled-insns} is used.
8360 @option{-fno-sched-stalled-insns-dep} is equivalent to
8361 @option{-fsched-stalled-insns-dep=0}.
8362 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8363 @option{-fsched-stalled-insns-dep=1}.
8365 @item -fsched2-use-superblocks
8366 @opindex fsched2-use-superblocks
8367 When scheduling after register allocation, use superblock scheduling.
8368 This allows motion across basic block boundaries,
8369 resulting in faster schedules.  This option is experimental, as not all machine
8370 descriptions used by GCC model the CPU closely enough to avoid unreliable
8371 results from the algorithm.
8373 This only makes sense when scheduling after register allocation, i.e.@: with
8374 @option{-fschedule-insns2} or at @option{-O2} or higher.
8376 @item -fsched-group-heuristic
8377 @opindex fsched-group-heuristic
8378 Enable the group heuristic in the scheduler.  This heuristic favors
8379 the instruction that belongs to a schedule group.  This is enabled
8380 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8381 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8383 @item -fsched-critical-path-heuristic
8384 @opindex fsched-critical-path-heuristic
8385 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8386 instructions on the critical path.  This is enabled by default when
8387 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8388 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8390 @item -fsched-spec-insn-heuristic
8391 @opindex fsched-spec-insn-heuristic
8392 Enable the speculative instruction heuristic in the scheduler.  This
8393 heuristic favors speculative instructions with greater dependency weakness.
8394 This is enabled by default when scheduling is enabled, i.e.@:
8395 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8396 or at @option{-O2} or higher.
8398 @item -fsched-rank-heuristic
8399 @opindex fsched-rank-heuristic
8400 Enable the rank heuristic in the scheduler.  This heuristic favors
8401 the instruction belonging to a basic block with greater size or frequency.
8402 This is enabled by default when scheduling is enabled, i.e.@:
8403 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8404 at @option{-O2} or higher.
8406 @item -fsched-last-insn-heuristic
8407 @opindex fsched-last-insn-heuristic
8408 Enable the last-instruction heuristic in the scheduler.  This heuristic
8409 favors the instruction that is less dependent on the last instruction
8410 scheduled.  This is enabled by default when scheduling is enabled,
8411 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8412 at @option{-O2} or higher.
8414 @item -fsched-dep-count-heuristic
8415 @opindex fsched-dep-count-heuristic
8416 Enable the dependent-count heuristic in the scheduler.  This heuristic
8417 favors the instruction that has more instructions depending on it.
8418 This is enabled by default when scheduling is enabled, i.e.@:
8419 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8420 at @option{-O2} or higher.
8422 @item -freschedule-modulo-scheduled-loops
8423 @opindex freschedule-modulo-scheduled-loops
8424 Modulo scheduling is performed before traditional scheduling.  If a loop
8425 is modulo scheduled, later scheduling passes may change its schedule.  
8426 Use this option to control that behavior.
8428 @item -fselective-scheduling
8429 @opindex fselective-scheduling
8430 Schedule instructions using selective scheduling algorithm.  Selective
8431 scheduling runs instead of the first scheduler pass.
8433 @item -fselective-scheduling2
8434 @opindex fselective-scheduling2
8435 Schedule instructions using selective scheduling algorithm.  Selective
8436 scheduling runs instead of the second scheduler pass.
8438 @item -fsel-sched-pipelining
8439 @opindex fsel-sched-pipelining
8440 Enable software pipelining of innermost loops during selective scheduling.
8441 This option has no effect unless one of @option{-fselective-scheduling} or
8442 @option{-fselective-scheduling2} is turned on.
8444 @item -fsel-sched-pipelining-outer-loops
8445 @opindex fsel-sched-pipelining-outer-loops
8446 When pipelining loops during selective scheduling, also pipeline outer loops.
8447 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8449 @item -fsemantic-interposition
8450 @opindex fsemantic-interposition
8451 Some object formats, like ELF, allow interposing of symbols by the 
8452 dynamic linker.
8453 This means that for symbols exported from the DSO, the compiler cannot perform
8454 interprocedural propagation, inlining and other optimizations in anticipation
8455 that the function or variable in question may change. While this feature is
8456 useful, for example, to rewrite memory allocation functions by a debugging
8457 implementation, it is expensive in the terms of code quality.
8458 With @option{-fno-semantic-interposition} the compiler assumes that 
8459 if interposition happens for functions the overwriting function will have 
8460 precisely the same semantics (and side effects). 
8461 Similarly if interposition happens
8462 for variables, the constructor of the variable will be the same. The flag
8463 has no effect for functions explicitly declared inline 
8464 (where it is never allowed for interposition to change semantics) 
8465 and for symbols explicitly declared weak.
8467 @item -fshrink-wrap
8468 @opindex fshrink-wrap
8469 Emit function prologues only before parts of the function that need it,
8470 rather than at the top of the function.  This flag is enabled by default at
8471 @option{-O} and higher.
8473 @item -fshrink-wrap-separate
8474 @opindex fshrink-wrap-separate
8475 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8476 those parts are only executed when needed.
8477 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8478 is also turned on and the target supports this.
8480 @item -fcaller-saves
8481 @opindex fcaller-saves
8482 Enable allocation of values to registers that are clobbered by
8483 function calls, by emitting extra instructions to save and restore the
8484 registers around such calls.  Such allocation is done only when it
8485 seems to result in better code.
8487 This option is always enabled by default on certain machines, usually
8488 those which have no call-preserved registers to use instead.
8490 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8492 @item -fcombine-stack-adjustments
8493 @opindex fcombine-stack-adjustments
8494 Tracks stack adjustments (pushes and pops) and stack memory references
8495 and then tries to find ways to combine them.
8497 Enabled by default at @option{-O1} and higher.
8499 @item -fipa-ra
8500 @opindex fipa-ra
8501 Use caller save registers for allocation if those registers are not used by
8502 any called function.  In that case it is not necessary to save and restore
8503 them around calls.  This is only possible if called functions are part of
8504 same compilation unit as current function and they are compiled before it.
8506 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8507 is disabled if generated code will be instrumented for profiling
8508 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8509 exactly (this happens on targets that do not expose prologues
8510 and epilogues in RTL).
8512 @item -fconserve-stack
8513 @opindex fconserve-stack
8514 Attempt to minimize stack usage.  The compiler attempts to use less
8515 stack space, even if that makes the program slower.  This option
8516 implies setting the @option{large-stack-frame} parameter to 100
8517 and the @option{large-stack-frame-growth} parameter to 400.
8519 @item -ftree-reassoc
8520 @opindex ftree-reassoc
8521 Perform reassociation on trees.  This flag is enabled by default
8522 at @option{-O} and higher.
8524 @item -fcode-hoisting
8525 @opindex fcode-hoisting
8526 Perform code hoisting.  Code hoisting tries to move the
8527 evaluation of expressions executed on all paths to the function exit
8528 as early as possible.  This is especially useful as a code size
8529 optimization, but it often helps for code speed as well.
8530 This flag is enabled by default at @option{-O2} and higher.
8532 @item -ftree-pre
8533 @opindex ftree-pre
8534 Perform partial redundancy elimination (PRE) on trees.  This flag is
8535 enabled by default at @option{-O2} and @option{-O3}.
8537 @item -ftree-partial-pre
8538 @opindex ftree-partial-pre
8539 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8540 enabled by default at @option{-O3}.
8542 @item -ftree-forwprop
8543 @opindex ftree-forwprop
8544 Perform forward propagation on trees.  This flag is enabled by default
8545 at @option{-O} and higher.
8547 @item -ftree-fre
8548 @opindex ftree-fre
8549 Perform full redundancy elimination (FRE) on trees.  The difference
8550 between FRE and PRE is that FRE only considers expressions
8551 that are computed on all paths leading to the redundant computation.
8552 This analysis is faster than PRE, though it exposes fewer redundancies.
8553 This flag is enabled by default at @option{-O} and higher.
8555 @item -ftree-phiprop
8556 @opindex ftree-phiprop
8557 Perform hoisting of loads from conditional pointers on trees.  This
8558 pass is enabled by default at @option{-O} and higher.
8560 @item -fhoist-adjacent-loads
8561 @opindex fhoist-adjacent-loads
8562 Speculatively hoist loads from both branches of an if-then-else if the
8563 loads are from adjacent locations in the same structure and the target
8564 architecture has a conditional move instruction.  This flag is enabled
8565 by default at @option{-O2} and higher.
8567 @item -ftree-copy-prop
8568 @opindex ftree-copy-prop
8569 Perform copy propagation on trees.  This pass eliminates unnecessary
8570 copy operations.  This flag is enabled by default at @option{-O} and
8571 higher.
8573 @item -fipa-pure-const
8574 @opindex fipa-pure-const
8575 Discover which functions are pure or constant.
8576 Enabled by default at @option{-O} and higher.
8578 @item -fipa-reference
8579 @opindex fipa-reference
8580 Discover which static variables do not escape the
8581 compilation unit.
8582 Enabled by default at @option{-O} and higher.
8584 @item -fipa-pta
8585 @opindex fipa-pta
8586 Perform interprocedural pointer analysis and interprocedural modification
8587 and reference analysis.  This option can cause excessive memory and
8588 compile-time usage on large compilation units.  It is not enabled by
8589 default at any optimization level.
8591 @item -fipa-profile
8592 @opindex fipa-profile
8593 Perform interprocedural profile propagation.  The functions called only from
8594 cold functions are marked as cold. Also functions executed once (such as
8595 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8596 functions and loop less parts of functions executed once are then optimized for
8597 size.
8598 Enabled by default at @option{-O} and higher.
8600 @item -fipa-cp
8601 @opindex fipa-cp
8602 Perform interprocedural constant propagation.
8603 This optimization analyzes the program to determine when values passed
8604 to functions are constants and then optimizes accordingly.
8605 This optimization can substantially increase performance
8606 if the application has constants passed to functions.
8607 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8609 @item -fipa-cp-clone
8610 @opindex fipa-cp-clone
8611 Perform function cloning to make interprocedural constant propagation stronger.
8612 When enabled, interprocedural constant propagation performs function cloning
8613 when externally visible function can be called with constant arguments.
8614 Because this optimization can create multiple copies of functions,
8615 it may significantly increase code size
8616 (see @option{--param ipcp-unit-growth=@var{value}}).
8617 This flag is enabled by default at @option{-O3}.
8619 @item -fipa-bit-cp
8620 @opindex -fipa-bit-cp
8621 When enabled, perform interprocedural bitwise constant
8622 propagation. This flag is enabled by default at @option{-O2}. It
8623 requires that @option{-fipa-cp} is enabled.
8625 @item -fipa-vrp
8626 @opindex -fipa-vrp
8627 When enabled, perform interprocedural propagation of value
8628 ranges. This flag is enabled by default at @option{-O2}. It requires
8629 that @option{-fipa-cp} is enabled.
8631 @item -fipa-icf
8632 @opindex fipa-icf
8633 Perform Identical Code Folding for functions and read-only variables.
8634 The optimization reduces code size and may disturb unwind stacks by replacing
8635 a function by equivalent one with a different name. The optimization works
8636 more effectively with link-time optimization enabled.
8638 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8639 works on different levels and thus the optimizations are not same - there are
8640 equivalences that are found only by GCC and equivalences found only by Gold.
8642 This flag is enabled by default at @option{-O2} and @option{-Os}.
8644 @item -fisolate-erroneous-paths-dereference
8645 @opindex fisolate-erroneous-paths-dereference
8646 Detect paths that trigger erroneous or undefined behavior due to
8647 dereferencing a null pointer.  Isolate those paths from the main control
8648 flow and turn the statement with erroneous or undefined behavior into a trap.
8649 This flag is enabled by default at @option{-O2} and higher and depends on
8650 @option{-fdelete-null-pointer-checks} also being enabled.
8652 @item -fisolate-erroneous-paths-attribute
8653 @opindex fisolate-erroneous-paths-attribute
8654 Detect paths that trigger erroneous or undefined behavior due to a null value
8655 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8656 attribute.  Isolate those paths from the main control flow and turn the
8657 statement with erroneous or undefined behavior into a trap.  This is not
8658 currently enabled, but may be enabled by @option{-O2} in the future.
8660 @item -ftree-sink
8661 @opindex ftree-sink
8662 Perform forward store motion on trees.  This flag is
8663 enabled by default at @option{-O} and higher.
8665 @item -ftree-bit-ccp
8666 @opindex ftree-bit-ccp
8667 Perform sparse conditional bit constant propagation on trees and propagate
8668 pointer alignment information.
8669 This pass only operates on local scalar variables and is enabled by default
8670 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8672 @item -ftree-ccp
8673 @opindex ftree-ccp
8674 Perform sparse conditional constant propagation (CCP) on trees.  This
8675 pass only operates on local scalar variables and is enabled by default
8676 at @option{-O} and higher.
8678 @item -fssa-backprop
8679 @opindex fssa-backprop
8680 Propagate information about uses of a value up the definition chain
8681 in order to simplify the definitions.  For example, this pass strips
8682 sign operations if the sign of a value never matters.  The flag is
8683 enabled by default at @option{-O} and higher.
8685 @item -fssa-phiopt
8686 @opindex fssa-phiopt
8687 Perform pattern matching on SSA PHI nodes to optimize conditional
8688 code.  This pass is enabled by default at @option{-O} and higher.
8690 @item -ftree-switch-conversion
8691 @opindex ftree-switch-conversion
8692 Perform conversion of simple initializations in a switch to
8693 initializations from a scalar array.  This flag is enabled by default
8694 at @option{-O2} and higher.
8696 @item -ftree-tail-merge
8697 @opindex ftree-tail-merge
8698 Look for identical code sequences.  When found, replace one with a jump to the
8699 other.  This optimization is known as tail merging or cross jumping.  This flag
8700 is enabled by default at @option{-O2} and higher.  The compilation time
8701 in this pass can
8702 be limited using @option{max-tail-merge-comparisons} parameter and
8703 @option{max-tail-merge-iterations} parameter.
8705 @item -ftree-dce
8706 @opindex ftree-dce
8707 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8708 default at @option{-O} and higher.
8710 @item -ftree-builtin-call-dce
8711 @opindex ftree-builtin-call-dce
8712 Perform conditional dead code elimination (DCE) for calls to built-in functions
8713 that may set @code{errno} but are otherwise side-effect free.  This flag is
8714 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8715 specified.
8717 @item -ftree-dominator-opts
8718 @opindex ftree-dominator-opts
8719 Perform a variety of simple scalar cleanups (constant/copy
8720 propagation, redundancy elimination, range propagation and expression
8721 simplification) based on a dominator tree traversal.  This also
8722 performs jump threading (to reduce jumps to jumps). This flag is
8723 enabled by default at @option{-O} and higher.
8725 @item -ftree-dse
8726 @opindex ftree-dse
8727 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8728 a memory location that is later overwritten by another store without
8729 any intervening loads.  In this case the earlier store can be deleted.  This
8730 flag is enabled by default at @option{-O} and higher.
8732 @item -ftree-ch
8733 @opindex ftree-ch
8734 Perform loop header copying on trees.  This is beneficial since it increases
8735 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8736 is enabled by default at @option{-O} and higher.  It is not enabled
8737 for @option{-Os}, since it usually increases code size.
8739 @item -ftree-loop-optimize
8740 @opindex ftree-loop-optimize
8741 Perform loop optimizations on trees.  This flag is enabled by default
8742 at @option{-O} and higher.
8744 @item -ftree-loop-linear
8745 @itemx -floop-strip-mine
8746 @itemx -floop-block
8747 @opindex ftree-loop-linear
8748 @opindex floop-strip-mine
8749 @opindex floop-block
8750 Perform loop nest optimizations.  Same as
8751 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8752 to be configured with @option{--with-isl} to enable the Graphite loop
8753 transformation infrastructure.
8755 @item -fgraphite-identity
8756 @opindex fgraphite-identity
8757 Enable the identity transformation for graphite.  For every SCoP we generate
8758 the polyhedral representation and transform it back to gimple.  Using
8759 @option{-fgraphite-identity} we can check the costs or benefits of the
8760 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8761 are also performed by the code generator isl, like index splitting and
8762 dead code elimination in loops.
8764 @item -floop-nest-optimize
8765 @opindex floop-nest-optimize
8766 Enable the isl based loop nest optimizer.  This is a generic loop nest
8767 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8768 structure optimized for data-locality and parallelism.  This option
8769 is experimental.
8771 @item -floop-parallelize-all
8772 @opindex floop-parallelize-all
8773 Use the Graphite data dependence analysis to identify loops that can
8774 be parallelized.  Parallelize all the loops that can be analyzed to
8775 not contain loop carried dependences without checking that it is
8776 profitable to parallelize the loops.
8778 @item -ftree-coalesce-vars
8779 @opindex ftree-coalesce-vars
8780 While transforming the program out of the SSA representation, attempt to
8781 reduce copying by coalescing versions of different user-defined
8782 variables, instead of just compiler temporaries.  This may severely
8783 limit the ability to debug an optimized program compiled with
8784 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8785 prevents SSA coalescing of user variables.  This option is enabled by
8786 default if optimization is enabled, and it does very little otherwise.
8788 @item -ftree-loop-if-convert
8789 @opindex ftree-loop-if-convert
8790 Attempt to transform conditional jumps in the innermost loops to
8791 branch-less equivalents.  The intent is to remove control-flow from
8792 the innermost loops in order to improve the ability of the
8793 vectorization pass to handle these loops.  This is enabled by default
8794 if vectorization is enabled.
8796 @item -ftree-loop-distribution
8797 @opindex ftree-loop-distribution
8798 Perform loop distribution.  This flag can improve cache performance on
8799 big loop bodies and allow further loop optimizations, like
8800 parallelization or vectorization, to take place.  For example, the loop
8801 @smallexample
8802 DO I = 1, N
8803   A(I) = B(I) + C
8804   D(I) = E(I) * F
8805 ENDDO
8806 @end smallexample
8807 is transformed to
8808 @smallexample
8809 DO I = 1, N
8810    A(I) = B(I) + C
8811 ENDDO
8812 DO I = 1, N
8813    D(I) = E(I) * F
8814 ENDDO
8815 @end smallexample
8817 @item -ftree-loop-distribute-patterns
8818 @opindex ftree-loop-distribute-patterns
8819 Perform loop distribution of patterns that can be code generated with
8820 calls to a library.  This flag is enabled by default at @option{-O3}.
8822 This pass distributes the initialization loops and generates a call to
8823 memset zero.  For example, the loop
8824 @smallexample
8825 DO I = 1, N
8826   A(I) = 0
8827   B(I) = A(I) + I
8828 ENDDO
8829 @end smallexample
8830 is transformed to
8831 @smallexample
8832 DO I = 1, N
8833    A(I) = 0
8834 ENDDO
8835 DO I = 1, N
8836    B(I) = A(I) + I
8837 ENDDO
8838 @end smallexample
8839 and the initialization loop is transformed into a call to memset zero.
8841 @item -floop-interchange
8842 @opindex floop-interchange
8843 Perform loop interchange outside of graphite.  This flag can improve cache
8844 performance on loop nest and allow further loop optimizations, like
8845 vectorization, to take place.  For example, the loop
8846 @smallexample
8847 for (int i = 0; i < N; i++)
8848   for (int j = 0; j < N; j++)
8849     for (int k = 0; k < N; k++)
8850       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8851 @end smallexample
8852 is transformed to
8853 @smallexample
8854 for (int i = 0; i < N; i++)
8855   for (int k = 0; k < N; k++)
8856     for (int j = 0; j < N; j++)
8857       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8858 @end smallexample
8860 @item -ftree-loop-im
8861 @opindex ftree-loop-im
8862 Perform loop invariant motion on trees.  This pass moves only invariants that
8863 are hard to handle at RTL level (function calls, operations that expand to
8864 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8865 operands of conditions that are invariant out of the loop, so that we can use
8866 just trivial invariantness analysis in loop unswitching.  The pass also includes
8867 store motion.
8869 @item -ftree-loop-ivcanon
8870 @opindex ftree-loop-ivcanon
8871 Create a canonical counter for number of iterations in loops for which
8872 determining number of iterations requires complicated analysis.  Later
8873 optimizations then may determine the number easily.  Useful especially
8874 in connection with unrolling.
8876 @item -fivopts
8877 @opindex fivopts
8878 Perform induction variable optimizations (strength reduction, induction
8879 variable merging and induction variable elimination) on trees.
8881 @item -ftree-parallelize-loops=n
8882 @opindex ftree-parallelize-loops
8883 Parallelize loops, i.e., split their iteration space to run in n threads.
8884 This is only possible for loops whose iterations are independent
8885 and can be arbitrarily reordered.  The optimization is only
8886 profitable on multiprocessor machines, for loops that are CPU-intensive,
8887 rather than constrained e.g.@: by memory bandwidth.  This option
8888 implies @option{-pthread}, and thus is only supported on targets
8889 that have support for @option{-pthread}.
8891 @item -ftree-pta
8892 @opindex ftree-pta
8893 Perform function-local points-to analysis on trees.  This flag is
8894 enabled by default at @option{-O} and higher.
8896 @item -ftree-sra
8897 @opindex ftree-sra
8898 Perform scalar replacement of aggregates.  This pass replaces structure
8899 references with scalars to prevent committing structures to memory too
8900 early.  This flag is enabled by default at @option{-O} and higher.
8902 @item -fstore-merging
8903 @opindex fstore-merging
8904 Perform merging of narrow stores to consecutive memory addresses.  This pass
8905 merges contiguous stores of immediate values narrower than a word into fewer
8906 wider stores to reduce the number of instructions.  This is enabled by default
8907 at @option{-O2} and higher as well as @option{-Os}.
8909 @item -ftree-ter
8910 @opindex ftree-ter
8911 Perform temporary expression replacement during the SSA->normal phase.  Single
8912 use/single def temporaries are replaced at their use location with their
8913 defining expression.  This results in non-GIMPLE code, but gives the expanders
8914 much more complex trees to work on resulting in better RTL generation.  This is
8915 enabled by default at @option{-O} and higher.
8917 @item -ftree-slsr
8918 @opindex ftree-slsr
8919 Perform straight-line strength reduction on trees.  This recognizes related
8920 expressions involving multiplications and replaces them by less expensive
8921 calculations when possible.  This is enabled by default at @option{-O} and
8922 higher.
8924 @item -ftree-vectorize
8925 @opindex ftree-vectorize
8926 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8927 and @option{-ftree-slp-vectorize} if not explicitly specified.
8929 @item -ftree-loop-vectorize
8930 @opindex ftree-loop-vectorize
8931 Perform loop vectorization on trees. This flag is enabled by default at
8932 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8934 @item -ftree-slp-vectorize
8935 @opindex ftree-slp-vectorize
8936 Perform basic block vectorization on trees. This flag is enabled by default at
8937 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8939 @item -fvect-cost-model=@var{model}
8940 @opindex fvect-cost-model
8941 Alter the cost model used for vectorization.  The @var{model} argument
8942 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8943 With the @samp{unlimited} model the vectorized code-path is assumed
8944 to be profitable while with the @samp{dynamic} model a runtime check
8945 guards the vectorized code-path to enable it only for iteration
8946 counts that will likely execute faster than when executing the original
8947 scalar loop.  The @samp{cheap} model disables vectorization of
8948 loops where doing so would be cost prohibitive for example due to
8949 required runtime checks for data dependence or alignment but otherwise
8950 is equal to the @samp{dynamic} model.
8951 The default cost model depends on other optimization flags and is
8952 either @samp{dynamic} or @samp{cheap}.
8954 @item -fsimd-cost-model=@var{model}
8955 @opindex fsimd-cost-model
8956 Alter the cost model used for vectorization of loops marked with the OpenMP
8957 simd directive.  The @var{model} argument should be one of
8958 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8959 have the same meaning as described in @option{-fvect-cost-model} and by
8960 default a cost model defined with @option{-fvect-cost-model} is used.
8962 @item -ftree-vrp
8963 @opindex ftree-vrp
8964 Perform Value Range Propagation on trees.  This is similar to the
8965 constant propagation pass, but instead of values, ranges of values are
8966 propagated.  This allows the optimizers to remove unnecessary range
8967 checks like array bound checks and null pointer checks.  This is
8968 enabled by default at @option{-O2} and higher.  Null pointer check
8969 elimination is only done if @option{-fdelete-null-pointer-checks} is
8970 enabled.
8972 @item -fsplit-paths
8973 @opindex fsplit-paths
8974 Split paths leading to loop backedges.  This can improve dead code
8975 elimination and common subexpression elimination.  This is enabled by
8976 default at @option{-O2} and above.
8978 @item -fsplit-ivs-in-unroller
8979 @opindex fsplit-ivs-in-unroller
8980 Enables expression of values of induction variables in later iterations
8981 of the unrolled loop using the value in the first iteration.  This breaks
8982 long dependency chains, thus improving efficiency of the scheduling passes.
8984 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8985 same effect.  However, that is not reliable in cases where the loop body
8986 is more complicated than a single basic block.  It also does not work at all
8987 on some architectures due to restrictions in the CSE pass.
8989 This optimization is enabled by default.
8991 @item -fvariable-expansion-in-unroller
8992 @opindex fvariable-expansion-in-unroller
8993 With this option, the compiler creates multiple copies of some
8994 local variables when unrolling a loop, which can result in superior code.
8996 @item -fpartial-inlining
8997 @opindex fpartial-inlining
8998 Inline parts of functions.  This option has any effect only
8999 when inlining itself is turned on by the @option{-finline-functions}
9000 or @option{-finline-small-functions} options.
9002 Enabled at level @option{-O2}.
9004 @item -fpredictive-commoning
9005 @opindex fpredictive-commoning
9006 Perform predictive commoning optimization, i.e., reusing computations
9007 (especially memory loads and stores) performed in previous
9008 iterations of loops.
9010 This option is enabled at level @option{-O3}.
9012 @item -fprefetch-loop-arrays
9013 @opindex fprefetch-loop-arrays
9014 If supported by the target machine, generate instructions to prefetch
9015 memory to improve the performance of loops that access large arrays.
9017 This option may generate better or worse code; results are highly
9018 dependent on the structure of loops within the source code.
9020 Disabled at level @option{-Os}.
9022 @item -fno-printf-return-value
9023 @opindex fno-printf-return-value
9024 Do not substitute constants for known return value of formatted output
9025 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
9026 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
9027 transformation allows GCC to optimize or even eliminate branches based
9028 on the known return value of these functions called with arguments that
9029 are either constant, or whose values are known to be in a range that
9030 makes determining the exact return value possible.  For example, when
9031 @option{-fprintf-return-value} is in effect, both the branch and the
9032 body of the @code{if} statement (but not the call to @code{snprint})
9033 can be optimized away when @code{i} is a 32-bit or smaller integer
9034 because the return value is guaranteed to be at most 8.
9036 @smallexample
9037 char buf[9];
9038 if (snprintf (buf, "%08x", i) >= sizeof buf)
9039   @dots{}
9040 @end smallexample
9042 The @option{-fprintf-return-value} option relies on other optimizations
9043 and yields best results with @option{-O2}.  It works in tandem with the
9044 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
9045 The @option{-fprintf-return-value} option is enabled by default.
9047 @item -fno-peephole
9048 @itemx -fno-peephole2
9049 @opindex fno-peephole
9050 @opindex fno-peephole2
9051 Disable any machine-specific peephole optimizations.  The difference
9052 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9053 are implemented in the compiler; some targets use one, some use the
9054 other, a few use both.
9056 @option{-fpeephole} is enabled by default.
9057 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9059 @item -fno-guess-branch-probability
9060 @opindex fno-guess-branch-probability
9061 Do not guess branch probabilities using heuristics.
9063 GCC uses heuristics to guess branch probabilities if they are
9064 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9065 heuristics are based on the control flow graph.  If some branch probabilities
9066 are specified by @code{__builtin_expect}, then the heuristics are
9067 used to guess branch probabilities for the rest of the control flow graph,
9068 taking the @code{__builtin_expect} info into account.  The interactions
9069 between the heuristics and @code{__builtin_expect} can be complex, and in
9070 some cases, it may be useful to disable the heuristics so that the effects
9071 of @code{__builtin_expect} are easier to understand.
9073 The default is @option{-fguess-branch-probability} at levels
9074 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9076 @item -freorder-blocks
9077 @opindex freorder-blocks
9078 Reorder basic blocks in the compiled function in order to reduce number of
9079 taken branches and improve code locality.
9081 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9083 @item -freorder-blocks-algorithm=@var{algorithm}
9084 @opindex freorder-blocks-algorithm
9085 Use the specified algorithm for basic block reordering.  The
9086 @var{algorithm} argument can be @samp{simple}, which does not increase
9087 code size (except sometimes due to secondary effects like alignment),
9088 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
9089 put all often executed code together, minimizing the number of branches
9090 executed by making extra copies of code.
9092 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
9093 @samp{stc} at levels @option{-O2}, @option{-O3}.
9095 @item -freorder-blocks-and-partition
9096 @opindex freorder-blocks-and-partition
9097 In addition to reordering basic blocks in the compiled function, in order
9098 to reduce number of taken branches, partitions hot and cold basic blocks
9099 into separate sections of the assembly and @file{.o} files, to improve
9100 paging and cache locality performance.
9102 This optimization is automatically turned off in the presence of
9103 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
9104 section attribute and on any architecture that does not support named
9105 sections.  When @option{-fsplit-stack} is used this option is not
9106 enabled by default (to avoid linker errors), but may be enabled
9107 explicitly (if using a working linker).
9109 Enabled for x86 at levels @option{-O2}, @option{-O3}.
9111 @item -freorder-functions
9112 @opindex freorder-functions
9113 Reorder functions in the object file in order to
9114 improve code locality.  This is implemented by using special
9115 subsections @code{.text.hot} for most frequently executed functions and
9116 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9117 the linker so object file format must support named sections and linker must
9118 place them in a reasonable way.
9120 Also profile feedback must be available to make this option effective.  See
9121 @option{-fprofile-arcs} for details.
9123 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9125 @item -fstrict-aliasing
9126 @opindex fstrict-aliasing
9127 Allow the compiler to assume the strictest aliasing rules applicable to
9128 the language being compiled.  For C (and C++), this activates
9129 optimizations based on the type of expressions.  In particular, an
9130 object of one type is assumed never to reside at the same address as an
9131 object of a different type, unless the types are almost the same.  For
9132 example, an @code{unsigned int} can alias an @code{int}, but not a
9133 @code{void*} or a @code{double}.  A character type may alias any other
9134 type.
9136 @anchor{Type-punning}Pay special attention to code like this:
9137 @smallexample
9138 union a_union @{
9139   int i;
9140   double d;
9143 int f() @{
9144   union a_union t;
9145   t.d = 3.0;
9146   return t.i;
9148 @end smallexample
9149 The practice of reading from a different union member than the one most
9150 recently written to (called ``type-punning'') is common.  Even with
9151 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9152 is accessed through the union type.  So, the code above works as
9153 expected.  @xref{Structures unions enumerations and bit-fields
9154 implementation}.  However, this code might not:
9155 @smallexample
9156 int f() @{
9157   union a_union t;
9158   int* ip;
9159   t.d = 3.0;
9160   ip = &t.i;
9161   return *ip;
9163 @end smallexample
9165 Similarly, access by taking the address, casting the resulting pointer
9166 and dereferencing the result has undefined behavior, even if the cast
9167 uses a union type, e.g.:
9168 @smallexample
9169 int f() @{
9170   double d = 3.0;
9171   return ((union a_union *) &d)->i;
9173 @end smallexample
9175 The @option{-fstrict-aliasing} option is enabled at levels
9176 @option{-O2}, @option{-O3}, @option{-Os}.
9178 @item -falign-functions
9179 @itemx -falign-functions=@var{n}
9180 @opindex falign-functions
9181 Align the start of functions to the next power-of-two greater than
9182 @var{n}, skipping up to @var{n} bytes.  For instance,
9183 @option{-falign-functions=32} aligns functions to the next 32-byte
9184 boundary, but @option{-falign-functions=24} aligns to the next
9185 32-byte boundary only if this can be done by skipping 23 bytes or less.
9187 @option{-fno-align-functions} and @option{-falign-functions=1} are
9188 equivalent and mean that functions are not aligned.
9190 Some assemblers only support this flag when @var{n} is a power of two;
9191 in that case, it is rounded up.
9193 If @var{n} is not specified or is zero, use a machine-dependent default.
9194 The maximum allowed @var{n} option value is 65536.
9196 Enabled at levels @option{-O2}, @option{-O3}.
9198 @item -flimit-function-alignment
9199 If this option is enabled, the compiler tries to avoid unnecessarily
9200 overaligning functions. It attempts to instruct the assembler to align
9201 by the amount specified by @option{-falign-functions}, but not to
9202 skip more bytes than the size of the function.
9204 @item -falign-labels
9205 @itemx -falign-labels=@var{n}
9206 @opindex falign-labels
9207 Align all branch targets to a power-of-two boundary, skipping up to
9208 @var{n} bytes like @option{-falign-functions}.  This option can easily
9209 make code slower, because it must insert dummy operations for when the
9210 branch target is reached in the usual flow of the code.
9212 @option{-fno-align-labels} and @option{-falign-labels=1} are
9213 equivalent and mean that labels are not aligned.
9215 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9216 are greater than this value, then their values are used instead.
9218 If @var{n} is not specified or is zero, use a machine-dependent default
9219 which is very likely to be @samp{1}, meaning no alignment.
9220 The maximum allowed @var{n} option value is 65536.
9222 Enabled at levels @option{-O2}, @option{-O3}.
9224 @item -falign-loops
9225 @itemx -falign-loops=@var{n}
9226 @opindex falign-loops
9227 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9228 like @option{-falign-functions}.  If the loops are
9229 executed many times, this makes up for any execution of the dummy
9230 operations.
9232 @option{-fno-align-loops} and @option{-falign-loops=1} are
9233 equivalent and mean that loops are not aligned.
9234 The maximum allowed @var{n} option value is 65536.
9236 If @var{n} is not specified or is zero, use a machine-dependent default.
9238 Enabled at levels @option{-O2}, @option{-O3}.
9240 @item -falign-jumps
9241 @itemx -falign-jumps=@var{n}
9242 @opindex falign-jumps
9243 Align branch targets to a power-of-two boundary, for branch targets
9244 where the targets can only be reached by jumping, skipping up to @var{n}
9245 bytes like @option{-falign-functions}.  In this case, no dummy operations
9246 need be executed.
9248 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9249 equivalent and mean that loops are not aligned.
9251 If @var{n} is not specified or is zero, use a machine-dependent default.
9252 The maximum allowed @var{n} option value is 65536.
9254 Enabled at levels @option{-O2}, @option{-O3}.
9256 @item -funit-at-a-time
9257 @opindex funit-at-a-time
9258 This option is left for compatibility reasons. @option{-funit-at-a-time}
9259 has no effect, while @option{-fno-unit-at-a-time} implies
9260 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9262 Enabled by default.
9264 @item -fno-toplevel-reorder
9265 @opindex fno-toplevel-reorder
9266 Do not reorder top-level functions, variables, and @code{asm}
9267 statements.  Output them in the same order that they appear in the
9268 input file.  When this option is used, unreferenced static variables
9269 are not removed.  This option is intended to support existing code
9270 that relies on a particular ordering.  For new code, it is better to
9271 use attributes when possible.
9273 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9274 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9275 targets.
9277 @item -fweb
9278 @opindex fweb
9279 Constructs webs as commonly used for register allocation purposes and assign
9280 each web individual pseudo register.  This allows the register allocation pass
9281 to operate on pseudos directly, but also strengthens several other optimization
9282 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9283 however, make debugging impossible, since variables no longer stay in a
9284 ``home register''.
9286 Enabled by default with @option{-funroll-loops}.
9288 @item -fwhole-program
9289 @opindex fwhole-program
9290 Assume that the current compilation unit represents the whole program being
9291 compiled.  All public functions and variables with the exception of @code{main}
9292 and those merged by attribute @code{externally_visible} become static functions
9293 and in effect are optimized more aggressively by interprocedural optimizers.
9295 This option should not be used in combination with @option{-flto}.
9296 Instead relying on a linker plugin should provide safer and more precise
9297 information.
9299 @item -flto[=@var{n}]
9300 @opindex flto
9301 This option runs the standard link-time optimizer.  When invoked
9302 with source code, it generates GIMPLE (one of GCC's internal
9303 representations) and writes it to special ELF sections in the object
9304 file.  When the object files are linked together, all the function
9305 bodies are read from these ELF sections and instantiated as if they
9306 had been part of the same translation unit.
9308 To use the link-time optimizer, @option{-flto} and optimization
9309 options should be specified at compile time and during the final link.
9310 It is recommended that you compile all the files participating in the
9311 same link with the same options and also specify those options at
9312 link time.  
9313 For example:
9315 @smallexample
9316 gcc -c -O2 -flto foo.c
9317 gcc -c -O2 -flto bar.c
9318 gcc -o myprog -flto -O2 foo.o bar.o
9319 @end smallexample
9321 The first two invocations to GCC save a bytecode representation
9322 of GIMPLE into special ELF sections inside @file{foo.o} and
9323 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9324 @file{foo.o} and @file{bar.o}, merges the two files into a single
9325 internal image, and compiles the result as usual.  Since both
9326 @file{foo.o} and @file{bar.o} are merged into a single image, this
9327 causes all the interprocedural analyses and optimizations in GCC to
9328 work across the two files as if they were a single one.  This means,
9329 for example, that the inliner is able to inline functions in
9330 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9332 Another (simpler) way to enable link-time optimization is:
9334 @smallexample
9335 gcc -o myprog -flto -O2 foo.c bar.c
9336 @end smallexample
9338 The above generates bytecode for @file{foo.c} and @file{bar.c},
9339 merges them together into a single GIMPLE representation and optimizes
9340 them as usual to produce @file{myprog}.
9342 The only important thing to keep in mind is that to enable link-time
9343 optimizations you need to use the GCC driver to perform the link step.
9344 GCC then automatically performs link-time optimization if any of the
9345 objects involved were compiled with the @option{-flto} command-line option.  
9346 You generally
9347 should specify the optimization options to be used for link-time
9348 optimization though GCC tries to be clever at guessing an
9349 optimization level to use from the options used at compile time
9350 if you fail to specify one at link time.  You can always override
9351 the automatic decision to do link-time optimization
9352 by passing @option{-fno-lto} to the link command.
9354 To make whole program optimization effective, it is necessary to make
9355 certain whole program assumptions.  The compiler needs to know
9356 what functions and variables can be accessed by libraries and runtime
9357 outside of the link-time optimized unit.  When supported by the linker,
9358 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9359 to the compiler about used and externally visible symbols.  When
9360 the linker plugin is not available, @option{-fwhole-program} should be
9361 used to allow the compiler to make these assumptions, which leads
9362 to more aggressive optimization decisions.
9364 When @option{-fuse-linker-plugin} is not enabled, when a file is
9365 compiled with @option{-flto}, the generated object file is larger than
9366 a regular object file because it contains GIMPLE bytecodes and the usual
9367 final code (see @option{-ffat-lto-objects}.  This means that
9368 object files with LTO information can be linked as normal object
9369 files; if @option{-fno-lto} is passed to the linker, no
9370 interprocedural optimizations are applied.  Note that when
9371 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9372 but you cannot perform a regular, non-LTO link on them.
9374 Additionally, the optimization flags used to compile individual files
9375 are not necessarily related to those used at link time.  For instance,
9377 @smallexample
9378 gcc -c -O0 -ffat-lto-objects -flto foo.c
9379 gcc -c -O0 -ffat-lto-objects -flto bar.c
9380 gcc -o myprog -O3 foo.o bar.o
9381 @end smallexample
9383 This produces individual object files with unoptimized assembler
9384 code, but the resulting binary @file{myprog} is optimized at
9385 @option{-O3}.  If, instead, the final binary is generated with
9386 @option{-fno-lto}, then @file{myprog} is not optimized.
9388 When producing the final binary, GCC only
9389 applies link-time optimizations to those files that contain bytecode.
9390 Therefore, you can mix and match object files and libraries with
9391 GIMPLE bytecodes and final object code.  GCC automatically selects
9392 which files to optimize in LTO mode and which files to link without
9393 further processing.
9395 There are some code generation flags preserved by GCC when
9396 generating bytecodes, as they need to be used during the final link
9397 stage.  Generally options specified at link time override those
9398 specified at compile time.
9400 If you do not specify an optimization level option @option{-O} at
9401 link time, then GCC uses the highest optimization level 
9402 used when compiling the object files.
9404 Currently, the following options and their settings are taken from
9405 the first object file that explicitly specifies them: 
9406 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9407 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9408 and all the @option{-m} target flags.
9410 Certain ABI-changing flags are required to match in all compilation units,
9411 and trying to override this at link time with a conflicting value
9412 is ignored.  This includes options such as @option{-freg-struct-return}
9413 and @option{-fpcc-struct-return}. 
9415 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9416 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9417 are passed through to the link stage and merged conservatively for
9418 conflicting translation units.  Specifically
9419 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9420 precedence; and for example @option{-ffp-contract=off} takes precedence
9421 over @option{-ffp-contract=fast}.  You can override them at link time.
9423 If LTO encounters objects with C linkage declared with incompatible
9424 types in separate translation units to be linked together (undefined
9425 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9426 issued.  The behavior is still undefined at run time.  Similar
9427 diagnostics may be raised for other languages.
9429 Another feature of LTO is that it is possible to apply interprocedural
9430 optimizations on files written in different languages:
9432 @smallexample
9433 gcc -c -flto foo.c
9434 g++ -c -flto bar.cc
9435 gfortran -c -flto baz.f90
9436 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9437 @end smallexample
9439 Notice that the final link is done with @command{g++} to get the C++
9440 runtime libraries and @option{-lgfortran} is added to get the Fortran
9441 runtime libraries.  In general, when mixing languages in LTO mode, you
9442 should use the same link command options as when mixing languages in a
9443 regular (non-LTO) compilation.
9445 If object files containing GIMPLE bytecode are stored in a library archive, say
9446 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9447 are using a linker with plugin support.  To create static libraries suitable
9448 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9449 and @command{ranlib}; 
9450 to show the symbols of object files with GIMPLE bytecode, use
9451 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9452 and @command{nm} have been compiled with plugin support.  At link time, use the the
9453 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9454 the LTO optimization process:
9456 @smallexample
9457 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9458 @end smallexample
9460 With the linker plugin enabled, the linker extracts the needed
9461 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9462 to make them part of the aggregated GIMPLE image to be optimized.
9464 If you are not using a linker with plugin support and/or do not
9465 enable the linker plugin, then the objects inside @file{libfoo.a}
9466 are extracted and linked as usual, but they do not participate
9467 in the LTO optimization process.  In order to make a static library suitable
9468 for both LTO optimization and usual linkage, compile its object files with
9469 @option{-flto} @option{-ffat-lto-objects}.
9471 Link-time optimizations do not require the presence of the whole program to
9472 operate.  If the program does not require any symbols to be exported, it is
9473 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9474 the interprocedural optimizers to use more aggressive assumptions which may
9475 lead to improved optimization opportunities.
9476 Use of @option{-fwhole-program} is not needed when linker plugin is
9477 active (see @option{-fuse-linker-plugin}).
9479 The current implementation of LTO makes no
9480 attempt to generate bytecode that is portable between different
9481 types of hosts.  The bytecode files are versioned and there is a
9482 strict version check, so bytecode files generated in one version of
9483 GCC do not work with an older or newer version of GCC.
9485 Link-time optimization does not work well with generation of debugging
9486 information on systems other than those using a combination of ELF and
9487 DWARF.
9489 If you specify the optional @var{n}, the optimization and code
9490 generation done at link time is executed in parallel using @var{n}
9491 parallel jobs by utilizing an installed @command{make} program.  The
9492 environment variable @env{MAKE} may be used to override the program
9493 used.  The default value for @var{n} is 1.
9495 You can also specify @option{-flto=jobserver} to use GNU make's
9496 job server mode to determine the number of parallel jobs. This
9497 is useful when the Makefile calling GCC is already executing in parallel.
9498 You must prepend a @samp{+} to the command recipe in the parent Makefile
9499 for this to work.  This option likely only works if @env{MAKE} is
9500 GNU make.
9502 @item -flto-partition=@var{alg}
9503 @opindex flto-partition
9504 Specify the partitioning algorithm used by the link-time optimizer.
9505 The value is either @samp{1to1} to specify a partitioning mirroring
9506 the original source files or @samp{balanced} to specify partitioning
9507 into equally sized chunks (whenever possible) or @samp{max} to create
9508 new partition for every symbol where possible.  Specifying @samp{none}
9509 as an algorithm disables partitioning and streaming completely. 
9510 The default value is @samp{balanced}. While @samp{1to1} can be used
9511 as an workaround for various code ordering issues, the @samp{max}
9512 partitioning is intended for internal testing only.
9513 The value @samp{one} specifies that exactly one partition should be
9514 used while the value @samp{none} bypasses partitioning and executes
9515 the link-time optimization step directly from the WPA phase.
9517 @item -flto-odr-type-merging
9518 @opindex flto-odr-type-merging
9519 Enable streaming of mangled types names of C++ types and their unification
9520 at link time.  This increases size of LTO object files, but enables
9521 diagnostics about One Definition Rule violations.
9523 @item -flto-compression-level=@var{n}
9524 @opindex flto-compression-level
9525 This option specifies the level of compression used for intermediate
9526 language written to LTO object files, and is only meaningful in
9527 conjunction with LTO mode (@option{-flto}).  Valid
9528 values are 0 (no compression) to 9 (maximum compression).  Values
9529 outside this range are clamped to either 0 or 9.  If the option is not
9530 given, a default balanced compression setting is used.
9532 @item -fuse-linker-plugin
9533 @opindex fuse-linker-plugin
9534 Enables the use of a linker plugin during link-time optimization.  This
9535 option relies on plugin support in the linker, which is available in gold
9536 or in GNU ld 2.21 or newer.
9538 This option enables the extraction of object files with GIMPLE bytecode out
9539 of library archives. This improves the quality of optimization by exposing
9540 more code to the link-time optimizer.  This information specifies what
9541 symbols can be accessed externally (by non-LTO object or during dynamic
9542 linking).  Resulting code quality improvements on binaries (and shared
9543 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9544 See @option{-flto} for a description of the effect of this flag and how to
9545 use it.
9547 This option is enabled by default when LTO support in GCC is enabled
9548 and GCC was configured for use with
9549 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9551 @item -ffat-lto-objects
9552 @opindex ffat-lto-objects
9553 Fat LTO objects are object files that contain both the intermediate language
9554 and the object code. This makes them usable for both LTO linking and normal
9555 linking. This option is effective only when compiling with @option{-flto}
9556 and is ignored at link time.
9558 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9559 requires the complete toolchain to be aware of LTO. It requires a linker with
9560 linker plugin support for basic functionality.  Additionally,
9561 @command{nm}, @command{ar} and @command{ranlib}
9562 need to support linker plugins to allow a full-featured build environment
9563 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9564 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9565 to these tools. With non fat LTO makefiles need to be modified to use them.
9567 Note that modern binutils provide plugin auto-load mechanism.
9568 Installing the linker plugin into @file{$libdir/bfd-plugins} has the same
9569 effect as usage of the command wrappers (@command{gcc-ar}, @command{gcc-nm} and
9570 @command{gcc-ranlib}).
9572 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9573 support.
9575 @item -fcompare-elim
9576 @opindex fcompare-elim
9577 After register allocation and post-register allocation instruction splitting,
9578 identify arithmetic instructions that compute processor flags similar to a
9579 comparison operation based on that arithmetic.  If possible, eliminate the
9580 explicit comparison operation.
9582 This pass only applies to certain targets that cannot explicitly represent
9583 the comparison operation before register allocation is complete.
9585 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9587 @item -fcprop-registers
9588 @opindex fcprop-registers
9589 After register allocation and post-register allocation instruction splitting,
9590 perform a copy-propagation pass to try to reduce scheduling dependencies
9591 and occasionally eliminate the copy.
9593 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9595 @item -fprofile-correction
9596 @opindex fprofile-correction
9597 Profiles collected using an instrumented binary for multi-threaded programs may
9598 be inconsistent due to missed counter updates. When this option is specified,
9599 GCC uses heuristics to correct or smooth out such inconsistencies. By
9600 default, GCC emits an error message when an inconsistent profile is detected.
9602 @item -fprofile-use
9603 @itemx -fprofile-use=@var{path}
9604 @opindex fprofile-use
9605 Enable profile feedback-directed optimizations, 
9606 and the following optimizations
9607 which are generally profitable only with profile feedback available:
9608 @option{-fbranch-probabilities}, @option{-fvpt},
9609 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9610 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9612 Before you can use this option, you must first generate profiling information.
9613 @xref{Instrumentation Options}, for information about the
9614 @option{-fprofile-generate} option.
9616 By default, GCC emits an error message if the feedback profiles do not
9617 match the source code.  This error can be turned into a warning by using
9618 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9619 code.
9621 If @var{path} is specified, GCC looks at the @var{path} to find
9622 the profile feedback data files. See @option{-fprofile-dir}.
9624 @item -fauto-profile
9625 @itemx -fauto-profile=@var{path}
9626 @opindex fauto-profile
9627 Enable sampling-based feedback-directed optimizations, 
9628 and the following optimizations
9629 which are generally profitable only with profile feedback available:
9630 @option{-fbranch-probabilities}, @option{-fvpt},
9631 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9632 @option{-ftree-vectorize},
9633 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9634 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9635 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9637 @var{path} is the name of a file containing AutoFDO profile information.
9638 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9640 Producing an AutoFDO profile data file requires running your program
9641 with the @command{perf} utility on a supported GNU/Linux target system.
9642 For more information, see @uref{https://perf.wiki.kernel.org/}.
9644 E.g.
9645 @smallexample
9646 perf record -e br_inst_retired:near_taken -b -o perf.data \
9647     -- your_program
9648 @end smallexample
9650 Then use the @command{create_gcov} tool to convert the raw profile data
9651 to a format that can be used by GCC.@  You must also supply the 
9652 unstripped binary for your program to this tool.  
9653 See @uref{https://github.com/google/autofdo}.
9655 E.g.
9656 @smallexample
9657 create_gcov --binary=your_program.unstripped --profile=perf.data \
9658     --gcov=profile.afdo
9659 @end smallexample
9660 @end table
9662 The following options control compiler behavior regarding floating-point 
9663 arithmetic.  These options trade off between speed and
9664 correctness.  All must be specifically enabled.
9666 @table @gcctabopt
9667 @item -ffloat-store
9668 @opindex ffloat-store
9669 Do not store floating-point variables in registers, and inhibit other
9670 options that might change whether a floating-point value is taken from a
9671 register or memory.
9673 @cindex floating-point precision
9674 This option prevents undesirable excess precision on machines such as
9675 the 68000 where the floating registers (of the 68881) keep more
9676 precision than a @code{double} is supposed to have.  Similarly for the
9677 x86 architecture.  For most programs, the excess precision does only
9678 good, but a few programs rely on the precise definition of IEEE floating
9679 point.  Use @option{-ffloat-store} for such programs, after modifying
9680 them to store all pertinent intermediate computations into variables.
9682 @item -fexcess-precision=@var{style}
9683 @opindex fexcess-precision
9684 This option allows further control over excess precision on machines
9685 where floating-point operations occur in a format with more precision or
9686 range than the IEEE standard and interchange floating-point types.  By
9687 default, @option{-fexcess-precision=fast} is in effect; this means that
9688 operations may be carried out in a wider precision than the types specified
9689 in the source if that would result in faster code, and it is unpredictable
9690 when rounding to the types specified in the source code takes place.
9691 When compiling C, if @option{-fexcess-precision=standard} is specified then
9692 excess precision follows the rules specified in ISO C99; in particular,
9693 both casts and assignments cause values to be rounded to their
9694 semantic types (whereas @option{-ffloat-store} only affects
9695 assignments).  This option is enabled by default for C if a strict
9696 conformance option such as @option{-std=c99} is used.
9697 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9698 regardless of whether a strict conformance option is used.
9700 @opindex mfpmath
9701 @option{-fexcess-precision=standard} is not implemented for languages
9702 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9703 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9704 semantics apply without excess precision, and in the latter, rounding
9705 is unpredictable.
9707 @item -ffast-math
9708 @opindex ffast-math
9709 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9710 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9711 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9712 @option{-fexcess-precision=fast}.
9714 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9716 This option is not turned on by any @option{-O} option besides
9717 @option{-Ofast} since it can result in incorrect output for programs
9718 that depend on an exact implementation of IEEE or ISO rules/specifications
9719 for math functions. It may, however, yield faster code for programs
9720 that do not require the guarantees of these specifications.
9722 @item -fno-math-errno
9723 @opindex fno-math-errno
9724 Do not set @code{errno} after calling math functions that are executed
9725 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9726 IEEE exceptions for math error handling may want to use this flag
9727 for speed while maintaining IEEE arithmetic compatibility.
9729 This option is not turned on by any @option{-O} option since
9730 it can result in incorrect output for programs that depend on
9731 an exact implementation of IEEE or ISO rules/specifications for
9732 math functions. It may, however, yield faster code for programs
9733 that do not require the guarantees of these specifications.
9735 The default is @option{-fmath-errno}.
9737 On Darwin systems, the math library never sets @code{errno}.  There is
9738 therefore no reason for the compiler to consider the possibility that
9739 it might, and @option{-fno-math-errno} is the default.
9741 @item -funsafe-math-optimizations
9742 @opindex funsafe-math-optimizations
9744 Allow optimizations for floating-point arithmetic that (a) assume
9745 that arguments and results are valid and (b) may violate IEEE or
9746 ANSI standards.  When used at link time, it may include libraries
9747 or startup files that change the default FPU control word or other
9748 similar optimizations.
9750 This option is not turned on by any @option{-O} option since
9751 it can result in incorrect output for programs that depend on
9752 an exact implementation of IEEE or ISO rules/specifications for
9753 math functions. It may, however, yield faster code for programs
9754 that do not require the guarantees of these specifications.
9755 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9756 @option{-fassociative-math} and @option{-freciprocal-math}.
9758 The default is @option{-fno-unsafe-math-optimizations}.
9760 @item -fassociative-math
9761 @opindex fassociative-math
9763 Allow re-association of operands in series of floating-point operations.
9764 This violates the ISO C and C++ language standard by possibly changing
9765 computation result.  NOTE: re-ordering may change the sign of zero as
9766 well as ignore NaNs and inhibit or create underflow or overflow (and
9767 thus cannot be used on code that relies on rounding behavior like
9768 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9769 and thus may not be used when ordered comparisons are required.
9770 This option requires that both @option{-fno-signed-zeros} and
9771 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9772 much sense with @option{-frounding-math}. For Fortran the option
9773 is automatically enabled when both @option{-fno-signed-zeros} and
9774 @option{-fno-trapping-math} are in effect.
9776 The default is @option{-fno-associative-math}.
9778 @item -freciprocal-math
9779 @opindex freciprocal-math
9781 Allow the reciprocal of a value to be used instead of dividing by
9782 the value if this enables optimizations.  For example @code{x / y}
9783 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9784 is subject to common subexpression elimination.  Note that this loses
9785 precision and increases the number of flops operating on the value.
9787 The default is @option{-fno-reciprocal-math}.
9789 @item -ffinite-math-only
9790 @opindex ffinite-math-only
9791 Allow optimizations for floating-point arithmetic that assume
9792 that arguments and results are not NaNs or +-Infs.
9794 This option is not turned on by any @option{-O} option since
9795 it can result in incorrect output for programs that depend on
9796 an exact implementation of IEEE or ISO rules/specifications for
9797 math functions. It may, however, yield faster code for programs
9798 that do not require the guarantees of these specifications.
9800 The default is @option{-fno-finite-math-only}.
9802 @item -fno-signed-zeros
9803 @opindex fno-signed-zeros
9804 Allow optimizations for floating-point arithmetic that ignore the
9805 signedness of zero.  IEEE arithmetic specifies the behavior of
9806 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9807 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9808 This option implies that the sign of a zero result isn't significant.
9810 The default is @option{-fsigned-zeros}.
9812 @item -fno-trapping-math
9813 @opindex fno-trapping-math
9814 Compile code assuming that floating-point operations cannot generate
9815 user-visible traps.  These traps include division by zero, overflow,
9816 underflow, inexact result and invalid operation.  This option requires
9817 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9818 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9820 This option should never be turned on by any @option{-O} option since
9821 it can result in incorrect output for programs that depend on
9822 an exact implementation of IEEE or ISO rules/specifications for
9823 math functions.
9825 The default is @option{-ftrapping-math}.
9827 @item -frounding-math
9828 @opindex frounding-math
9829 Disable transformations and optimizations that assume default floating-point
9830 rounding behavior.  This is round-to-zero for all floating point
9831 to integer conversions, and round-to-nearest for all other arithmetic
9832 truncations.  This option should be specified for programs that change
9833 the FP rounding mode dynamically, or that may be executed with a
9834 non-default rounding mode.  This option disables constant folding of
9835 floating-point expressions at compile time (which may be affected by
9836 rounding mode) and arithmetic transformations that are unsafe in the
9837 presence of sign-dependent rounding modes.
9839 The default is @option{-fno-rounding-math}.
9841 This option is experimental and does not currently guarantee to
9842 disable all GCC optimizations that are affected by rounding mode.
9843 Future versions of GCC may provide finer control of this setting
9844 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9845 will be used to specify the default state for @code{FENV_ACCESS}.
9847 @item -fsignaling-nans
9848 @opindex fsignaling-nans
9849 Compile code assuming that IEEE signaling NaNs may generate user-visible
9850 traps during floating-point operations.  Setting this option disables
9851 optimizations that may change the number of exceptions visible with
9852 signaling NaNs.  This option implies @option{-ftrapping-math}.
9854 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9855 be defined.
9857 The default is @option{-fno-signaling-nans}.
9859 This option is experimental and does not currently guarantee to
9860 disable all GCC optimizations that affect signaling NaN behavior.
9862 @item -fno-fp-int-builtin-inexact
9863 @opindex fno-fp-int-builtin-inexact
9864 Do not allow the built-in functions @code{ceil}, @code{floor},
9865 @code{round} and @code{trunc}, and their @code{float} and @code{long
9866 double} variants, to generate code that raises the ``inexact''
9867 floating-point exception for noninteger arguments.  ISO C99 and C11
9868 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9869 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9870 functions to do so.
9872 The default is @option{-ffp-int-builtin-inexact}, allowing the
9873 exception to be raised.  This option does nothing unless
9874 @option{-ftrapping-math} is in effect.
9876 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9877 generate a call to a library function then the ``inexact'' exception
9878 may be raised if the library implementation does not follow TS 18661.
9880 @item -fsingle-precision-constant
9881 @opindex fsingle-precision-constant
9882 Treat floating-point constants as single precision instead of
9883 implicitly converting them to double-precision constants.
9885 @item -fcx-limited-range
9886 @opindex fcx-limited-range
9887 When enabled, this option states that a range reduction step is not
9888 needed when performing complex division.  Also, there is no checking
9889 whether the result of a complex multiplication or division is @code{NaN
9890 + I*NaN}, with an attempt to rescue the situation in that case.  The
9891 default is @option{-fno-cx-limited-range}, but is enabled by
9892 @option{-ffast-math}.
9894 This option controls the default setting of the ISO C99
9895 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9896 all languages.
9898 @item -fcx-fortran-rules
9899 @opindex fcx-fortran-rules
9900 Complex multiplication and division follow Fortran rules.  Range
9901 reduction is done as part of complex division, but there is no checking
9902 whether the result of a complex multiplication or division is @code{NaN
9903 + I*NaN}, with an attempt to rescue the situation in that case.
9905 The default is @option{-fno-cx-fortran-rules}.
9907 @end table
9909 The following options control optimizations that may improve
9910 performance, but are not enabled by any @option{-O} options.  This
9911 section includes experimental options that may produce broken code.
9913 @table @gcctabopt
9914 @item -fbranch-probabilities
9915 @opindex fbranch-probabilities
9916 After running a program compiled with @option{-fprofile-arcs}
9917 (@pxref{Instrumentation Options}),
9918 you can compile it a second time using
9919 @option{-fbranch-probabilities}, to improve optimizations based on
9920 the number of times each branch was taken.  When a program
9921 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9922 counts to a file called @file{@var{sourcename}.gcda} for each source
9923 file.  The information in this data file is very dependent on the
9924 structure of the generated code, so you must use the same source code
9925 and the same optimization options for both compilations.
9927 With @option{-fbranch-probabilities}, GCC puts a
9928 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9929 These can be used to improve optimization.  Currently, they are only
9930 used in one place: in @file{reorg.c}, instead of guessing which path a
9931 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9932 exactly determine which path is taken more often.
9934 @item -fprofile-values
9935 @opindex fprofile-values
9936 If combined with @option{-fprofile-arcs}, it adds code so that some
9937 data about values of expressions in the program is gathered.
9939 With @option{-fbranch-probabilities}, it reads back the data gathered
9940 from profiling values of expressions for usage in optimizations.
9942 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9944 @item -fprofile-reorder-functions
9945 @opindex fprofile-reorder-functions
9946 Function reordering based on profile instrumentation collects
9947 first time of execution of a function and orders these functions
9948 in ascending order.
9950 Enabled with @option{-fprofile-use}.
9952 @item -fvpt
9953 @opindex fvpt
9954 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9955 to add code to gather information about values of expressions.
9957 With @option{-fbranch-probabilities}, it reads back the data gathered
9958 and actually performs the optimizations based on them.
9959 Currently the optimizations include specialization of division operations
9960 using the knowledge about the value of the denominator.
9962 @item -frename-registers
9963 @opindex frename-registers
9964 Attempt to avoid false dependencies in scheduled code by making use
9965 of registers left over after register allocation.  This optimization
9966 most benefits processors with lots of registers.  Depending on the
9967 debug information format adopted by the target, however, it can
9968 make debugging impossible, since variables no longer stay in
9969 a ``home register''.
9971 Enabled by default with @option{-funroll-loops}.
9973 @item -fschedule-fusion
9974 @opindex fschedule-fusion
9975 Performs a target dependent pass over the instruction stream to schedule
9976 instructions of same type together because target machine can execute them
9977 more efficiently if they are adjacent to each other in the instruction flow.
9979 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9981 @item -ftracer
9982 @opindex ftracer
9983 Perform tail duplication to enlarge superblock size.  This transformation
9984 simplifies the control flow of the function allowing other optimizations to do
9985 a better job.
9987 Enabled with @option{-fprofile-use}.
9989 @item -funroll-loops
9990 @opindex funroll-loops
9991 Unroll loops whose number of iterations can be determined at compile time or
9992 upon entry to the loop.  @option{-funroll-loops} implies
9993 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9994 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9995 a small constant number of iterations).  This option makes code larger, and may
9996 or may not make it run faster.
9998 Enabled with @option{-fprofile-use}.
10000 @item -funroll-all-loops
10001 @opindex funroll-all-loops
10002 Unroll all loops, even if their number of iterations is uncertain when
10003 the loop is entered.  This usually makes programs run more slowly.
10004 @option{-funroll-all-loops} implies the same options as
10005 @option{-funroll-loops}.
10007 @item -fpeel-loops
10008 @opindex fpeel-loops
10009 Peels loops for which there is enough information that they do not
10010 roll much (from profile feedback or static analysis).  It also turns on
10011 complete loop peeling (i.e.@: complete removal of loops with small constant
10012 number of iterations).
10014 Enabled with @option{-O3} and/or @option{-fprofile-use}.
10016 @item -fmove-loop-invariants
10017 @opindex fmove-loop-invariants
10018 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10019 at level @option{-O1}
10021 @item -fsplit-loops
10022 @opindex fsplit-loops
10023 Split a loop into two if it contains a condition that's always true
10024 for one side of the iteration space and false for the other.
10026 @item -funswitch-loops
10027 @opindex funswitch-loops
10028 Move branches with loop invariant conditions out of the loop, with duplicates
10029 of the loop on both branches (modified according to result of the condition).
10031 @item -floop-unroll-and-jam
10032 @opindex floop-unroll-and-jam
10033 Apply unroll and jam transformations on feasible loops.  In a loop
10034 nest this unrolls the outer loop by some factor and fuses the resulting
10035 multiple inner loops.
10037 @item -ffunction-sections
10038 @itemx -fdata-sections
10039 @opindex ffunction-sections
10040 @opindex fdata-sections
10041 Place each function or data item into its own section in the output
10042 file if the target supports arbitrary sections.  The name of the
10043 function or the name of the data item determines the section's name
10044 in the output file.
10046 Use these options on systems where the linker can perform optimizations to
10047 improve locality of reference in the instruction space.  Most systems using the
10048 ELF object format have linkers with such optimizations.  On AIX, the linker
10049 rearranges sections (CSECTs) based on the call graph.  The performance impact
10050 varies.
10052 Together with a linker garbage collection (linker @option{--gc-sections}
10053 option) these options may lead to smaller statically-linked executables (after
10054 stripping).
10056 On ELF/DWARF systems these options do not degenerate the quality of the debug
10057 information.  There could be issues with other object files/debug info formats.
10059 Only use these options when there are significant benefits from doing so.  When
10060 you specify these options, the assembler and linker create larger object and
10061 executable files and are also slower.  These options affect code generation.
10062 They prevent optimizations by the compiler and assembler using relative
10063 locations inside a translation unit since the locations are unknown until
10064 link time.  An example of such an optimization is relaxing calls to short call
10065 instructions.
10067 @item -fbranch-target-load-optimize
10068 @opindex fbranch-target-load-optimize
10069 Perform branch target register load optimization before prologue / epilogue
10070 threading.
10071 The use of target registers can typically be exposed only during reload,
10072 thus hoisting loads out of loops and doing inter-block scheduling needs
10073 a separate optimization pass.
10075 @item -fbranch-target-load-optimize2
10076 @opindex fbranch-target-load-optimize2
10077 Perform branch target register load optimization after prologue / epilogue
10078 threading.
10080 @item -fbtr-bb-exclusive
10081 @opindex fbtr-bb-exclusive
10082 When performing branch target register load optimization, don't reuse
10083 branch target registers within any basic block.
10085 @item -fstdarg-opt
10086 @opindex fstdarg-opt
10087 Optimize the prologue of variadic argument functions with respect to usage of
10088 those arguments.
10090 @item -fsection-anchors
10091 @opindex fsection-anchors
10092 Try to reduce the number of symbolic address calculations by using
10093 shared ``anchor'' symbols to address nearby objects.  This transformation
10094 can help to reduce the number of GOT entries and GOT accesses on some
10095 targets.
10097 For example, the implementation of the following function @code{foo}:
10099 @smallexample
10100 static int a, b, c;
10101 int foo (void) @{ return a + b + c; @}
10102 @end smallexample
10104 @noindent
10105 usually calculates the addresses of all three variables, but if you
10106 compile it with @option{-fsection-anchors}, it accesses the variables
10107 from a common anchor point instead.  The effect is similar to the
10108 following pseudocode (which isn't valid C):
10110 @smallexample
10111 int foo (void)
10113   register int *xr = &x;
10114   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10116 @end smallexample
10118 Not all targets support this option.
10120 @item --param @var{name}=@var{value}
10121 @opindex param
10122 In some places, GCC uses various constants to control the amount of
10123 optimization that is done.  For example, GCC does not inline functions
10124 that contain more than a certain number of instructions.  You can
10125 control some of these constants on the command line using the
10126 @option{--param} option.
10128 The names of specific parameters, and the meaning of the values, are
10129 tied to the internals of the compiler, and are subject to change
10130 without notice in future releases.
10132 In each case, the @var{value} is an integer.  The allowable choices for
10133 @var{name} are:
10135 @table @gcctabopt
10136 @item predictable-branch-outcome
10137 When branch is predicted to be taken with probability lower than this threshold
10138 (in percent), then it is considered well predictable. The default is 10.
10140 @item max-rtl-if-conversion-insns
10141 RTL if-conversion tries to remove conditional branches around a block and
10142 replace them with conditionally executed instructions.  This parameter
10143 gives the maximum number of instructions in a block which should be
10144 considered for if-conversion.  The default is 10, though the compiler will
10145 also use other heuristics to decide whether if-conversion is likely to be
10146 profitable.
10148 @item max-rtl-if-conversion-predictable-cost
10149 @itemx max-rtl-if-conversion-unpredictable-cost
10150 RTL if-conversion will try to remove conditional branches around a block
10151 and replace them with conditionally executed instructions.  These parameters
10152 give the maximum permissible cost for the sequence that would be generated
10153 by if-conversion depending on whether the branch is statically determined
10154 to be predictable or not.  The units for this parameter are the same as
10155 those for the GCC internal seq_cost metric.  The compiler will try to
10156 provide a reasonable default for this parameter using the BRANCH_COST
10157 target macro.
10159 @item max-crossjump-edges
10160 The maximum number of incoming edges to consider for cross-jumping.
10161 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10162 the number of edges incoming to each block.  Increasing values mean
10163 more aggressive optimization, making the compilation time increase with
10164 probably small improvement in executable size.
10166 @item min-crossjump-insns
10167 The minimum number of instructions that must be matched at the end
10168 of two blocks before cross-jumping is performed on them.  This
10169 value is ignored in the case where all instructions in the block being
10170 cross-jumped from are matched.  The default value is 5.
10172 @item max-grow-copy-bb-insns
10173 The maximum code size expansion factor when copying basic blocks
10174 instead of jumping.  The expansion is relative to a jump instruction.
10175 The default value is 8.
10177 @item max-goto-duplication-insns
10178 The maximum number of instructions to duplicate to a block that jumps
10179 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10180 passes, GCC factors computed gotos early in the compilation process,
10181 and unfactors them as late as possible.  Only computed jumps at the
10182 end of a basic blocks with no more than max-goto-duplication-insns are
10183 unfactored.  The default value is 8.
10185 @item max-delay-slot-insn-search
10186 The maximum number of instructions to consider when looking for an
10187 instruction to fill a delay slot.  If more than this arbitrary number of
10188 instructions are searched, the time savings from filling the delay slot
10189 are minimal, so stop searching.  Increasing values mean more
10190 aggressive optimization, making the compilation time increase with probably
10191 small improvement in execution time.
10193 @item max-delay-slot-live-search
10194 When trying to fill delay slots, the maximum number of instructions to
10195 consider when searching for a block with valid live register
10196 information.  Increasing this arbitrarily chosen value means more
10197 aggressive optimization, increasing the compilation time.  This parameter
10198 should be removed when the delay slot code is rewritten to maintain the
10199 control-flow graph.
10201 @item max-gcse-memory
10202 The approximate maximum amount of memory that can be allocated in
10203 order to perform the global common subexpression elimination
10204 optimization.  If more memory than specified is required, the
10205 optimization is not done.
10207 @item max-gcse-insertion-ratio
10208 If the ratio of expression insertions to deletions is larger than this value
10209 for any expression, then RTL PRE inserts or removes the expression and thus
10210 leaves partially redundant computations in the instruction stream.  The default value is 20.
10212 @item max-pending-list-length
10213 The maximum number of pending dependencies scheduling allows
10214 before flushing the current state and starting over.  Large functions
10215 with few branches or calls can create excessively large lists which
10216 needlessly consume memory and resources.
10218 @item max-modulo-backtrack-attempts
10219 The maximum number of backtrack attempts the scheduler should make
10220 when modulo scheduling a loop.  Larger values can exponentially increase
10221 compilation time.
10223 @item max-inline-insns-single
10224 Several parameters control the tree inliner used in GCC@.
10225 This number sets the maximum number of instructions (counted in GCC's
10226 internal representation) in a single function that the tree inliner
10227 considers for inlining.  This only affects functions declared
10228 inline and methods implemented in a class declaration (C++).
10229 The default value is 400.
10231 @item max-inline-insns-auto
10232 When you use @option{-finline-functions} (included in @option{-O3}),
10233 a lot of functions that would otherwise not be considered for inlining
10234 by the compiler are investigated.  To those functions, a different
10235 (more restrictive) limit compared to functions declared inline can
10236 be applied.
10237 The default value is 30.
10239 @item inline-min-speedup
10240 When estimated performance improvement of caller + callee runtime exceeds this
10241 threshold (in percent), the function can be inlined regardless of the limit on
10242 @option{--param max-inline-insns-single} and @option{--param
10243 max-inline-insns-auto}.
10244 The default value is 15.
10246 @item large-function-insns
10247 The limit specifying really large functions.  For functions larger than this
10248 limit after inlining, inlining is constrained by
10249 @option{--param large-function-growth}.  This parameter is useful primarily
10250 to avoid extreme compilation time caused by non-linear algorithms used by the
10251 back end.
10252 The default value is 2700.
10254 @item large-function-growth
10255 Specifies maximal growth of large function caused by inlining in percents.
10256 The default value is 100 which limits large function growth to 2.0 times
10257 the original size.
10259 @item large-unit-insns
10260 The limit specifying large translation unit.  Growth caused by inlining of
10261 units larger than this limit is limited by @option{--param inline-unit-growth}.
10262 For small units this might be too tight.
10263 For example, consider a unit consisting of function A
10264 that is inline and B that just calls A three times.  If B is small relative to
10265 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10266 large units consisting of small inlineable functions, however, the overall unit
10267 growth limit is needed to avoid exponential explosion of code size.  Thus for
10268 smaller units, the size is increased to @option{--param large-unit-insns}
10269 before applying @option{--param inline-unit-growth}.  The default is 10000.
10271 @item inline-unit-growth
10272 Specifies maximal overall growth of the compilation unit caused by inlining.
10273 The default value is 20 which limits unit growth to 1.2 times the original
10274 size. Cold functions (either marked cold via an attribute or by profile
10275 feedback) are not accounted into the unit size.
10277 @item ipcp-unit-growth
10278 Specifies maximal overall growth of the compilation unit caused by
10279 interprocedural constant propagation.  The default value is 10 which limits
10280 unit growth to 1.1 times the original size.
10282 @item large-stack-frame
10283 The limit specifying large stack frames.  While inlining the algorithm is trying
10284 to not grow past this limit too much.  The default value is 256 bytes.
10286 @item large-stack-frame-growth
10287 Specifies maximal growth of large stack frames caused by inlining in percents.
10288 The default value is 1000 which limits large stack frame growth to 11 times
10289 the original size.
10291 @item max-inline-insns-recursive
10292 @itemx max-inline-insns-recursive-auto
10293 Specifies the maximum number of instructions an out-of-line copy of a
10294 self-recursive inline
10295 function can grow into by performing recursive inlining.
10297 @option{--param max-inline-insns-recursive} applies to functions
10298 declared inline.
10299 For functions not declared inline, recursive inlining
10300 happens only when @option{-finline-functions} (included in @option{-O3}) is
10301 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10302 default value is 450.
10304 @item max-inline-recursive-depth
10305 @itemx max-inline-recursive-depth-auto
10306 Specifies the maximum recursion depth used for recursive inlining.
10308 @option{--param max-inline-recursive-depth} applies to functions
10309 declared inline.  For functions not declared inline, recursive inlining
10310 happens only when @option{-finline-functions} (included in @option{-O3}) is
10311 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10312 default value is 8.
10314 @item min-inline-recursive-probability
10315 Recursive inlining is profitable only for function having deep recursion
10316 in average and can hurt for function having little recursion depth by
10317 increasing the prologue size or complexity of function body to other
10318 optimizers.
10320 When profile feedback is available (see @option{-fprofile-generate}) the actual
10321 recursion depth can be guessed from the probability that function recurses
10322 via a given call expression.  This parameter limits inlining only to call
10323 expressions whose probability exceeds the given threshold (in percents).
10324 The default value is 10.
10326 @item early-inlining-insns
10327 Specify growth that the early inliner can make.  In effect it increases
10328 the amount of inlining for code having a large abstraction penalty.
10329 The default value is 14.
10331 @item max-early-inliner-iterations
10332 Limit of iterations of the early inliner.  This basically bounds
10333 the number of nested indirect calls the early inliner can resolve.
10334 Deeper chains are still handled by late inlining.
10336 @item comdat-sharing-probability
10337 Probability (in percent) that C++ inline function with comdat visibility
10338 are shared across multiple compilation units.  The default value is 20.
10340 @item profile-func-internal-id
10341 A parameter to control whether to use function internal id in profile
10342 database lookup. If the value is 0, the compiler uses an id that
10343 is based on function assembler name and filename, which makes old profile
10344 data more tolerant to source changes such as function reordering etc.
10345 The default value is 0.
10347 @item min-vect-loop-bound
10348 The minimum number of iterations under which loops are not vectorized
10349 when @option{-ftree-vectorize} is used.  The number of iterations after
10350 vectorization needs to be greater than the value specified by this option
10351 to allow vectorization.  The default value is 0.
10353 @item gcse-cost-distance-ratio
10354 Scaling factor in calculation of maximum distance an expression
10355 can be moved by GCSE optimizations.  This is currently supported only in the
10356 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10357 is with simple expressions, i.e., the expressions that have cost
10358 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10359 hoisting of simple expressions.  The default value is 10.
10361 @item gcse-unrestricted-cost
10362 Cost, roughly measured as the cost of a single typical machine
10363 instruction, at which GCSE optimizations do not constrain
10364 the distance an expression can travel.  This is currently
10365 supported only in the code hoisting pass.  The lesser the cost,
10366 the more aggressive code hoisting is.  Specifying 0 
10367 allows all expressions to travel unrestricted distances.
10368 The default value is 3.
10370 @item max-hoist-depth
10371 The depth of search in the dominator tree for expressions to hoist.
10372 This is used to avoid quadratic behavior in hoisting algorithm.
10373 The value of 0 does not limit on the search, but may slow down compilation
10374 of huge functions.  The default value is 30.
10376 @item max-tail-merge-comparisons
10377 The maximum amount of similar bbs to compare a bb with.  This is used to
10378 avoid quadratic behavior in tree tail merging.  The default value is 10.
10380 @item max-tail-merge-iterations
10381 The maximum amount of iterations of the pass over the function.  This is used to
10382 limit compilation time in tree tail merging.  The default value is 2.
10384 @item store-merging-allow-unaligned
10385 Allow the store merging pass to introduce unaligned stores if it is legal to
10386 do so.  The default value is 1.
10388 @item max-stores-to-merge
10389 The maximum number of stores to attempt to merge into wider stores in the store
10390 merging pass.  The minimum value is 2 and the default is 64.
10392 @item max-unrolled-insns
10393 The maximum number of instructions that a loop may have to be unrolled.
10394 If a loop is unrolled, this parameter also determines how many times
10395 the loop code is unrolled.
10397 @item max-average-unrolled-insns
10398 The maximum number of instructions biased by probabilities of their execution
10399 that a loop may have to be unrolled.  If a loop is unrolled,
10400 this parameter also determines how many times the loop code is unrolled.
10402 @item max-unroll-times
10403 The maximum number of unrollings of a single loop.
10405 @item max-peeled-insns
10406 The maximum number of instructions that a loop may have to be peeled.
10407 If a loop is peeled, this parameter also determines how many times
10408 the loop code is peeled.
10410 @item max-peel-times
10411 The maximum number of peelings of a single loop.
10413 @item max-peel-branches
10414 The maximum number of branches on the hot path through the peeled sequence.
10416 @item max-completely-peeled-insns
10417 The maximum number of insns of a completely peeled loop.
10419 @item max-completely-peel-times
10420 The maximum number of iterations of a loop to be suitable for complete peeling.
10422 @item max-completely-peel-loop-nest-depth
10423 The maximum depth of a loop nest suitable for complete peeling.
10425 @item max-unswitch-insns
10426 The maximum number of insns of an unswitched loop.
10428 @item max-unswitch-level
10429 The maximum number of branches unswitched in a single loop.
10431 @item max-loop-headers-insns
10432 The maximum number of insns in loop header duplicated by the copy loop headers
10433 pass.
10435 @item lim-expensive
10436 The minimum cost of an expensive expression in the loop invariant motion.
10438 @item iv-consider-all-candidates-bound
10439 Bound on number of candidates for induction variables, below which
10440 all candidates are considered for each use in induction variable
10441 optimizations.  If there are more candidates than this,
10442 only the most relevant ones are considered to avoid quadratic time complexity.
10444 @item iv-max-considered-uses
10445 The induction variable optimizations give up on loops that contain more
10446 induction variable uses.
10448 @item iv-always-prune-cand-set-bound
10449 If the number of candidates in the set is smaller than this value,
10450 always try to remove unnecessary ivs from the set
10451 when adding a new one.
10453 @item avg-loop-niter
10454 Average number of iterations of a loop.
10456 @item dse-max-object-size
10457 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10458 Larger values may result in larger compilation times.
10460 @item scev-max-expr-size
10461 Bound on size of expressions used in the scalar evolutions analyzer.
10462 Large expressions slow the analyzer.
10464 @item scev-max-expr-complexity
10465 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10466 Complex expressions slow the analyzer.
10468 @item max-tree-if-conversion-phi-args
10469 Maximum number of arguments in a PHI supported by TREE if conversion
10470 unless the loop is marked with simd pragma.
10472 @item vect-max-version-for-alignment-checks
10473 The maximum number of run-time checks that can be performed when
10474 doing loop versioning for alignment in the vectorizer.
10476 @item vect-max-version-for-alias-checks
10477 The maximum number of run-time checks that can be performed when
10478 doing loop versioning for alias in the vectorizer.
10480 @item vect-max-peeling-for-alignment
10481 The maximum number of loop peels to enhance access alignment
10482 for vectorizer. Value -1 means no limit.
10484 @item max-iterations-to-track
10485 The maximum number of iterations of a loop the brute-force algorithm
10486 for analysis of the number of iterations of the loop tries to evaluate.
10488 @item hot-bb-count-ws-permille
10489 A basic block profile count is considered hot if it contributes to 
10490 the given permillage (i.e. 0...1000) of the entire profiled execution.
10492 @item hot-bb-frequency-fraction
10493 Select fraction of the entry block frequency of executions of basic block in
10494 function given basic block needs to have to be considered hot.
10496 @item max-predicted-iterations
10497 The maximum number of loop iterations we predict statically.  This is useful
10498 in cases where a function contains a single loop with known bound and
10499 another loop with unknown bound.
10500 The known number of iterations is predicted correctly, while
10501 the unknown number of iterations average to roughly 10.  This means that the
10502 loop without bounds appears artificially cold relative to the other one.
10504 @item builtin-expect-probability
10505 Control the probability of the expression having the specified value. This
10506 parameter takes a percentage (i.e. 0 ... 100) as input.
10507 The default probability of 90 is obtained empirically.
10509 @item align-threshold
10511 Select fraction of the maximal frequency of executions of a basic block in
10512 a function to align the basic block.
10514 @item align-loop-iterations
10516 A loop expected to iterate at least the selected number of iterations is
10517 aligned.
10519 @item tracer-dynamic-coverage
10520 @itemx tracer-dynamic-coverage-feedback
10522 This value is used to limit superblock formation once the given percentage of
10523 executed instructions is covered.  This limits unnecessary code size
10524 expansion.
10526 The @option{tracer-dynamic-coverage-feedback} parameter
10527 is used only when profile
10528 feedback is available.  The real profiles (as opposed to statically estimated
10529 ones) are much less balanced allowing the threshold to be larger value.
10531 @item tracer-max-code-growth
10532 Stop tail duplication once code growth has reached given percentage.  This is
10533 a rather artificial limit, as most of the duplicates are eliminated later in
10534 cross jumping, so it may be set to much higher values than is the desired code
10535 growth.
10537 @item tracer-min-branch-ratio
10539 Stop reverse growth when the reverse probability of best edge is less than this
10540 threshold (in percent).
10542 @item tracer-min-branch-probability
10543 @itemx tracer-min-branch-probability-feedback
10545 Stop forward growth if the best edge has probability lower than this
10546 threshold.
10548 Similarly to @option{tracer-dynamic-coverage} two parameters are
10549 provided.  @option{tracer-min-branch-probability-feedback} is used for
10550 compilation with profile feedback and @option{tracer-min-branch-probability}
10551 compilation without.  The value for compilation with profile feedback
10552 needs to be more conservative (higher) in order to make tracer
10553 effective.
10555 @item stack-clash-protection-guard-size
10556 Specify the size of the operating system provided stack guard as
10557 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10558 Acceptable values are between 12 and 30.  Higher values may reduce the
10559 number of explicit probes, but a value larger than the operating system
10560 provided guard will leave code vulnerable to stack clash style attacks.
10562 @item stack-clash-protection-probe-interval
10563 Stack clash protection involves probing stack space as it is allocated.  This
10564 param controls the maximum distance between probes into the stack as 2 raised
10565 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10566 12.  Higher values may reduce the number of explicit probes, but a value
10567 larger than the operating system provided guard will leave code vulnerable to
10568 stack clash style attacks.
10570 @item max-cse-path-length
10572 The maximum number of basic blocks on path that CSE considers.
10573 The default is 10.
10575 @item max-cse-insns
10576 The maximum number of instructions CSE processes before flushing.
10577 The default is 1000.
10579 @item ggc-min-expand
10581 GCC uses a garbage collector to manage its own memory allocation.  This
10582 parameter specifies the minimum percentage by which the garbage
10583 collector's heap should be allowed to expand between collections.
10584 Tuning this may improve compilation speed; it has no effect on code
10585 generation.
10587 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10588 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10589 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10590 GCC is not able to calculate RAM on a particular platform, the lower
10591 bound of 30% is used.  Setting this parameter and
10592 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10593 every opportunity.  This is extremely slow, but can be useful for
10594 debugging.
10596 @item ggc-min-heapsize
10598 Minimum size of the garbage collector's heap before it begins bothering
10599 to collect garbage.  The first collection occurs after the heap expands
10600 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10601 tuning this may improve compilation speed, and has no effect on code
10602 generation.
10604 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10605 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10606 with a lower bound of 4096 (four megabytes) and an upper bound of
10607 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10608 particular platform, the lower bound is used.  Setting this parameter
10609 very large effectively disables garbage collection.  Setting this
10610 parameter and @option{ggc-min-expand} to zero causes a full collection
10611 to occur at every opportunity.
10613 @item max-reload-search-insns
10614 The maximum number of instruction reload should look backward for equivalent
10615 register.  Increasing values mean more aggressive optimization, making the
10616 compilation time increase with probably slightly better performance.
10617 The default value is 100.
10619 @item max-cselib-memory-locations
10620 The maximum number of memory locations cselib should take into account.
10621 Increasing values mean more aggressive optimization, making the compilation time
10622 increase with probably slightly better performance.  The default value is 500.
10624 @item max-sched-ready-insns
10625 The maximum number of instructions ready to be issued the scheduler should
10626 consider at any given time during the first scheduling pass.  Increasing
10627 values mean more thorough searches, making the compilation time increase
10628 with probably little benefit.  The default value is 100.
10630 @item max-sched-region-blocks
10631 The maximum number of blocks in a region to be considered for
10632 interblock scheduling.  The default value is 10.
10634 @item max-pipeline-region-blocks
10635 The maximum number of blocks in a region to be considered for
10636 pipelining in the selective scheduler.  The default value is 15.
10638 @item max-sched-region-insns
10639 The maximum number of insns in a region to be considered for
10640 interblock scheduling.  The default value is 100.
10642 @item max-pipeline-region-insns
10643 The maximum number of insns in a region to be considered for
10644 pipelining in the selective scheduler.  The default value is 200.
10646 @item min-spec-prob
10647 The minimum probability (in percents) of reaching a source block
10648 for interblock speculative scheduling.  The default value is 40.
10650 @item max-sched-extend-regions-iters
10651 The maximum number of iterations through CFG to extend regions.
10652 A value of 0 (the default) disables region extensions.
10654 @item max-sched-insn-conflict-delay
10655 The maximum conflict delay for an insn to be considered for speculative motion.
10656 The default value is 3.
10658 @item sched-spec-prob-cutoff
10659 The minimal probability of speculation success (in percents), so that
10660 speculative insns are scheduled.
10661 The default value is 40.
10663 @item sched-state-edge-prob-cutoff
10664 The minimum probability an edge must have for the scheduler to save its
10665 state across it.
10666 The default value is 10.
10668 @item sched-mem-true-dep-cost
10669 Minimal distance (in CPU cycles) between store and load targeting same
10670 memory locations.  The default value is 1.
10672 @item selsched-max-lookahead
10673 The maximum size of the lookahead window of selective scheduling.  It is a
10674 depth of search for available instructions.
10675 The default value is 50.
10677 @item selsched-max-sched-times
10678 The maximum number of times that an instruction is scheduled during
10679 selective scheduling.  This is the limit on the number of iterations
10680 through which the instruction may be pipelined.  The default value is 2.
10682 @item selsched-insns-to-rename
10683 The maximum number of best instructions in the ready list that are considered
10684 for renaming in the selective scheduler.  The default value is 2.
10686 @item sms-min-sc
10687 The minimum value of stage count that swing modulo scheduler
10688 generates.  The default value is 2.
10690 @item max-last-value-rtl
10691 The maximum size measured as number of RTLs that can be recorded in an expression
10692 in combiner for a pseudo register as last known value of that register.  The default
10693 is 10000.
10695 @item max-combine-insns
10696 The maximum number of instructions the RTL combiner tries to combine.
10697 The default value is 2 at @option{-Og} and 4 otherwise.
10699 @item integer-share-limit
10700 Small integer constants can use a shared data structure, reducing the
10701 compiler's memory usage and increasing its speed.  This sets the maximum
10702 value of a shared integer constant.  The default value is 256.
10704 @item ssp-buffer-size
10705 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10706 protection when @option{-fstack-protection} is used.
10708 @item min-size-for-stack-sharing
10709 The minimum size of variables taking part in stack slot sharing when not
10710 optimizing. The default value is 32.
10712 @item max-jump-thread-duplication-stmts
10713 Maximum number of statements allowed in a block that needs to be
10714 duplicated when threading jumps.
10716 @item max-fields-for-field-sensitive
10717 Maximum number of fields in a structure treated in
10718 a field sensitive manner during pointer analysis.  The default is zero
10719 for @option{-O0} and @option{-O1},
10720 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10722 @item prefetch-latency
10723 Estimate on average number of instructions that are executed before
10724 prefetch finishes.  The distance prefetched ahead is proportional
10725 to this constant.  Increasing this number may also lead to less
10726 streams being prefetched (see @option{simultaneous-prefetches}).
10728 @item simultaneous-prefetches
10729 Maximum number of prefetches that can run at the same time.
10731 @item l1-cache-line-size
10732 The size of cache line in L1 cache, in bytes.
10734 @item l1-cache-size
10735 The size of L1 cache, in kilobytes.
10737 @item l2-cache-size
10738 The size of L2 cache, in kilobytes.
10740 @item loop-interchange-max-num-stmts
10741 The maximum number of stmts in a loop to be interchanged.
10743 @item loop-interchange-stride-ratio
10744 The minimum ratio between stride of two loops for interchange to be profitable.
10746 @item min-insn-to-prefetch-ratio
10747 The minimum ratio between the number of instructions and the
10748 number of prefetches to enable prefetching in a loop.
10750 @item prefetch-min-insn-to-mem-ratio
10751 The minimum ratio between the number of instructions and the
10752 number of memory references to enable prefetching in a loop.
10754 @item use-canonical-types
10755 Whether the compiler should use the ``canonical'' type system.  By
10756 default, this should always be 1, which uses a more efficient internal
10757 mechanism for comparing types in C++ and Objective-C++.  However, if
10758 bugs in the canonical type system are causing compilation failures,
10759 set this value to 0 to disable canonical types.
10761 @item switch-conversion-max-branch-ratio
10762 Switch initialization conversion refuses to create arrays that are
10763 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10764 branches in the switch.
10766 @item max-partial-antic-length
10767 Maximum length of the partial antic set computed during the tree
10768 partial redundancy elimination optimization (@option{-ftree-pre}) when
10769 optimizing at @option{-O3} and above.  For some sorts of source code
10770 the enhanced partial redundancy elimination optimization can run away,
10771 consuming all of the memory available on the host machine.  This
10772 parameter sets a limit on the length of the sets that are computed,
10773 which prevents the runaway behavior.  Setting a value of 0 for
10774 this parameter allows an unlimited set length.
10776 @item sccvn-max-scc-size
10777 Maximum size of a strongly connected component (SCC) during SCCVN
10778 processing.  If this limit is hit, SCCVN processing for the whole
10779 function is not done and optimizations depending on it are
10780 disabled.  The default maximum SCC size is 10000.
10782 @item sccvn-max-alias-queries-per-access
10783 Maximum number of alias-oracle queries we perform when looking for
10784 redundancies for loads and stores.  If this limit is hit the search
10785 is aborted and the load or store is not considered redundant.  The
10786 number of queries is algorithmically limited to the number of
10787 stores on all paths from the load to the function entry.
10788 The default maximum number of queries is 1000.
10790 @item ira-max-loops-num
10791 IRA uses regional register allocation by default.  If a function
10792 contains more loops than the number given by this parameter, only at most
10793 the given number of the most frequently-executed loops form regions
10794 for regional register allocation.  The default value of the
10795 parameter is 100.
10797 @item ira-max-conflict-table-size 
10798 Although IRA uses a sophisticated algorithm to compress the conflict
10799 table, the table can still require excessive amounts of memory for
10800 huge functions.  If the conflict table for a function could be more
10801 than the size in MB given by this parameter, the register allocator
10802 instead uses a faster, simpler, and lower-quality
10803 algorithm that does not require building a pseudo-register conflict table.  
10804 The default value of the parameter is 2000.
10806 @item ira-loop-reserved-regs
10807 IRA can be used to evaluate more accurate register pressure in loops
10808 for decisions to move loop invariants (see @option{-O3}).  The number
10809 of available registers reserved for some other purposes is given
10810 by this parameter.  The default value of the parameter is 2, which is
10811 the minimal number of registers needed by typical instructions.
10812 This value is the best found from numerous experiments.
10814 @item lra-inheritance-ebb-probability-cutoff
10815 LRA tries to reuse values reloaded in registers in subsequent insns.
10816 This optimization is called inheritance.  EBB is used as a region to
10817 do this optimization.  The parameter defines a minimal fall-through
10818 edge probability in percentage used to add BB to inheritance EBB in
10819 LRA.  The default value of the parameter is 40.  The value was chosen
10820 from numerous runs of SPEC2000 on x86-64.
10822 @item loop-invariant-max-bbs-in-loop
10823 Loop invariant motion can be very expensive, both in compilation time and
10824 in amount of needed compile-time memory, with very large loops.  Loops
10825 with more basic blocks than this parameter won't have loop invariant
10826 motion optimization performed on them.  The default value of the
10827 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10829 @item loop-max-datarefs-for-datadeps
10830 Building data dependencies is expensive for very large loops.  This
10831 parameter limits the number of data references in loops that are
10832 considered for data dependence analysis.  These large loops are no
10833 handled by the optimizations using loop data dependencies.
10834 The default value is 1000.
10836 @item max-vartrack-size
10837 Sets a maximum number of hash table slots to use during variable
10838 tracking dataflow analysis of any function.  If this limit is exceeded
10839 with variable tracking at assignments enabled, analysis for that
10840 function is retried without it, after removing all debug insns from
10841 the function.  If the limit is exceeded even without debug insns, var
10842 tracking analysis is completely disabled for the function.  Setting
10843 the parameter to zero makes it unlimited.
10845 @item max-vartrack-expr-depth
10846 Sets a maximum number of recursion levels when attempting to map
10847 variable names or debug temporaries to value expressions.  This trades
10848 compilation time for more complete debug information.  If this is set too
10849 low, value expressions that are available and could be represented in
10850 debug information may end up not being used; setting this higher may
10851 enable the compiler to find more complex debug expressions, but compile
10852 time and memory use may grow.  The default is 12.
10854 @item max-debug-marker-count
10855 Sets a threshold on the number of debug markers (e.g. begin stmt
10856 markers) to avoid complexity explosion at inlining or expanding to RTL.
10857 If a function has more such gimple stmts than the set limit, such stmts
10858 will be dropped from the inlined copy of a function, and from its RTL
10859 expansion.  The default is 100000.
10861 @item min-nondebug-insn-uid
10862 Use uids starting at this parameter for nondebug insns.  The range below
10863 the parameter is reserved exclusively for debug insns created by
10864 @option{-fvar-tracking-assignments}, but debug insns may get
10865 (non-overlapping) uids above it if the reserved range is exhausted.
10867 @item ipa-sra-ptr-growth-factor
10868 IPA-SRA replaces a pointer to an aggregate with one or more new
10869 parameters only when their cumulative size is less or equal to
10870 @option{ipa-sra-ptr-growth-factor} times the size of the original
10871 pointer parameter.
10873 @item sra-max-scalarization-size-Ospeed
10874 @itemx sra-max-scalarization-size-Osize
10875 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10876 replace scalar parts of aggregates with uses of independent scalar
10877 variables.  These parameters control the maximum size, in storage units,
10878 of aggregate which is considered for replacement when compiling for
10879 speed
10880 (@option{sra-max-scalarization-size-Ospeed}) or size
10881 (@option{sra-max-scalarization-size-Osize}) respectively.
10883 @item tm-max-aggregate-size
10884 When making copies of thread-local variables in a transaction, this
10885 parameter specifies the size in bytes after which variables are
10886 saved with the logging functions as opposed to save/restore code
10887 sequence pairs.  This option only applies when using
10888 @option{-fgnu-tm}.
10890 @item graphite-max-nb-scop-params
10891 To avoid exponential effects in the Graphite loop transforms, the
10892 number of parameters in a Static Control Part (SCoP) is bounded.  The
10893 default value is 10 parameters, a value of zero can be used to lift
10894 the bound.  A variable whose value is unknown at compilation time and
10895 defined outside a SCoP is a parameter of the SCoP.
10897 @item loop-block-tile-size
10898 Loop blocking or strip mining transforms, enabled with
10899 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10900 loop in the loop nest by a given number of iterations.  The strip
10901 length can be changed using the @option{loop-block-tile-size}
10902 parameter.  The default value is 51 iterations.
10904 @item loop-unroll-jam-size
10905 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10906 default value is 4.
10908 @item loop-unroll-jam-depth
10909 Specify the dimension to be unrolled (counting from the most inner loop)
10910 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10912 @item ipa-cp-value-list-size
10913 IPA-CP attempts to track all possible values and types passed to a function's
10914 parameter in order to propagate them and perform devirtualization.
10915 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10916 stores per one formal parameter of a function.
10918 @item ipa-cp-eval-threshold
10919 IPA-CP calculates its own score of cloning profitability heuristics
10920 and performs those cloning opportunities with scores that exceed
10921 @option{ipa-cp-eval-threshold}.
10923 @item ipa-cp-recursion-penalty
10924 Percentage penalty the recursive functions will receive when they
10925 are evaluated for cloning.
10927 @item ipa-cp-single-call-penalty
10928 Percentage penalty functions containing a single call to another
10929 function will receive when they are evaluated for cloning.
10932 @item ipa-max-agg-items
10933 IPA-CP is also capable to propagate a number of scalar values passed
10934 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10935 number of such values per one parameter.
10937 @item ipa-cp-loop-hint-bonus
10938 When IPA-CP determines that a cloning candidate would make the number
10939 of iterations of a loop known, it adds a bonus of
10940 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10941 the candidate.
10943 @item ipa-cp-array-index-hint-bonus
10944 When IPA-CP determines that a cloning candidate would make the index of
10945 an array access known, it adds a bonus of
10946 @option{ipa-cp-array-index-hint-bonus} to the profitability
10947 score of the candidate.
10949 @item ipa-max-aa-steps
10950 During its analysis of function bodies, IPA-CP employs alias analysis
10951 in order to track values pointed to by function parameters.  In order
10952 not spend too much time analyzing huge functions, it gives up and
10953 consider all memory clobbered after examining
10954 @option{ipa-max-aa-steps} statements modifying memory.
10956 @item lto-partitions
10957 Specify desired number of partitions produced during WHOPR compilation.
10958 The number of partitions should exceed the number of CPUs used for compilation.
10959 The default value is 32.
10961 @item lto-min-partition
10962 Size of minimal partition for WHOPR (in estimated instructions).
10963 This prevents expenses of splitting very small programs into too many
10964 partitions.
10966 @item lto-max-partition
10967 Size of max partition for WHOPR (in estimated instructions).
10968 to provide an upper bound for individual size of partition.
10969 Meant to be used only with balanced partitioning.
10971 @item cxx-max-namespaces-for-diagnostic-help
10972 The maximum number of namespaces to consult for suggestions when C++
10973 name lookup fails for an identifier.  The default is 1000.
10975 @item sink-frequency-threshold
10976 The maximum relative execution frequency (in percents) of the target block
10977 relative to a statement's original block to allow statement sinking of a
10978 statement.  Larger numbers result in more aggressive statement sinking.
10979 The default value is 75.  A small positive adjustment is applied for
10980 statements with memory operands as those are even more profitable so sink.
10982 @item max-stores-to-sink
10983 The maximum number of conditional store pairs that can be sunk.  Set to 0
10984 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10985 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10987 @item allow-store-data-races
10988 Allow optimizers to introduce new data races on stores.
10989 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10990 at optimization level @option{-Ofast}.
10992 @item case-values-threshold
10993 The smallest number of different values for which it is best to use a
10994 jump-table instead of a tree of conditional branches.  If the value is
10995 0, use the default for the machine.  The default is 0.
10997 @item tree-reassoc-width
10998 Set the maximum number of instructions executed in parallel in
10999 reassociated tree. This parameter overrides target dependent
11000 heuristics used by default if has non zero value.
11002 @item sched-pressure-algorithm
11003 Choose between the two available implementations of
11004 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
11005 and is the more likely to prevent instructions from being reordered.
11006 Algorithm 2 was designed to be a compromise between the relatively
11007 conservative approach taken by algorithm 1 and the rather aggressive
11008 approach taken by the default scheduler.  It relies more heavily on
11009 having a regular register file and accurate register pressure classes.
11010 See @file{haifa-sched.c} in the GCC sources for more details.
11012 The default choice depends on the target.
11014 @item max-slsr-cand-scan
11015 Set the maximum number of existing candidates that are considered when
11016 seeking a basis for a new straight-line strength reduction candidate.
11018 @item asan-globals
11019 Enable buffer overflow detection for global objects.  This kind
11020 of protection is enabled by default if you are using
11021 @option{-fsanitize=address} option.
11022 To disable global objects protection use @option{--param asan-globals=0}.
11024 @item asan-stack
11025 Enable buffer overflow detection for stack objects.  This kind of
11026 protection is enabled by default when using @option{-fsanitize=address}.
11027 To disable stack protection use @option{--param asan-stack=0} option.
11029 @item asan-instrument-reads
11030 Enable buffer overflow detection for memory reads.  This kind of
11031 protection is enabled by default when using @option{-fsanitize=address}.
11032 To disable memory reads protection use
11033 @option{--param asan-instrument-reads=0}.
11035 @item asan-instrument-writes
11036 Enable buffer overflow detection for memory writes.  This kind of
11037 protection is enabled by default when using @option{-fsanitize=address}.
11038 To disable memory writes protection use
11039 @option{--param asan-instrument-writes=0} option.
11041 @item asan-memintrin
11042 Enable detection for built-in functions.  This kind of protection
11043 is enabled by default when using @option{-fsanitize=address}.
11044 To disable built-in functions protection use
11045 @option{--param asan-memintrin=0}.
11047 @item asan-use-after-return
11048 Enable detection of use-after-return.  This kind of protection
11049 is enabled by default when using the @option{-fsanitize=address} option.
11050 To disable it use @option{--param asan-use-after-return=0}.
11052 Note: By default the check is disabled at run time.  To enable it,
11053 add @code{detect_stack_use_after_return=1} to the environment variable
11054 @env{ASAN_OPTIONS}.
11056 @item asan-instrumentation-with-call-threshold
11057 If number of memory accesses in function being instrumented
11058 is greater or equal to this number, use callbacks instead of inline checks.
11059 E.g. to disable inline code use
11060 @option{--param asan-instrumentation-with-call-threshold=0}.
11062 @item use-after-scope-direct-emission-threshold
11063 If the size of a local variable in bytes is smaller or equal to this
11064 number, directly poison (or unpoison) shadow memory instead of using
11065 run-time callbacks.  The default value is 256.
11067 @item chkp-max-ctor-size
11068 Static constructors generated by Pointer Bounds Checker may become very
11069 large and significantly increase compile time at optimization level
11070 @option{-O1} and higher.  This parameter is a maximum number of statements
11071 in a single generated constructor.  Default value is 5000.
11073 @item max-fsm-thread-path-insns
11074 Maximum number of instructions to copy when duplicating blocks on a
11075 finite state automaton jump thread path.  The default is 100.
11077 @item max-fsm-thread-length
11078 Maximum number of basic blocks on a finite state automaton jump thread
11079 path.  The default is 10.
11081 @item max-fsm-thread-paths
11082 Maximum number of new jump thread paths to create for a finite state
11083 automaton.  The default is 50.
11085 @item parloops-chunk-size
11086 Chunk size of omp schedule for loops parallelized by parloops.  The default
11087 is 0.
11089 @item parloops-schedule
11090 Schedule type of omp schedule for loops parallelized by parloops (static,
11091 dynamic, guided, auto, runtime).  The default is static.
11093 @item parloops-min-per-thread
11094 The minimum number of iterations per thread of an innermost parallelized
11095 loop for which the parallelized variant is prefered over the single threaded
11096 one.  The default is 100.  Note that for a parallelized loop nest the
11097 minimum number of iterations of the outermost loop per thread is two.
11099 @item max-ssa-name-query-depth
11100 Maximum depth of recursion when querying properties of SSA names in things
11101 like fold routines.  One level of recursion corresponds to following a
11102 use-def chain.
11104 @item hsa-gen-debug-stores
11105 Enable emission of special debug stores within HSA kernels which are
11106 then read and reported by libgomp plugin.  Generation of these stores
11107 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
11108 enable it.
11110 @item max-speculative-devirt-maydefs
11111 The maximum number of may-defs we analyze when looking for a must-def
11112 specifying the dynamic type of an object that invokes a virtual call
11113 we may be able to devirtualize speculatively.
11115 @item max-vrp-switch-assertions
11116 The maximum number of assertions to add along the default edge of a switch
11117 statement during VRP.  The default is 10.
11119 @item unroll-jam-min-percent
11120 The minimum percentage of memory references that must be optimized
11121 away for the unroll-and-jam transformation to be considered profitable.
11123 @item unroll-jam-max-unroll
11124 The maximum number of times the outer loop should be unrolled by
11125 the unroll-and-jam transformation.
11126 @end table
11127 @end table
11129 @node Instrumentation Options
11130 @section Program Instrumentation Options
11131 @cindex instrumentation options
11132 @cindex program instrumentation options
11133 @cindex run-time error checking options
11134 @cindex profiling options
11135 @cindex options, program instrumentation
11136 @cindex options, run-time error checking
11137 @cindex options, profiling
11139 GCC supports a number of command-line options that control adding
11140 run-time instrumentation to the code it normally generates.  
11141 For example, one purpose of instrumentation is collect profiling
11142 statistics for use in finding program hot spots, code coverage
11143 analysis, or profile-guided optimizations.
11144 Another class of program instrumentation is adding run-time checking 
11145 to detect programming errors like invalid pointer
11146 dereferences or out-of-bounds array accesses, as well as deliberately
11147 hostile attacks such as stack smashing or C++ vtable hijacking.
11148 There is also a general hook which can be used to implement other
11149 forms of tracing or function-level instrumentation for debug or
11150 program analysis purposes.
11152 @table @gcctabopt
11153 @cindex @command{prof}
11154 @item -p
11155 @opindex p
11156 Generate extra code to write profile information suitable for the
11157 analysis program @command{prof}.  You must use this option when compiling
11158 the source files you want data about, and you must also use it when
11159 linking.
11161 @cindex @command{gprof}
11162 @item -pg
11163 @opindex pg
11164 Generate extra code to write profile information suitable for the
11165 analysis program @command{gprof}.  You must use this option when compiling
11166 the source files you want data about, and you must also use it when
11167 linking.
11169 @item -fprofile-arcs
11170 @opindex fprofile-arcs
11171 Add code so that program flow @dfn{arcs} are instrumented.  During
11172 execution the program records how many times each branch and call is
11173 executed and how many times it is taken or returns.  On targets that support
11174 constructors with priority support, profiling properly handles constructors,
11175 destructors and C++ constructors (and destructors) of classes which are used
11176 as a type of a global variable.
11178 When the compiled
11179 program exits it saves this data to a file called
11180 @file{@var{auxname}.gcda} for each source file.  The data may be used for
11181 profile-directed optimizations (@option{-fbranch-probabilities}), or for
11182 test coverage analysis (@option{-ftest-coverage}).  Each object file's
11183 @var{auxname} is generated from the name of the output file, if
11184 explicitly specified and it is not the final executable, otherwise it is
11185 the basename of the source file.  In both cases any suffix is removed
11186 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
11187 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
11188 @xref{Cross-profiling}.
11190 @cindex @command{gcov}
11191 @item --coverage
11192 @opindex coverage
11194 This option is used to compile and link code instrumented for coverage
11195 analysis.  The option is a synonym for @option{-fprofile-arcs}
11196 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11197 linking).  See the documentation for those options for more details.
11199 @itemize
11201 @item
11202 Compile the source files with @option{-fprofile-arcs} plus optimization
11203 and code generation options.  For test coverage analysis, use the
11204 additional @option{-ftest-coverage} option.  You do not need to profile
11205 every source file in a program.
11207 @item
11208 Compile the source files additionally with @option{-fprofile-abs-path}
11209 to create absolute path names in the @file{.gcno} files.  This allows
11210 @command{gcov} to find the correct sources in projects where compilations
11211 occur with different working directories.
11213 @item
11214 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11215 (the latter implies the former).
11217 @item
11218 Run the program on a representative workload to generate the arc profile
11219 information.  This may be repeated any number of times.  You can run
11220 concurrent instances of your program, and provided that the file system
11221 supports locking, the data files will be correctly updated.  Unless
11222 a strict ISO C dialect option is in effect, @code{fork} calls are
11223 detected and correctly handled without double counting.
11225 @item
11226 For profile-directed optimizations, compile the source files again with
11227 the same optimization and code generation options plus
11228 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11229 Control Optimization}).
11231 @item
11232 For test coverage analysis, use @command{gcov} to produce human readable
11233 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11234 @command{gcov} documentation for further information.
11236 @end itemize
11238 With @option{-fprofile-arcs}, for each function of your program GCC
11239 creates a program flow graph, then finds a spanning tree for the graph.
11240 Only arcs that are not on the spanning tree have to be instrumented: the
11241 compiler adds code to count the number of times that these arcs are
11242 executed.  When an arc is the only exit or only entrance to a block, the
11243 instrumentation code can be added to the block; otherwise, a new basic
11244 block must be created to hold the instrumentation code.
11246 @need 2000
11247 @item -ftest-coverage
11248 @opindex ftest-coverage
11249 Produce a notes file that the @command{gcov} code-coverage utility
11250 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11251 show program coverage.  Each source file's note file is called
11252 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11253 above for a description of @var{auxname} and instructions on how to
11254 generate test coverage data.  Coverage data matches the source files
11255 more closely if you do not optimize.
11257 @item -fprofile-abs-path
11258 @opindex fprofile-abs-path
11259 Automatically convert relative source file names to absolute path names
11260 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11261 sources in projects where compilations occur with different working
11262 directories.
11264 @item -fprofile-dir=@var{path}
11265 @opindex fprofile-dir
11267 Set the directory to search for the profile data files in to @var{path}.
11268 This option affects only the profile data generated by
11269 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11270 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11271 and its related options.  Both absolute and relative paths can be used.
11272 By default, GCC uses the current directory as @var{path}, thus the
11273 profile data file appears in the same directory as the object file.
11275 @item -fprofile-generate
11276 @itemx -fprofile-generate=@var{path}
11277 @opindex fprofile-generate
11279 Enable options usually used for instrumenting application to produce
11280 profile useful for later recompilation with profile feedback based
11281 optimization.  You must use @option{-fprofile-generate} both when
11282 compiling and when linking your program.
11284 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11286 If @var{path} is specified, GCC looks at the @var{path} to find
11287 the profile feedback data files. See @option{-fprofile-dir}.
11289 To optimize the program based on the collected profile information, use
11290 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11292 @item -fprofile-update=@var{method}
11293 @opindex fprofile-update
11295 Alter the update method for an application instrumented for profile
11296 feedback based optimization.  The @var{method} argument should be one of
11297 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11298 The first one is useful for single-threaded applications,
11299 while the second one prevents profile corruption by emitting thread-safe code.
11301 @strong{Warning:} When an application does not properly join all threads
11302 (or creates an detached thread), a profile file can be still corrupted.
11304 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11305 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11306 automatically selects @samp{prefer-atomic} when @option{-pthread}
11307 is present in the command line.
11309 @item -fsanitize=address
11310 @opindex fsanitize=address
11311 Enable AddressSanitizer, a fast memory error detector.
11312 Memory access instructions are instrumented to detect
11313 out-of-bounds and use-after-free bugs.
11314 The option enables @option{-fsanitize-address-use-after-scope}.
11315 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11316 more details.  The run-time behavior can be influenced using the
11317 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11318 the available options are shown at startup of the instrumented program.  See
11319 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11320 for a list of supported options.
11321 The option cannot be combined with @option{-fsanitize=thread}
11322 and/or @option{-fcheck-pointer-bounds}.
11324 @item -fsanitize=kernel-address
11325 @opindex fsanitize=kernel-address
11326 Enable AddressSanitizer for Linux kernel.
11327 See @uref{https://github.com/google/kasan/wiki} for more details.
11328 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11330 @item -fsanitize=pointer-compare
11331 @opindex fsanitize=pointer-compare
11332 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11333 The option must be combined with either @option{-fsanitize=kernel-address} or
11334 @option{-fsanitize=address}
11335 The option cannot be combined with @option{-fsanitize=thread}
11336 and/or @option{-fcheck-pointer-bounds}.
11337 Note: By default the check is disabled at run time.  To enable it,
11338 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11339 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11340 invalid operation only when both pointers are non-null.
11342 @item -fsanitize=pointer-subtract
11343 @opindex fsanitize=pointer-subtract
11344 Instrument subtraction with pointer operands.
11345 The option must be combined with either @option{-fsanitize=kernel-address} or
11346 @option{-fsanitize=address}
11347 The option cannot be combined with @option{-fsanitize=thread}
11348 and/or @option{-fcheck-pointer-bounds}.
11349 Note: By default the check is disabled at run time.  To enable it,
11350 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11351 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11352 invalid operation only when both pointers are non-null.
11354 @item -fsanitize=thread
11355 @opindex fsanitize=thread
11356 Enable ThreadSanitizer, a fast data race detector.
11357 Memory access instructions are instrumented to detect
11358 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11359 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11360 environment variable; see
11361 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11362 supported options.
11363 The option cannot be combined with @option{-fsanitize=address},
11364 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11366 Note that sanitized atomic builtins cannot throw exceptions when
11367 operating on invalid memory addresses with non-call exceptions
11368 (@option{-fnon-call-exceptions}).
11370 @item -fsanitize=leak
11371 @opindex fsanitize=leak
11372 Enable LeakSanitizer, a memory leak detector.
11373 This option only matters for linking of executables and
11374 the executable is linked against a library that overrides @code{malloc}
11375 and other allocator functions.  See
11376 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11377 details.  The run-time behavior can be influenced using the
11378 @env{LSAN_OPTIONS} environment variable.
11379 The option cannot be combined with @option{-fsanitize=thread}.
11381 @item -fsanitize=undefined
11382 @opindex fsanitize=undefined
11383 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11384 Various computations are instrumented to detect undefined behavior
11385 at runtime.  Current suboptions are:
11387 @table @gcctabopt
11389 @item -fsanitize=shift
11390 @opindex fsanitize=shift
11391 This option enables checking that the result of a shift operation is
11392 not undefined.  Note that what exactly is considered undefined differs
11393 slightly between C and C++, as well as between ISO C90 and C99, etc.
11394 This option has two suboptions, @option{-fsanitize=shift-base} and
11395 @option{-fsanitize=shift-exponent}.
11397 @item -fsanitize=shift-exponent
11398 @opindex fsanitize=shift-exponent
11399 This option enables checking that the second argument of a shift operation
11400 is not negative and is smaller than the precision of the promoted first
11401 argument.
11403 @item -fsanitize=shift-base
11404 @opindex fsanitize=shift-base
11405 If the second argument of a shift operation is within range, check that the
11406 result of a shift operation is not undefined.  Note that what exactly is
11407 considered undefined differs slightly between C and C++, as well as between
11408 ISO C90 and C99, etc.
11410 @item -fsanitize=integer-divide-by-zero
11411 @opindex fsanitize=integer-divide-by-zero
11412 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11414 @item -fsanitize=unreachable
11415 @opindex fsanitize=unreachable
11416 With this option, the compiler turns the @code{__builtin_unreachable}
11417 call into a diagnostics message call instead.  When reaching the
11418 @code{__builtin_unreachable} call, the behavior is undefined.
11420 @item -fsanitize=vla-bound
11421 @opindex fsanitize=vla-bound
11422 This option instructs the compiler to check that the size of a variable
11423 length array is positive.
11425 @item -fsanitize=null
11426 @opindex fsanitize=null
11427 This option enables pointer checking.  Particularly, the application
11428 built with this option turned on will issue an error message when it
11429 tries to dereference a NULL pointer, or if a reference (possibly an
11430 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11431 on an object pointed by a NULL pointer.
11433 @item -fsanitize=return
11434 @opindex fsanitize=return
11435 This option enables return statement checking.  Programs
11436 built with this option turned on will issue an error message
11437 when the end of a non-void function is reached without actually
11438 returning a value.  This option works in C++ only.
11440 @item -fsanitize=signed-integer-overflow
11441 @opindex fsanitize=signed-integer-overflow
11442 This option enables signed integer overflow checking.  We check that
11443 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11444 does not overflow in the signed arithmetics.  Note, integer promotion
11445 rules must be taken into account.  That is, the following is not an
11446 overflow:
11447 @smallexample
11448 signed char a = SCHAR_MAX;
11449 a++;
11450 @end smallexample
11452 @item -fsanitize=bounds
11453 @opindex fsanitize=bounds
11454 This option enables instrumentation of array bounds.  Various out of bounds
11455 accesses are detected.  Flexible array members, flexible array member-like
11456 arrays, and initializers of variables with static storage are not instrumented.
11457 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11459 @item -fsanitize=bounds-strict
11460 @opindex fsanitize=bounds-strict
11461 This option enables strict instrumentation of array bounds.  Most out of bounds
11462 accesses are detected, including flexible array members and flexible array
11463 member-like arrays.  Initializers of variables with static storage are not
11464 instrumented.  The option cannot be combined
11465 with @option{-fcheck-pointer-bounds}.
11467 @item -fsanitize=alignment
11468 @opindex fsanitize=alignment
11470 This option enables checking of alignment of pointers when they are
11471 dereferenced, or when a reference is bound to insufficiently aligned target,
11472 or when a method or constructor is invoked on insufficiently aligned object.
11474 @item -fsanitize=object-size
11475 @opindex fsanitize=object-size
11476 This option enables instrumentation of memory references using the
11477 @code{__builtin_object_size} function.  Various out of bounds pointer
11478 accesses are detected.
11480 @item -fsanitize=float-divide-by-zero
11481 @opindex fsanitize=float-divide-by-zero
11482 Detect floating-point division by zero.  Unlike other similar options,
11483 @option{-fsanitize=float-divide-by-zero} is not enabled by
11484 @option{-fsanitize=undefined}, since floating-point division by zero can
11485 be a legitimate way of obtaining infinities and NaNs.
11487 @item -fsanitize=float-cast-overflow
11488 @opindex fsanitize=float-cast-overflow
11489 This option enables floating-point type to integer conversion checking.
11490 We check that the result of the conversion does not overflow.
11491 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11492 not enabled by @option{-fsanitize=undefined}.
11493 This option does not work well with @code{FE_INVALID} exceptions enabled.
11495 @item -fsanitize=nonnull-attribute
11496 @opindex fsanitize=nonnull-attribute
11498 This option enables instrumentation of calls, checking whether null values
11499 are not passed to arguments marked as requiring a non-null value by the
11500 @code{nonnull} function attribute.
11502 @item -fsanitize=returns-nonnull-attribute
11503 @opindex fsanitize=returns-nonnull-attribute
11505 This option enables instrumentation of return statements in functions
11506 marked with @code{returns_nonnull} function attribute, to detect returning
11507 of null values from such functions.
11509 @item -fsanitize=bool
11510 @opindex fsanitize=bool
11512 This option enables instrumentation of loads from bool.  If a value other
11513 than 0/1 is loaded, a run-time error is issued.
11515 @item -fsanitize=enum
11516 @opindex fsanitize=enum
11518 This option enables instrumentation of loads from an enum type.  If
11519 a value outside the range of values for the enum type is loaded,
11520 a run-time error is issued.
11522 @item -fsanitize=vptr
11523 @opindex fsanitize=vptr
11525 This option enables instrumentation of C++ member function calls, member
11526 accesses and some conversions between pointers to base and derived classes,
11527 to verify the referenced object has the correct dynamic type.
11529 @item -fsanitize=pointer-overflow
11530 @opindex fsanitize=pointer-overflow
11532 This option enables instrumentation of pointer arithmetics.  If the pointer
11533 arithmetics overflows, a run-time error is issued.
11535 @item -fsanitize=builtin
11536 @opindex fsanitize=builtin
11538 This option enables instrumentation of arguments to selected builtin
11539 functions.  If an invalid value is passed to such arguments, a run-time
11540 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11541 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11542 by this option.
11544 @end table
11546 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11547 @option{-fsanitize=undefined} gives a diagnostic message.
11548 This currently works only for the C family of languages.
11550 @item -fno-sanitize=all
11551 @opindex fno-sanitize=all
11553 This option disables all previously enabled sanitizers.
11554 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11555 together.
11557 @item -fasan-shadow-offset=@var{number}
11558 @opindex fasan-shadow-offset
11559 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11560 It is useful for experimenting with different shadow memory layouts in
11561 Kernel AddressSanitizer.
11563 @item -fsanitize-sections=@var{s1},@var{s2},...
11564 @opindex fsanitize-sections
11565 Sanitize global variables in selected user-defined sections.  @var{si} may
11566 contain wildcards.
11568 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11569 @opindex fsanitize-recover
11570 @opindex fno-sanitize-recover
11571 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11572 mentioned in comma-separated list of @var{opts}.  Enabling this option
11573 for a sanitizer component causes it to attempt to continue
11574 running the program as if no error happened.  This means multiple
11575 runtime errors can be reported in a single program run, and the exit
11576 code of the program may indicate success even when errors
11577 have been reported.  The @option{-fno-sanitize-recover=} option
11578 can be used to alter
11579 this behavior: only the first detected error is reported
11580 and program then exits with a non-zero exit code.
11582 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11583 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11584 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11585 @option{-fsanitize=bounds-strict},
11586 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11587 For these sanitizers error recovery is turned on by default,
11588 except @option{-fsanitize=address}, for which this feature is experimental.
11589 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11590 accepted, the former enables recovery for all sanitizers that support it,
11591 the latter disables recovery for all sanitizers that support it.
11593 Even if a recovery mode is turned on the compiler side, it needs to be also
11594 enabled on the runtime library side, otherwise the failures are still fatal.
11595 The runtime library defaults to @code{halt_on_error=0} for
11596 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11597 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11598 setting the @code{halt_on_error} flag in the corresponding environment variable.
11600 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11601 equivalent to specifying an @var{opts} list of:
11603 @smallexample
11604 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11605 @end smallexample
11607 @item -fsanitize-address-use-after-scope
11608 @opindex fsanitize-address-use-after-scope
11609 Enable sanitization of local variables to detect use-after-scope bugs.
11610 The option sets @option{-fstack-reuse} to @samp{none}.
11612 @item -fsanitize-undefined-trap-on-error
11613 @opindex fsanitize-undefined-trap-on-error
11614 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11615 report undefined behavior using @code{__builtin_trap} rather than
11616 a @code{libubsan} library routine.  The advantage of this is that the
11617 @code{libubsan} library is not needed and is not linked in, so this
11618 is usable even in freestanding environments.
11620 @item -fsanitize-coverage=trace-pc
11621 @opindex fsanitize-coverage=trace-pc
11622 Enable coverage-guided fuzzing code instrumentation.
11623 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11625 @item -fsanitize-coverage=trace-cmp
11626 @opindex fsanitize-coverage=trace-cmp
11627 Enable dataflow guided fuzzing code instrumentation.
11628 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11629 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11630 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11631 variable or @code{__sanitizer_cov_trace_const_cmp1},
11632 @code{__sanitizer_cov_trace_const_cmp2},
11633 @code{__sanitizer_cov_trace_const_cmp4} or
11634 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11635 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11636 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11637 @code{__sanitizer_cov_trace_switch} for switch statements.
11639 @item -fbounds-check
11640 @opindex fbounds-check
11641 For front ends that support it, generate additional code to check that
11642 indices used to access arrays are within the declared range.  This is
11643 currently only supported by the Fortran front end, where this option
11644 defaults to false.
11646 @item -fcheck-pointer-bounds
11647 @opindex fcheck-pointer-bounds
11648 @opindex fno-check-pointer-bounds
11649 @cindex Pointer Bounds Checker options
11650 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11651 is instrumented with checks of the pointer used for memory access against
11652 bounds associated with that pointer.  
11654 Currently there
11655 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11656 and @option{-mmpx} are required to enable this feature.  
11657 MPX-based instrumentation requires
11658 a runtime library to enable MPX in hardware and handle bounds
11659 violation signals.  By default when @option{-fcheck-pointer-bounds}
11660 and @option{-mmpx} options are used to link a program, the GCC driver
11661 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11662 Bounds checking on calls to dynamic libraries requires a linker
11663 with @option{-z bndplt} support; if GCC was configured with a linker
11664 without support for this option (including the Gold linker and older
11665 versions of ld), a warning is given if you link with @option{-mmpx}
11666 without also specifying @option{-static}, since the overall effectiveness
11667 of the bounds checking protection is reduced.
11668 See also @option{-static-libmpxwrappers}.
11670 MPX-based instrumentation
11671 may be used for debugging and also may be included in production code
11672 to increase program security.  Depending on usage, you may
11673 have different requirements for the runtime library.  The current version
11674 of the MPX runtime library is more oriented for use as a debugging
11675 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11676 also @option{-static-libmpx}.  The runtime library  behavior can be
11677 influenced using various @env{CHKP_RT_*} environment variables.  See
11678 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11679 for more details.
11681 Generated instrumentation may be controlled by various
11682 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11683 structure field attribute (@pxref{Type Attributes}) and
11684 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11685 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11686 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11687 Bounds Checker builtins}, for more information.
11689 @item -fchkp-check-incomplete-type
11690 @opindex fchkp-check-incomplete-type
11691 @opindex fno-chkp-check-incomplete-type
11692 Generate pointer bounds checks for variables with incomplete type.
11693 Enabled by default.
11695 @item -fchkp-narrow-bounds
11696 @opindex fchkp-narrow-bounds
11697 @opindex fno-chkp-narrow-bounds
11698 Controls bounds used by Pointer Bounds Checker for pointers to object
11699 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11700 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11701 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11703 @item -fchkp-first-field-has-own-bounds
11704 @opindex fchkp-first-field-has-own-bounds
11705 @opindex fno-chkp-first-field-has-own-bounds
11706 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11707 first field in the structure.  By default a pointer to the first field has
11708 the same bounds as a pointer to the whole structure.
11710 @item -fchkp-flexible-struct-trailing-arrays
11711 @opindex fchkp-flexible-struct-trailing-arrays
11712 @opindex fno-chkp-flexible-struct-trailing-arrays
11713 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11714 possibly flexible.  By default only array fields with zero length or that are
11715 marked with attribute bnd_variable_size are treated as flexible.
11717 @item -fchkp-narrow-to-innermost-array
11718 @opindex fchkp-narrow-to-innermost-array
11719 @opindex fno-chkp-narrow-to-innermost-array
11720 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11721 case of nested static array access.  By default this option is disabled and
11722 bounds of the outermost array are used.
11724 @item -fchkp-optimize
11725 @opindex fchkp-optimize
11726 @opindex fno-chkp-optimize
11727 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11728 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11730 @item -fchkp-use-fast-string-functions
11731 @opindex fchkp-use-fast-string-functions
11732 @opindex fno-chkp-use-fast-string-functions
11733 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11734 by Pointer Bounds Checker.  Disabled by default.
11736 @item -fchkp-use-nochk-string-functions
11737 @opindex fchkp-use-nochk-string-functions
11738 @opindex fno-chkp-use-nochk-string-functions
11739 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11740 by Pointer Bounds Checker.  Disabled by default.
11742 @item -fchkp-use-static-bounds
11743 @opindex fchkp-use-static-bounds
11744 @opindex fno-chkp-use-static-bounds
11745 Allow Pointer Bounds Checker to generate static bounds holding
11746 bounds of static variables.  Enabled by default.
11748 @item -fchkp-use-static-const-bounds
11749 @opindex fchkp-use-static-const-bounds
11750 @opindex fno-chkp-use-static-const-bounds
11751 Use statically-initialized bounds for constant bounds instead of
11752 generating them each time they are required.  By default enabled when
11753 @option{-fchkp-use-static-bounds} is enabled.
11755 @item -fchkp-treat-zero-dynamic-size-as-infinite
11756 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11757 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11758 With this option, objects with incomplete type whose
11759 dynamically-obtained size is zero are treated as having infinite size
11760 instead by Pointer Bounds
11761 Checker.  This option may be helpful if a program is linked with a library
11762 missing size information for some symbols.  Disabled by default.
11764 @item -fchkp-check-read
11765 @opindex fchkp-check-read
11766 @opindex fno-chkp-check-read
11767 Instructs Pointer Bounds Checker to generate checks for all read
11768 accesses to memory.  Enabled by default.
11770 @item -fchkp-check-write
11771 @opindex fchkp-check-write
11772 @opindex fno-chkp-check-write
11773 Instructs Pointer Bounds Checker to generate checks for all write
11774 accesses to memory.  Enabled by default.
11776 @item -fchkp-store-bounds
11777 @opindex fchkp-store-bounds
11778 @opindex fno-chkp-store-bounds
11779 Instructs Pointer Bounds Checker to generate bounds stores for
11780 pointer writes.  Enabled by default.
11782 @item -fchkp-instrument-calls
11783 @opindex fchkp-instrument-calls
11784 @opindex fno-chkp-instrument-calls
11785 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11786 Enabled by default.
11788 @item -fchkp-instrument-marked-only
11789 @opindex fchkp-instrument-marked-only
11790 @opindex fno-chkp-instrument-marked-only
11791 Instructs Pointer Bounds Checker to instrument only functions
11792 marked with the @code{bnd_instrument} attribute
11793 (@pxref{Function Attributes}).  Disabled by default.
11795 @item -fchkp-use-wrappers
11796 @opindex fchkp-use-wrappers
11797 @opindex fno-chkp-use-wrappers
11798 Allows Pointer Bounds Checker to replace calls to built-in functions
11799 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11800 is used to link a program, the GCC driver automatically links
11801 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11802 Enabled by default.
11804 @item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11805 @opindex fcf-protection
11806 Enable code instrumentation of control-flow transfers to increase
11807 program security by checking that target addresses of control-flow
11808 transfer instructions (such as indirect function call, function return,
11809 indirect jump) are valid.  This prevents diverting the flow of control
11810 to an unexpected target.  This is intended to protect against such
11811 threats as Return-oriented Programming (ROP), and similarly
11812 call/jmp-oriented programming (COP/JOP).
11814 The value @code{branch} tells the compiler to implement checking of
11815 validity of control-flow transfer at the point of indirect branch
11816 instructions, i.e. call/jmp instructions.  The value @code{return}
11817 implements checking of validity at the point of returning from a
11818 function.  The value @code{full} is an alias for specifying both
11819 @code{branch} and @code{return}. The value @code{none} turns off
11820 instrumentation.
11822 You can also use the @code{nocf_check} attribute to identify
11823 which functions and calls should be skipped from instrumentation
11824 (@pxref{Function Attributes}).
11826 Currently the x86 GNU/Linux target provides an implementation based
11827 on Intel Control-flow Enforcement Technology (CET).  Instrumentation
11828 for x86 is controlled by target-specific options @option{-mcet},
11829 @option{-mibt} and @option{-mshstk} (@pxref{x86 Options}).
11831 @item -fstack-protector
11832 @opindex fstack-protector
11833 Emit extra code to check for buffer overflows, such as stack smashing
11834 attacks.  This is done by adding a guard variable to functions with
11835 vulnerable objects.  This includes functions that call @code{alloca}, and
11836 functions with buffers larger than 8 bytes.  The guards are initialized
11837 when a function is entered and then checked when the function exits.
11838 If a guard check fails, an error message is printed and the program exits.
11840 @item -fstack-protector-all
11841 @opindex fstack-protector-all
11842 Like @option{-fstack-protector} except that all functions are protected.
11844 @item -fstack-protector-strong
11845 @opindex fstack-protector-strong
11846 Like @option{-fstack-protector} but includes additional functions to
11847 be protected --- those that have local array definitions, or have
11848 references to local frame addresses.
11850 @item -fstack-protector-explicit
11851 @opindex fstack-protector-explicit
11852 Like @option{-fstack-protector} but only protects those functions which
11853 have the @code{stack_protect} attribute.
11855 @item -fstack-check
11856 @opindex fstack-check
11857 Generate code to verify that you do not go beyond the boundary of the
11858 stack.  You should specify this flag if you are running in an
11859 environment with multiple threads, but you only rarely need to specify it in
11860 a single-threaded environment since stack overflow is automatically
11861 detected on nearly all systems if there is only one stack.
11863 Note that this switch does not actually cause checking to be done; the
11864 operating system or the language runtime must do that.  The switch causes
11865 generation of code to ensure that they see the stack being extended.
11867 You can additionally specify a string parameter: @samp{no} means no
11868 checking, @samp{generic} means force the use of old-style checking,
11869 @samp{specific} means use the best checking method and is equivalent
11870 to bare @option{-fstack-check}.
11872 Old-style checking is a generic mechanism that requires no specific
11873 target support in the compiler but comes with the following drawbacks:
11875 @enumerate
11876 @item
11877 Modified allocation strategy for large objects: they are always
11878 allocated dynamically if their size exceeds a fixed threshold.  Note this
11879 may change the semantics of some code.
11881 @item
11882 Fixed limit on the size of the static frame of functions: when it is
11883 topped by a particular function, stack checking is not reliable and
11884 a warning is issued by the compiler.
11886 @item
11887 Inefficiency: because of both the modified allocation strategy and the
11888 generic implementation, code performance is hampered.
11889 @end enumerate
11891 Note that old-style stack checking is also the fallback method for
11892 @samp{specific} if no target support has been added in the compiler.
11894 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11895 and stack overflows.  @samp{specific} is an excellent choice when compiling
11896 Ada code.  It is not generally sufficient to protect against stack-clash
11897 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11899 @item -fstack-clash-protection
11900 @opindex fstack-clash-protection
11901 Generate code to prevent stack clash style attacks.  When this option is
11902 enabled, the compiler will only allocate one page of stack space at a time
11903 and each page is accessed immediately after allocation.  Thus, it prevents
11904 allocations from jumping over any stack guard page provided by the
11905 operating system.
11907 Most targets do not fully support stack clash protection.  However, on
11908 those targets @option{-fstack-clash-protection} will protect dynamic stack
11909 allocations.  @option{-fstack-clash-protection} may also provide limited
11910 protection for static stack allocations if the target supports
11911 @option{-fstack-check=specific}.
11913 @item -fstack-limit-register=@var{reg}
11914 @itemx -fstack-limit-symbol=@var{sym}
11915 @itemx -fno-stack-limit
11916 @opindex fstack-limit-register
11917 @opindex fstack-limit-symbol
11918 @opindex fno-stack-limit
11919 Generate code to ensure that the stack does not grow beyond a certain value,
11920 either the value of a register or the address of a symbol.  If a larger
11921 stack is required, a signal is raised at run time.  For most targets,
11922 the signal is raised before the stack overruns the boundary, so
11923 it is possible to catch the signal without taking special precautions.
11925 For instance, if the stack starts at absolute address @samp{0x80000000}
11926 and grows downwards, you can use the flags
11927 @option{-fstack-limit-symbol=__stack_limit} and
11928 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11929 of 128KB@.  Note that this may only work with the GNU linker.
11931 You can locally override stack limit checking by using the
11932 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11934 @item -fsplit-stack
11935 @opindex fsplit-stack
11936 Generate code to automatically split the stack before it overflows.
11937 The resulting program has a discontiguous stack which can only
11938 overflow if the program is unable to allocate any more memory.  This
11939 is most useful when running threaded programs, as it is no longer
11940 necessary to calculate a good stack size to use for each thread.  This
11941 is currently only implemented for the x86 targets running
11942 GNU/Linux.
11944 When code compiled with @option{-fsplit-stack} calls code compiled
11945 without @option{-fsplit-stack}, there may not be much stack space
11946 available for the latter code to run.  If compiling all code,
11947 including library code, with @option{-fsplit-stack} is not an option,
11948 then the linker can fix up these calls so that the code compiled
11949 without @option{-fsplit-stack} always has a large stack.  Support for
11950 this is implemented in the gold linker in GNU binutils release 2.21
11951 and later.
11953 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11954 @opindex fvtable-verify
11955 This option is only available when compiling C++ code.
11956 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11957 feature that verifies at run time, for every virtual call, that
11958 the vtable pointer through which the call is made is valid for the type of
11959 the object, and has not been corrupted or overwritten.  If an invalid vtable
11960 pointer is detected at run time, an error is reported and execution of the
11961 program is immediately halted.
11963 This option causes run-time data structures to be built at program startup,
11964 which are used for verifying the vtable pointers.  
11965 The options @samp{std} and @samp{preinit}
11966 control the timing of when these data structures are built.  In both cases the
11967 data structures are built before execution reaches @code{main}.  Using
11968 @option{-fvtable-verify=std} causes the data structures to be built after
11969 shared libraries have been loaded and initialized.
11970 @option{-fvtable-verify=preinit} causes them to be built before shared
11971 libraries have been loaded and initialized.
11973 If this option appears multiple times in the command line with different
11974 values specified, @samp{none} takes highest priority over both @samp{std} and
11975 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11977 @item -fvtv-debug
11978 @opindex fvtv-debug
11979 When used in conjunction with @option{-fvtable-verify=std} or 
11980 @option{-fvtable-verify=preinit}, causes debug versions of the 
11981 runtime functions for the vtable verification feature to be called.  
11982 This flag also causes the compiler to log information about which 
11983 vtable pointers it finds for each class.
11984 This information is written to a file named @file{vtv_set_ptr_data.log} 
11985 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11986 if that is defined or the current working directory otherwise.
11988 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11989 file, be sure to delete any existing one.
11991 @item -fvtv-counts
11992 @opindex fvtv-counts
11993 This is a debugging flag.  When used in conjunction with
11994 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11995 causes the compiler to keep track of the total number of virtual calls
11996 it encounters and the number of verifications it inserts.  It also
11997 counts the number of calls to certain run-time library functions
11998 that it inserts and logs this information for each compilation unit.
11999 The compiler writes this information to a file named
12000 @file{vtv_count_data.log} in the directory named by the environment
12001 variable @env{VTV_LOGS_DIR} if that is defined or the current working
12002 directory otherwise.  It also counts the size of the vtable pointer sets
12003 for each class, and writes this information to @file{vtv_class_set_sizes.log}
12004 in the same directory.
12006 Note:  This feature @emph{appends} data to the log files.  To get fresh log
12007 files, be sure to delete any existing ones.
12009 @item -finstrument-functions
12010 @opindex finstrument-functions
12011 Generate instrumentation calls for entry and exit to functions.  Just
12012 after function entry and just before function exit, the following
12013 profiling functions are called with the address of the current
12014 function and its call site.  (On some platforms,
12015 @code{__builtin_return_address} does not work beyond the current
12016 function, so the call site information may not be available to the
12017 profiling functions otherwise.)
12019 @smallexample
12020 void __cyg_profile_func_enter (void *this_fn,
12021                                void *call_site);
12022 void __cyg_profile_func_exit  (void *this_fn,
12023                                void *call_site);
12024 @end smallexample
12026 The first argument is the address of the start of the current function,
12027 which may be looked up exactly in the symbol table.
12029 This instrumentation is also done for functions expanded inline in other
12030 functions.  The profiling calls indicate where, conceptually, the
12031 inline function is entered and exited.  This means that addressable
12032 versions of such functions must be available.  If all your uses of a
12033 function are expanded inline, this may mean an additional expansion of
12034 code size.  If you use @code{extern inline} in your C code, an
12035 addressable version of such functions must be provided.  (This is
12036 normally the case anyway, but if you get lucky and the optimizer always
12037 expands the functions inline, you might have gotten away without
12038 providing static copies.)
12040 A function may be given the attribute @code{no_instrument_function}, in
12041 which case this instrumentation is not done.  This can be used, for
12042 example, for the profiling functions listed above, high-priority
12043 interrupt routines, and any functions from which the profiling functions
12044 cannot safely be called (perhaps signal handlers, if the profiling
12045 routines generate output or allocate memory).
12047 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
12048 @opindex finstrument-functions-exclude-file-list
12050 Set the list of functions that are excluded from instrumentation (see
12051 the description of @option{-finstrument-functions}).  If the file that
12052 contains a function definition matches with one of @var{file}, then
12053 that function is not instrumented.  The match is done on substrings:
12054 if the @var{file} parameter is a substring of the file name, it is
12055 considered to be a match.
12057 For example:
12059 @smallexample
12060 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
12061 @end smallexample
12063 @noindent
12064 excludes any inline function defined in files whose pathnames
12065 contain @file{/bits/stl} or @file{include/sys}.
12067 If, for some reason, you want to include letter @samp{,} in one of
12068 @var{sym}, write @samp{\,}. For example,
12069 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
12070 (note the single quote surrounding the option).
12072 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
12073 @opindex finstrument-functions-exclude-function-list
12075 This is similar to @option{-finstrument-functions-exclude-file-list},
12076 but this option sets the list of function names to be excluded from
12077 instrumentation.  The function name to be matched is its user-visible
12078 name, such as @code{vector<int> blah(const vector<int> &)}, not the
12079 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
12080 match is done on substrings: if the @var{sym} parameter is a substring
12081 of the function name, it is considered to be a match.  For C99 and C++
12082 extended identifiers, the function name must be given in UTF-8, not
12083 using universal character names.
12085 @item -fpatchable-function-entry=@var{N}[,@var{M}]
12086 @opindex fpatchable-function-entry
12087 Generate @var{N} NOPs right at the beginning
12088 of each function, with the function entry point before the @var{M}th NOP.
12089 If @var{M} is omitted, it defaults to @code{0} so the
12090 function entry points to the address just at the first NOP.
12091 The NOP instructions reserve extra space which can be used to patch in
12092 any desired instrumentation at run time, provided that the code segment
12093 is writable.  The amount of space is controllable indirectly via
12094 the number of NOPs; the NOP instruction used corresponds to the instruction
12095 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
12096 is target-specific and may also depend on the architecture variant and/or
12097 other compilation options.
12099 For run-time identification, the starting addresses of these areas,
12100 which correspond to their respective function entries minus @var{M},
12101 are additionally collected in the @code{__patchable_function_entries}
12102 section of the resulting binary.
12104 Note that the value of @code{__attribute__ ((patchable_function_entry
12105 (N,M)))} takes precedence over command-line option
12106 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
12107 the area size or to remove it completely on a single function.
12108 If @code{N=0}, no pad location is recorded.
12110 The NOP instructions are inserted at---and maybe before, depending on
12111 @var{M}---the function entry address, even before the prologue.
12113 @end table
12116 @node Preprocessor Options
12117 @section Options Controlling the Preprocessor
12118 @cindex preprocessor options
12119 @cindex options, preprocessor
12121 These options control the C preprocessor, which is run on each C source
12122 file before actual compilation.
12124 If you use the @option{-E} option, nothing is done except preprocessing.
12125 Some of these options make sense only together with @option{-E} because
12126 they cause the preprocessor output to be unsuitable for actual
12127 compilation.
12129 In addition to the options listed here, there are a number of options 
12130 to control search paths for include files documented in 
12131 @ref{Directory Options}.  
12132 Options to control preprocessor diagnostics are listed in 
12133 @ref{Warning Options}.
12135 @table @gcctabopt
12136 @include cppopts.texi
12138 @item -Wp,@var{option}
12139 @opindex Wp
12140 You can use @option{-Wp,@var{option}} to bypass the compiler driver
12141 and pass @var{option} directly through to the preprocessor.  If
12142 @var{option} contains commas, it is split into multiple options at the
12143 commas.  However, many options are modified, translated or interpreted
12144 by the compiler driver before being passed to the preprocessor, and
12145 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
12146 interface is undocumented and subject to change, so whenever possible
12147 you should avoid using @option{-Wp} and let the driver handle the
12148 options instead.
12150 @item -Xpreprocessor @var{option}
12151 @opindex Xpreprocessor
12152 Pass @var{option} as an option to the preprocessor.  You can use this to
12153 supply system-specific preprocessor options that GCC does not 
12154 recognize.
12156 If you want to pass an option that takes an argument, you must use
12157 @option{-Xpreprocessor} twice, once for the option and once for the argument.
12159 @item -no-integrated-cpp
12160 @opindex no-integrated-cpp
12161 Perform preprocessing as a separate pass before compilation.
12162 By default, GCC performs preprocessing as an integrated part of
12163 input tokenization and parsing.
12164 If this option is provided, the appropriate language front end
12165 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
12166 and Objective-C, respectively) is instead invoked twice,
12167 once for preprocessing only and once for actual compilation
12168 of the preprocessed input.
12169 This option may be useful in conjunction with the @option{-B} or
12170 @option{-wrapper} options to specify an alternate preprocessor or
12171 perform additional processing of the program source between
12172 normal preprocessing and compilation.
12174 @end table
12176 @node Assembler Options
12177 @section Passing Options to the Assembler
12179 @c prevent bad page break with this line
12180 You can pass options to the assembler.
12182 @table @gcctabopt
12183 @item -Wa,@var{option}
12184 @opindex Wa
12185 Pass @var{option} as an option to the assembler.  If @var{option}
12186 contains commas, it is split into multiple options at the commas.
12188 @item -Xassembler @var{option}
12189 @opindex Xassembler
12190 Pass @var{option} as an option to the assembler.  You can use this to
12191 supply system-specific assembler options that GCC does not
12192 recognize.
12194 If you want to pass an option that takes an argument, you must use
12195 @option{-Xassembler} twice, once for the option and once for the argument.
12197 @end table
12199 @node Link Options
12200 @section Options for Linking
12201 @cindex link options
12202 @cindex options, linking
12204 These options come into play when the compiler links object files into
12205 an executable output file.  They are meaningless if the compiler is
12206 not doing a link step.
12208 @table @gcctabopt
12209 @cindex file names
12210 @item @var{object-file-name}
12211 A file name that does not end in a special recognized suffix is
12212 considered to name an object file or library.  (Object files are
12213 distinguished from libraries by the linker according to the file
12214 contents.)  If linking is done, these object files are used as input
12215 to the linker.
12217 @item -c
12218 @itemx -S
12219 @itemx -E
12220 @opindex c
12221 @opindex S
12222 @opindex E
12223 If any of these options is used, then the linker is not run, and
12224 object file names should not be used as arguments.  @xref{Overall
12225 Options}.
12227 @item -fuse-ld=bfd
12228 @opindex fuse-ld=bfd
12229 Use the @command{bfd} linker instead of the default linker.
12231 @item -fuse-ld=gold
12232 @opindex fuse-ld=gold
12233 Use the @command{gold} linker instead of the default linker.
12235 @cindex Libraries
12236 @item -l@var{library}
12237 @itemx -l @var{library}
12238 @opindex l
12239 Search the library named @var{library} when linking.  (The second
12240 alternative with the library as a separate argument is only for
12241 POSIX compliance and is not recommended.)
12243 It makes a difference where in the command you write this option; the
12244 linker searches and processes libraries and object files in the order they
12245 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12246 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12247 to functions in @samp{z}, those functions may not be loaded.
12249 The linker searches a standard list of directories for the library,
12250 which is actually a file named @file{lib@var{library}.a}.  The linker
12251 then uses this file as if it had been specified precisely by name.
12253 The directories searched include several standard system directories
12254 plus any that you specify with @option{-L}.
12256 Normally the files found this way are library files---archive files
12257 whose members are object files.  The linker handles an archive file by
12258 scanning through it for members which define symbols that have so far
12259 been referenced but not defined.  But if the file that is found is an
12260 ordinary object file, it is linked in the usual fashion.  The only
12261 difference between using an @option{-l} option and specifying a file name
12262 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12263 and searches several directories.
12265 @item -lobjc
12266 @opindex lobjc
12267 You need this special case of the @option{-l} option in order to
12268 link an Objective-C or Objective-C++ program.
12270 @item -nostartfiles
12271 @opindex nostartfiles
12272 Do not use the standard system startup files when linking.
12273 The standard system libraries are used normally, unless @option{-nostdlib}
12274 or @option{-nodefaultlibs} is used.
12276 @item -nodefaultlibs
12277 @opindex nodefaultlibs
12278 Do not use the standard system libraries when linking.
12279 Only the libraries you specify are passed to the linker, and options
12280 specifying linkage of the system libraries, such as @option{-static-libgcc}
12281 or @option{-shared-libgcc}, are ignored.  
12282 The standard startup files are used normally, unless @option{-nostartfiles}
12283 is used.  
12285 The compiler may generate calls to @code{memcmp},
12286 @code{memset}, @code{memcpy} and @code{memmove}.
12287 These entries are usually resolved by entries in
12288 libc.  These entry points should be supplied through some other
12289 mechanism when this option is specified.
12291 @item -nostdlib
12292 @opindex nostdlib
12293 Do not use the standard system startup files or libraries when linking.
12294 No startup files and only the libraries you specify are passed to
12295 the linker, and options specifying linkage of the system libraries, such as
12296 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12298 The compiler may generate calls to @code{memcmp}, @code{memset},
12299 @code{memcpy} and @code{memmove}.
12300 These entries are usually resolved by entries in
12301 libc.  These entry points should be supplied through some other
12302 mechanism when this option is specified.
12304 @cindex @option{-lgcc}, use with @option{-nostdlib}
12305 @cindex @option{-nostdlib} and unresolved references
12306 @cindex unresolved references and @option{-nostdlib}
12307 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12308 @cindex @option{-nodefaultlibs} and unresolved references
12309 @cindex unresolved references and @option{-nodefaultlibs}
12310 One of the standard libraries bypassed by @option{-nostdlib} and
12311 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12312 which GCC uses to overcome shortcomings of particular machines, or special
12313 needs for some languages.
12314 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12315 Collection (GCC) Internals},
12316 for more discussion of @file{libgcc.a}.)
12317 In most cases, you need @file{libgcc.a} even when you want to avoid
12318 other standard libraries.  In other words, when you specify @option{-nostdlib}
12319 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12320 This ensures that you have no unresolved references to internal GCC
12321 library subroutines.
12322 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12323 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12324 GNU Compiler Collection (GCC) Internals}.)
12326 @item -pie
12327 @opindex pie
12328 Produce a dynamically linked position independent executable on targets
12329 that support it.  For predictable results, you must also specify the same
12330 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12331 or model suboptions) when you specify this linker option.
12333 @item -no-pie
12334 @opindex no-pie
12335 Don't produce a dynamically linked position independent executable.
12337 @item -static-pie
12338 @opindex static-pie
12339 Produce a static position independent executable on targets that support
12340 it.  A static position independent executable is similar to a static
12341 executable, but can be loaded at any address without a dynamic linker.
12342 For predictable results, you must also specify the same set of options
12343 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12344 suboptions) when you specify this linker option.
12346 @item -pthread
12347 @opindex pthread
12348 Link with the POSIX threads library.  This option is supported on 
12349 GNU/Linux targets, most other Unix derivatives, and also on 
12350 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12351 flags for the preprocessor, so it should be used consistently for both
12352 compilation and linking.
12354 @item -rdynamic
12355 @opindex rdynamic
12356 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12357 that support it. This instructs the linker to add all symbols, not
12358 only used ones, to the dynamic symbol table. This option is needed
12359 for some uses of @code{dlopen} or to allow obtaining backtraces
12360 from within a program.
12362 @item -s
12363 @opindex s
12364 Remove all symbol table and relocation information from the executable.
12366 @item -static
12367 @opindex static
12368 On systems that support dynamic linking, this overrides @option{-pie}
12369 and prevents linking with the shared libraries.  On other systems, this
12370 option has no effect.
12372 @item -shared
12373 @opindex shared
12374 Produce a shared object which can then be linked with other objects to
12375 form an executable.  Not all systems support this option.  For predictable
12376 results, you must also specify the same set of options used for compilation
12377 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12378 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12379 needs to build supplementary stub code for constructors to work.  On
12380 multi-libbed systems, @samp{gcc -shared} must select the correct support
12381 libraries to link against.  Failing to supply the correct flags may lead
12382 to subtle defects.  Supplying them in cases where they are not necessary
12383 is innocuous.}
12385 @item -shared-libgcc
12386 @itemx -static-libgcc
12387 @opindex shared-libgcc
12388 @opindex static-libgcc
12389 On systems that provide @file{libgcc} as a shared library, these options
12390 force the use of either the shared or static version, respectively.
12391 If no shared version of @file{libgcc} was built when the compiler was
12392 configured, these options have no effect.
12394 There are several situations in which an application should use the
12395 shared @file{libgcc} instead of the static version.  The most common
12396 of these is when the application wishes to throw and catch exceptions
12397 across different shared libraries.  In that case, each of the libraries
12398 as well as the application itself should use the shared @file{libgcc}.
12400 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12401  whenever you build a shared library or a main executable, because C++
12402  programs typically use exceptions, so this is the right thing to do.
12404 If, instead, you use the GCC driver to create shared libraries, you may
12405 find that they are not always linked with the shared @file{libgcc}.
12406 If GCC finds, at its configuration time, that you have a non-GNU linker
12407 or a GNU linker that does not support option @option{--eh-frame-hdr},
12408 it links the shared version of @file{libgcc} into shared libraries
12409 by default.  Otherwise, it takes advantage of the linker and optimizes
12410 away the linking with the shared version of @file{libgcc}, linking with
12411 the static version of libgcc by default.  This allows exceptions to
12412 propagate through such shared libraries, without incurring relocation
12413 costs at library load time.
12415 However, if a library or main executable is supposed to throw or catch
12416 exceptions, you must link it using the G++ driver, as appropriate
12417 for the languages used in the program, or using the option
12418 @option{-shared-libgcc}, such that it is linked with the shared
12419 @file{libgcc}.
12421 @item -static-libasan
12422 @opindex static-libasan
12423 When the @option{-fsanitize=address} option is used to link a program,
12424 the GCC driver automatically links against @option{libasan}.  If
12425 @file{libasan} is available as a shared library, and the @option{-static}
12426 option is not used, then this links against the shared version of
12427 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12428 driver to link @file{libasan} statically, without necessarily linking
12429 other libraries statically.
12431 @item -static-libtsan
12432 @opindex static-libtsan
12433 When the @option{-fsanitize=thread} option is used to link a program,
12434 the GCC driver automatically links against @option{libtsan}.  If
12435 @file{libtsan} is available as a shared library, and the @option{-static}
12436 option is not used, then this links against the shared version of
12437 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12438 driver to link @file{libtsan} statically, without necessarily linking
12439 other libraries statically.
12441 @item -static-liblsan
12442 @opindex static-liblsan
12443 When the @option{-fsanitize=leak} option is used to link a program,
12444 the GCC driver automatically links against @option{liblsan}.  If
12445 @file{liblsan} is available as a shared library, and the @option{-static}
12446 option is not used, then this links against the shared version of
12447 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12448 driver to link @file{liblsan} statically, without necessarily linking
12449 other libraries statically.
12451 @item -static-libubsan
12452 @opindex static-libubsan
12453 When the @option{-fsanitize=undefined} option is used to link a program,
12454 the GCC driver automatically links against @option{libubsan}.  If
12455 @file{libubsan} is available as a shared library, and the @option{-static}
12456 option is not used, then this links against the shared version of
12457 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12458 driver to link @file{libubsan} statically, without necessarily linking
12459 other libraries statically.
12461 @item -static-libmpx
12462 @opindex static-libmpx
12463 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12464 used to link a program, the GCC driver automatically links against
12465 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12466 and the @option{-static} option is not used, then this links against
12467 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12468 option directs the GCC driver to link @file{libmpx} statically,
12469 without necessarily linking other libraries statically.
12471 @item -static-libmpxwrappers
12472 @opindex static-libmpxwrappers
12473 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12474 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12475 GCC driver automatically links against @file{libmpxwrappers}.  If
12476 @file{libmpxwrappers} is available as a shared library, and the
12477 @option{-static} option is not used, then this links against the shared
12478 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12479 option directs the GCC driver to link @file{libmpxwrappers} statically,
12480 without necessarily linking other libraries statically.
12482 @item -static-libstdc++
12483 @opindex static-libstdc++
12484 When the @command{g++} program is used to link a C++ program, it
12485 normally automatically links against @option{libstdc++}.  If
12486 @file{libstdc++} is available as a shared library, and the
12487 @option{-static} option is not used, then this links against the
12488 shared version of @file{libstdc++}.  That is normally fine.  However, it
12489 is sometimes useful to freeze the version of @file{libstdc++} used by
12490 the program without going all the way to a fully static link.  The
12491 @option{-static-libstdc++} option directs the @command{g++} driver to
12492 link @file{libstdc++} statically, without necessarily linking other
12493 libraries statically.
12495 @item -symbolic
12496 @opindex symbolic
12497 Bind references to global symbols when building a shared object.  Warn
12498 about any unresolved references (unless overridden by the link editor
12499 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12500 this option.
12502 @item -T @var{script}
12503 @opindex T
12504 @cindex linker script
12505 Use @var{script} as the linker script.  This option is supported by most
12506 systems using the GNU linker.  On some targets, such as bare-board
12507 targets without an operating system, the @option{-T} option may be required
12508 when linking to avoid references to undefined symbols.
12510 @item -Xlinker @var{option}
12511 @opindex Xlinker
12512 Pass @var{option} as an option to the linker.  You can use this to
12513 supply system-specific linker options that GCC does not recognize.
12515 If you want to pass an option that takes a separate argument, you must use
12516 @option{-Xlinker} twice, once for the option and once for the argument.
12517 For example, to pass @option{-assert definitions}, you must write
12518 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12519 @option{-Xlinker "-assert definitions"}, because this passes the entire
12520 string as a single argument, which is not what the linker expects.
12522 When using the GNU linker, it is usually more convenient to pass
12523 arguments to linker options using the @option{@var{option}=@var{value}}
12524 syntax than as separate arguments.  For example, you can specify
12525 @option{-Xlinker -Map=output.map} rather than
12526 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12527 this syntax for command-line options.
12529 @item -Wl,@var{option}
12530 @opindex Wl
12531 Pass @var{option} as an option to the linker.  If @var{option} contains
12532 commas, it is split into multiple options at the commas.  You can use this
12533 syntax to pass an argument to the option.
12534 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12535 linker.  When using the GNU linker, you can also get the same effect with
12536 @option{-Wl,-Map=output.map}.
12538 @item -u @var{symbol}
12539 @opindex u
12540 Pretend the symbol @var{symbol} is undefined, to force linking of
12541 library modules to define it.  You can use @option{-u} multiple times with
12542 different symbols to force loading of additional library modules.
12544 @item -z @var{keyword}
12545 @opindex z
12546 @option{-z} is passed directly on to the linker along with the keyword
12547 @var{keyword}. See the section in the documentation of your linker for
12548 permitted values and their meanings.
12549 @end table
12551 @node Directory Options
12552 @section Options for Directory Search
12553 @cindex directory options
12554 @cindex options, directory search
12555 @cindex search path
12557 These options specify directories to search for header files, for
12558 libraries and for parts of the compiler:
12560 @table @gcctabopt
12561 @include cppdiropts.texi
12563 @item -iplugindir=@var{dir}
12564 @opindex iplugindir=
12565 Set the directory to search for plugins that are passed
12566 by @option{-fplugin=@var{name}} instead of
12567 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12568 to be used by the user, but only passed by the driver.
12570 @item -L@var{dir}
12571 @opindex L
12572 Add directory @var{dir} to the list of directories to be searched
12573 for @option{-l}.
12575 @item -B@var{prefix}
12576 @opindex B
12577 This option specifies where to find the executables, libraries,
12578 include files, and data files of the compiler itself.
12580 The compiler driver program runs one or more of the subprograms
12581 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12582 @var{prefix} as a prefix for each program it tries to run, both with and
12583 without @samp{@var{machine}/@var{version}/} for the corresponding target
12584 machine and compiler version.
12586 For each subprogram to be run, the compiler driver first tries the
12587 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12588 is not specified, the driver tries two standard prefixes, 
12589 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12590 those results in a file name that is found, the unmodified program
12591 name is searched for using the directories specified in your
12592 @env{PATH} environment variable.
12594 The compiler checks to see if the path provided by @option{-B}
12595 refers to a directory, and if necessary it adds a directory
12596 separator character at the end of the path.
12598 @option{-B} prefixes that effectively specify directory names also apply
12599 to libraries in the linker, because the compiler translates these
12600 options into @option{-L} options for the linker.  They also apply to
12601 include files in the preprocessor, because the compiler translates these
12602 options into @option{-isystem} options for the preprocessor.  In this case,
12603 the compiler appends @samp{include} to the prefix.
12605 The runtime support file @file{libgcc.a} can also be searched for using
12606 the @option{-B} prefix, if needed.  If it is not found there, the two
12607 standard prefixes above are tried, and that is all.  The file is left
12608 out of the link if it is not found by those means.
12610 Another way to specify a prefix much like the @option{-B} prefix is to use
12611 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12612 Variables}.
12614 As a special kludge, if the path provided by @option{-B} is
12615 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12616 9, then it is replaced by @file{[dir/]include}.  This is to help
12617 with boot-strapping the compiler.
12619 @item -no-canonical-prefixes
12620 @opindex no-canonical-prefixes
12621 Do not expand any symbolic links, resolve references to @samp{/../}
12622 or @samp{/./}, or make the path absolute when generating a relative
12623 prefix.
12625 @item --sysroot=@var{dir}
12626 @opindex sysroot
12627 Use @var{dir} as the logical root directory for headers and libraries.
12628 For example, if the compiler normally searches for headers in
12629 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12630 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12632 If you use both this option and the @option{-isysroot} option, then
12633 the @option{--sysroot} option applies to libraries, but the
12634 @option{-isysroot} option applies to header files.
12636 The GNU linker (beginning with version 2.16) has the necessary support
12637 for this option.  If your linker does not support this option, the
12638 header file aspect of @option{--sysroot} still works, but the
12639 library aspect does not.
12641 @item --no-sysroot-suffix
12642 @opindex no-sysroot-suffix
12643 For some targets, a suffix is added to the root directory specified
12644 with @option{--sysroot}, depending on the other options used, so that
12645 headers may for example be found in
12646 @file{@var{dir}/@var{suffix}/usr/include} instead of
12647 @file{@var{dir}/usr/include}.  This option disables the addition of
12648 such a suffix.
12650 @end table
12652 @node Code Gen Options
12653 @section Options for Code Generation Conventions
12654 @cindex code generation conventions
12655 @cindex options, code generation
12656 @cindex run-time options
12658 These machine-independent options control the interface conventions
12659 used in code generation.
12661 Most of them have both positive and negative forms; the negative form
12662 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12663 one of the forms is listed---the one that is not the default.  You
12664 can figure out the other form by either removing @samp{no-} or adding
12667 @table @gcctabopt
12668 @item -fstack-reuse=@var{reuse-level}
12669 @opindex fstack_reuse
12670 This option controls stack space reuse for user declared local/auto variables
12671 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12672 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12673 local variables and temporaries, @samp{named_vars} enables the reuse only for
12674 user defined local variables with names, and @samp{none} disables stack reuse
12675 completely. The default value is @samp{all}. The option is needed when the
12676 program extends the lifetime of a scoped local variable or a compiler generated
12677 temporary beyond the end point defined by the language.  When a lifetime of
12678 a variable ends, and if the variable lives in memory, the optimizing compiler
12679 has the freedom to reuse its stack space with other temporaries or scoped
12680 local variables whose live range does not overlap with it. Legacy code extending
12681 local lifetime is likely to break with the stack reuse optimization.
12683 For example,
12685 @smallexample
12686    int *p;
12687    @{
12688      int local1;
12690      p = &local1;
12691      local1 = 10;
12692      ....
12693    @}
12694    @{
12695       int local2;
12696       local2 = 20;
12697       ...
12698    @}
12700    if (*p == 10)  // out of scope use of local1
12701      @{
12703      @}
12704 @end smallexample
12706 Another example:
12707 @smallexample
12709    struct A
12710    @{
12711        A(int k) : i(k), j(k) @{ @}
12712        int i;
12713        int j;
12714    @};
12716    A *ap;
12718    void foo(const A& ar)
12719    @{
12720       ap = &ar;
12721    @}
12723    void bar()
12724    @{
12725       foo(A(10)); // temp object's lifetime ends when foo returns
12727       @{
12728         A a(20);
12729         ....
12730       @}
12731       ap->i+= 10;  // ap references out of scope temp whose space
12732                    // is reused with a. What is the value of ap->i?
12733    @}
12735 @end smallexample
12737 The lifetime of a compiler generated temporary is well defined by the C++
12738 standard. When a lifetime of a temporary ends, and if the temporary lives
12739 in memory, the optimizing compiler has the freedom to reuse its stack
12740 space with other temporaries or scoped local variables whose live range
12741 does not overlap with it. However some of the legacy code relies on
12742 the behavior of older compilers in which temporaries' stack space is
12743 not reused, the aggressive stack reuse can lead to runtime errors. This
12744 option is used to control the temporary stack reuse optimization.
12746 @item -ftrapv
12747 @opindex ftrapv
12748 This option generates traps for signed overflow on addition, subtraction,
12749 multiplication operations.
12750 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12751 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12752 @option{-fwrapv} being effective.  Note that only active options override, so
12753 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12754 results in @option{-ftrapv} being effective.
12756 @item -fwrapv
12757 @opindex fwrapv
12758 This option instructs the compiler to assume that signed arithmetic
12759 overflow of addition, subtraction and multiplication wraps around
12760 using twos-complement representation.  This flag enables some optimizations
12761 and disables others.
12762 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12763 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12764 @option{-fwrapv} being effective.  Note that only active options override, so
12765 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12766 results in @option{-ftrapv} being effective.
12768 @item -fwrapv-pointer
12769 @opindex fwrapv-pointer
12770 This option instructs the compiler to assume that pointer arithmetic
12771 overflow on addition and subtraction wraps around using twos-complement
12772 representation.  This flag disables some optimizations which assume
12773 pointer overflow is invalid.
12775 @item -fstrict-overflow
12776 @opindex fstrict-overflow
12777 This option implies @option{-fno-wrapv} @option{-fno-wrapv-pointer} and when
12778 negated implies @option{-fwrapv} @option{-fwrapv-pointer}.
12780 @item -fexceptions
12781 @opindex fexceptions
12782 Enable exception handling.  Generates extra code needed to propagate
12783 exceptions.  For some targets, this implies GCC generates frame
12784 unwind information for all functions, which can produce significant data
12785 size overhead, although it does not affect execution.  If you do not
12786 specify this option, GCC enables it by default for languages like
12787 C++ that normally require exception handling, and disables it for
12788 languages like C that do not normally require it.  However, you may need
12789 to enable this option when compiling C code that needs to interoperate
12790 properly with exception handlers written in C++.  You may also wish to
12791 disable this option if you are compiling older C++ programs that don't
12792 use exception handling.
12794 @item -fnon-call-exceptions
12795 @opindex fnon-call-exceptions
12796 Generate code that allows trapping instructions to throw exceptions.
12797 Note that this requires platform-specific runtime support that does
12798 not exist everywhere.  Moreover, it only allows @emph{trapping}
12799 instructions to throw exceptions, i.e.@: memory references or floating-point
12800 instructions.  It does not allow exceptions to be thrown from
12801 arbitrary signal handlers such as @code{SIGALRM}.
12803 @item -fdelete-dead-exceptions
12804 @opindex fdelete-dead-exceptions
12805 Consider that instructions that may throw exceptions but don't otherwise
12806 contribute to the execution of the program can be optimized away.
12807 This option is enabled by default for the Ada front end, as permitted by
12808 the Ada language specification.
12809 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12811 @item -funwind-tables
12812 @opindex funwind-tables
12813 Similar to @option{-fexceptions}, except that it just generates any needed
12814 static data, but does not affect the generated code in any other way.
12815 You normally do not need to enable this option; instead, a language processor
12816 that needs this handling enables it on your behalf.
12818 @item -fasynchronous-unwind-tables
12819 @opindex fasynchronous-unwind-tables
12820 Generate unwind table in DWARF format, if supported by target machine.  The
12821 table is exact at each instruction boundary, so it can be used for stack
12822 unwinding from asynchronous events (such as debugger or garbage collector).
12824 @item -fno-gnu-unique
12825 @opindex fno-gnu-unique
12826 On systems with recent GNU assembler and C library, the C++ compiler
12827 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12828 of template static data members and static local variables in inline
12829 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12830 is necessary to avoid problems with a library used by two different
12831 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12832 therefore disagreeing with the other one about the binding of the
12833 symbol.  But this causes @code{dlclose} to be ignored for affected
12834 DSOs; if your program relies on reinitialization of a DSO via
12835 @code{dlclose} and @code{dlopen}, you can use
12836 @option{-fno-gnu-unique}.
12838 @item -fpcc-struct-return
12839 @opindex fpcc-struct-return
12840 Return ``short'' @code{struct} and @code{union} values in memory like
12841 longer ones, rather than in registers.  This convention is less
12842 efficient, but it has the advantage of allowing intercallability between
12843 GCC-compiled files and files compiled with other compilers, particularly
12844 the Portable C Compiler (pcc).
12846 The precise convention for returning structures in memory depends
12847 on the target configuration macros.
12849 Short structures and unions are those whose size and alignment match
12850 that of some integer type.
12852 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12853 switch is not binary compatible with code compiled with the
12854 @option{-freg-struct-return} switch.
12855 Use it to conform to a non-default application binary interface.
12857 @item -freg-struct-return
12858 @opindex freg-struct-return
12859 Return @code{struct} and @code{union} values in registers when possible.
12860 This is more efficient for small structures than
12861 @option{-fpcc-struct-return}.
12863 If you specify neither @option{-fpcc-struct-return} nor
12864 @option{-freg-struct-return}, GCC defaults to whichever convention is
12865 standard for the target.  If there is no standard convention, GCC
12866 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12867 the principal compiler.  In those cases, we can choose the standard, and
12868 we chose the more efficient register return alternative.
12870 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12871 switch is not binary compatible with code compiled with the
12872 @option{-fpcc-struct-return} switch.
12873 Use it to conform to a non-default application binary interface.
12875 @item -fshort-enums
12876 @opindex fshort-enums
12877 Allocate to an @code{enum} type only as many bytes as it needs for the
12878 declared range of possible values.  Specifically, the @code{enum} type
12879 is equivalent to the smallest integer type that has enough room.
12881 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12882 code that is not binary compatible with code generated without that switch.
12883 Use it to conform to a non-default application binary interface.
12885 @item -fshort-wchar
12886 @opindex fshort-wchar
12887 Override the underlying type for @code{wchar_t} to be @code{short
12888 unsigned int} instead of the default for the target.  This option is
12889 useful for building programs to run under WINE@.
12891 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12892 code that is not binary compatible with code generated without that switch.
12893 Use it to conform to a non-default application binary interface.
12895 @item -fno-common
12896 @opindex fno-common
12897 @cindex tentative definitions
12898 In C code, this option controls the placement of global variables 
12899 defined without an initializer, known as @dfn{tentative definitions} 
12900 in the C standard.  Tentative definitions are distinct from declarations 
12901 of a variable with the @code{extern} keyword, which do not allocate storage.
12903 Unix C compilers have traditionally allocated storage for
12904 uninitialized global variables in a common block.  This allows the
12905 linker to resolve all tentative definitions of the same variable
12906 in different compilation units to the same object, or to a non-tentative
12907 definition.  
12908 This is the behavior specified by @option{-fcommon}, and is the default for 
12909 GCC on most targets.  
12910 On the other hand, this behavior is not required by ISO
12911 C, and on some targets may carry a speed or code size penalty on
12912 variable references.
12914 The @option{-fno-common} option specifies that the compiler should instead
12915 place uninitialized global variables in the data section of the object file.
12916 This inhibits the merging of tentative definitions by the linker so
12917 you get a multiple-definition error if the same 
12918 variable is defined in more than one compilation unit.
12919 Compiling with @option{-fno-common} is useful on targets for which
12920 it provides better performance, or if you wish to verify that the
12921 program will work on other systems that always treat uninitialized
12922 variable definitions this way.
12924 @item -fno-ident
12925 @opindex fno-ident
12926 Ignore the @code{#ident} directive.
12928 @item -finhibit-size-directive
12929 @opindex finhibit-size-directive
12930 Don't output a @code{.size} assembler directive, or anything else that
12931 would cause trouble if the function is split in the middle, and the
12932 two halves are placed at locations far apart in memory.  This option is
12933 used when compiling @file{crtstuff.c}; you should not need to use it
12934 for anything else.
12936 @item -fverbose-asm
12937 @opindex fverbose-asm
12938 Put extra commentary information in the generated assembly code to
12939 make it more readable.  This option is generally only of use to those
12940 who actually need to read the generated assembly code (perhaps while
12941 debugging the compiler itself).
12943 @option{-fno-verbose-asm}, the default, causes the
12944 extra information to be omitted and is useful when comparing two assembler
12945 files.
12947 The added comments include:
12949 @itemize @bullet
12951 @item
12952 information on the compiler version and command-line options,
12954 @item
12955 the source code lines associated with the assembly instructions,
12956 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12958 @item
12959 hints on which high-level expressions correspond to
12960 the various assembly instruction operands.
12962 @end itemize
12964 For example, given this C source file:
12966 @smallexample
12967 int test (int n)
12969   int i;
12970   int total = 0;
12972   for (i = 0; i < n; i++)
12973     total += i * i;
12975   return total;
12977 @end smallexample
12979 compiling to (x86_64) assembly via @option{-S} and emitting the result
12980 direct to stdout via @option{-o} @option{-}
12982 @smallexample
12983 gcc -S test.c -fverbose-asm -Os -o -
12984 @end smallexample
12986 gives output similar to this:
12988 @smallexample
12989         .file   "test.c"
12990 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12991   [...snip...]
12992 # options passed:
12993   [...snip...]
12995         .text
12996         .globl  test
12997         .type   test, @@function
12998 test:
12999 .LFB0:
13000         .cfi_startproc
13001 # test.c:4:   int total = 0;
13002         xorl    %eax, %eax      # <retval>
13003 # test.c:6:   for (i = 0; i < n; i++)
13004         xorl    %edx, %edx      # i
13005 .L2:
13006 # test.c:6:   for (i = 0; i < n; i++)
13007         cmpl    %edi, %edx      # n, i
13008         jge     .L5     #,
13009 # test.c:7:     total += i * i;
13010         movl    %edx, %ecx      # i, tmp92
13011         imull   %edx, %ecx      # i, tmp92
13012 # test.c:6:   for (i = 0; i < n; i++)
13013         incl    %edx    # i
13014 # test.c:7:     total += i * i;
13015         addl    %ecx, %eax      # tmp92, <retval>
13016         jmp     .L2     #
13017 .L5:
13018 # test.c:10: @}
13019         ret
13020         .cfi_endproc
13021 .LFE0:
13022         .size   test, .-test
13023         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
13024         .section        .note.GNU-stack,"",@@progbits
13025 @end smallexample
13027 The comments are intended for humans rather than machines and hence the
13028 precise format of the comments is subject to change.
13030 @item -frecord-gcc-switches
13031 @opindex frecord-gcc-switches
13032 This switch causes the command line used to invoke the
13033 compiler to be recorded into the object file that is being created.
13034 This switch is only implemented on some targets and the exact format
13035 of the recording is target and binary file format dependent, but it
13036 usually takes the form of a section containing ASCII text.  This
13037 switch is related to the @option{-fverbose-asm} switch, but that
13038 switch only records information in the assembler output file as
13039 comments, so it never reaches the object file.
13040 See also @option{-grecord-gcc-switches} for another
13041 way of storing compiler options into the object file.
13043 @item -fpic
13044 @opindex fpic
13045 @cindex global offset table
13046 @cindex PIC
13047 Generate position-independent code (PIC) suitable for use in a shared
13048 library, if supported for the target machine.  Such code accesses all
13049 constant addresses through a global offset table (GOT)@.  The dynamic
13050 loader resolves the GOT entries when the program starts (the dynamic
13051 loader is not part of GCC; it is part of the operating system).  If
13052 the GOT size for the linked executable exceeds a machine-specific
13053 maximum size, you get an error message from the linker indicating that
13054 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13055 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
13056 on the m68k and RS/6000.  The x86 has no such limit.)
13058 Position-independent code requires special support, and therefore works
13059 only on certain machines.  For the x86, GCC supports PIC for System V
13060 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13061 position-independent.
13063 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13064 are defined to 1.
13066 @item -fPIC
13067 @opindex fPIC
13068 If supported for the target machine, emit position-independent code,
13069 suitable for dynamic linking and avoiding any limit on the size of the
13070 global offset table.  This option makes a difference on AArch64, m68k,
13071 PowerPC and SPARC@.
13073 Position-independent code requires special support, and therefore works
13074 only on certain machines.
13076 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13077 are defined to 2.
13079 @item -fpie
13080 @itemx -fPIE
13081 @opindex fpie
13082 @opindex fPIE
13083 These options are similar to @option{-fpic} and @option{-fPIC}, but
13084 generated position independent code can be only linked into executables.
13085 Usually these options are used when @option{-pie} GCC option is
13086 used during linking.
13088 @option{-fpie} and @option{-fPIE} both define the macros
13089 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
13090 for @option{-fpie} and 2 for @option{-fPIE}.
13092 @item -fno-plt
13093 @opindex fno-plt
13094 Do not use the PLT for external function calls in position-independent code.
13095 Instead, load the callee address at call sites from the GOT and branch to it.
13096 This leads to more efficient code by eliminating PLT stubs and exposing
13097 GOT loads to optimizations.  On architectures such as 32-bit x86 where
13098 PLT stubs expect the GOT pointer in a specific register, this gives more
13099 register allocation freedom to the compiler.
13100 Lazy binding requires use of the PLT; 
13101 with @option{-fno-plt} all external symbols are resolved at load time.
13103 Alternatively, the function attribute @code{noplt} can be used to avoid calls
13104 through the PLT for specific external functions.
13106 In position-dependent code, a few targets also convert calls to
13107 functions that are marked to not use the PLT to use the GOT instead.
13109 @item -fno-jump-tables
13110 @opindex fno-jump-tables
13111 Do not use jump tables for switch statements even where it would be
13112 more efficient than other code generation strategies.  This option is
13113 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13114 building code that forms part of a dynamic linker and cannot
13115 reference the address of a jump table.  On some targets, jump tables
13116 do not require a GOT and this option is not needed.
13118 @item -ffixed-@var{reg}
13119 @opindex ffixed
13120 Treat the register named @var{reg} as a fixed register; generated code
13121 should never refer to it (except perhaps as a stack pointer, frame
13122 pointer or in some other fixed role).
13124 @var{reg} must be the name of a register.  The register names accepted
13125 are machine-specific and are defined in the @code{REGISTER_NAMES}
13126 macro in the machine description macro file.
13128 This flag does not have a negative form, because it specifies a
13129 three-way choice.
13131 @item -fcall-used-@var{reg}
13132 @opindex fcall-used
13133 Treat the register named @var{reg} as an allocable register that is
13134 clobbered by function calls.  It may be allocated for temporaries or
13135 variables that do not live across a call.  Functions compiled this way
13136 do not save and restore the register @var{reg}.
13138 It is an error to use this flag with the frame pointer or stack pointer.
13139 Use of this flag for other registers that have fixed pervasive roles in
13140 the machine's execution model produces disastrous results.
13142 This flag does not have a negative form, because it specifies a
13143 three-way choice.
13145 @item -fcall-saved-@var{reg}
13146 @opindex fcall-saved
13147 Treat the register named @var{reg} as an allocable register saved by
13148 functions.  It may be allocated even for temporaries or variables that
13149 live across a call.  Functions compiled this way save and restore
13150 the register @var{reg} if they use it.
13152 It is an error to use this flag with the frame pointer or stack pointer.
13153 Use of this flag for other registers that have fixed pervasive roles in
13154 the machine's execution model produces disastrous results.
13156 A different sort of disaster results from the use of this flag for
13157 a register in which function values may be returned.
13159 This flag does not have a negative form, because it specifies a
13160 three-way choice.
13162 @item -fpack-struct[=@var{n}]
13163 @opindex fpack-struct
13164 Without a value specified, pack all structure members together without
13165 holes.  When a value is specified (which must be a small power of two), pack
13166 structure members according to this value, representing the maximum
13167 alignment (that is, objects with default alignment requirements larger than
13168 this are output potentially unaligned at the next fitting location.
13170 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13171 code that is not binary compatible with code generated without that switch.
13172 Additionally, it makes the code suboptimal.
13173 Use it to conform to a non-default application binary interface.
13175 @item -fleading-underscore
13176 @opindex fleading-underscore
13177 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13178 change the way C symbols are represented in the object file.  One use
13179 is to help link with legacy assembly code.
13181 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13182 generate code that is not binary compatible with code generated without that
13183 switch.  Use it to conform to a non-default application binary interface.
13184 Not all targets provide complete support for this switch.
13186 @item -ftls-model=@var{model}
13187 @opindex ftls-model
13188 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13189 The @var{model} argument should be one of @samp{global-dynamic},
13190 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
13191 Note that the choice is subject to optimization: the compiler may use
13192 a more efficient model for symbols not visible outside of the translation
13193 unit, or if @option{-fpic} is not given on the command line.
13195 The default without @option{-fpic} is @samp{initial-exec}; with
13196 @option{-fpic} the default is @samp{global-dynamic}.
13198 @item -ftrampolines
13199 @opindex ftrampolines
13200 For targets that normally need trampolines for nested functions, always
13201 generate them instead of using descriptors.  Otherwise, for targets that
13202 do not need them, like for example HP-PA or IA-64, do nothing.
13204 A trampoline is a small piece of code that is created at run time on the
13205 stack when the address of a nested function is taken, and is used to call
13206 the nested function indirectly.  Therefore, it requires the stack to be
13207 made executable in order for the program to work properly.
13209 @option{-fno-trampolines} is enabled by default on a language by language
13210 basis to let the compiler avoid generating them, if it computes that this
13211 is safe, and replace them with descriptors.  Descriptors are made up of data
13212 only, but the generated code must be prepared to deal with them.  As of this
13213 writing, @option{-fno-trampolines} is enabled by default only for Ada.
13215 Moreover, code compiled with @option{-ftrampolines} and code compiled with
13216 @option{-fno-trampolines} are not binary compatible if nested functions are
13217 present.  This option must therefore be used on a program-wide basis and be
13218 manipulated with extreme care.
13220 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
13221 @opindex fvisibility
13222 Set the default ELF image symbol visibility to the specified option---all
13223 symbols are marked with this unless overridden within the code.
13224 Using this feature can very substantially improve linking and
13225 load times of shared object libraries, produce more optimized
13226 code, provide near-perfect API export and prevent symbol clashes.
13227 It is @strong{strongly} recommended that you use this in any shared objects
13228 you distribute.
13230 Despite the nomenclature, @samp{default} always means public; i.e.,
13231 available to be linked against from outside the shared object.
13232 @samp{protected} and @samp{internal} are pretty useless in real-world
13233 usage so the only other commonly used option is @samp{hidden}.
13234 The default if @option{-fvisibility} isn't specified is
13235 @samp{default}, i.e., make every symbol public.
13237 A good explanation of the benefits offered by ensuring ELF
13238 symbols have the correct visibility is given by ``How To Write
13239 Shared Libraries'' by Ulrich Drepper (which can be found at
13240 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13241 solution made possible by this option to marking things hidden when
13242 the default is public is to make the default hidden and mark things
13243 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13244 and @code{__attribute__ ((visibility("default")))} instead of
13245 @code{__declspec(dllexport)} you get almost identical semantics with
13246 identical syntax.  This is a great boon to those working with
13247 cross-platform projects.
13249 For those adding visibility support to existing code, you may find
13250 @code{#pragma GCC visibility} of use.  This works by you enclosing
13251 the declarations you wish to set visibility for with (for example)
13252 @code{#pragma GCC visibility push(hidden)} and
13253 @code{#pragma GCC visibility pop}.
13254 Bear in mind that symbol visibility should be viewed @strong{as
13255 part of the API interface contract} and thus all new code should
13256 always specify visibility when it is not the default; i.e., declarations
13257 only for use within the local DSO should @strong{always} be marked explicitly
13258 as hidden as so to avoid PLT indirection overheads---making this
13259 abundantly clear also aids readability and self-documentation of the code.
13260 Note that due to ISO C++ specification requirements, @code{operator new} and
13261 @code{operator delete} must always be of default visibility.
13263 Be aware that headers from outside your project, in particular system
13264 headers and headers from any other library you use, may not be
13265 expecting to be compiled with visibility other than the default.  You
13266 may need to explicitly say @code{#pragma GCC visibility push(default)}
13267 before including any such headers.
13269 @code{extern} declarations are not affected by @option{-fvisibility}, so
13270 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13271 no modifications.  However, this means that calls to @code{extern}
13272 functions with no explicit visibility use the PLT, so it is more
13273 effective to use @code{__attribute ((visibility))} and/or
13274 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13275 declarations should be treated as hidden.
13277 Note that @option{-fvisibility} does affect C++ vague linkage
13278 entities. This means that, for instance, an exception class that is
13279 be thrown between DSOs must be explicitly marked with default
13280 visibility so that the @samp{type_info} nodes are unified between
13281 the DSOs.
13283 An overview of these techniques, their benefits and how to use them
13284 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13286 @item -fstrict-volatile-bitfields
13287 @opindex fstrict-volatile-bitfields
13288 This option should be used if accesses to volatile bit-fields (or other
13289 structure fields, although the compiler usually honors those types
13290 anyway) should use a single access of the width of the
13291 field's type, aligned to a natural alignment if possible.  For
13292 example, targets with memory-mapped peripheral registers might require
13293 all such accesses to be 16 bits wide; with this flag you can
13294 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13295 is 16 bits on these targets) to force GCC to use 16-bit accesses
13296 instead of, perhaps, a more efficient 32-bit access.
13298 If this option is disabled, the compiler uses the most efficient
13299 instruction.  In the previous example, that might be a 32-bit load
13300 instruction, even though that accesses bytes that do not contain
13301 any portion of the bit-field, or memory-mapped registers unrelated to
13302 the one being updated.
13304 In some cases, such as when the @code{packed} attribute is applied to a 
13305 structure field, it may not be possible to access the field with a single
13306 read or write that is correctly aligned for the target machine.  In this
13307 case GCC falls back to generating multiple accesses rather than code that 
13308 will fault or truncate the result at run time.
13310 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13311 not allowed to touch non bit-field members.  It is therefore recommended
13312 to define all bits of the field's type as bit-field members.
13314 The default value of this option is determined by the application binary
13315 interface for the target processor.
13317 @item -fsync-libcalls
13318 @opindex fsync-libcalls
13319 This option controls whether any out-of-line instance of the @code{__sync}
13320 family of functions may be used to implement the C++11 @code{__atomic}
13321 family of functions.
13323 The default value of this option is enabled, thus the only useful form
13324 of the option is @option{-fno-sync-libcalls}.  This option is used in
13325 the implementation of the @file{libatomic} runtime library.
13327 @end table
13329 @node Developer Options
13330 @section GCC Developer Options
13331 @cindex developer options
13332 @cindex debugging GCC
13333 @cindex debug dump options
13334 @cindex dump options
13335 @cindex compilation statistics
13337 This section describes command-line options that are primarily of
13338 interest to GCC developers, including options to support compiler
13339 testing and investigation of compiler bugs and compile-time
13340 performance problems.  This includes options that produce debug dumps
13341 at various points in the compilation; that print statistics such as
13342 memory use and execution time; and that print information about GCC's
13343 configuration, such as where it searches for libraries.  You should
13344 rarely need to use any of these options for ordinary compilation and
13345 linking tasks.
13347 @table @gcctabopt
13349 @item -d@var{letters}
13350 @itemx -fdump-rtl-@var{pass}
13351 @itemx -fdump-rtl-@var{pass}=@var{filename}
13352 @opindex d
13353 @opindex fdump-rtl-@var{pass}
13354 Says to make debugging dumps during compilation at times specified by
13355 @var{letters}.  This is used for debugging the RTL-based passes of the
13356 compiler.  The file names for most of the dumps are made by appending
13357 a pass number and a word to the @var{dumpname}, and the files are
13358 created in the directory of the output file.  In case of
13359 @option{=@var{filename}} option, the dump is output on the given file
13360 instead of the pass numbered dump files.  Note that the pass number is
13361 assigned as passes are registered into the pass manager.  Most passes
13362 are registered in the order that they will execute and for these passes
13363 the number corresponds to the pass execution order.  However, passes
13364 registered by plugins, passes specific to compilation targets, or
13365 passes that are otherwise registered after all the other passes are
13366 numbered higher than a pass named "final", even if they are executed
13367 earlier.  @var{dumpname} is generated from the name of the output
13368 file if explicitly specified and not an executable, otherwise it is
13369 the basename of the source file.  
13371 Some @option{-d@var{letters}} switches have different meaning when
13372 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13373 for information about preprocessor-specific dump options.
13375 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13376 @option{-d} option @var{letters}.  Here are the possible
13377 letters for use in @var{pass} and @var{letters}, and their meanings:
13379 @table @gcctabopt
13381 @item -fdump-rtl-alignments
13382 @opindex fdump-rtl-alignments
13383 Dump after branch alignments have been computed.
13385 @item -fdump-rtl-asmcons
13386 @opindex fdump-rtl-asmcons
13387 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13389 @item -fdump-rtl-auto_inc_dec
13390 @opindex fdump-rtl-auto_inc_dec
13391 Dump after auto-inc-dec discovery.  This pass is only run on
13392 architectures that have auto inc or auto dec instructions.
13394 @item -fdump-rtl-barriers
13395 @opindex fdump-rtl-barriers
13396 Dump after cleaning up the barrier instructions.
13398 @item -fdump-rtl-bbpart
13399 @opindex fdump-rtl-bbpart
13400 Dump after partitioning hot and cold basic blocks.
13402 @item -fdump-rtl-bbro
13403 @opindex fdump-rtl-bbro
13404 Dump after block reordering.
13406 @item -fdump-rtl-btl1
13407 @itemx -fdump-rtl-btl2
13408 @opindex fdump-rtl-btl2
13409 @opindex fdump-rtl-btl2
13410 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13411 after the two branch
13412 target load optimization passes.
13414 @item -fdump-rtl-bypass
13415 @opindex fdump-rtl-bypass
13416 Dump after jump bypassing and control flow optimizations.
13418 @item -fdump-rtl-combine
13419 @opindex fdump-rtl-combine
13420 Dump after the RTL instruction combination pass.
13422 @item -fdump-rtl-compgotos
13423 @opindex fdump-rtl-compgotos
13424 Dump after duplicating the computed gotos.
13426 @item -fdump-rtl-ce1
13427 @itemx -fdump-rtl-ce2
13428 @itemx -fdump-rtl-ce3
13429 @opindex fdump-rtl-ce1
13430 @opindex fdump-rtl-ce2
13431 @opindex fdump-rtl-ce3
13432 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13433 @option{-fdump-rtl-ce3} enable dumping after the three
13434 if conversion passes.
13436 @item -fdump-rtl-cprop_hardreg
13437 @opindex fdump-rtl-cprop_hardreg
13438 Dump after hard register copy propagation.
13440 @item -fdump-rtl-csa
13441 @opindex fdump-rtl-csa
13442 Dump after combining stack adjustments.
13444 @item -fdump-rtl-cse1
13445 @itemx -fdump-rtl-cse2
13446 @opindex fdump-rtl-cse1
13447 @opindex fdump-rtl-cse2
13448 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13449 the two common subexpression elimination passes.
13451 @item -fdump-rtl-dce
13452 @opindex fdump-rtl-dce
13453 Dump after the standalone dead code elimination passes.
13455 @item -fdump-rtl-dbr
13456 @opindex fdump-rtl-dbr
13457 Dump after delayed branch scheduling.
13459 @item -fdump-rtl-dce1
13460 @itemx -fdump-rtl-dce2
13461 @opindex fdump-rtl-dce1
13462 @opindex fdump-rtl-dce2
13463 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13464 the two dead store elimination passes.
13466 @item -fdump-rtl-eh
13467 @opindex fdump-rtl-eh
13468 Dump after finalization of EH handling code.
13470 @item -fdump-rtl-eh_ranges
13471 @opindex fdump-rtl-eh_ranges
13472 Dump after conversion of EH handling range regions.
13474 @item -fdump-rtl-expand
13475 @opindex fdump-rtl-expand
13476 Dump after RTL generation.
13478 @item -fdump-rtl-fwprop1
13479 @itemx -fdump-rtl-fwprop2
13480 @opindex fdump-rtl-fwprop1
13481 @opindex fdump-rtl-fwprop2
13482 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13483 dumping after the two forward propagation passes.
13485 @item -fdump-rtl-gcse1
13486 @itemx -fdump-rtl-gcse2
13487 @opindex fdump-rtl-gcse1
13488 @opindex fdump-rtl-gcse2
13489 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13490 after global common subexpression elimination.
13492 @item -fdump-rtl-init-regs
13493 @opindex fdump-rtl-init-regs
13494 Dump after the initialization of the registers.
13496 @item -fdump-rtl-initvals
13497 @opindex fdump-rtl-initvals
13498 Dump after the computation of the initial value sets.
13500 @item -fdump-rtl-into_cfglayout
13501 @opindex fdump-rtl-into_cfglayout
13502 Dump after converting to cfglayout mode.
13504 @item -fdump-rtl-ira
13505 @opindex fdump-rtl-ira
13506 Dump after iterated register allocation.
13508 @item -fdump-rtl-jump
13509 @opindex fdump-rtl-jump
13510 Dump after the second jump optimization.
13512 @item -fdump-rtl-loop2
13513 @opindex fdump-rtl-loop2
13514 @option{-fdump-rtl-loop2} enables dumping after the rtl
13515 loop optimization passes.
13517 @item -fdump-rtl-mach
13518 @opindex fdump-rtl-mach
13519 Dump after performing the machine dependent reorganization pass, if that
13520 pass exists.
13522 @item -fdump-rtl-mode_sw
13523 @opindex fdump-rtl-mode_sw
13524 Dump after removing redundant mode switches.
13526 @item -fdump-rtl-rnreg
13527 @opindex fdump-rtl-rnreg
13528 Dump after register renumbering.
13530 @item -fdump-rtl-outof_cfglayout
13531 @opindex fdump-rtl-outof_cfglayout
13532 Dump after converting from cfglayout mode.
13534 @item -fdump-rtl-peephole2
13535 @opindex fdump-rtl-peephole2
13536 Dump after the peephole pass.
13538 @item -fdump-rtl-postreload
13539 @opindex fdump-rtl-postreload
13540 Dump after post-reload optimizations.
13542 @item -fdump-rtl-pro_and_epilogue
13543 @opindex fdump-rtl-pro_and_epilogue
13544 Dump after generating the function prologues and epilogues.
13546 @item -fdump-rtl-sched1
13547 @itemx -fdump-rtl-sched2
13548 @opindex fdump-rtl-sched1
13549 @opindex fdump-rtl-sched2
13550 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13551 after the basic block scheduling passes.
13553 @item -fdump-rtl-ree
13554 @opindex fdump-rtl-ree
13555 Dump after sign/zero extension elimination.
13557 @item -fdump-rtl-seqabstr
13558 @opindex fdump-rtl-seqabstr
13559 Dump after common sequence discovery.
13561 @item -fdump-rtl-shorten
13562 @opindex fdump-rtl-shorten
13563 Dump after shortening branches.
13565 @item -fdump-rtl-sibling
13566 @opindex fdump-rtl-sibling
13567 Dump after sibling call optimizations.
13569 @item -fdump-rtl-split1
13570 @itemx -fdump-rtl-split2
13571 @itemx -fdump-rtl-split3
13572 @itemx -fdump-rtl-split4
13573 @itemx -fdump-rtl-split5
13574 @opindex fdump-rtl-split1
13575 @opindex fdump-rtl-split2
13576 @opindex fdump-rtl-split3
13577 @opindex fdump-rtl-split4
13578 @opindex fdump-rtl-split5
13579 These options enable dumping after five rounds of
13580 instruction splitting.
13582 @item -fdump-rtl-sms
13583 @opindex fdump-rtl-sms
13584 Dump after modulo scheduling.  This pass is only run on some
13585 architectures.
13587 @item -fdump-rtl-stack
13588 @opindex fdump-rtl-stack
13589 Dump after conversion from GCC's ``flat register file'' registers to the
13590 x87's stack-like registers.  This pass is only run on x86 variants.
13592 @item -fdump-rtl-subreg1
13593 @itemx -fdump-rtl-subreg2
13594 @opindex fdump-rtl-subreg1
13595 @opindex fdump-rtl-subreg2
13596 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13597 the two subreg expansion passes.
13599 @item -fdump-rtl-unshare
13600 @opindex fdump-rtl-unshare
13601 Dump after all rtl has been unshared.
13603 @item -fdump-rtl-vartrack
13604 @opindex fdump-rtl-vartrack
13605 Dump after variable tracking.
13607 @item -fdump-rtl-vregs
13608 @opindex fdump-rtl-vregs
13609 Dump after converting virtual registers to hard registers.
13611 @item -fdump-rtl-web
13612 @opindex fdump-rtl-web
13613 Dump after live range splitting.
13615 @item -fdump-rtl-regclass
13616 @itemx -fdump-rtl-subregs_of_mode_init
13617 @itemx -fdump-rtl-subregs_of_mode_finish
13618 @itemx -fdump-rtl-dfinit
13619 @itemx -fdump-rtl-dfinish
13620 @opindex fdump-rtl-regclass
13621 @opindex fdump-rtl-subregs_of_mode_init
13622 @opindex fdump-rtl-subregs_of_mode_finish
13623 @opindex fdump-rtl-dfinit
13624 @opindex fdump-rtl-dfinish
13625 These dumps are defined but always produce empty files.
13627 @item -da
13628 @itemx -fdump-rtl-all
13629 @opindex da
13630 @opindex fdump-rtl-all
13631 Produce all the dumps listed above.
13633 @item -dA
13634 @opindex dA
13635 Annotate the assembler output with miscellaneous debugging information.
13637 @item -dD
13638 @opindex dD
13639 Dump all macro definitions, at the end of preprocessing, in addition to
13640 normal output.
13642 @item -dH
13643 @opindex dH
13644 Produce a core dump whenever an error occurs.
13646 @item -dp
13647 @opindex dp
13648 Annotate the assembler output with a comment indicating which
13649 pattern and alternative is used.  The length and cost of each instruction are
13650 also printed.
13652 @item -dP
13653 @opindex dP
13654 Dump the RTL in the assembler output as a comment before each instruction.
13655 Also turns on @option{-dp} annotation.
13657 @item -dx
13658 @opindex dx
13659 Just generate RTL for a function instead of compiling it.  Usually used
13660 with @option{-fdump-rtl-expand}.
13661 @end table
13663 @item -fdump-noaddr
13664 @opindex fdump-noaddr
13665 When doing debugging dumps, suppress address output.  This makes it more
13666 feasible to use diff on debugging dumps for compiler invocations with
13667 different compiler binaries and/or different
13668 text / bss / data / heap / stack / dso start locations.
13670 @item -freport-bug
13671 @opindex freport-bug
13672 Collect and dump debug information into a temporary file if an
13673 internal compiler error (ICE) occurs.
13675 @item -fdump-unnumbered
13676 @opindex fdump-unnumbered
13677 When doing debugging dumps, suppress instruction numbers and address output.
13678 This makes it more feasible to use diff on debugging dumps for compiler
13679 invocations with different options, in particular with and without
13680 @option{-g}.
13682 @item -fdump-unnumbered-links
13683 @opindex fdump-unnumbered-links
13684 When doing debugging dumps (see @option{-d} option above), suppress
13685 instruction numbers for the links to the previous and next instructions
13686 in a sequence.
13688 @item -fdump-ipa-@var{switch}
13689 @opindex fdump-ipa
13690 Control the dumping at various stages of inter-procedural analysis
13691 language tree to a file.  The file name is generated by appending a
13692 switch specific suffix to the source file name, and the file is created
13693 in the same directory as the output file.  The following dumps are
13694 possible:
13696 @table @samp
13697 @item all
13698 Enables all inter-procedural analysis dumps.
13700 @item cgraph
13701 Dumps information about call-graph optimization, unused function removal,
13702 and inlining decisions.
13704 @item inline
13705 Dump after function inlining.
13707 @end table
13709 @item -fdump-lang-all
13710 @itemx -fdump-lang-@var{switch}
13711 @itemx -fdump-lang-@var{switch}-@var{options}
13712 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13713 @opindex fdump-lang-all
13714 @opindex fdump-lang
13715 Control the dumping of language-specific information.  The @var{options}
13716 and @var{filename} portions behave as described in the
13717 @option{-fdump-tree} option.  The following @var{switch} values are
13718 accepted:
13720 @table @samp
13721 @item all
13723 Enable all language-specific dumps.
13725 @item class
13726 Dump class hierarchy information.  Virtual table information is emitted
13727 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13729 @item raw
13730 Dump the raw internal tree data.  This option is applicable to C++ only.
13732 @end table
13734 @item -fdump-passes
13735 @opindex fdump-passes
13736 Print on @file{stderr} the list of optimization passes that are turned
13737 on and off by the current command-line options.
13739 @item -fdump-statistics-@var{option}
13740 @opindex fdump-statistics
13741 Enable and control dumping of pass statistics in a separate file.  The
13742 file name is generated by appending a suffix ending in
13743 @samp{.statistics} to the source file name, and the file is created in
13744 the same directory as the output file.  If the @samp{-@var{option}}
13745 form is used, @samp{-stats} causes counters to be summed over the
13746 whole compilation unit while @samp{-details} dumps every event as
13747 the passes generate them.  The default with no option is to sum
13748 counters for each function compiled.
13750 @item -fdump-tree-all
13751 @itemx -fdump-tree-@var{switch}
13752 @itemx -fdump-tree-@var{switch}-@var{options}
13753 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13754 @opindex fdump-tree-all
13755 @opindex fdump-tree
13756 Control the dumping at various stages of processing the intermediate
13757 language tree to a file.  The file name is generated by appending a
13758 switch-specific suffix to the source file name, and the file is
13759 created in the same directory as the output file. In case of
13760 @option{=@var{filename}} option, the dump is output on the given file
13761 instead of the auto named dump files.  If the @samp{-@var{options}}
13762 form is used, @var{options} is a list of @samp{-} separated options
13763 which control the details of the dump.  Not all options are applicable
13764 to all dumps; those that are not meaningful are ignored.  The
13765 following options are available
13767 @table @samp
13768 @item address
13769 Print the address of each node.  Usually this is not meaningful as it
13770 changes according to the environment and source file.  Its primary use
13771 is for tying up a dump file with a debug environment.
13772 @item asmname
13773 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13774 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13775 use working backward from mangled names in the assembly file.
13776 @item slim
13777 When dumping front-end intermediate representations, inhibit dumping
13778 of members of a scope or body of a function merely because that scope
13779 has been reached.  Only dump such items when they are directly reachable
13780 by some other path.
13782 When dumping pretty-printed trees, this option inhibits dumping the
13783 bodies of control structures.
13785 When dumping RTL, print the RTL in slim (condensed) form instead of
13786 the default LISP-like representation.
13787 @item raw
13788 Print a raw representation of the tree.  By default, trees are
13789 pretty-printed into a C-like representation.
13790 @item details
13791 Enable more detailed dumps (not honored by every dump option). Also
13792 include information from the optimization passes.
13793 @item stats
13794 Enable dumping various statistics about the pass (not honored by every dump
13795 option).
13796 @item blocks
13797 Enable showing basic block boundaries (disabled in raw dumps).
13798 @item graph
13799 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13800 dump a representation of the control flow graph suitable for viewing with
13801 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13802 the file is pretty-printed as a subgraph, so that GraphViz can render them
13803 all in a single plot.
13805 This option currently only works for RTL dumps, and the RTL is always
13806 dumped in slim form.
13807 @item vops
13808 Enable showing virtual operands for every statement.
13809 @item lineno
13810 Enable showing line numbers for statements.
13811 @item uid
13812 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13813 @item verbose
13814 Enable showing the tree dump for each statement.
13815 @item eh
13816 Enable showing the EH region number holding each statement.
13817 @item scev
13818 Enable showing scalar evolution analysis details.
13819 @item optimized
13820 Enable showing optimization information (only available in certain
13821 passes).
13822 @item missed
13823 Enable showing missed optimization information (only available in certain
13824 passes).
13825 @item note
13826 Enable other detailed optimization information (only available in
13827 certain passes).
13828 @item =@var{filename}
13829 Instead of an auto named dump file, output into the given file
13830 name. The file names @file{stdout} and @file{stderr} are treated
13831 specially and are considered already open standard streams. For
13832 example,
13834 @smallexample
13835 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13836      -fdump-tree-pre=/dev/stderr file.c
13837 @end smallexample
13839 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13840 output on to @file{stderr}. If two conflicting dump filenames are
13841 given for the same pass, then the latter option overrides the earlier
13842 one.
13844 @item all
13845 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13846 and @option{lineno}.
13848 @item optall
13849 Turn on all optimization options, i.e., @option{optimized},
13850 @option{missed}, and @option{note}.
13851 @end table
13853 To determine what tree dumps are available or find the dump for a pass
13854 of interest follow the steps below.
13856 @enumerate
13857 @item
13858 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13859 look for a code that corresponds to the pass you are interested in.
13860 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13861 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13862 The number at the end distinguishes distinct invocations of the same pass.
13863 @item
13864 To enable the creation of the dump file, append the pass code to
13865 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13866 to enable the dump from the Early Value Range Propagation pass, invoke
13867 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13868 specify the name of the dump file.  If you don't specify one, GCC
13869 creates as described below.
13870 @item
13871 Find the pass dump in a file whose name is composed of three components
13872 separated by a period: the name of the source file GCC was invoked to
13873 compile, a numeric suffix indicating the pass number followed by the
13874 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13875 and finally the pass code.  For example, the Early VRP pass dump might
13876 be in a file named @file{myfile.c.038t.evrp} in the current working
13877 directory.  Note that the numeric codes are not stable and may change
13878 from one version of GCC to another.
13879 @end enumerate
13881 @item -fopt-info
13882 @itemx -fopt-info-@var{options}
13883 @itemx -fopt-info-@var{options}=@var{filename}
13884 @opindex fopt-info
13885 Controls optimization dumps from various optimization passes. If the
13886 @samp{-@var{options}} form is used, @var{options} is a list of
13887 @samp{-} separated option keywords to select the dump details and
13888 optimizations.  
13890 The @var{options} can be divided into two groups: options describing the
13891 verbosity of the dump, and options describing which optimizations
13892 should be included. The options from both the groups can be freely
13893 mixed as they are non-overlapping. However, in case of any conflicts,
13894 the later options override the earlier options on the command
13895 line. 
13897 The following options control the dump verbosity:
13899 @table @samp
13900 @item optimized
13901 Print information when an optimization is successfully applied. It is
13902 up to a pass to decide which information is relevant. For example, the
13903 vectorizer passes print the source location of loops which are
13904 successfully vectorized.
13905 @item missed
13906 Print information about missed optimizations. Individual passes
13907 control which information to include in the output. 
13908 @item note
13909 Print verbose information about optimizations, such as certain
13910 transformations, more detailed messages about decisions etc.
13911 @item all
13912 Print detailed optimization information. This includes
13913 @samp{optimized}, @samp{missed}, and @samp{note}.
13914 @end table
13916 One or more of the following option keywords can be used to describe a
13917 group of optimizations:
13919 @table @samp
13920 @item ipa
13921 Enable dumps from all interprocedural optimizations.
13922 @item loop
13923 Enable dumps from all loop optimizations.
13924 @item inline
13925 Enable dumps from all inlining optimizations.
13926 @item omp
13927 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13928 @item vec
13929 Enable dumps from all vectorization optimizations.
13930 @item optall
13931 Enable dumps from all optimizations. This is a superset of
13932 the optimization groups listed above.
13933 @end table
13935 If @var{options} is
13936 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13937 info about successful optimizations from all the passes.  
13939 If the @var{filename} is provided, then the dumps from all the
13940 applicable optimizations are concatenated into the @var{filename}.
13941 Otherwise the dump is output onto @file{stderr}. Though multiple
13942 @option{-fopt-info} options are accepted, only one of them can include
13943 a @var{filename}. If other filenames are provided then all but the
13944 first such option are ignored.
13946 Note that the output @var{filename} is overwritten
13947 in case of multiple translation units. If a combined output from
13948 multiple translation units is desired, @file{stderr} should be used
13949 instead.
13951 In the following example, the optimization info is output to
13952 @file{stderr}:
13954 @smallexample
13955 gcc -O3 -fopt-info
13956 @end smallexample
13958 This example:
13959 @smallexample
13960 gcc -O3 -fopt-info-missed=missed.all
13961 @end smallexample
13963 @noindent
13964 outputs missed optimization report from all the passes into
13965 @file{missed.all}, and this one:
13967 @smallexample
13968 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13969 @end smallexample
13971 @noindent
13972 prints information about missed optimization opportunities from
13973 vectorization passes on @file{stderr}.  
13974 Note that @option{-fopt-info-vec-missed} is equivalent to 
13975 @option{-fopt-info-missed-vec}.  The order of the optimization group
13976 names and message types listed after @option{-fopt-info} does not matter.
13978 As another example,
13979 @smallexample
13980 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13981 @end smallexample
13983 @noindent
13984 outputs information about missed optimizations as well as
13985 optimized locations from all the inlining passes into
13986 @file{inline.txt}.
13988 Finally, consider:
13990 @smallexample
13991 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13992 @end smallexample
13994 @noindent
13995 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13996 in conflict since only one output file is allowed. In this case, only
13997 the first option takes effect and the subsequent options are
13998 ignored. Thus only @file{vec.miss} is produced which contains
13999 dumps from the vectorizer about missed opportunities.
14001 @item -fsched-verbose=@var{n}
14002 @opindex fsched-verbose
14003 On targets that use instruction scheduling, this option controls the
14004 amount of debugging output the scheduler prints to the dump files.
14006 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
14007 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
14008 For @var{n} greater than one, it also output basic block probabilities,
14009 detailed ready list information and unit/insn info.  For @var{n} greater
14010 than two, it includes RTL at abort point, control-flow and regions info.
14011 And for @var{n} over four, @option{-fsched-verbose} also includes
14012 dependence info.
14016 @item -fenable-@var{kind}-@var{pass}
14017 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
14018 @opindex fdisable-
14019 @opindex fenable-
14021 This is a set of options that are used to explicitly disable/enable
14022 optimization passes.  These options are intended for use for debugging GCC.
14023 Compiler users should use regular options for enabling/disabling
14024 passes instead.
14026 @table @gcctabopt
14028 @item -fdisable-ipa-@var{pass}
14029 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
14030 statically invoked in the compiler multiple times, the pass name should be
14031 appended with a sequential number starting from 1.
14033 @item -fdisable-rtl-@var{pass}
14034 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
14035 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14036 statically invoked in the compiler multiple times, the pass name should be
14037 appended with a sequential number starting from 1.  @var{range-list} is a 
14038 comma-separated list of function ranges or assembler names.  Each range is a number
14039 pair separated by a colon.  The range is inclusive in both ends.  If the range
14040 is trivial, the number pair can be simplified as a single number.  If the
14041 function's call graph node's @var{uid} falls within one of the specified ranges,
14042 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
14043 function header of a dump file, and the pass names can be dumped by using
14044 option @option{-fdump-passes}.
14046 @item -fdisable-tree-@var{pass}
14047 @itemx -fdisable-tree-@var{pass}=@var{range-list}
14048 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
14049 option arguments.
14051 @item -fenable-ipa-@var{pass}
14052 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14053 statically invoked in the compiler multiple times, the pass name should be
14054 appended with a sequential number starting from 1.
14056 @item -fenable-rtl-@var{pass}
14057 @itemx -fenable-rtl-@var{pass}=@var{range-list}
14058 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
14059 description and examples.
14061 @item -fenable-tree-@var{pass}
14062 @itemx -fenable-tree-@var{pass}=@var{range-list}
14063 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
14064 of option arguments.
14066 @end table
14068 Here are some examples showing uses of these options.
14070 @smallexample
14072 # disable ccp1 for all functions
14073    -fdisable-tree-ccp1
14074 # disable complete unroll for function whose cgraph node uid is 1
14075    -fenable-tree-cunroll=1
14076 # disable gcse2 for functions at the following ranges [1,1],
14077 # [300,400], and [400,1000]
14078 # disable gcse2 for functions foo and foo2
14079    -fdisable-rtl-gcse2=foo,foo2
14080 # disable early inlining
14081    -fdisable-tree-einline
14082 # disable ipa inlining
14083    -fdisable-ipa-inline
14084 # enable tree full unroll
14085    -fenable-tree-unroll
14087 @end smallexample
14089 @item -fchecking
14090 @itemx -fchecking=@var{n}
14091 @opindex fchecking
14092 @opindex fno-checking
14093 Enable internal consistency checking.  The default depends on
14094 the compiler configuration.  @option{-fchecking=2} enables further
14095 internal consistency checking that might affect code generation.
14097 @item -frandom-seed=@var{string}
14098 @opindex frandom-seed
14099 This option provides a seed that GCC uses in place of
14100 random numbers in generating certain symbol names
14101 that have to be different in every compiled file.  It is also used to
14102 place unique stamps in coverage data files and the object files that
14103 produce them.  You can use the @option{-frandom-seed} option to produce
14104 reproducibly identical object files.
14106 The @var{string} can either be a number (decimal, octal or hex) or an
14107 arbitrary string (in which case it's converted to a number by
14108 computing CRC32).
14110 The @var{string} should be different for every file you compile.
14112 @item -save-temps
14113 @itemx -save-temps=cwd
14114 @opindex save-temps
14115 Store the usual ``temporary'' intermediate files permanently; place them
14116 in the current directory and name them based on the source file.  Thus,
14117 compiling @file{foo.c} with @option{-c -save-temps} produces files
14118 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
14119 preprocessed @file{foo.i} output file even though the compiler now
14120 normally uses an integrated preprocessor.
14122 When used in combination with the @option{-x} command-line option,
14123 @option{-save-temps} is sensible enough to avoid over writing an
14124 input source file with the same extension as an intermediate file.
14125 The corresponding intermediate file may be obtained by renaming the
14126 source file before using @option{-save-temps}.
14128 If you invoke GCC in parallel, compiling several different source
14129 files that share a common base name in different subdirectories or the
14130 same source file compiled for multiple output destinations, it is
14131 likely that the different parallel compilers will interfere with each
14132 other, and overwrite the temporary files.  For instance:
14134 @smallexample
14135 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
14136 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
14137 @end smallexample
14139 may result in @file{foo.i} and @file{foo.o} being written to
14140 simultaneously by both compilers.
14142 @item -save-temps=obj
14143 @opindex save-temps=obj
14144 Store the usual ``temporary'' intermediate files permanently.  If the
14145 @option{-o} option is used, the temporary files are based on the
14146 object file.  If the @option{-o} option is not used, the
14147 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
14149 For example:
14151 @smallexample
14152 gcc -save-temps=obj -c foo.c
14153 gcc -save-temps=obj -c bar.c -o dir/xbar.o
14154 gcc -save-temps=obj foobar.c -o dir2/yfoobar
14155 @end smallexample
14157 @noindent
14158 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
14159 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
14160 @file{dir2/yfoobar.o}.
14162 @item -time@r{[}=@var{file}@r{]}
14163 @opindex time
14164 Report the CPU time taken by each subprocess in the compilation
14165 sequence.  For C source files, this is the compiler proper and assembler
14166 (plus the linker if linking is done).
14168 Without the specification of an output file, the output looks like this:
14170 @smallexample
14171 # cc1 0.12 0.01
14172 # as 0.00 0.01
14173 @end smallexample
14175 The first number on each line is the ``user time'', that is time spent
14176 executing the program itself.  The second number is ``system time'',
14177 time spent executing operating system routines on behalf of the program.
14178 Both numbers are in seconds.
14180 With the specification of an output file, the output is appended to the
14181 named file, and it looks like this:
14183 @smallexample
14184 0.12 0.01 cc1 @var{options}
14185 0.00 0.01 as @var{options}
14186 @end smallexample
14188 The ``user time'' and the ``system time'' are moved before the program
14189 name, and the options passed to the program are displayed, so that one
14190 can later tell what file was being compiled, and with which options.
14192 @item -fdump-final-insns@r{[}=@var{file}@r{]}
14193 @opindex fdump-final-insns
14194 Dump the final internal representation (RTL) to @var{file}.  If the
14195 optional argument is omitted (or if @var{file} is @code{.}), the name
14196 of the dump file is determined by appending @code{.gkd} to the
14197 compilation output file name.
14199 @item -fcompare-debug@r{[}=@var{opts}@r{]}
14200 @opindex fcompare-debug
14201 @opindex fno-compare-debug
14202 If no error occurs during compilation, run the compiler a second time,
14203 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14204 passed to the second compilation.  Dump the final internal
14205 representation in both compilations, and print an error if they differ.
14207 If the equal sign is omitted, the default @option{-gtoggle} is used.
14209 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14210 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14211 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14212 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14213 is used.
14215 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14216 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14217 of the final representation and the second compilation, preventing even
14218 @env{GCC_COMPARE_DEBUG} from taking effect.
14220 To verify full coverage during @option{-fcompare-debug} testing, set
14221 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14222 which GCC rejects as an invalid option in any actual compilation
14223 (rather than preprocessing, assembly or linking).  To get just a
14224 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14225 not overridden} will do.
14227 @item -fcompare-debug-second
14228 @opindex fcompare-debug-second
14229 This option is implicitly passed to the compiler for the second
14230 compilation requested by @option{-fcompare-debug}, along with options to
14231 silence warnings, and omitting other options that would cause
14232 side-effect compiler outputs to files or to the standard output.  Dump
14233 files and preserved temporary files are renamed so as to contain the
14234 @code{.gk} additional extension during the second compilation, to avoid
14235 overwriting those generated by the first.
14237 When this option is passed to the compiler driver, it causes the
14238 @emph{first} compilation to be skipped, which makes it useful for little
14239 other than debugging the compiler proper.
14241 @item -gtoggle
14242 @opindex gtoggle
14243 Turn off generation of debug info, if leaving out this option
14244 generates it, or turn it on at level 2 otherwise.  The position of this
14245 argument in the command line does not matter; it takes effect after all
14246 other options are processed, and it does so only once, no matter how
14247 many times it is given.  This is mainly intended to be used with
14248 @option{-fcompare-debug}.
14250 @item -fvar-tracking-assignments-toggle
14251 @opindex fvar-tracking-assignments-toggle
14252 @opindex fno-var-tracking-assignments-toggle
14253 Toggle @option{-fvar-tracking-assignments}, in the same way that
14254 @option{-gtoggle} toggles @option{-g}.
14256 @item -Q
14257 @opindex Q
14258 Makes the compiler print out each function name as it is compiled, and
14259 print some statistics about each pass when it finishes.
14261 @item -ftime-report
14262 @opindex ftime-report
14263 Makes the compiler print some statistics about the time consumed by each
14264 pass when it finishes.
14266 @item -ftime-report-details
14267 @opindex ftime-report-details
14268 Record the time consumed by infrastructure parts separately for each pass.
14270 @item -fira-verbose=@var{n}
14271 @opindex fira-verbose
14272 Control the verbosity of the dump file for the integrated register allocator.
14273 The default value is 5.  If the value @var{n} is greater or equal to 10,
14274 the dump output is sent to stderr using the same format as @var{n} minus 10.
14276 @item -flto-report
14277 @opindex flto-report
14278 Prints a report with internal details on the workings of the link-time
14279 optimizer.  The contents of this report vary from version to version.
14280 It is meant to be useful to GCC developers when processing object
14281 files in LTO mode (via @option{-flto}).
14283 Disabled by default.
14285 @item -flto-report-wpa
14286 @opindex flto-report-wpa
14287 Like @option{-flto-report}, but only print for the WPA phase of Link
14288 Time Optimization.
14290 @item -fmem-report
14291 @opindex fmem-report
14292 Makes the compiler print some statistics about permanent memory
14293 allocation when it finishes.
14295 @item -fmem-report-wpa
14296 @opindex fmem-report-wpa
14297 Makes the compiler print some statistics about permanent memory
14298 allocation for the WPA phase only.
14300 @item -fpre-ipa-mem-report
14301 @opindex fpre-ipa-mem-report
14302 @item -fpost-ipa-mem-report
14303 @opindex fpost-ipa-mem-report
14304 Makes the compiler print some statistics about permanent memory
14305 allocation before or after interprocedural optimization.
14307 @item -fprofile-report
14308 @opindex fprofile-report
14309 Makes the compiler print some statistics about consistency of the
14310 (estimated) profile and effect of individual passes.
14312 @item -fstack-usage
14313 @opindex fstack-usage
14314 Makes the compiler output stack usage information for the program, on a
14315 per-function basis.  The filename for the dump is made by appending
14316 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14317 the output file, if explicitly specified and it is not an executable,
14318 otherwise it is the basename of the source file.  An entry is made up
14319 of three fields:
14321 @itemize
14322 @item
14323 The name of the function.
14324 @item
14325 A number of bytes.
14326 @item
14327 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14328 @end itemize
14330 The qualifier @code{static} means that the function manipulates the stack
14331 statically: a fixed number of bytes are allocated for the frame on function
14332 entry and released on function exit; no stack adjustments are otherwise made
14333 in the function.  The second field is this fixed number of bytes.
14335 The qualifier @code{dynamic} means that the function manipulates the stack
14336 dynamically: in addition to the static allocation described above, stack
14337 adjustments are made in the body of the function, for example to push/pop
14338 arguments around function calls.  If the qualifier @code{bounded} is also
14339 present, the amount of these adjustments is bounded at compile time and
14340 the second field is an upper bound of the total amount of stack used by
14341 the function.  If it is not present, the amount of these adjustments is
14342 not bounded at compile time and the second field only represents the
14343 bounded part.
14345 @item -fstats
14346 @opindex fstats
14347 Emit statistics about front-end processing at the end of the compilation.
14348 This option is supported only by the C++ front end, and
14349 the information is generally only useful to the G++ development team.
14351 @item -fdbg-cnt-list
14352 @opindex fdbg-cnt-list
14353 Print the name and the counter upper bound for all debug counters.
14356 @item -fdbg-cnt=@var{counter-value-list}
14357 @opindex fdbg-cnt
14358 Set the internal debug counter upper bound.  @var{counter-value-list}
14359 is a comma-separated list of @var{name}:@var{value} pairs
14360 which sets the upper bound of each debug counter @var{name} to @var{value}.
14361 All debug counters have the initial upper bound of @code{UINT_MAX};
14362 thus @code{dbg_cnt} returns true always unless the upper bound
14363 is set by this option.
14364 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
14365 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
14367 @item -print-file-name=@var{library}
14368 @opindex print-file-name
14369 Print the full absolute name of the library file @var{library} that
14370 would be used when linking---and don't do anything else.  With this
14371 option, GCC does not compile or link anything; it just prints the
14372 file name.
14374 @item -print-multi-directory
14375 @opindex print-multi-directory
14376 Print the directory name corresponding to the multilib selected by any
14377 other switches present in the command line.  This directory is supposed
14378 to exist in @env{GCC_EXEC_PREFIX}.
14380 @item -print-multi-lib
14381 @opindex print-multi-lib
14382 Print the mapping from multilib directory names to compiler switches
14383 that enable them.  The directory name is separated from the switches by
14384 @samp{;}, and each switch starts with an @samp{@@} instead of the
14385 @samp{-}, without spaces between multiple switches.  This is supposed to
14386 ease shell processing.
14388 @item -print-multi-os-directory
14389 @opindex print-multi-os-directory
14390 Print the path to OS libraries for the selected
14391 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14392 present in the @file{lib} subdirectory and no multilibs are used, this is
14393 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14394 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14395 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14396 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14398 @item -print-multiarch
14399 @opindex print-multiarch
14400 Print the path to OS libraries for the selected multiarch,
14401 relative to some @file{lib} subdirectory.
14403 @item -print-prog-name=@var{program}
14404 @opindex print-prog-name
14405 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14407 @item -print-libgcc-file-name
14408 @opindex print-libgcc-file-name
14409 Same as @option{-print-file-name=libgcc.a}.
14411 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14412 but you do want to link with @file{libgcc.a}.  You can do:
14414 @smallexample
14415 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14416 @end smallexample
14418 @item -print-search-dirs
14419 @opindex print-search-dirs
14420 Print the name of the configured installation directory and a list of
14421 program and library directories @command{gcc} searches---and don't do anything else.
14423 This is useful when @command{gcc} prints the error message
14424 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14425 To resolve this you either need to put @file{cpp0} and the other compiler
14426 components where @command{gcc} expects to find them, or you can set the environment
14427 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14428 Don't forget the trailing @samp{/}.
14429 @xref{Environment Variables}.
14431 @item -print-sysroot
14432 @opindex print-sysroot
14433 Print the target sysroot directory that is used during
14434 compilation.  This is the target sysroot specified either at configure
14435 time or using the @option{--sysroot} option, possibly with an extra
14436 suffix that depends on compilation options.  If no target sysroot is
14437 specified, the option prints nothing.
14439 @item -print-sysroot-headers-suffix
14440 @opindex print-sysroot-headers-suffix
14441 Print the suffix added to the target sysroot when searching for
14442 headers, or give an error if the compiler is not configured with such
14443 a suffix---and don't do anything else.
14445 @item -dumpmachine
14446 @opindex dumpmachine
14447 Print the compiler's target machine (for example,
14448 @samp{i686-pc-linux-gnu})---and don't do anything else.
14450 @item -dumpversion
14451 @opindex dumpversion
14452 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14453 anything else.  This is the compiler version used in filesystem paths,
14454 specs, can be depending on how the compiler has been configured just
14455 a single number (major version), two numbers separated by dot (major and
14456 minor version) or three numbers separated by dots (major, minor and patchlevel
14457 version).
14459 @item -dumpfullversion
14460 @opindex dumpfullversion
14461 Print the full compiler version, always 3 numbers separated by dots,
14462 major, minor and patchlevel version.
14464 @item -dumpspecs
14465 @opindex dumpspecs
14466 Print the compiler's built-in specs---and don't do anything else.  (This
14467 is used when GCC itself is being built.)  @xref{Spec Files}.
14468 @end table
14470 @node Submodel Options
14471 @section Machine-Dependent Options
14472 @cindex submodel options
14473 @cindex specifying hardware config
14474 @cindex hardware models and configurations, specifying
14475 @cindex target-dependent options
14476 @cindex machine-dependent options
14478 Each target machine supported by GCC can have its own options---for
14479 example, to allow you to compile for a particular processor variant or
14480 ABI, or to control optimizations specific to that machine.  By
14481 convention, the names of machine-specific options start with
14482 @samp{-m}.
14484 Some configurations of the compiler also support additional target-specific
14485 options, usually for compatibility with other compilers on the same
14486 platform.
14488 @c This list is ordered alphanumerically by subsection name.
14489 @c It should be the same order and spelling as these options are listed
14490 @c in Machine Dependent Options
14492 @menu
14493 * AArch64 Options::
14494 * Adapteva Epiphany Options::
14495 * ARC Options::
14496 * ARM Options::
14497 * AVR Options::
14498 * Blackfin Options::
14499 * C6X Options::
14500 * CRIS Options::
14501 * CR16 Options::
14502 * Darwin Options::
14503 * DEC Alpha Options::
14504 * FR30 Options::
14505 * FT32 Options::
14506 * FRV Options::
14507 * GNU/Linux Options::
14508 * H8/300 Options::
14509 * HPPA Options::
14510 * IA-64 Options::
14511 * LM32 Options::
14512 * M32C Options::
14513 * M32R/D Options::
14514 * M680x0 Options::
14515 * MCore Options::
14516 * MeP Options::
14517 * MicroBlaze Options::
14518 * MIPS Options::
14519 * MMIX Options::
14520 * MN10300 Options::
14521 * Moxie Options::
14522 * MSP430 Options::
14523 * NDS32 Options::
14524 * Nios II Options::
14525 * Nvidia PTX Options::
14526 * PDP-11 Options::
14527 * picoChip Options::
14528 * PowerPC Options::
14529 * PowerPC SPE Options::
14530 * RISC-V Options::
14531 * RL78 Options::
14532 * RS/6000 and PowerPC Options::
14533 * RX Options::
14534 * S/390 and zSeries Options::
14535 * Score Options::
14536 * SH Options::
14537 * Solaris 2 Options::
14538 * SPARC Options::
14539 * SPU Options::
14540 * System V Options::
14541 * TILE-Gx Options::
14542 * TILEPro Options::
14543 * V850 Options::
14544 * VAX Options::
14545 * Visium Options::
14546 * VMS Options::
14547 * VxWorks Options::
14548 * x86 Options::
14549 * x86 Windows Options::
14550 * Xstormy16 Options::
14551 * Xtensa Options::
14552 * zSeries Options::
14553 @end menu
14555 @node AArch64 Options
14556 @subsection AArch64 Options
14557 @cindex AArch64 Options
14559 These options are defined for AArch64 implementations:
14561 @table @gcctabopt
14563 @item -mabi=@var{name}
14564 @opindex mabi
14565 Generate code for the specified data model.  Permissible values
14566 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14567 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14568 but long int and pointers are 64 bits.
14570 The default depends on the specific target configuration.  Note that
14571 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14572 entire program with the same ABI, and link with a compatible set of libraries.
14574 @item -mbig-endian
14575 @opindex mbig-endian
14576 Generate big-endian code.  This is the default when GCC is configured for an
14577 @samp{aarch64_be-*-*} target.
14579 @item -mgeneral-regs-only
14580 @opindex mgeneral-regs-only
14581 Generate code which uses only the general-purpose registers.  This will prevent
14582 the compiler from using floating-point and Advanced SIMD registers but will not
14583 impose any restrictions on the assembler.
14585 @item -mlittle-endian
14586 @opindex mlittle-endian
14587 Generate little-endian code.  This is the default when GCC is configured for an
14588 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14590 @item -mcmodel=tiny
14591 @opindex mcmodel=tiny
14592 Generate code for the tiny code model.  The program and its statically defined
14593 symbols must be within 1MB of each other.  Programs can be statically or
14594 dynamically linked.
14596 @item -mcmodel=small
14597 @opindex mcmodel=small
14598 Generate code for the small code model.  The program and its statically defined
14599 symbols must be within 4GB of each other.  Programs can be statically or
14600 dynamically linked.  This is the default code model.
14602 @item -mcmodel=large
14603 @opindex mcmodel=large
14604 Generate code for the large code model.  This makes no assumptions about
14605 addresses and sizes of sections.  Programs can be statically linked only.
14607 @item -mstrict-align
14608 @opindex mstrict-align
14609 Avoid generating memory accesses that may not be aligned on a natural object
14610 boundary as described in the architecture specification.
14612 @item -momit-leaf-frame-pointer
14613 @itemx -mno-omit-leaf-frame-pointer
14614 @opindex momit-leaf-frame-pointer
14615 @opindex mno-omit-leaf-frame-pointer
14616 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14617 default.
14619 @item -mtls-dialect=desc
14620 @opindex mtls-dialect=desc
14621 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14622 of TLS variables.  This is the default.
14624 @item -mtls-dialect=traditional
14625 @opindex mtls-dialect=traditional
14626 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14627 of TLS variables.
14629 @item -mtls-size=@var{size}
14630 @opindex mtls-size
14631 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14632 This option requires binutils 2.26 or newer.
14634 @item -mfix-cortex-a53-835769
14635 @itemx -mno-fix-cortex-a53-835769
14636 @opindex mfix-cortex-a53-835769
14637 @opindex mno-fix-cortex-a53-835769
14638 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14639 This involves inserting a NOP instruction between memory instructions and
14640 64-bit integer multiply-accumulate instructions.
14642 @item -mfix-cortex-a53-843419
14643 @itemx -mno-fix-cortex-a53-843419
14644 @opindex mfix-cortex-a53-843419
14645 @opindex mno-fix-cortex-a53-843419
14646 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14647 This erratum workaround is made at link time and this will only pass the
14648 corresponding flag to the linker.
14650 @item -mlow-precision-recip-sqrt
14651 @itemx -mno-low-precision-recip-sqrt
14652 @opindex mlow-precision-recip-sqrt
14653 @opindex mno-low-precision-recip-sqrt
14654 Enable or disable the reciprocal square root approximation.
14655 This option only has an effect if @option{-ffast-math} or
14656 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14657 precision of reciprocal square root results to about 16 bits for
14658 single precision and to 32 bits for double precision.
14660 @item -mlow-precision-sqrt
14661 @itemx -mno-low-precision-sqrt
14662 @opindex -mlow-precision-sqrt
14663 @opindex -mno-low-precision-sqrt
14664 Enable or disable the square root approximation.
14665 This option only has an effect if @option{-ffast-math} or
14666 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14667 precision of square root results to about 16 bits for
14668 single precision and to 32 bits for double precision.
14669 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14671 @item -mlow-precision-div
14672 @itemx -mno-low-precision-div
14673 @opindex -mlow-precision-div
14674 @opindex -mno-low-precision-div
14675 Enable or disable the division approximation.
14676 This option only has an effect if @option{-ffast-math} or
14677 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14678 precision of division results to about 16 bits for
14679 single precision and to 32 bits for double precision.
14681 @item -march=@var{name}
14682 @opindex march
14683 Specify the name of the target architecture and, optionally, one or
14684 more feature modifiers.  This option has the form
14685 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14687 The permissible values for @var{arch} are @samp{armv8-a},
14688 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @samp{armv8.4-a}
14689 or @var{native}.
14691 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
14692 support for the ARMv8.4-A architecture extensions.
14694 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14695 support for the ARMv8.3-A architecture extensions.
14697 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14698 support for the ARMv8.2-A architecture extensions.
14700 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14701 support for the ARMv8.1-A architecture extension.  In particular, it
14702 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14704 The value @samp{native} is available on native AArch64 GNU/Linux and
14705 causes the compiler to pick the architecture of the host system.  This
14706 option has no effect if the compiler is unable to recognize the
14707 architecture of the host system,
14709 The permissible values for @var{feature} are listed in the sub-section
14710 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14711 Feature Modifiers}.  Where conflicting feature modifiers are
14712 specified, the right-most feature is used.
14714 GCC uses @var{name} to determine what kind of instructions it can emit
14715 when generating assembly code.  If @option{-march} is specified
14716 without either of @option{-mtune} or @option{-mcpu} also being
14717 specified, the code is tuned to perform well across a range of target
14718 processors implementing the target architecture.
14720 @item -mtune=@var{name}
14721 @opindex mtune
14722 Specify the name of the target processor for which GCC should tune the
14723 performance of the code.  Permissible values for this option are:
14724 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14725 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14726 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14727 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14728 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14729 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14730 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14731 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14732 @samp{native}.
14734 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14735 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14736 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14737 big.LITTLE system.
14739 Additionally on native AArch64 GNU/Linux systems the value
14740 @samp{native} tunes performance to the host system.  This option has no effect
14741 if the compiler is unable to recognize the processor of the host system.
14743 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14744 are specified, the code is tuned to perform well across a range
14745 of target processors.
14747 This option cannot be suffixed by feature modifiers.
14749 @item -mcpu=@var{name}
14750 @opindex mcpu
14751 Specify the name of the target processor, optionally suffixed by one
14752 or more feature modifiers.  This option has the form
14753 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14754 the permissible values for @var{cpu} are the same as those available
14755 for @option{-mtune}.  The permissible values for @var{feature} are
14756 documented in the sub-section on
14757 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14758 Feature Modifiers}.  Where conflicting feature modifiers are
14759 specified, the right-most feature is used.
14761 GCC uses @var{name} to determine what kind of instructions it can emit when
14762 generating assembly code (as if by @option{-march}) and to determine
14763 the target processor for which to tune for performance (as if
14764 by @option{-mtune}).  Where this option is used in conjunction
14765 with @option{-march} or @option{-mtune}, those options take precedence
14766 over the appropriate part of this option.
14768 @item -moverride=@var{string}
14769 @opindex moverride
14770 Override tuning decisions made by the back-end in response to a
14771 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14772 for @var{string} in this option are not guaranteed to be consistent
14773 across releases.
14775 This option is only intended to be useful when developing GCC.
14777 @item -mverbose-cost-dump
14778 @opindex mverbose-cost-dump
14779 Enable verbose cost model dumping in the debug dump files.  This option is
14780 provided for use in debugging the compiler.
14782 @item -mpc-relative-literal-loads
14783 @itemx -mno-pc-relative-literal-loads
14784 @opindex mpc-relative-literal-loads
14785 @opindex mno-pc-relative-literal-loads
14786 Enable or disable PC-relative literal loads.  With this option literal pools are
14787 accessed using a single instruction and emitted after each function.  This
14788 limits the maximum size of functions to 1MB.  This is enabled by default for
14789 @option{-mcmodel=tiny}.
14791 @item -msign-return-address=@var{scope}
14792 @opindex msign-return-address
14793 Select the function scope on which return address signing will be applied.
14794 Permissible values are @samp{none}, which disables return address signing,
14795 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14796 functions, and @samp{all}, which enables pointer signing for all functions.  The
14797 default value is @samp{none}.
14799 @item -msve-vector-bits=@var{bits}
14800 @opindex msve-vector-bits
14801 Specify the number of bits in an SVE vector register.  This option only has
14802 an effect when SVE is enabled.
14804 GCC supports two forms of SVE code generation: ``vector-length
14805 agnostic'' output that works with any size of vector register and
14806 ``vector-length specific'' output that only works when the vector
14807 registers are a particular size.  Replacing @var{bits} with
14808 @samp{scalable} selects vector-length agnostic output while
14809 replacing it with a number selects vector-length specific output.
14810 The possible lengths in the latter case are: 128, 256, 512, 1024
14811 and 2048.  @samp{scalable} is the default.
14813 At present, @samp{-msve-vector-bits=128} produces the same output
14814 as @samp{-msve-vector-bits=scalable}.
14816 @end table
14818 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14819 @anchor{aarch64-feature-modifiers}
14820 @cindex @option{-march} feature modifiers
14821 @cindex @option{-mcpu} feature modifiers
14822 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14823 the following and their inverses @option{no@var{feature}}:
14825 @table @samp
14826 @item crc
14827 Enable CRC extension.  This is on by default for
14828 @option{-march=armv8.1-a}.
14829 @item crypto
14830 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14831 instructions.
14832 @item fp
14833 Enable floating-point instructions.  This is on by default for all possible
14834 values for options @option{-march} and @option{-mcpu}.
14835 @item simd
14836 Enable Advanced SIMD instructions.  This also enables floating-point
14837 instructions.  This is on by default for all possible values for options
14838 @option{-march} and @option{-mcpu}.
14839 @item sve
14840 Enable Scalable Vector Extension instructions.  This also enables Advanced
14841 SIMD and floating-point instructions.
14842 @item lse
14843 Enable Large System Extension instructions.  This is on by default for
14844 @option{-march=armv8.1-a}.
14845 @item rdma
14846 Enable Round Double Multiply Accumulate instructions.  This is on by default
14847 for @option{-march=armv8.1-a}.
14848 @item fp16
14849 Enable FP16 extension.  This also enables floating-point instructions.
14850 @item fp16fml
14851 Enable FP16 fmla extension.  This also enables FP16 extensions and
14852 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.
14854 @item rcpc
14855 Enable the RcPc extension.  This does not change code generation from GCC,
14856 but is passed on to the assembler, enabling inline asm statements to use
14857 instructions from the RcPc extension.
14858 @item dotprod
14859 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14860 @item aes
14861 Enable the Armv8-a aes and pmull crypto extension.  This also enables Advanced
14862 SIMD instructions.
14863 @item sha2
14864 Enable the Armv8-a sha2 crypto extension.  This also enables Advanced SIMD instructions.
14865 @item sha3
14866 Enable the sha512 and sha3 crypto extension.  This also enables Advanced SIMD
14867 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
14868 @item sm4
14869 Enable the sm3 and sm4 crypto extension.  This also enables Advanced SIMD instructions.
14870 Use of this option with architectures prior to Armv8.2-A is not supported.
14872 @end table
14874 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
14875 which implies @option{fp}.
14876 Conversely, @option{nofp} implies @option{nosimd}, which implies
14877 @option{nocrypto}, @option{noaes} and @option{nosha2}.
14879 @node Adapteva Epiphany Options
14880 @subsection Adapteva Epiphany Options
14882 These @samp{-m} options are defined for Adapteva Epiphany:
14884 @table @gcctabopt
14885 @item -mhalf-reg-file
14886 @opindex mhalf-reg-file
14887 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14888 That allows code to run on hardware variants that lack these registers.
14890 @item -mprefer-short-insn-regs
14891 @opindex mprefer-short-insn-regs
14892 Preferentially allocate registers that allow short instruction generation.
14893 This can result in increased instruction count, so this may either reduce or
14894 increase overall code size.
14896 @item -mbranch-cost=@var{num}
14897 @opindex mbranch-cost
14898 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14899 This cost is only a heuristic and is not guaranteed to produce
14900 consistent results across releases.
14902 @item -mcmove
14903 @opindex mcmove
14904 Enable the generation of conditional moves.
14906 @item -mnops=@var{num}
14907 @opindex mnops
14908 Emit @var{num} NOPs before every other generated instruction.
14910 @item -mno-soft-cmpsf
14911 @opindex mno-soft-cmpsf
14912 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14913 and test the flags.  This is faster than a software comparison, but can
14914 get incorrect results in the presence of NaNs, or when two different small
14915 numbers are compared such that their difference is calculated as zero.
14916 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14917 software comparisons.
14919 @item -mstack-offset=@var{num}
14920 @opindex mstack-offset
14921 Set the offset between the top of the stack and the stack pointer.
14922 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14923 can be used by leaf functions without stack allocation.
14924 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14925 Note also that this option changes the ABI; compiling a program with a
14926 different stack offset than the libraries have been compiled with
14927 generally does not work.
14928 This option can be useful if you want to evaluate if a different stack
14929 offset would give you better code, but to actually use a different stack
14930 offset to build working programs, it is recommended to configure the
14931 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14933 @item -mno-round-nearest
14934 @opindex mno-round-nearest
14935 Make the scheduler assume that the rounding mode has been set to
14936 truncating.  The default is @option{-mround-nearest}.
14938 @item -mlong-calls
14939 @opindex mlong-calls
14940 If not otherwise specified by an attribute, assume all calls might be beyond
14941 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14942 function address into a register before performing a (otherwise direct) call.
14943 This is the default.
14945 @item -mshort-calls
14946 @opindex short-calls
14947 If not otherwise specified by an attribute, assume all direct calls are
14948 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14949 for direct calls.  The default is @option{-mlong-calls}.
14951 @item -msmall16
14952 @opindex msmall16
14953 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14954 apply to function addresses for which @option{-mlong-calls} semantics
14955 are in effect.
14957 @item -mfp-mode=@var{mode}
14958 @opindex mfp-mode
14959 Set the prevailing mode of the floating-point unit.
14960 This determines the floating-point mode that is provided and expected
14961 at function call and return time.  Making this mode match the mode you
14962 predominantly need at function start can make your programs smaller and
14963 faster by avoiding unnecessary mode switches.
14965 @var{mode} can be set to one the following values:
14967 @table @samp
14968 @item caller
14969 Any mode at function entry is valid, and retained or restored when
14970 the function returns, and when it calls other functions.
14971 This mode is useful for compiling libraries or other compilation units
14972 you might want to incorporate into different programs with different
14973 prevailing FPU modes, and the convenience of being able to use a single
14974 object file outweighs the size and speed overhead for any extra
14975 mode switching that might be needed, compared with what would be needed
14976 with a more specific choice of prevailing FPU mode.
14978 @item truncate
14979 This is the mode used for floating-point calculations with
14980 truncating (i.e.@: round towards zero) rounding mode.  That includes
14981 conversion from floating point to integer.
14983 @item round-nearest
14984 This is the mode used for floating-point calculations with
14985 round-to-nearest-or-even rounding mode.
14987 @item int
14988 This is the mode used to perform integer calculations in the FPU, e.g.@:
14989 integer multiply, or integer multiply-and-accumulate.
14990 @end table
14992 The default is @option{-mfp-mode=caller}
14994 @item -mnosplit-lohi
14995 @itemx -mno-postinc
14996 @itemx -mno-postmodify
14997 @opindex mnosplit-lohi
14998 @opindex mno-postinc
14999 @opindex mno-postmodify
15000 Code generation tweaks that disable, respectively, splitting of 32-bit
15001 loads, generation of post-increment addresses, and generation of
15002 post-modify addresses.  The defaults are @option{msplit-lohi},
15003 @option{-mpost-inc}, and @option{-mpost-modify}.
15005 @item -mnovect-double
15006 @opindex mno-vect-double
15007 Change the preferred SIMD mode to SImode.  The default is
15008 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
15010 @item -max-vect-align=@var{num}
15011 @opindex max-vect-align
15012 The maximum alignment for SIMD vector mode types.
15013 @var{num} may be 4 or 8.  The default is 8.
15014 Note that this is an ABI change, even though many library function
15015 interfaces are unaffected if they don't use SIMD vector modes
15016 in places that affect size and/or alignment of relevant types.
15018 @item -msplit-vecmove-early
15019 @opindex msplit-vecmove-early
15020 Split vector moves into single word moves before reload.  In theory this
15021 can give better register allocation, but so far the reverse seems to be
15022 generally the case.
15024 @item -m1reg-@var{reg}
15025 @opindex m1reg-
15026 Specify a register to hold the constant @minus{}1, which makes loading small negative
15027 constants and certain bitmasks faster.
15028 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
15029 which specify use of that register as a fixed register,
15030 and @samp{none}, which means that no register is used for this
15031 purpose.  The default is @option{-m1reg-none}.
15033 @end table
15035 @node ARC Options
15036 @subsection ARC Options
15037 @cindex ARC options
15039 The following options control the architecture variant for which code
15040 is being compiled:
15042 @c architecture variants
15043 @table @gcctabopt
15045 @item -mbarrel-shifter
15046 @opindex mbarrel-shifter
15047 Generate instructions supported by barrel shifter.  This is the default
15048 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
15050 @item -mjli-always
15051 @opindex mjli-alawys
15052 Force to call a function using jli_s instruction.  This option is
15053 valid only for ARCv2 architecture.
15055 @item -mcpu=@var{cpu}
15056 @opindex mcpu
15057 Set architecture type, register usage, and instruction scheduling
15058 parameters for @var{cpu}.  There are also shortcut alias options
15059 available for backward compatibility and convenience.  Supported
15060 values for @var{cpu} are
15062 @table @samp
15063 @opindex mA6
15064 @opindex mARC600
15065 @item arc600
15066 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
15068 @item arc601
15069 @opindex mARC601
15070 Compile for ARC601.  Alias: @option{-mARC601}.
15072 @item arc700
15073 @opindex mA7
15074 @opindex mARC700
15075 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
15076 This is the default when configured with @option{--with-cpu=arc700}@.
15078 @item arcem
15079 Compile for ARC EM.
15081 @item archs
15082 Compile for ARC HS.
15084 @item em
15085 Compile for ARC EM CPU with no hardware extensions.
15087 @item em4
15088 Compile for ARC EM4 CPU.
15090 @item em4_dmips
15091 Compile for ARC EM4 DMIPS CPU.
15093 @item em4_fpus
15094 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
15095 extension.
15097 @item em4_fpuda
15098 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
15099 double assist instructions.
15101 @item hs
15102 Compile for ARC HS CPU with no hardware extensions except the atomic
15103 instructions.
15105 @item hs34
15106 Compile for ARC HS34 CPU.
15108 @item hs38
15109 Compile for ARC HS38 CPU.
15111 @item hs38_linux
15112 Compile for ARC HS38 CPU with all hardware extensions on.
15114 @item arc600_norm
15115 Compile for ARC 600 CPU with @code{norm} instructions enabled.
15117 @item arc600_mul32x16
15118 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
15119 instructions enabled.
15121 @item arc600_mul64
15122 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
15123 instructions enabled.
15125 @item arc601_norm
15126 Compile for ARC 601 CPU with @code{norm} instructions enabled.
15128 @item arc601_mul32x16
15129 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
15130 instructions enabled.
15132 @item arc601_mul64
15133 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
15134 instructions enabled.
15136 @item nps400
15137 Compile for ARC 700 on NPS400 chip.
15139 @item em_mini
15140 Compile for ARC EM minimalist configuration featuring reduced register
15141 set.
15143 @end table
15145 @item -mdpfp
15146 @opindex mdpfp
15147 @itemx -mdpfp-compact
15148 @opindex mdpfp-compact
15149 Generate double-precision FPX instructions, tuned for the compact
15150 implementation.
15152 @item -mdpfp-fast
15153 @opindex mdpfp-fast
15154 Generate double-precision FPX instructions, tuned for the fast
15155 implementation.
15157 @item -mno-dpfp-lrsr
15158 @opindex mno-dpfp-lrsr
15159 Disable @code{lr} and @code{sr} instructions from using FPX extension
15160 aux registers.
15162 @item -mea
15163 @opindex mea
15164 Generate extended arithmetic instructions.  Currently only
15165 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
15166 supported.  This is always enabled for @option{-mcpu=ARC700}.
15168 @item -mno-mpy
15169 @opindex mno-mpy
15170 Do not generate @code{mpy}-family instructions for ARC700.  This option is
15171 deprecated.
15173 @item -mmul32x16
15174 @opindex mmul32x16
15175 Generate 32x16-bit multiply and multiply-accumulate instructions.
15177 @item -mmul64
15178 @opindex mmul64
15179 Generate @code{mul64} and @code{mulu64} instructions.  
15180 Only valid for @option{-mcpu=ARC600}.
15182 @item -mnorm
15183 @opindex mnorm
15184 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
15185 is in effect.
15187 @item -mspfp
15188 @opindex mspfp
15189 @itemx -mspfp-compact
15190 @opindex mspfp-compact
15191 Generate single-precision FPX instructions, tuned for the compact
15192 implementation.
15194 @item -mspfp-fast
15195 @opindex mspfp-fast
15196 Generate single-precision FPX instructions, tuned for the fast
15197 implementation.
15199 @item -msimd
15200 @opindex msimd
15201 Enable generation of ARC SIMD instructions via target-specific
15202 builtins.  Only valid for @option{-mcpu=ARC700}.
15204 @item -msoft-float
15205 @opindex msoft-float
15206 This option ignored; it is provided for compatibility purposes only.
15207 Software floating-point code is emitted by default, and this default
15208 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
15209 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
15210 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
15212 @item -mswap
15213 @opindex mswap
15214 Generate @code{swap} instructions.
15216 @item -matomic
15217 @opindex matomic
15218 This enables use of the locked load/store conditional extension to implement
15219 atomic memory built-in functions.  Not available for ARC 6xx or ARC
15220 EM cores.
15222 @item -mdiv-rem
15223 @opindex mdiv-rem
15224 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
15226 @item -mcode-density
15227 @opindex mcode-density
15228 Enable code density instructions for ARC EM.  
15229 This option is on by default for ARC HS.
15231 @item -mll64
15232 @opindex mll64
15233 Enable double load/store operations for ARC HS cores.
15235 @item -mtp-regno=@var{regno}
15236 @opindex mtp-regno
15237 Specify thread pointer register number.
15239 @item -mmpy-option=@var{multo}
15240 @opindex mmpy-option
15241 Compile ARCv2 code with a multiplier design option.  You can specify 
15242 the option using either a string or numeric value for @var{multo}.  
15243 @samp{wlh1} is the default value.  The recognized values are:
15245 @table @samp
15246 @item 0
15247 @itemx none
15248 No multiplier available.
15250 @item 1
15251 @itemx w
15252 16x16 multiplier, fully pipelined.
15253 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15255 @item 2
15256 @itemx wlh1
15257 32x32 multiplier, fully
15258 pipelined (1 stage).  The following instructions are additionally
15259 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15261 @item 3
15262 @itemx wlh2
15263 32x32 multiplier, fully pipelined
15264 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15265 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15267 @item 4
15268 @itemx wlh3
15269 Two 16x16 multipliers, blocking,
15270 sequential.  The following instructions are additionally enabled: @code{mpy},
15271 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15273 @item 5
15274 @itemx wlh4
15275 One 16x16 multiplier, blocking,
15276 sequential.  The following instructions are additionally enabled: @code{mpy},
15277 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15279 @item 6
15280 @itemx wlh5
15281 One 32x4 multiplier, blocking,
15282 sequential.  The following instructions are additionally enabled: @code{mpy},
15283 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15285 @item 7
15286 @itemx plus_dmpy
15287 ARC HS SIMD support.
15289 @item 8
15290 @itemx plus_macd
15291 ARC HS SIMD support.
15293 @item 9
15294 @itemx plus_qmacw
15295 ARC HS SIMD support.
15297 @end table
15299 This option is only available for ARCv2 cores@.
15301 @item -mfpu=@var{fpu}
15302 @opindex mfpu
15303 Enables support for specific floating-point hardware extensions for ARCv2
15304 cores.  Supported values for @var{fpu} are:
15306 @table @samp
15308 @item fpus
15309 Enables support for single-precision floating-point hardware
15310 extensions@.
15312 @item fpud
15313 Enables support for double-precision floating-point hardware
15314 extensions.  The single-precision floating-point extension is also
15315 enabled.  Not available for ARC EM@.
15317 @item fpuda
15318 Enables support for double-precision floating-point hardware
15319 extensions using double-precision assist instructions.  The single-precision
15320 floating-point extension is also enabled.  This option is
15321 only available for ARC EM@.
15323 @item fpuda_div
15324 Enables support for double-precision floating-point hardware
15325 extensions using double-precision assist instructions.
15326 The single-precision floating-point, square-root, and divide 
15327 extensions are also enabled.  This option is
15328 only available for ARC EM@.
15330 @item fpuda_fma
15331 Enables support for double-precision floating-point hardware
15332 extensions using double-precision assist instructions.
15333 The single-precision floating-point and fused multiply and add 
15334 hardware extensions are also enabled.  This option is
15335 only available for ARC EM@.
15337 @item fpuda_all
15338 Enables support for double-precision floating-point hardware
15339 extensions using double-precision assist instructions.
15340 All single-precision floating-point hardware extensions are also
15341 enabled.  This option is only available for ARC EM@.
15343 @item fpus_div
15344 Enables support for single-precision floating-point, square-root and divide 
15345 hardware extensions@.
15347 @item fpud_div
15348 Enables support for double-precision floating-point, square-root and divide 
15349 hardware extensions.  This option
15350 includes option @samp{fpus_div}. Not available for ARC EM@.
15352 @item fpus_fma
15353 Enables support for single-precision floating-point and 
15354 fused multiply and add hardware extensions@.
15356 @item fpud_fma
15357 Enables support for double-precision floating-point and 
15358 fused multiply and add hardware extensions.  This option
15359 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15361 @item fpus_all
15362 Enables support for all single-precision floating-point hardware
15363 extensions@.
15365 @item fpud_all
15366 Enables support for all single- and double-precision floating-point
15367 hardware extensions.  Not available for ARC EM@.
15369 @end table
15371 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15372 @opindex mirq-ctrl-saved
15373 Specifies general-purposes registers that the processor automatically
15374 saves/restores on interrupt entry and exit.  @var{register-range} is
15375 specified as two registers separated by a dash.  The register range
15376 always starts with @code{r0}, the upper limit is @code{fp} register.
15377 @var{blink} and @var{lp_count} are optional.  This option is only
15378 valid for ARC EM and ARC HS cores.
15380 @item -mrgf-banked-regs=@var{number}
15381 @opindex mrgf-banked-regs
15382 Specifies the number of registers replicated in second register bank
15383 on entry to fast interrupt.  Fast interrupts are interrupts with the
15384 highest priority level P0.  These interrupts save only PC and STATUS32
15385 registers to avoid memory transactions during interrupt entry and exit
15386 sequences.  Use this option when you are using fast interrupts in an
15387 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15389 @item -mlpc-width=@var{width}
15390 @opindex mlpc-width
15391 Specify the width of the @code{lp_count} register.  Valid values for
15392 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15393 fixed to 32 bits.  If the width is less than 32, the compiler does not
15394 attempt to transform loops in your program to use the zero-delay loop
15395 mechanism unless it is known that the @code{lp_count} register can
15396 hold the required loop-counter value.  Depending on the width
15397 specified, the compiler and run-time library might continue to use the
15398 loop mechanism for various needs.  This option defines macro
15399 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15401 @item -mrf16
15402 @opindex mrf16
15403 This option instructs the compiler to generate code for a 16-entry
15404 register file.  This option defines the @code{__ARC_RF16__}
15405 preprocessor macro.
15407 @end table
15409 The following options are passed through to the assembler, and also
15410 define preprocessor macro symbols.
15412 @c Flags used by the assembler, but for which we define preprocessor
15413 @c macro symbols as well.
15414 @table @gcctabopt
15415 @item -mdsp-packa
15416 @opindex mdsp-packa
15417 Passed down to the assembler to enable the DSP Pack A extensions.
15418 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15419 deprecated.
15421 @item -mdvbf
15422 @opindex mdvbf
15423 Passed down to the assembler to enable the dual Viterbi butterfly
15424 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15425 option is deprecated.
15427 @c ARC700 4.10 extension instruction
15428 @item -mlock
15429 @opindex mlock
15430 Passed down to the assembler to enable the locked load/store
15431 conditional extension.  Also sets the preprocessor symbol
15432 @code{__Xlock}.
15434 @item -mmac-d16
15435 @opindex mmac-d16
15436 Passed down to the assembler.  Also sets the preprocessor symbol
15437 @code{__Xxmac_d16}.  This option is deprecated.
15439 @item -mmac-24
15440 @opindex mmac-24
15441 Passed down to the assembler.  Also sets the preprocessor symbol
15442 @code{__Xxmac_24}.  This option is deprecated.
15444 @c ARC700 4.10 extension instruction
15445 @item -mrtsc
15446 @opindex mrtsc
15447 Passed down to the assembler to enable the 64-bit time-stamp counter
15448 extension instruction.  Also sets the preprocessor symbol
15449 @code{__Xrtsc}.  This option is deprecated.
15451 @c ARC700 4.10 extension instruction
15452 @item -mswape
15453 @opindex mswape
15454 Passed down to the assembler to enable the swap byte ordering
15455 extension instruction.  Also sets the preprocessor symbol
15456 @code{__Xswape}.
15458 @item -mtelephony
15459 @opindex mtelephony
15460 Passed down to the assembler to enable dual- and single-operand
15461 instructions for telephony.  Also sets the preprocessor symbol
15462 @code{__Xtelephony}.  This option is deprecated.
15464 @item -mxy
15465 @opindex mxy
15466 Passed down to the assembler to enable the XY memory extension.  Also
15467 sets the preprocessor symbol @code{__Xxy}.
15469 @end table
15471 The following options control how the assembly code is annotated:
15473 @c Assembly annotation options
15474 @table @gcctabopt
15475 @item -misize
15476 @opindex misize
15477 Annotate assembler instructions with estimated addresses.
15479 @item -mannotate-align
15480 @opindex mannotate-align
15481 Explain what alignment considerations lead to the decision to make an
15482 instruction short or long.
15484 @end table
15486 The following options are passed through to the linker:
15488 @c options passed through to the linker
15489 @table @gcctabopt
15490 @item -marclinux
15491 @opindex marclinux
15492 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15493 This option is enabled by default in tool chains built for
15494 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15495 when profiling is not requested.
15497 @item -marclinux_prof
15498 @opindex marclinux_prof
15499 Passed through to the linker, to specify use of the
15500 @code{arclinux_prof} emulation.  This option is enabled by default in
15501 tool chains built for @w{@code{arc-linux-uclibc}} and
15502 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15504 @end table
15506 The following options control the semantics of generated code:
15508 @c semantically relevant code generation options
15509 @table @gcctabopt
15510 @item -mlong-calls
15511 @opindex mlong-calls
15512 Generate calls as register indirect calls, thus providing access
15513 to the full 32-bit address range.
15515 @item -mmedium-calls
15516 @opindex mmedium-calls
15517 Don't use less than 25-bit addressing range for calls, which is the
15518 offset available for an unconditional branch-and-link
15519 instruction.  Conditional execution of function calls is suppressed, to
15520 allow use of the 25-bit range, rather than the 21-bit range with
15521 conditional branch-and-link.  This is the default for tool chains built
15522 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15524 @item -G @var{num}
15525 @opindex G
15526 Put definitions of externally-visible data in a small data section if
15527 that data is no bigger than @var{num} bytes.  The default value of
15528 @var{num} is 4 for any ARC configuration, or 8 when we have double
15529 load/store operations.
15531 @item -mno-sdata
15532 @opindex mno-sdata
15533 Do not generate sdata references.  This is the default for tool chains
15534 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15535 targets.
15537 @item -mvolatile-cache
15538 @opindex mvolatile-cache
15539 Use ordinarily cached memory accesses for volatile references.  This is the
15540 default.
15542 @item -mno-volatile-cache
15543 @opindex mno-volatile-cache
15544 Enable cache bypass for volatile references.
15546 @end table
15548 The following options fine tune code generation:
15549 @c code generation tuning options
15550 @table @gcctabopt
15551 @item -malign-call
15552 @opindex malign-call
15553 Do alignment optimizations for call instructions.
15555 @item -mauto-modify-reg
15556 @opindex mauto-modify-reg
15557 Enable the use of pre/post modify with register displacement.
15559 @item -mbbit-peephole
15560 @opindex mbbit-peephole
15561 Enable bbit peephole2.
15563 @item -mno-brcc
15564 @opindex mno-brcc
15565 This option disables a target-specific pass in @file{arc_reorg} to
15566 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15567 It has no effect on
15568 generation of these instructions driven by the combiner pass.
15570 @item -mcase-vector-pcrel
15571 @opindex mcase-vector-pcrel
15572 Use PC-relative switch case tables to enable case table shortening.
15573 This is the default for @option{-Os}.
15575 @item -mcompact-casesi
15576 @opindex mcompact-casesi
15577 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15578 and only available for ARCv1 cores.
15580 @item -mno-cond-exec
15581 @opindex mno-cond-exec
15582 Disable the ARCompact-specific pass to generate conditional 
15583 execution instructions.
15585 Due to delay slot scheduling and interactions between operand numbers,
15586 literal sizes, instruction lengths, and the support for conditional execution,
15587 the target-independent pass to generate conditional execution is often lacking,
15588 so the ARC port has kept a special pass around that tries to find more
15589 conditional execution generation opportunities after register allocation,
15590 branch shortening, and delay slot scheduling have been done.  This pass
15591 generally, but not always, improves performance and code size, at the cost of
15592 extra compilation time, which is why there is an option to switch it off.
15593 If you have a problem with call instructions exceeding their allowable
15594 offset range because they are conditionalized, you should consider using
15595 @option{-mmedium-calls} instead.
15597 @item -mearly-cbranchsi
15598 @opindex mearly-cbranchsi
15599 Enable pre-reload use of the @code{cbranchsi} pattern.
15601 @item -mexpand-adddi
15602 @opindex mexpand-adddi
15603 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15604 @code{add.f}, @code{adc} etc.  This option is deprecated.
15606 @item -mindexed-loads
15607 @opindex mindexed-loads
15608 Enable the use of indexed loads.  This can be problematic because some
15609 optimizers then assume that indexed stores exist, which is not
15610 the case.
15612 @item -mlra
15613 @opindex mlra
15614 Enable Local Register Allocation.  This is still experimental for ARC,
15615 so by default the compiler uses standard reload
15616 (i.e. @option{-mno-lra}).
15618 @item -mlra-priority-none
15619 @opindex mlra-priority-none
15620 Don't indicate any priority for target registers.
15622 @item -mlra-priority-compact
15623 @opindex mlra-priority-compact
15624 Indicate target register priority for r0..r3 / r12..r15.
15626 @item -mlra-priority-noncompact
15627 @opindex mlra-priority-noncompact
15628 Reduce target register priority for r0..r3 / r12..r15.
15630 @item -mno-millicode
15631 @opindex mno-millicode
15632 When optimizing for size (using @option{-Os}), prologues and epilogues
15633 that have to save or restore a large number of registers are often
15634 shortened by using call to a special function in libgcc; this is
15635 referred to as a @emph{millicode} call.  As these calls can pose
15636 performance issues, and/or cause linking issues when linking in a
15637 nonstandard way, this option is provided to turn off millicode call
15638 generation.
15640 @item -mmixed-code
15641 @opindex mmixed-code
15642 Tweak register allocation to help 16-bit instruction generation.
15643 This generally has the effect of decreasing the average instruction size
15644 while increasing the instruction count.
15646 @item -mq-class
15647 @opindex mq-class
15648 Enable @samp{q} instruction alternatives.
15649 This is the default for @option{-Os}.
15651 @item -mRcq
15652 @opindex mRcq
15653 Enable @samp{Rcq} constraint handling.  
15654 Most short code generation depends on this.
15655 This is the default.
15657 @item -mRcw
15658 @opindex mRcw
15659 Enable @samp{Rcw} constraint handling.  
15660 Most ccfsm condexec mostly depends on this.
15661 This is the default.
15663 @item -msize-level=@var{level}
15664 @opindex msize-level
15665 Fine-tune size optimization with regards to instruction lengths and alignment.
15666 The recognized values for @var{level} are:
15667 @table @samp
15668 @item 0
15669 No size optimization.  This level is deprecated and treated like @samp{1}.
15671 @item 1
15672 Short instructions are used opportunistically.
15674 @item 2
15675 In addition, alignment of loops and of code after barriers are dropped.
15677 @item 3
15678 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15680 @end table
15682 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15683 the behavior when this is not set is equivalent to level @samp{1}.
15685 @item -mtune=@var{cpu}
15686 @opindex mtune
15687 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15688 by @option{-mcpu=}.
15690 Supported values for @var{cpu} are
15692 @table @samp
15693 @item ARC600
15694 Tune for ARC600 CPU.
15696 @item ARC601
15697 Tune for ARC601 CPU.
15699 @item ARC700
15700 Tune for ARC700 CPU with standard multiplier block.
15702 @item ARC700-xmac
15703 Tune for ARC700 CPU with XMAC block.
15705 @item ARC725D
15706 Tune for ARC725D CPU.
15708 @item ARC750D
15709 Tune for ARC750D CPU.
15711 @end table
15713 @item -mmultcost=@var{num}
15714 @opindex mmultcost
15715 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15716 normal instruction.
15718 @item -munalign-prob-threshold=@var{probability}
15719 @opindex munalign-prob-threshold
15720 Set probability threshold for unaligning branches.
15721 When tuning for @samp{ARC700} and optimizing for speed, branches without
15722 filled delay slot are preferably emitted unaligned and long, unless
15723 profiling indicates that the probability for the branch to be taken
15724 is below @var{probability}.  @xref{Cross-profiling}.
15725 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15727 @end table
15729 The following options are maintained for backward compatibility, but
15730 are now deprecated and will be removed in a future release:
15732 @c Deprecated options
15733 @table @gcctabopt
15735 @item -margonaut
15736 @opindex margonaut
15737 Obsolete FPX.
15739 @item -mbig-endian
15740 @opindex mbig-endian
15741 @itemx -EB
15742 @opindex EB
15743 Compile code for big-endian targets.  Use of these options is now
15744 deprecated.  Big-endian code is supported by configuring GCC to build
15745 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15746 for which big endian is the default.
15748 @item -mlittle-endian
15749 @opindex mlittle-endian
15750 @itemx -EL
15751 @opindex EL
15752 Compile code for little-endian targets.  Use of these options is now
15753 deprecated.  Little-endian code is supported by configuring GCC to build 
15754 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15755 for which little endian is the default.
15757 @item -mbarrel_shifter
15758 @opindex mbarrel_shifter
15759 Replaced by @option{-mbarrel-shifter}.
15761 @item -mdpfp_compact
15762 @opindex mdpfp_compact
15763 Replaced by @option{-mdpfp-compact}.
15765 @item -mdpfp_fast
15766 @opindex mdpfp_fast
15767 Replaced by @option{-mdpfp-fast}.
15769 @item -mdsp_packa
15770 @opindex mdsp_packa
15771 Replaced by @option{-mdsp-packa}.
15773 @item -mEA
15774 @opindex mEA
15775 Replaced by @option{-mea}.
15777 @item -mmac_24
15778 @opindex mmac_24
15779 Replaced by @option{-mmac-24}.
15781 @item -mmac_d16
15782 @opindex mmac_d16
15783 Replaced by @option{-mmac-d16}.
15785 @item -mspfp_compact
15786 @opindex mspfp_compact
15787 Replaced by @option{-mspfp-compact}.
15789 @item -mspfp_fast
15790 @opindex mspfp_fast
15791 Replaced by @option{-mspfp-fast}.
15793 @item -mtune=@var{cpu}
15794 @opindex mtune
15795 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15796 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15797 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15799 @item -multcost=@var{num}
15800 @opindex multcost
15801 Replaced by @option{-mmultcost}.
15803 @end table
15805 @node ARM Options
15806 @subsection ARM Options
15807 @cindex ARM options
15809 These @samp{-m} options are defined for the ARM port:
15811 @table @gcctabopt
15812 @item -mabi=@var{name}
15813 @opindex mabi
15814 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15815 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15817 @item -mapcs-frame
15818 @opindex mapcs-frame
15819 Generate a stack frame that is compliant with the ARM Procedure Call
15820 Standard for all functions, even if this is not strictly necessary for
15821 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15822 with this option causes the stack frames not to be generated for
15823 leaf functions.  The default is @option{-mno-apcs-frame}.
15824 This option is deprecated.
15826 @item -mapcs
15827 @opindex mapcs
15828 This is a synonym for @option{-mapcs-frame} and is deprecated.
15830 @ignore
15831 @c not currently implemented
15832 @item -mapcs-stack-check
15833 @opindex mapcs-stack-check
15834 Generate code to check the amount of stack space available upon entry to
15835 every function (that actually uses some stack space).  If there is
15836 insufficient space available then either the function
15837 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15838 called, depending upon the amount of stack space required.  The runtime
15839 system is required to provide these functions.  The default is
15840 @option{-mno-apcs-stack-check}, since this produces smaller code.
15842 @c not currently implemented
15843 @item -mapcs-reentrant
15844 @opindex mapcs-reentrant
15845 Generate reentrant, position-independent code.  The default is
15846 @option{-mno-apcs-reentrant}.
15847 @end ignore
15849 @item -mthumb-interwork
15850 @opindex mthumb-interwork
15851 Generate code that supports calling between the ARM and Thumb
15852 instruction sets.  Without this option, on pre-v5 architectures, the
15853 two instruction sets cannot be reliably used inside one program.  The
15854 default is @option{-mno-thumb-interwork}, since slightly larger code
15855 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15856 configurations this option is meaningless.
15858 @item -mno-sched-prolog
15859 @opindex mno-sched-prolog
15860 Prevent the reordering of instructions in the function prologue, or the
15861 merging of those instruction with the instructions in the function's
15862 body.  This means that all functions start with a recognizable set
15863 of instructions (or in fact one of a choice from a small set of
15864 different function prologues), and this information can be used to
15865 locate the start of functions inside an executable piece of code.  The
15866 default is @option{-msched-prolog}.
15868 @item -mfloat-abi=@var{name}
15869 @opindex mfloat-abi
15870 Specifies which floating-point ABI to use.  Permissible values
15871 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15873 Specifying @samp{soft} causes GCC to generate output containing
15874 library calls for floating-point operations.
15875 @samp{softfp} allows the generation of code using hardware floating-point
15876 instructions, but still uses the soft-float calling conventions.
15877 @samp{hard} allows generation of floating-point instructions
15878 and uses FPU-specific calling conventions.
15880 The default depends on the specific target configuration.  Note that
15881 the hard-float and soft-float ABIs are not link-compatible; you must
15882 compile your entire program with the same ABI, and link with a
15883 compatible set of libraries.
15885 @item -mlittle-endian
15886 @opindex mlittle-endian
15887 Generate code for a processor running in little-endian mode.  This is
15888 the default for all standard configurations.
15890 @item -mbig-endian
15891 @opindex mbig-endian
15892 Generate code for a processor running in big-endian mode; the default is
15893 to compile code for a little-endian processor.
15895 @item -mbe8
15896 @itemx -mbe32
15897 @opindex mbe8
15898 When linking a big-endian image select between BE8 and BE32 formats.
15899 The option has no effect for little-endian images and is ignored.  The
15900 default is dependent on the selected target architecture.  For ARMv6
15901 and later architectures the default is BE8, for older architectures
15902 the default is BE32.  BE32 format has been deprecated by ARM.
15904 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15905 @opindex march
15906 This specifies the name of the target ARM architecture.  GCC uses this
15907 name to determine what kind of instructions it can emit when generating
15908 assembly code.  This option can be used in conjunction with or instead
15909 of the @option{-mcpu=} option.
15911 Permissible names are:
15912 @samp{armv4t},
15913 @samp{armv5t}, @samp{armv5te},
15914 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15915 @samp{armv6z}, @samp{armv6zk},
15916 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15917 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15918 @samp{armv8.4-a},
15919 @samp{armv7-r},
15920 @samp{armv8-r},
15921 @samp{armv6-m}, @samp{armv6s-m},
15922 @samp{armv7-m}, @samp{armv7e-m},
15923 @samp{armv8-m.base}, @samp{armv8-m.main},
15924 @samp{iwmmxt} and @samp{iwmmxt2}.
15926 Additionally, the following architectures, which lack support for the
15927 Thumb execution state, are recognized but support is deprecated:
15928 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15929 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15931 Many of the architectures support extensions.  These can be added by
15932 appending @samp{+@var{extension}} to the architecture name.  Extension
15933 options are processed in order and capabilities accumulate.  An extension
15934 will also enable any necessary base extensions
15935 upon which it depends.  For example, the @samp{+crypto} extension
15936 will always enable the @samp{+simd} extension.  The exception to the
15937 additive construction is for extensions that are prefixed with
15938 @samp{+no@dots{}}: these extensions disable the specified option and
15939 any other extensions that may depend on the presence of that
15940 extension.
15942 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15943 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15944 entirely disabled by the @samp{+nofp} option that follows it.
15946 Most extension names are generically named, but have an effect that is
15947 dependent upon the architecture to which it is applied.  For example,
15948 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15949 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15950 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15951 variant for @samp{armv8-a}.
15953 The table below lists the supported extensions for each architecture.
15954 Architectures not mentioned do not support any extensions.
15956 @table @samp
15957 @item  armv5e
15958 @itemx armv5te
15959 @itemx armv6
15960 @itemx armv6j
15961 @itemx armv6k
15962 @itemx armv6kz
15963 @itemx armv6t2
15964 @itemx armv6z
15965 @itemx armv6zk
15966 @table @samp
15967 @item +fp
15968 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15969 used as an alias for this extension.
15971 @item +nofp
15972 Disable the floating-point instructions.
15973 @end table
15975 @item armv7
15976 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15977 @table @samp
15978 @item +fp
15979 The VFPv3 floating-point instructions, with 16 double-precision
15980 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15981 for this extension.  Note that floating-point is not supported by the
15982 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15983 ARMv7-R architectures.
15985 @item +nofp
15986 Disable the floating-point instructions.
15987 @end table
15989 @item armv7-a
15990 @table @samp
15991 @item +fp
15992 The VFPv3 floating-point instructions, with 16 double-precision
15993 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15994 for this extension.
15996 @item +simd
15997 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15998 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15999 for this extension.
16001 @item +vfpv3
16002 The VFPv3 floating-point instructions, with 32 double-precision
16003 registers.
16005 @item +vfpv3-d16-fp16
16006 The VFPv3 floating-point instructions, with 16 double-precision
16007 registers and the half-precision floating-point conversion operations.
16009 @item +vfpv3-fp16
16010 The VFPv3 floating-point instructions, with 32 double-precision
16011 registers and the half-precision floating-point conversion operations.
16013 @item +vfpv4-d16
16014 The VFPv4 floating-point instructions, with 16 double-precision
16015 registers.
16017 @item +vfpv4
16018 The VFPv4 floating-point instructions, with 32 double-precision
16019 registers.
16021 @item +neon-fp16
16022 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16023 the half-precision floating-point conversion operations.
16025 @item +neon-vfpv4
16026 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
16028 @item +nosimd
16029 Disable the Advanced SIMD instructions (does not disable floating point).
16031 @item +nofp
16032 Disable the floating-point and Advanced SIMD instructions.
16033 @end table
16035 @item armv7ve
16036 The extended version of the ARMv7-A architecture with support for
16037 virtualization.
16038 @table @samp
16039 @item +fp
16040 The VFPv4 floating-point instructions, with 16 double-precision registers.
16041 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
16043 @item +simd
16044 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
16045 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
16047 @item +vfpv3-d16
16048 The VFPv3 floating-point instructions, with 16 double-precision
16049 registers.
16051 @item +vfpv3
16052 The VFPv3 floating-point instructions, with 32 double-precision
16053 registers.
16055 @item +vfpv3-d16-fp16
16056 The VFPv3 floating-point instructions, with 16 double-precision
16057 registers and the half-precision floating-point conversion operations.
16059 @item +vfpv3-fp16
16060 The VFPv3 floating-point instructions, with 32 double-precision
16061 registers and the half-precision floating-point conversion operations.
16063 @item +vfpv4-d16
16064 The VFPv4 floating-point instructions, with 16 double-precision
16065 registers.
16067 @item +vfpv4
16068 The VFPv4 floating-point instructions, with 32 double-precision
16069 registers.
16071 @item +neon
16072 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16073 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
16075 @item +neon-fp16
16076 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16077 the half-precision floating-point conversion operations.
16079 @item +nosimd
16080 Disable the Advanced SIMD instructions (does not disable floating point).
16082 @item +nofp
16083 Disable the floating-point and Advanced SIMD instructions.
16084 @end table
16086 @item armv8-a
16087 @table @samp
16088 @item +crc
16089 The Cyclic Redundancy Check (CRC) instructions.
16090 @item +simd
16091 The ARMv8-A Advanced SIMD and floating-point instructions.
16092 @item +crypto
16093 The cryptographic instructions.
16094 @item +nocrypto
16095 Disable the cryptographic instructions.
16096 @item +nofp
16097 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16098 @end table
16100 @item armv8.1-a
16101 @table @samp
16102 @item +simd
16103 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16105 @item +crypto
16106 The cryptographic instructions.  This also enables the Advanced SIMD and
16107 floating-point instructions.
16109 @item +nocrypto
16110 Disable the cryptographic instructions.
16112 @item +nofp
16113 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16114 @end table
16116 @item armv8.2-a
16117 @itemx armv8.3-a
16118 @table @samp
16119 @item +fp16
16120 The half-precision floating-point data processing instructions.
16121 This also enables the Advanced SIMD and floating-point instructions.
16123 @item +fp16fml
16124 The half-precision floating-point fmla extension.  This also enables
16125 the half-precision floating-point extension and Advanced SIMD and
16126 floating-point instructions.
16128 @item +simd
16129 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16131 @item +crypto
16132 The cryptographic instructions.  This also enables the Advanced SIMD and
16133 floating-point instructions.
16135 @item +dotprod
16136 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
16138 @item +nocrypto
16139 Disable the cryptographic extension.
16141 @item +nofp
16142 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16143 @end table
16145 @item armv8.4-a
16146 @table @samp
16147 @item +fp16
16148 The half-precision floating-point data processing instructions.
16149 This also enables the Advanced SIMD and floating-point instructions as well
16150 as the Dot Product extension and the half-precision floating-point fmla
16151 extension.
16153 @item +simd
16154 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
16155 Dot Product extension.
16157 @item +crypto
16158 The cryptographic instructions.  This also enables the Advanced SIMD and
16159 floating-point instructions as well as the Dot Product extension.
16161 @item +nocrypto
16162 Disable the cryptographic extension.
16164 @item +nofp
16165 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16166 @end table
16168 @item armv7-r
16169 @table @samp
16170 @item +fp.sp
16171 The single-precision VFPv3 floating-point instructions.  The extension
16172 @samp{+vfpv3xd} can be used as an alias for this extension.
16174 @item +fp
16175 The VFPv3 floating-point instructions with 16 double-precision registers.
16176 The extension +vfpv3-d16 can be used as an alias for this extension.
16178 @item +nofp
16179 Disable the floating-point extension.
16181 @item +idiv
16182 The ARM-state integer division instructions.
16184 @item +noidiv
16185 Disable the ARM-state integer division extension.
16186 @end table
16188 @item armv7e-m
16189 @table @samp
16190 @item +fp
16191 The single-precision VFPv4 floating-point instructions.
16193 @item +fpv5
16194 The single-precision FPv5 floating-point instructions.
16196 @item +fp.dp
16197 The single- and double-precision FPv5 floating-point instructions.
16199 @item +nofp
16200 Disable the floating-point extensions.
16201 @end table
16203 @item  armv8-m.main
16204 @table @samp
16205 @item +dsp
16206 The DSP instructions.
16208 @item +nodsp
16209 Disable the DSP extension.
16211 @item +fp
16212 The single-precision floating-point instructions.
16214 @item +fp.dp
16215 The single- and double-precision floating-point instructions.
16217 @item +nofp
16218 Disable the floating-point extension.
16219 @end table
16221 @item armv8-r
16222 @table @samp
16223 @item +crc
16224 The Cyclic Redundancy Check (CRC) instructions.
16225 @item +fp.sp
16226 The single-precision FPv5 floating-point instructions.
16227 @item +simd
16228 The ARMv8-A Advanced SIMD and floating-point instructions.
16229 @item +crypto
16230 The cryptographic instructions.
16231 @item +nocrypto
16232 Disable the cryptographic instructions.
16233 @item +nofp
16234 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16235 @end table
16237 @end table
16239 @option{-march=native} causes the compiler to auto-detect the architecture
16240 of the build computer.  At present, this feature is only supported on
16241 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16242 is unsuccessful the option has no effect.
16244 @item -mtune=@var{name}
16245 @opindex mtune
16246 This option specifies the name of the target ARM processor for
16247 which GCC should tune the performance of the code.
16248 For some ARM implementations better performance can be obtained by using
16249 this option.
16250 Permissible names are: @samp{arm2}, @samp{arm250},
16251 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
16252 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
16253 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
16254 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
16255 @samp{arm720},
16256 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
16257 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
16258 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
16259 @samp{strongarm1110},
16260 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
16261 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
16262 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
16263 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
16264 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
16265 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
16266 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
16267 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
16268 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
16269 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
16270 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
16271 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
16272 @samp{cortex-r8}, @samp{cortex-r52},
16273 @samp{cortex-m33},
16274 @samp{cortex-m23},
16275 @samp{cortex-m7},
16276 @samp{cortex-m4},
16277 @samp{cortex-m3},
16278 @samp{cortex-m1},
16279 @samp{cortex-m0},
16280 @samp{cortex-m0plus},
16281 @samp{cortex-m1.small-multiply},
16282 @samp{cortex-m0.small-multiply},
16283 @samp{cortex-m0plus.small-multiply},
16284 @samp{exynos-m1},
16285 @samp{marvell-pj4},
16286 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
16287 @samp{fa526}, @samp{fa626},
16288 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16289 @samp{xgene1}.
16291 Additionally, this option can specify that GCC should tune the performance
16292 of the code for a big.LITTLE system.  Permissible names are:
16293 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16294 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16295 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16296 @samp{cortex-a75.cortex-a55}.
16298 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16299 performance for a blend of processors within architecture @var{arch}.
16300 The aim is to generate code that run well on the current most popular
16301 processors, balancing between optimizations that benefit some CPUs in the
16302 range, and avoiding performance pitfalls of other CPUs.  The effects of
16303 this option may change in future GCC versions as CPU models come and go.
16305 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16306 the extension options do not affect the tuning of the generated code.
16308 @option{-mtune=native} causes the compiler to auto-detect the CPU
16309 of the build computer.  At present, this feature is only supported on
16310 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16311 unsuccessful the option has no effect.
16313 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16314 @opindex mcpu
16315 This specifies the name of the target ARM processor.  GCC uses this name
16316 to derive the name of the target ARM architecture (as if specified
16317 by @option{-march}) and the ARM processor type for which to tune for
16318 performance (as if specified by @option{-mtune}).  Where this option
16319 is used in conjunction with @option{-march} or @option{-mtune},
16320 those options take precedence over the appropriate part of this option.
16322 Many of the supported CPUs implement optional architectural
16323 extensions.  Where this is so the architectural extensions are
16324 normally enabled by default.  If implementations that lack the
16325 extension exist, then the extension syntax can be used to disable
16326 those extensions that have been omitted.  For floating-point and
16327 Advanced SIMD (Neon) instructions, the settings of the options
16328 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16329 floating-point and Advanced SIMD instructions will only be used if
16330 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16331 @option{-mfpu} other than @samp{auto} will override the available
16332 floating-point and SIMD extension instructions.
16334 For example, @samp{cortex-a9} can be found in three major
16335 configurations: integer only, with just a floating-point unit or with
16336 floating-point and Advanced SIMD.  The default is to enable all the
16337 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16338 be used to disable just the SIMD or both the SIMD and floating-point
16339 instructions respectively.
16341 Permissible names for this option are the same as those for
16342 @option{-mtune}.
16344 The following extension options are common to the listed CPUs:
16346 @table @samp
16347 @item +nodsp
16348 Disable the DSP instructions on @samp{cortex-m33}.
16350 @item  +nofp
16351 Disables the floating-point instructions on @samp{arm9e},
16352 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16353 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16354 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16355 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16356 Disables the floating-point and SIMD instructions on
16357 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16358 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16359 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16360 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16361 @samp{cortex-a53} and @samp{cortex-a55}.
16363 @item +nofp.dp
16364 Disables the double-precision component of the floating-point instructions
16365 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16367 @item +nosimd
16368 Disables the SIMD (but not floating-point) instructions on
16369 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16370 and @samp{cortex-a9}.
16372 @item +crypto
16373 Enables the cryptographic instructions on @samp{cortex-a32},
16374 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16375 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16376 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16377 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16378 @samp{cortex-a75.cortex-a55}.
16379 @end table
16381 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16382 VFPv3 with 16 double-precision registers.  It supports the following
16383 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16384 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16385 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16386 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16387 @option{-march=armv7-a}.
16389 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16390 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16391 See @option{-mtune} for more information.
16393 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16394 of the build computer.  At present, this feature is only supported on
16395 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16396 is unsuccessful the option has no effect.
16398 @item -mfpu=@var{name}
16399 @opindex mfpu
16400 This specifies what floating-point hardware (or hardware emulation) is
16401 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16402 @samp{vfpv3},
16403 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16404 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16405 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16406 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16407 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16408 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16409 is an alias for @samp{vfpv2}.
16411 The setting @samp{auto} is the default and is special.  It causes the
16412 compiler to select the floating-point and Advanced SIMD instructions
16413 based on the settings of @option{-mcpu} and @option{-march}.
16415 If the selected floating-point hardware includes the NEON extension
16416 (e.g. @option{-mfpu=neon}), note that floating-point
16417 operations are not generated by GCC's auto-vectorization pass unless
16418 @option{-funsafe-math-optimizations} is also specified.  This is
16419 because NEON hardware does not fully implement the IEEE 754 standard for
16420 floating-point arithmetic (in particular denormal values are treated as
16421 zero), so the use of NEON instructions may lead to a loss of precision.
16423 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}).
16425 @item -mfp16-format=@var{name}
16426 @opindex mfp16-format
16427 Specify the format of the @code{__fp16} half-precision floating-point type.
16428 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16429 the default is @samp{none}, in which case the @code{__fp16} type is not
16430 defined.  @xref{Half-Precision}, for more information.
16432 @item -mstructure-size-boundary=@var{n}
16433 @opindex mstructure-size-boundary
16434 The sizes of all structures and unions are rounded up to a multiple
16435 of the number of bits set by this option.  Permissible values are 8, 32
16436 and 64.  The default value varies for different toolchains.  For the COFF
16437 targeted toolchain the default value is 8.  A value of 64 is only allowed
16438 if the underlying ABI supports it.
16440 Specifying a larger number can produce faster, more efficient code, but
16441 can also increase the size of the program.  Different values are potentially
16442 incompatible.  Code compiled with one value cannot necessarily expect to
16443 work with code or libraries compiled with another value, if they exchange
16444 information using structures or unions.
16446 This option is deprecated.
16448 @item -mabort-on-noreturn
16449 @opindex mabort-on-noreturn
16450 Generate a call to the function @code{abort} at the end of a
16451 @code{noreturn} function.  It is executed if the function tries to
16452 return.
16454 @item -mlong-calls
16455 @itemx -mno-long-calls
16456 @opindex mlong-calls
16457 @opindex mno-long-calls
16458 Tells the compiler to perform function calls by first loading the
16459 address of the function into a register and then performing a subroutine
16460 call on this register.  This switch is needed if the target function
16461 lies outside of the 64-megabyte addressing range of the offset-based
16462 version of subroutine call instruction.
16464 Even if this switch is enabled, not all function calls are turned
16465 into long calls.  The heuristic is that static functions, functions
16466 that have the @code{short_call} attribute, functions that are inside
16467 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16468 definitions have already been compiled within the current compilation
16469 unit are not turned into long calls.  The exceptions to this rule are
16470 that weak function definitions, functions with the @code{long_call}
16471 attribute or the @code{section} attribute, and functions that are within
16472 the scope of a @code{#pragma long_calls} directive are always
16473 turned into long calls.
16475 This feature is not enabled by default.  Specifying
16476 @option{-mno-long-calls} restores the default behavior, as does
16477 placing the function calls within the scope of a @code{#pragma
16478 long_calls_off} directive.  Note these switches have no effect on how
16479 the compiler generates code to handle function calls via function
16480 pointers.
16482 @item -msingle-pic-base
16483 @opindex msingle-pic-base
16484 Treat the register used for PIC addressing as read-only, rather than
16485 loading it in the prologue for each function.  The runtime system is
16486 responsible for initializing this register with an appropriate value
16487 before execution begins.
16489 @item -mpic-register=@var{reg}
16490 @opindex mpic-register
16491 Specify the register to be used for PIC addressing.
16492 For standard PIC base case, the default is any suitable register
16493 determined by compiler.  For single PIC base case, the default is
16494 @samp{R9} if target is EABI based or stack-checking is enabled,
16495 otherwise the default is @samp{R10}.
16497 @item -mpic-data-is-text-relative
16498 @opindex mpic-data-is-text-relative
16499 Assume that the displacement between the text and data segments is fixed
16500 at static link time.  This permits using PC-relative addressing
16501 operations to access data known to be in the data segment.  For
16502 non-VxWorks RTP targets, this option is enabled by default.  When
16503 disabled on such targets, it will enable @option{-msingle-pic-base} by
16504 default.
16506 @item -mpoke-function-name
16507 @opindex mpoke-function-name
16508 Write the name of each function into the text section, directly
16509 preceding the function prologue.  The generated code is similar to this:
16511 @smallexample
16512      t0
16513          .ascii "arm_poke_function_name", 0
16514          .align
16515      t1
16516          .word 0xff000000 + (t1 - t0)
16517      arm_poke_function_name
16518          mov     ip, sp
16519          stmfd   sp!, @{fp, ip, lr, pc@}
16520          sub     fp, ip, #4
16521 @end smallexample
16523 When performing a stack backtrace, code can inspect the value of
16524 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16525 location @code{pc - 12} and the top 8 bits are set, then we know that
16526 there is a function name embedded immediately preceding this location
16527 and has length @code{((pc[-3]) & 0xff000000)}.
16529 @item -mthumb
16530 @itemx -marm
16531 @opindex marm
16532 @opindex mthumb
16534 Select between generating code that executes in ARM and Thumb
16535 states.  The default for most configurations is to generate code
16536 that executes in ARM state, but the default can be changed by
16537 configuring GCC with the @option{--with-mode=}@var{state}
16538 configure option.
16540 You can also override the ARM and Thumb mode for each function
16541 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16542 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16544 @item -mflip-thumb 
16545 @opindex mflip-thumb
16546 Switch ARM/Thumb modes on alternating functions.
16547 This option is provided for regression testing of mixed Thumb/ARM code
16548 generation, and is not intended for ordinary use in compiling code.
16550 @item -mtpcs-frame
16551 @opindex mtpcs-frame
16552 Generate a stack frame that is compliant with the Thumb Procedure Call
16553 Standard for all non-leaf functions.  (A leaf function is one that does
16554 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16556 @item -mtpcs-leaf-frame
16557 @opindex mtpcs-leaf-frame
16558 Generate a stack frame that is compliant with the Thumb Procedure Call
16559 Standard for all leaf functions.  (A leaf function is one that does
16560 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16562 @item -mcallee-super-interworking
16563 @opindex mcallee-super-interworking
16564 Gives all externally visible functions in the file being compiled an ARM
16565 instruction set header which switches to Thumb mode before executing the
16566 rest of the function.  This allows these functions to be called from
16567 non-interworking code.  This option is not valid in AAPCS configurations
16568 because interworking is enabled by default.
16570 @item -mcaller-super-interworking
16571 @opindex mcaller-super-interworking
16572 Allows calls via function pointers (including virtual functions) to
16573 execute correctly regardless of whether the target code has been
16574 compiled for interworking or not.  There is a small overhead in the cost
16575 of executing a function pointer if this option is enabled.  This option
16576 is not valid in AAPCS configurations because interworking is enabled
16577 by default.
16579 @item -mtp=@var{name}
16580 @opindex mtp
16581 Specify the access model for the thread local storage pointer.  The valid
16582 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16583 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16584 (supported in the arm6k architecture), and @samp{auto}, which uses the
16585 best available method for the selected processor.  The default setting is
16586 @samp{auto}.
16588 @item -mtls-dialect=@var{dialect}
16589 @opindex mtls-dialect
16590 Specify the dialect to use for accessing thread local storage.  Two
16591 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16592 @samp{gnu} dialect selects the original GNU scheme for supporting
16593 local and global dynamic TLS models.  The @samp{gnu2} dialect
16594 selects the GNU descriptor scheme, which provides better performance
16595 for shared libraries.  The GNU descriptor scheme is compatible with
16596 the original scheme, but does require new assembler, linker and
16597 library support.  Initial and local exec TLS models are unaffected by
16598 this option and always use the original scheme.
16600 @item -mword-relocations
16601 @opindex mword-relocations
16602 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16603 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16604 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16605 is specified.
16607 @item -mfix-cortex-m3-ldrd
16608 @opindex mfix-cortex-m3-ldrd
16609 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16610 with overlapping destination and base registers are used.  This option avoids
16611 generating these instructions.  This option is enabled by default when
16612 @option{-mcpu=cortex-m3} is specified.
16614 @item -munaligned-access
16615 @itemx -mno-unaligned-access
16616 @opindex munaligned-access
16617 @opindex mno-unaligned-access
16618 Enables (or disables) reading and writing of 16- and 32- bit values
16619 from addresses that are not 16- or 32- bit aligned.  By default
16620 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16621 ARMv8-M Baseline architectures, and enabled for all other
16622 architectures.  If unaligned access is not enabled then words in packed
16623 data structures are accessed a byte at a time.
16625 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16626 generated object file to either true or false, depending upon the
16627 setting of this option.  If unaligned access is enabled then the
16628 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16629 defined.
16631 @item -mneon-for-64bits
16632 @opindex mneon-for-64bits
16633 Enables using Neon to handle scalar 64-bits operations. This is
16634 disabled by default since the cost of moving data from core registers
16635 to Neon is high.
16637 @item -mslow-flash-data
16638 @opindex mslow-flash-data
16639 Assume loading data from flash is slower than fetching instruction.
16640 Therefore literal load is minimized for better performance.
16641 This option is only supported when compiling for ARMv7 M-profile and
16642 off by default.
16644 @item -masm-syntax-unified
16645 @opindex masm-syntax-unified
16646 Assume inline assembler is using unified asm syntax.  The default is
16647 currently off which implies divided syntax.  This option has no impact
16648 on Thumb2. However, this may change in future releases of GCC.
16649 Divided syntax should be considered deprecated.
16651 @item -mrestrict-it
16652 @opindex mrestrict-it
16653 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16654 IT blocks can only contain a single 16-bit instruction from a select
16655 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16657 @item -mprint-tune-info
16658 @opindex mprint-tune-info
16659 Print CPU tuning information as comment in assembler file.  This is
16660 an option used only for regression testing of the compiler and not
16661 intended for ordinary use in compiling code.  This option is disabled
16662 by default.
16664 @item -mverbose-cost-dump
16665 @opindex mverbose-cost-dump
16666 Enable verbose cost model dumping in the debug dump files.  This option is
16667 provided for use in debugging the compiler.
16669 @item -mpure-code
16670 @opindex mpure-code
16671 Do not allow constant data to be placed in code sections.
16672 Additionally, when compiling for ELF object format give all text sections the
16673 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16674 is only available when generating non-pic code for M-profile targets with the
16675 MOVT instruction.
16677 @item -mcmse
16678 @opindex mcmse
16679 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16680 Development Tools Engineering Specification", which can be found on
16681 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16682 @end table
16684 @node AVR Options
16685 @subsection AVR Options
16686 @cindex AVR Options
16688 These options are defined for AVR implementations:
16690 @table @gcctabopt
16691 @item -mmcu=@var{mcu}
16692 @opindex mmcu
16693 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16695 The default for this option is@tie{}@samp{avr2}.
16697 GCC supports the following AVR devices and ISAs:
16699 @include avr-mmcu.texi
16701 @item -mabsdata
16702 @opindex mabsdata
16704 Assume that all data in static storage can be accessed by LDS / STS
16705 instructions.  This option has only an effect on reduced Tiny devices like
16706 ATtiny40.  See also the @code{absdata}
16707 @ref{AVR Variable Attributes,variable attribute}.
16709 @item -maccumulate-args
16710 @opindex maccumulate-args
16711 Accumulate outgoing function arguments and acquire/release the needed
16712 stack space for outgoing function arguments once in function
16713 prologue/epilogue.  Without this option, outgoing arguments are pushed
16714 before calling a function and popped afterwards.
16716 Popping the arguments after the function call can be expensive on
16717 AVR so that accumulating the stack space might lead to smaller
16718 executables because arguments need not be removed from the
16719 stack after such a function call.
16721 This option can lead to reduced code size for functions that perform
16722 several calls to functions that get their arguments on the stack like
16723 calls to printf-like functions.
16725 @item -mbranch-cost=@var{cost}
16726 @opindex mbranch-cost
16727 Set the branch costs for conditional branch instructions to
16728 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16729 integers. The default branch cost is 0.
16731 @item -mcall-prologues
16732 @opindex mcall-prologues
16733 Functions prologues/epilogues are expanded as calls to appropriate
16734 subroutines.  Code size is smaller.
16736 @item -mgas-isr-prologues
16737 @opindex mgas-isr-prologues
16738 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16739 instruction supported by GNU Binutils.
16740 If this option is on, the feature can still be disabled for individual
16741 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16742 function attribute.  This feature is activated per default
16743 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16744 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16746 @item -mint8
16747 @opindex mint8
16748 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16749 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16750 and @code{long long} is 4 bytes.  Please note that this option does not
16751 conform to the C standards, but it results in smaller code
16752 size.
16754 @item -mmain-is-OS_task
16755 @opindex mmain-is-OS_task
16756 Do not save registers in @code{main}.  The effect is the same like
16757 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
16758 to @code{main}. It is activated per default if optimization is on.
16760 @item -mn-flash=@var{num}
16761 @opindex mn-flash
16762 Assume that the flash memory has a size of 
16763 @var{num} times 64@tie{}KiB.
16765 @item -mno-interrupts
16766 @opindex mno-interrupts
16767 Generated code is not compatible with hardware interrupts.
16768 Code size is smaller.
16770 @item -mrelax
16771 @opindex mrelax
16772 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16773 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16774 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16775 the assembler's command line and the @option{--relax} option to the
16776 linker's command line.
16778 Jump relaxing is performed by the linker because jump offsets are not
16779 known before code is located. Therefore, the assembler code generated by the
16780 compiler is the same, but the instructions in the executable may
16781 differ from instructions in the assembler code.
16783 Relaxing must be turned on if linker stubs are needed, see the
16784 section on @code{EIND} and linker stubs below.
16786 @item -mrmw
16787 @opindex mrmw
16788 Assume that the device supports the Read-Modify-Write
16789 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16791 @item -mshort-calls
16792 @opindex mshort-calls
16794 Assume that @code{RJMP} and @code{RCALL} can target the whole
16795 program memory.
16797 This option is used internally for multilib selection.  It is
16798 not an optimization option, and you don't need to set it by hand.
16800 @item -msp8
16801 @opindex msp8
16802 Treat the stack pointer register as an 8-bit register,
16803 i.e.@: assume the high byte of the stack pointer is zero.
16804 In general, you don't need to set this option by hand.
16806 This option is used internally by the compiler to select and
16807 build multilibs for architectures @code{avr2} and @code{avr25}.
16808 These architectures mix devices with and without @code{SPH}.
16809 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16810 the compiler driver adds or removes this option from the compiler
16811 proper's command line, because the compiler then knows if the device
16812 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16813 register or not.
16815 @item -mstrict-X
16816 @opindex mstrict-X
16817 Use address register @code{X} in a way proposed by the hardware.  This means
16818 that @code{X} is only used in indirect, post-increment or
16819 pre-decrement addressing.
16821 Without this option, the @code{X} register may be used in the same way
16822 as @code{Y} or @code{Z} which then is emulated by additional
16823 instructions.  
16824 For example, loading a value with @code{X+const} addressing with a
16825 small non-negative @code{const < 64} to a register @var{Rn} is
16826 performed as
16828 @example
16829 adiw r26, const   ; X += const
16830 ld   @var{Rn}, X        ; @var{Rn} = *X
16831 sbiw r26, const   ; X -= const
16832 @end example
16834 @item -mtiny-stack
16835 @opindex mtiny-stack
16836 Only change the lower 8@tie{}bits of the stack pointer.
16838 @item -mfract-convert-truncate
16839 @opindex mfract-convert-truncate
16840 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16842 @item -nodevicelib
16843 @opindex nodevicelib
16844 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16846 @item -Waddr-space-convert
16847 @opindex Waddr-space-convert
16848 Warn about conversions between address spaces in the case where the
16849 resulting address space is not contained in the incoming address space.
16851 @item -Wmisspelled-isr
16852 @opindex Wmisspelled-isr
16853 Warn if the ISR is misspelled, i.e. without __vector prefix.
16854 Enabled by default.
16855 @end table
16857 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16858 @cindex @code{EIND}
16859 Pointers in the implementation are 16@tie{}bits wide.
16860 The address of a function or label is represented as word address so
16861 that indirect jumps and calls can target any code address in the
16862 range of 64@tie{}Ki words.
16864 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16865 bytes of program memory space, there is a special function register called
16866 @code{EIND} that serves as most significant part of the target address
16867 when @code{EICALL} or @code{EIJMP} instructions are used.
16869 Indirect jumps and calls on these devices are handled as follows by
16870 the compiler and are subject to some limitations:
16872 @itemize @bullet
16874 @item
16875 The compiler never sets @code{EIND}.
16877 @item
16878 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16879 instructions or might read @code{EIND} directly in order to emulate an
16880 indirect call/jump by means of a @code{RET} instruction.
16882 @item
16883 The compiler assumes that @code{EIND} never changes during the startup
16884 code or during the application. In particular, @code{EIND} is not
16885 saved/restored in function or interrupt service routine
16886 prologue/epilogue.
16888 @item
16889 For indirect calls to functions and computed goto, the linker
16890 generates @emph{stubs}. Stubs are jump pads sometimes also called
16891 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16892 The stub contains a direct jump to the desired address.
16894 @item
16895 Linker relaxation must be turned on so that the linker generates
16896 the stubs correctly in all situations. See the compiler option
16897 @option{-mrelax} and the linker option @option{--relax}.
16898 There are corner cases where the linker is supposed to generate stubs
16899 but aborts without relaxation and without a helpful error message.
16901 @item
16902 The default linker script is arranged for code with @code{EIND = 0}.
16903 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16904 linker script has to be used in order to place the sections whose
16905 name start with @code{.trampolines} into the segment where @code{EIND}
16906 points to.
16908 @item
16909 The startup code from libgcc never sets @code{EIND}.
16910 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16911 For the impact of AVR-LibC on @code{EIND}, see the
16912 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16914 @item
16915 It is legitimate for user-specific startup code to set up @code{EIND}
16916 early, for example by means of initialization code located in
16917 section @code{.init3}. Such code runs prior to general startup code
16918 that initializes RAM and calls constructors, but after the bit
16919 of startup code from AVR-LibC that sets @code{EIND} to the segment
16920 where the vector table is located.
16921 @example
16922 #include <avr/io.h>
16924 static void
16925 __attribute__((section(".init3"),naked,used,no_instrument_function))
16926 init3_set_eind (void)
16928   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16929                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16931 @end example
16933 @noindent
16934 The @code{__trampolines_start} symbol is defined in the linker script.
16936 @item
16937 Stubs are generated automatically by the linker if
16938 the following two conditions are met:
16939 @itemize @minus
16941 @item The address of a label is taken by means of the @code{gs} modifier
16942 (short for @emph{generate stubs}) like so:
16943 @example
16944 LDI r24, lo8(gs(@var{func}))
16945 LDI r25, hi8(gs(@var{func}))
16946 @end example
16947 @item The final location of that label is in a code segment
16948 @emph{outside} the segment where the stubs are located.
16949 @end itemize
16951 @item
16952 The compiler emits such @code{gs} modifiers for code labels in the
16953 following situations:
16954 @itemize @minus
16955 @item Taking address of a function or code label.
16956 @item Computed goto.
16957 @item If prologue-save function is used, see @option{-mcall-prologues}
16958 command-line option.
16959 @item Switch/case dispatch tables. If you do not want such dispatch
16960 tables you can specify the @option{-fno-jump-tables} command-line option.
16961 @item C and C++ constructors/destructors called during startup/shutdown.
16962 @item If the tools hit a @code{gs()} modifier explained above.
16963 @end itemize
16965 @item
16966 Jumping to non-symbolic addresses like so is @emph{not} supported:
16968 @example
16969 int main (void)
16971     /* Call function at word address 0x2 */
16972     return ((int(*)(void)) 0x2)();
16974 @end example
16976 Instead, a stub has to be set up, i.e.@: the function has to be called
16977 through a symbol (@code{func_4} in the example):
16979 @example
16980 int main (void)
16982     extern int func_4 (void);
16984     /* Call function at byte address 0x4 */
16985     return func_4();
16987 @end example
16989 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16990 Alternatively, @code{func_4} can be defined in the linker script.
16991 @end itemize
16993 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16994 @cindex @code{RAMPD}
16995 @cindex @code{RAMPX}
16996 @cindex @code{RAMPY}
16997 @cindex @code{RAMPZ}
16998 Some AVR devices support memories larger than the 64@tie{}KiB range
16999 that can be accessed with 16-bit pointers.  To access memory locations
17000 outside this 64@tie{}KiB range, the content of a @code{RAMP}
17001 register is used as high part of the address:
17002 The @code{X}, @code{Y}, @code{Z} address register is concatenated
17003 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
17004 register, respectively, to get a wide address. Similarly,
17005 @code{RAMPD} is used together with direct addressing.
17007 @itemize
17008 @item
17009 The startup code initializes the @code{RAMP} special function
17010 registers with zero.
17012 @item
17013 If a @ref{AVR Named Address Spaces,named address space} other than
17014 generic or @code{__flash} is used, then @code{RAMPZ} is set
17015 as needed before the operation.
17017 @item
17018 If the device supports RAM larger than 64@tie{}KiB and the compiler
17019 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
17020 is reset to zero after the operation.
17022 @item
17023 If the device comes with a specific @code{RAMP} register, the ISR
17024 prologue/epilogue saves/restores that SFR and initializes it with
17025 zero in case the ISR code might (implicitly) use it.
17027 @item
17028 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
17029 If you use inline assembler to read from locations outside the
17030 16-bit address range and change one of the @code{RAMP} registers,
17031 you must reset it to zero after the access.
17033 @end itemize
17035 @subsubsection AVR Built-in Macros
17037 GCC defines several built-in macros so that the user code can test
17038 for the presence or absence of features.  Almost any of the following
17039 built-in macros are deduced from device capabilities and thus
17040 triggered by the @option{-mmcu=} command-line option.
17042 For even more AVR-specific built-in macros see
17043 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
17045 @table @code
17047 @item __AVR_ARCH__
17048 Build-in macro that resolves to a decimal number that identifies the
17049 architecture and depends on the @option{-mmcu=@var{mcu}} option.
17050 Possible values are:
17052 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
17053 @code{4}, @code{5}, @code{51}, @code{6}
17055 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
17056 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
17058 respectively and
17060 @code{100},
17061 @code{102}, @code{103}, @code{104},
17062 @code{105}, @code{106}, @code{107}
17064 for @var{mcu}=@code{avrtiny},
17065 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
17066 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
17067 If @var{mcu} specifies a device, this built-in macro is set
17068 accordingly. For example, with @option{-mmcu=atmega8} the macro is
17069 defined to @code{4}.
17071 @item __AVR_@var{Device}__
17072 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
17073 the device's name. For example, @option{-mmcu=atmega8} defines the
17074 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
17075 @code{__AVR_ATtiny261A__}, etc.
17077 The built-in macros' names follow
17078 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
17079 the device name as from the AVR user manual. The difference between
17080 @var{Device} in the built-in macro and @var{device} in
17081 @option{-mmcu=@var{device}} is that the latter is always lowercase.
17083 If @var{device} is not a device but only a core architecture like
17084 @samp{avr51}, this macro is not defined.
17086 @item __AVR_DEVICE_NAME__
17087 Setting @option{-mmcu=@var{device}} defines this built-in macro to
17088 the device's name. For example, with @option{-mmcu=atmega8} the macro
17089 is defined to @code{atmega8}.
17091 If @var{device} is not a device but only a core architecture like
17092 @samp{avr51}, this macro is not defined.
17094 @item __AVR_XMEGA__
17095 The device / architecture belongs to the XMEGA family of devices.
17097 @item __AVR_HAVE_ELPM__
17098 The device has the @code{ELPM} instruction.
17100 @item __AVR_HAVE_ELPMX__
17101 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
17102 R@var{n},Z+} instructions.
17104 @item __AVR_HAVE_MOVW__
17105 The device has the @code{MOVW} instruction to perform 16-bit
17106 register-register moves.
17108 @item __AVR_HAVE_LPMX__
17109 The device has the @code{LPM R@var{n},Z} and
17110 @code{LPM R@var{n},Z+} instructions.
17112 @item __AVR_HAVE_MUL__
17113 The device has a hardware multiplier. 
17115 @item __AVR_HAVE_JMP_CALL__
17116 The device has the @code{JMP} and @code{CALL} instructions.
17117 This is the case for devices with more than 8@tie{}KiB of program
17118 memory.
17120 @item __AVR_HAVE_EIJMP_EICALL__
17121 @itemx __AVR_3_BYTE_PC__
17122 The device has the @code{EIJMP} and @code{EICALL} instructions.
17123 This is the case for devices with more than 128@tie{}KiB of program memory.
17124 This also means that the program counter
17125 (PC) is 3@tie{}bytes wide.
17127 @item __AVR_2_BYTE_PC__
17128 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
17129 with up to 128@tie{}KiB of program memory.
17131 @item __AVR_HAVE_8BIT_SP__
17132 @itemx __AVR_HAVE_16BIT_SP__
17133 The stack pointer (SP) register is treated as 8-bit respectively
17134 16-bit register by the compiler.
17135 The definition of these macros is affected by @option{-mtiny-stack}.
17137 @item __AVR_HAVE_SPH__
17138 @itemx __AVR_SP8__
17139 The device has the SPH (high part of stack pointer) special function
17140 register or has an 8-bit stack pointer, respectively.
17141 The definition of these macros is affected by @option{-mmcu=} and
17142 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
17143 by @option{-msp8}.
17145 @item __AVR_HAVE_RAMPD__
17146 @itemx __AVR_HAVE_RAMPX__
17147 @itemx __AVR_HAVE_RAMPY__
17148 @itemx __AVR_HAVE_RAMPZ__
17149 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
17150 @code{RAMPZ} special function register, respectively.
17152 @item __NO_INTERRUPTS__
17153 This macro reflects the @option{-mno-interrupts} command-line option.
17155 @item __AVR_ERRATA_SKIP__
17156 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
17157 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
17158 instructions because of a hardware erratum.  Skip instructions are
17159 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
17160 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
17161 set.
17163 @item __AVR_ISA_RMW__
17164 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
17166 @item __AVR_SFR_OFFSET__=@var{offset}
17167 Instructions that can address I/O special function registers directly
17168 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
17169 address as if addressed by an instruction to access RAM like @code{LD}
17170 or @code{STS}. This offset depends on the device architecture and has
17171 to be subtracted from the RAM address in order to get the
17172 respective I/O@tie{}address.
17174 @item __AVR_SHORT_CALLS__
17175 The @option{-mshort-calls} command line option is set.
17177 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
17178 Some devices support reading from flash memory by means of @code{LD*}
17179 instructions.  The flash memory is seen in the data address space
17180 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
17181 is not defined, this feature is not available.  If defined,
17182 the address space is linear and there is no need to put
17183 @code{.rodata} into RAM.  This is handled by the default linker
17184 description file, and is currently available for
17185 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
17186 there is no need to use address spaces like @code{__flash} or
17187 features like attribute @code{progmem} and @code{pgm_read_*}.
17189 @item __WITH_AVRLIBC__
17190 The compiler is configured to be used together with AVR-Libc.
17191 See the @option{--with-avrlibc} configure option.
17193 @end table
17195 @node Blackfin Options
17196 @subsection Blackfin Options
17197 @cindex Blackfin Options
17199 @table @gcctabopt
17200 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
17201 @opindex mcpu=
17202 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
17203 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
17204 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
17205 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
17206 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
17207 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
17208 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
17209 @samp{bf561}, @samp{bf592}.
17211 The optional @var{sirevision} specifies the silicon revision of the target
17212 Blackfin processor.  Any workarounds available for the targeted silicon revision
17213 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
17214 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
17215 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
17216 hexadecimal digits representing the major and minor numbers in the silicon
17217 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
17218 is not defined.  If @var{sirevision} is @samp{any}, the
17219 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
17220 If this optional @var{sirevision} is not used, GCC assumes the latest known
17221 silicon revision of the targeted Blackfin processor.
17223 GCC defines a preprocessor macro for the specified @var{cpu}.
17224 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
17225 provided by libgloss to be linked in if @option{-msim} is not given.
17227 Without this option, @samp{bf532} is used as the processor by default.
17229 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
17230 only the preprocessor macro is defined.
17232 @item -msim
17233 @opindex msim
17234 Specifies that the program will be run on the simulator.  This causes
17235 the simulator BSP provided by libgloss to be linked in.  This option
17236 has effect only for @samp{bfin-elf} toolchain.
17237 Certain other options, such as @option{-mid-shared-library} and
17238 @option{-mfdpic}, imply @option{-msim}.
17240 @item -momit-leaf-frame-pointer
17241 @opindex momit-leaf-frame-pointer
17242 Don't keep the frame pointer in a register for leaf functions.  This
17243 avoids the instructions to save, set up and restore frame pointers and
17244 makes an extra register available in leaf functions.
17246 @item -mspecld-anomaly
17247 @opindex mspecld-anomaly
17248 When enabled, the compiler ensures that the generated code does not
17249 contain speculative loads after jump instructions. If this option is used,
17250 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
17252 @item -mno-specld-anomaly
17253 @opindex mno-specld-anomaly
17254 Don't generate extra code to prevent speculative loads from occurring.
17256 @item -mcsync-anomaly
17257 @opindex mcsync-anomaly
17258 When enabled, the compiler ensures that the generated code does not
17259 contain CSYNC or SSYNC instructions too soon after conditional branches.
17260 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
17262 @item -mno-csync-anomaly
17263 @opindex mno-csync-anomaly
17264 Don't generate extra code to prevent CSYNC or SSYNC instructions from
17265 occurring too soon after a conditional branch.
17267 @item -mlow-64k
17268 @opindex mlow-64k
17269 When enabled, the compiler is free to take advantage of the knowledge that
17270 the entire program fits into the low 64k of memory.
17272 @item -mno-low-64k
17273 @opindex mno-low-64k
17274 Assume that the program is arbitrarily large.  This is the default.
17276 @item -mstack-check-l1
17277 @opindex mstack-check-l1
17278 Do stack checking using information placed into L1 scratchpad memory by the
17279 uClinux kernel.
17281 @item -mid-shared-library
17282 @opindex mid-shared-library
17283 Generate code that supports shared libraries via the library ID method.
17284 This allows for execute in place and shared libraries in an environment
17285 without virtual memory management.  This option implies @option{-fPIC}.
17286 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17288 @item -mno-id-shared-library
17289 @opindex mno-id-shared-library
17290 Generate code that doesn't assume ID-based shared libraries are being used.
17291 This is the default.
17293 @item -mleaf-id-shared-library
17294 @opindex mleaf-id-shared-library
17295 Generate code that supports shared libraries via the library ID method,
17296 but assumes that this library or executable won't link against any other
17297 ID shared libraries.  That allows the compiler to use faster code for jumps
17298 and calls.
17300 @item -mno-leaf-id-shared-library
17301 @opindex mno-leaf-id-shared-library
17302 Do not assume that the code being compiled won't link against any ID shared
17303 libraries.  Slower code is generated for jump and call insns.
17305 @item -mshared-library-id=n
17306 @opindex mshared-library-id
17307 Specifies the identification number of the ID-based shared library being
17308 compiled.  Specifying a value of 0 generates more compact code; specifying
17309 other values forces the allocation of that number to the current
17310 library but is no more space- or time-efficient than omitting this option.
17312 @item -msep-data
17313 @opindex msep-data
17314 Generate code that allows the data segment to be located in a different
17315 area of memory from the text segment.  This allows for execute in place in
17316 an environment without virtual memory management by eliminating relocations
17317 against the text section.
17319 @item -mno-sep-data
17320 @opindex mno-sep-data
17321 Generate code that assumes that the data segment follows the text segment.
17322 This is the default.
17324 @item -mlong-calls
17325 @itemx -mno-long-calls
17326 @opindex mlong-calls
17327 @opindex mno-long-calls
17328 Tells the compiler to perform function calls by first loading the
17329 address of the function into a register and then performing a subroutine
17330 call on this register.  This switch is needed if the target function
17331 lies outside of the 24-bit addressing range of the offset-based
17332 version of subroutine call instruction.
17334 This feature is not enabled by default.  Specifying
17335 @option{-mno-long-calls} restores the default behavior.  Note these
17336 switches have no effect on how the compiler generates code to handle
17337 function calls via function pointers.
17339 @item -mfast-fp
17340 @opindex mfast-fp
17341 Link with the fast floating-point library. This library relaxes some of
17342 the IEEE floating-point standard's rules for checking inputs against
17343 Not-a-Number (NAN), in the interest of performance.
17345 @item -minline-plt
17346 @opindex minline-plt
17347 Enable inlining of PLT entries in function calls to functions that are
17348 not known to bind locally.  It has no effect without @option{-mfdpic}.
17350 @item -mmulticore
17351 @opindex mmulticore
17352 Build a standalone application for multicore Blackfin processors. 
17353 This option causes proper start files and link scripts supporting 
17354 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17355 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17357 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17358 selects the one-application-per-core programming model.  Without
17359 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17360 programming model is used. In this model, the main function of Core B
17361 should be named as @code{coreb_main}.
17363 If this option is not used, the single-core application programming
17364 model is used.
17366 @item -mcorea
17367 @opindex mcorea
17368 Build a standalone application for Core A of BF561 when using
17369 the one-application-per-core programming model. Proper start files
17370 and link scripts are used to support Core A, and the macro
17371 @code{__BFIN_COREA} is defined.
17372 This option can only be used in conjunction with @option{-mmulticore}.
17374 @item -mcoreb
17375 @opindex mcoreb
17376 Build a standalone application for Core B of BF561 when using
17377 the one-application-per-core programming model. Proper start files
17378 and link scripts are used to support Core B, and the macro
17379 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17380 should be used instead of @code{main}. 
17381 This option can only be used in conjunction with @option{-mmulticore}.
17383 @item -msdram
17384 @opindex msdram
17385 Build a standalone application for SDRAM. Proper start files and
17386 link scripts are used to put the application into SDRAM, and the macro
17387 @code{__BFIN_SDRAM} is defined.
17388 The loader should initialize SDRAM before loading the application.
17390 @item -micplb
17391 @opindex micplb
17392 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17393 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17394 are enabled; for standalone applications the default is off.
17395 @end table
17397 @node C6X Options
17398 @subsection C6X Options
17399 @cindex C6X Options
17401 @table @gcctabopt
17402 @item -march=@var{name}
17403 @opindex march
17404 This specifies the name of the target architecture.  GCC uses this
17405 name to determine what kind of instructions it can emit when generating
17406 assembly code.  Permissible names are: @samp{c62x},
17407 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17409 @item -mbig-endian
17410 @opindex mbig-endian
17411 Generate code for a big-endian target.
17413 @item -mlittle-endian
17414 @opindex mlittle-endian
17415 Generate code for a little-endian target.  This is the default.
17417 @item -msim
17418 @opindex msim
17419 Choose startup files and linker script suitable for the simulator.
17421 @item -msdata=default
17422 @opindex msdata=default
17423 Put small global and static data in the @code{.neardata} section,
17424 which is pointed to by register @code{B14}.  Put small uninitialized
17425 global and static data in the @code{.bss} section, which is adjacent
17426 to the @code{.neardata} section.  Put small read-only data into the
17427 @code{.rodata} section.  The corresponding sections used for large
17428 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17430 @item -msdata=all
17431 @opindex msdata=all
17432 Put all data, not just small objects, into the sections reserved for
17433 small data, and use addressing relative to the @code{B14} register to
17434 access them.
17436 @item -msdata=none
17437 @opindex msdata=none
17438 Make no use of the sections reserved for small data, and use absolute
17439 addresses to access all data.  Put all initialized global and static
17440 data in the @code{.fardata} section, and all uninitialized data in the
17441 @code{.far} section.  Put all constant data into the @code{.const}
17442 section.
17443 @end table
17445 @node CRIS Options
17446 @subsection CRIS Options
17447 @cindex CRIS Options
17449 These options are defined specifically for the CRIS ports.
17451 @table @gcctabopt
17452 @item -march=@var{architecture-type}
17453 @itemx -mcpu=@var{architecture-type}
17454 @opindex march
17455 @opindex mcpu
17456 Generate code for the specified architecture.  The choices for
17457 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17458 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17459 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17460 @samp{v10}.
17462 @item -mtune=@var{architecture-type}
17463 @opindex mtune
17464 Tune to @var{architecture-type} everything applicable about the generated
17465 code, except for the ABI and the set of available instructions.  The
17466 choices for @var{architecture-type} are the same as for
17467 @option{-march=@var{architecture-type}}.
17469 @item -mmax-stack-frame=@var{n}
17470 @opindex mmax-stack-frame
17471 Warn when the stack frame of a function exceeds @var{n} bytes.
17473 @item -metrax4
17474 @itemx -metrax100
17475 @opindex metrax4
17476 @opindex metrax100
17477 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17478 @option{-march=v3} and @option{-march=v8} respectively.
17480 @item -mmul-bug-workaround
17481 @itemx -mno-mul-bug-workaround
17482 @opindex mmul-bug-workaround
17483 @opindex mno-mul-bug-workaround
17484 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17485 models where it applies.  This option is active by default.
17487 @item -mpdebug
17488 @opindex mpdebug
17489 Enable CRIS-specific verbose debug-related information in the assembly
17490 code.  This option also has the effect of turning off the @samp{#NO_APP}
17491 formatted-code indicator to the assembler at the beginning of the
17492 assembly file.
17494 @item -mcc-init
17495 @opindex mcc-init
17496 Do not use condition-code results from previous instruction; always emit
17497 compare and test instructions before use of condition codes.
17499 @item -mno-side-effects
17500 @opindex mno-side-effects
17501 Do not emit instructions with side effects in addressing modes other than
17502 post-increment.
17504 @item -mstack-align
17505 @itemx -mno-stack-align
17506 @itemx -mdata-align
17507 @itemx -mno-data-align
17508 @itemx -mconst-align
17509 @itemx -mno-const-align
17510 @opindex mstack-align
17511 @opindex mno-stack-align
17512 @opindex mdata-align
17513 @opindex mno-data-align
17514 @opindex mconst-align
17515 @opindex mno-const-align
17516 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17517 stack frame, individual data and constants to be aligned for the maximum
17518 single data access size for the chosen CPU model.  The default is to
17519 arrange for 32-bit alignment.  ABI details such as structure layout are
17520 not affected by these options.
17522 @item -m32-bit
17523 @itemx -m16-bit
17524 @itemx -m8-bit
17525 @opindex m32-bit
17526 @opindex m16-bit
17527 @opindex m8-bit
17528 Similar to the stack- data- and const-align options above, these options
17529 arrange for stack frame, writable data and constants to all be 32-bit,
17530 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17532 @item -mno-prologue-epilogue
17533 @itemx -mprologue-epilogue
17534 @opindex mno-prologue-epilogue
17535 @opindex mprologue-epilogue
17536 With @option{-mno-prologue-epilogue}, the normal function prologue and
17537 epilogue which set up the stack frame are omitted and no return
17538 instructions or return sequences are generated in the code.  Use this
17539 option only together with visual inspection of the compiled code: no
17540 warnings or errors are generated when call-saved registers must be saved,
17541 or storage for local variables needs to be allocated.
17543 @item -mno-gotplt
17544 @itemx -mgotplt
17545 @opindex mno-gotplt
17546 @opindex mgotplt
17547 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17548 instruction sequences that load addresses for functions from the PLT part
17549 of the GOT rather than (traditional on other architectures) calls to the
17550 PLT@.  The default is @option{-mgotplt}.
17552 @item -melf
17553 @opindex melf
17554 Legacy no-op option only recognized with the cris-axis-elf and
17555 cris-axis-linux-gnu targets.
17557 @item -mlinux
17558 @opindex mlinux
17559 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17561 @item -sim
17562 @opindex sim
17563 This option, recognized for the cris-axis-elf, arranges
17564 to link with input-output functions from a simulator library.  Code,
17565 initialized data and zero-initialized data are allocated consecutively.
17567 @item -sim2
17568 @opindex sim2
17569 Like @option{-sim}, but pass linker options to locate initialized data at
17570 0x40000000 and zero-initialized data at 0x80000000.
17571 @end table
17573 @node CR16 Options
17574 @subsection CR16 Options
17575 @cindex CR16 Options
17577 These options are defined specifically for the CR16 ports.
17579 @table @gcctabopt
17581 @item -mmac
17582 @opindex mmac
17583 Enable the use of multiply-accumulate instructions. Disabled by default.
17585 @item -mcr16cplus
17586 @itemx -mcr16c
17587 @opindex mcr16cplus
17588 @opindex mcr16c
17589 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17590 is default.
17592 @item -msim
17593 @opindex msim
17594 Links the library libsim.a which is in compatible with simulator. Applicable
17595 to ELF compiler only.
17597 @item -mint32
17598 @opindex mint32
17599 Choose integer type as 32-bit wide.
17601 @item -mbit-ops
17602 @opindex mbit-ops
17603 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17605 @item -mdata-model=@var{model}
17606 @opindex mdata-model
17607 Choose a data model. The choices for @var{model} are @samp{near},
17608 @samp{far} or @samp{medium}. @samp{medium} is default.
17609 However, @samp{far} is not valid with @option{-mcr16c}, as the
17610 CR16C architecture does not support the far data model.
17611 @end table
17613 @node Darwin Options
17614 @subsection Darwin Options
17615 @cindex Darwin options
17617 These options are defined for all architectures running the Darwin operating
17618 system.
17620 FSF GCC on Darwin does not create ``fat'' object files; it creates
17621 an object file for the single architecture that GCC was built to
17622 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17623 @option{-arch} options are used; it does so by running the compiler or
17624 linker multiple times and joining the results together with
17625 @file{lipo}.
17627 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17628 @samp{i686}) is determined by the flags that specify the ISA
17629 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17630 @option{-force_cpusubtype_ALL} option can be used to override this.
17632 The Darwin tools vary in their behavior when presented with an ISA
17633 mismatch.  The assembler, @file{as}, only permits instructions to
17634 be used that are valid for the subtype of the file it is generating,
17635 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17636 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17637 and prints an error if asked to create a shared library with a less
17638 restrictive subtype than its input files (for instance, trying to put
17639 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17640 for executables, @command{ld}, quietly gives the executable the most
17641 restrictive subtype of any of its input files.
17643 @table @gcctabopt
17644 @item -F@var{dir}
17645 @opindex F
17646 Add the framework directory @var{dir} to the head of the list of
17647 directories to be searched for header files.  These directories are
17648 interleaved with those specified by @option{-I} options and are
17649 scanned in a left-to-right order.
17651 A framework directory is a directory with frameworks in it.  A
17652 framework is a directory with a @file{Headers} and/or
17653 @file{PrivateHeaders} directory contained directly in it that ends
17654 in @file{.framework}.  The name of a framework is the name of this
17655 directory excluding the @file{.framework}.  Headers associated with
17656 the framework are found in one of those two directories, with
17657 @file{Headers} being searched first.  A subframework is a framework
17658 directory that is in a framework's @file{Frameworks} directory.
17659 Includes of subframework headers can only appear in a header of a
17660 framework that contains the subframework, or in a sibling subframework
17661 header.  Two subframeworks are siblings if they occur in the same
17662 framework.  A subframework should not have the same name as a
17663 framework; a warning is issued if this is violated.  Currently a
17664 subframework cannot have subframeworks; in the future, the mechanism
17665 may be extended to support this.  The standard frameworks can be found
17666 in @file{/System/Library/Frameworks} and
17667 @file{/Library/Frameworks}.  An example include looks like
17668 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17669 the name of the framework and @file{header.h} is found in the
17670 @file{PrivateHeaders} or @file{Headers} directory.
17672 @item -iframework@var{dir}
17673 @opindex iframework
17674 Like @option{-F} except the directory is a treated as a system
17675 directory.  The main difference between this @option{-iframework} and
17676 @option{-F} is that with @option{-iframework} the compiler does not
17677 warn about constructs contained within header files found via
17678 @var{dir}.  This option is valid only for the C family of languages.
17680 @item -gused
17681 @opindex gused
17682 Emit debugging information for symbols that are used.  For stabs
17683 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17684 This is by default ON@.
17686 @item -gfull
17687 @opindex gfull
17688 Emit debugging information for all symbols and types.
17690 @item -mmacosx-version-min=@var{version}
17691 The earliest version of MacOS X that this executable will run on
17692 is @var{version}.  Typical values of @var{version} include @code{10.1},
17693 @code{10.2}, and @code{10.3.9}.
17695 If the compiler was built to use the system's headers by default,
17696 then the default for this option is the system version on which the
17697 compiler is running, otherwise the default is to make choices that
17698 are compatible with as many systems and code bases as possible.
17700 @item -mkernel
17701 @opindex mkernel
17702 Enable kernel development mode.  The @option{-mkernel} option sets
17703 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17704 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17705 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17706 applicable.  This mode also sets @option{-mno-altivec},
17707 @option{-msoft-float}, @option{-fno-builtin} and
17708 @option{-mlong-branch} for PowerPC targets.
17710 @item -mone-byte-bool
17711 @opindex mone-byte-bool
17712 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17713 By default @code{sizeof(bool)} is @code{4} when compiling for
17714 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17715 option has no effect on x86.
17717 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17718 to generate code that is not binary compatible with code generated
17719 without that switch.  Using this switch may require recompiling all
17720 other modules in a program, including system libraries.  Use this
17721 switch to conform to a non-default data model.
17723 @item -mfix-and-continue
17724 @itemx -ffix-and-continue
17725 @itemx -findirect-data
17726 @opindex mfix-and-continue
17727 @opindex ffix-and-continue
17728 @opindex findirect-data
17729 Generate code suitable for fast turnaround development, such as to
17730 allow GDB to dynamically load @file{.o} files into already-running
17731 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17732 are provided for backwards compatibility.
17734 @item -all_load
17735 @opindex all_load
17736 Loads all members of static archive libraries.
17737 See man ld(1) for more information.
17739 @item -arch_errors_fatal
17740 @opindex arch_errors_fatal
17741 Cause the errors having to do with files that have the wrong architecture
17742 to be fatal.
17744 @item -bind_at_load
17745 @opindex bind_at_load
17746 Causes the output file to be marked such that the dynamic linker will
17747 bind all undefined references when the file is loaded or launched.
17749 @item -bundle
17750 @opindex bundle
17751 Produce a Mach-o bundle format file.
17752 See man ld(1) for more information.
17754 @item -bundle_loader @var{executable}
17755 @opindex bundle_loader
17756 This option specifies the @var{executable} that will load the build
17757 output file being linked.  See man ld(1) for more information.
17759 @item -dynamiclib
17760 @opindex dynamiclib
17761 When passed this option, GCC produces a dynamic library instead of
17762 an executable when linking, using the Darwin @file{libtool} command.
17764 @item -force_cpusubtype_ALL
17765 @opindex force_cpusubtype_ALL
17766 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17767 one controlled by the @option{-mcpu} or @option{-march} option.
17769 @item -allowable_client  @var{client_name}
17770 @itemx -client_name
17771 @itemx -compatibility_version
17772 @itemx -current_version
17773 @itemx -dead_strip
17774 @itemx -dependency-file
17775 @itemx -dylib_file
17776 @itemx -dylinker_install_name
17777 @itemx -dynamic
17778 @itemx -exported_symbols_list
17779 @itemx -filelist
17780 @need 800
17781 @itemx -flat_namespace
17782 @itemx -force_flat_namespace
17783 @itemx -headerpad_max_install_names
17784 @itemx -image_base
17785 @itemx -init
17786 @itemx -install_name
17787 @itemx -keep_private_externs
17788 @itemx -multi_module
17789 @itemx -multiply_defined
17790 @itemx -multiply_defined_unused
17791 @need 800
17792 @itemx -noall_load
17793 @itemx -no_dead_strip_inits_and_terms
17794 @itemx -nofixprebinding
17795 @itemx -nomultidefs
17796 @itemx -noprebind
17797 @itemx -noseglinkedit
17798 @itemx -pagezero_size
17799 @itemx -prebind
17800 @itemx -prebind_all_twolevel_modules
17801 @itemx -private_bundle
17802 @need 800
17803 @itemx -read_only_relocs
17804 @itemx -sectalign
17805 @itemx -sectobjectsymbols
17806 @itemx -whyload
17807 @itemx -seg1addr
17808 @itemx -sectcreate
17809 @itemx -sectobjectsymbols
17810 @itemx -sectorder
17811 @itemx -segaddr
17812 @itemx -segs_read_only_addr
17813 @need 800
17814 @itemx -segs_read_write_addr
17815 @itemx -seg_addr_table
17816 @itemx -seg_addr_table_filename
17817 @itemx -seglinkedit
17818 @itemx -segprot
17819 @itemx -segs_read_only_addr
17820 @itemx -segs_read_write_addr
17821 @itemx -single_module
17822 @itemx -static
17823 @itemx -sub_library
17824 @need 800
17825 @itemx -sub_umbrella
17826 @itemx -twolevel_namespace
17827 @itemx -umbrella
17828 @itemx -undefined
17829 @itemx -unexported_symbols_list
17830 @itemx -weak_reference_mismatches
17831 @itemx -whatsloaded
17832 @opindex allowable_client
17833 @opindex client_name
17834 @opindex compatibility_version
17835 @opindex current_version
17836 @opindex dead_strip
17837 @opindex dependency-file
17838 @opindex dylib_file
17839 @opindex dylinker_install_name
17840 @opindex dynamic
17841 @opindex exported_symbols_list
17842 @opindex filelist
17843 @opindex flat_namespace
17844 @opindex force_flat_namespace
17845 @opindex headerpad_max_install_names
17846 @opindex image_base
17847 @opindex init
17848 @opindex install_name
17849 @opindex keep_private_externs
17850 @opindex multi_module
17851 @opindex multiply_defined
17852 @opindex multiply_defined_unused
17853 @opindex noall_load
17854 @opindex no_dead_strip_inits_and_terms
17855 @opindex nofixprebinding
17856 @opindex nomultidefs
17857 @opindex noprebind
17858 @opindex noseglinkedit
17859 @opindex pagezero_size
17860 @opindex prebind
17861 @opindex prebind_all_twolevel_modules
17862 @opindex private_bundle
17863 @opindex read_only_relocs
17864 @opindex sectalign
17865 @opindex sectobjectsymbols
17866 @opindex whyload
17867 @opindex seg1addr
17868 @opindex sectcreate
17869 @opindex sectobjectsymbols
17870 @opindex sectorder
17871 @opindex segaddr
17872 @opindex segs_read_only_addr
17873 @opindex segs_read_write_addr
17874 @opindex seg_addr_table
17875 @opindex seg_addr_table_filename
17876 @opindex seglinkedit
17877 @opindex segprot
17878 @opindex segs_read_only_addr
17879 @opindex segs_read_write_addr
17880 @opindex single_module
17881 @opindex static
17882 @opindex sub_library
17883 @opindex sub_umbrella
17884 @opindex twolevel_namespace
17885 @opindex umbrella
17886 @opindex undefined
17887 @opindex unexported_symbols_list
17888 @opindex weak_reference_mismatches
17889 @opindex whatsloaded
17890 These options are passed to the Darwin linker.  The Darwin linker man page
17891 describes them in detail.
17892 @end table
17894 @node DEC Alpha Options
17895 @subsection DEC Alpha Options
17897 These @samp{-m} options are defined for the DEC Alpha implementations:
17899 @table @gcctabopt
17900 @item -mno-soft-float
17901 @itemx -msoft-float
17902 @opindex mno-soft-float
17903 @opindex msoft-float
17904 Use (do not use) the hardware floating-point instructions for
17905 floating-point operations.  When @option{-msoft-float} is specified,
17906 functions in @file{libgcc.a} are used to perform floating-point
17907 operations.  Unless they are replaced by routines that emulate the
17908 floating-point operations, or compiled in such a way as to call such
17909 emulations routines, these routines issue floating-point
17910 operations.   If you are compiling for an Alpha without floating-point
17911 operations, you must ensure that the library is built so as not to call
17912 them.
17914 Note that Alpha implementations without floating-point operations are
17915 required to have floating-point registers.
17917 @item -mfp-reg
17918 @itemx -mno-fp-regs
17919 @opindex mfp-reg
17920 @opindex mno-fp-regs
17921 Generate code that uses (does not use) the floating-point register set.
17922 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17923 register set is not used, floating-point operands are passed in integer
17924 registers as if they were integers and floating-point results are passed
17925 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17926 so any function with a floating-point argument or return value called by code
17927 compiled with @option{-mno-fp-regs} must also be compiled with that
17928 option.
17930 A typical use of this option is building a kernel that does not use,
17931 and hence need not save and restore, any floating-point registers.
17933 @item -mieee
17934 @opindex mieee
17935 The Alpha architecture implements floating-point hardware optimized for
17936 maximum performance.  It is mostly compliant with the IEEE floating-point
17937 standard.  However, for full compliance, software assistance is
17938 required.  This option generates code fully IEEE-compliant code
17939 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17940 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17941 defined during compilation.  The resulting code is less efficient but is
17942 able to correctly support denormalized numbers and exceptional IEEE
17943 values such as not-a-number and plus/minus infinity.  Other Alpha
17944 compilers call this option @option{-ieee_with_no_inexact}.
17946 @item -mieee-with-inexact
17947 @opindex mieee-with-inexact
17948 This is like @option{-mieee} except the generated code also maintains
17949 the IEEE @var{inexact-flag}.  Turning on this option causes the
17950 generated code to implement fully-compliant IEEE math.  In addition to
17951 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17952 macro.  On some Alpha implementations the resulting code may execute
17953 significantly slower than the code generated by default.  Since there is
17954 very little code that depends on the @var{inexact-flag}, you should
17955 normally not specify this option.  Other Alpha compilers call this
17956 option @option{-ieee_with_inexact}.
17958 @item -mfp-trap-mode=@var{trap-mode}
17959 @opindex mfp-trap-mode
17960 This option controls what floating-point related traps are enabled.
17961 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17962 The trap mode can be set to one of four values:
17964 @table @samp
17965 @item n
17966 This is the default (normal) setting.  The only traps that are enabled
17967 are the ones that cannot be disabled in software (e.g., division by zero
17968 trap).
17970 @item u
17971 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17972 as well.
17974 @item su
17975 Like @samp{u}, but the instructions are marked to be safe for software
17976 completion (see Alpha architecture manual for details).
17978 @item sui
17979 Like @samp{su}, but inexact traps are enabled as well.
17980 @end table
17982 @item -mfp-rounding-mode=@var{rounding-mode}
17983 @opindex mfp-rounding-mode
17984 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17985 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17988 @table @samp
17989 @item n
17990 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17991 the nearest machine number or towards the even machine number in case
17992 of a tie.
17994 @item m
17995 Round towards minus infinity.
17997 @item c
17998 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
18000 @item d
18001 Dynamic rounding mode.  A field in the floating-point control register
18002 (@var{fpcr}, see Alpha architecture reference manual) controls the
18003 rounding mode in effect.  The C library initializes this register for
18004 rounding towards plus infinity.  Thus, unless your program modifies the
18005 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
18006 @end table
18008 @item -mtrap-precision=@var{trap-precision}
18009 @opindex mtrap-precision
18010 In the Alpha architecture, floating-point traps are imprecise.  This
18011 means without software assistance it is impossible to recover from a
18012 floating trap and program execution normally needs to be terminated.
18013 GCC can generate code that can assist operating system trap handlers
18014 in determining the exact location that caused a floating-point trap.
18015 Depending on the requirements of an application, different levels of
18016 precisions can be selected:
18018 @table @samp
18019 @item p
18020 Program precision.  This option is the default and means a trap handler
18021 can only identify which program caused a floating-point exception.
18023 @item f
18024 Function precision.  The trap handler can determine the function that
18025 caused a floating-point exception.
18027 @item i
18028 Instruction precision.  The trap handler can determine the exact
18029 instruction that caused a floating-point exception.
18030 @end table
18032 Other Alpha compilers provide the equivalent options called
18033 @option{-scope_safe} and @option{-resumption_safe}.
18035 @item -mieee-conformant
18036 @opindex mieee-conformant
18037 This option marks the generated code as IEEE conformant.  You must not
18038 use this option unless you also specify @option{-mtrap-precision=i} and either
18039 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
18040 is to emit the line @samp{.eflag 48} in the function prologue of the
18041 generated assembly file.
18043 @item -mbuild-constants
18044 @opindex mbuild-constants
18045 Normally GCC examines a 32- or 64-bit integer constant to
18046 see if it can construct it from smaller constants in two or three
18047 instructions.  If it cannot, it outputs the constant as a literal and
18048 generates code to load it from the data segment at run time.
18050 Use this option to require GCC to construct @emph{all} integer constants
18051 using code, even if it takes more instructions (the maximum is six).
18053 You typically use this option to build a shared library dynamic
18054 loader.  Itself a shared library, it must relocate itself in memory
18055 before it can find the variables and constants in its own data segment.
18057 @item -mbwx
18058 @itemx -mno-bwx
18059 @itemx -mcix
18060 @itemx -mno-cix
18061 @itemx -mfix
18062 @itemx -mno-fix
18063 @itemx -mmax
18064 @itemx -mno-max
18065 @opindex mbwx
18066 @opindex mno-bwx
18067 @opindex mcix
18068 @opindex mno-cix
18069 @opindex mfix
18070 @opindex mno-fix
18071 @opindex mmax
18072 @opindex mno-max
18073 Indicate whether GCC should generate code to use the optional BWX,
18074 CIX, FIX and MAX instruction sets.  The default is to use the instruction
18075 sets supported by the CPU type specified via @option{-mcpu=} option or that
18076 of the CPU on which GCC was built if none is specified.
18078 @item -mfloat-vax
18079 @itemx -mfloat-ieee
18080 @opindex mfloat-vax
18081 @opindex mfloat-ieee
18082 Generate code that uses (does not use) VAX F and G floating-point
18083 arithmetic instead of IEEE single and double precision.
18085 @item -mexplicit-relocs
18086 @itemx -mno-explicit-relocs
18087 @opindex mexplicit-relocs
18088 @opindex mno-explicit-relocs
18089 Older Alpha assemblers provided no way to generate symbol relocations
18090 except via assembler macros.  Use of these macros does not allow
18091 optimal instruction scheduling.  GNU binutils as of version 2.12
18092 supports a new syntax that allows the compiler to explicitly mark
18093 which relocations should apply to which instructions.  This option
18094 is mostly useful for debugging, as GCC detects the capabilities of
18095 the assembler when it is built and sets the default accordingly.
18097 @item -msmall-data
18098 @itemx -mlarge-data
18099 @opindex msmall-data
18100 @opindex mlarge-data
18101 When @option{-mexplicit-relocs} is in effect, static data is
18102 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
18103 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
18104 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
18105 16-bit relocations off of the @code{$gp} register.  This limits the
18106 size of the small data area to 64KB, but allows the variables to be
18107 directly accessed via a single instruction.
18109 The default is @option{-mlarge-data}.  With this option the data area
18110 is limited to just below 2GB@.  Programs that require more than 2GB of
18111 data must use @code{malloc} or @code{mmap} to allocate the data in the
18112 heap instead of in the program's data segment.
18114 When generating code for shared libraries, @option{-fpic} implies
18115 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
18117 @item -msmall-text
18118 @itemx -mlarge-text
18119 @opindex msmall-text
18120 @opindex mlarge-text
18121 When @option{-msmall-text} is used, the compiler assumes that the
18122 code of the entire program (or shared library) fits in 4MB, and is
18123 thus reachable with a branch instruction.  When @option{-msmall-data}
18124 is used, the compiler can assume that all local symbols share the
18125 same @code{$gp} value, and thus reduce the number of instructions
18126 required for a function call from 4 to 1.
18128 The default is @option{-mlarge-text}.
18130 @item -mcpu=@var{cpu_type}
18131 @opindex mcpu
18132 Set the instruction set and instruction scheduling parameters for
18133 machine type @var{cpu_type}.  You can specify either the @samp{EV}
18134 style name or the corresponding chip number.  GCC supports scheduling
18135 parameters for the EV4, EV5 and EV6 family of processors and
18136 chooses the default values for the instruction set from the processor
18137 you specify.  If you do not specify a processor type, GCC defaults
18138 to the processor on which the compiler was built.
18140 Supported values for @var{cpu_type} are
18142 @table @samp
18143 @item ev4
18144 @itemx ev45
18145 @itemx 21064
18146 Schedules as an EV4 and has no instruction set extensions.
18148 @item ev5
18149 @itemx 21164
18150 Schedules as an EV5 and has no instruction set extensions.
18152 @item ev56
18153 @itemx 21164a
18154 Schedules as an EV5 and supports the BWX extension.
18156 @item pca56
18157 @itemx 21164pc
18158 @itemx 21164PC
18159 Schedules as an EV5 and supports the BWX and MAX extensions.
18161 @item ev6
18162 @itemx 21264
18163 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
18165 @item ev67
18166 @itemx 21264a
18167 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
18168 @end table
18170 Native toolchains also support the value @samp{native},
18171 which selects the best architecture option for the host processor.
18172 @option{-mcpu=native} has no effect if GCC does not recognize
18173 the processor.
18175 @item -mtune=@var{cpu_type}
18176 @opindex mtune
18177 Set only the instruction scheduling parameters for machine type
18178 @var{cpu_type}.  The instruction set is not changed.
18180 Native toolchains also support the value @samp{native},
18181 which selects the best architecture option for the host processor.
18182 @option{-mtune=native} has no effect if GCC does not recognize
18183 the processor.
18185 @item -mmemory-latency=@var{time}
18186 @opindex mmemory-latency
18187 Sets the latency the scheduler should assume for typical memory
18188 references as seen by the application.  This number is highly
18189 dependent on the memory access patterns used by the application
18190 and the size of the external cache on the machine.
18192 Valid options for @var{time} are
18194 @table @samp
18195 @item @var{number}
18196 A decimal number representing clock cycles.
18198 @item L1
18199 @itemx L2
18200 @itemx L3
18201 @itemx main
18202 The compiler contains estimates of the number of clock cycles for
18203 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
18204 (also called Dcache, Scache, and Bcache), as well as to main memory.
18205 Note that L3 is only valid for EV5.
18207 @end table
18208 @end table
18210 @node FR30 Options
18211 @subsection FR30 Options
18212 @cindex FR30 Options
18214 These options are defined specifically for the FR30 port.
18216 @table @gcctabopt
18218 @item -msmall-model
18219 @opindex msmall-model
18220 Use the small address space model.  This can produce smaller code, but
18221 it does assume that all symbolic values and addresses fit into a
18222 20-bit range.
18224 @item -mno-lsim
18225 @opindex mno-lsim
18226 Assume that runtime support has been provided and so there is no need
18227 to include the simulator library (@file{libsim.a}) on the linker
18228 command line.
18230 @end table
18232 @node FT32 Options
18233 @subsection FT32 Options
18234 @cindex FT32 Options
18236 These options are defined specifically for the FT32 port.
18238 @table @gcctabopt
18240 @item -msim
18241 @opindex msim
18242 Specifies that the program will be run on the simulator.  This causes
18243 an alternate runtime startup and library to be linked.
18244 You must not use this option when generating programs that will run on
18245 real hardware; you must provide your own runtime library for whatever
18246 I/O functions are needed.
18248 @item -mlra
18249 @opindex mlra
18250 Enable Local Register Allocation.  This is still experimental for FT32,
18251 so by default the compiler uses standard reload.
18253 @item -mnodiv
18254 @opindex mnodiv
18255 Do not use div and mod instructions.
18257 @item -mft32b
18258 @opindex mft32b
18259 Enable use of the extended instructions of the FT32B processor.
18261 @item -mcompress
18262 @opindex mcompress
18263 Compress all code using the Ft32B code compression scheme.
18265 @item -mnopm
18266 @opindex  mnopm
18267 Do not generate code that reads program memory.
18269 @end table
18271 @node FRV Options
18272 @subsection FRV Options
18273 @cindex FRV Options
18275 @table @gcctabopt
18276 @item -mgpr-32
18277 @opindex mgpr-32
18279 Only use the first 32 general-purpose registers.
18281 @item -mgpr-64
18282 @opindex mgpr-64
18284 Use all 64 general-purpose registers.
18286 @item -mfpr-32
18287 @opindex mfpr-32
18289 Use only the first 32 floating-point registers.
18291 @item -mfpr-64
18292 @opindex mfpr-64
18294 Use all 64 floating-point registers.
18296 @item -mhard-float
18297 @opindex mhard-float
18299 Use hardware instructions for floating-point operations.
18301 @item -msoft-float
18302 @opindex msoft-float
18304 Use library routines for floating-point operations.
18306 @item -malloc-cc
18307 @opindex malloc-cc
18309 Dynamically allocate condition code registers.
18311 @item -mfixed-cc
18312 @opindex mfixed-cc
18314 Do not try to dynamically allocate condition code registers, only
18315 use @code{icc0} and @code{fcc0}.
18317 @item -mdword
18318 @opindex mdword
18320 Change ABI to use double word insns.
18322 @item -mno-dword
18323 @opindex mno-dword
18325 Do not use double word instructions.
18327 @item -mdouble
18328 @opindex mdouble
18330 Use floating-point double instructions.
18332 @item -mno-double
18333 @opindex mno-double
18335 Do not use floating-point double instructions.
18337 @item -mmedia
18338 @opindex mmedia
18340 Use media instructions.
18342 @item -mno-media
18343 @opindex mno-media
18345 Do not use media instructions.
18347 @item -mmuladd
18348 @opindex mmuladd
18350 Use multiply and add/subtract instructions.
18352 @item -mno-muladd
18353 @opindex mno-muladd
18355 Do not use multiply and add/subtract instructions.
18357 @item -mfdpic
18358 @opindex mfdpic
18360 Select the FDPIC ABI, which uses function descriptors to represent
18361 pointers to functions.  Without any PIC/PIE-related options, it
18362 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18363 assumes GOT entries and small data are within a 12-bit range from the
18364 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18365 are computed with 32 bits.
18366 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18368 @item -minline-plt
18369 @opindex minline-plt
18371 Enable inlining of PLT entries in function calls to functions that are
18372 not known to bind locally.  It has no effect without @option{-mfdpic}.
18373 It's enabled by default if optimizing for speed and compiling for
18374 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18375 optimization option such as @option{-O3} or above is present in the
18376 command line.
18378 @item -mTLS
18379 @opindex mTLS
18381 Assume a large TLS segment when generating thread-local code.
18383 @item -mtls
18384 @opindex mtls
18386 Do not assume a large TLS segment when generating thread-local code.
18388 @item -mgprel-ro
18389 @opindex mgprel-ro
18391 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18392 that is known to be in read-only sections.  It's enabled by default,
18393 except for @option{-fpic} or @option{-fpie}: even though it may help
18394 make the global offset table smaller, it trades 1 instruction for 4.
18395 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18396 one of which may be shared by multiple symbols, and it avoids the need
18397 for a GOT entry for the referenced symbol, so it's more likely to be a
18398 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18400 @item -multilib-library-pic
18401 @opindex multilib-library-pic
18403 Link with the (library, not FD) pic libraries.  It's implied by
18404 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18405 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18406 it explicitly.
18408 @item -mlinked-fp
18409 @opindex mlinked-fp
18411 Follow the EABI requirement of always creating a frame pointer whenever
18412 a stack frame is allocated.  This option is enabled by default and can
18413 be disabled with @option{-mno-linked-fp}.
18415 @item -mlong-calls
18416 @opindex mlong-calls
18418 Use indirect addressing to call functions outside the current
18419 compilation unit.  This allows the functions to be placed anywhere
18420 within the 32-bit address space.
18422 @item -malign-labels
18423 @opindex malign-labels
18425 Try to align labels to an 8-byte boundary by inserting NOPs into the
18426 previous packet.  This option only has an effect when VLIW packing
18427 is enabled.  It doesn't create new packets; it merely adds NOPs to
18428 existing ones.
18430 @item -mlibrary-pic
18431 @opindex mlibrary-pic
18433 Generate position-independent EABI code.
18435 @item -macc-4
18436 @opindex macc-4
18438 Use only the first four media accumulator registers.
18440 @item -macc-8
18441 @opindex macc-8
18443 Use all eight media accumulator registers.
18445 @item -mpack
18446 @opindex mpack
18448 Pack VLIW instructions.
18450 @item -mno-pack
18451 @opindex mno-pack
18453 Do not pack VLIW instructions.
18455 @item -mno-eflags
18456 @opindex mno-eflags
18458 Do not mark ABI switches in e_flags.
18460 @item -mcond-move
18461 @opindex mcond-move
18463 Enable the use of conditional-move instructions (default).
18465 This switch is mainly for debugging the compiler and will likely be removed
18466 in a future version.
18468 @item -mno-cond-move
18469 @opindex mno-cond-move
18471 Disable the use of conditional-move instructions.
18473 This switch is mainly for debugging the compiler and will likely be removed
18474 in a future version.
18476 @item -mscc
18477 @opindex mscc
18479 Enable the use of conditional set instructions (default).
18481 This switch is mainly for debugging the compiler and will likely be removed
18482 in a future version.
18484 @item -mno-scc
18485 @opindex mno-scc
18487 Disable the use of conditional set instructions.
18489 This switch is mainly for debugging the compiler and will likely be removed
18490 in a future version.
18492 @item -mcond-exec
18493 @opindex mcond-exec
18495 Enable the use of conditional execution (default).
18497 This switch is mainly for debugging the compiler and will likely be removed
18498 in a future version.
18500 @item -mno-cond-exec
18501 @opindex mno-cond-exec
18503 Disable the use of conditional execution.
18505 This switch is mainly for debugging the compiler and will likely be removed
18506 in a future version.
18508 @item -mvliw-branch
18509 @opindex mvliw-branch
18511 Run a pass to pack branches into VLIW instructions (default).
18513 This switch is mainly for debugging the compiler and will likely be removed
18514 in a future version.
18516 @item -mno-vliw-branch
18517 @opindex mno-vliw-branch
18519 Do not run a pass to pack branches into VLIW instructions.
18521 This switch is mainly for debugging the compiler and will likely be removed
18522 in a future version.
18524 @item -mmulti-cond-exec
18525 @opindex mmulti-cond-exec
18527 Enable optimization of @code{&&} and @code{||} in conditional execution
18528 (default).
18530 This switch is mainly for debugging the compiler and will likely be removed
18531 in a future version.
18533 @item -mno-multi-cond-exec
18534 @opindex mno-multi-cond-exec
18536 Disable optimization of @code{&&} and @code{||} in conditional execution.
18538 This switch is mainly for debugging the compiler and will likely be removed
18539 in a future version.
18541 @item -mnested-cond-exec
18542 @opindex mnested-cond-exec
18544 Enable nested conditional execution optimizations (default).
18546 This switch is mainly for debugging the compiler and will likely be removed
18547 in a future version.
18549 @item -mno-nested-cond-exec
18550 @opindex mno-nested-cond-exec
18552 Disable nested conditional execution optimizations.
18554 This switch is mainly for debugging the compiler and will likely be removed
18555 in a future version.
18557 @item -moptimize-membar
18558 @opindex moptimize-membar
18560 This switch removes redundant @code{membar} instructions from the
18561 compiler-generated code.  It is enabled by default.
18563 @item -mno-optimize-membar
18564 @opindex mno-optimize-membar
18566 This switch disables the automatic removal of redundant @code{membar}
18567 instructions from the generated code.
18569 @item -mtomcat-stats
18570 @opindex mtomcat-stats
18572 Cause gas to print out tomcat statistics.
18574 @item -mcpu=@var{cpu}
18575 @opindex mcpu
18577 Select the processor type for which to generate code.  Possible values are
18578 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18579 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18581 @end table
18583 @node GNU/Linux Options
18584 @subsection GNU/Linux Options
18586 These @samp{-m} options are defined for GNU/Linux targets:
18588 @table @gcctabopt
18589 @item -mglibc
18590 @opindex mglibc
18591 Use the GNU C library.  This is the default except
18592 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18593 @samp{*-*-linux-*android*} targets.
18595 @item -muclibc
18596 @opindex muclibc
18597 Use uClibc C library.  This is the default on
18598 @samp{*-*-linux-*uclibc*} targets.
18600 @item -mmusl
18601 @opindex mmusl
18602 Use the musl C library.  This is the default on
18603 @samp{*-*-linux-*musl*} targets.
18605 @item -mbionic
18606 @opindex mbionic
18607 Use Bionic C library.  This is the default on
18608 @samp{*-*-linux-*android*} targets.
18610 @item -mandroid
18611 @opindex mandroid
18612 Compile code compatible with Android platform.  This is the default on
18613 @samp{*-*-linux-*android*} targets.
18615 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18616 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18617 this option makes the GCC driver pass Android-specific options to the linker.
18618 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18619 to be defined.
18621 @item -tno-android-cc
18622 @opindex tno-android-cc
18623 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18624 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18625 @option{-fno-rtti} by default.
18627 @item -tno-android-ld
18628 @opindex tno-android-ld
18629 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18630 linking options to the linker.
18632 @end table
18634 @node H8/300 Options
18635 @subsection H8/300 Options
18637 These @samp{-m} options are defined for the H8/300 implementations:
18639 @table @gcctabopt
18640 @item -mrelax
18641 @opindex mrelax
18642 Shorten some address references at link time, when possible; uses the
18643 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18644 ld, Using ld}, for a fuller description.
18646 @item -mh
18647 @opindex mh
18648 Generate code for the H8/300H@.
18650 @item -ms
18651 @opindex ms
18652 Generate code for the H8S@.
18654 @item -mn
18655 @opindex mn
18656 Generate code for the H8S and H8/300H in the normal mode.  This switch
18657 must be used either with @option{-mh} or @option{-ms}.
18659 @item -ms2600
18660 @opindex ms2600
18661 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18663 @item -mexr
18664 @opindex mexr
18665 Extended registers are stored on stack before execution of function
18666 with monitor attribute. Default option is @option{-mexr}.
18667 This option is valid only for H8S targets.
18669 @item -mno-exr
18670 @opindex mno-exr
18671 Extended registers are not stored on stack before execution of function 
18672 with monitor attribute. Default option is @option{-mno-exr}. 
18673 This option is valid only for H8S targets.
18675 @item -mint32
18676 @opindex mint32
18677 Make @code{int} data 32 bits by default.
18679 @item -malign-300
18680 @opindex malign-300
18681 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18682 The default for the H8/300H and H8S is to align longs and floats on
18683 4-byte boundaries.
18684 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18685 This option has no effect on the H8/300.
18686 @end table
18688 @node HPPA Options
18689 @subsection HPPA Options
18690 @cindex HPPA Options
18692 These @samp{-m} options are defined for the HPPA family of computers:
18694 @table @gcctabopt
18695 @item -march=@var{architecture-type}
18696 @opindex march
18697 Generate code for the specified architecture.  The choices for
18698 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18699 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18700 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18701 architecture option for your machine.  Code compiled for lower numbered
18702 architectures runs on higher numbered architectures, but not the
18703 other way around.
18705 @item -mpa-risc-1-0
18706 @itemx -mpa-risc-1-1
18707 @itemx -mpa-risc-2-0
18708 @opindex mpa-risc-1-0
18709 @opindex mpa-risc-1-1
18710 @opindex mpa-risc-2-0
18711 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18713 @item -mcaller-copies
18714 @opindex mcaller-copies
18715 The caller copies function arguments passed by hidden reference.  This
18716 option should be used with care as it is not compatible with the default
18717 32-bit runtime.  However, only aggregates larger than eight bytes are
18718 passed by hidden reference and the option provides better compatibility
18719 with OpenMP.
18721 @item -mjump-in-delay
18722 @opindex mjump-in-delay
18723 This option is ignored and provided for compatibility purposes only.
18725 @item -mdisable-fpregs
18726 @opindex mdisable-fpregs
18727 Prevent floating-point registers from being used in any manner.  This is
18728 necessary for compiling kernels that perform lazy context switching of
18729 floating-point registers.  If you use this option and attempt to perform
18730 floating-point operations, the compiler aborts.
18732 @item -mdisable-indexing
18733 @opindex mdisable-indexing
18734 Prevent the compiler from using indexing address modes.  This avoids some
18735 rather obscure problems when compiling MIG generated code under MACH@.
18737 @item -mno-space-regs
18738 @opindex mno-space-regs
18739 Generate code that assumes the target has no space registers.  This allows
18740 GCC to generate faster indirect calls and use unscaled index address modes.
18742 Such code is suitable for level 0 PA systems and kernels.
18744 @item -mfast-indirect-calls
18745 @opindex mfast-indirect-calls
18746 Generate code that assumes calls never cross space boundaries.  This
18747 allows GCC to emit code that performs faster indirect calls.
18749 This option does not work in the presence of shared libraries or nested
18750 functions.
18752 @item -mfixed-range=@var{register-range}
18753 @opindex mfixed-range
18754 Generate code treating the given register range as fixed registers.
18755 A fixed register is one that the register allocator cannot use.  This is
18756 useful when compiling kernel code.  A register range is specified as
18757 two registers separated by a dash.  Multiple register ranges can be
18758 specified separated by a comma.
18760 @item -mlong-load-store
18761 @opindex mlong-load-store
18762 Generate 3-instruction load and store sequences as sometimes required by
18763 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18764 the HP compilers.
18766 @item -mportable-runtime
18767 @opindex mportable-runtime
18768 Use the portable calling conventions proposed by HP for ELF systems.
18770 @item -mgas
18771 @opindex mgas
18772 Enable the use of assembler directives only GAS understands.
18774 @item -mschedule=@var{cpu-type}
18775 @opindex mschedule
18776 Schedule code according to the constraints for the machine type
18777 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18778 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18779 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18780 proper scheduling option for your machine.  The default scheduling is
18781 @samp{8000}.
18783 @item -mlinker-opt
18784 @opindex mlinker-opt
18785 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18786 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18787 linkers in which they give bogus error messages when linking some programs.
18789 @item -msoft-float
18790 @opindex msoft-float
18791 Generate output containing library calls for floating point.
18792 @strong{Warning:} the requisite libraries are not available for all HPPA
18793 targets.  Normally the facilities of the machine's usual C compiler are
18794 used, but this cannot be done directly in cross-compilation.  You must make
18795 your own arrangements to provide suitable library functions for
18796 cross-compilation.
18798 @option{-msoft-float} changes the calling convention in the output file;
18799 therefore, it is only useful if you compile @emph{all} of a program with
18800 this option.  In particular, you need to compile @file{libgcc.a}, the
18801 library that comes with GCC, with @option{-msoft-float} in order for
18802 this to work.
18804 @item -msio
18805 @opindex msio
18806 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18807 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18808 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18809 options are available under HP-UX and HI-UX@.
18811 @item -mgnu-ld
18812 @opindex mgnu-ld
18813 Use options specific to GNU @command{ld}.
18814 This passes @option{-shared} to @command{ld} when
18815 building a shared library.  It is the default when GCC is configured,
18816 explicitly or implicitly, with the GNU linker.  This option does not
18817 affect which @command{ld} is called; it only changes what parameters
18818 are passed to that @command{ld}.
18819 The @command{ld} that is called is determined by the
18820 @option{--with-ld} configure option, GCC's program search path, and
18821 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18822 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18823 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18825 @item -mhp-ld
18826 @opindex mhp-ld
18827 Use options specific to HP @command{ld}.
18828 This passes @option{-b} to @command{ld} when building
18829 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18830 links.  It is the default when GCC is configured, explicitly or
18831 implicitly, with the HP linker.  This option does not affect
18832 which @command{ld} is called; it only changes what parameters are passed to that
18833 @command{ld}.
18834 The @command{ld} that is called is determined by the @option{--with-ld}
18835 configure option, GCC's program search path, and finally by the user's
18836 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18837 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18838 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18840 @item -mlong-calls
18841 @opindex mno-long-calls
18842 Generate code that uses long call sequences.  This ensures that a call
18843 is always able to reach linker generated stubs.  The default is to generate
18844 long calls only when the distance from the call site to the beginning
18845 of the function or translation unit, as the case may be, exceeds a
18846 predefined limit set by the branch type being used.  The limits for
18847 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18848 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18849 240,000 bytes.
18851 Distances are measured from the beginning of functions when using the
18852 @option{-ffunction-sections} option, or when using the @option{-mgas}
18853 and @option{-mno-portable-runtime} options together under HP-UX with
18854 the SOM linker.
18856 It is normally not desirable to use this option as it degrades
18857 performance.  However, it may be useful in large applications,
18858 particularly when partial linking is used to build the application.
18860 The types of long calls used depends on the capabilities of the
18861 assembler and linker, and the type of code being generated.  The
18862 impact on systems that support long absolute calls, and long pic
18863 symbol-difference or pc-relative calls should be relatively small.
18864 However, an indirect call is used on 32-bit ELF systems in pic code
18865 and it is quite long.
18867 @item -munix=@var{unix-std}
18868 @opindex march
18869 Generate compiler predefines and select a startfile for the specified
18870 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18871 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18872 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18873 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18874 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18875 and later.
18877 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18878 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18879 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18880 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18881 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18882 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18884 It is @emph{important} to note that this option changes the interfaces
18885 for various library routines.  It also affects the operational behavior
18886 of the C library.  Thus, @emph{extreme} care is needed in using this
18887 option.
18889 Library code that is intended to operate with more than one UNIX
18890 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18891 as appropriate.  Most GNU software doesn't provide this capability.
18893 @item -nolibdld
18894 @opindex nolibdld
18895 Suppress the generation of link options to search libdld.sl when the
18896 @option{-static} option is specified on HP-UX 10 and later.
18898 @item -static
18899 @opindex static
18900 The HP-UX implementation of setlocale in libc has a dependency on
18901 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18902 when the @option{-static} option is specified, special link options
18903 are needed to resolve this dependency.
18905 On HP-UX 10 and later, the GCC driver adds the necessary options to
18906 link with libdld.sl when the @option{-static} option is specified.
18907 This causes the resulting binary to be dynamic.  On the 64-bit port,
18908 the linkers generate dynamic binaries by default in any case.  The
18909 @option{-nolibdld} option can be used to prevent the GCC driver from
18910 adding these link options.
18912 @item -threads
18913 @opindex threads
18914 Add support for multithreading with the @dfn{dce thread} library
18915 under HP-UX@.  This option sets flags for both the preprocessor and
18916 linker.
18917 @end table
18919 @node IA-64 Options
18920 @subsection IA-64 Options
18921 @cindex IA-64 Options
18923 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18925 @table @gcctabopt
18926 @item -mbig-endian
18927 @opindex mbig-endian
18928 Generate code for a big-endian target.  This is the default for HP-UX@.
18930 @item -mlittle-endian
18931 @opindex mlittle-endian
18932 Generate code for a little-endian target.  This is the default for AIX5
18933 and GNU/Linux.
18935 @item -mgnu-as
18936 @itemx -mno-gnu-as
18937 @opindex mgnu-as
18938 @opindex mno-gnu-as
18939 Generate (or don't) code for the GNU assembler.  This is the default.
18940 @c Also, this is the default if the configure option @option{--with-gnu-as}
18941 @c is used.
18943 @item -mgnu-ld
18944 @itemx -mno-gnu-ld
18945 @opindex mgnu-ld
18946 @opindex mno-gnu-ld
18947 Generate (or don't) code for the GNU linker.  This is the default.
18948 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18949 @c is used.
18951 @item -mno-pic
18952 @opindex mno-pic
18953 Generate code that does not use a global pointer register.  The result
18954 is not position independent code, and violates the IA-64 ABI@.
18956 @item -mvolatile-asm-stop
18957 @itemx -mno-volatile-asm-stop
18958 @opindex mvolatile-asm-stop
18959 @opindex mno-volatile-asm-stop
18960 Generate (or don't) a stop bit immediately before and after volatile asm
18961 statements.
18963 @item -mregister-names
18964 @itemx -mno-register-names
18965 @opindex mregister-names
18966 @opindex mno-register-names
18967 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18968 the stacked registers.  This may make assembler output more readable.
18970 @item -mno-sdata
18971 @itemx -msdata
18972 @opindex mno-sdata
18973 @opindex msdata
18974 Disable (or enable) optimizations that use the small data section.  This may
18975 be useful for working around optimizer bugs.
18977 @item -mconstant-gp
18978 @opindex mconstant-gp
18979 Generate code that uses a single constant global pointer value.  This is
18980 useful when compiling kernel code.
18982 @item -mauto-pic
18983 @opindex mauto-pic
18984 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18985 This is useful when compiling firmware code.
18987 @item -minline-float-divide-min-latency
18988 @opindex minline-float-divide-min-latency
18989 Generate code for inline divides of floating-point values
18990 using the minimum latency algorithm.
18992 @item -minline-float-divide-max-throughput
18993 @opindex minline-float-divide-max-throughput
18994 Generate code for inline divides of floating-point values
18995 using the maximum throughput algorithm.
18997 @item -mno-inline-float-divide
18998 @opindex mno-inline-float-divide
18999 Do not generate inline code for divides of floating-point values.
19001 @item -minline-int-divide-min-latency
19002 @opindex minline-int-divide-min-latency
19003 Generate code for inline divides of integer values
19004 using the minimum latency algorithm.
19006 @item -minline-int-divide-max-throughput
19007 @opindex minline-int-divide-max-throughput
19008 Generate code for inline divides of integer values
19009 using the maximum throughput algorithm.
19011 @item -mno-inline-int-divide
19012 @opindex mno-inline-int-divide
19013 Do not generate inline code for divides of integer values.
19015 @item -minline-sqrt-min-latency
19016 @opindex minline-sqrt-min-latency
19017 Generate code for inline square roots
19018 using the minimum latency algorithm.
19020 @item -minline-sqrt-max-throughput
19021 @opindex minline-sqrt-max-throughput
19022 Generate code for inline square roots
19023 using the maximum throughput algorithm.
19025 @item -mno-inline-sqrt
19026 @opindex mno-inline-sqrt
19027 Do not generate inline code for @code{sqrt}.
19029 @item -mfused-madd
19030 @itemx -mno-fused-madd
19031 @opindex mfused-madd
19032 @opindex mno-fused-madd
19033 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
19034 instructions.  The default is to use these instructions.
19036 @item -mno-dwarf2-asm
19037 @itemx -mdwarf2-asm
19038 @opindex mno-dwarf2-asm
19039 @opindex mdwarf2-asm
19040 Don't (or do) generate assembler code for the DWARF line number debugging
19041 info.  This may be useful when not using the GNU assembler.
19043 @item -mearly-stop-bits
19044 @itemx -mno-early-stop-bits
19045 @opindex mearly-stop-bits
19046 @opindex mno-early-stop-bits
19047 Allow stop bits to be placed earlier than immediately preceding the
19048 instruction that triggered the stop bit.  This can improve instruction
19049 scheduling, but does not always do so.
19051 @item -mfixed-range=@var{register-range}
19052 @opindex mfixed-range
19053 Generate code treating the given register range as fixed registers.
19054 A fixed register is one that the register allocator cannot use.  This is
19055 useful when compiling kernel code.  A register range is specified as
19056 two registers separated by a dash.  Multiple register ranges can be
19057 specified separated by a comma.
19059 @item -mtls-size=@var{tls-size}
19060 @opindex mtls-size
19061 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
19064 @item -mtune=@var{cpu-type}
19065 @opindex mtune
19066 Tune the instruction scheduling for a particular CPU, Valid values are
19067 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
19068 and @samp{mckinley}.
19070 @item -milp32
19071 @itemx -mlp64
19072 @opindex milp32
19073 @opindex mlp64
19074 Generate code for a 32-bit or 64-bit environment.
19075 The 32-bit environment sets int, long and pointer to 32 bits.
19076 The 64-bit environment sets int to 32 bits and long and pointer
19077 to 64 bits.  These are HP-UX specific flags.
19079 @item -mno-sched-br-data-spec
19080 @itemx -msched-br-data-spec
19081 @opindex mno-sched-br-data-spec
19082 @opindex msched-br-data-spec
19083 (Dis/En)able data speculative scheduling before reload.
19084 This results in generation of @code{ld.a} instructions and
19085 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19086 The default setting is disabled.
19088 @item -msched-ar-data-spec
19089 @itemx -mno-sched-ar-data-spec
19090 @opindex msched-ar-data-spec
19091 @opindex mno-sched-ar-data-spec
19092 (En/Dis)able data speculative scheduling after reload.
19093 This results in generation of @code{ld.a} instructions and
19094 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19095 The default setting is enabled.
19097 @item -mno-sched-control-spec
19098 @itemx -msched-control-spec
19099 @opindex mno-sched-control-spec
19100 @opindex msched-control-spec
19101 (Dis/En)able control speculative scheduling.  This feature is
19102 available only during region scheduling (i.e.@: before reload).
19103 This results in generation of the @code{ld.s} instructions and
19104 the corresponding check instructions @code{chk.s}.
19105 The default setting is disabled.
19107 @item -msched-br-in-data-spec
19108 @itemx -mno-sched-br-in-data-spec
19109 @opindex msched-br-in-data-spec
19110 @opindex mno-sched-br-in-data-spec
19111 (En/Dis)able speculative scheduling of the instructions that
19112 are dependent on the data speculative loads before reload.
19113 This is effective only with @option{-msched-br-data-spec} enabled.
19114 The default setting is enabled.
19116 @item -msched-ar-in-data-spec
19117 @itemx -mno-sched-ar-in-data-spec
19118 @opindex msched-ar-in-data-spec
19119 @opindex mno-sched-ar-in-data-spec
19120 (En/Dis)able speculative scheduling of the instructions that
19121 are dependent on the data speculative loads after reload.
19122 This is effective only with @option{-msched-ar-data-spec} enabled.
19123 The default setting is enabled.
19125 @item -msched-in-control-spec
19126 @itemx -mno-sched-in-control-spec
19127 @opindex msched-in-control-spec
19128 @opindex mno-sched-in-control-spec
19129 (En/Dis)able speculative scheduling of the instructions that
19130 are dependent on the control speculative loads.
19131 This is effective only with @option{-msched-control-spec} enabled.
19132 The default setting is enabled.
19134 @item -mno-sched-prefer-non-data-spec-insns
19135 @itemx -msched-prefer-non-data-spec-insns
19136 @opindex mno-sched-prefer-non-data-spec-insns
19137 @opindex msched-prefer-non-data-spec-insns
19138 If enabled, data-speculative instructions are chosen for schedule
19139 only if there are no other choices at the moment.  This makes
19140 the use of the data speculation much more conservative.
19141 The default setting is disabled.
19143 @item -mno-sched-prefer-non-control-spec-insns
19144 @itemx -msched-prefer-non-control-spec-insns
19145 @opindex mno-sched-prefer-non-control-spec-insns
19146 @opindex msched-prefer-non-control-spec-insns
19147 If enabled, control-speculative instructions are chosen for schedule
19148 only if there are no other choices at the moment.  This makes
19149 the use of the control speculation much more conservative.
19150 The default setting is disabled.
19152 @item -mno-sched-count-spec-in-critical-path
19153 @itemx -msched-count-spec-in-critical-path
19154 @opindex mno-sched-count-spec-in-critical-path
19155 @opindex msched-count-spec-in-critical-path
19156 If enabled, speculative dependencies are considered during
19157 computation of the instructions priorities.  This makes the use of the
19158 speculation a bit more conservative.
19159 The default setting is disabled.
19161 @item -msched-spec-ldc
19162 @opindex msched-spec-ldc
19163 Use a simple data speculation check.  This option is on by default.
19165 @item -msched-control-spec-ldc
19166 @opindex msched-spec-ldc
19167 Use a simple check for control speculation.  This option is on by default.
19169 @item -msched-stop-bits-after-every-cycle
19170 @opindex msched-stop-bits-after-every-cycle
19171 Place a stop bit after every cycle when scheduling.  This option is on
19172 by default.
19174 @item -msched-fp-mem-deps-zero-cost
19175 @opindex msched-fp-mem-deps-zero-cost
19176 Assume that floating-point stores and loads are not likely to cause a conflict
19177 when placed into the same instruction group.  This option is disabled by
19178 default.
19180 @item -msel-sched-dont-check-control-spec
19181 @opindex msel-sched-dont-check-control-spec
19182 Generate checks for control speculation in selective scheduling.
19183 This flag is disabled by default.
19185 @item -msched-max-memory-insns=@var{max-insns}
19186 @opindex msched-max-memory-insns
19187 Limit on the number of memory insns per instruction group, giving lower
19188 priority to subsequent memory insns attempting to schedule in the same
19189 instruction group. Frequently useful to prevent cache bank conflicts.
19190 The default value is 1.
19192 @item -msched-max-memory-insns-hard-limit
19193 @opindex msched-max-memory-insns-hard-limit
19194 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
19195 disallowing more than that number in an instruction group.
19196 Otherwise, the limit is ``soft'', meaning that non-memory operations
19197 are preferred when the limit is reached, but memory operations may still
19198 be scheduled.
19200 @end table
19202 @node LM32 Options
19203 @subsection LM32 Options
19204 @cindex LM32 options
19206 These @option{-m} options are defined for the LatticeMico32 architecture:
19208 @table @gcctabopt
19209 @item -mbarrel-shift-enabled
19210 @opindex mbarrel-shift-enabled
19211 Enable barrel-shift instructions.
19213 @item -mdivide-enabled
19214 @opindex mdivide-enabled
19215 Enable divide and modulus instructions.
19217 @item -mmultiply-enabled
19218 @opindex multiply-enabled
19219 Enable multiply instructions.
19221 @item -msign-extend-enabled
19222 @opindex msign-extend-enabled
19223 Enable sign extend instructions.
19225 @item -muser-enabled
19226 @opindex muser-enabled
19227 Enable user-defined instructions.
19229 @end table
19231 @node M32C Options
19232 @subsection M32C Options
19233 @cindex M32C options
19235 @table @gcctabopt
19236 @item -mcpu=@var{name}
19237 @opindex mcpu=
19238 Select the CPU for which code is generated.  @var{name} may be one of
19239 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
19240 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
19241 the M32C/80 series.
19243 @item -msim
19244 @opindex msim
19245 Specifies that the program will be run on the simulator.  This causes
19246 an alternate runtime library to be linked in which supports, for
19247 example, file I/O@.  You must not use this option when generating
19248 programs that will run on real hardware; you must provide your own
19249 runtime library for whatever I/O functions are needed.
19251 @item -memregs=@var{number}
19252 @opindex memregs=
19253 Specifies the number of memory-based pseudo-registers GCC uses
19254 during code generation.  These pseudo-registers are used like real
19255 registers, so there is a tradeoff between GCC's ability to fit the
19256 code into available registers, and the performance penalty of using
19257 memory instead of registers.  Note that all modules in a program must
19258 be compiled with the same value for this option.  Because of that, you
19259 must not use this option with GCC's default runtime libraries.
19261 @end table
19263 @node M32R/D Options
19264 @subsection M32R/D Options
19265 @cindex M32R/D options
19267 These @option{-m} options are defined for Renesas M32R/D architectures:
19269 @table @gcctabopt
19270 @item -m32r2
19271 @opindex m32r2
19272 Generate code for the M32R/2@.
19274 @item -m32rx
19275 @opindex m32rx
19276 Generate code for the M32R/X@.
19278 @item -m32r
19279 @opindex m32r
19280 Generate code for the M32R@.  This is the default.
19282 @item -mmodel=small
19283 @opindex mmodel=small
19284 Assume all objects live in the lower 16MB of memory (so that their addresses
19285 can be loaded with the @code{ld24} instruction), and assume all subroutines
19286 are reachable with the @code{bl} instruction.
19287 This is the default.
19289 The addressability of a particular object can be set with the
19290 @code{model} attribute.
19292 @item -mmodel=medium
19293 @opindex mmodel=medium
19294 Assume objects may be anywhere in the 32-bit address space (the compiler
19295 generates @code{seth/add3} instructions to load their addresses), and
19296 assume all subroutines are reachable with the @code{bl} instruction.
19298 @item -mmodel=large
19299 @opindex mmodel=large
19300 Assume objects may be anywhere in the 32-bit address space (the compiler
19301 generates @code{seth/add3} instructions to load their addresses), and
19302 assume subroutines may not be reachable with the @code{bl} instruction
19303 (the compiler generates the much slower @code{seth/add3/jl}
19304 instruction sequence).
19306 @item -msdata=none
19307 @opindex msdata=none
19308 Disable use of the small data area.  Variables are put into
19309 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19310 @code{section} attribute has been specified).
19311 This is the default.
19313 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19314 Objects may be explicitly put in the small data area with the
19315 @code{section} attribute using one of these sections.
19317 @item -msdata=sdata
19318 @opindex msdata=sdata
19319 Put small global and static data in the small data area, but do not
19320 generate special code to reference them.
19322 @item -msdata=use
19323 @opindex msdata=use
19324 Put small global and static data in the small data area, and generate
19325 special instructions to reference them.
19327 @item -G @var{num}
19328 @opindex G
19329 @cindex smaller data references
19330 Put global and static objects less than or equal to @var{num} bytes
19331 into the small data or BSS sections instead of the normal data or BSS
19332 sections.  The default value of @var{num} is 8.
19333 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
19334 for this option to have any effect.
19336 All modules should be compiled with the same @option{-G @var{num}} value.
19337 Compiling with different values of @var{num} may or may not work; if it
19338 doesn't the linker gives an error message---incorrect code is not
19339 generated.
19341 @item -mdebug
19342 @opindex mdebug
19343 Makes the M32R-specific code in the compiler display some statistics
19344 that might help in debugging programs.
19346 @item -malign-loops
19347 @opindex malign-loops
19348 Align all loops to a 32-byte boundary.
19350 @item -mno-align-loops
19351 @opindex mno-align-loops
19352 Do not enforce a 32-byte alignment for loops.  This is the default.
19354 @item -missue-rate=@var{number}
19355 @opindex missue-rate=@var{number}
19356 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19357 or 2.
19359 @item -mbranch-cost=@var{number}
19360 @opindex mbranch-cost=@var{number}
19361 @var{number} can only be 1 or 2.  If it is 1 then branches are
19362 preferred over conditional code, if it is 2, then the opposite applies.
19364 @item -mflush-trap=@var{number}
19365 @opindex mflush-trap=@var{number}
19366 Specifies the trap number to use to flush the cache.  The default is
19367 12.  Valid numbers are between 0 and 15 inclusive.
19369 @item -mno-flush-trap
19370 @opindex mno-flush-trap
19371 Specifies that the cache cannot be flushed by using a trap.
19373 @item -mflush-func=@var{name}
19374 @opindex mflush-func=@var{name}
19375 Specifies the name of the operating system function to call to flush
19376 the cache.  The default is @samp{_flush_cache}, but a function call
19377 is only used if a trap is not available.
19379 @item -mno-flush-func
19380 @opindex mno-flush-func
19381 Indicates that there is no OS function for flushing the cache.
19383 @end table
19385 @node M680x0 Options
19386 @subsection M680x0 Options
19387 @cindex M680x0 options
19389 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19390 The default settings depend on which architecture was selected when
19391 the compiler was configured; the defaults for the most common choices
19392 are given below.
19394 @table @gcctabopt
19395 @item -march=@var{arch}
19396 @opindex march
19397 Generate code for a specific M680x0 or ColdFire instruction set
19398 architecture.  Permissible values of @var{arch} for M680x0
19399 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19400 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19401 architectures are selected according to Freescale's ISA classification
19402 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19403 @samp{isab} and @samp{isac}.
19405 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19406 code for a ColdFire target.  The @var{arch} in this macro is one of the
19407 @option{-march} arguments given above.
19409 When used together, @option{-march} and @option{-mtune} select code
19410 that runs on a family of similar processors but that is optimized
19411 for a particular microarchitecture.
19413 @item -mcpu=@var{cpu}
19414 @opindex mcpu
19415 Generate code for a specific M680x0 or ColdFire processor.
19416 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19417 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19418 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19419 below, which also classifies the CPUs into families:
19421 @multitable @columnfractions 0.20 0.80
19422 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19423 @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}
19424 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19425 @item @samp{5206e} @tab @samp{5206e}
19426 @item @samp{5208} @tab @samp{5207} @samp{5208}
19427 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19428 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19429 @item @samp{5216} @tab @samp{5214} @samp{5216}
19430 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19431 @item @samp{5225} @tab @samp{5224} @samp{5225}
19432 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19433 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19434 @item @samp{5249} @tab @samp{5249}
19435 @item @samp{5250} @tab @samp{5250}
19436 @item @samp{5271} @tab @samp{5270} @samp{5271}
19437 @item @samp{5272} @tab @samp{5272}
19438 @item @samp{5275} @tab @samp{5274} @samp{5275}
19439 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19440 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19441 @item @samp{5307} @tab @samp{5307}
19442 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19443 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19444 @item @samp{5407} @tab @samp{5407}
19445 @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}
19446 @end multitable
19448 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19449 @var{arch} is compatible with @var{cpu}.  Other combinations of
19450 @option{-mcpu} and @option{-march} are rejected.
19452 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19453 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19454 where the value of @var{family} is given by the table above.
19456 @item -mtune=@var{tune}
19457 @opindex mtune
19458 Tune the code for a particular microarchitecture within the
19459 constraints set by @option{-march} and @option{-mcpu}.
19460 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19461 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19462 and @samp{cpu32}.  The ColdFire microarchitectures
19463 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19465 You can also use @option{-mtune=68020-40} for code that needs
19466 to run relatively well on 68020, 68030 and 68040 targets.
19467 @option{-mtune=68020-60} is similar but includes 68060 targets
19468 as well.  These two options select the same tuning decisions as
19469 @option{-m68020-40} and @option{-m68020-60} respectively.
19471 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19472 when tuning for 680x0 architecture @var{arch}.  It also defines
19473 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19474 option is used.  If GCC is tuning for a range of architectures,
19475 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19476 it defines the macros for every architecture in the range.
19478 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19479 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19480 of the arguments given above.
19482 @item -m68000
19483 @itemx -mc68000
19484 @opindex m68000
19485 @opindex mc68000
19486 Generate output for a 68000.  This is the default
19487 when the compiler is configured for 68000-based systems.
19488 It is equivalent to @option{-march=68000}.
19490 Use this option for microcontrollers with a 68000 or EC000 core,
19491 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19493 @item -m68010
19494 @opindex m68010
19495 Generate output for a 68010.  This is the default
19496 when the compiler is configured for 68010-based systems.
19497 It is equivalent to @option{-march=68010}.
19499 @item -m68020
19500 @itemx -mc68020
19501 @opindex m68020
19502 @opindex mc68020
19503 Generate output for a 68020.  This is the default
19504 when the compiler is configured for 68020-based systems.
19505 It is equivalent to @option{-march=68020}.
19507 @item -m68030
19508 @opindex m68030
19509 Generate output for a 68030.  This is the default when the compiler is
19510 configured for 68030-based systems.  It is equivalent to
19511 @option{-march=68030}.
19513 @item -m68040
19514 @opindex m68040
19515 Generate output for a 68040.  This is the default when the compiler is
19516 configured for 68040-based systems.  It is equivalent to
19517 @option{-march=68040}.
19519 This option inhibits the use of 68881/68882 instructions that have to be
19520 emulated by software on the 68040.  Use this option if your 68040 does not
19521 have code to emulate those instructions.
19523 @item -m68060
19524 @opindex m68060
19525 Generate output for a 68060.  This is the default when the compiler is
19526 configured for 68060-based systems.  It is equivalent to
19527 @option{-march=68060}.
19529 This option inhibits the use of 68020 and 68881/68882 instructions that
19530 have to be emulated by software on the 68060.  Use this option if your 68060
19531 does not have code to emulate those instructions.
19533 @item -mcpu32
19534 @opindex mcpu32
19535 Generate output for a CPU32.  This is the default
19536 when the compiler is configured for CPU32-based systems.
19537 It is equivalent to @option{-march=cpu32}.
19539 Use this option for microcontrollers with a
19540 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19541 68336, 68340, 68341, 68349 and 68360.
19543 @item -m5200
19544 @opindex m5200
19545 Generate output for a 520X ColdFire CPU@.  This is the default
19546 when the compiler is configured for 520X-based systems.
19547 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19548 in favor of that option.
19550 Use this option for microcontroller with a 5200 core, including
19551 the MCF5202, MCF5203, MCF5204 and MCF5206.
19553 @item -m5206e
19554 @opindex m5206e
19555 Generate output for a 5206e ColdFire CPU@.  The option is now
19556 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19558 @item -m528x
19559 @opindex m528x
19560 Generate output for a member of the ColdFire 528X family.
19561 The option is now deprecated in favor of the equivalent
19562 @option{-mcpu=528x}.
19564 @item -m5307
19565 @opindex m5307
19566 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19567 in favor of the equivalent @option{-mcpu=5307}.
19569 @item -m5407
19570 @opindex m5407
19571 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19572 in favor of the equivalent @option{-mcpu=5407}.
19574 @item -mcfv4e
19575 @opindex mcfv4e
19576 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19577 This includes use of hardware floating-point instructions.
19578 The option is equivalent to @option{-mcpu=547x}, and is now
19579 deprecated in favor of that option.
19581 @item -m68020-40
19582 @opindex m68020-40
19583 Generate output for a 68040, without using any of the new instructions.
19584 This results in code that can run relatively efficiently on either a
19585 68020/68881 or a 68030 or a 68040.  The generated code does use the
19586 68881 instructions that are emulated on the 68040.
19588 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19590 @item -m68020-60
19591 @opindex m68020-60
19592 Generate output for a 68060, without using any of the new instructions.
19593 This results in code that can run relatively efficiently on either a
19594 68020/68881 or a 68030 or a 68040.  The generated code does use the
19595 68881 instructions that are emulated on the 68060.
19597 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19599 @item -mhard-float
19600 @itemx -m68881
19601 @opindex mhard-float
19602 @opindex m68881
19603 Generate floating-point instructions.  This is the default for 68020
19604 and above, and for ColdFire devices that have an FPU@.  It defines the
19605 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19606 on ColdFire targets.
19608 @item -msoft-float
19609 @opindex msoft-float
19610 Do not generate floating-point instructions; use library calls instead.
19611 This is the default for 68000, 68010, and 68832 targets.  It is also
19612 the default for ColdFire devices that have no FPU.
19614 @item -mdiv
19615 @itemx -mno-div
19616 @opindex mdiv
19617 @opindex mno-div
19618 Generate (do not generate) ColdFire hardware divide and remainder
19619 instructions.  If @option{-march} is used without @option{-mcpu},
19620 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19621 architectures.  Otherwise, the default is taken from the target CPU
19622 (either the default CPU, or the one specified by @option{-mcpu}).  For
19623 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19624 @option{-mcpu=5206e}.
19626 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19628 @item -mshort
19629 @opindex mshort
19630 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19631 Additionally, parameters passed on the stack are also aligned to a
19632 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19634 @item -mno-short
19635 @opindex mno-short
19636 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19638 @item -mnobitfield
19639 @itemx -mno-bitfield
19640 @opindex mnobitfield
19641 @opindex mno-bitfield
19642 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19643 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19645 @item -mbitfield
19646 @opindex mbitfield
19647 Do use the bit-field instructions.  The @option{-m68020} option implies
19648 @option{-mbitfield}.  This is the default if you use a configuration
19649 designed for a 68020.
19651 @item -mrtd
19652 @opindex mrtd
19653 Use a different function-calling convention, in which functions
19654 that take a fixed number of arguments return with the @code{rtd}
19655 instruction, which pops their arguments while returning.  This
19656 saves one instruction in the caller since there is no need to pop
19657 the arguments there.
19659 This calling convention is incompatible with the one normally
19660 used on Unix, so you cannot use it if you need to call libraries
19661 compiled with the Unix compiler.
19663 Also, you must provide function prototypes for all functions that
19664 take variable numbers of arguments (including @code{printf});
19665 otherwise incorrect code is generated for calls to those
19666 functions.
19668 In addition, seriously incorrect code results if you call a
19669 function with too many arguments.  (Normally, extra arguments are
19670 harmlessly ignored.)
19672 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19673 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19675 @item -mno-rtd
19676 @opindex mno-rtd
19677 Do not use the calling conventions selected by @option{-mrtd}.
19678 This is the default.
19680 @item -malign-int
19681 @itemx -mno-align-int
19682 @opindex malign-int
19683 @opindex mno-align-int
19684 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19685 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19686 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19687 Aligning variables on 32-bit boundaries produces code that runs somewhat
19688 faster on processors with 32-bit busses at the expense of more memory.
19690 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19691 aligns structures containing the above types differently than
19692 most published application binary interface specifications for the m68k.
19694 @item -mpcrel
19695 @opindex mpcrel
19696 Use the pc-relative addressing mode of the 68000 directly, instead of
19697 using a global offset table.  At present, this option implies @option{-fpic},
19698 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19699 not presently supported with @option{-mpcrel}, though this could be supported for
19700 68020 and higher processors.
19702 @item -mno-strict-align
19703 @itemx -mstrict-align
19704 @opindex mno-strict-align
19705 @opindex mstrict-align
19706 Do not (do) assume that unaligned memory references are handled by
19707 the system.
19709 @item -msep-data
19710 Generate code that allows the data segment to be located in a different
19711 area of memory from the text segment.  This allows for execute-in-place in
19712 an environment without virtual memory management.  This option implies
19713 @option{-fPIC}.
19715 @item -mno-sep-data
19716 Generate code that assumes that the data segment follows the text segment.
19717 This is the default.
19719 @item -mid-shared-library
19720 Generate code that supports shared libraries via the library ID method.
19721 This allows for execute-in-place and shared libraries in an environment
19722 without virtual memory management.  This option implies @option{-fPIC}.
19724 @item -mno-id-shared-library
19725 Generate code that doesn't assume ID-based shared libraries are being used.
19726 This is the default.
19728 @item -mshared-library-id=n
19729 Specifies the identification number of the ID-based shared library being
19730 compiled.  Specifying a value of 0 generates more compact code; specifying
19731 other values forces the allocation of that number to the current
19732 library, but is no more space- or time-efficient than omitting this option.
19734 @item -mxgot
19735 @itemx -mno-xgot
19736 @opindex mxgot
19737 @opindex mno-xgot
19738 When generating position-independent code for ColdFire, generate code
19739 that works if the GOT has more than 8192 entries.  This code is
19740 larger and slower than code generated without this option.  On M680x0
19741 processors, this option is not needed; @option{-fPIC} suffices.
19743 GCC normally uses a single instruction to load values from the GOT@.
19744 While this is relatively efficient, it only works if the GOT
19745 is smaller than about 64k.  Anything larger causes the linker
19746 to report an error such as:
19748 @cindex relocation truncated to fit (ColdFire)
19749 @smallexample
19750 relocation truncated to fit: R_68K_GOT16O foobar
19751 @end smallexample
19753 If this happens, you should recompile your code with @option{-mxgot}.
19754 It should then work with very large GOTs.  However, code generated with
19755 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19756 the value of a global symbol.
19758 Note that some linkers, including newer versions of the GNU linker,
19759 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19760 you should only need to use @option{-mxgot} when compiling a single
19761 object file that accesses more than 8192 GOT entries.  Very few do.
19763 These options have no effect unless GCC is generating
19764 position-independent code.
19766 @item -mlong-jump-table-offsets
19767 @opindex mlong-jump-table-offsets
19768 Use 32-bit offsets in @code{switch} tables.  The default is to use
19769 16-bit offsets.
19771 @end table
19773 @node MCore Options
19774 @subsection MCore Options
19775 @cindex MCore options
19777 These are the @samp{-m} options defined for the Motorola M*Core
19778 processors.
19780 @table @gcctabopt
19782 @item -mhardlit
19783 @itemx -mno-hardlit
19784 @opindex mhardlit
19785 @opindex mno-hardlit
19786 Inline constants into the code stream if it can be done in two
19787 instructions or less.
19789 @item -mdiv
19790 @itemx -mno-div
19791 @opindex mdiv
19792 @opindex mno-div
19793 Use the divide instruction.  (Enabled by default).
19795 @item -mrelax-immediate
19796 @itemx -mno-relax-immediate
19797 @opindex mrelax-immediate
19798 @opindex mno-relax-immediate
19799 Allow arbitrary-sized immediates in bit operations.
19801 @item -mwide-bitfields
19802 @itemx -mno-wide-bitfields
19803 @opindex mwide-bitfields
19804 @opindex mno-wide-bitfields
19805 Always treat bit-fields as @code{int}-sized.
19807 @item -m4byte-functions
19808 @itemx -mno-4byte-functions
19809 @opindex m4byte-functions
19810 @opindex mno-4byte-functions
19811 Force all functions to be aligned to a 4-byte boundary.
19813 @item -mcallgraph-data
19814 @itemx -mno-callgraph-data
19815 @opindex mcallgraph-data
19816 @opindex mno-callgraph-data
19817 Emit callgraph information.
19819 @item -mslow-bytes
19820 @itemx -mno-slow-bytes
19821 @opindex mslow-bytes
19822 @opindex mno-slow-bytes
19823 Prefer word access when reading byte quantities.
19825 @item -mlittle-endian
19826 @itemx -mbig-endian
19827 @opindex mlittle-endian
19828 @opindex mbig-endian
19829 Generate code for a little-endian target.
19831 @item -m210
19832 @itemx -m340
19833 @opindex m210
19834 @opindex m340
19835 Generate code for the 210 processor.
19837 @item -mno-lsim
19838 @opindex mno-lsim
19839 Assume that runtime support has been provided and so omit the
19840 simulator library (@file{libsim.a)} from the linker command line.
19842 @item -mstack-increment=@var{size}
19843 @opindex mstack-increment
19844 Set the maximum amount for a single stack increment operation.  Large
19845 values can increase the speed of programs that contain functions
19846 that need a large amount of stack space, but they can also trigger a
19847 segmentation fault if the stack is extended too much.  The default
19848 value is 0x1000.
19850 @end table
19852 @node MeP Options
19853 @subsection MeP Options
19854 @cindex MeP options
19856 @table @gcctabopt
19858 @item -mabsdiff
19859 @opindex mabsdiff
19860 Enables the @code{abs} instruction, which is the absolute difference
19861 between two registers.
19863 @item -mall-opts
19864 @opindex mall-opts
19865 Enables all the optional instructions---average, multiply, divide, bit
19866 operations, leading zero, absolute difference, min/max, clip, and
19867 saturation.
19870 @item -maverage
19871 @opindex maverage
19872 Enables the @code{ave} instruction, which computes the average of two
19873 registers.
19875 @item -mbased=@var{n}
19876 @opindex mbased=
19877 Variables of size @var{n} bytes or smaller are placed in the
19878 @code{.based} section by default.  Based variables use the @code{$tp}
19879 register as a base register, and there is a 128-byte limit to the
19880 @code{.based} section.
19882 @item -mbitops
19883 @opindex mbitops
19884 Enables the bit operation instructions---bit test (@code{btstm}), set
19885 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19886 test-and-set (@code{tas}).
19888 @item -mc=@var{name}
19889 @opindex mc=
19890 Selects which section constant data is placed in.  @var{name} may
19891 be @samp{tiny}, @samp{near}, or @samp{far}.
19893 @item -mclip
19894 @opindex mclip
19895 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19896 useful unless you also provide @option{-mminmax}.
19898 @item -mconfig=@var{name}
19899 @opindex mconfig=
19900 Selects one of the built-in core configurations.  Each MeP chip has
19901 one or more modules in it; each module has a core CPU and a variety of
19902 coprocessors, optional instructions, and peripherals.  The
19903 @code{MeP-Integrator} tool, not part of GCC, provides these
19904 configurations through this option; using this option is the same as
19905 using all the corresponding command-line options.  The default
19906 configuration is @samp{default}.
19908 @item -mcop
19909 @opindex mcop
19910 Enables the coprocessor instructions.  By default, this is a 32-bit
19911 coprocessor.  Note that the coprocessor is normally enabled via the
19912 @option{-mconfig=} option.
19914 @item -mcop32
19915 @opindex mcop32
19916 Enables the 32-bit coprocessor's instructions.
19918 @item -mcop64
19919 @opindex mcop64
19920 Enables the 64-bit coprocessor's instructions.
19922 @item -mivc2
19923 @opindex mivc2
19924 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19926 @item -mdc
19927 @opindex mdc
19928 Causes constant variables to be placed in the @code{.near} section.
19930 @item -mdiv
19931 @opindex mdiv
19932 Enables the @code{div} and @code{divu} instructions.
19934 @item -meb
19935 @opindex meb
19936 Generate big-endian code.
19938 @item -mel
19939 @opindex mel
19940 Generate little-endian code.
19942 @item -mio-volatile
19943 @opindex mio-volatile
19944 Tells the compiler that any variable marked with the @code{io}
19945 attribute is to be considered volatile.
19947 @item -ml
19948 @opindex ml
19949 Causes variables to be assigned to the @code{.far} section by default.
19951 @item -mleadz
19952 @opindex mleadz
19953 Enables the @code{leadz} (leading zero) instruction.
19955 @item -mm
19956 @opindex mm
19957 Causes variables to be assigned to the @code{.near} section by default.
19959 @item -mminmax
19960 @opindex mminmax
19961 Enables the @code{min} and @code{max} instructions.
19963 @item -mmult
19964 @opindex mmult
19965 Enables the multiplication and multiply-accumulate instructions.
19967 @item -mno-opts
19968 @opindex mno-opts
19969 Disables all the optional instructions enabled by @option{-mall-opts}.
19971 @item -mrepeat
19972 @opindex mrepeat
19973 Enables the @code{repeat} and @code{erepeat} instructions, used for
19974 low-overhead looping.
19976 @item -ms
19977 @opindex ms
19978 Causes all variables to default to the @code{.tiny} section.  Note
19979 that there is a 65536-byte limit to this section.  Accesses to these
19980 variables use the @code{%gp} base register.
19982 @item -msatur
19983 @opindex msatur
19984 Enables the saturation instructions.  Note that the compiler does not
19985 currently generate these itself, but this option is included for
19986 compatibility with other tools, like @code{as}.
19988 @item -msdram
19989 @opindex msdram
19990 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19992 @item -msim
19993 @opindex msim
19994 Link the simulator run-time libraries.
19996 @item -msimnovec
19997 @opindex msimnovec
19998 Link the simulator runtime libraries, excluding built-in support
19999 for reset and exception vectors and tables.
20001 @item -mtf
20002 @opindex mtf
20003 Causes all functions to default to the @code{.far} section.  Without
20004 this option, functions default to the @code{.near} section.
20006 @item -mtiny=@var{n}
20007 @opindex mtiny=
20008 Variables that are @var{n} bytes or smaller are allocated to the
20009 @code{.tiny} section.  These variables use the @code{$gp} base
20010 register.  The default for this option is 4, but note that there's a
20011 65536-byte limit to the @code{.tiny} section.
20013 @end table
20015 @node MicroBlaze Options
20016 @subsection MicroBlaze Options
20017 @cindex MicroBlaze Options
20019 @table @gcctabopt
20021 @item -msoft-float
20022 @opindex msoft-float
20023 Use software emulation for floating point (default).
20025 @item -mhard-float
20026 @opindex mhard-float
20027 Use hardware floating-point instructions.
20029 @item -mmemcpy
20030 @opindex mmemcpy
20031 Do not optimize block moves, use @code{memcpy}.
20033 @item -mno-clearbss
20034 @opindex mno-clearbss
20035 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
20037 @item -mcpu=@var{cpu-type}
20038 @opindex mcpu=
20039 Use features of, and schedule code for, the given CPU.
20040 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
20041 where @var{X} is a major version, @var{YY} is the minor version, and
20042 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
20043 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
20045 @item -mxl-soft-mul
20046 @opindex mxl-soft-mul
20047 Use software multiply emulation (default).
20049 @item -mxl-soft-div
20050 @opindex mxl-soft-div
20051 Use software emulation for divides (default).
20053 @item -mxl-barrel-shift
20054 @opindex mxl-barrel-shift
20055 Use the hardware barrel shifter.
20057 @item -mxl-pattern-compare
20058 @opindex mxl-pattern-compare
20059 Use pattern compare instructions.
20061 @item -msmall-divides
20062 @opindex msmall-divides
20063 Use table lookup optimization for small signed integer divisions.
20065 @item -mxl-stack-check
20066 @opindex mxl-stack-check
20067 This option is deprecated.  Use @option{-fstack-check} instead.
20069 @item -mxl-gp-opt
20070 @opindex mxl-gp-opt
20071 Use GP-relative @code{.sdata}/@code{.sbss} sections.
20073 @item -mxl-multiply-high
20074 @opindex mxl-multiply-high
20075 Use multiply high instructions for high part of 32x32 multiply.
20077 @item -mxl-float-convert
20078 @opindex mxl-float-convert
20079 Use hardware floating-point conversion instructions.
20081 @item -mxl-float-sqrt
20082 @opindex mxl-float-sqrt
20083 Use hardware floating-point square root instruction.
20085 @item -mbig-endian
20086 @opindex mbig-endian
20087 Generate code for a big-endian target.
20089 @item -mlittle-endian
20090 @opindex mlittle-endian
20091 Generate code for a little-endian target.
20093 @item -mxl-reorder
20094 @opindex mxl-reorder
20095 Use reorder instructions (swap and byte reversed load/store).
20097 @item -mxl-mode-@var{app-model}
20098 Select application model @var{app-model}.  Valid models are
20099 @table @samp
20100 @item executable
20101 normal executable (default), uses startup code @file{crt0.o}.
20103 @item xmdstub
20104 for use with Xilinx Microprocessor Debugger (XMD) based
20105 software intrusive debug agent called xmdstub. This uses startup file
20106 @file{crt1.o} and sets the start address of the program to 0x800.
20108 @item bootstrap
20109 for applications that are loaded using a bootloader.
20110 This model uses startup file @file{crt2.o} which does not contain a processor
20111 reset vector handler. This is suitable for transferring control on a
20112 processor reset to the bootloader rather than the application.
20114 @item novectors
20115 for applications that do not require any of the
20116 MicroBlaze vectors. This option may be useful for applications running
20117 within a monitoring application. This model uses @file{crt3.o} as a startup file.
20118 @end table
20120 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
20121 @option{-mxl-mode-@var{app-model}}.
20123 @end table
20125 @node MIPS Options
20126 @subsection MIPS Options
20127 @cindex MIPS options
20129 @table @gcctabopt
20131 @item -EB
20132 @opindex EB
20133 Generate big-endian code.
20135 @item -EL
20136 @opindex EL
20137 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
20138 configurations.
20140 @item -march=@var{arch}
20141 @opindex march
20142 Generate code that runs on @var{arch}, which can be the name of a
20143 generic MIPS ISA, or the name of a particular processor.
20144 The ISA names are:
20145 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
20146 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
20147 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
20148 @samp{mips64r5} and @samp{mips64r6}.
20149 The processor names are:
20150 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
20151 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
20152 @samp{5kc}, @samp{5kf},
20153 @samp{20kc},
20154 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
20155 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
20156 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
20157 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
20158 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
20159 @samp{i6400},
20160 @samp{interaptiv},
20161 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
20162 @samp{m4k},
20163 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
20164 @samp{m5100}, @samp{m5101},
20165 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
20166 @samp{orion},
20167 @samp{p5600},
20168 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
20169 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
20170 @samp{rm7000}, @samp{rm9000},
20171 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
20172 @samp{sb1},
20173 @samp{sr71000},
20174 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
20175 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
20176 @samp{xlr} and @samp{xlp}.
20177 The special value @samp{from-abi} selects the
20178 most compatible architecture for the selected ABI (that is,
20179 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
20181 The native Linux/GNU toolchain also supports the value @samp{native},
20182 which selects the best architecture option for the host processor.
20183 @option{-march=native} has no effect if GCC does not recognize
20184 the processor.
20186 In processor names, a final @samp{000} can be abbreviated as @samp{k}
20187 (for example, @option{-march=r2k}).  Prefixes are optional, and
20188 @samp{vr} may be written @samp{r}.
20190 Names of the form @samp{@var{n}f2_1} refer to processors with
20191 FPUs clocked at half the rate of the core, names of the form
20192 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
20193 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
20194 processors with FPUs clocked a ratio of 3:2 with respect to the core.
20195 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
20196 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
20197 accepted as synonyms for @samp{@var{n}f1_1}.
20199 GCC defines two macros based on the value of this option.  The first
20200 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
20201 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
20202 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
20203 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
20204 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
20206 Note that the @code{_MIPS_ARCH} macro uses the processor names given
20207 above.  In other words, it has the full prefix and does not
20208 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
20209 the macro names the resolved architecture (either @code{"mips1"} or
20210 @code{"mips3"}).  It names the default architecture when no
20211 @option{-march} option is given.
20213 @item -mtune=@var{arch}
20214 @opindex mtune
20215 Optimize for @var{arch}.  Among other things, this option controls
20216 the way instructions are scheduled, and the perceived cost of arithmetic
20217 operations.  The list of @var{arch} values is the same as for
20218 @option{-march}.
20220 When this option is not used, GCC optimizes for the processor
20221 specified by @option{-march}.  By using @option{-march} and
20222 @option{-mtune} together, it is possible to generate code that
20223 runs on a family of processors, but optimize the code for one
20224 particular member of that family.
20226 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
20227 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
20228 @option{-march} ones described above.
20230 @item -mips1
20231 @opindex mips1
20232 Equivalent to @option{-march=mips1}.
20234 @item -mips2
20235 @opindex mips2
20236 Equivalent to @option{-march=mips2}.
20238 @item -mips3
20239 @opindex mips3
20240 Equivalent to @option{-march=mips3}.
20242 @item -mips4
20243 @opindex mips4
20244 Equivalent to @option{-march=mips4}.
20246 @item -mips32
20247 @opindex mips32
20248 Equivalent to @option{-march=mips32}.
20250 @item -mips32r3
20251 @opindex mips32r3
20252 Equivalent to @option{-march=mips32r3}.
20254 @item -mips32r5
20255 @opindex mips32r5
20256 Equivalent to @option{-march=mips32r5}.
20258 @item -mips32r6
20259 @opindex mips32r6
20260 Equivalent to @option{-march=mips32r6}.
20262 @item -mips64
20263 @opindex mips64
20264 Equivalent to @option{-march=mips64}.
20266 @item -mips64r2
20267 @opindex mips64r2
20268 Equivalent to @option{-march=mips64r2}.
20270 @item -mips64r3
20271 @opindex mips64r3
20272 Equivalent to @option{-march=mips64r3}.
20274 @item -mips64r5
20275 @opindex mips64r5
20276 Equivalent to @option{-march=mips64r5}.
20278 @item -mips64r6
20279 @opindex mips64r6
20280 Equivalent to @option{-march=mips64r6}.
20282 @item -mips16
20283 @itemx -mno-mips16
20284 @opindex mips16
20285 @opindex mno-mips16
20286 Generate (do not generate) MIPS16 code.  If GCC is targeting a
20287 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
20289 MIPS16 code generation can also be controlled on a per-function basis
20290 by means of @code{mips16} and @code{nomips16} attributes.
20291 @xref{Function Attributes}, for more information.
20293 @item -mflip-mips16
20294 @opindex mflip-mips16
20295 Generate MIPS16 code on alternating functions.  This option is provided
20296 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20297 not intended for ordinary use in compiling user code.
20299 @item -minterlink-compressed
20300 @itemx -mno-interlink-compressed
20301 @opindex minterlink-compressed
20302 @opindex mno-interlink-compressed
20303 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20304 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20306 For example, code using the standard ISA encoding cannot jump directly
20307 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20308 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20309 knows that the target of the jump is not compressed.
20311 @item -minterlink-mips16
20312 @itemx -mno-interlink-mips16
20313 @opindex minterlink-mips16
20314 @opindex mno-interlink-mips16
20315 Aliases of @option{-minterlink-compressed} and
20316 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
20317 and are retained for backwards compatibility.
20319 @item -mabi=32
20320 @itemx -mabi=o64
20321 @itemx -mabi=n32
20322 @itemx -mabi=64
20323 @itemx -mabi=eabi
20324 @opindex mabi=32
20325 @opindex mabi=o64
20326 @opindex mabi=n32
20327 @opindex mabi=64
20328 @opindex mabi=eabi
20329 Generate code for the given ABI@.
20331 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
20332 generates 64-bit code when you select a 64-bit architecture, but you
20333 can use @option{-mgp32} to get 32-bit code instead.
20335 For information about the O64 ABI, see
20336 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20338 GCC supports a variant of the o32 ABI in which floating-point registers
20339 are 64 rather than 32 bits wide.  You can select this combination with
20340 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20341 and @code{mfhc1} instructions and is therefore only supported for
20342 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20344 The register assignments for arguments and return values remain the
20345 same, but each scalar value is passed in a single 64-bit register
20346 rather than a pair of 32-bit registers.  For example, scalar
20347 floating-point values are returned in @samp{$f0} only, not a
20348 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20349 remains the same in that the even-numbered double-precision registers
20350 are saved.
20352 Two additional variants of the o32 ABI are supported to enable
20353 a transition from 32-bit to 64-bit registers.  These are FPXX
20354 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20355 The FPXX extension mandates that all code must execute correctly
20356 when run using 32-bit or 64-bit registers.  The code can be interlinked
20357 with either FP32 or FP64, but not both.
20358 The FP64A extension is similar to the FP64 extension but forbids the
20359 use of odd-numbered single-precision registers.  This can be used
20360 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20361 processors and allows both FP32 and FP64A code to interlink and
20362 run in the same process without changing FPU modes.
20364 @item -mabicalls
20365 @itemx -mno-abicalls
20366 @opindex mabicalls
20367 @opindex mno-abicalls
20368 Generate (do not generate) code that is suitable for SVR4-style
20369 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20370 systems.
20372 @item -mshared
20373 @itemx -mno-shared
20374 Generate (do not generate) code that is fully position-independent,
20375 and that can therefore be linked into shared libraries.  This option
20376 only affects @option{-mabicalls}.
20378 All @option{-mabicalls} code has traditionally been position-independent,
20379 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20380 as an extension, the GNU toolchain allows executables to use absolute
20381 accesses for locally-binding symbols.  It can also use shorter GP
20382 initialization sequences and generate direct calls to locally-defined
20383 functions.  This mode is selected by @option{-mno-shared}.
20385 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20386 objects that can only be linked by the GNU linker.  However, the option
20387 does not affect the ABI of the final executable; it only affects the ABI
20388 of relocatable objects.  Using @option{-mno-shared} generally makes
20389 executables both smaller and quicker.
20391 @option{-mshared} is the default.
20393 @item -mplt
20394 @itemx -mno-plt
20395 @opindex mplt
20396 @opindex mno-plt
20397 Assume (do not assume) that the static and dynamic linkers
20398 support PLTs and copy relocations.  This option only affects
20399 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20400 has no effect without @option{-msym32}.
20402 You can make @option{-mplt} the default by configuring
20403 GCC with @option{--with-mips-plt}.  The default is
20404 @option{-mno-plt} otherwise.
20406 @item -mxgot
20407 @itemx -mno-xgot
20408 @opindex mxgot
20409 @opindex mno-xgot
20410 Lift (do not lift) the usual restrictions on the size of the global
20411 offset table.
20413 GCC normally uses a single instruction to load values from the GOT@.
20414 While this is relatively efficient, it only works if the GOT
20415 is smaller than about 64k.  Anything larger causes the linker
20416 to report an error such as:
20418 @cindex relocation truncated to fit (MIPS)
20419 @smallexample
20420 relocation truncated to fit: R_MIPS_GOT16 foobar
20421 @end smallexample
20423 If this happens, you should recompile your code with @option{-mxgot}.
20424 This works with very large GOTs, although the code is also
20425 less efficient, since it takes three instructions to fetch the
20426 value of a global symbol.
20428 Note that some linkers can create multiple GOTs.  If you have such a
20429 linker, you should only need to use @option{-mxgot} when a single object
20430 file accesses more than 64k's worth of GOT entries.  Very few do.
20432 These options have no effect unless GCC is generating position
20433 independent code.
20435 @item -mgp32
20436 @opindex mgp32
20437 Assume that general-purpose registers are 32 bits wide.
20439 @item -mgp64
20440 @opindex mgp64
20441 Assume that general-purpose registers are 64 bits wide.
20443 @item -mfp32
20444 @opindex mfp32
20445 Assume that floating-point registers are 32 bits wide.
20447 @item -mfp64
20448 @opindex mfp64
20449 Assume that floating-point registers are 64 bits wide.
20451 @item -mfpxx
20452 @opindex mfpxx
20453 Do not assume the width of floating-point registers.
20455 @item -mhard-float
20456 @opindex mhard-float
20457 Use floating-point coprocessor instructions.
20459 @item -msoft-float
20460 @opindex msoft-float
20461 Do not use floating-point coprocessor instructions.  Implement
20462 floating-point calculations using library calls instead.
20464 @item -mno-float
20465 @opindex mno-float
20466 Equivalent to @option{-msoft-float}, but additionally asserts that the
20467 program being compiled does not perform any floating-point operations.
20468 This option is presently supported only by some bare-metal MIPS
20469 configurations, where it may select a special set of libraries
20470 that lack all floating-point support (including, for example, the
20471 floating-point @code{printf} formats).  
20472 If code compiled with @option{-mno-float} accidentally contains
20473 floating-point operations, it is likely to suffer a link-time
20474 or run-time failure.
20476 @item -msingle-float
20477 @opindex msingle-float
20478 Assume that the floating-point coprocessor only supports single-precision
20479 operations.
20481 @item -mdouble-float
20482 @opindex mdouble-float
20483 Assume that the floating-point coprocessor supports double-precision
20484 operations.  This is the default.
20486 @item -modd-spreg
20487 @itemx -mno-odd-spreg
20488 @opindex modd-spreg
20489 @opindex mno-odd-spreg
20490 Enable the use of odd-numbered single-precision floating-point registers
20491 for the o32 ABI.  This is the default for processors that are known to
20492 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20493 is set by default.
20495 @item -mabs=2008
20496 @itemx -mabs=legacy
20497 @opindex mabs=2008
20498 @opindex mabs=legacy
20499 These options control the treatment of the special not-a-number (NaN)
20500 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20501 @code{neg.@i{fmt}} machine instructions.
20503 By default or when @option{-mabs=legacy} is used the legacy
20504 treatment is selected.  In this case these instructions are considered
20505 arithmetic and avoided where correct operation is required and the
20506 input operand might be a NaN.  A longer sequence of instructions that
20507 manipulate the sign bit of floating-point datum manually is used
20508 instead unless the @option{-ffinite-math-only} option has also been
20509 specified.
20511 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20512 this case these instructions are considered non-arithmetic and therefore
20513 operating correctly in all cases, including in particular where the
20514 input operand is a NaN.  These instructions are therefore always used
20515 for the respective operations.
20517 @item -mnan=2008
20518 @itemx -mnan=legacy
20519 @opindex mnan=2008
20520 @opindex mnan=legacy
20521 These options control the encoding of the special not-a-number (NaN)
20522 IEEE 754 floating-point data.
20524 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20525 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20526 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20527 by the first bit of their trailing significand field being 1.
20529 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20530 this case qNaNs are denoted by the first bit of their trailing
20531 significand field being 1, whereas sNaNs are denoted by the first bit of
20532 their trailing significand field being 0.
20534 The default is @option{-mnan=legacy} unless GCC has been configured with
20535 @option{--with-nan=2008}.
20537 @item -mllsc
20538 @itemx -mno-llsc
20539 @opindex mllsc
20540 @opindex mno-llsc
20541 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20542 implement atomic memory built-in functions.  When neither option is
20543 specified, GCC uses the instructions if the target architecture
20544 supports them.
20546 @option{-mllsc} is useful if the runtime environment can emulate the
20547 instructions and @option{-mno-llsc} can be useful when compiling for
20548 nonstandard ISAs.  You can make either option the default by
20549 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20550 respectively.  @option{--with-llsc} is the default for some
20551 configurations; see the installation documentation for details.
20553 @item -mdsp
20554 @itemx -mno-dsp
20555 @opindex mdsp
20556 @opindex mno-dsp
20557 Use (do not use) revision 1 of the MIPS DSP ASE@.
20558 @xref{MIPS DSP Built-in Functions}.  This option defines the
20559 preprocessor macro @code{__mips_dsp}.  It also defines
20560 @code{__mips_dsp_rev} to 1.
20562 @item -mdspr2
20563 @itemx -mno-dspr2
20564 @opindex mdspr2
20565 @opindex mno-dspr2
20566 Use (do not use) revision 2 of the MIPS DSP ASE@.
20567 @xref{MIPS DSP Built-in Functions}.  This option defines the
20568 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20569 It also defines @code{__mips_dsp_rev} to 2.
20571 @item -msmartmips
20572 @itemx -mno-smartmips
20573 @opindex msmartmips
20574 @opindex mno-smartmips
20575 Use (do not use) the MIPS SmartMIPS ASE.
20577 @item -mpaired-single
20578 @itemx -mno-paired-single
20579 @opindex mpaired-single
20580 @opindex mno-paired-single
20581 Use (do not use) paired-single floating-point instructions.
20582 @xref{MIPS Paired-Single Support}.  This option requires
20583 hardware floating-point support to be enabled.
20585 @item -mdmx
20586 @itemx -mno-mdmx
20587 @opindex mdmx
20588 @opindex mno-mdmx
20589 Use (do not use) MIPS Digital Media Extension instructions.
20590 This option can only be used when generating 64-bit code and requires
20591 hardware floating-point support to be enabled.
20593 @item -mips3d
20594 @itemx -mno-mips3d
20595 @opindex mips3d
20596 @opindex mno-mips3d
20597 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20598 The option @option{-mips3d} implies @option{-mpaired-single}.
20600 @item -mmicromips
20601 @itemx -mno-micromips
20602 @opindex mmicromips
20603 @opindex mno-mmicromips
20604 Generate (do not generate) microMIPS code.
20606 MicroMIPS code generation can also be controlled on a per-function basis
20607 by means of @code{micromips} and @code{nomicromips} attributes.
20608 @xref{Function Attributes}, for more information.
20610 @item -mmt
20611 @itemx -mno-mt
20612 @opindex mmt
20613 @opindex mno-mt
20614 Use (do not use) MT Multithreading instructions.
20616 @item -mmcu
20617 @itemx -mno-mcu
20618 @opindex mmcu
20619 @opindex mno-mcu
20620 Use (do not use) the MIPS MCU ASE instructions.
20622 @item -meva
20623 @itemx -mno-eva
20624 @opindex meva
20625 @opindex mno-eva
20626 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20628 @item -mvirt
20629 @itemx -mno-virt
20630 @opindex mvirt
20631 @opindex mno-virt
20632 Use (do not use) the MIPS Virtualization (VZ) instructions.
20634 @item -mxpa
20635 @itemx -mno-xpa
20636 @opindex mxpa
20637 @opindex mno-xpa
20638 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20640 @item -mlong64
20641 @opindex mlong64
20642 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20643 an explanation of the default and the way that the pointer size is
20644 determined.
20646 @item -mlong32
20647 @opindex mlong32
20648 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20650 The default size of @code{int}s, @code{long}s and pointers depends on
20651 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20652 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20653 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20654 or the same size as integer registers, whichever is smaller.
20656 @item -msym32
20657 @itemx -mno-sym32
20658 @opindex msym32
20659 @opindex mno-sym32
20660 Assume (do not assume) that all symbols have 32-bit values, regardless
20661 of the selected ABI@.  This option is useful in combination with
20662 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20663 to generate shorter and faster references to symbolic addresses.
20665 @item -G @var{num}
20666 @opindex G
20667 Put definitions of externally-visible data in a small data section
20668 if that data is no bigger than @var{num} bytes.  GCC can then generate
20669 more efficient accesses to the data; see @option{-mgpopt} for details.
20671 The default @option{-G} option depends on the configuration.
20673 @item -mlocal-sdata
20674 @itemx -mno-local-sdata
20675 @opindex mlocal-sdata
20676 @opindex mno-local-sdata
20677 Extend (do not extend) the @option{-G} behavior to local data too,
20678 such as to static variables in C@.  @option{-mlocal-sdata} is the
20679 default for all configurations.
20681 If the linker complains that an application is using too much small data,
20682 you might want to try rebuilding the less performance-critical parts with
20683 @option{-mno-local-sdata}.  You might also want to build large
20684 libraries with @option{-mno-local-sdata}, so that the libraries leave
20685 more room for the main program.
20687 @item -mextern-sdata
20688 @itemx -mno-extern-sdata
20689 @opindex mextern-sdata
20690 @opindex mno-extern-sdata
20691 Assume (do not assume) that externally-defined data is in
20692 a small data section if the size of that data is within the @option{-G} limit.
20693 @option{-mextern-sdata} is the default for all configurations.
20695 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20696 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20697 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20698 is placed in a small data section.  If @var{Var} is defined by another
20699 module, you must either compile that module with a high-enough
20700 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20701 definition.  If @var{Var} is common, you must link the application
20702 with a high-enough @option{-G} setting.
20704 The easiest way of satisfying these restrictions is to compile
20705 and link every module with the same @option{-G} option.  However,
20706 you may wish to build a library that supports several different
20707 small data limits.  You can do this by compiling the library with
20708 the highest supported @option{-G} setting and additionally using
20709 @option{-mno-extern-sdata} to stop the library from making assumptions
20710 about externally-defined data.
20712 @item -mgpopt
20713 @itemx -mno-gpopt
20714 @opindex mgpopt
20715 @opindex mno-gpopt
20716 Use (do not use) GP-relative accesses for symbols that are known to be
20717 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20718 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20719 configurations.
20721 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20722 might not hold the value of @code{_gp}.  For example, if the code is
20723 part of a library that might be used in a boot monitor, programs that
20724 call boot monitor routines pass an unknown value in @code{$gp}.
20725 (In such situations, the boot monitor itself is usually compiled
20726 with @option{-G0}.)
20728 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20729 @option{-mno-extern-sdata}.
20731 @item -membedded-data
20732 @itemx -mno-embedded-data
20733 @opindex membedded-data
20734 @opindex mno-embedded-data
20735 Allocate variables to the read-only data section first if possible, then
20736 next in the small data section if possible, otherwise in data.  This gives
20737 slightly slower code than the default, but reduces the amount of RAM required
20738 when executing, and thus may be preferred for some embedded systems.
20740 @item -muninit-const-in-rodata
20741 @itemx -mno-uninit-const-in-rodata
20742 @opindex muninit-const-in-rodata
20743 @opindex mno-uninit-const-in-rodata
20744 Put uninitialized @code{const} variables in the read-only data section.
20745 This option is only meaningful in conjunction with @option{-membedded-data}.
20747 @item -mcode-readable=@var{setting}
20748 @opindex mcode-readable
20749 Specify whether GCC may generate code that reads from executable sections.
20750 There are three possible settings:
20752 @table @gcctabopt
20753 @item -mcode-readable=yes
20754 Instructions may freely access executable sections.  This is the
20755 default setting.
20757 @item -mcode-readable=pcrel
20758 MIPS16 PC-relative load instructions can access executable sections,
20759 but other instructions must not do so.  This option is useful on 4KSc
20760 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20761 It is also useful on processors that can be configured to have a dual
20762 instruction/data SRAM interface and that, like the M4K, automatically
20763 redirect PC-relative loads to the instruction RAM.
20765 @item -mcode-readable=no
20766 Instructions must not access executable sections.  This option can be
20767 useful on targets that are configured to have a dual instruction/data
20768 SRAM interface but that (unlike the M4K) do not automatically redirect
20769 PC-relative loads to the instruction RAM.
20770 @end table
20772 @item -msplit-addresses
20773 @itemx -mno-split-addresses
20774 @opindex msplit-addresses
20775 @opindex mno-split-addresses
20776 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20777 relocation operators.  This option has been superseded by
20778 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20780 @item -mexplicit-relocs
20781 @itemx -mno-explicit-relocs
20782 @opindex mexplicit-relocs
20783 @opindex mno-explicit-relocs
20784 Use (do not use) assembler relocation operators when dealing with symbolic
20785 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20786 is to use assembler macros instead.
20788 @option{-mexplicit-relocs} is the default if GCC was configured
20789 to use an assembler that supports relocation operators.
20791 @item -mcheck-zero-division
20792 @itemx -mno-check-zero-division
20793 @opindex mcheck-zero-division
20794 @opindex mno-check-zero-division
20795 Trap (do not trap) on integer division by zero.
20797 The default is @option{-mcheck-zero-division}.
20799 @item -mdivide-traps
20800 @itemx -mdivide-breaks
20801 @opindex mdivide-traps
20802 @opindex mdivide-breaks
20803 MIPS systems check for division by zero by generating either a
20804 conditional trap or a break instruction.  Using traps results in
20805 smaller code, but is only supported on MIPS II and later.  Also, some
20806 versions of the Linux kernel have a bug that prevents trap from
20807 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20808 allow conditional traps on architectures that support them and
20809 @option{-mdivide-breaks} to force the use of breaks.
20811 The default is usually @option{-mdivide-traps}, but this can be
20812 overridden at configure time using @option{--with-divide=breaks}.
20813 Divide-by-zero checks can be completely disabled using
20814 @option{-mno-check-zero-division}.
20816 @item -mload-store-pairs
20817 @itemx -mno-load-store-pairs
20818 @opindex mload-store-pairs
20819 @opindex mno-load-store-pairs
20820 Enable (disable) an optimization that pairs consecutive load or store
20821 instructions to enable load/store bonding.  This option is enabled by
20822 default but only takes effect when the selected architecture is known
20823 to support bonding.
20825 @item -mmemcpy
20826 @itemx -mno-memcpy
20827 @opindex mmemcpy
20828 @opindex mno-memcpy
20829 Force (do not force) the use of @code{memcpy} for non-trivial block
20830 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20831 most constant-sized copies.
20833 @item -mlong-calls
20834 @itemx -mno-long-calls
20835 @opindex mlong-calls
20836 @opindex mno-long-calls
20837 Disable (do not disable) use of the @code{jal} instruction.  Calling
20838 functions using @code{jal} is more efficient but requires the caller
20839 and callee to be in the same 256 megabyte segment.
20841 This option has no effect on abicalls code.  The default is
20842 @option{-mno-long-calls}.
20844 @item -mmad
20845 @itemx -mno-mad
20846 @opindex mmad
20847 @opindex mno-mad
20848 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20849 instructions, as provided by the R4650 ISA@.
20851 @item -mimadd
20852 @itemx -mno-imadd
20853 @opindex mimadd
20854 @opindex mno-imadd
20855 Enable (disable) use of the @code{madd} and @code{msub} integer
20856 instructions.  The default is @option{-mimadd} on architectures
20857 that support @code{madd} and @code{msub} except for the 74k 
20858 architecture where it was found to generate slower code.
20860 @item -mfused-madd
20861 @itemx -mno-fused-madd
20862 @opindex mfused-madd
20863 @opindex mno-fused-madd
20864 Enable (disable) use of the floating-point multiply-accumulate
20865 instructions, when they are available.  The default is
20866 @option{-mfused-madd}.
20868 On the R8000 CPU when multiply-accumulate instructions are used,
20869 the intermediate product is calculated to infinite precision
20870 and is not subject to the FCSR Flush to Zero bit.  This may be
20871 undesirable in some circumstances.  On other processors the result
20872 is numerically identical to the equivalent computation using
20873 separate multiply, add, subtract and negate instructions.
20875 @item -nocpp
20876 @opindex nocpp
20877 Tell the MIPS assembler to not run its preprocessor over user
20878 assembler files (with a @samp{.s} suffix) when assembling them.
20880 @item -mfix-24k
20881 @itemx -mno-fix-24k
20882 @opindex mfix-24k
20883 @opindex mno-fix-24k
20884 Work around the 24K E48 (lost data on stores during refill) errata.
20885 The workarounds are implemented by the assembler rather than by GCC@.
20887 @item -mfix-r4000
20888 @itemx -mno-fix-r4000
20889 @opindex mfix-r4000
20890 @opindex mno-fix-r4000
20891 Work around certain R4000 CPU errata:
20892 @itemize @minus
20893 @item
20894 A double-word or a variable shift may give an incorrect result if executed
20895 immediately after starting an integer division.
20896 @item
20897 A double-word or a variable shift may give an incorrect result if executed
20898 while an integer multiplication is in progress.
20899 @item
20900 An integer division may give an incorrect result if started in a delay slot
20901 of a taken branch or a jump.
20902 @end itemize
20904 @item -mfix-r4400
20905 @itemx -mno-fix-r4400
20906 @opindex mfix-r4400
20907 @opindex mno-fix-r4400
20908 Work around certain R4400 CPU errata:
20909 @itemize @minus
20910 @item
20911 A double-word or a variable shift may give an incorrect result if executed
20912 immediately after starting an integer division.
20913 @end itemize
20915 @item -mfix-r10000
20916 @itemx -mno-fix-r10000
20917 @opindex mfix-r10000
20918 @opindex mno-fix-r10000
20919 Work around certain R10000 errata:
20920 @itemize @minus
20921 @item
20922 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20923 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20924 @end itemize
20926 This option can only be used if the target architecture supports
20927 branch-likely instructions.  @option{-mfix-r10000} is the default when
20928 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20929 otherwise.
20931 @item -mfix-rm7000
20932 @itemx -mno-fix-rm7000
20933 @opindex mfix-rm7000
20934 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20935 workarounds are implemented by the assembler rather than by GCC@.
20937 @item -mfix-vr4120
20938 @itemx -mno-fix-vr4120
20939 @opindex mfix-vr4120
20940 Work around certain VR4120 errata:
20941 @itemize @minus
20942 @item
20943 @code{dmultu} does not always produce the correct result.
20944 @item
20945 @code{div} and @code{ddiv} do not always produce the correct result if one
20946 of the operands is negative.
20947 @end itemize
20948 The workarounds for the division errata rely on special functions in
20949 @file{libgcc.a}.  At present, these functions are only provided by
20950 the @code{mips64vr*-elf} configurations.
20952 Other VR4120 errata require a NOP to be inserted between certain pairs of
20953 instructions.  These errata are handled by the assembler, not by GCC itself.
20955 @item -mfix-vr4130
20956 @opindex mfix-vr4130
20957 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20958 workarounds are implemented by the assembler rather than by GCC,
20959 although GCC avoids using @code{mflo} and @code{mfhi} if the
20960 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20961 instructions are available instead.
20963 @item -mfix-sb1
20964 @itemx -mno-fix-sb1
20965 @opindex mfix-sb1
20966 Work around certain SB-1 CPU core errata.
20967 (This flag currently works around the SB-1 revision 2
20968 ``F1'' and ``F2'' floating-point errata.)
20970 @item -mr10k-cache-barrier=@var{setting}
20971 @opindex mr10k-cache-barrier
20972 Specify whether GCC should insert cache barriers to avoid the
20973 side-effects of speculation on R10K processors.
20975 In common with many processors, the R10K tries to predict the outcome
20976 of a conditional branch and speculatively executes instructions from
20977 the ``taken'' branch.  It later aborts these instructions if the
20978 predicted outcome is wrong.  However, on the R10K, even aborted
20979 instructions can have side effects.
20981 This problem only affects kernel stores and, depending on the system,
20982 kernel loads.  As an example, a speculatively-executed store may load
20983 the target memory into cache and mark the cache line as dirty, even if
20984 the store itself is later aborted.  If a DMA operation writes to the
20985 same area of memory before the ``dirty'' line is flushed, the cached
20986 data overwrites the DMA-ed data.  See the R10K processor manual
20987 for a full description, including other potential problems.
20989 One workaround is to insert cache barrier instructions before every memory
20990 access that might be speculatively executed and that might have side
20991 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20992 controls GCC's implementation of this workaround.  It assumes that
20993 aborted accesses to any byte in the following regions does not have
20994 side effects:
20996 @enumerate
20997 @item
20998 the memory occupied by the current function's stack frame;
21000 @item
21001 the memory occupied by an incoming stack argument;
21003 @item
21004 the memory occupied by an object with a link-time-constant address.
21005 @end enumerate
21007 It is the kernel's responsibility to ensure that speculative
21008 accesses to these regions are indeed safe.
21010 If the input program contains a function declaration such as:
21012 @smallexample
21013 void foo (void);
21014 @end smallexample
21016 then the implementation of @code{foo} must allow @code{j foo} and
21017 @code{jal foo} to be executed speculatively.  GCC honors this
21018 restriction for functions it compiles itself.  It expects non-GCC
21019 functions (such as hand-written assembly code) to do the same.
21021 The option has three forms:
21023 @table @gcctabopt
21024 @item -mr10k-cache-barrier=load-store
21025 Insert a cache barrier before a load or store that might be
21026 speculatively executed and that might have side effects even
21027 if aborted.
21029 @item -mr10k-cache-barrier=store
21030 Insert a cache barrier before a store that might be speculatively
21031 executed and that might have side effects even if aborted.
21033 @item -mr10k-cache-barrier=none
21034 Disable the insertion of cache barriers.  This is the default setting.
21035 @end table
21037 @item -mflush-func=@var{func}
21038 @itemx -mno-flush-func
21039 @opindex mflush-func
21040 Specifies the function to call to flush the I and D caches, or to not
21041 call any such function.  If called, the function must take the same
21042 arguments as the common @code{_flush_func}, that is, the address of the
21043 memory range for which the cache is being flushed, the size of the
21044 memory range, and the number 3 (to flush both caches).  The default
21045 depends on the target GCC was configured for, but commonly is either
21046 @code{_flush_func} or @code{__cpu_flush}.
21048 @item mbranch-cost=@var{num}
21049 @opindex mbranch-cost
21050 Set the cost of branches to roughly @var{num} ``simple'' instructions.
21051 This cost is only a heuristic and is not guaranteed to produce
21052 consistent results across releases.  A zero cost redundantly selects
21053 the default, which is based on the @option{-mtune} setting.
21055 @item -mbranch-likely
21056 @itemx -mno-branch-likely
21057 @opindex mbranch-likely
21058 @opindex mno-branch-likely
21059 Enable or disable use of Branch Likely instructions, regardless of the
21060 default for the selected architecture.  By default, Branch Likely
21061 instructions may be generated if they are supported by the selected
21062 architecture.  An exception is for the MIPS32 and MIPS64 architectures
21063 and processors that implement those architectures; for those, Branch
21064 Likely instructions are not be generated by default because the MIPS32
21065 and MIPS64 architectures specifically deprecate their use.
21067 @item -mcompact-branches=never
21068 @itemx -mcompact-branches=optimal
21069 @itemx -mcompact-branches=always
21070 @opindex mcompact-branches=never
21071 @opindex mcompact-branches=optimal
21072 @opindex mcompact-branches=always
21073 These options control which form of branches will be generated.  The
21074 default is @option{-mcompact-branches=optimal}.
21076 The @option{-mcompact-branches=never} option ensures that compact branch
21077 instructions will never be generated.
21079 The @option{-mcompact-branches=always} option ensures that a compact
21080 branch instruction will be generated if available.  If a compact branch
21081 instruction is not available, a delay slot form of the branch will be
21082 used instead.
21084 This option is supported from MIPS Release 6 onwards.
21086 The @option{-mcompact-branches=optimal} option will cause a delay slot
21087 branch to be used if one is available in the current ISA and the delay
21088 slot is successfully filled.  If the delay slot is not filled, a compact
21089 branch will be chosen if one is available.
21091 @item -mfp-exceptions
21092 @itemx -mno-fp-exceptions
21093 @opindex mfp-exceptions
21094 Specifies whether FP exceptions are enabled.  This affects how
21095 FP instructions are scheduled for some processors.
21096 The default is that FP exceptions are
21097 enabled.
21099 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
21100 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
21101 FP pipe.
21103 @item -mvr4130-align
21104 @itemx -mno-vr4130-align
21105 @opindex mvr4130-align
21106 The VR4130 pipeline is two-way superscalar, but can only issue two
21107 instructions together if the first one is 8-byte aligned.  When this
21108 option is enabled, GCC aligns pairs of instructions that it
21109 thinks should execute in parallel.
21111 This option only has an effect when optimizing for the VR4130.
21112 It normally makes code faster, but at the expense of making it bigger.
21113 It is enabled by default at optimization level @option{-O3}.
21115 @item -msynci
21116 @itemx -mno-synci
21117 @opindex msynci
21118 Enable (disable) generation of @code{synci} instructions on
21119 architectures that support it.  The @code{synci} instructions (if
21120 enabled) are generated when @code{__builtin___clear_cache} is
21121 compiled.
21123 This option defaults to @option{-mno-synci}, but the default can be
21124 overridden by configuring GCC with @option{--with-synci}.
21126 When compiling code for single processor systems, it is generally safe
21127 to use @code{synci}.  However, on many multi-core (SMP) systems, it
21128 does not invalidate the instruction caches on all cores and may lead
21129 to undefined behavior.
21131 @item -mrelax-pic-calls
21132 @itemx -mno-relax-pic-calls
21133 @opindex mrelax-pic-calls
21134 Try to turn PIC calls that are normally dispatched via register
21135 @code{$25} into direct calls.  This is only possible if the linker can
21136 resolve the destination at link time and if the destination is within
21137 range for a direct call.
21139 @option{-mrelax-pic-calls} is the default if GCC was configured to use
21140 an assembler and a linker that support the @code{.reloc} assembly
21141 directive and @option{-mexplicit-relocs} is in effect.  With
21142 @option{-mno-explicit-relocs}, this optimization can be performed by the
21143 assembler and the linker alone without help from the compiler.
21145 @item -mmcount-ra-address
21146 @itemx -mno-mcount-ra-address
21147 @opindex mmcount-ra-address
21148 @opindex mno-mcount-ra-address
21149 Emit (do not emit) code that allows @code{_mcount} to modify the
21150 calling function's return address.  When enabled, this option extends
21151 the usual @code{_mcount} interface with a new @var{ra-address}
21152 parameter, which has type @code{intptr_t *} and is passed in register
21153 @code{$12}.  @code{_mcount} can then modify the return address by
21154 doing both of the following:
21155 @itemize
21156 @item
21157 Returning the new address in register @code{$31}.
21158 @item
21159 Storing the new address in @code{*@var{ra-address}},
21160 if @var{ra-address} is nonnull.
21161 @end itemize
21163 The default is @option{-mno-mcount-ra-address}.
21165 @item -mframe-header-opt
21166 @itemx -mno-frame-header-opt
21167 @opindex mframe-header-opt
21168 Enable (disable) frame header optimization in the o32 ABI.  When using the
21169 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
21170 function to write out register arguments.  When enabled, this optimization
21171 will suppress the allocation of the frame header if it can be determined that
21172 it is unused.
21174 This optimization is off by default at all optimization levels.
21176 @item -mlxc1-sxc1
21177 @itemx -mno-lxc1-sxc1
21178 @opindex mlxc1-sxc1
21179 When applicable, enable (disable) the generation of @code{lwxc1},
21180 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
21182 @item -mmadd4
21183 @itemx -mno-madd4
21184 @opindex mmadd4
21185 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
21186 @code{madd.d} and related instructions.  Enabled by default.
21188 @end table
21190 @node MMIX Options
21191 @subsection MMIX Options
21192 @cindex MMIX Options
21194 These options are defined for the MMIX:
21196 @table @gcctabopt
21197 @item -mlibfuncs
21198 @itemx -mno-libfuncs
21199 @opindex mlibfuncs
21200 @opindex mno-libfuncs
21201 Specify that intrinsic library functions are being compiled, passing all
21202 values in registers, no matter the size.
21204 @item -mepsilon
21205 @itemx -mno-epsilon
21206 @opindex mepsilon
21207 @opindex mno-epsilon
21208 Generate floating-point comparison instructions that compare with respect
21209 to the @code{rE} epsilon register.
21211 @item -mabi=mmixware
21212 @itemx -mabi=gnu
21213 @opindex mabi=mmixware
21214 @opindex mabi=gnu
21215 Generate code that passes function parameters and return values that (in
21216 the called function) are seen as registers @code{$0} and up, as opposed to
21217 the GNU ABI which uses global registers @code{$231} and up.
21219 @item -mzero-extend
21220 @itemx -mno-zero-extend
21221 @opindex mzero-extend
21222 @opindex mno-zero-extend
21223 When reading data from memory in sizes shorter than 64 bits, use (do not
21224 use) zero-extending load instructions by default, rather than
21225 sign-extending ones.
21227 @item -mknuthdiv
21228 @itemx -mno-knuthdiv
21229 @opindex mknuthdiv
21230 @opindex mno-knuthdiv
21231 Make the result of a division yielding a remainder have the same sign as
21232 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
21233 remainder follows the sign of the dividend.  Both methods are
21234 arithmetically valid, the latter being almost exclusively used.
21236 @item -mtoplevel-symbols
21237 @itemx -mno-toplevel-symbols
21238 @opindex mtoplevel-symbols
21239 @opindex mno-toplevel-symbols
21240 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
21241 code can be used with the @code{PREFIX} assembly directive.
21243 @item -melf
21244 @opindex melf
21245 Generate an executable in the ELF format, rather than the default
21246 @samp{mmo} format used by the @command{mmix} simulator.
21248 @item -mbranch-predict
21249 @itemx -mno-branch-predict
21250 @opindex mbranch-predict
21251 @opindex mno-branch-predict
21252 Use (do not use) the probable-branch instructions, when static branch
21253 prediction indicates a probable branch.
21255 @item -mbase-addresses
21256 @itemx -mno-base-addresses
21257 @opindex mbase-addresses
21258 @opindex mno-base-addresses
21259 Generate (do not generate) code that uses @emph{base addresses}.  Using a
21260 base address automatically generates a request (handled by the assembler
21261 and the linker) for a constant to be set up in a global register.  The
21262 register is used for one or more base address requests within the range 0
21263 to 255 from the value held in the register.  The generally leads to short
21264 and fast code, but the number of different data items that can be
21265 addressed is limited.  This means that a program that uses lots of static
21266 data may require @option{-mno-base-addresses}.
21268 @item -msingle-exit
21269 @itemx -mno-single-exit
21270 @opindex msingle-exit
21271 @opindex mno-single-exit
21272 Force (do not force) generated code to have a single exit point in each
21273 function.
21274 @end table
21276 @node MN10300 Options
21277 @subsection MN10300 Options
21278 @cindex MN10300 options
21280 These @option{-m} options are defined for Matsushita MN10300 architectures:
21282 @table @gcctabopt
21283 @item -mmult-bug
21284 @opindex mmult-bug
21285 Generate code to avoid bugs in the multiply instructions for the MN10300
21286 processors.  This is the default.
21288 @item -mno-mult-bug
21289 @opindex mno-mult-bug
21290 Do not generate code to avoid bugs in the multiply instructions for the
21291 MN10300 processors.
21293 @item -mam33
21294 @opindex mam33
21295 Generate code using features specific to the AM33 processor.
21297 @item -mno-am33
21298 @opindex mno-am33
21299 Do not generate code using features specific to the AM33 processor.  This
21300 is the default.
21302 @item -mam33-2
21303 @opindex mam33-2
21304 Generate code using features specific to the AM33/2.0 processor.
21306 @item -mam34
21307 @opindex mam34
21308 Generate code using features specific to the AM34 processor.
21310 @item -mtune=@var{cpu-type}
21311 @opindex mtune
21312 Use the timing characteristics of the indicated CPU type when
21313 scheduling instructions.  This does not change the targeted processor
21314 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
21315 @samp{am33-2} or @samp{am34}.
21317 @item -mreturn-pointer-on-d0
21318 @opindex mreturn-pointer-on-d0
21319 When generating a function that returns a pointer, return the pointer
21320 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
21321 only in @code{a0}, and attempts to call such functions without a prototype
21322 result in errors.  Note that this option is on by default; use
21323 @option{-mno-return-pointer-on-d0} to disable it.
21325 @item -mno-crt0
21326 @opindex mno-crt0
21327 Do not link in the C run-time initialization object file.
21329 @item -mrelax
21330 @opindex mrelax
21331 Indicate to the linker that it should perform a relaxation optimization pass
21332 to shorten branches, calls and absolute memory addresses.  This option only
21333 has an effect when used on the command line for the final link step.
21335 This option makes symbolic debugging impossible.
21337 @item -mliw
21338 @opindex mliw
21339 Allow the compiler to generate @emph{Long Instruction Word}
21340 instructions if the target is the @samp{AM33} or later.  This is the
21341 default.  This option defines the preprocessor macro @code{__LIW__}.
21343 @item -mnoliw
21344 @opindex mnoliw
21345 Do not allow the compiler to generate @emph{Long Instruction Word}
21346 instructions.  This option defines the preprocessor macro
21347 @code{__NO_LIW__}.
21349 @item -msetlb
21350 @opindex msetlb
21351 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21352 instructions if the target is the @samp{AM33} or later.  This is the
21353 default.  This option defines the preprocessor macro @code{__SETLB__}.
21355 @item -mnosetlb
21356 @opindex mnosetlb
21357 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21358 instructions.  This option defines the preprocessor macro
21359 @code{__NO_SETLB__}.
21361 @end table
21363 @node Moxie Options
21364 @subsection Moxie Options
21365 @cindex Moxie Options
21367 @table @gcctabopt
21369 @item -meb
21370 @opindex meb
21371 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21372 configurations.
21374 @item -mel
21375 @opindex mel
21376 Generate little-endian code.
21378 @item -mmul.x
21379 @opindex mmul.x
21380 Generate mul.x and umul.x instructions.  This is the default for
21381 @samp{moxiebox-*-*} configurations.
21383 @item -mno-crt0
21384 @opindex mno-crt0
21385 Do not link in the C run-time initialization object file.
21387 @end table
21389 @node MSP430 Options
21390 @subsection MSP430 Options
21391 @cindex MSP430 Options
21393 These options are defined for the MSP430:
21395 @table @gcctabopt
21397 @item -masm-hex
21398 @opindex masm-hex
21399 Force assembly output to always use hex constants.  Normally such
21400 constants are signed decimals, but this option is available for
21401 testsuite and/or aesthetic purposes.
21403 @item -mmcu=
21404 @opindex mmcu=
21405 Select the MCU to target.  This is used to create a C preprocessor
21406 symbol based upon the MCU name, converted to upper case and pre- and
21407 post-fixed with @samp{__}.  This in turn is used by the
21408 @file{msp430.h} header file to select an MCU-specific supplementary
21409 header file.
21411 The option also sets the ISA to use.  If the MCU name is one that is
21412 known to only support the 430 ISA then that is selected, otherwise the
21413 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21414 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21415 name selects the 430X ISA.
21417 In addition an MCU-specific linker script is added to the linker
21418 command line.  The script's name is the name of the MCU with
21419 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21420 command line defines the C preprocessor symbol @code{__XXX__} and
21421 cause the linker to search for a script called @file{xxx.ld}.
21423 This option is also passed on to the assembler.
21425 @item -mwarn-mcu
21426 @itemx -mno-warn-mcu
21427 @opindex mwarn-mcu
21428 @opindex mno-warn-mcu
21429 This option enables or disables warnings about conflicts between the
21430 MCU name specified by the @option{-mmcu} option and the ISA set by the
21431 @option{-mcpu} option and/or the hardware multiply support set by the
21432 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21433 MCU names.  This option is on by default.
21435 @item -mcpu=
21436 @opindex mcpu=
21437 Specifies the ISA to use.  Accepted values are @samp{msp430},
21438 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21439 @option{-mmcu=} option should be used to select the ISA.
21441 @item -msim
21442 @opindex msim
21443 Link to the simulator runtime libraries and linker script.  Overrides
21444 any scripts that would be selected by the @option{-mmcu=} option.
21446 @item -mlarge
21447 @opindex mlarge
21448 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21450 @item -msmall
21451 @opindex msmall
21452 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21454 @item -mrelax
21455 @opindex mrelax
21456 This option is passed to the assembler and linker, and allows the
21457 linker to perform certain optimizations that cannot be done until
21458 the final link.
21460 @item mhwmult=
21461 @opindex mhwmult=
21462 Describes the type of hardware multiply supported by the target.
21463 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21464 for the original 16-bit-only multiply supported by early MCUs.
21465 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21466 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21467 A value of @samp{auto} can also be given.  This tells GCC to deduce
21468 the hardware multiply support based upon the MCU name provided by the
21469 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21470 the MCU name is not recognized then no hardware multiply support is
21471 assumed.  @code{auto} is the default setting.
21473 Hardware multiplies are normally performed by calling a library
21474 routine.  This saves space in the generated code.  When compiling at
21475 @option{-O3} or higher however the hardware multiplier is invoked
21476 inline.  This makes for bigger, but faster code.
21478 The hardware multiply routines disable interrupts whilst running and
21479 restore the previous interrupt state when they finish.  This makes
21480 them safe to use inside interrupt handlers as well as in normal code.
21482 @item -minrt
21483 @opindex minrt
21484 Enable the use of a minimum runtime environment - no static
21485 initializers or constructors.  This is intended for memory-constrained
21486 devices.  The compiler includes special symbols in some objects
21487 that tell the linker and runtime which code fragments are required.
21489 @item -mcode-region=
21490 @itemx -mdata-region=
21491 @opindex mcode-region
21492 @opindex mdata-region
21493 These options tell the compiler where to place functions and data that
21494 do not have one of the @code{lower}, @code{upper}, @code{either} or
21495 @code{section} attributes.  Possible values are @code{lower},
21496 @code{upper}, @code{either} or @code{any}.  The first three behave
21497 like the corresponding attribute.  The fourth possible value -
21498 @code{any} - is the default.  It leaves placement entirely up to the
21499 linker script and how it assigns the standard sections
21500 (@code{.text}, @code{.data}, etc) to the memory regions.
21502 @item -msilicon-errata=
21503 @opindex msilicon-errata
21504 This option passes on a request to assembler to enable the fixes for
21505 the named silicon errata.
21507 @item -msilicon-errata-warn=
21508 @opindex msilicon-errata-warn
21509 This option passes on a request to the assembler to enable warning
21510 messages when a silicon errata might need to be applied.
21512 @end table
21514 @node NDS32 Options
21515 @subsection NDS32 Options
21516 @cindex NDS32 Options
21518 These options are defined for NDS32 implementations:
21520 @table @gcctabopt
21522 @item -mbig-endian
21523 @opindex mbig-endian
21524 Generate code in big-endian mode.
21526 @item -mlittle-endian
21527 @opindex mlittle-endian
21528 Generate code in little-endian mode.
21530 @item -mreduced-regs
21531 @opindex mreduced-regs
21532 Use reduced-set registers for register allocation.
21534 @item -mfull-regs
21535 @opindex mfull-regs
21536 Use full-set registers for register allocation.
21538 @item -mcmov
21539 @opindex mcmov
21540 Generate conditional move instructions.
21542 @item -mno-cmov
21543 @opindex mno-cmov
21544 Do not generate conditional move instructions.
21546 @item -mext-perf
21547 @opindex mperf-ext
21548 Generate performance extension instructions.
21550 @item -mno-ext-perf
21551 @opindex mno-perf-ext
21552 Do not generate performance extension instructions.
21554 @item -mext-perf2
21555 @opindex mperf-ext
21556 Generate performance extension 2 instructions.
21558 @item -mno-ext-perf2
21559 @opindex mno-perf-ext
21560 Do not generate performance extension 2 instructions.
21562 @item -mext-string
21563 @opindex mperf-ext
21564 Generate string extension instructions.
21566 @item -mno-ext-string
21567 @opindex mno-perf-ext
21568 Do not generate string extension instructions.
21570 @item -mv3push
21571 @opindex mv3push
21572 Generate v3 push25/pop25 instructions.
21574 @item -mno-v3push
21575 @opindex mno-v3push
21576 Do not generate v3 push25/pop25 instructions.
21578 @item -m16-bit
21579 @opindex m16-bit
21580 Generate 16-bit instructions.
21582 @item -mno-16-bit
21583 @opindex mno-16-bit
21584 Do not generate 16-bit instructions.
21586 @item -misr-vector-size=@var{num}
21587 @opindex misr-vector-size
21588 Specify the size of each interrupt vector, which must be 4 or 16.
21590 @item -mcache-block-size=@var{num}
21591 @opindex mcache-block-size
21592 Specify the size of each cache block,
21593 which must be a power of 2 between 4 and 512.
21595 @item -march=@var{arch}
21596 @opindex march
21597 Specify the name of the target architecture.
21599 @item -mcmodel=@var{code-model}
21600 @opindex mcmodel
21601 Set the code model to one of
21602 @table @asis
21603 @item @samp{small}
21604 All the data and read-only data segments must be within 512KB addressing space.
21605 The text segment must be within 16MB addressing space.
21606 @item @samp{medium}
21607 The data segment must be within 512KB while the read-only data segment can be
21608 within 4GB addressing space.  The text segment should be still within 16MB
21609 addressing space.
21610 @item @samp{large}
21611 All the text and data segments can be within 4GB addressing space.
21612 @end table
21614 @item -mctor-dtor
21615 @opindex mctor-dtor
21616 Enable constructor/destructor feature.
21618 @item -mrelax
21619 @opindex mrelax
21620 Guide linker to relax instructions.
21622 @end table
21624 @node Nios II Options
21625 @subsection Nios II Options
21626 @cindex Nios II options
21627 @cindex Altera Nios II options
21629 These are the options defined for the Altera Nios II processor.
21631 @table @gcctabopt
21633 @item -G @var{num}
21634 @opindex G
21635 @cindex smaller data references
21636 Put global and static objects less than or equal to @var{num} bytes
21637 into the small data or BSS sections instead of the normal data or BSS
21638 sections.  The default value of @var{num} is 8.
21640 @item -mgpopt=@var{option}
21641 @itemx -mgpopt
21642 @itemx -mno-gpopt
21643 @opindex mgpopt
21644 @opindex mno-gpopt
21645 Generate (do not generate) GP-relative accesses.  The following 
21646 @var{option} names are recognized:
21648 @table @samp
21650 @item none
21651 Do not generate GP-relative accesses.
21653 @item local
21654 Generate GP-relative accesses for small data objects that are not 
21655 external, weak, or uninitialized common symbols.  
21656 Also use GP-relative addressing for objects that
21657 have been explicitly placed in a small data section via a @code{section}
21658 attribute.
21660 @item global
21661 As for @samp{local}, but also generate GP-relative accesses for
21662 small data objects that are external, weak, or common.  If you use this option,
21663 you must ensure that all parts of your program (including libraries) are
21664 compiled with the same @option{-G} setting.
21666 @item data
21667 Generate GP-relative accesses for all data objects in the program.  If you
21668 use this option, the entire data and BSS segments
21669 of your program must fit in 64K of memory and you must use an appropriate
21670 linker script to allocate them within the addressable range of the
21671 global pointer.
21673 @item all
21674 Generate GP-relative addresses for function pointers as well as data
21675 pointers.  If you use this option, the entire text, data, and BSS segments
21676 of your program must fit in 64K of memory and you must use an appropriate
21677 linker script to allocate them within the addressable range of the
21678 global pointer.
21680 @end table
21682 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21683 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21685 The default is @option{-mgpopt} except when @option{-fpic} or
21686 @option{-fPIC} is specified to generate position-independent code.
21687 Note that the Nios II ABI does not permit GP-relative accesses from
21688 shared libraries.
21690 You may need to specify @option{-mno-gpopt} explicitly when building
21691 programs that include large amounts of small data, including large
21692 GOT data sections.  In this case, the 16-bit offset for GP-relative
21693 addressing may not be large enough to allow access to the entire 
21694 small data section.
21696 @item -mgprel-sec=@var{regexp}
21697 @opindex mgprel-sec
21698 This option specifies additional section names that can be accessed via
21699 GP-relative addressing.  It is most useful in conjunction with 
21700 @code{section} attributes on variable declarations 
21701 (@pxref{Common Variable Attributes}) and a custom linker script.  
21702 The @var{regexp} is a POSIX Extended Regular Expression.
21704 This option does not affect the behavior of the @option{-G} option, and 
21705 and the specified sections are in addition to the standard @code{.sdata} 
21706 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21708 @item -mr0rel-sec=@var{regexp}
21709 @opindex mr0rel-sec
21710 This option specifies names of sections that can be accessed via a 
21711 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21712 of the 32-bit address space.  It is most useful in conjunction with 
21713 @code{section} attributes on variable declarations 
21714 (@pxref{Common Variable Attributes}) and a custom linker script.  
21715 The @var{regexp} is a POSIX Extended Regular Expression.
21717 In contrast to the use of GP-relative addressing for small data, 
21718 zero-based addressing is never generated by default and there are no 
21719 conventional section names used in standard linker scripts for sections
21720 in the low or high areas of memory.
21722 @item -mel
21723 @itemx -meb
21724 @opindex mel
21725 @opindex meb
21726 Generate little-endian (default) or big-endian (experimental) code,
21727 respectively.
21729 @item -march=@var{arch}
21730 @opindex march
21731 This specifies the name of the target Nios II architecture.  GCC uses this
21732 name to determine what kind of instructions it can emit when generating
21733 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21735 The preprocessor macro @code{__nios2_arch__} is available to programs,
21736 with value 1 or 2, indicating the targeted ISA level.
21738 @item -mbypass-cache
21739 @itemx -mno-bypass-cache
21740 @opindex mno-bypass-cache
21741 @opindex mbypass-cache
21742 Force all load and store instructions to always bypass cache by 
21743 using I/O variants of the instructions. The default is not to
21744 bypass the cache.
21746 @item -mno-cache-volatile 
21747 @itemx -mcache-volatile       
21748 @opindex mcache-volatile 
21749 @opindex mno-cache-volatile
21750 Volatile memory access bypass the cache using the I/O variants of 
21751 the load and store instructions. The default is not to bypass the cache.
21753 @item -mno-fast-sw-div
21754 @itemx -mfast-sw-div
21755 @opindex mno-fast-sw-div
21756 @opindex mfast-sw-div
21757 Do not use table-based fast divide for small numbers. The default 
21758 is to use the fast divide at @option{-O3} and above.
21760 @item -mno-hw-mul
21761 @itemx -mhw-mul
21762 @itemx -mno-hw-mulx
21763 @itemx -mhw-mulx
21764 @itemx -mno-hw-div
21765 @itemx -mhw-div
21766 @opindex mno-hw-mul
21767 @opindex mhw-mul
21768 @opindex mno-hw-mulx
21769 @opindex mhw-mulx
21770 @opindex mno-hw-div
21771 @opindex mhw-div
21772 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21773 instructions by the compiler. The default is to emit @code{mul}
21774 and not emit @code{div} and @code{mulx}.
21776 @item -mbmx
21777 @itemx -mno-bmx
21778 @itemx -mcdx
21779 @itemx -mno-cdx
21780 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21781 CDX (code density) instructions.  Enabling these instructions also
21782 requires @option{-march=r2}.  Since these instructions are optional
21783 extensions to the R2 architecture, the default is not to emit them.
21785 @item -mcustom-@var{insn}=@var{N}
21786 @itemx -mno-custom-@var{insn}
21787 @opindex mcustom-@var{insn}
21788 @opindex mno-custom-@var{insn}
21789 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21790 custom instruction with encoding @var{N} when generating code that uses 
21791 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21792 instruction 253 for single-precision floating-point add operations instead
21793 of the default behavior of using a library call.
21795 The following values of @var{insn} are supported.  Except as otherwise
21796 noted, floating-point operations are expected to be implemented with
21797 normal IEEE 754 semantics and correspond directly to the C operators or the
21798 equivalent GCC built-in functions (@pxref{Other Builtins}).
21800 Single-precision floating point:
21801 @table @asis
21803 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21804 Binary arithmetic operations.
21806 @item @samp{fnegs}
21807 Unary negation.
21809 @item @samp{fabss}
21810 Unary absolute value.
21812 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21813 Comparison operations.
21815 @item @samp{fmins}, @samp{fmaxs}
21816 Floating-point minimum and maximum.  These instructions are only
21817 generated if @option{-ffinite-math-only} is specified.
21819 @item @samp{fsqrts}
21820 Unary square root operation.
21822 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21823 Floating-point trigonometric and exponential functions.  These instructions
21824 are only generated if @option{-funsafe-math-optimizations} is also specified.
21826 @end table
21828 Double-precision floating point:
21829 @table @asis
21831 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21832 Binary arithmetic operations.
21834 @item @samp{fnegd}
21835 Unary negation.
21837 @item @samp{fabsd}
21838 Unary absolute value.
21840 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21841 Comparison operations.
21843 @item @samp{fmind}, @samp{fmaxd}
21844 Double-precision minimum and maximum.  These instructions are only
21845 generated if @option{-ffinite-math-only} is specified.
21847 @item @samp{fsqrtd}
21848 Unary square root operation.
21850 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21851 Double-precision trigonometric and exponential functions.  These instructions
21852 are only generated if @option{-funsafe-math-optimizations} is also specified.
21854 @end table
21856 Conversions:
21857 @table @asis
21858 @item @samp{fextsd}
21859 Conversion from single precision to double precision.
21861 @item @samp{ftruncds}
21862 Conversion from double precision to single precision.
21864 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21865 Conversion from floating point to signed or unsigned integer types, with
21866 truncation towards zero.
21868 @item @samp{round}
21869 Conversion from single-precision floating point to signed integer,
21870 rounding to the nearest integer and ties away from zero.
21871 This corresponds to the @code{__builtin_lroundf} function when
21872 @option{-fno-math-errno} is used.
21874 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21875 Conversion from signed or unsigned integer types to floating-point types.
21877 @end table
21879 In addition, all of the following transfer instructions for internal
21880 registers X and Y must be provided to use any of the double-precision
21881 floating-point instructions.  Custom instructions taking two
21882 double-precision source operands expect the first operand in the
21883 64-bit register X.  The other operand (or only operand of a unary
21884 operation) is given to the custom arithmetic instruction with the
21885 least significant half in source register @var{src1} and the most
21886 significant half in @var{src2}.  A custom instruction that returns a
21887 double-precision result returns the most significant 32 bits in the
21888 destination register and the other half in 32-bit register Y.  
21889 GCC automatically generates the necessary code sequences to write
21890 register X and/or read register Y when double-precision floating-point
21891 instructions are used.
21893 @table @asis
21895 @item @samp{fwrx}
21896 Write @var{src1} into the least significant half of X and @var{src2} into
21897 the most significant half of X.
21899 @item @samp{fwry}
21900 Write @var{src1} into Y.
21902 @item @samp{frdxhi}, @samp{frdxlo}
21903 Read the most or least (respectively) significant half of X and store it in
21904 @var{dest}.
21906 @item @samp{frdy}
21907 Read the value of Y and store it into @var{dest}.
21908 @end table
21910 Note that you can gain more local control over generation of Nios II custom
21911 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21912 and @code{target("no-custom-@var{insn}")} function attributes
21913 (@pxref{Function Attributes})
21914 or pragmas (@pxref{Function Specific Option Pragmas}).
21916 @item -mcustom-fpu-cfg=@var{name}
21917 @opindex mcustom-fpu-cfg
21919 This option enables a predefined, named set of custom instruction encodings
21920 (see @option{-mcustom-@var{insn}} above).  
21921 Currently, the following sets are defined:
21923 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21924 @gccoptlist{-mcustom-fmuls=252 @gol
21925 -mcustom-fadds=253 @gol
21926 -mcustom-fsubs=254 @gol
21927 -fsingle-precision-constant}
21929 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21930 @gccoptlist{-mcustom-fmuls=252 @gol
21931 -mcustom-fadds=253 @gol
21932 -mcustom-fsubs=254 @gol
21933 -mcustom-fdivs=255 @gol
21934 -fsingle-precision-constant}
21936 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21937 @gccoptlist{-mcustom-floatus=243 @gol
21938 -mcustom-fixsi=244 @gol
21939 -mcustom-floatis=245 @gol
21940 -mcustom-fcmpgts=246 @gol
21941 -mcustom-fcmples=249 @gol
21942 -mcustom-fcmpeqs=250 @gol
21943 -mcustom-fcmpnes=251 @gol
21944 -mcustom-fmuls=252 @gol
21945 -mcustom-fadds=253 @gol
21946 -mcustom-fsubs=254 @gol
21947 -mcustom-fdivs=255 @gol
21948 -fsingle-precision-constant}
21950 Custom instruction assignments given by individual
21951 @option{-mcustom-@var{insn}=} options override those given by
21952 @option{-mcustom-fpu-cfg=}, regardless of the
21953 order of the options on the command line.
21955 Note that you can gain more local control over selection of a FPU
21956 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21957 function attribute (@pxref{Function Attributes})
21958 or pragma (@pxref{Function Specific Option Pragmas}).
21960 @end table
21962 These additional @samp{-m} options are available for the Altera Nios II
21963 ELF (bare-metal) target:
21965 @table @gcctabopt
21967 @item -mhal
21968 @opindex mhal
21969 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21970 startup and termination code, and is typically used in conjunction with
21971 @option{-msys-crt0=} to specify the location of the alternate startup code
21972 provided by the HAL BSP.
21974 @item -msmallc
21975 @opindex msmallc
21976 Link with a limited version of the C library, @option{-lsmallc}, rather than
21977 Newlib.
21979 @item -msys-crt0=@var{startfile}
21980 @opindex msys-crt0
21981 @var{startfile} is the file name of the startfile (crt0) to use 
21982 when linking.  This option is only useful in conjunction with @option{-mhal}.
21984 @item -msys-lib=@var{systemlib}
21985 @opindex msys-lib
21986 @var{systemlib} is the library name of the library that provides
21987 low-level system calls required by the C library,
21988 e.g. @code{read} and @code{write}.
21989 This option is typically used to link with a library provided by a HAL BSP.
21991 @end table
21993 @node Nvidia PTX Options
21994 @subsection Nvidia PTX Options
21995 @cindex Nvidia PTX options
21996 @cindex nvptx options
21998 These options are defined for Nvidia PTX:
22000 @table @gcctabopt
22002 @item -m32
22003 @itemx -m64
22004 @opindex m32
22005 @opindex m64
22006 Generate code for 32-bit or 64-bit ABI.
22008 @item -mmainkernel
22009 @opindex mmainkernel
22010 Link in code for a __main kernel.  This is for stand-alone instead of
22011 offloading execution.
22013 @item -moptimize
22014 @opindex moptimize
22015 Apply partitioned execution optimizations.  This is the default when any
22016 level of optimization is selected.
22018 @item -msoft-stack
22019 @opindex msoft-stack
22020 Generate code that does not use @code{.local} memory
22021 directly for stack storage. Instead, a per-warp stack pointer is
22022 maintained explicitly. This enables variable-length stack allocation (with
22023 variable-length arrays or @code{alloca}), and when global memory is used for
22024 underlying storage, makes it possible to access automatic variables from other
22025 threads, or with atomic instructions. This code generation variant is used
22026 for OpenMP offloading, but the option is exposed on its own for the purpose
22027 of testing the compiler; to generate code suitable for linking into programs
22028 using OpenMP offloading, use option @option{-mgomp}.
22030 @item -muniform-simt
22031 @opindex muniform-simt
22032 Switch to code generation variant that allows to execute all threads in each
22033 warp, while maintaining memory state and side effects as if only one thread
22034 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
22035 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
22036 current lane index equals the master lane index), and the register being
22037 assigned is copied via a shuffle instruction from the master lane.  Outside of
22038 SIMD regions lane 0 is the master; inside, each thread sees itself as the
22039 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
22040 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
22041 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
22042 with current lane index to compute the master lane index.
22044 @item -mgomp
22045 @opindex mgomp
22046 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
22047 @option{-muniform-simt} options, and selects corresponding multilib variant.
22049 @end table
22051 @node PDP-11 Options
22052 @subsection PDP-11 Options
22053 @cindex PDP-11 Options
22055 These options are defined for the PDP-11:
22057 @table @gcctabopt
22058 @item -mfpu
22059 @opindex mfpu
22060 Use hardware FPP floating point.  This is the default.  (FIS floating
22061 point on the PDP-11/40 is not supported.)
22063 @item -msoft-float
22064 @opindex msoft-float
22065 Do not use hardware floating point.
22067 @item -mac0
22068 @opindex mac0
22069 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
22071 @item -mno-ac0
22072 @opindex mno-ac0
22073 Return floating-point results in memory.  This is the default.
22075 @item -m40
22076 @opindex m40
22077 Generate code for a PDP-11/40.
22079 @item -m45
22080 @opindex m45
22081 Generate code for a PDP-11/45.  This is the default.
22083 @item -m10
22084 @opindex m10
22085 Generate code for a PDP-11/10.
22087 @item -mbcopy-builtin
22088 @opindex mbcopy-builtin
22089 Use inline @code{movmemhi} patterns for copying memory.  This is the
22090 default.
22092 @item -mbcopy
22093 @opindex mbcopy
22094 Do not use inline @code{movmemhi} patterns for copying memory.
22096 @item -mint16
22097 @itemx -mno-int32
22098 @opindex mint16
22099 @opindex mno-int32
22100 Use 16-bit @code{int}.  This is the default.
22102 @item -mint32
22103 @itemx -mno-int16
22104 @opindex mint32
22105 @opindex mno-int16
22106 Use 32-bit @code{int}.
22108 @item -mfloat64
22109 @itemx -mno-float32
22110 @opindex mfloat64
22111 @opindex mno-float32
22112 Use 64-bit @code{float}.  This is the default.
22114 @item -mfloat32
22115 @itemx -mno-float64
22116 @opindex mfloat32
22117 @opindex mno-float64
22118 Use 32-bit @code{float}.
22120 @item -mabshi
22121 @opindex mabshi
22122 Use @code{abshi2} pattern.  This is the default.
22124 @item -mno-abshi
22125 @opindex mno-abshi
22126 Do not use @code{abshi2} pattern.
22128 @item -mbranch-expensive
22129 @opindex mbranch-expensive
22130 Pretend that branches are expensive.  This is for experimenting with
22131 code generation only.
22133 @item -mbranch-cheap
22134 @opindex mbranch-cheap
22135 Do not pretend that branches are expensive.  This is the default.
22137 @item -munix-asm
22138 @opindex munix-asm
22139 Use Unix assembler syntax.  This is the default when configured for
22140 @samp{pdp11-*-bsd}.
22142 @item -mdec-asm
22143 @opindex mdec-asm
22144 Use DEC assembler syntax.  This is the default when configured for any
22145 PDP-11 target other than @samp{pdp11-*-bsd}.
22146 @end table
22148 @node picoChip Options
22149 @subsection picoChip Options
22150 @cindex picoChip options
22152 These @samp{-m} options are defined for picoChip implementations:
22154 @table @gcctabopt
22156 @item -mae=@var{ae_type}
22157 @opindex mcpu
22158 Set the instruction set, register set, and instruction scheduling
22159 parameters for array element type @var{ae_type}.  Supported values
22160 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
22162 @option{-mae=ANY} selects a completely generic AE type.  Code
22163 generated with this option runs on any of the other AE types.  The
22164 code is not as efficient as it would be if compiled for a specific
22165 AE type, and some types of operation (e.g., multiplication) do not
22166 work properly on all types of AE.
22168 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
22169 for compiled code, and is the default.
22171 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
22172 option may suffer from poor performance of byte (char) manipulation,
22173 since the DSP AE does not provide hardware support for byte load/stores.
22175 @item -msymbol-as-address
22176 Enable the compiler to directly use a symbol name as an address in a
22177 load/store instruction, without first loading it into a
22178 register.  Typically, the use of this option generates larger
22179 programs, which run faster than when the option isn't used.  However, the
22180 results vary from program to program, so it is left as a user option,
22181 rather than being permanently enabled.
22183 @item -mno-inefficient-warnings
22184 Disables warnings about the generation of inefficient code.  These
22185 warnings can be generated, for example, when compiling code that
22186 performs byte-level memory operations on the MAC AE type.  The MAC AE has
22187 no hardware support for byte-level memory operations, so all byte
22188 load/stores must be synthesized from word load/store operations.  This is
22189 inefficient and a warning is generated to indicate
22190 that you should rewrite the code to avoid byte operations, or to target
22191 an AE type that has the necessary hardware support.  This option disables
22192 these warnings.
22194 @end table
22196 @node PowerPC Options
22197 @subsection PowerPC Options
22198 @cindex PowerPC options
22200 These are listed under @xref{RS/6000 and PowerPC Options}.
22202 @node PowerPC SPE Options
22203 @subsection PowerPC SPE Options
22204 @cindex PowerPC SPE options
22206 These @samp{-m} options are defined for PowerPC SPE:
22207 @table @gcctabopt
22208 @item -mmfcrf
22209 @itemx -mno-mfcrf
22210 @itemx -mpopcntb
22211 @itemx -mno-popcntb
22212 @opindex mmfcrf
22213 @opindex mno-mfcrf
22214 @opindex mpopcntb
22215 @opindex mno-popcntb
22216 You use these options to specify which instructions are available on the
22217 processor you are using.  The default value of these options is
22218 determined when configuring GCC@.  Specifying the
22219 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22220 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22221 rather than the options listed above.
22223 The @option{-mmfcrf} option allows GCC to generate the move from
22224 condition register field instruction implemented on the POWER4
22225 processor and other processors that support the PowerPC V2.01
22226 architecture.
22227 The @option{-mpopcntb} option allows GCC to generate the popcount and
22228 double-precision FP reciprocal estimate instruction implemented on the
22229 POWER5 processor and other processors that support the PowerPC V2.02
22230 architecture.
22232 @item -mcpu=@var{cpu_type}
22233 @opindex mcpu
22234 Set architecture type, register usage, and
22235 instruction scheduling parameters for machine type @var{cpu_type}.
22236 Supported values for @var{cpu_type} are @samp{8540}, @samp{8548},
22237 and @samp{native}.
22239 @option{-mcpu=powerpc} specifies pure 32-bit PowerPC (either
22240 endian), with an appropriate, generic processor model assumed for
22241 scheduling purposes.
22243 Specifying @samp{native} as cpu type detects and selects the
22244 architecture option that corresponds to the host processor of the
22245 system performing the compilation.
22246 @option{-mcpu=native} has no effect if GCC does not recognize the
22247 processor.
22249 The other options specify a specific processor.  Code generated under
22250 those options runs best on that processor, and may not run at all on
22251 others.
22253 The @option{-mcpu} options automatically enable or disable the
22254 following options:
22256 @gccoptlist{-mhard-float  -mmfcrf  -mmultiple @gol
22257 -mpopcntb -mpopcntd @gol
22258 -msingle-float -mdouble-float @gol
22259 -mfloat128}
22261 The particular options set for any particular CPU varies between
22262 compiler versions, depending on what setting seems to produce optimal
22263 code for that CPU; it doesn't necessarily reflect the actual hardware's
22264 capabilities.  If you wish to set an individual option to a particular
22265 value, you may specify it after the @option{-mcpu} option, like
22266 @option{-mcpu=8548}.
22268 @item -mtune=@var{cpu_type}
22269 @opindex mtune
22270 Set the instruction scheduling parameters for machine type
22271 @var{cpu_type}, but do not set the architecture type or register usage,
22272 as @option{-mcpu=@var{cpu_type}} does.  The same
22273 values for @var{cpu_type} are used for @option{-mtune} as for
22274 @option{-mcpu}.  If both are specified, the code generated uses the
22275 architecture and registers set by @option{-mcpu}, but the
22276 scheduling parameters set by @option{-mtune}.
22278 @item -msecure-plt
22279 @opindex msecure-plt
22280 Generate code that allows @command{ld} and @command{ld.so}
22281 to build executables and shared
22282 libraries with non-executable @code{.plt} and @code{.got} sections.
22283 This is a PowerPC
22284 32-bit SYSV ABI option.
22286 @item -mbss-plt
22287 @opindex mbss-plt
22288 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22289 fills in, and
22290 requires @code{.plt} and @code{.got}
22291 sections that are both writable and executable.
22292 This is a PowerPC 32-bit SYSV ABI option.
22294 @item -misel
22295 @itemx -mno-isel
22296 @opindex misel
22297 @opindex mno-isel
22298 This switch enables or disables the generation of ISEL instructions.
22300 @item -misel=@var{yes/no}
22301 This switch has been deprecated.  Use @option{-misel} and
22302 @option{-mno-isel} instead.
22304 @item -mspe
22305 @itemx -mno-spe
22306 @opindex mspe
22307 @opindex mno-spe
22308 This switch enables or disables the generation of SPE simd
22309 instructions.
22311 @item -mspe=@var{yes/no}
22312 This option has been deprecated.  Use @option{-mspe} and
22313 @option{-mno-spe} instead.
22315 @item -mfloat128
22316 @itemx -mno-float128
22317 @opindex mfloat128
22318 @opindex mno-float128
22319 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22320 and use either software emulation for IEEE 128-bit floating point or
22321 hardware instructions.
22323 @item -mfloat-gprs=@var{yes/single/double/no}
22324 @itemx -mfloat-gprs
22325 @opindex mfloat-gprs
22326 This switch enables or disables the generation of floating-point
22327 operations on the general-purpose registers for architectures that
22328 support it.
22330 The argument @samp{yes} or @samp{single} enables the use of
22331 single-precision floating-point operations.
22333 The argument @samp{double} enables the use of single and
22334 double-precision floating-point operations.
22336 The argument @samp{no} disables floating-point operations on the
22337 general-purpose registers.
22339 This option is currently only available on the MPC854x.
22341 @item -mfull-toc
22342 @itemx -mno-fp-in-toc
22343 @itemx -mno-sum-in-toc
22344 @itemx -mminimal-toc
22345 @opindex mfull-toc
22346 @opindex mno-fp-in-toc
22347 @opindex mno-sum-in-toc
22348 @opindex mminimal-toc
22349 Modify generation of the TOC (Table Of Contents), which is created for
22350 every executable file.  The @option{-mfull-toc} option is selected by
22351 default.  In that case, GCC allocates at least one TOC entry for
22352 each unique non-automatic variable reference in your program.  GCC
22353 also places floating-point constants in the TOC@.  However, only
22354 16,384 entries are available in the TOC@.
22356 If you receive a linker error message that saying you have overflowed
22357 the available TOC space, you can reduce the amount of TOC space used
22358 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22359 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22360 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22361 generate code to calculate the sum of an address and a constant at
22362 run time instead of putting that sum into the TOC@.  You may specify one
22363 or both of these options.  Each causes GCC to produce very slightly
22364 slower and larger code at the expense of conserving TOC space.
22366 If you still run out of space in the TOC even when you specify both of
22367 these options, specify @option{-mminimal-toc} instead.  This option causes
22368 GCC to make only one TOC entry for every file.  When you specify this
22369 option, GCC produces code that is slower and larger but which
22370 uses extremely little TOC space.  You may wish to use this option
22371 only on files that contain less frequently-executed code.
22373 @item -maix32
22374 @opindex maix32
22375 Disables the 64-bit ABI.  GCC defaults to @option{-maix32}.
22377 @item -mxl-compat
22378 @itemx -mno-xl-compat
22379 @opindex mxl-compat
22380 @opindex mno-xl-compat
22381 Produce code that conforms more closely to IBM XL compiler semantics
22382 when using AIX-compatible ABI@.  Pass floating-point arguments to
22383 prototyped functions beyond the register save area (RSA) on the stack
22384 in addition to argument FPRs.  Do not assume that most significant
22385 double in 128-bit long double value is properly rounded when comparing
22386 values and converting to double.  Use XL symbol names for long double
22387 support routines.
22389 The AIX calling convention was extended but not initially documented to
22390 handle an obscure K&R C case of calling a function that takes the
22391 address of its arguments with fewer arguments than declared.  IBM XL
22392 compilers access floating-point arguments that do not fit in the
22393 RSA from the stack when a subroutine is compiled without
22394 optimization.  Because always storing floating-point arguments on the
22395 stack is inefficient and rarely needed, this option is not enabled by
22396 default and only is necessary when calling subroutines compiled by IBM
22397 XL compilers without optimization.
22399 @item -malign-natural
22400 @itemx -malign-power
22401 @opindex malign-natural
22402 @opindex malign-power
22403 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22404 @option{-malign-natural} overrides the ABI-defined alignment of larger
22405 types, such as floating-point doubles, on their natural size-based boundary.
22406 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22407 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22409 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22410 is not supported.
22412 @item -msoft-float
22413 @itemx -mhard-float
22414 @opindex msoft-float
22415 @opindex mhard-float
22416 Generate code that does not use (uses) the floating-point register set.
22417 Software floating-point emulation is provided if you use the
22418 @option{-msoft-float} option, and pass the option to GCC when linking.
22420 @item -msingle-float
22421 @itemx -mdouble-float
22422 @opindex msingle-float
22423 @opindex mdouble-float
22424 Generate code for single- or double-precision floating-point operations.
22425 @option{-mdouble-float} implies @option{-msingle-float}.
22427 @item -mmultiple
22428 @itemx -mno-multiple
22429 @opindex mmultiple
22430 @opindex mno-multiple
22431 Generate code that uses (does not use) the load multiple word
22432 instructions and the store multiple word instructions.  These
22433 instructions are generated by default on POWER systems, and not
22434 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22435 PowerPC systems, since those instructions do not work when the
22436 processor is in little-endian mode.  The exceptions are PPC740 and
22437 PPC750 which permit these instructions in little-endian mode.
22439 @item -mupdate
22440 @itemx -mno-update
22441 @opindex mupdate
22442 @opindex mno-update
22443 Generate code that uses (does not use) the load or store instructions
22444 that update the base register to the address of the calculated memory
22445 location.  These instructions are generated by default.  If you use
22446 @option{-mno-update}, there is a small window between the time that the
22447 stack pointer is updated and the address of the previous frame is
22448 stored, which means code that walks the stack frame across interrupts or
22449 signals may get corrupted data.
22451 @item -mavoid-indexed-addresses
22452 @itemx -mno-avoid-indexed-addresses
22453 @opindex mavoid-indexed-addresses
22454 @opindex mno-avoid-indexed-addresses
22455 Generate code that tries to avoid (not avoid) the use of indexed load
22456 or store instructions. These instructions can incur a performance
22457 penalty on Power6 processors in certain situations, such as when
22458 stepping through large arrays that cross a 16M boundary.  This option
22459 is enabled by default when targeting Power6 and disabled otherwise.
22461 @item -mfused-madd
22462 @itemx -mno-fused-madd
22463 @opindex mfused-madd
22464 @opindex mno-fused-madd
22465 Generate code that uses (does not use) the floating-point multiply and
22466 accumulate instructions.  These instructions are generated by default
22467 if hardware floating point is used.  The machine-dependent
22468 @option{-mfused-madd} option is now mapped to the machine-independent
22469 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22470 mapped to @option{-ffp-contract=off}.
22472 @item -mno-strict-align
22473 @itemx -mstrict-align
22474 @opindex mno-strict-align
22475 @opindex mstrict-align
22476 On System V.4 and embedded PowerPC systems do not (do) assume that
22477 unaligned memory references are handled by the system.
22479 @item -mrelocatable
22480 @itemx -mno-relocatable
22481 @opindex mrelocatable
22482 @opindex mno-relocatable
22483 Generate code that allows (does not allow) a static executable to be
22484 relocated to a different address at run time.  A simple embedded
22485 PowerPC system loader should relocate the entire contents of
22486 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22487 a table of 32-bit addresses generated by this option.  For this to
22488 work, all objects linked together must be compiled with
22489 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22490 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22492 @item -mrelocatable-lib
22493 @itemx -mno-relocatable-lib
22494 @opindex mrelocatable-lib
22495 @opindex mno-relocatable-lib
22496 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22497 @code{.fixup} section to allow static executables to be relocated at
22498 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22499 alignment of @option{-mrelocatable}.  Objects compiled with
22500 @option{-mrelocatable-lib} may be linked with objects compiled with
22501 any combination of the @option{-mrelocatable} options.
22503 @item -mno-toc
22504 @itemx -mtoc
22505 @opindex mno-toc
22506 @opindex mtoc
22507 On System V.4 and embedded PowerPC systems do not (do) assume that
22508 register 2 contains a pointer to a global area pointing to the addresses
22509 used in the program.
22511 @item -mlittle
22512 @itemx -mlittle-endian
22513 @opindex mlittle
22514 @opindex mlittle-endian
22515 On System V.4 and embedded PowerPC systems compile code for the
22516 processor in little-endian mode.  The @option{-mlittle-endian} option is
22517 the same as @option{-mlittle}.
22519 @item -mbig
22520 @itemx -mbig-endian
22521 @opindex mbig
22522 @opindex mbig-endian
22523 On System V.4 and embedded PowerPC systems compile code for the
22524 processor in big-endian mode.  The @option{-mbig-endian} option is
22525 the same as @option{-mbig}.
22527 @item -mdynamic-no-pic
22528 @opindex mdynamic-no-pic
22529 On Darwin and Mac OS X systems, compile code so that it is not
22530 relocatable, but that its external references are relocatable.  The
22531 resulting code is suitable for applications, but not shared
22532 libraries.
22534 @item -msingle-pic-base
22535 @opindex msingle-pic-base
22536 Treat the register used for PIC addressing as read-only, rather than
22537 loading it in the prologue for each function.  The runtime system is
22538 responsible for initializing this register with an appropriate value
22539 before execution begins.
22541 @item -mprioritize-restricted-insns=@var{priority}
22542 @opindex mprioritize-restricted-insns
22543 This option controls the priority that is assigned to
22544 dispatch-slot restricted instructions during the second scheduling
22545 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22546 or @samp{2} to assign no, highest, or second-highest (respectively)
22547 priority to dispatch-slot restricted
22548 instructions.
22550 @item -msched-costly-dep=@var{dependence_type}
22551 @opindex msched-costly-dep
22552 This option controls which dependences are considered costly
22553 by the target during instruction scheduling.  The argument
22554 @var{dependence_type} takes one of the following values:
22556 @table @asis
22557 @item @samp{no}
22558 No dependence is costly.
22560 @item @samp{all}
22561 All dependences are costly.
22563 @item @samp{true_store_to_load}
22564 A true dependence from store to load is costly.
22566 @item @samp{store_to_load}
22567 Any dependence from store to load is costly.
22569 @item @var{number}
22570 Any dependence for which the latency is greater than or equal to
22571 @var{number} is costly.
22572 @end table
22574 @item -minsert-sched-nops=@var{scheme}
22575 @opindex minsert-sched-nops
22576 This option controls which NOP insertion scheme is used during
22577 the second scheduling pass.  The argument @var{scheme} takes one of the
22578 following values:
22580 @table @asis
22581 @item @samp{no}
22582 Don't insert NOPs.
22584 @item @samp{pad}
22585 Pad with NOPs any dispatch group that has vacant issue slots,
22586 according to the scheduler's grouping.
22588 @item @samp{regroup_exact}
22589 Insert NOPs to force costly dependent insns into
22590 separate groups.  Insert exactly as many NOPs as needed to force an insn
22591 to a new group, according to the estimated processor grouping.
22593 @item @var{number}
22594 Insert NOPs to force costly dependent insns into
22595 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22596 @end table
22598 @item -mcall-sysv
22599 @opindex mcall-sysv
22600 On System V.4 and embedded PowerPC systems compile code using calling
22601 conventions that adhere to the March 1995 draft of the System V
22602 Application Binary Interface, PowerPC processor supplement.  This is the
22603 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22605 @item -mcall-sysv-eabi
22606 @itemx -mcall-eabi
22607 @opindex mcall-sysv-eabi
22608 @opindex mcall-eabi
22609 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22611 @item -mcall-sysv-noeabi
22612 @opindex mcall-sysv-noeabi
22613 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22615 @item -mcall-aixdesc
22616 @opindex m
22617 On System V.4 and embedded PowerPC systems compile code for the AIX
22618 operating system.
22620 @item -mcall-linux
22621 @opindex mcall-linux
22622 On System V.4 and embedded PowerPC systems compile code for the
22623 Linux-based GNU system.
22625 @item -mcall-freebsd
22626 @opindex mcall-freebsd
22627 On System V.4 and embedded PowerPC systems compile code for the
22628 FreeBSD operating system.
22630 @item -mcall-netbsd
22631 @opindex mcall-netbsd
22632 On System V.4 and embedded PowerPC systems compile code for the
22633 NetBSD operating system.
22635 @item -mcall-openbsd
22636 @opindex mcall-netbsd
22637 On System V.4 and embedded PowerPC systems compile code for the
22638 OpenBSD operating system.
22640 @item -maix-struct-return
22641 @opindex maix-struct-return
22642 Return all structures in memory (as specified by the AIX ABI)@.
22644 @item -msvr4-struct-return
22645 @opindex msvr4-struct-return
22646 Return structures smaller than 8 bytes in registers (as specified by the
22647 SVR4 ABI)@.
22649 @item -mabi=@var{abi-type}
22650 @opindex mabi
22651 Extend the current ABI with a particular extension, or remove such extension.
22652 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22653 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22654 @samp{elfv1}, @samp{elfv2}@.
22656 @item -mabi=spe
22657 @opindex mabi=spe
22658 Extend the current ABI with SPE ABI extensions.  This does not change
22659 the default ABI, instead it adds the SPE ABI extensions to the current
22660 ABI@.
22662 @item -mabi=no-spe
22663 @opindex mabi=no-spe
22664 Disable Book-E SPE ABI extensions for the current ABI@.
22666 @item -mabi=ibmlongdouble
22667 @opindex mabi=ibmlongdouble
22668 Change the current ABI to use IBM extended-precision long double.
22669 This is not likely to work if your system defaults to using IEEE
22670 extended-precision long double.  If you change the long double type
22671 from IEEE extended-precision, the compiler will issue a warning unless
22672 you use the @option{-Wno-psabi} option.
22674 @item -mabi=ieeelongdouble
22675 @opindex mabi=ieeelongdouble
22676 Change the current ABI to use IEEE extended-precision long double.
22677 This is not likely to work if your system defaults to using IBM
22678 extended-precision long double.  If you change the long double type
22679 from IBM extended-precision, the compiler will issue a warning unless
22680 you use the @option{-Wno-psabi} option.
22682 @item -mabi=elfv1
22683 @opindex mabi=elfv1
22684 Change the current ABI to use the ELFv1 ABI.
22685 This is the default ABI for big-endian PowerPC 64-bit Linux.
22686 Overriding the default ABI requires special system support and is
22687 likely to fail in spectacular ways.
22689 @item -mabi=elfv2
22690 @opindex mabi=elfv2
22691 Change the current ABI to use the ELFv2 ABI.
22692 This is the default ABI for little-endian PowerPC 64-bit Linux.
22693 Overriding the default ABI requires special system support and is
22694 likely to fail in spectacular ways.
22696 @item -mgnu-attribute
22697 @itemx -mno-gnu-attribute
22698 @opindex mgnu-attribute
22699 @opindex mno-gnu-attribute
22700 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22701 .gnu.attributes section that specify ABI variations in function
22702 parameters or return values.
22704 @item -mprototype
22705 @itemx -mno-prototype
22706 @opindex mprototype
22707 @opindex mno-prototype
22708 On System V.4 and embedded PowerPC systems assume that all calls to
22709 variable argument functions are properly prototyped.  Otherwise, the
22710 compiler must insert an instruction before every non-prototyped call to
22711 set or clear bit 6 of the condition code register (@code{CR}) to
22712 indicate whether floating-point values are passed in the floating-point
22713 registers in case the function takes variable arguments.  With
22714 @option{-mprototype}, only calls to prototyped variable argument functions
22715 set or clear the bit.
22717 @item -msim
22718 @opindex msim
22719 On embedded PowerPC systems, assume that the startup module is called
22720 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22721 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22722 configurations.
22724 @item -mmvme
22725 @opindex mmvme
22726 On embedded PowerPC systems, assume that the startup module is called
22727 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22728 @file{libc.a}.
22730 @item -mads
22731 @opindex mads
22732 On embedded PowerPC systems, assume that the startup module is called
22733 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22734 @file{libc.a}.
22736 @item -myellowknife
22737 @opindex myellowknife
22738 On embedded PowerPC systems, assume that the startup module is called
22739 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22740 @file{libc.a}.
22742 @item -mvxworks
22743 @opindex mvxworks
22744 On System V.4 and embedded PowerPC systems, specify that you are
22745 compiling for a VxWorks system.
22747 @item -memb
22748 @opindex memb
22749 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22750 header to indicate that @samp{eabi} extended relocations are used.
22752 @item -meabi
22753 @itemx -mno-eabi
22754 @opindex meabi
22755 @opindex mno-eabi
22756 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22757 Embedded Applications Binary Interface (EABI), which is a set of
22758 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22759 means that the stack is aligned to an 8-byte boundary, a function
22760 @code{__eabi} is called from @code{main} to set up the EABI
22761 environment, and the @option{-msdata} option can use both @code{r2} and
22762 @code{r13} to point to two separate small data areas.  Selecting
22763 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22764 no EABI initialization function is called from @code{main}, and the
22765 @option{-msdata} option only uses @code{r13} to point to a single
22766 small data area.  The @option{-meabi} option is on by default if you
22767 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22769 @item -msdata=eabi
22770 @opindex msdata=eabi
22771 On System V.4 and embedded PowerPC systems, put small initialized
22772 @code{const} global and static data in the @code{.sdata2} section, which
22773 is pointed to by register @code{r2}.  Put small initialized
22774 non-@code{const} global and static data in the @code{.sdata} section,
22775 which is pointed to by register @code{r13}.  Put small uninitialized
22776 global and static data in the @code{.sbss} section, which is adjacent to
22777 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22778 incompatible with the @option{-mrelocatable} option.  The
22779 @option{-msdata=eabi} option also sets the @option{-memb} option.
22781 @item -msdata=sysv
22782 @opindex msdata=sysv
22783 On System V.4 and embedded PowerPC systems, put small global and static
22784 data in the @code{.sdata} section, which is pointed to by register
22785 @code{r13}.  Put small uninitialized global and static data in the
22786 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22787 The @option{-msdata=sysv} option is incompatible with the
22788 @option{-mrelocatable} option.
22790 @item -msdata=default
22791 @itemx -msdata
22792 @opindex msdata=default
22793 @opindex msdata
22794 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22795 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22796 same as @option{-msdata=sysv}.
22798 @item -msdata=data
22799 @opindex msdata=data
22800 On System V.4 and embedded PowerPC systems, put small global
22801 data in the @code{.sdata} section.  Put small uninitialized global
22802 data in the @code{.sbss} section.  Do not use register @code{r13}
22803 to address small data however.  This is the default behavior unless
22804 other @option{-msdata} options are used.
22806 @item -msdata=none
22807 @itemx -mno-sdata
22808 @opindex msdata=none
22809 @opindex mno-sdata
22810 On embedded PowerPC systems, put all initialized global and static data
22811 in the @code{.data} section, and all uninitialized data in the
22812 @code{.bss} section.
22814 @item -mblock-move-inline-limit=@var{num}
22815 @opindex mblock-move-inline-limit
22816 Inline all block moves (such as calls to @code{memcpy} or structure
22817 copies) less than or equal to @var{num} bytes.  The minimum value for
22818 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22819 targets.  The default value is target-specific.
22821 @item -G @var{num}
22822 @opindex G
22823 @cindex smaller data references (PowerPC)
22824 @cindex .sdata/.sdata2 references (PowerPC)
22825 On embedded PowerPC systems, put global and static items less than or
22826 equal to @var{num} bytes into the small data or BSS sections instead of
22827 the normal data or BSS section.  By default, @var{num} is 8.  The
22828 @option{-G @var{num}} switch is also passed to the linker.
22829 All modules should be compiled with the same @option{-G @var{num}} value.
22831 @item -mregnames
22832 @itemx -mno-regnames
22833 @opindex mregnames
22834 @opindex mno-regnames
22835 On System V.4 and embedded PowerPC systems do (do not) emit register
22836 names in the assembly language output using symbolic forms.
22838 @item -mlongcall
22839 @itemx -mno-longcall
22840 @opindex mlongcall
22841 @opindex mno-longcall
22842 By default assume that all calls are far away so that a longer and more
22843 expensive calling sequence is required.  This is required for calls
22844 farther than 32 megabytes (33,554,432 bytes) from the current location.
22845 A short call is generated if the compiler knows
22846 the call cannot be that far away.  This setting can be overridden by
22847 the @code{shortcall} function attribute, or by @code{#pragma
22848 longcall(0)}.
22850 Some linkers are capable of detecting out-of-range calls and generating
22851 glue code on the fly.  On these systems, long calls are unnecessary and
22852 generate slower code.  As of this writing, the AIX linker can do this,
22853 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22854 to the GNU linker for 32-bit PowerPC systems as well.
22856 In the future, GCC may ignore all longcall specifications
22857 when the linker is known to generate glue.
22859 @item -mtls-markers
22860 @itemx -mno-tls-markers
22861 @opindex mtls-markers
22862 @opindex mno-tls-markers
22863 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22864 specifying the function argument.  The relocation allows the linker to
22865 reliably associate function call with argument setup instructions for
22866 TLS optimization, which in turn allows GCC to better schedule the
22867 sequence.
22869 @item -mrecip
22870 @itemx -mno-recip
22871 @opindex mrecip
22872 This option enables use of the reciprocal estimate and
22873 reciprocal square root estimate instructions with additional
22874 Newton-Raphson steps to increase precision instead of doing a divide or
22875 square root and divide for floating-point arguments.  You should use
22876 the @option{-ffast-math} option when using @option{-mrecip} (or at
22877 least @option{-funsafe-math-optimizations},
22878 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22879 @option{-fno-trapping-math}).  Note that while the throughput of the
22880 sequence is generally higher than the throughput of the non-reciprocal
22881 instruction, the precision of the sequence can be decreased by up to 2
22882 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22883 roots.
22885 @item -mrecip=@var{opt}
22886 @opindex mrecip=opt
22887 This option controls which reciprocal estimate instructions
22888 may be used.  @var{opt} is a comma-separated list of options, which may
22889 be preceded by a @code{!} to invert the option:
22891 @table @samp
22893 @item all
22894 Enable all estimate instructions.
22896 @item default
22897 Enable the default instructions, equivalent to @option{-mrecip}.
22899 @item none
22900 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22902 @item div
22903 Enable the reciprocal approximation instructions for both
22904 single and double precision.
22906 @item divf
22907 Enable the single-precision reciprocal approximation instructions.
22909 @item divd
22910 Enable the double-precision reciprocal approximation instructions.
22912 @item rsqrt
22913 Enable the reciprocal square root approximation instructions for both
22914 single and double precision.
22916 @item rsqrtf
22917 Enable the single-precision reciprocal square root approximation instructions.
22919 @item rsqrtd
22920 Enable the double-precision reciprocal square root approximation instructions.
22922 @end table
22924 So, for example, @option{-mrecip=all,!rsqrtd} enables
22925 all of the reciprocal estimate instructions, except for the
22926 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22927 which handle the double-precision reciprocal square root calculations.
22929 @item -mrecip-precision
22930 @itemx -mno-recip-precision
22931 @opindex mrecip-precision
22932 Assume (do not assume) that the reciprocal estimate instructions
22933 provide higher-precision estimates than is mandated by the PowerPC
22934 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22935 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22936 The double-precision square root estimate instructions are not generated by
22937 default on low-precision machines, since they do not provide an
22938 estimate that converges after three steps.
22940 @item -mpointers-to-nested-functions
22941 @itemx -mno-pointers-to-nested-functions
22942 @opindex mpointers-to-nested-functions
22943 Generate (do not generate) code to load up the static chain register
22944 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22945 systems where a function pointer points to a 3-word descriptor giving
22946 the function address, TOC value to be loaded in register @code{r2}, and
22947 static chain value to be loaded in register @code{r11}.  The
22948 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22949 call through pointers to nested functions or pointers
22950 to functions compiled in other languages that use the static chain if
22951 you use @option{-mno-pointers-to-nested-functions}.
22953 @item -msave-toc-indirect
22954 @itemx -mno-save-toc-indirect
22955 @opindex msave-toc-indirect
22956 Generate (do not generate) code to save the TOC value in the reserved
22957 stack location in the function prologue if the function calls through
22958 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22959 saved in the prologue, it is saved just before the call through the
22960 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22962 @item -mcompat-align-parm
22963 @itemx -mno-compat-align-parm
22964 @opindex mcompat-align-parm
22965 Generate (do not generate) code to pass structure parameters with a
22966 maximum alignment of 64 bits, for compatibility with older versions
22967 of GCC.
22969 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22970 structure parameter on a 128-bit boundary when that structure contained
22971 a member requiring 128-bit alignment.  This is corrected in more
22972 recent versions of GCC.  This option may be used to generate code
22973 that is compatible with functions compiled with older versions of
22974 GCC.
22976 The @option{-mno-compat-align-parm} option is the default.
22978 @item -mstack-protector-guard=@var{guard}
22979 @itemx -mstack-protector-guard-reg=@var{reg}
22980 @itemx -mstack-protector-guard-offset=@var{offset}
22981 @itemx -mstack-protector-guard-symbol=@var{symbol}
22982 @opindex mstack-protector-guard
22983 @opindex mstack-protector-guard-reg
22984 @opindex mstack-protector-guard-offset
22985 @opindex mstack-protector-guard-symbol
22986 Generate stack protection code using canary at @var{guard}.  Supported
22987 locations are @samp{global} for global canary or @samp{tls} for per-thread
22988 canary in the TLS block (the default with GNU libc version 2.4 or later).
22990 With the latter choice the options
22991 @option{-mstack-protector-guard-reg=@var{reg}} and
22992 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22993 which register to use as base register for reading the canary, and from what
22994 offset from that base register. The default for those is as specified in the
22995 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
22996 the offset with a symbol reference to a canary in the TLS block.
22997 @end table
23000 @node RISC-V Options
23001 @subsection RISC-V Options
23002 @cindex RISC-V Options
23004 These command-line options are defined for RISC-V targets:
23006 @table @gcctabopt
23007 @item -mbranch-cost=@var{n}
23008 @opindex mbranch-cost
23009 Set the cost of branches to roughly @var{n} instructions.
23011 @item -mplt
23012 @itemx -mno-plt
23013 @opindex plt
23014 When generating PIC code, do or don't allow the use of PLTs. Ignored for
23015 non-PIC.  The default is @option{-mplt}.
23017 @item -mabi=@var{ABI-string}
23018 @opindex mabi
23019 Specify integer and floating-point calling convention.  @var{ABI-string}
23020 contains two parts: the size of integer types and the registers used for
23021 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
23022 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
23023 32-bit), and that floating-point values up to 64 bits wide are passed in F
23024 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
23025 allows the compiler to generate code that uses the F and D extensions but only
23026 allows floating-point values up to 32 bits long to be passed in registers; or
23027 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
23028 passed in registers.
23030 The default for this argument is system dependent, users who want a specific
23031 calling convention should specify one explicitly.  The valid calling
23032 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
23033 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
23034 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
23035 invalid because the ABI requires 64-bit values be passed in F registers, but F
23036 registers are only 32 bits wide.
23038 @item -mfdiv
23039 @itemx -mno-fdiv
23040 @opindex mfdiv
23041 Do or don't use hardware floating-point divide and square root instructions.
23042 This requires the F or D extensions for floating-point registers.  The default
23043 is to use them if the specified architecture has these instructions.
23045 @item -mdiv
23046 @itemx -mno-div
23047 @opindex mdiv
23048 Do or don't use hardware instructions for integer division.  This requires the
23049 M extension.  The default is to use them if the specified architecture has
23050 these instructions.
23052 @item -march=@var{ISA-string}
23053 @opindex march
23054 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
23055 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
23057 @item -mtune=@var{processor-string}
23058 @opindex mtune
23059 Optimize the output for the given processor, specified by microarchitecture
23060 name.
23062 @item -mpreferred-stack-boundary=@var{num}
23063 @opindex mpreferred-stack-boundary
23064 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
23065 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
23066 the default is 4 (16 bytes or 128-bits).
23068 @strong{Warning:} If you use this switch, then you must build all modules with
23069 the same value, including any libraries.  This includes the system libraries
23070 and startup modules.
23072 @item -msmall-data-limit=@var{n}
23073 @opindex msmall-data-limit
23074 Put global and static data smaller than @var{n} bytes into a special section
23075 (on some targets).
23077 @item -msave-restore
23078 @itemx -mno-save-restore
23079 @opindex msave-restore
23080 Do or don't use smaller but slower prologue and epilogue code that uses
23081 library function calls.  The default is to use fast inline prologues and
23082 epilogues.
23084 @item -mstrict-align
23085 @itemx -mno-strict-align
23086 @opindex mstrict-align
23087 Do not or do generate unaligned memory accesses.  The default is set depending
23088 on whether the processor we are optimizing for supports fast unaligned access
23089 or not.
23091 @item -mcmodel=medlow
23092 @opindex mcmodel=medlow
23093 Generate code for the medium-low code model. The program and its statically
23094 defined symbols must lie within a single 2 GiB address range and must lie
23095 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
23096 statically or dynamically linked. This is the default code model.
23098 @item -mcmodel=medany
23099 @opindex mcmodel=medany
23100 Generate code for the medium-any code model. The program and its statically
23101 defined symbols must be within any single 2 GiB address range. Programs can be
23102 statically or dynamically linked.
23104 @item -mexplicit-relocs
23105 @itemx -mno-exlicit-relocs
23106 Use or do not use assembler relocation operators when dealing with symbolic
23107 addresses.  The alternative is to use assembler macros instead, which may
23108 limit optimization.
23110 @item -mrelax
23111 @itemx -mno-relax
23112 Take advantage of linker relaxations to reduce the number of instructions
23113 required to materialize symbol addresses. The default is to take advantage of
23114 linker relaxations.
23116 @end table
23118 @node RL78 Options
23119 @subsection RL78 Options
23120 @cindex RL78 Options
23122 @table @gcctabopt
23124 @item -msim
23125 @opindex msim
23126 Links in additional target libraries to support operation within a
23127 simulator.
23129 @item -mmul=none
23130 @itemx -mmul=g10
23131 @itemx -mmul=g13
23132 @itemx -mmul=g14
23133 @itemx -mmul=rl78
23134 @opindex mmul
23135 Specifies the type of hardware multiplication and division support to
23136 be used.  The simplest is @code{none}, which uses software for both
23137 multiplication and division.  This is the default.  The @code{g13}
23138 value is for the hardware multiply/divide peripheral found on the
23139 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
23140 the multiplication and division instructions supported by the RL78/G14
23141 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
23142 the value @code{mg10} is an alias for @code{none}.
23144 In addition a C preprocessor macro is defined, based upon the setting
23145 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
23146 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
23148 @item -mcpu=g10
23149 @itemx -mcpu=g13
23150 @itemx -mcpu=g14
23151 @itemx -mcpu=rl78
23152 @opindex mcpu
23153 Specifies the RL78 core to target.  The default is the G14 core, also
23154 known as an S3 core or just RL78.  The G13 or S2 core does not have
23155 multiply or divide instructions, instead it uses a hardware peripheral
23156 for these operations.  The G10 or S1 core does not have register
23157 banks, so it uses a different calling convention.
23159 If this option is set it also selects the type of hardware multiply
23160 support to use, unless this is overridden by an explicit
23161 @option{-mmul=none} option on the command line.  Thus specifying
23162 @option{-mcpu=g13} enables the use of the G13 hardware multiply
23163 peripheral and specifying @option{-mcpu=g10} disables the use of
23164 hardware multiplications altogether.
23166 Note, although the RL78/G14 core is the default target, specifying
23167 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
23168 change the behavior of the toolchain since it also enables G14
23169 hardware multiply support.  If these options are not specified on the
23170 command line then software multiplication routines will be used even
23171 though the code targets the RL78 core.  This is for backwards
23172 compatibility with older toolchains which did not have hardware
23173 multiply and divide support.
23175 In addition a C preprocessor macro is defined, based upon the setting
23176 of this option.  Possible values are: @code{__RL78_G10__},
23177 @code{__RL78_G13__} or @code{__RL78_G14__}.
23179 @item -mg10
23180 @itemx -mg13
23181 @itemx -mg14
23182 @itemx -mrl78
23183 @opindex mg10
23184 @opindex mg13
23185 @opindex mg14
23186 @opindex mrl78
23187 These are aliases for the corresponding @option{-mcpu=} option.  They
23188 are provided for backwards compatibility.
23190 @item -mallregs
23191 @opindex mallregs
23192 Allow the compiler to use all of the available registers.  By default
23193 registers @code{r24..r31} are reserved for use in interrupt handlers.
23194 With this option enabled these registers can be used in ordinary
23195 functions as well.
23197 @item -m64bit-doubles
23198 @itemx -m32bit-doubles
23199 @opindex m64bit-doubles
23200 @opindex m32bit-doubles
23201 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23202 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23203 @option{-m32bit-doubles}.
23205 @item -msave-mduc-in-interrupts
23206 @itemx -mno-save-mduc-in-interrupts
23207 @opindex msave-mduc-in-interrupts
23208 @opindex mno-save-mduc-in-interrupts
23209 Specifies that interrupt handler functions should preserve the
23210 MDUC registers.  This is only necessary if normal code might use
23211 the MDUC registers, for example because it performs multiplication
23212 and division operations.  The default is to ignore the MDUC registers
23213 as this makes the interrupt handlers faster.  The target option -mg13
23214 needs to be passed for this to work as this feature is only available
23215 on the G13 target (S2 core).  The MDUC registers will only be saved
23216 if the interrupt handler performs a multiplication or division
23217 operation or it calls another function.
23219 @end table
23221 @node RS/6000 and PowerPC Options
23222 @subsection IBM RS/6000 and PowerPC Options
23223 @cindex RS/6000 and PowerPC Options
23224 @cindex IBM RS/6000 and PowerPC Options
23226 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
23227 @table @gcctabopt
23228 @item -mpowerpc-gpopt
23229 @itemx -mno-powerpc-gpopt
23230 @itemx -mpowerpc-gfxopt
23231 @itemx -mno-powerpc-gfxopt
23232 @need 800
23233 @itemx -mpowerpc64
23234 @itemx -mno-powerpc64
23235 @itemx -mmfcrf
23236 @itemx -mno-mfcrf
23237 @itemx -mpopcntb
23238 @itemx -mno-popcntb
23239 @itemx -mpopcntd
23240 @itemx -mno-popcntd
23241 @itemx -mfprnd
23242 @itemx -mno-fprnd
23243 @need 800
23244 @itemx -mcmpb
23245 @itemx -mno-cmpb
23246 @itemx -mmfpgpr
23247 @itemx -mno-mfpgpr
23248 @itemx -mhard-dfp
23249 @itemx -mno-hard-dfp
23250 @opindex mpowerpc-gpopt
23251 @opindex mno-powerpc-gpopt
23252 @opindex mpowerpc-gfxopt
23253 @opindex mno-powerpc-gfxopt
23254 @opindex mpowerpc64
23255 @opindex mno-powerpc64
23256 @opindex mmfcrf
23257 @opindex mno-mfcrf
23258 @opindex mpopcntb
23259 @opindex mno-popcntb
23260 @opindex mpopcntd
23261 @opindex mno-popcntd
23262 @opindex mfprnd
23263 @opindex mno-fprnd
23264 @opindex mcmpb
23265 @opindex mno-cmpb
23266 @opindex mmfpgpr
23267 @opindex mno-mfpgpr
23268 @opindex mhard-dfp
23269 @opindex mno-hard-dfp
23270 You use these options to specify which instructions are available on the
23271 processor you are using.  The default value of these options is
23272 determined when configuring GCC@.  Specifying the
23273 @option{-mcpu=@var{cpu_type}} overrides the specification of these
23274 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
23275 rather than the options listed above.
23277 Specifying @option{-mpowerpc-gpopt} allows
23278 GCC to use the optional PowerPC architecture instructions in the
23279 General Purpose group, including floating-point square root.  Specifying
23280 @option{-mpowerpc-gfxopt} allows GCC to
23281 use the optional PowerPC architecture instructions in the Graphics
23282 group, including floating-point select.
23284 The @option{-mmfcrf} option allows GCC to generate the move from
23285 condition register field instruction implemented on the POWER4
23286 processor and other processors that support the PowerPC V2.01
23287 architecture.
23288 The @option{-mpopcntb} option allows GCC to generate the popcount and
23289 double-precision FP reciprocal estimate instruction implemented on the
23290 POWER5 processor and other processors that support the PowerPC V2.02
23291 architecture.
23292 The @option{-mpopcntd} option allows GCC to generate the popcount
23293 instruction implemented on the POWER7 processor and other processors
23294 that support the PowerPC V2.06 architecture.
23295 The @option{-mfprnd} option allows GCC to generate the FP round to
23296 integer instructions implemented on the POWER5+ processor and other
23297 processors that support the PowerPC V2.03 architecture.
23298 The @option{-mcmpb} option allows GCC to generate the compare bytes
23299 instruction implemented on the POWER6 processor and other processors
23300 that support the PowerPC V2.05 architecture.
23301 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
23302 general-purpose register instructions implemented on the POWER6X
23303 processor and other processors that support the extended PowerPC V2.05
23304 architecture.
23305 The @option{-mhard-dfp} option allows GCC to generate the decimal
23306 floating-point instructions implemented on some POWER processors.
23308 The @option{-mpowerpc64} option allows GCC to generate the additional
23309 64-bit instructions that are found in the full PowerPC64 architecture
23310 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
23311 @option{-mno-powerpc64}.
23313 @item -mcpu=@var{cpu_type}
23314 @opindex mcpu
23315 Set architecture type, register usage, and
23316 instruction scheduling parameters for machine type @var{cpu_type}.
23317 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
23318 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
23319 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
23320 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
23321 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
23322 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
23323 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
23324 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
23325 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
23326 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
23327 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
23328 @samp{rs64}, and @samp{native}.
23330 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
23331 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
23332 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
23333 architecture machine types, with an appropriate, generic processor
23334 model assumed for scheduling purposes.
23336 Specifying @samp{native} as cpu type detects and selects the
23337 architecture option that corresponds to the host processor of the
23338 system performing the compilation.
23339 @option{-mcpu=native} has no effect if GCC does not recognize the
23340 processor.
23342 The other options specify a specific processor.  Code generated under
23343 those options runs best on that processor, and may not run at all on
23344 others.
23346 The @option{-mcpu} options automatically enable or disable the
23347 following options:
23349 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
23350 -mpopcntb -mpopcntd  -mpowerpc64 @gol
23351 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
23352 -msimple-fpu  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
23353 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
23354 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
23356 The particular options set for any particular CPU varies between
23357 compiler versions, depending on what setting seems to produce optimal
23358 code for that CPU; it doesn't necessarily reflect the actual hardware's
23359 capabilities.  If you wish to set an individual option to a particular
23360 value, you may specify it after the @option{-mcpu} option, like
23361 @option{-mcpu=970 -mno-altivec}.
23363 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
23364 not enabled or disabled by the @option{-mcpu} option at present because
23365 AIX does not have full support for these options.  You may still
23366 enable or disable them individually if you're sure it'll work in your
23367 environment.
23369 @item -mtune=@var{cpu_type}
23370 @opindex mtune
23371 Set the instruction scheduling parameters for machine type
23372 @var{cpu_type}, but do not set the architecture type or register usage,
23373 as @option{-mcpu=@var{cpu_type}} does.  The same
23374 values for @var{cpu_type} are used for @option{-mtune} as for
23375 @option{-mcpu}.  If both are specified, the code generated uses the
23376 architecture and registers set by @option{-mcpu}, but the
23377 scheduling parameters set by @option{-mtune}.
23379 @item -mcmodel=small
23380 @opindex mcmodel=small
23381 Generate PowerPC64 code for the small model: The TOC is limited to
23382 64k.
23384 @item -mcmodel=medium
23385 @opindex mcmodel=medium
23386 Generate PowerPC64 code for the medium model: The TOC and other static
23387 data may be up to a total of 4G in size.  This is the default for 64-bit
23388 Linux.
23390 @item -mcmodel=large
23391 @opindex mcmodel=large
23392 Generate PowerPC64 code for the large model: The TOC may be up to 4G
23393 in size.  Other data and code is only limited by the 64-bit address
23394 space.
23396 @item -maltivec
23397 @itemx -mno-altivec
23398 @opindex maltivec
23399 @opindex mno-altivec
23400 Generate code that uses (does not use) AltiVec instructions, and also
23401 enable the use of built-in functions that allow more direct access to
23402 the AltiVec instruction set.  You may also need to set
23403 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
23404 enhancements.
23406 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
23407 @option{-maltivec=be}, the element order for AltiVec intrinsics such
23408 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
23409 match array element order corresponding to the endianness of the
23410 target.  That is, element zero identifies the leftmost element in a
23411 vector register when targeting a big-endian platform, and identifies
23412 the rightmost element in a vector register when targeting a
23413 little-endian platform.
23415 @item -maltivec=be
23416 @opindex maltivec=be
23417 Generate AltiVec instructions using big-endian element order,
23418 regardless of whether the target is big- or little-endian.  This is
23419 the default when targeting a big-endian platform.  Using this option
23420 is currently deprecated.  Support for this feature will be removed in
23421 GCC 9.
23423 The element order is used to interpret element numbers in AltiVec
23424 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23425 @code{vec_insert}.  By default, these match array element order
23426 corresponding to the endianness for the target.
23428 @item -maltivec=le
23429 @opindex maltivec=le
23430 Generate AltiVec instructions using little-endian element order,
23431 regardless of whether the target is big- or little-endian.  This is
23432 the default when targeting a little-endian platform.  This option is
23433 currently ignored when targeting a big-endian platform.
23435 The element order is used to interpret element numbers in AltiVec
23436 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23437 @code{vec_insert}.  By default, these match array element order
23438 corresponding to the endianness for the target.
23440 @item -mvrsave
23441 @itemx -mno-vrsave
23442 @opindex mvrsave
23443 @opindex mno-vrsave
23444 Generate VRSAVE instructions when generating AltiVec code.
23446 @item -msecure-plt
23447 @opindex msecure-plt
23448 Generate code that allows @command{ld} and @command{ld.so}
23449 to build executables and shared
23450 libraries with non-executable @code{.plt} and @code{.got} sections.
23451 This is a PowerPC
23452 32-bit SYSV ABI option.
23454 @item -mbss-plt
23455 @opindex mbss-plt
23456 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
23457 fills in, and
23458 requires @code{.plt} and @code{.got}
23459 sections that are both writable and executable.
23460 This is a PowerPC 32-bit SYSV ABI option.
23462 @item -misel
23463 @itemx -mno-isel
23464 @opindex misel
23465 @opindex mno-isel
23466 This switch enables or disables the generation of ISEL instructions.
23468 @item -misel=@var{yes/no}
23469 This switch has been deprecated.  Use @option{-misel} and
23470 @option{-mno-isel} instead.
23472 @item -mpaired
23473 @itemx -mno-paired
23474 @opindex mpaired
23475 @opindex mno-paired
23476 This switch enables or disables the generation of PAIRED simd
23477 instructions.
23479 @item -mvsx
23480 @itemx -mno-vsx
23481 @opindex mvsx
23482 @opindex mno-vsx
23483 Generate code that uses (does not use) vector/scalar (VSX)
23484 instructions, and also enable the use of built-in functions that allow
23485 more direct access to the VSX instruction set.
23487 @item -mcrypto
23488 @itemx -mno-crypto
23489 @opindex mcrypto
23490 @opindex mno-crypto
23491 Enable the use (disable) of the built-in functions that allow direct
23492 access to the cryptographic instructions that were added in version
23493 2.07 of the PowerPC ISA.
23495 @item -mdirect-move
23496 @itemx -mno-direct-move
23497 @opindex mdirect-move
23498 @opindex mno-direct-move
23499 Generate code that uses (does not use) the instructions to move data
23500 between the general purpose registers and the vector/scalar (VSX)
23501 registers that were added in version 2.07 of the PowerPC ISA.
23503 @item -mhtm
23504 @itemx -mno-htm
23505 @opindex mhtm
23506 @opindex mno-htm
23507 Enable (disable) the use of the built-in functions that allow direct
23508 access to the Hardware Transactional Memory (HTM) instructions that
23509 were added in version 2.07 of the PowerPC ISA.
23511 @item -mpower8-fusion
23512 @itemx -mno-power8-fusion
23513 @opindex mpower8-fusion
23514 @opindex mno-power8-fusion
23515 Generate code that keeps (does not keeps) some integer operations
23516 adjacent so that the instructions can be fused together on power8 and
23517 later processors.
23519 @item -mpower8-vector
23520 @itemx -mno-power8-vector
23521 @opindex mpower8-vector
23522 @opindex mno-power8-vector
23523 Generate code that uses (does not use) the vector and scalar
23524 instructions that were added in version 2.07 of the PowerPC ISA.  Also
23525 enable the use of built-in functions that allow more direct access to
23526 the vector instructions.
23528 @item -mquad-memory
23529 @itemx -mno-quad-memory
23530 @opindex mquad-memory
23531 @opindex mno-quad-memory
23532 Generate code that uses (does not use) the non-atomic quad word memory
23533 instructions.  The @option{-mquad-memory} option requires use of
23534 64-bit mode.
23536 @item -mquad-memory-atomic
23537 @itemx -mno-quad-memory-atomic
23538 @opindex mquad-memory-atomic
23539 @opindex mno-quad-memory-atomic
23540 Generate code that uses (does not use) the atomic quad word memory
23541 instructions.  The @option{-mquad-memory-atomic} option requires use of
23542 64-bit mode.
23544 @item -mfloat128
23545 @itemx -mno-float128
23546 @opindex mfloat128
23547 @opindex mno-float128
23548 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
23549 and use either software emulation for IEEE 128-bit floating point or
23550 hardware instructions.
23552 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
23553 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
23554 use the IEEE 128-bit floating point support.  The IEEE 128-bit
23555 floating point support only works on PowerPC Linux systems.
23557 The default for @option{-mfloat128} is enabled on PowerPC Linux
23558 systems using the VSX instruction set, and disabled on other systems.
23560 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
23561 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
23562 point support will also enable the generation of ISA 3.0 IEEE 128-bit
23563 floating point instructions.  Otherwise, if you do not specify to
23564 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
23565 system, IEEE 128-bit floating point will be done with software
23566 emulation.
23568 @item -mfloat128-hardware
23569 @itemx -mno-float128-hardware
23570 @opindex mfloat128-hardware
23571 @opindex mno-float128-hardware
23572 Enable/disable using ISA 3.0 hardware instructions to support the
23573 @var{__float128} data type.
23575 The default for @option{-mfloat128-hardware} is enabled on PowerPC
23576 Linux systems using the ISA 3.0 instruction set, and disabled on other
23577 systems.
23579 @item -m32
23580 @itemx -m64
23581 @opindex m32
23582 @opindex m64
23583 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
23584 targets (including GNU/Linux).  The 32-bit environment sets int, long
23585 and pointer to 32 bits and generates code that runs on any PowerPC
23586 variant.  The 64-bit environment sets int to 32 bits and long and
23587 pointer to 64 bits, and generates code for PowerPC64, as for
23588 @option{-mpowerpc64}.
23590 @item -mfull-toc
23591 @itemx -mno-fp-in-toc
23592 @itemx -mno-sum-in-toc
23593 @itemx -mminimal-toc
23594 @opindex mfull-toc
23595 @opindex mno-fp-in-toc
23596 @opindex mno-sum-in-toc
23597 @opindex mminimal-toc
23598 Modify generation of the TOC (Table Of Contents), which is created for
23599 every executable file.  The @option{-mfull-toc} option is selected by
23600 default.  In that case, GCC allocates at least one TOC entry for
23601 each unique non-automatic variable reference in your program.  GCC
23602 also places floating-point constants in the TOC@.  However, only
23603 16,384 entries are available in the TOC@.
23605 If you receive a linker error message that saying you have overflowed
23606 the available TOC space, you can reduce the amount of TOC space used
23607 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
23608 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
23609 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
23610 generate code to calculate the sum of an address and a constant at
23611 run time instead of putting that sum into the TOC@.  You may specify one
23612 or both of these options.  Each causes GCC to produce very slightly
23613 slower and larger code at the expense of conserving TOC space.
23615 If you still run out of space in the TOC even when you specify both of
23616 these options, specify @option{-mminimal-toc} instead.  This option causes
23617 GCC to make only one TOC entry for every file.  When you specify this
23618 option, GCC produces code that is slower and larger but which
23619 uses extremely little TOC space.  You may wish to use this option
23620 only on files that contain less frequently-executed code.
23622 @item -maix64
23623 @itemx -maix32
23624 @opindex maix64
23625 @opindex maix32
23626 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
23627 @code{long} type, and the infrastructure needed to support them.
23628 Specifying @option{-maix64} implies @option{-mpowerpc64},
23629 while @option{-maix32} disables the 64-bit ABI and
23630 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
23632 @item -mxl-compat
23633 @itemx -mno-xl-compat
23634 @opindex mxl-compat
23635 @opindex mno-xl-compat
23636 Produce code that conforms more closely to IBM XL compiler semantics
23637 when using AIX-compatible ABI@.  Pass floating-point arguments to
23638 prototyped functions beyond the register save area (RSA) on the stack
23639 in addition to argument FPRs.  Do not assume that most significant
23640 double in 128-bit long double value is properly rounded when comparing
23641 values and converting to double.  Use XL symbol names for long double
23642 support routines.
23644 The AIX calling convention was extended but not initially documented to
23645 handle an obscure K&R C case of calling a function that takes the
23646 address of its arguments with fewer arguments than declared.  IBM XL
23647 compilers access floating-point arguments that do not fit in the
23648 RSA from the stack when a subroutine is compiled without
23649 optimization.  Because always storing floating-point arguments on the
23650 stack is inefficient and rarely needed, this option is not enabled by
23651 default and only is necessary when calling subroutines compiled by IBM
23652 XL compilers without optimization.
23654 @item -mpe
23655 @opindex mpe
23656 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
23657 application written to use message passing with special startup code to
23658 enable the application to run.  The system must have PE installed in the
23659 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
23660 must be overridden with the @option{-specs=} option to specify the
23661 appropriate directory location.  The Parallel Environment does not
23662 support threads, so the @option{-mpe} option and the @option{-pthread}
23663 option are incompatible.
23665 @item -malign-natural
23666 @itemx -malign-power
23667 @opindex malign-natural
23668 @opindex malign-power
23669 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
23670 @option{-malign-natural} overrides the ABI-defined alignment of larger
23671 types, such as floating-point doubles, on their natural size-based boundary.
23672 The option @option{-malign-power} instructs GCC to follow the ABI-specified
23673 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
23675 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
23676 is not supported.
23678 @item -msoft-float
23679 @itemx -mhard-float
23680 @opindex msoft-float
23681 @opindex mhard-float
23682 Generate code that does not use (uses) the floating-point register set.
23683 Software floating-point emulation is provided if you use the
23684 @option{-msoft-float} option, and pass the option to GCC when linking.
23686 @item -msingle-float
23687 @itemx -mdouble-float
23688 @opindex msingle-float
23689 @opindex mdouble-float
23690 Generate code for single- or double-precision floating-point operations.
23691 @option{-mdouble-float} implies @option{-msingle-float}.
23693 @item -msimple-fpu
23694 @opindex msimple-fpu
23695 Do not generate @code{sqrt} and @code{div} instructions for hardware
23696 floating-point unit.
23698 @item -mfpu=@var{name}
23699 @opindex mfpu
23700 Specify type of floating-point unit.  Valid values for @var{name} are
23701 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
23702 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
23703 @samp{sp_full} (equivalent to @option{-msingle-float}),
23704 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
23706 @item -mxilinx-fpu
23707 @opindex mxilinx-fpu
23708 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
23710 @item -mmultiple
23711 @itemx -mno-multiple
23712 @opindex mmultiple
23713 @opindex mno-multiple
23714 Generate code that uses (does not use) the load multiple word
23715 instructions and the store multiple word instructions.  These
23716 instructions are generated by default on POWER systems, and not
23717 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
23718 PowerPC systems, since those instructions do not work when the
23719 processor is in little-endian mode.  The exceptions are PPC740 and
23720 PPC750 which permit these instructions in little-endian mode.
23722 @item -mupdate
23723 @itemx -mno-update
23724 @opindex mupdate
23725 @opindex mno-update
23726 Generate code that uses (does not use) the load or store instructions
23727 that update the base register to the address of the calculated memory
23728 location.  These instructions are generated by default.  If you use
23729 @option{-mno-update}, there is a small window between the time that the
23730 stack pointer is updated and the address of the previous frame is
23731 stored, which means code that walks the stack frame across interrupts or
23732 signals may get corrupted data.
23734 @item -mavoid-indexed-addresses
23735 @itemx -mno-avoid-indexed-addresses
23736 @opindex mavoid-indexed-addresses
23737 @opindex mno-avoid-indexed-addresses
23738 Generate code that tries to avoid (not avoid) the use of indexed load
23739 or store instructions. These instructions can incur a performance
23740 penalty on Power6 processors in certain situations, such as when
23741 stepping through large arrays that cross a 16M boundary.  This option
23742 is enabled by default when targeting Power6 and disabled otherwise.
23744 @item -mfused-madd
23745 @itemx -mno-fused-madd
23746 @opindex mfused-madd
23747 @opindex mno-fused-madd
23748 Generate code that uses (does not use) the floating-point multiply and
23749 accumulate instructions.  These instructions are generated by default
23750 if hardware floating point is used.  The machine-dependent
23751 @option{-mfused-madd} option is now mapped to the machine-independent
23752 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23753 mapped to @option{-ffp-contract=off}.
23755 @item -mmulhw
23756 @itemx -mno-mulhw
23757 @opindex mmulhw
23758 @opindex mno-mulhw
23759 Generate code that uses (does not use) the half-word multiply and
23760 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
23761 These instructions are generated by default when targeting those
23762 processors.
23764 @item -mdlmzb
23765 @itemx -mno-dlmzb
23766 @opindex mdlmzb
23767 @opindex mno-dlmzb
23768 Generate code that uses (does not use) the string-search @samp{dlmzb}
23769 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
23770 generated by default when targeting those processors.
23772 @item -mno-bit-align
23773 @itemx -mbit-align
23774 @opindex mno-bit-align
23775 @opindex mbit-align
23776 On System V.4 and embedded PowerPC systems do not (do) force structures
23777 and unions that contain bit-fields to be aligned to the base type of the
23778 bit-field.
23780 For example, by default a structure containing nothing but 8
23781 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
23782 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
23783 the structure is aligned to a 1-byte boundary and is 1 byte in
23784 size.
23786 @item -mno-strict-align
23787 @itemx -mstrict-align
23788 @opindex mno-strict-align
23789 @opindex mstrict-align
23790 On System V.4 and embedded PowerPC systems do not (do) assume that
23791 unaligned memory references are handled by the system.
23793 @item -mrelocatable
23794 @itemx -mno-relocatable
23795 @opindex mrelocatable
23796 @opindex mno-relocatable
23797 Generate code that allows (does not allow) a static executable to be
23798 relocated to a different address at run time.  A simple embedded
23799 PowerPC system loader should relocate the entire contents of
23800 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
23801 a table of 32-bit addresses generated by this option.  For this to
23802 work, all objects linked together must be compiled with
23803 @option{-mrelocatable} or @option{-mrelocatable-lib}.
23804 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
23806 @item -mrelocatable-lib
23807 @itemx -mno-relocatable-lib
23808 @opindex mrelocatable-lib
23809 @opindex mno-relocatable-lib
23810 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
23811 @code{.fixup} section to allow static executables to be relocated at
23812 run time, but @option{-mrelocatable-lib} does not use the smaller stack
23813 alignment of @option{-mrelocatable}.  Objects compiled with
23814 @option{-mrelocatable-lib} may be linked with objects compiled with
23815 any combination of the @option{-mrelocatable} options.
23817 @item -mno-toc
23818 @itemx -mtoc
23819 @opindex mno-toc
23820 @opindex mtoc
23821 On System V.4 and embedded PowerPC systems do not (do) assume that
23822 register 2 contains a pointer to a global area pointing to the addresses
23823 used in the program.
23825 @item -mlittle
23826 @itemx -mlittle-endian
23827 @opindex mlittle
23828 @opindex mlittle-endian
23829 On System V.4 and embedded PowerPC systems compile code for the
23830 processor in little-endian mode.  The @option{-mlittle-endian} option is
23831 the same as @option{-mlittle}.
23833 @item -mbig
23834 @itemx -mbig-endian
23835 @opindex mbig
23836 @opindex mbig-endian
23837 On System V.4 and embedded PowerPC systems compile code for the
23838 processor in big-endian mode.  The @option{-mbig-endian} option is
23839 the same as @option{-mbig}.
23841 @item -mdynamic-no-pic
23842 @opindex mdynamic-no-pic
23843 On Darwin and Mac OS X systems, compile code so that it is not
23844 relocatable, but that its external references are relocatable.  The
23845 resulting code is suitable for applications, but not shared
23846 libraries.
23848 @item -msingle-pic-base
23849 @opindex msingle-pic-base
23850 Treat the register used for PIC addressing as read-only, rather than
23851 loading it in the prologue for each function.  The runtime system is
23852 responsible for initializing this register with an appropriate value
23853 before execution begins.
23855 @item -mprioritize-restricted-insns=@var{priority}
23856 @opindex mprioritize-restricted-insns
23857 This option controls the priority that is assigned to
23858 dispatch-slot restricted instructions during the second scheduling
23859 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
23860 or @samp{2} to assign no, highest, or second-highest (respectively) 
23861 priority to dispatch-slot restricted
23862 instructions.
23864 @item -msched-costly-dep=@var{dependence_type}
23865 @opindex msched-costly-dep
23866 This option controls which dependences are considered costly
23867 by the target during instruction scheduling.  The argument
23868 @var{dependence_type} takes one of the following values:
23870 @table @asis
23871 @item @samp{no}
23872 No dependence is costly.
23874 @item @samp{all}
23875 All dependences are costly.
23877 @item @samp{true_store_to_load}
23878 A true dependence from store to load is costly.
23880 @item @samp{store_to_load}
23881 Any dependence from store to load is costly.
23883 @item @var{number}
23884 Any dependence for which the latency is greater than or equal to 
23885 @var{number} is costly.
23886 @end table
23888 @item -minsert-sched-nops=@var{scheme}
23889 @opindex minsert-sched-nops
23890 This option controls which NOP insertion scheme is used during
23891 the second scheduling pass.  The argument @var{scheme} takes one of the
23892 following values:
23894 @table @asis
23895 @item @samp{no}
23896 Don't insert NOPs.
23898 @item @samp{pad}
23899 Pad with NOPs any dispatch group that has vacant issue slots,
23900 according to the scheduler's grouping.
23902 @item @samp{regroup_exact}
23903 Insert NOPs to force costly dependent insns into
23904 separate groups.  Insert exactly as many NOPs as needed to force an insn
23905 to a new group, according to the estimated processor grouping.
23907 @item @var{number}
23908 Insert NOPs to force costly dependent insns into
23909 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
23910 @end table
23912 @item -mcall-sysv
23913 @opindex mcall-sysv
23914 On System V.4 and embedded PowerPC systems compile code using calling
23915 conventions that adhere to the March 1995 draft of the System V
23916 Application Binary Interface, PowerPC processor supplement.  This is the
23917 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
23919 @item -mcall-sysv-eabi
23920 @itemx -mcall-eabi
23921 @opindex mcall-sysv-eabi
23922 @opindex mcall-eabi
23923 Specify both @option{-mcall-sysv} and @option{-meabi} options.
23925 @item -mcall-sysv-noeabi
23926 @opindex mcall-sysv-noeabi
23927 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
23929 @item -mcall-aixdesc
23930 @opindex m
23931 On System V.4 and embedded PowerPC systems compile code for the AIX
23932 operating system.
23934 @item -mcall-linux
23935 @opindex mcall-linux
23936 On System V.4 and embedded PowerPC systems compile code for the
23937 Linux-based GNU system.
23939 @item -mcall-freebsd
23940 @opindex mcall-freebsd
23941 On System V.4 and embedded PowerPC systems compile code for the
23942 FreeBSD operating system.
23944 @item -mcall-netbsd
23945 @opindex mcall-netbsd
23946 On System V.4 and embedded PowerPC systems compile code for the
23947 NetBSD operating system.
23949 @item -mcall-openbsd
23950 @opindex mcall-netbsd
23951 On System V.4 and embedded PowerPC systems compile code for the
23952 OpenBSD operating system.
23954 @item -maix-struct-return
23955 @opindex maix-struct-return
23956 Return all structures in memory (as specified by the AIX ABI)@.
23958 @item -msvr4-struct-return
23959 @opindex msvr4-struct-return
23960 Return structures smaller than 8 bytes in registers (as specified by the
23961 SVR4 ABI)@.
23963 @item -mabi=@var{abi-type}
23964 @opindex mabi
23965 Extend the current ABI with a particular extension, or remove such extension.
23966 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
23967 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
23968 @samp{elfv1}, @samp{elfv2}@.
23970 @item -mabi=spe
23971 @opindex mabi=spe
23972 Extend the current ABI with SPE ABI extensions.  This does not change
23973 the default ABI, instead it adds the SPE ABI extensions to the current
23974 ABI@.
23976 @item -mabi=no-spe
23977 @opindex mabi=no-spe
23978 Disable Book-E SPE ABI extensions for the current ABI@.
23980 @item -mabi=ibmlongdouble
23981 @opindex mabi=ibmlongdouble
23982 Change the current ABI to use IBM extended-precision long double.
23983 This is not likely to work if your system defaults to using IEEE
23984 extended-precision long double.  If you change the long double type
23985 from IEEE extended-precision, the compiler will issue a warning unless
23986 you use the @option{-Wno-psabi} option.
23988 @item -mabi=ieeelongdouble
23989 @opindex mabi=ieeelongdouble
23990 Change the current ABI to use IEEE extended-precision long double.
23991 This is not likely to work if your system defaults to using IBM
23992 extended-precision long double.  If you change the long double type
23993 from IBM extended-precision, the compiler will issue a warning unless
23994 you use the @option{-Wno-psabi} option.
23996 @item -mabi=elfv1
23997 @opindex mabi=elfv1
23998 Change the current ABI to use the ELFv1 ABI.
23999 This is the default ABI for big-endian PowerPC 64-bit Linux.
24000 Overriding the default ABI requires special system support and is
24001 likely to fail in spectacular ways.
24003 @item -mabi=elfv2
24004 @opindex mabi=elfv2
24005 Change the current ABI to use the ELFv2 ABI.
24006 This is the default ABI for little-endian PowerPC 64-bit Linux.
24007 Overriding the default ABI requires special system support and is
24008 likely to fail in spectacular ways.
24010 @item -mgnu-attribute
24011 @itemx -mno-gnu-attribute
24012 @opindex mgnu-attribute
24013 @opindex mno-gnu-attribute
24014 Emit .gnu_attribute assembly directives to set tag/value pairs in a
24015 .gnu.attributes section that specify ABI variations in function
24016 parameters or return values.
24018 @item -mprototype
24019 @itemx -mno-prototype
24020 @opindex mprototype
24021 @opindex mno-prototype
24022 On System V.4 and embedded PowerPC systems assume that all calls to
24023 variable argument functions are properly prototyped.  Otherwise, the
24024 compiler must insert an instruction before every non-prototyped call to
24025 set or clear bit 6 of the condition code register (@code{CR}) to
24026 indicate whether floating-point values are passed in the floating-point
24027 registers in case the function takes variable arguments.  With
24028 @option{-mprototype}, only calls to prototyped variable argument functions
24029 set or clear the bit.
24031 @item -msim
24032 @opindex msim
24033 On embedded PowerPC systems, assume that the startup module is called
24034 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
24035 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
24036 configurations.
24038 @item -mmvme
24039 @opindex mmvme
24040 On embedded PowerPC systems, assume that the startup module is called
24041 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
24042 @file{libc.a}.
24044 @item -mads
24045 @opindex mads
24046 On embedded PowerPC systems, assume that the startup module is called
24047 @file{crt0.o} and the standard C libraries are @file{libads.a} and
24048 @file{libc.a}.
24050 @item -myellowknife
24051 @opindex myellowknife
24052 On embedded PowerPC systems, assume that the startup module is called
24053 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
24054 @file{libc.a}.
24056 @item -mvxworks
24057 @opindex mvxworks
24058 On System V.4 and embedded PowerPC systems, specify that you are
24059 compiling for a VxWorks system.
24061 @item -memb
24062 @opindex memb
24063 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
24064 header to indicate that @samp{eabi} extended relocations are used.
24066 @item -meabi
24067 @itemx -mno-eabi
24068 @opindex meabi
24069 @opindex mno-eabi
24070 On System V.4 and embedded PowerPC systems do (do not) adhere to the
24071 Embedded Applications Binary Interface (EABI), which is a set of
24072 modifications to the System V.4 specifications.  Selecting @option{-meabi}
24073 means that the stack is aligned to an 8-byte boundary, a function
24074 @code{__eabi} is called from @code{main} to set up the EABI
24075 environment, and the @option{-msdata} option can use both @code{r2} and
24076 @code{r13} to point to two separate small data areas.  Selecting
24077 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
24078 no EABI initialization function is called from @code{main}, and the
24079 @option{-msdata} option only uses @code{r13} to point to a single
24080 small data area.  The @option{-meabi} option is on by default if you
24081 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
24083 @item -msdata=eabi
24084 @opindex msdata=eabi
24085 On System V.4 and embedded PowerPC systems, put small initialized
24086 @code{const} global and static data in the @code{.sdata2} section, which
24087 is pointed to by register @code{r2}.  Put small initialized
24088 non-@code{const} global and static data in the @code{.sdata} section,
24089 which is pointed to by register @code{r13}.  Put small uninitialized
24090 global and static data in the @code{.sbss} section, which is adjacent to
24091 the @code{.sdata} section.  The @option{-msdata=eabi} option is
24092 incompatible with the @option{-mrelocatable} option.  The
24093 @option{-msdata=eabi} option also sets the @option{-memb} option.
24095 @item -msdata=sysv
24096 @opindex msdata=sysv
24097 On System V.4 and embedded PowerPC systems, put small global and static
24098 data in the @code{.sdata} section, which is pointed to by register
24099 @code{r13}.  Put small uninitialized global and static data in the
24100 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
24101 The @option{-msdata=sysv} option is incompatible with the
24102 @option{-mrelocatable} option.
24104 @item -msdata=default
24105 @itemx -msdata
24106 @opindex msdata=default
24107 @opindex msdata
24108 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
24109 compile code the same as @option{-msdata=eabi}, otherwise compile code the
24110 same as @option{-msdata=sysv}.
24112 @item -msdata=data
24113 @opindex msdata=data
24114 On System V.4 and embedded PowerPC systems, put small global
24115 data in the @code{.sdata} section.  Put small uninitialized global
24116 data in the @code{.sbss} section.  Do not use register @code{r13}
24117 to address small data however.  This is the default behavior unless
24118 other @option{-msdata} options are used.
24120 @item -msdata=none
24121 @itemx -mno-sdata
24122 @opindex msdata=none
24123 @opindex mno-sdata
24124 On embedded PowerPC systems, put all initialized global and static data
24125 in the @code{.data} section, and all uninitialized data in the
24126 @code{.bss} section.
24128 @item -mreadonly-in-sdata
24129 @itemx -mreadonly-in-sdata
24130 @opindex mreadonly-in-sdata
24131 @opindex mno-readonly-in-sdata
24132 Put read-only objects in the @code{.sdata} section as well.  This is the
24133 default.
24135 @item -mblock-move-inline-limit=@var{num}
24136 @opindex mblock-move-inline-limit
24137 Inline all block moves (such as calls to @code{memcpy} or structure
24138 copies) less than or equal to @var{num} bytes.  The minimum value for
24139 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
24140 targets.  The default value is target-specific.
24142 @item -G @var{num}
24143 @opindex G
24144 @cindex smaller data references (PowerPC)
24145 @cindex .sdata/.sdata2 references (PowerPC)
24146 On embedded PowerPC systems, put global and static items less than or
24147 equal to @var{num} bytes into the small data or BSS sections instead of
24148 the normal data or BSS section.  By default, @var{num} is 8.  The
24149 @option{-G @var{num}} switch is also passed to the linker.
24150 All modules should be compiled with the same @option{-G @var{num}} value.
24152 @item -mregnames
24153 @itemx -mno-regnames
24154 @opindex mregnames
24155 @opindex mno-regnames
24156 On System V.4 and embedded PowerPC systems do (do not) emit register
24157 names in the assembly language output using symbolic forms.
24159 @item -mlongcall
24160 @itemx -mno-longcall
24161 @opindex mlongcall
24162 @opindex mno-longcall
24163 By default assume that all calls are far away so that a longer and more
24164 expensive calling sequence is required.  This is required for calls
24165 farther than 32 megabytes (33,554,432 bytes) from the current location.
24166 A short call is generated if the compiler knows
24167 the call cannot be that far away.  This setting can be overridden by
24168 the @code{shortcall} function attribute, or by @code{#pragma
24169 longcall(0)}.
24171 Some linkers are capable of detecting out-of-range calls and generating
24172 glue code on the fly.  On these systems, long calls are unnecessary and
24173 generate slower code.  As of this writing, the AIX linker can do this,
24174 as can the GNU linker for PowerPC/64.  It is planned to add this feature
24175 to the GNU linker for 32-bit PowerPC systems as well.
24177 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
24178 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
24179 addresses represent the callee and the branch island.  The
24180 Darwin/PPC linker prefers the first address and generates a @code{bl
24181 callee} if the PPC @code{bl} instruction reaches the callee directly;
24182 otherwise, the linker generates @code{bl L42} to call the branch
24183 island.  The branch island is appended to the body of the
24184 calling function; it computes the full 32-bit address of the callee
24185 and jumps to it.
24187 On Mach-O (Darwin) systems, this option directs the compiler emit to
24188 the glue for every direct call, and the Darwin linker decides whether
24189 to use or discard it.
24191 In the future, GCC may ignore all longcall specifications
24192 when the linker is known to generate glue.
24194 @item -mtls-markers
24195 @itemx -mno-tls-markers
24196 @opindex mtls-markers
24197 @opindex mno-tls-markers
24198 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
24199 specifying the function argument.  The relocation allows the linker to
24200 reliably associate function call with argument setup instructions for
24201 TLS optimization, which in turn allows GCC to better schedule the
24202 sequence.
24204 @item -mrecip
24205 @itemx -mno-recip
24206 @opindex mrecip
24207 This option enables use of the reciprocal estimate and
24208 reciprocal square root estimate instructions with additional
24209 Newton-Raphson steps to increase precision instead of doing a divide or
24210 square root and divide for floating-point arguments.  You should use
24211 the @option{-ffast-math} option when using @option{-mrecip} (or at
24212 least @option{-funsafe-math-optimizations},
24213 @option{-ffinite-math-only}, @option{-freciprocal-math} and
24214 @option{-fno-trapping-math}).  Note that while the throughput of the
24215 sequence is generally higher than the throughput of the non-reciprocal
24216 instruction, the precision of the sequence can be decreased by up to 2
24217 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
24218 roots.
24220 @item -mrecip=@var{opt}
24221 @opindex mrecip=opt
24222 This option controls which reciprocal estimate instructions
24223 may be used.  @var{opt} is a comma-separated list of options, which may
24224 be preceded by a @code{!} to invert the option:
24226 @table @samp
24228 @item all
24229 Enable all estimate instructions.
24231 @item default 
24232 Enable the default instructions, equivalent to @option{-mrecip}.
24234 @item none 
24235 Disable all estimate instructions, equivalent to @option{-mno-recip}.
24237 @item div 
24238 Enable the reciprocal approximation instructions for both 
24239 single and double precision.
24241 @item divf 
24242 Enable the single-precision reciprocal approximation instructions.
24244 @item divd 
24245 Enable the double-precision reciprocal approximation instructions.
24247 @item rsqrt 
24248 Enable the reciprocal square root approximation instructions for both
24249 single and double precision.
24251 @item rsqrtf 
24252 Enable the single-precision reciprocal square root approximation instructions.
24254 @item rsqrtd 
24255 Enable the double-precision reciprocal square root approximation instructions.
24257 @end table
24259 So, for example, @option{-mrecip=all,!rsqrtd} enables
24260 all of the reciprocal estimate instructions, except for the
24261 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
24262 which handle the double-precision reciprocal square root calculations.
24264 @item -mrecip-precision
24265 @itemx -mno-recip-precision
24266 @opindex mrecip-precision
24267 Assume (do not assume) that the reciprocal estimate instructions
24268 provide higher-precision estimates than is mandated by the PowerPC
24269 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
24270 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
24271 The double-precision square root estimate instructions are not generated by
24272 default on low-precision machines, since they do not provide an
24273 estimate that converges after three steps.
24275 @item -mveclibabi=@var{type}
24276 @opindex mveclibabi
24277 Specifies the ABI type to use for vectorizing intrinsics using an
24278 external library.  The only type supported at present is @samp{mass},
24279 which specifies to use IBM's Mathematical Acceleration Subsystem
24280 (MASS) libraries for vectorizing intrinsics using external libraries.
24281 GCC currently emits calls to @code{acosd2}, @code{acosf4},
24282 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
24283 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
24284 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
24285 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
24286 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
24287 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
24288 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
24289 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
24290 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
24291 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
24292 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
24293 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
24294 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
24295 for power7.  Both @option{-ftree-vectorize} and
24296 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
24297 libraries must be specified at link time.
24299 @item -mfriz
24300 @itemx -mno-friz
24301 @opindex mfriz
24302 Generate (do not generate) the @code{friz} instruction when the
24303 @option{-funsafe-math-optimizations} option is used to optimize
24304 rounding of floating-point values to 64-bit integer and back to floating
24305 point.  The @code{friz} instruction does not return the same value if
24306 the floating-point number is too large to fit in an integer.
24308 @item -mpointers-to-nested-functions
24309 @itemx -mno-pointers-to-nested-functions
24310 @opindex mpointers-to-nested-functions
24311 Generate (do not generate) code to load up the static chain register
24312 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
24313 systems where a function pointer points to a 3-word descriptor giving
24314 the function address, TOC value to be loaded in register @code{r2}, and
24315 static chain value to be loaded in register @code{r11}.  The
24316 @option{-mpointers-to-nested-functions} is on by default.  You cannot
24317 call through pointers to nested functions or pointers
24318 to functions compiled in other languages that use the static chain if
24319 you use @option{-mno-pointers-to-nested-functions}.
24321 @item -msave-toc-indirect
24322 @itemx -mno-save-toc-indirect
24323 @opindex msave-toc-indirect
24324 Generate (do not generate) code to save the TOC value in the reserved
24325 stack location in the function prologue if the function calls through
24326 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
24327 saved in the prologue, it is saved just before the call through the
24328 pointer.  The @option{-mno-save-toc-indirect} option is the default.
24330 @item -mcompat-align-parm
24331 @itemx -mno-compat-align-parm
24332 @opindex mcompat-align-parm
24333 Generate (do not generate) code to pass structure parameters with a
24334 maximum alignment of 64 bits, for compatibility with older versions
24335 of GCC.
24337 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
24338 structure parameter on a 128-bit boundary when that structure contained
24339 a member requiring 128-bit alignment.  This is corrected in more
24340 recent versions of GCC.  This option may be used to generate code
24341 that is compatible with functions compiled with older versions of
24342 GCC.
24344 The @option{-mno-compat-align-parm} option is the default.
24346 @item -mstack-protector-guard=@var{guard}
24347 @itemx -mstack-protector-guard-reg=@var{reg}
24348 @itemx -mstack-protector-guard-offset=@var{offset}
24349 @itemx -mstack-protector-guard-symbol=@var{symbol}
24350 @opindex mstack-protector-guard
24351 @opindex mstack-protector-guard-reg
24352 @opindex mstack-protector-guard-offset
24353 @opindex mstack-protector-guard-symbol
24354 Generate stack protection code using canary at @var{guard}.  Supported
24355 locations are @samp{global} for global canary or @samp{tls} for per-thread
24356 canary in the TLS block (the default with GNU libc version 2.4 or later).
24358 With the latter choice the options
24359 @option{-mstack-protector-guard-reg=@var{reg}} and
24360 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
24361 which register to use as base register for reading the canary, and from what
24362 offset from that base register. The default for those is as specified in the
24363 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
24364 the offset with a symbol reference to a canary in the TLS block.
24365 @end table
24367 @node RX Options
24368 @subsection RX Options
24369 @cindex RX Options
24371 These command-line options are defined for RX targets:
24373 @table @gcctabopt
24374 @item -m64bit-doubles
24375 @itemx -m32bit-doubles
24376 @opindex m64bit-doubles
24377 @opindex m32bit-doubles
24378 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
24379 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
24380 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
24381 works on 32-bit values, which is why the default is
24382 @option{-m32bit-doubles}.
24384 @item -fpu
24385 @itemx -nofpu
24386 @opindex fpu
24387 @opindex nofpu
24388 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
24389 floating-point hardware.  The default is enabled for the RX600
24390 series and disabled for the RX200 series.
24392 Floating-point instructions are only generated for 32-bit floating-point 
24393 values, however, so the FPU hardware is not used for doubles if the
24394 @option{-m64bit-doubles} option is used.
24396 @emph{Note} If the @option{-fpu} option is enabled then
24397 @option{-funsafe-math-optimizations} is also enabled automatically.
24398 This is because the RX FPU instructions are themselves unsafe.
24400 @item -mcpu=@var{name}
24401 @opindex mcpu
24402 Selects the type of RX CPU to be targeted.  Currently three types are
24403 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
24404 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
24406 The only difference between @samp{RX600} and @samp{RX610} is that the
24407 @samp{RX610} does not support the @code{MVTIPL} instruction.
24409 The @samp{RX200} series does not have a hardware floating-point unit
24410 and so @option{-nofpu} is enabled by default when this type is
24411 selected.
24413 @item -mbig-endian-data
24414 @itemx -mlittle-endian-data
24415 @opindex mbig-endian-data
24416 @opindex mlittle-endian-data
24417 Store data (but not code) in the big-endian format.  The default is
24418 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
24419 format.
24421 @item -msmall-data-limit=@var{N}
24422 @opindex msmall-data-limit
24423 Specifies the maximum size in bytes of global and static variables
24424 which can be placed into the small data area.  Using the small data
24425 area can lead to smaller and faster code, but the size of area is
24426 limited and it is up to the programmer to ensure that the area does
24427 not overflow.  Also when the small data area is used one of the RX's
24428 registers (usually @code{r13}) is reserved for use pointing to this
24429 area, so it is no longer available for use by the compiler.  This
24430 could result in slower and/or larger code if variables are pushed onto
24431 the stack instead of being held in this register.
24433 Note, common variables (variables that have not been initialized) and
24434 constants are not placed into the small data area as they are assigned
24435 to other sections in the output executable.
24437 The default value is zero, which disables this feature.  Note, this
24438 feature is not enabled by default with higher optimization levels
24439 (@option{-O2} etc) because of the potentially detrimental effects of
24440 reserving a register.  It is up to the programmer to experiment and
24441 discover whether this feature is of benefit to their program.  See the
24442 description of the @option{-mpid} option for a description of how the
24443 actual register to hold the small data area pointer is chosen.
24445 @item -msim
24446 @itemx -mno-sim
24447 @opindex msim
24448 @opindex mno-sim
24449 Use the simulator runtime.  The default is to use the libgloss
24450 board-specific runtime.
24452 @item -mas100-syntax
24453 @itemx -mno-as100-syntax
24454 @opindex mas100-syntax
24455 @opindex mno-as100-syntax
24456 When generating assembler output use a syntax that is compatible with
24457 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
24458 assembler, but it has some restrictions so it is not generated by default.
24460 @item -mmax-constant-size=@var{N}
24461 @opindex mmax-constant-size
24462 Specifies the maximum size, in bytes, of a constant that can be used as
24463 an operand in a RX instruction.  Although the RX instruction set does
24464 allow constants of up to 4 bytes in length to be used in instructions,
24465 a longer value equates to a longer instruction.  Thus in some
24466 circumstances it can be beneficial to restrict the size of constants
24467 that are used in instructions.  Constants that are too big are instead
24468 placed into a constant pool and referenced via register indirection.
24470 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
24471 or 4 means that constants of any size are allowed.
24473 @item -mrelax
24474 @opindex mrelax
24475 Enable linker relaxation.  Linker relaxation is a process whereby the
24476 linker attempts to reduce the size of a program by finding shorter
24477 versions of various instructions.  Disabled by default.
24479 @item -mint-register=@var{N}
24480 @opindex mint-register
24481 Specify the number of registers to reserve for fast interrupt handler
24482 functions.  The value @var{N} can be between 0 and 4.  A value of 1
24483 means that register @code{r13} is reserved for the exclusive use
24484 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
24485 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
24486 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
24487 A value of 0, the default, does not reserve any registers.
24489 @item -msave-acc-in-interrupts
24490 @opindex msave-acc-in-interrupts
24491 Specifies that interrupt handler functions should preserve the
24492 accumulator register.  This is only necessary if normal code might use
24493 the accumulator register, for example because it performs 64-bit
24494 multiplications.  The default is to ignore the accumulator as this
24495 makes the interrupt handlers faster.
24497 @item -mpid
24498 @itemx -mno-pid
24499 @opindex mpid
24500 @opindex mno-pid
24501 Enables the generation of position independent data.  When enabled any
24502 access to constant data is done via an offset from a base address
24503 held in a register.  This allows the location of constant data to be
24504 determined at run time without requiring the executable to be
24505 relocated, which is a benefit to embedded applications with tight
24506 memory constraints.  Data that can be modified is not affected by this
24507 option.
24509 Note, using this feature reserves a register, usually @code{r13}, for
24510 the constant data base address.  This can result in slower and/or
24511 larger code, especially in complicated functions.
24513 The actual register chosen to hold the constant data base address
24514 depends upon whether the @option{-msmall-data-limit} and/or the
24515 @option{-mint-register} command-line options are enabled.  Starting
24516 with register @code{r13} and proceeding downwards, registers are
24517 allocated first to satisfy the requirements of @option{-mint-register},
24518 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
24519 is possible for the small data area register to be @code{r8} if both
24520 @option{-mint-register=4} and @option{-mpid} are specified on the
24521 command line.
24523 By default this feature is not enabled.  The default can be restored
24524 via the @option{-mno-pid} command-line option.
24526 @item -mno-warn-multiple-fast-interrupts
24527 @itemx -mwarn-multiple-fast-interrupts
24528 @opindex mno-warn-multiple-fast-interrupts
24529 @opindex mwarn-multiple-fast-interrupts
24530 Prevents GCC from issuing a warning message if it finds more than one
24531 fast interrupt handler when it is compiling a file.  The default is to
24532 issue a warning for each extra fast interrupt handler found, as the RX
24533 only supports one such interrupt.
24535 @item -mallow-string-insns
24536 @itemx -mno-allow-string-insns
24537 @opindex mallow-string-insns
24538 @opindex mno-allow-string-insns
24539 Enables or disables the use of the string manipulation instructions
24540 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
24541 @code{SWHILE} and also the @code{RMPA} instruction.  These
24542 instructions may prefetch data, which is not safe to do if accessing
24543 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
24544 for more information).
24546 The default is to allow these instructions, but it is not possible for
24547 GCC to reliably detect all circumstances where a string instruction
24548 might be used to access an I/O register, so their use cannot be
24549 disabled automatically.  Instead it is reliant upon the programmer to
24550 use the @option{-mno-allow-string-insns} option if their program
24551 accesses I/O space.
24553 When the instructions are enabled GCC defines the C preprocessor
24554 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
24555 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
24557 @item -mjsr
24558 @itemx -mno-jsr
24559 @opindex mjsr
24560 @opindex mno-jsr
24561 Use only (or not only) @code{JSR} instructions to access functions.
24562 This option can be used when code size exceeds the range of @code{BSR}
24563 instructions.  Note that @option{-mno-jsr} does not mean to not use
24564 @code{JSR} but instead means that any type of branch may be used.
24565 @end table
24567 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
24568 has special significance to the RX port when used with the
24569 @code{interrupt} function attribute.  This attribute indicates a
24570 function intended to process fast interrupts.  GCC ensures
24571 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
24572 and/or @code{r13} and only provided that the normal use of the
24573 corresponding registers have been restricted via the
24574 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
24575 options.
24577 @node S/390 and zSeries Options
24578 @subsection S/390 and zSeries Options
24579 @cindex S/390 and zSeries Options
24581 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
24583 @table @gcctabopt
24584 @item -mhard-float
24585 @itemx -msoft-float
24586 @opindex mhard-float
24587 @opindex msoft-float
24588 Use (do not use) the hardware floating-point instructions and registers
24589 for floating-point operations.  When @option{-msoft-float} is specified,
24590 functions in @file{libgcc.a} are used to perform floating-point
24591 operations.  When @option{-mhard-float} is specified, the compiler
24592 generates IEEE floating-point instructions.  This is the default.
24594 @item -mhard-dfp
24595 @itemx -mno-hard-dfp
24596 @opindex mhard-dfp
24597 @opindex mno-hard-dfp
24598 Use (do not use) the hardware decimal-floating-point instructions for
24599 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
24600 specified, functions in @file{libgcc.a} are used to perform
24601 decimal-floating-point operations.  When @option{-mhard-dfp} is
24602 specified, the compiler generates decimal-floating-point hardware
24603 instructions.  This is the default for @option{-march=z9-ec} or higher.
24605 @item -mlong-double-64
24606 @itemx -mlong-double-128
24607 @opindex mlong-double-64
24608 @opindex mlong-double-128
24609 These switches control the size of @code{long double} type. A size
24610 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24611 type. This is the default.
24613 @item -mbackchain
24614 @itemx -mno-backchain
24615 @opindex mbackchain
24616 @opindex mno-backchain
24617 Store (do not store) the address of the caller's frame as backchain pointer
24618 into the callee's stack frame.
24619 A backchain may be needed to allow debugging using tools that do not understand
24620 DWARF call frame information.
24621 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
24622 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
24623 the backchain is placed into the topmost word of the 96/160 byte register
24624 save area.
24626 In general, code compiled with @option{-mbackchain} is call-compatible with
24627 code compiled with @option{-mmo-backchain}; however, use of the backchain
24628 for debugging purposes usually requires that the whole binary is built with
24629 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
24630 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24631 to build a linux kernel use @option{-msoft-float}.
24633 The default is to not maintain the backchain.
24635 @item -mpacked-stack
24636 @itemx -mno-packed-stack
24637 @opindex mpacked-stack
24638 @opindex mno-packed-stack
24639 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
24640 specified, the compiler uses the all fields of the 96/160 byte register save
24641 area only for their default purpose; unused fields still take up stack space.
24642 When @option{-mpacked-stack} is specified, register save slots are densely
24643 packed at the top of the register save area; unused space is reused for other
24644 purposes, allowing for more efficient use of the available stack space.
24645 However, when @option{-mbackchain} is also in effect, the topmost word of
24646 the save area is always used to store the backchain, and the return address
24647 register is always saved two words below the backchain.
24649 As long as the stack frame backchain is not used, code generated with
24650 @option{-mpacked-stack} is call-compatible with code generated with
24651 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
24652 S/390 or zSeries generated code that uses the stack frame backchain at run
24653 time, not just for debugging purposes.  Such code is not call-compatible
24654 with code compiled with @option{-mpacked-stack}.  Also, note that the
24655 combination of @option{-mbackchain},
24656 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24657 to build a linux kernel use @option{-msoft-float}.
24659 The default is to not use the packed stack layout.
24661 @item -msmall-exec
24662 @itemx -mno-small-exec
24663 @opindex msmall-exec
24664 @opindex mno-small-exec
24665 Generate (or do not generate) code using the @code{bras} instruction
24666 to do subroutine calls.
24667 This only works reliably if the total executable size does not
24668 exceed 64k.  The default is to use the @code{basr} instruction instead,
24669 which does not have this limitation.
24671 @item -m64
24672 @itemx -m31
24673 @opindex m64
24674 @opindex m31
24675 When @option{-m31} is specified, generate code compliant to the
24676 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
24677 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
24678 particular to generate 64-bit instructions.  For the @samp{s390}
24679 targets, the default is @option{-m31}, while the @samp{s390x}
24680 targets default to @option{-m64}.
24682 @item -mzarch
24683 @itemx -mesa
24684 @opindex mzarch
24685 @opindex mesa
24686 When @option{-mzarch} is specified, generate code using the
24687 instructions available on z/Architecture.
24688 When @option{-mesa} is specified, generate code using the
24689 instructions available on ESA/390.  Note that @option{-mesa} is
24690 not possible with @option{-m64}.
24691 When generating code compliant to the GNU/Linux for S/390 ABI,
24692 the default is @option{-mesa}.  When generating code compliant
24693 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
24695 @item -mhtm
24696 @itemx -mno-htm
24697 @opindex mhtm
24698 @opindex mno-htm
24699 The @option{-mhtm} option enables a set of builtins making use of
24700 instructions available with the transactional execution facility
24701 introduced with the IBM zEnterprise EC12 machine generation
24702 @ref{S/390 System z Built-in Functions}.
24703 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
24705 @item -mvx
24706 @itemx -mno-vx
24707 @opindex mvx
24708 @opindex mno-vx
24709 When @option{-mvx} is specified, generate code using the instructions
24710 available with the vector extension facility introduced with the IBM
24711 z13 machine generation.
24712 This option changes the ABI for some vector type values with regard to
24713 alignment and calling conventions.  In case vector type values are
24714 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
24715 command will be added to mark the resulting binary with the ABI used.
24716 @option{-mvx} is enabled by default when using @option{-march=z13}.
24718 @item -mzvector
24719 @itemx -mno-zvector
24720 @opindex mzvector
24721 @opindex mno-zvector
24722 The @option{-mzvector} option enables vector language extensions and
24723 builtins using instructions available with the vector extension
24724 facility introduced with the IBM z13 machine generation.
24725 This option adds support for @samp{vector} to be used as a keyword to
24726 define vector type variables and arguments.  @samp{vector} is only
24727 available when GNU extensions are enabled.  It will not be expanded
24728 when requesting strict standard compliance e.g. with @option{-std=c99}.
24729 In addition to the GCC low-level builtins @option{-mzvector} enables
24730 a set of builtins added for compatibility with AltiVec-style
24731 implementations like Power and Cell.  In order to make use of these
24732 builtins the header file @file{vecintrin.h} needs to be included.
24733 @option{-mzvector} is disabled by default.
24735 @item -mmvcle
24736 @itemx -mno-mvcle
24737 @opindex mmvcle
24738 @opindex mno-mvcle
24739 Generate (or do not generate) code using the @code{mvcle} instruction
24740 to perform block moves.  When @option{-mno-mvcle} is specified,
24741 use a @code{mvc} loop instead.  This is the default unless optimizing for
24742 size.
24744 @item -mdebug
24745 @itemx -mno-debug
24746 @opindex mdebug
24747 @opindex mno-debug
24748 Print (or do not print) additional debug information when compiling.
24749 The default is to not print debug information.
24751 @item -march=@var{cpu-type}
24752 @opindex march
24753 Generate code that runs on @var{cpu-type}, which is the name of a
24754 system representing a certain processor type.  Possible values for
24755 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
24756 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
24757 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
24758 @samp{native}.
24760 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
24761 @samp{g6} are deprecated and will be removed with future releases.
24763 Specifying @samp{native} as cpu type can be used to select the best
24764 architecture option for the host processor.
24765 @option{-march=native} has no effect if GCC does not recognize the
24766 processor.
24768 @item -mtune=@var{cpu-type}
24769 @opindex mtune
24770 Tune to @var{cpu-type} everything applicable about the generated code,
24771 except for the ABI and the set of available instructions.
24772 The list of @var{cpu-type} values is the same as for @option{-march}.
24773 The default is the value used for @option{-march}.
24775 @item -mtpf-trace
24776 @itemx -mno-tpf-trace
24777 @opindex mtpf-trace
24778 @opindex mno-tpf-trace
24779 Generate code that adds (does not add) in TPF OS specific branches to trace
24780 routines in the operating system.  This option is off by default, even
24781 when compiling for the TPF OS@.
24783 @item -mfused-madd
24784 @itemx -mno-fused-madd
24785 @opindex mfused-madd
24786 @opindex mno-fused-madd
24787 Generate code that uses (does not use) the floating-point multiply and
24788 accumulate instructions.  These instructions are generated by default if
24789 hardware floating point is used.
24791 @item -mwarn-framesize=@var{framesize}
24792 @opindex mwarn-framesize
24793 Emit a warning if the current function exceeds the given frame size.  Because
24794 this is a compile-time check it doesn't need to be a real problem when the program
24795 runs.  It is intended to identify functions that most probably cause
24796 a stack overflow.  It is useful to be used in an environment with limited stack
24797 size e.g.@: the linux kernel.
24799 @item -mwarn-dynamicstack
24800 @opindex mwarn-dynamicstack
24801 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
24802 arrays.  This is generally a bad idea with a limited stack size.
24804 @item -mstack-guard=@var{stack-guard}
24805 @itemx -mstack-size=@var{stack-size}
24806 @opindex mstack-guard
24807 @opindex mstack-size
24808 If these options are provided the S/390 back end emits additional instructions in
24809 the function prologue that trigger a trap if the stack size is @var{stack-guard}
24810 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
24811 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
24812 the frame size of the compiled function is chosen.
24813 These options are intended to be used to help debugging stack overflow problems.
24814 The additionally emitted code causes only little overhead and hence can also be
24815 used in production-like systems without greater performance degradation.  The given
24816 values have to be exact powers of 2 and @var{stack-size} has to be greater than
24817 @var{stack-guard} without exceeding 64k.
24818 In order to be efficient the extra code makes the assumption that the stack starts
24819 at an address aligned to the value given by @var{stack-size}.
24820 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
24822 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
24823 @opindex mhotpatch
24824 If the hotpatch option is enabled, a ``hot-patching'' function
24825 prologue is generated for all functions in the compilation unit.
24826 The funtion label is prepended with the given number of two-byte
24827 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
24828 the label, 2 * @var{post-halfwords} bytes are appended, using the
24829 largest NOP like instructions the architecture allows (maximum
24830 1000000).
24832 If both arguments are zero, hotpatching is disabled.
24834 This option can be overridden for individual functions with the
24835 @code{hotpatch} attribute.
24836 @end table
24838 @node Score Options
24839 @subsection Score Options
24840 @cindex Score Options
24842 These options are defined for Score implementations:
24844 @table @gcctabopt
24845 @item -meb
24846 @opindex meb
24847 Compile code for big-endian mode.  This is the default.
24849 @item -mel
24850 @opindex mel
24851 Compile code for little-endian mode.
24853 @item -mnhwloop
24854 @opindex mnhwloop
24855 Disable generation of @code{bcnz} instructions.
24857 @item -muls
24858 @opindex muls
24859 Enable generation of unaligned load and store instructions.
24861 @item -mmac
24862 @opindex mmac
24863 Enable the use of multiply-accumulate instructions. Disabled by default.
24865 @item -mscore5
24866 @opindex mscore5
24867 Specify the SCORE5 as the target architecture.
24869 @item -mscore5u
24870 @opindex mscore5u
24871 Specify the SCORE5U of the target architecture.
24873 @item -mscore7
24874 @opindex mscore7
24875 Specify the SCORE7 as the target architecture. This is the default.
24877 @item -mscore7d
24878 @opindex mscore7d
24879 Specify the SCORE7D as the target architecture.
24880 @end table
24882 @node SH Options
24883 @subsection SH Options
24885 These @samp{-m} options are defined for the SH implementations:
24887 @table @gcctabopt
24888 @item -m1
24889 @opindex m1
24890 Generate code for the SH1.
24892 @item -m2
24893 @opindex m2
24894 Generate code for the SH2.
24896 @item -m2e
24897 Generate code for the SH2e.
24899 @item -m2a-nofpu
24900 @opindex m2a-nofpu
24901 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
24902 that the floating-point unit is not used.
24904 @item -m2a-single-only
24905 @opindex m2a-single-only
24906 Generate code for the SH2a-FPU, in such a way that no double-precision
24907 floating-point operations are used.
24909 @item -m2a-single
24910 @opindex m2a-single
24911 Generate code for the SH2a-FPU assuming the floating-point unit is in
24912 single-precision mode by default.
24914 @item -m2a
24915 @opindex m2a
24916 Generate code for the SH2a-FPU assuming the floating-point unit is in
24917 double-precision mode by default.
24919 @item -m3
24920 @opindex m3
24921 Generate code for the SH3.
24923 @item -m3e
24924 @opindex m3e
24925 Generate code for the SH3e.
24927 @item -m4-nofpu
24928 @opindex m4-nofpu
24929 Generate code for the SH4 without a floating-point unit.
24931 @item -m4-single-only
24932 @opindex m4-single-only
24933 Generate code for the SH4 with a floating-point unit that only
24934 supports single-precision arithmetic.
24936 @item -m4-single
24937 @opindex m4-single
24938 Generate code for the SH4 assuming the floating-point unit is in
24939 single-precision mode by default.
24941 @item -m4
24942 @opindex m4
24943 Generate code for the SH4.
24945 @item -m4-100
24946 @opindex m4-100
24947 Generate code for SH4-100.
24949 @item -m4-100-nofpu
24950 @opindex m4-100-nofpu
24951 Generate code for SH4-100 in such a way that the
24952 floating-point unit is not used.
24954 @item -m4-100-single
24955 @opindex m4-100-single
24956 Generate code for SH4-100 assuming the floating-point unit is in
24957 single-precision mode by default.
24959 @item -m4-100-single-only
24960 @opindex m4-100-single-only
24961 Generate code for SH4-100 in such a way that no double-precision
24962 floating-point operations are used.
24964 @item -m4-200
24965 @opindex m4-200
24966 Generate code for SH4-200.
24968 @item -m4-200-nofpu
24969 @opindex m4-200-nofpu
24970 Generate code for SH4-200 without in such a way that the
24971 floating-point unit is not used.
24973 @item -m4-200-single
24974 @opindex m4-200-single
24975 Generate code for SH4-200 assuming the floating-point unit is in
24976 single-precision mode by default.
24978 @item -m4-200-single-only
24979 @opindex m4-200-single-only
24980 Generate code for SH4-200 in such a way that no double-precision
24981 floating-point operations are used.
24983 @item -m4-300
24984 @opindex m4-300
24985 Generate code for SH4-300.
24987 @item -m4-300-nofpu
24988 @opindex m4-300-nofpu
24989 Generate code for SH4-300 without in such a way that the
24990 floating-point unit is not used.
24992 @item -m4-300-single
24993 @opindex m4-300-single
24994 Generate code for SH4-300 in such a way that no double-precision
24995 floating-point operations are used.
24997 @item -m4-300-single-only
24998 @opindex m4-300-single-only
24999 Generate code for SH4-300 in such a way that no double-precision
25000 floating-point operations are used.
25002 @item -m4-340
25003 @opindex m4-340
25004 Generate code for SH4-340 (no MMU, no FPU).
25006 @item -m4-500
25007 @opindex m4-500
25008 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
25009 assembler.
25011 @item -m4a-nofpu
25012 @opindex m4a-nofpu
25013 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
25014 floating-point unit is not used.
25016 @item -m4a-single-only
25017 @opindex m4a-single-only
25018 Generate code for the SH4a, in such a way that no double-precision
25019 floating-point operations are used.
25021 @item -m4a-single
25022 @opindex m4a-single
25023 Generate code for the SH4a assuming the floating-point unit is in
25024 single-precision mode by default.
25026 @item -m4a
25027 @opindex m4a
25028 Generate code for the SH4a.
25030 @item -m4al
25031 @opindex m4al
25032 Same as @option{-m4a-nofpu}, except that it implicitly passes
25033 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
25034 instructions at the moment.
25036 @item -mb
25037 @opindex mb
25038 Compile code for the processor in big-endian mode.
25040 @item -ml
25041 @opindex ml
25042 Compile code for the processor in little-endian mode.
25044 @item -mdalign
25045 @opindex mdalign
25046 Align doubles at 64-bit boundaries.  Note that this changes the calling
25047 conventions, and thus some functions from the standard C library do
25048 not work unless you recompile it first with @option{-mdalign}.
25050 @item -mrelax
25051 @opindex mrelax
25052 Shorten some address references at link time, when possible; uses the
25053 linker option @option{-relax}.
25055 @item -mbigtable
25056 @opindex mbigtable
25057 Use 32-bit offsets in @code{switch} tables.  The default is to use
25058 16-bit offsets.
25060 @item -mbitops
25061 @opindex mbitops
25062 Enable the use of bit manipulation instructions on SH2A.
25064 @item -mfmovd
25065 @opindex mfmovd
25066 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
25067 alignment constraints.
25069 @item -mrenesas
25070 @opindex mrenesas
25071 Comply with the calling conventions defined by Renesas.
25073 @item -mno-renesas
25074 @opindex mno-renesas
25075 Comply with the calling conventions defined for GCC before the Renesas
25076 conventions were available.  This option is the default for all
25077 targets of the SH toolchain.
25079 @item -mnomacsave
25080 @opindex mnomacsave
25081 Mark the @code{MAC} register as call-clobbered, even if
25082 @option{-mrenesas} is given.
25084 @item -mieee
25085 @itemx -mno-ieee
25086 @opindex mieee
25087 @opindex mno-ieee
25088 Control the IEEE compliance of floating-point comparisons, which affects the
25089 handling of cases where the result of a comparison is unordered.  By default
25090 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
25091 enabled @option{-mno-ieee} is implicitly set, which results in faster
25092 floating-point greater-equal and less-equal comparisons.  The implicit settings
25093 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
25095 @item -minline-ic_invalidate
25096 @opindex minline-ic_invalidate
25097 Inline code to invalidate instruction cache entries after setting up
25098 nested function trampolines.
25099 This option has no effect if @option{-musermode} is in effect and the selected
25100 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
25101 instruction.
25102 If the selected code generation option does not allow the use of the @code{icbi}
25103 instruction, and @option{-musermode} is not in effect, the inlined code
25104 manipulates the instruction cache address array directly with an associative
25105 write.  This not only requires privileged mode at run time, but it also
25106 fails if the cache line had been mapped via the TLB and has become unmapped.
25108 @item -misize
25109 @opindex misize
25110 Dump instruction size and location in the assembly code.
25112 @item -mpadstruct
25113 @opindex mpadstruct
25114 This option is deprecated.  It pads structures to multiple of 4 bytes,
25115 which is incompatible with the SH ABI@.
25117 @item -matomic-model=@var{model}
25118 @opindex matomic-model=@var{model}
25119 Sets the model of atomic operations and additional parameters as a comma
25120 separated list.  For details on the atomic built-in functions see
25121 @ref{__atomic Builtins}.  The following models and parameters are supported:
25123 @table @samp
25125 @item none
25126 Disable compiler generated atomic sequences and emit library calls for atomic
25127 operations.  This is the default if the target is not @code{sh*-*-linux*}.
25129 @item soft-gusa
25130 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
25131 built-in functions.  The generated atomic sequences require additional support
25132 from the interrupt/exception handling code of the system and are only suitable
25133 for SH3* and SH4* single-core systems.  This option is enabled by default when
25134 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
25135 this option also partially utilizes the hardware atomic instructions
25136 @code{movli.l} and @code{movco.l} to create more efficient code, unless
25137 @samp{strict} is specified.  
25139 @item soft-tcb
25140 Generate software atomic sequences that use a variable in the thread control
25141 block.  This is a variation of the gUSA sequences which can also be used on
25142 SH1* and SH2* targets.  The generated atomic sequences require additional
25143 support from the interrupt/exception handling code of the system and are only
25144 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
25145 parameter has to be specified as well.
25147 @item soft-imask
25148 Generate software atomic sequences that temporarily disable interrupts by
25149 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
25150 in privileged mode and is only suitable for single-core systems.  Additional
25151 support from the interrupt/exception handling code of the system is not
25152 required.  This model is enabled by default when the target is
25153 @code{sh*-*-linux*} and SH1* or SH2*.
25155 @item hard-llcs
25156 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
25157 instructions only.  This is only available on SH4A and is suitable for
25158 multi-core systems.  Since the hardware instructions support only 32 bit atomic
25159 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
25160 Code compiled with this option is also compatible with other software
25161 atomic model interrupt/exception handling systems if executed on an SH4A
25162 system.  Additional support from the interrupt/exception handling code of the
25163 system is not required for this model.
25165 @item gbr-offset=
25166 This parameter specifies the offset in bytes of the variable in the thread
25167 control block structure that should be used by the generated atomic sequences
25168 when the @samp{soft-tcb} model has been selected.  For other models this
25169 parameter is ignored.  The specified value must be an integer multiple of four
25170 and in the range 0-1020.
25172 @item strict
25173 This parameter prevents mixed usage of multiple atomic models, even if they
25174 are compatible, and makes the compiler generate atomic sequences of the
25175 specified model only.
25177 @end table
25179 @item -mtas
25180 @opindex mtas
25181 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
25182 Notice that depending on the particular hardware and software configuration
25183 this can degrade overall performance due to the operand cache line flushes
25184 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
25185 processors the @code{tas.b} instruction must be used with caution since it
25186 can result in data corruption for certain cache configurations.
25188 @item -mprefergot
25189 @opindex mprefergot
25190 When generating position-independent code, emit function calls using
25191 the Global Offset Table instead of the Procedure Linkage Table.
25193 @item -musermode
25194 @itemx -mno-usermode
25195 @opindex musermode
25196 @opindex mno-usermode
25197 Don't allow (allow) the compiler generating privileged mode code.  Specifying
25198 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
25199 inlined code would not work in user mode.  @option{-musermode} is the default
25200 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
25201 @option{-musermode} has no effect, since there is no user mode.
25203 @item -multcost=@var{number}
25204 @opindex multcost=@var{number}
25205 Set the cost to assume for a multiply insn.
25207 @item -mdiv=@var{strategy}
25208 @opindex mdiv=@var{strategy}
25209 Set the division strategy to be used for integer division operations.
25210 @var{strategy} can be one of: 
25212 @table @samp
25214 @item call-div1
25215 Calls a library function that uses the single-step division instruction
25216 @code{div1} to perform the operation.  Division by zero calculates an
25217 unspecified result and does not trap.  This is the default except for SH4,
25218 SH2A and SHcompact.
25220 @item call-fp
25221 Calls a library function that performs the operation in double precision
25222 floating point.  Division by zero causes a floating-point exception.  This is
25223 the default for SHcompact with FPU.  Specifying this for targets that do not
25224 have a double precision FPU defaults to @code{call-div1}.
25226 @item call-table
25227 Calls a library function that uses a lookup table for small divisors and
25228 the @code{div1} instruction with case distinction for larger divisors.  Division
25229 by zero calculates an unspecified result and does not trap.  This is the default
25230 for SH4.  Specifying this for targets that do not have dynamic shift
25231 instructions defaults to @code{call-div1}.
25233 @end table
25235 When a division strategy has not been specified the default strategy is
25236 selected based on the current target.  For SH2A the default strategy is to
25237 use the @code{divs} and @code{divu} instructions instead of library function
25238 calls.
25240 @item -maccumulate-outgoing-args
25241 @opindex maccumulate-outgoing-args
25242 Reserve space once for outgoing arguments in the function prologue rather
25243 than around each call.  Generally beneficial for performance and size.  Also
25244 needed for unwinding to avoid changing the stack frame around conditional code.
25246 @item -mdivsi3_libfunc=@var{name}
25247 @opindex mdivsi3_libfunc=@var{name}
25248 Set the name of the library function used for 32-bit signed division to
25249 @var{name}.
25250 This only affects the name used in the @samp{call} division strategies, and
25251 the compiler still expects the same sets of input/output/clobbered registers as
25252 if this option were not present.
25254 @item -mfixed-range=@var{register-range}
25255 @opindex mfixed-range
25256 Generate code treating the given register range as fixed registers.
25257 A fixed register is one that the register allocator can not use.  This is
25258 useful when compiling kernel code.  A register range is specified as
25259 two registers separated by a dash.  Multiple register ranges can be
25260 specified separated by a comma.
25262 @item -mbranch-cost=@var{num}
25263 @opindex mbranch-cost=@var{num}
25264 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
25265 make the compiler try to generate more branch-free code if possible.  
25266 If not specified the value is selected depending on the processor type that
25267 is being compiled for.
25269 @item -mzdcbranch
25270 @itemx -mno-zdcbranch
25271 @opindex mzdcbranch
25272 @opindex mno-zdcbranch
25273 Assume (do not assume) that zero displacement conditional branch instructions
25274 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
25275 compiler prefers zero displacement branch code sequences.  This is
25276 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
25277 disabled by specifying @option{-mno-zdcbranch}.
25279 @item -mcbranch-force-delay-slot
25280 @opindex mcbranch-force-delay-slot
25281 Force the usage of delay slots for conditional branches, which stuffs the delay
25282 slot with a @code{nop} if a suitable instruction cannot be found.  By default
25283 this option is disabled.  It can be enabled to work around hardware bugs as
25284 found in the original SH7055.
25286 @item -mfused-madd
25287 @itemx -mno-fused-madd
25288 @opindex mfused-madd
25289 @opindex mno-fused-madd
25290 Generate code that uses (does not use) the floating-point multiply and
25291 accumulate instructions.  These instructions are generated by default
25292 if hardware floating point is used.  The machine-dependent
25293 @option{-mfused-madd} option is now mapped to the machine-independent
25294 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
25295 mapped to @option{-ffp-contract=off}.
25297 @item -mfsca
25298 @itemx -mno-fsca
25299 @opindex mfsca
25300 @opindex mno-fsca
25301 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
25302 and cosine approximations.  The option @option{-mfsca} must be used in
25303 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
25304 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
25305 approximations even if @option{-funsafe-math-optimizations} is in effect.
25307 @item -mfsrra
25308 @itemx -mno-fsrra
25309 @opindex mfsrra
25310 @opindex mno-fsrra
25311 Allow or disallow the compiler to emit the @code{fsrra} instruction for
25312 reciprocal square root approximations.  The option @option{-mfsrra} must be used
25313 in combination with @option{-funsafe-math-optimizations} and
25314 @option{-ffinite-math-only}.  It is enabled by default when generating code for
25315 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
25316 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
25317 in effect.
25319 @item -mpretend-cmove
25320 @opindex mpretend-cmove
25321 Prefer zero-displacement conditional branches for conditional move instruction
25322 patterns.  This can result in faster code on the SH4 processor.
25324 @item -mfdpic
25325 @opindex fdpic
25326 Generate code using the FDPIC ABI.
25328 @end table
25330 @node Solaris 2 Options
25331 @subsection Solaris 2 Options
25332 @cindex Solaris 2 options
25334 These @samp{-m} options are supported on Solaris 2:
25336 @table @gcctabopt
25337 @item -mclear-hwcap
25338 @opindex mclear-hwcap
25339 @option{-mclear-hwcap} tells the compiler to remove the hardware
25340 capabilities generated by the Solaris assembler.  This is only necessary
25341 when object files use ISA extensions not supported by the current
25342 machine, but check at runtime whether or not to use them.
25344 @item -mimpure-text
25345 @opindex mimpure-text
25346 @option{-mimpure-text}, used in addition to @option{-shared}, tells
25347 the compiler to not pass @option{-z text} to the linker when linking a
25348 shared object.  Using this option, you can link position-dependent
25349 code into a shared object.
25351 @option{-mimpure-text} suppresses the ``relocations remain against
25352 allocatable but non-writable sections'' linker error message.
25353 However, the necessary relocations trigger copy-on-write, and the
25354 shared object is not actually shared across processes.  Instead of
25355 using @option{-mimpure-text}, you should compile all source code with
25356 @option{-fpic} or @option{-fPIC}.
25358 @end table
25360 These switches are supported in addition to the above on Solaris 2:
25362 @table @gcctabopt
25363 @item -pthreads
25364 @opindex pthreads
25365 This is a synonym for @option{-pthread}.
25366 @end table
25368 @node SPARC Options
25369 @subsection SPARC Options
25370 @cindex SPARC options
25372 These @samp{-m} options are supported on the SPARC:
25374 @table @gcctabopt
25375 @item -mno-app-regs
25376 @itemx -mapp-regs
25377 @opindex mno-app-regs
25378 @opindex mapp-regs
25379 Specify @option{-mapp-regs} to generate output using the global registers
25380 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
25381 global register 1, each global register 2 through 4 is then treated as an
25382 allocable register that is clobbered by function calls.  This is the default.
25384 To be fully SVR4 ABI-compliant at the cost of some performance loss,
25385 specify @option{-mno-app-regs}.  You should compile libraries and system
25386 software with this option.
25388 @item -mflat
25389 @itemx -mno-flat
25390 @opindex mflat
25391 @opindex mno-flat
25392 With @option{-mflat}, the compiler does not generate save/restore instructions
25393 and uses a ``flat'' or single register window model.  This model is compatible
25394 with the regular register window model.  The local registers and the input
25395 registers (0--5) are still treated as ``call-saved'' registers and are
25396 saved on the stack as needed.
25398 With @option{-mno-flat} (the default), the compiler generates save/restore
25399 instructions (except for leaf functions).  This is the normal operating mode.
25401 @item -mfpu
25402 @itemx -mhard-float
25403 @opindex mfpu
25404 @opindex mhard-float
25405 Generate output containing floating-point instructions.  This is the
25406 default.
25408 @item -mno-fpu
25409 @itemx -msoft-float
25410 @opindex mno-fpu
25411 @opindex msoft-float
25412 Generate output containing library calls for floating point.
25413 @strong{Warning:} the requisite libraries are not available for all SPARC
25414 targets.  Normally the facilities of the machine's usual C compiler are
25415 used, but this cannot be done directly in cross-compilation.  You must make
25416 your own arrangements to provide suitable library functions for
25417 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
25418 @samp{sparclite-*-*} do provide software floating-point support.
25420 @option{-msoft-float} changes the calling convention in the output file;
25421 therefore, it is only useful if you compile @emph{all} of a program with
25422 this option.  In particular, you need to compile @file{libgcc.a}, the
25423 library that comes with GCC, with @option{-msoft-float} in order for
25424 this to work.
25426 @item -mhard-quad-float
25427 @opindex mhard-quad-float
25428 Generate output containing quad-word (long double) floating-point
25429 instructions.
25431 @item -msoft-quad-float
25432 @opindex msoft-quad-float
25433 Generate output containing library calls for quad-word (long double)
25434 floating-point instructions.  The functions called are those specified
25435 in the SPARC ABI@.  This is the default.
25437 As of this writing, there are no SPARC implementations that have hardware
25438 support for the quad-word floating-point instructions.  They all invoke
25439 a trap handler for one of these instructions, and then the trap handler
25440 emulates the effect of the instruction.  Because of the trap handler overhead,
25441 this is much slower than calling the ABI library routines.  Thus the
25442 @option{-msoft-quad-float} option is the default.
25444 @item -mno-unaligned-doubles
25445 @itemx -munaligned-doubles
25446 @opindex mno-unaligned-doubles
25447 @opindex munaligned-doubles
25448 Assume that doubles have 8-byte alignment.  This is the default.
25450 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
25451 alignment only if they are contained in another type, or if they have an
25452 absolute address.  Otherwise, it assumes they have 4-byte alignment.
25453 Specifying this option avoids some rare compatibility problems with code
25454 generated by other compilers.  It is not the default because it results
25455 in a performance loss, especially for floating-point code.
25457 @item -muser-mode
25458 @itemx -mno-user-mode
25459 @opindex muser-mode
25460 @opindex mno-user-mode
25461 Do not generate code that can only run in supervisor mode.  This is relevant
25462 only for the @code{casa} instruction emitted for the LEON3 processor.  This
25463 is the default.
25465 @item -mfaster-structs
25466 @itemx -mno-faster-structs
25467 @opindex mfaster-structs
25468 @opindex mno-faster-structs
25469 With @option{-mfaster-structs}, the compiler assumes that structures
25470 should have 8-byte alignment.  This enables the use of pairs of
25471 @code{ldd} and @code{std} instructions for copies in structure
25472 assignment, in place of twice as many @code{ld} and @code{st} pairs.
25473 However, the use of this changed alignment directly violates the SPARC
25474 ABI@.  Thus, it's intended only for use on targets where the developer
25475 acknowledges that their resulting code is not directly in line with
25476 the rules of the ABI@.
25478 @item -mstd-struct-return
25479 @itemx -mno-std-struct-return
25480 @opindex mstd-struct-return
25481 @opindex mno-std-struct-return
25482 With @option{-mstd-struct-return}, the compiler generates checking code
25483 in functions returning structures or unions to detect size mismatches
25484 between the two sides of function calls, as per the 32-bit ABI@.
25486 The default is @option{-mno-std-struct-return}.  This option has no effect
25487 in 64-bit mode.
25489 @item -mlra
25490 @itemx -mno-lra
25491 @opindex mlra
25492 @opindex mno-lra
25493 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
25494 so @option{-mno-lra} needs to be passed to get old Reload.
25496 @item -mcpu=@var{cpu_type}
25497 @opindex mcpu
25498 Set the instruction set, register set, and instruction scheduling parameters
25499 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25500 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
25501 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
25502 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
25503 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
25504 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
25506 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
25507 which selects the best architecture option for the host processor.
25508 @option{-mcpu=native} has no effect if GCC does not recognize
25509 the processor.
25511 Default instruction scheduling parameters are used for values that select
25512 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
25513 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
25515 Here is a list of each supported architecture and their supported
25516 implementations.
25518 @table @asis
25519 @item v7
25520 cypress, leon3v7
25522 @item v8
25523 supersparc, hypersparc, leon, leon3
25525 @item sparclite
25526 f930, f934, sparclite86x
25528 @item sparclet
25529 tsc701
25531 @item v9
25532 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
25533 niagara7, m8
25534 @end table
25536 By default (unless configured otherwise), GCC generates code for the V7
25537 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
25538 additionally optimizes it for the Cypress CY7C602 chip, as used in the
25539 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
25540 SPARCStation 1, 2, IPX etc.
25542 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
25543 architecture.  The only difference from V7 code is that the compiler emits
25544 the integer multiply and integer divide instructions which exist in SPARC-V8
25545 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
25546 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
25547 2000 series.
25549 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
25550 the SPARC architecture.  This adds the integer multiply, integer divide step
25551 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
25552 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
25553 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
25554 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
25555 MB86934 chip, which is the more recent SPARClite with FPU@.
25557 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
25558 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
25559 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
25560 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
25561 optimizes it for the TEMIC SPARClet chip.
25563 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
25564 architecture.  This adds 64-bit integer and floating-point move instructions,
25565 3 additional floating-point condition code registers and conditional move
25566 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
25567 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
25568 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
25569 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
25570 @option{-mcpu=niagara}, the compiler additionally optimizes it for
25571 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
25572 additionally optimizes it for Sun UltraSPARC T2 chips. With
25573 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
25574 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
25575 additionally optimizes it for Sun UltraSPARC T4 chips.  With
25576 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
25577 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
25578 additionally optimizes it for Oracle M8 chips.
25580 @item -mtune=@var{cpu_type}
25581 @opindex mtune
25582 Set the instruction scheduling parameters for machine type
25583 @var{cpu_type}, but do not set the instruction set or register set that the
25584 option @option{-mcpu=@var{cpu_type}} does.
25586 The same values for @option{-mcpu=@var{cpu_type}} can be used for
25587 @option{-mtune=@var{cpu_type}}, but the only useful values are those
25588 that select a particular CPU implementation.  Those are
25589 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
25590 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
25591 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
25592 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
25593 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
25594 and GNU/Linux toolchains, @samp{native} can also be used.
25596 @item -mv8plus
25597 @itemx -mno-v8plus
25598 @opindex mv8plus
25599 @opindex mno-v8plus
25600 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
25601 difference from the V8 ABI is that the global and out registers are
25602 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
25603 mode for all SPARC-V9 processors.
25605 @item -mvis
25606 @itemx -mno-vis
25607 @opindex mvis
25608 @opindex mno-vis
25609 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
25610 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
25612 @item -mvis2
25613 @itemx -mno-vis2
25614 @opindex mvis2
25615 @opindex mno-vis2
25616 With @option{-mvis2}, GCC generates code that takes advantage of
25617 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
25618 default is @option{-mvis2} when targeting a cpu that supports such
25619 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
25620 also sets @option{-mvis}.
25622 @item -mvis3
25623 @itemx -mno-vis3
25624 @opindex mvis3
25625 @opindex mno-vis3
25626 With @option{-mvis3}, GCC generates code that takes advantage of
25627 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
25628 default is @option{-mvis3} when targeting a cpu that supports such
25629 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
25630 also sets @option{-mvis2} and @option{-mvis}.
25632 @item -mvis4
25633 @itemx -mno-vis4
25634 @opindex mvis4
25635 @opindex mno-vis4
25636 With @option{-mvis4}, GCC generates code that takes advantage of
25637 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
25638 default is @option{-mvis4} when targeting a cpu that supports such
25639 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
25640 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
25642 @item -mvis4b
25643 @itemx -mno-vis4b
25644 @opindex mvis4b
25645 @opindex mno-vis4b
25646 With @option{-mvis4b}, GCC generates code that takes advantage of
25647 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
25648 the additional VIS instructions introduced in the Oracle SPARC
25649 Architecture 2017.  The default is @option{-mvis4b} when targeting a
25650 cpu that supports such instructions, such as m8 and later.  Setting
25651 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
25652 @option{-mvis2} and @option{-mvis}.
25654 @item -mcbcond
25655 @itemx -mno-cbcond
25656 @opindex mcbcond
25657 @opindex mno-cbcond
25658 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
25659 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
25660 when targeting a CPU that supports such instructions, such as Niagara-4 and
25661 later.
25663 @item -mfmaf
25664 @itemx -mno-fmaf
25665 @opindex mfmaf
25666 @opindex mno-fmaf
25667 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
25668 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
25669 when targeting a CPU that supports such instructions, such as Niagara-3 and
25670 later.
25672 @item -mfsmuld
25673 @itemx -mno-fsmuld
25674 @opindex mfsmuld
25675 @opindex mno-fsmuld
25676 With @option{-mfsmuld}, GCC generates code that takes advantage of the
25677 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
25678 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
25679 or V9 with FPU except @option{-mcpu=leon}.
25681 @item -mpopc
25682 @itemx -mno-popc
25683 @opindex mpopc
25684 @opindex mno-popc
25685 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
25686 Population Count instruction.  The default is @option{-mpopc}
25687 when targeting a CPU that supports such an instruction, such as Niagara-2 and
25688 later.
25690 @item -msubxc
25691 @itemx -mno-subxc
25692 @opindex msubxc
25693 @opindex mno-subxc
25694 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
25695 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
25696 when targeting a CPU that supports such an instruction, such as Niagara-7 and
25697 later.
25699 @item -mfix-at697f
25700 @opindex mfix-at697f
25701 Enable the documented workaround for the single erratum of the Atmel AT697F
25702 processor (which corresponds to erratum #13 of the AT697E processor).
25704 @item -mfix-ut699
25705 @opindex mfix-ut699
25706 Enable the documented workarounds for the floating-point errata and the data
25707 cache nullify errata of the UT699 processor.
25709 @item -mfix-ut700
25710 @opindex mfix-ut700
25711 Enable the documented workaround for the back-to-back store errata of
25712 the UT699E/UT700 processor.
25714 @item -mfix-gr712rc
25715 @opindex mfix-gr712rc
25716 Enable the documented workaround for the back-to-back store errata of
25717 the GR712RC processor.
25718 @end table
25720 These @samp{-m} options are supported in addition to the above
25721 on SPARC-V9 processors in 64-bit environments:
25723 @table @gcctabopt
25724 @item -m32
25725 @itemx -m64
25726 @opindex m32
25727 @opindex m64
25728 Generate code for a 32-bit or 64-bit environment.
25729 The 32-bit environment sets int, long and pointer to 32 bits.
25730 The 64-bit environment sets int to 32 bits and long and pointer
25731 to 64 bits.
25733 @item -mcmodel=@var{which}
25734 @opindex mcmodel
25735 Set the code model to one of
25737 @table @samp
25738 @item medlow
25739 The Medium/Low code model: 64-bit addresses, programs
25740 must be linked in the low 32 bits of memory.  Programs can be statically
25741 or dynamically linked.
25743 @item medmid
25744 The Medium/Middle code model: 64-bit addresses, programs
25745 must be linked in the low 44 bits of memory, the text and data segments must
25746 be less than 2GB in size and the data segment must be located within 2GB of
25747 the text segment.
25749 @item medany
25750 The Medium/Anywhere code model: 64-bit addresses, programs
25751 may be linked anywhere in memory, the text and data segments must be less
25752 than 2GB in size and the data segment must be located within 2GB of the
25753 text segment.
25755 @item embmedany
25756 The Medium/Anywhere code model for embedded systems:
25757 64-bit addresses, the text and data segments must be less than 2GB in
25758 size, both starting anywhere in memory (determined at link time).  The
25759 global register %g4 points to the base of the data segment.  Programs
25760 are statically linked and PIC is not supported.
25761 @end table
25763 @item -mmemory-model=@var{mem-model}
25764 @opindex mmemory-model
25765 Set the memory model in force on the processor to one of
25767 @table @samp
25768 @item default
25769 The default memory model for the processor and operating system.
25771 @item rmo
25772 Relaxed Memory Order
25774 @item pso
25775 Partial Store Order
25777 @item tso
25778 Total Store Order
25780 @item sc
25781 Sequential Consistency
25782 @end table
25784 These memory models are formally defined in Appendix D of the SPARC-V9
25785 architecture manual, as set in the processor's @code{PSTATE.MM} field.
25787 @item -mstack-bias
25788 @itemx -mno-stack-bias
25789 @opindex mstack-bias
25790 @opindex mno-stack-bias
25791 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
25792 frame pointer if present, are offset by @minus{}2047 which must be added back
25793 when making stack frame references.  This is the default in 64-bit mode.
25794 Otherwise, assume no such offset is present.
25795 @end table
25797 @node SPU Options
25798 @subsection SPU Options
25799 @cindex SPU options
25801 These @samp{-m} options are supported on the SPU:
25803 @table @gcctabopt
25804 @item -mwarn-reloc
25805 @itemx -merror-reloc
25806 @opindex mwarn-reloc
25807 @opindex merror-reloc
25809 The loader for SPU does not handle dynamic relocations.  By default, GCC
25810 gives an error when it generates code that requires a dynamic
25811 relocation.  @option{-mno-error-reloc} disables the error,
25812 @option{-mwarn-reloc} generates a warning instead.
25814 @item -msafe-dma
25815 @itemx -munsafe-dma
25816 @opindex msafe-dma
25817 @opindex munsafe-dma
25819 Instructions that initiate or test completion of DMA must not be
25820 reordered with respect to loads and stores of the memory that is being
25821 accessed.
25822 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
25823 memory accesses, but that can lead to inefficient code in places where the
25824 memory is known to not change.  Rather than mark the memory as volatile,
25825 you can use @option{-msafe-dma} to tell the compiler to treat
25826 the DMA instructions as potentially affecting all memory.  
25828 @item -mbranch-hints
25829 @opindex mbranch-hints
25831 By default, GCC generates a branch hint instruction to avoid
25832 pipeline stalls for always-taken or probably-taken branches.  A hint
25833 is not generated closer than 8 instructions away from its branch.
25834 There is little reason to disable them, except for debugging purposes,
25835 or to make an object a little bit smaller.
25837 @item -msmall-mem
25838 @itemx -mlarge-mem
25839 @opindex msmall-mem
25840 @opindex mlarge-mem
25842 By default, GCC generates code assuming that addresses are never larger
25843 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
25844 a full 32-bit address.
25846 @item -mstdmain
25847 @opindex mstdmain
25849 By default, GCC links against startup code that assumes the SPU-style
25850 main function interface (which has an unconventional parameter list).
25851 With @option{-mstdmain}, GCC links your program against startup
25852 code that assumes a C99-style interface to @code{main}, including a
25853 local copy of @code{argv} strings.
25855 @item -mfixed-range=@var{register-range}
25856 @opindex mfixed-range
25857 Generate code treating the given register range as fixed registers.
25858 A fixed register is one that the register allocator cannot use.  This is
25859 useful when compiling kernel code.  A register range is specified as
25860 two registers separated by a dash.  Multiple register ranges can be
25861 specified separated by a comma.
25863 @item -mea32
25864 @itemx -mea64
25865 @opindex mea32
25866 @opindex mea64
25867 Compile code assuming that pointers to the PPU address space accessed
25868 via the @code{__ea} named address space qualifier are either 32 or 64
25869 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
25870 all object code in an executable must be compiled with the same setting.
25872 @item -maddress-space-conversion
25873 @itemx -mno-address-space-conversion
25874 @opindex maddress-space-conversion
25875 @opindex mno-address-space-conversion
25876 Allow/disallow treating the @code{__ea} address space as superset
25877 of the generic address space.  This enables explicit type casts
25878 between @code{__ea} and generic pointer as well as implicit
25879 conversions of generic pointers to @code{__ea} pointers.  The
25880 default is to allow address space pointer conversions.
25882 @item -mcache-size=@var{cache-size}
25883 @opindex mcache-size
25884 This option controls the version of libgcc that the compiler links to an
25885 executable and selects a software-managed cache for accessing variables
25886 in the @code{__ea} address space with a particular cache size.  Possible
25887 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
25888 and @samp{128}.  The default cache size is 64KB.
25890 @item -matomic-updates
25891 @itemx -mno-atomic-updates
25892 @opindex matomic-updates
25893 @opindex mno-atomic-updates
25894 This option controls the version of libgcc that the compiler links to an
25895 executable and selects whether atomic updates to the software-managed
25896 cache of PPU-side variables are used.  If you use atomic updates, changes
25897 to a PPU variable from SPU code using the @code{__ea} named address space
25898 qualifier do not interfere with changes to other PPU variables residing
25899 in the same cache line from PPU code.  If you do not use atomic updates,
25900 such interference may occur; however, writing back cache lines is
25901 more efficient.  The default behavior is to use atomic updates.
25903 @item -mdual-nops
25904 @itemx -mdual-nops=@var{n}
25905 @opindex mdual-nops
25906 By default, GCC inserts NOPs to increase dual issue when it expects
25907 it to increase performance.  @var{n} can be a value from 0 to 10.  A
25908 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
25909 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
25911 @item -mhint-max-nops=@var{n}
25912 @opindex mhint-max-nops
25913 Maximum number of NOPs to insert for a branch hint.  A branch hint must
25914 be at least 8 instructions away from the branch it is affecting.  GCC
25915 inserts up to @var{n} NOPs to enforce this, otherwise it does not
25916 generate the branch hint.
25918 @item -mhint-max-distance=@var{n}
25919 @opindex mhint-max-distance
25920 The encoding of the branch hint instruction limits the hint to be within
25921 256 instructions of the branch it is affecting.  By default, GCC makes
25922 sure it is within 125.
25924 @item -msafe-hints
25925 @opindex msafe-hints
25926 Work around a hardware bug that causes the SPU to stall indefinitely.
25927 By default, GCC inserts the @code{hbrp} instruction to make sure
25928 this stall won't happen.
25930 @end table
25932 @node System V Options
25933 @subsection Options for System V
25935 These additional options are available on System V Release 4 for
25936 compatibility with other compilers on those systems:
25938 @table @gcctabopt
25939 @item -G
25940 @opindex G
25941 Create a shared object.
25942 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
25944 @item -Qy
25945 @opindex Qy
25946 Identify the versions of each tool used by the compiler, in a
25947 @code{.ident} assembler directive in the output.
25949 @item -Qn
25950 @opindex Qn
25951 Refrain from adding @code{.ident} directives to the output file (this is
25952 the default).
25954 @item -YP,@var{dirs}
25955 @opindex YP
25956 Search the directories @var{dirs}, and no others, for libraries
25957 specified with @option{-l}.
25959 @item -Ym,@var{dir}
25960 @opindex Ym
25961 Look in the directory @var{dir} to find the M4 preprocessor.
25962 The assembler uses this option.
25963 @c This is supposed to go with a -Yd for predefined M4 macro files, but
25964 @c the generic assembler that comes with Solaris takes just -Ym.
25965 @end table
25967 @node TILE-Gx Options
25968 @subsection TILE-Gx Options
25969 @cindex TILE-Gx options
25971 These @samp{-m} options are supported on the TILE-Gx:
25973 @table @gcctabopt
25974 @item -mcmodel=small
25975 @opindex mcmodel=small
25976 Generate code for the small model.  The distance for direct calls is
25977 limited to 500M in either direction.  PC-relative addresses are 32
25978 bits.  Absolute addresses support the full address range.
25980 @item -mcmodel=large
25981 @opindex mcmodel=large
25982 Generate code for the large model.  There is no limitation on call
25983 distance, pc-relative addresses, or absolute addresses.
25985 @item -mcpu=@var{name}
25986 @opindex mcpu
25987 Selects the type of CPU to be targeted.  Currently the only supported
25988 type is @samp{tilegx}.
25990 @item -m32
25991 @itemx -m64
25992 @opindex m32
25993 @opindex m64
25994 Generate code for a 32-bit or 64-bit environment.  The 32-bit
25995 environment sets int, long, and pointer to 32 bits.  The 64-bit
25996 environment sets int to 32 bits and long and pointer to 64 bits.
25998 @item -mbig-endian
25999 @itemx -mlittle-endian
26000 @opindex mbig-endian
26001 @opindex mlittle-endian
26002 Generate code in big/little endian mode, respectively.
26003 @end table
26005 @node TILEPro Options
26006 @subsection TILEPro Options
26007 @cindex TILEPro options
26009 These @samp{-m} options are supported on the TILEPro:
26011 @table @gcctabopt
26012 @item -mcpu=@var{name}
26013 @opindex mcpu
26014 Selects the type of CPU to be targeted.  Currently the only supported
26015 type is @samp{tilepro}.
26017 @item -m32
26018 @opindex m32
26019 Generate code for a 32-bit environment, which sets int, long, and
26020 pointer to 32 bits.  This is the only supported behavior so the flag
26021 is essentially ignored.
26022 @end table
26024 @node V850 Options
26025 @subsection V850 Options
26026 @cindex V850 Options
26028 These @samp{-m} options are defined for V850 implementations:
26030 @table @gcctabopt
26031 @item -mlong-calls
26032 @itemx -mno-long-calls
26033 @opindex mlong-calls
26034 @opindex mno-long-calls
26035 Treat all calls as being far away (near).  If calls are assumed to be
26036 far away, the compiler always loads the function's address into a
26037 register, and calls indirect through the pointer.
26039 @item -mno-ep
26040 @itemx -mep
26041 @opindex mno-ep
26042 @opindex mep
26043 Do not optimize (do optimize) basic blocks that use the same index
26044 pointer 4 or more times to copy pointer into the @code{ep} register, and
26045 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
26046 option is on by default if you optimize.
26048 @item -mno-prolog-function
26049 @itemx -mprolog-function
26050 @opindex mno-prolog-function
26051 @opindex mprolog-function
26052 Do not use (do use) external functions to save and restore registers
26053 at the prologue and epilogue of a function.  The external functions
26054 are slower, but use less code space if more than one function saves
26055 the same number of registers.  The @option{-mprolog-function} option
26056 is on by default if you optimize.
26058 @item -mspace
26059 @opindex mspace
26060 Try to make the code as small as possible.  At present, this just turns
26061 on the @option{-mep} and @option{-mprolog-function} options.
26063 @item -mtda=@var{n}
26064 @opindex mtda
26065 Put static or global variables whose size is @var{n} bytes or less into
26066 the tiny data area that register @code{ep} points to.  The tiny data
26067 area can hold up to 256 bytes in total (128 bytes for byte references).
26069 @item -msda=@var{n}
26070 @opindex msda
26071 Put static or global variables whose size is @var{n} bytes or less into
26072 the small data area that register @code{gp} points to.  The small data
26073 area can hold up to 64 kilobytes.
26075 @item -mzda=@var{n}
26076 @opindex mzda
26077 Put static or global variables whose size is @var{n} bytes or less into
26078 the first 32 kilobytes of memory.
26080 @item -mv850
26081 @opindex mv850
26082 Specify that the target processor is the V850.
26084 @item -mv850e3v5
26085 @opindex mv850e3v5
26086 Specify that the target processor is the V850E3V5.  The preprocessor
26087 constant @code{__v850e3v5__} is defined if this option is used.
26089 @item -mv850e2v4
26090 @opindex mv850e2v4
26091 Specify that the target processor is the V850E3V5.  This is an alias for
26092 the @option{-mv850e3v5} option.
26094 @item -mv850e2v3
26095 @opindex mv850e2v3
26096 Specify that the target processor is the V850E2V3.  The preprocessor
26097 constant @code{__v850e2v3__} is defined if this option is used.
26099 @item -mv850e2
26100 @opindex mv850e2
26101 Specify that the target processor is the V850E2.  The preprocessor
26102 constant @code{__v850e2__} is defined if this option is used.
26104 @item -mv850e1
26105 @opindex mv850e1
26106 Specify that the target processor is the V850E1.  The preprocessor
26107 constants @code{__v850e1__} and @code{__v850e__} are defined if
26108 this option is used.
26110 @item -mv850es
26111 @opindex mv850es
26112 Specify that the target processor is the V850ES.  This is an alias for
26113 the @option{-mv850e1} option.
26115 @item -mv850e
26116 @opindex mv850e
26117 Specify that the target processor is the V850E@.  The preprocessor
26118 constant @code{__v850e__} is defined if this option is used.
26120 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
26121 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
26122 are defined then a default target processor is chosen and the
26123 relevant @samp{__v850*__} preprocessor constant is defined.
26125 The preprocessor constants @code{__v850} and @code{__v851__} are always
26126 defined, regardless of which processor variant is the target.
26128 @item -mdisable-callt
26129 @itemx -mno-disable-callt
26130 @opindex mdisable-callt
26131 @opindex mno-disable-callt
26132 This option suppresses generation of the @code{CALLT} instruction for the
26133 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
26134 architecture.
26136 This option is enabled by default when the RH850 ABI is
26137 in use (see @option{-mrh850-abi}), and disabled by default when the
26138 GCC ABI is in use.  If @code{CALLT} instructions are being generated
26139 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
26141 @item -mrelax
26142 @itemx -mno-relax
26143 @opindex mrelax
26144 @opindex mno-relax
26145 Pass on (or do not pass on) the @option{-mrelax} command-line option
26146 to the assembler.
26148 @item -mlong-jumps
26149 @itemx -mno-long-jumps
26150 @opindex mlong-jumps
26151 @opindex mno-long-jumps
26152 Disable (or re-enable) the generation of PC-relative jump instructions.
26154 @item -msoft-float
26155 @itemx -mhard-float
26156 @opindex msoft-float
26157 @opindex mhard-float
26158 Disable (or re-enable) the generation of hardware floating point
26159 instructions.  This option is only significant when the target
26160 architecture is @samp{V850E2V3} or higher.  If hardware floating point
26161 instructions are being generated then the C preprocessor symbol
26162 @code{__FPU_OK__} is defined, otherwise the symbol
26163 @code{__NO_FPU__} is defined.
26165 @item -mloop
26166 @opindex mloop
26167 Enables the use of the e3v5 LOOP instruction.  The use of this
26168 instruction is not enabled by default when the e3v5 architecture is
26169 selected because its use is still experimental.
26171 @item -mrh850-abi
26172 @itemx -mghs
26173 @opindex mrh850-abi
26174 @opindex mghs
26175 Enables support for the RH850 version of the V850 ABI.  This is the
26176 default.  With this version of the ABI the following rules apply:
26178 @itemize
26179 @item
26180 Integer sized structures and unions are returned via a memory pointer
26181 rather than a register.
26183 @item
26184 Large structures and unions (more than 8 bytes in size) are passed by
26185 value.
26187 @item
26188 Functions are aligned to 16-bit boundaries.
26190 @item
26191 The @option{-m8byte-align} command-line option is supported.
26193 @item
26194 The @option{-mdisable-callt} command-line option is enabled by
26195 default.  The @option{-mno-disable-callt} command-line option is not
26196 supported.
26197 @end itemize
26199 When this version of the ABI is enabled the C preprocessor symbol
26200 @code{__V850_RH850_ABI__} is defined.
26202 @item -mgcc-abi
26203 @opindex mgcc-abi
26204 Enables support for the old GCC version of the V850 ABI.  With this
26205 version of the ABI the following rules apply:
26207 @itemize
26208 @item
26209 Integer sized structures and unions are returned in register @code{r10}.
26211 @item
26212 Large structures and unions (more than 8 bytes in size) are passed by
26213 reference.
26215 @item
26216 Functions are aligned to 32-bit boundaries, unless optimizing for
26217 size.
26219 @item
26220 The @option{-m8byte-align} command-line option is not supported.
26222 @item
26223 The @option{-mdisable-callt} command-line option is supported but not
26224 enabled by default.
26225 @end itemize
26227 When this version of the ABI is enabled the C preprocessor symbol
26228 @code{__V850_GCC_ABI__} is defined.
26230 @item -m8byte-align
26231 @itemx -mno-8byte-align
26232 @opindex m8byte-align
26233 @opindex mno-8byte-align
26234 Enables support for @code{double} and @code{long long} types to be
26235 aligned on 8-byte boundaries.  The default is to restrict the
26236 alignment of all objects to at most 4-bytes.  When
26237 @option{-m8byte-align} is in effect the C preprocessor symbol
26238 @code{__V850_8BYTE_ALIGN__} is defined.
26240 @item -mbig-switch
26241 @opindex mbig-switch
26242 Generate code suitable for big switch tables.  Use this option only if
26243 the assembler/linker complain about out of range branches within a switch
26244 table.
26246 @item -mapp-regs
26247 @opindex mapp-regs
26248 This option causes r2 and r5 to be used in the code generated by
26249 the compiler.  This setting is the default.
26251 @item -mno-app-regs
26252 @opindex mno-app-regs
26253 This option causes r2 and r5 to be treated as fixed registers.
26255 @end table
26257 @node VAX Options
26258 @subsection VAX Options
26259 @cindex VAX options
26261 These @samp{-m} options are defined for the VAX:
26263 @table @gcctabopt
26264 @item -munix
26265 @opindex munix
26266 Do not output certain jump instructions (@code{aobleq} and so on)
26267 that the Unix assembler for the VAX cannot handle across long
26268 ranges.
26270 @item -mgnu
26271 @opindex mgnu
26272 Do output those jump instructions, on the assumption that the
26273 GNU assembler is being used.
26275 @item -mg
26276 @opindex mg
26277 Output code for G-format floating-point numbers instead of D-format.
26278 @end table
26280 @node Visium Options
26281 @subsection Visium Options
26282 @cindex Visium options
26284 @table @gcctabopt
26286 @item -mdebug
26287 @opindex mdebug
26288 A program which performs file I/O and is destined to run on an MCM target
26289 should be linked with this option.  It causes the libraries libc.a and
26290 libdebug.a to be linked.  The program should be run on the target under
26291 the control of the GDB remote debugging stub.
26293 @item -msim
26294 @opindex msim
26295 A program which performs file I/O and is destined to run on the simulator
26296 should be linked with option.  This causes libraries libc.a and libsim.a to
26297 be linked.
26299 @item -mfpu
26300 @itemx -mhard-float
26301 @opindex mfpu
26302 @opindex mhard-float
26303 Generate code containing floating-point instructions.  This is the
26304 default.
26306 @item -mno-fpu
26307 @itemx -msoft-float
26308 @opindex mno-fpu
26309 @opindex msoft-float
26310 Generate code containing library calls for floating-point.
26312 @option{-msoft-float} changes the calling convention in the output file;
26313 therefore, it is only useful if you compile @emph{all} of a program with
26314 this option.  In particular, you need to compile @file{libgcc.a}, the
26315 library that comes with GCC, with @option{-msoft-float} in order for
26316 this to work.
26318 @item -mcpu=@var{cpu_type}
26319 @opindex mcpu
26320 Set the instruction set, register set, and instruction scheduling parameters
26321 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
26322 @samp{mcm}, @samp{gr5} and @samp{gr6}.
26324 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
26326 By default (unless configured otherwise), GCC generates code for the GR5
26327 variant of the Visium architecture.  
26329 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
26330 architecture.  The only difference from GR5 code is that the compiler will
26331 generate block move instructions.
26333 @item -mtune=@var{cpu_type}
26334 @opindex mtune
26335 Set the instruction scheduling parameters for machine type @var{cpu_type},
26336 but do not set the instruction set or register set that the option
26337 @option{-mcpu=@var{cpu_type}} would.
26339 @item -msv-mode
26340 @opindex msv-mode
26341 Generate code for the supervisor mode, where there are no restrictions on
26342 the access to general registers.  This is the default.
26344 @item -muser-mode
26345 @opindex muser-mode
26346 Generate code for the user mode, where the access to some general registers
26347 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
26348 mode; on the GR6, only registers r29 to r31 are affected.
26349 @end table
26351 @node VMS Options
26352 @subsection VMS Options
26354 These @samp{-m} options are defined for the VMS implementations:
26356 @table @gcctabopt
26357 @item -mvms-return-codes
26358 @opindex mvms-return-codes
26359 Return VMS condition codes from @code{main}. The default is to return POSIX-style
26360 condition (e.g.@ error) codes.
26362 @item -mdebug-main=@var{prefix}
26363 @opindex mdebug-main=@var{prefix}
26364 Flag the first routine whose name starts with @var{prefix} as the main
26365 routine for the debugger.
26367 @item -mmalloc64
26368 @opindex mmalloc64
26369 Default to 64-bit memory allocation routines.
26371 @item -mpointer-size=@var{size}
26372 @opindex mpointer-size=@var{size}
26373 Set the default size of pointers. Possible options for @var{size} are
26374 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
26375 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
26376 The later option disables @code{pragma pointer_size}.
26377 @end table
26379 @node VxWorks Options
26380 @subsection VxWorks Options
26381 @cindex VxWorks Options
26383 The options in this section are defined for all VxWorks targets.
26384 Options specific to the target hardware are listed with the other
26385 options for that target.
26387 @table @gcctabopt
26388 @item -mrtp
26389 @opindex mrtp
26390 GCC can generate code for both VxWorks kernels and real time processes
26391 (RTPs).  This option switches from the former to the latter.  It also
26392 defines the preprocessor macro @code{__RTP__}.
26394 @item -non-static
26395 @opindex non-static
26396 Link an RTP executable against shared libraries rather than static
26397 libraries.  The options @option{-static} and @option{-shared} can
26398 also be used for RTPs (@pxref{Link Options}); @option{-static}
26399 is the default.
26401 @item -Bstatic
26402 @itemx -Bdynamic
26403 @opindex Bstatic
26404 @opindex Bdynamic
26405 These options are passed down to the linker.  They are defined for
26406 compatibility with Diab.
26408 @item -Xbind-lazy
26409 @opindex Xbind-lazy
26410 Enable lazy binding of function calls.  This option is equivalent to
26411 @option{-Wl,-z,now} and is defined for compatibility with Diab.
26413 @item -Xbind-now
26414 @opindex Xbind-now
26415 Disable lazy binding of function calls.  This option is the default and
26416 is defined for compatibility with Diab.
26417 @end table
26419 @node x86 Options
26420 @subsection x86 Options
26421 @cindex x86 Options
26423 These @samp{-m} options are defined for the x86 family of computers.
26425 @table @gcctabopt
26427 @item -march=@var{cpu-type}
26428 @opindex march
26429 Generate instructions for the machine type @var{cpu-type}.  In contrast to
26430 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
26431 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
26432 to generate code that may not run at all on processors other than the one
26433 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
26434 @option{-mtune=@var{cpu-type}}.
26436 The choices for @var{cpu-type} are:
26438 @table @samp
26439 @item native
26440 This selects the CPU to generate code for at compilation time by determining
26441 the processor type of the compiling machine.  Using @option{-march=native}
26442 enables all instruction subsets supported by the local machine (hence
26443 the result might not run on different machines).  Using @option{-mtune=native}
26444 produces code optimized for the local machine under the constraints
26445 of the selected instruction set.  
26447 @item x86-64
26448 A generic CPU with 64-bit extensions.
26450 @item i386
26451 Original Intel i386 CPU@.
26453 @item i486
26454 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
26456 @item i586
26457 @itemx pentium
26458 Intel Pentium CPU with no MMX support.
26460 @item lakemont
26461 Intel Lakemont MCU, based on Intel Pentium CPU.
26463 @item pentium-mmx
26464 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
26466 @item pentiumpro
26467 Intel Pentium Pro CPU@.
26469 @item i686
26470 When used with @option{-march}, the Pentium Pro
26471 instruction set is used, so the code runs on all i686 family chips.
26472 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
26474 @item pentium2
26475 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
26476 support.
26478 @item pentium3
26479 @itemx pentium3m
26480 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
26481 set support.
26483 @item pentium-m
26484 Intel Pentium M; low-power version of Intel Pentium III CPU
26485 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
26487 @item pentium4
26488 @itemx pentium4m
26489 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
26491 @item prescott
26492 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
26493 set support.
26495 @item nocona
26496 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
26497 SSE2 and SSE3 instruction set support.
26499 @item core2
26500 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
26501 instruction set support.
26503 @item nehalem
26504 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26505 SSE4.1, SSE4.2 and POPCNT instruction set support.
26507 @item westmere
26508 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26509 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
26511 @item sandybridge
26512 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26513 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
26515 @item ivybridge
26516 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26517 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
26518 instruction set support.
26520 @item haswell
26521 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26522 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26523 BMI, BMI2 and F16C instruction set support.
26525 @item broadwell
26526 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26527 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26528 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
26530 @item skylake
26531 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26532 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26533 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
26534 XSAVES instruction set support.
26536 @item bonnell
26537 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
26538 instruction set support.
26540 @item silvermont
26541 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26542 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
26544 @item knl
26545 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26546 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26547 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
26548 AVX512CD instruction set support.
26550 @item knm
26551 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26552 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26553 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26554 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
26556 @item skylake-avx512
26557 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26558 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26559 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
26560 CLWB, AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
26562 @item cannonlake
26563 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26564 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26565 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26566 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26567 AVX512IFMA, SHA and UMIP instruction set support.
26569 @item icelake-client
26570 Intel Icelake Client CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26571 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26572 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26573 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26574 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26575 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES instruction set support.
26577 @item icelake-server
26578 Intel Icelake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26579 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26580 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26581 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26582 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26583 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES, PCONFIG and WBNOINVD instruction
26584 set support.
26586 @item k6
26587 AMD K6 CPU with MMX instruction set support.
26589 @item k6-2
26590 @itemx k6-3
26591 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
26593 @item athlon
26594 @itemx athlon-tbird
26595 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
26596 support.
26598 @item athlon-4
26599 @itemx athlon-xp
26600 @itemx athlon-mp
26601 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
26602 instruction set support.
26604 @item k8
26605 @itemx opteron
26606 @itemx athlon64
26607 @itemx athlon-fx
26608 Processors based on the AMD K8 core with x86-64 instruction set support,
26609 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
26610 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
26611 instruction set extensions.)
26613 @item k8-sse3
26614 @itemx opteron-sse3
26615 @itemx athlon64-sse3
26616 Improved versions of AMD K8 cores with SSE3 instruction set support.
26618 @item amdfam10
26619 @itemx barcelona
26620 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
26621 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
26622 instruction set extensions.)
26624 @item bdver1
26625 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
26626 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
26627 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
26628 @item bdver2
26629 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26630 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
26631 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
26632 extensions.)
26633 @item bdver3
26634 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26635 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
26636 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
26637 64-bit instruction set extensions.
26638 @item bdver4
26639 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26640 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
26641 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
26642 SSE4.2, ABM and 64-bit instruction set extensions.
26644 @item znver1
26645 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
26646 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
26647 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
26648 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
26649 instruction set extensions.
26651 @item btver1
26652 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
26653 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
26654 instruction set extensions.)
26656 @item btver2
26657 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
26658 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
26659 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
26661 @item winchip-c6
26662 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
26663 set support.
26665 @item winchip2
26666 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
26667 instruction set support.
26669 @item c3
26670 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
26671 (No scheduling is implemented for this chip.)
26673 @item c3-2
26674 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
26675 (No scheduling is implemented for this chip.)
26677 @item c7
26678 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26679 (No scheduling is implemented for this chip.)
26681 @item samuel-2
26682 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
26683 (No scheduling is implemented for this chip.)
26685 @item nehemiah
26686 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
26687 (No scheduling is implemented for this chip.)
26689 @item esther
26690 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26691 (No scheduling is implemented for this chip.)
26693 @item eden-x2
26694 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
26695 (No scheduling is implemented for this chip.)
26697 @item eden-x4
26698 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
26699 AVX and AVX2 instruction set support.
26700 (No scheduling is implemented for this chip.)
26702 @item nano
26703 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26704 instruction set support.
26705 (No scheduling is implemented for this chip.)
26707 @item nano-1000
26708 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26709 instruction set support.
26710 (No scheduling is implemented for this chip.)
26712 @item nano-2000
26713 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26714 instruction set support.
26715 (No scheduling is implemented for this chip.)
26717 @item nano-3000
26718 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26719 instruction set support.
26720 (No scheduling is implemented for this chip.)
26722 @item nano-x2
26723 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26724 instruction set support.
26725 (No scheduling is implemented for this chip.)
26727 @item nano-x4
26728 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26729 instruction set support.
26730 (No scheduling is implemented for this chip.)
26732 @item geode
26733 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
26734 @end table
26736 @item -mtune=@var{cpu-type}
26737 @opindex mtune
26738 Tune to @var{cpu-type} everything applicable about the generated code, except
26739 for the ABI and the set of available instructions.  
26740 While picking a specific @var{cpu-type} schedules things appropriately
26741 for that particular chip, the compiler does not generate any code that
26742 cannot run on the default machine type unless you use a
26743 @option{-march=@var{cpu-type}} option.
26744 For example, if GCC is configured for i686-pc-linux-gnu
26745 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
26746 but still runs on i686 machines.
26748 The choices for @var{cpu-type} are the same as for @option{-march}.
26749 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
26751 @table @samp
26752 @item generic
26753 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
26754 If you know the CPU on which your code will run, then you should use
26755 the corresponding @option{-mtune} or @option{-march} option instead of
26756 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
26757 of your application will have, then you should use this option.
26759 As new processors are deployed in the marketplace, the behavior of this
26760 option will change.  Therefore, if you upgrade to a newer version of
26761 GCC, code generation controlled by this option will change to reflect
26762 the processors
26763 that are most common at the time that version of GCC is released.
26765 There is no @option{-march=generic} option because @option{-march}
26766 indicates the instruction set the compiler can use, and there is no
26767 generic instruction set applicable to all processors.  In contrast,
26768 @option{-mtune} indicates the processor (or, in this case, collection of
26769 processors) for which the code is optimized.
26771 @item intel
26772 Produce code optimized for the most current Intel processors, which are
26773 Haswell and Silvermont for this version of GCC.  If you know the CPU
26774 on which your code will run, then you should use the corresponding
26775 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
26776 But, if you want your application performs better on both Haswell and
26777 Silvermont, then you should use this option.
26779 As new Intel processors are deployed in the marketplace, the behavior of
26780 this option will change.  Therefore, if you upgrade to a newer version of
26781 GCC, code generation controlled by this option will change to reflect
26782 the most current Intel processors at the time that version of GCC is
26783 released.
26785 There is no @option{-march=intel} option because @option{-march} indicates
26786 the instruction set the compiler can use, and there is no common
26787 instruction set applicable to all processors.  In contrast,
26788 @option{-mtune} indicates the processor (or, in this case, collection of
26789 processors) for which the code is optimized.
26790 @end table
26792 @item -mcpu=@var{cpu-type}
26793 @opindex mcpu
26794 A deprecated synonym for @option{-mtune}.
26796 @item -mfpmath=@var{unit}
26797 @opindex mfpmath
26798 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
26799 for @var{unit} are:
26801 @table @samp
26802 @item 387
26803 Use the standard 387 floating-point coprocessor present on the majority of chips and
26804 emulated otherwise.  Code compiled with this option runs almost everywhere.
26805 The temporary results are computed in 80-bit precision instead of the precision
26806 specified by the type, resulting in slightly different results compared to most
26807 of other chips.  See @option{-ffloat-store} for more detailed description.
26809 This is the default choice for non-Darwin x86-32 targets.
26811 @item sse
26812 Use scalar floating-point instructions present in the SSE instruction set.
26813 This instruction set is supported by Pentium III and newer chips,
26814 and in the AMD line
26815 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
26816 instruction set supports only single-precision arithmetic, thus the double and
26817 extended-precision arithmetic are still done using 387.  A later version, present
26818 only in Pentium 4 and AMD x86-64 chips, supports double-precision
26819 arithmetic too.
26821 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
26822 or @option{-msse2} switches to enable SSE extensions and make this option
26823 effective.  For the x86-64 compiler, these extensions are enabled by default.
26825 The resulting code should be considerably faster in the majority of cases and avoid
26826 the numerical instability problems of 387 code, but may break some existing
26827 code that expects temporaries to be 80 bits.
26829 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
26830 and the default choice for x86-32 targets with the SSE2 instruction set
26831 when @option{-ffast-math} is enabled.
26833 @item sse,387
26834 @itemx sse+387
26835 @itemx both
26836 Attempt to utilize both instruction sets at once.  This effectively doubles the
26837 amount of available registers, and on chips with separate execution units for
26838 387 and SSE the execution resources too.  Use this option with care, as it is
26839 still experimental, because the GCC register allocator does not model separate
26840 functional units well, resulting in unstable performance.
26841 @end table
26843 @item -masm=@var{dialect}
26844 @opindex masm=@var{dialect}
26845 Output assembly instructions using selected @var{dialect}.  Also affects
26846 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
26847 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
26848 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
26849 not support @samp{intel}.
26851 @item -mieee-fp
26852 @itemx -mno-ieee-fp
26853 @opindex mieee-fp
26854 @opindex mno-ieee-fp
26855 Control whether or not the compiler uses IEEE floating-point
26856 comparisons.  These correctly handle the case where the result of a
26857 comparison is unordered.
26859 @item -m80387
26860 @itemx -mhard-float
26861 @opindex 80387
26862 @opindex mhard-float
26863 Generate output containing 80387 instructions for floating point.
26865 @item -mno-80387
26866 @itemx -msoft-float
26867 @opindex no-80387
26868 @opindex msoft-float
26869 Generate output containing library calls for floating point.
26871 @strong{Warning:} the requisite libraries are not part of GCC@.
26872 Normally the facilities of the machine's usual C compiler are used, but
26873 this cannot be done directly in cross-compilation.  You must make your
26874 own arrangements to provide suitable library functions for
26875 cross-compilation.
26877 On machines where a function returns floating-point results in the 80387
26878 register stack, some floating-point opcodes may be emitted even if
26879 @option{-msoft-float} is used.
26881 @item -mno-fp-ret-in-387
26882 @opindex mno-fp-ret-in-387
26883 Do not use the FPU registers for return values of functions.
26885 The usual calling convention has functions return values of types
26886 @code{float} and @code{double} in an FPU register, even if there
26887 is no FPU@.  The idea is that the operating system should emulate
26888 an FPU@.
26890 The option @option{-mno-fp-ret-in-387} causes such values to be returned
26891 in ordinary CPU registers instead.
26893 @item -mno-fancy-math-387
26894 @opindex mno-fancy-math-387
26895 Some 387 emulators do not support the @code{sin}, @code{cos} and
26896 @code{sqrt} instructions for the 387.  Specify this option to avoid
26897 generating those instructions.  This option is the default on
26898 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
26899 indicates that the target CPU always has an FPU and so the
26900 instruction does not need emulation.  These
26901 instructions are not generated unless you also use the
26902 @option{-funsafe-math-optimizations} switch.
26904 @item -malign-double
26905 @itemx -mno-align-double
26906 @opindex malign-double
26907 @opindex mno-align-double
26908 Control whether GCC aligns @code{double}, @code{long double}, and
26909 @code{long long} variables on a two-word boundary or a one-word
26910 boundary.  Aligning @code{double} variables on a two-word boundary
26911 produces code that runs somewhat faster on a Pentium at the
26912 expense of more memory.
26914 On x86-64, @option{-malign-double} is enabled by default.
26916 @strong{Warning:} if you use the @option{-malign-double} switch,
26917 structures containing the above types are aligned differently than
26918 the published application binary interface specifications for the x86-32
26919 and are not binary compatible with structures in code compiled
26920 without that switch.
26922 @item -m96bit-long-double
26923 @itemx -m128bit-long-double
26924 @opindex m96bit-long-double
26925 @opindex m128bit-long-double
26926 These switches control the size of @code{long double} type.  The x86-32
26927 application binary interface specifies the size to be 96 bits,
26928 so @option{-m96bit-long-double} is the default in 32-bit mode.
26930 Modern architectures (Pentium and newer) prefer @code{long double}
26931 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
26932 conforming to the ABI, this is not possible.  So specifying
26933 @option{-m128bit-long-double} aligns @code{long double}
26934 to a 16-byte boundary by padding the @code{long double} with an additional
26935 32-bit zero.
26937 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
26938 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
26940 Notice that neither of these options enable any extra precision over the x87
26941 standard of 80 bits for a @code{long double}.
26943 @strong{Warning:} if you override the default value for your target ABI, this
26944 changes the size of 
26945 structures and arrays containing @code{long double} variables,
26946 as well as modifying the function calling convention for functions taking
26947 @code{long double}.  Hence they are not binary-compatible
26948 with code compiled without that switch.
26950 @item -mlong-double-64
26951 @itemx -mlong-double-80
26952 @itemx -mlong-double-128
26953 @opindex mlong-double-64
26954 @opindex mlong-double-80
26955 @opindex mlong-double-128
26956 These switches control the size of @code{long double} type. A size
26957 of 64 bits makes the @code{long double} type equivalent to the @code{double}
26958 type. This is the default for 32-bit Bionic C library.  A size
26959 of 128 bits makes the @code{long double} type equivalent to the
26960 @code{__float128} type. This is the default for 64-bit Bionic C library.
26962 @strong{Warning:} if you override the default value for your target ABI, this
26963 changes the size of
26964 structures and arrays containing @code{long double} variables,
26965 as well as modifying the function calling convention for functions taking
26966 @code{long double}.  Hence they are not binary-compatible
26967 with code compiled without that switch.
26969 @item -malign-data=@var{type}
26970 @opindex malign-data
26971 Control how GCC aligns variables.  Supported values for @var{type} are
26972 @samp{compat} uses increased alignment value compatible uses GCC 4.8
26973 and earlier, @samp{abi} uses alignment value as specified by the
26974 psABI, and @samp{cacheline} uses increased alignment value to match
26975 the cache line size.  @samp{compat} is the default.
26977 @item -mlarge-data-threshold=@var{threshold}
26978 @opindex mlarge-data-threshold
26979 When @option{-mcmodel=medium} is specified, data objects larger than
26980 @var{threshold} are placed in the large data section.  This value must be the
26981 same across all objects linked into the binary, and defaults to 65535.
26983 @item -mrtd
26984 @opindex mrtd
26985 Use a different function-calling convention, in which functions that
26986 take a fixed number of arguments return with the @code{ret @var{num}}
26987 instruction, which pops their arguments while returning.  This saves one
26988 instruction in the caller since there is no need to pop the arguments
26989 there.
26991 You can specify that an individual function is called with this calling
26992 sequence with the function attribute @code{stdcall}.  You can also
26993 override the @option{-mrtd} option by using the function attribute
26994 @code{cdecl}.  @xref{Function Attributes}.
26996 @strong{Warning:} this calling convention is incompatible with the one
26997 normally used on Unix, so you cannot use it if you need to call
26998 libraries compiled with the Unix compiler.
27000 Also, you must provide function prototypes for all functions that
27001 take variable numbers of arguments (including @code{printf});
27002 otherwise incorrect code is generated for calls to those
27003 functions.
27005 In addition, seriously incorrect code results if you call a
27006 function with too many arguments.  (Normally, extra arguments are
27007 harmlessly ignored.)
27009 @item -mregparm=@var{num}
27010 @opindex mregparm
27011 Control how many registers are used to pass integer arguments.  By
27012 default, no registers are used to pass arguments, and at most 3
27013 registers can be used.  You can control this behavior for a specific
27014 function by using the function attribute @code{regparm}.
27015 @xref{Function Attributes}.
27017 @strong{Warning:} if you use this switch, and
27018 @var{num} is nonzero, then you must build all modules with the same
27019 value, including any libraries.  This includes the system libraries and
27020 startup modules.
27022 @item -msseregparm
27023 @opindex msseregparm
27024 Use SSE register passing conventions for float and double arguments
27025 and return values.  You can control this behavior for a specific
27026 function by using the function attribute @code{sseregparm}.
27027 @xref{Function Attributes}.
27029 @strong{Warning:} if you use this switch then you must build all
27030 modules with the same value, including any libraries.  This includes
27031 the system libraries and startup modules.
27033 @item -mvect8-ret-in-mem
27034 @opindex mvect8-ret-in-mem
27035 Return 8-byte vectors in memory instead of MMX registers.  This is the
27036 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
27037 Studio compilers until version 12.  Later compiler versions (starting
27038 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
27039 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
27040 you need to remain compatible with existing code produced by those
27041 previous compiler versions or older versions of GCC@.
27043 @item -mpc32
27044 @itemx -mpc64
27045 @itemx -mpc80
27046 @opindex mpc32
27047 @opindex mpc64
27048 @opindex mpc80
27050 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
27051 is specified, the significands of results of floating-point operations are
27052 rounded to 24 bits (single precision); @option{-mpc64} rounds the
27053 significands of results of floating-point operations to 53 bits (double
27054 precision) and @option{-mpc80} rounds the significands of results of
27055 floating-point operations to 64 bits (extended double precision), which is
27056 the default.  When this option is used, floating-point operations in higher
27057 precisions are not available to the programmer without setting the FPU
27058 control word explicitly.
27060 Setting the rounding of floating-point operations to less than the default
27061 80 bits can speed some programs by 2% or more.  Note that some mathematical
27062 libraries assume that extended-precision (80-bit) floating-point operations
27063 are enabled by default; routines in such libraries could suffer significant
27064 loss of accuracy, typically through so-called ``catastrophic cancellation'',
27065 when this option is used to set the precision to less than extended precision.
27067 @item -mstackrealign
27068 @opindex mstackrealign
27069 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
27070 option generates an alternate prologue and epilogue that realigns the
27071 run-time stack if necessary.  This supports mixing legacy codes that keep
27072 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
27073 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
27074 applicable to individual functions.
27076 @item -mpreferred-stack-boundary=@var{num}
27077 @opindex mpreferred-stack-boundary
27078 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
27079 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
27080 the default is 4 (16 bytes or 128 bits).
27082 @strong{Warning:} When generating code for the x86-64 architecture with
27083 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
27084 used to keep the stack boundary aligned to 8 byte boundary.  Since
27085 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
27086 intended to be used in controlled environment where stack space is
27087 important limitation.  This option leads to wrong code when functions
27088 compiled with 16 byte stack alignment (such as functions from a standard
27089 library) are called with misaligned stack.  In this case, SSE
27090 instructions may lead to misaligned memory access traps.  In addition,
27091 variable arguments are handled incorrectly for 16 byte aligned
27092 objects (including x87 long double and __int128), leading to wrong
27093 results.  You must build all modules with
27094 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
27095 includes the system libraries and startup modules.
27097 @item -mincoming-stack-boundary=@var{num}
27098 @opindex mincoming-stack-boundary
27099 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
27100 boundary.  If @option{-mincoming-stack-boundary} is not specified,
27101 the one specified by @option{-mpreferred-stack-boundary} is used.
27103 On Pentium and Pentium Pro, @code{double} and @code{long double} values
27104 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
27105 suffer significant run time performance penalties.  On Pentium III, the
27106 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
27107 properly if it is not 16-byte aligned.
27109 To ensure proper alignment of this values on the stack, the stack boundary
27110 must be as aligned as that required by any value stored on the stack.
27111 Further, every function must be generated such that it keeps the stack
27112 aligned.  Thus calling a function compiled with a higher preferred
27113 stack boundary from a function compiled with a lower preferred stack
27114 boundary most likely misaligns the stack.  It is recommended that
27115 libraries that use callbacks always use the default setting.
27117 This extra alignment does consume extra stack space, and generally
27118 increases code size.  Code that is sensitive to stack space usage, such
27119 as embedded systems and operating system kernels, may want to reduce the
27120 preferred alignment to @option{-mpreferred-stack-boundary=2}.
27122 @need 200
27123 @item -mmmx
27124 @opindex mmmx
27125 @need 200
27126 @itemx -msse
27127 @opindex msse
27128 @need 200
27129 @itemx -msse2
27130 @opindex msse2
27131 @need 200
27132 @itemx -msse3
27133 @opindex msse3
27134 @need 200
27135 @itemx -mssse3
27136 @opindex mssse3
27137 @need 200
27138 @itemx -msse4
27139 @opindex msse4
27140 @need 200
27141 @itemx -msse4a
27142 @opindex msse4a
27143 @need 200
27144 @itemx -msse4.1
27145 @opindex msse4.1
27146 @need 200
27147 @itemx -msse4.2
27148 @opindex msse4.2
27149 @need 200
27150 @itemx -mavx
27151 @opindex mavx
27152 @need 200
27153 @itemx -mavx2
27154 @opindex mavx2
27155 @need 200
27156 @itemx -mavx512f
27157 @opindex mavx512f
27158 @need 200
27159 @itemx -mavx512pf
27160 @opindex mavx512pf
27161 @need 200
27162 @itemx -mavx512er
27163 @opindex mavx512er
27164 @need 200
27165 @itemx -mavx512cd
27166 @opindex mavx512cd
27167 @need 200
27168 @itemx -mavx512vl
27169 @opindex mavx512vl
27170 @need 200
27171 @itemx -mavx512bw
27172 @opindex mavx512bw
27173 @need 200
27174 @itemx -mavx512dq
27175 @opindex mavx512dq
27176 @need 200
27177 @itemx -mavx512ifma
27178 @opindex mavx512ifma
27179 @need 200
27180 @itemx -mavx512vbmi
27181 @opindex mavx512vbmi
27182 @need 200
27183 @itemx -msha
27184 @opindex msha
27185 @need 200
27186 @itemx -maes
27187 @opindex maes
27188 @need 200
27189 @itemx -mpclmul
27190 @opindex mpclmul
27191 @need 200
27192 @itemx -mclflushopt
27193 @opindex mclflushopt
27194 @need 200
27195 @itemx -mfsgsbase
27196 @opindex mfsgsbase
27197 @need 200
27198 @itemx -mrdrnd
27199 @opindex mrdrnd
27200 @need 200
27201 @itemx -mf16c
27202 @opindex mf16c
27203 @need 200
27204 @itemx -mfma
27205 @opindex mfma
27206 @need 200
27207 @itemx -mpconfig
27208 @opindex mpconfig
27209 @need 200
27210 @itemx -mwbnoinvd
27211 @opindex mwbnoinvd
27212 @need 200
27213 @itemx -mfma4
27214 @opindex mfma4
27215 @need 200
27216 @itemx -mprefetchwt1
27217 @opindex mprefetchwt1
27218 @need 200
27219 @itemx -mxop
27220 @opindex mxop
27221 @need 200
27222 @itemx -mlwp
27223 @opindex mlwp
27224 @need 200
27225 @itemx -m3dnow
27226 @opindex m3dnow
27227 @need 200
27228 @itemx -m3dnowa
27229 @opindex m3dnowa
27230 @need 200
27231 @itemx -mpopcnt
27232 @opindex mpopcnt
27233 @need 200
27234 @itemx -mabm
27235 @opindex mabm
27236 @need 200
27237 @itemx -mbmi
27238 @opindex mbmi
27239 @need 200
27240 @itemx -mbmi2
27241 @need 200
27242 @itemx -mlzcnt
27243 @opindex mlzcnt
27244 @need 200
27245 @itemx -mfxsr
27246 @opindex mfxsr
27247 @need 200
27248 @itemx -mxsave
27249 @opindex mxsave
27250 @need 200
27251 @itemx -mxsaveopt
27252 @opindex mxsaveopt
27253 @need 200
27254 @itemx -mxsavec
27255 @opindex mxsavec
27256 @need 200
27257 @itemx -mxsaves
27258 @opindex mxsaves
27259 @need 200
27260 @itemx -mrtm
27261 @opindex mrtm
27262 @need 200
27263 @itemx -mtbm
27264 @opindex mtbm
27265 @need 200
27266 @itemx -mmpx
27267 @opindex mmpx
27268 @need 200
27269 @itemx -mmwaitx
27270 @opindex mmwaitx
27271 @need 200
27272 @itemx -mclzero
27273 @opindex mclzero
27274 @need 200
27275 @itemx -mpku
27276 @opindex mpku
27277 @need 200
27278 @itemx -mcet
27279 @opindex mcet
27280 @need 200
27281 @itemx -mavx512vbmi2
27282 @opindex mavx512vbmi2
27283 @need 200
27284 @itemx -mgfni
27285 @opindex mgfni
27286 @need 200
27287 @itemx -mvaes
27288 @opindex mvaes
27289 @need 200
27290 @itemx -mvpclmulqdq
27291 @opindex mvpclmulqdq
27292 @need 200
27293 @itemx -mavx512bitalg
27294 @opindex mavx512bitalg
27295 @need 200
27296 @itemx -mavx512vpopcntdq
27297 @opindex mavx512vpopcntdq
27298 These switches enable the use of instructions in the MMX, SSE,
27299 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
27300 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
27301 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES,
27302 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
27303 GFNI, VPCLMULQDQ, AVX512BITALG, AVX512VPOPCNTDQ3DNow!@: or enhanced 3DNow!@:
27304 extended instruction sets.
27305 Each has a corresponding @option{-mno-} option to disable use of these
27306 instructions.
27308 These extensions are also available as built-in functions: see
27309 @ref{x86 Built-in Functions}, for details of the functions enabled and
27310 disabled by these switches.
27312 To generate SSE/SSE2 instructions automatically from floating-point
27313 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
27315 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
27316 generates new AVX instructions or AVX equivalence for all SSEx instructions
27317 when needed.
27319 These options enable GCC to use these extended instructions in
27320 generated code, even without @option{-mfpmath=sse}.  Applications that
27321 perform run-time CPU detection must compile separate files for each
27322 supported architecture, using the appropriate flags.  In particular,
27323 the file containing the CPU detection code should be compiled without
27324 these options.
27326 The @option{-mcet} option turns on the @option{-mibt} and @option{-mshstk}
27327 options.  The @option{-mibt} option enables indirect branch tracking support
27328 and the @option{-mshstk} option enables shadow stack support from
27329 Intel Control-flow Enforcement Technology (CET).  The compiler also provides
27330 a number of built-in functions for fine-grained control in a CET-based
27331 application.  See @xref{x86 Built-in Functions}, for more information.
27333 @item -mdump-tune-features
27334 @opindex mdump-tune-features
27335 This option instructs GCC to dump the names of the x86 performance 
27336 tuning features and default settings. The names can be used in 
27337 @option{-mtune-ctrl=@var{feature-list}}.
27339 @item -mtune-ctrl=@var{feature-list}
27340 @opindex mtune-ctrl=@var{feature-list}
27341 This option is used to do fine grain control of x86 code generation features.
27342 @var{feature-list} is a comma separated list of @var{feature} names. See also
27343 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
27344 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
27345 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
27346 developers. Using it may lead to code paths not covered by testing and can
27347 potentially result in compiler ICEs or runtime errors.
27349 @item -mno-default
27350 @opindex mno-default
27351 This option instructs GCC to turn off all tunable features. See also 
27352 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
27354 @item -mcld
27355 @opindex mcld
27356 This option instructs GCC to emit a @code{cld} instruction in the prologue
27357 of functions that use string instructions.  String instructions depend on
27358 the DF flag to select between autoincrement or autodecrement mode.  While the
27359 ABI specifies the DF flag to be cleared on function entry, some operating
27360 systems violate this specification by not clearing the DF flag in their
27361 exception dispatchers.  The exception handler can be invoked with the DF flag
27362 set, which leads to wrong direction mode when string instructions are used.
27363 This option can be enabled by default on 32-bit x86 targets by configuring
27364 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
27365 instructions can be suppressed with the @option{-mno-cld} compiler option
27366 in this case.
27368 @item -mvzeroupper
27369 @opindex mvzeroupper
27370 This option instructs GCC to emit a @code{vzeroupper} instruction
27371 before a transfer of control flow out of the function to minimize
27372 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
27373 intrinsics.
27375 @item -mprefer-avx128
27376 @opindex mprefer-avx128
27377 This option instructs GCC to use 128-bit AVX instructions instead of
27378 256-bit AVX instructions in the auto-vectorizer.
27380 @item -mprefer-vector-width=@var{opt}
27381 @opindex mprefer-vector-width
27382 This option instructs GCC to use @var{opt}-bit vector width in instructions
27383 instead of default on the selected platform.
27385 @table @samp
27386 @item none
27387 No extra limitations applied to GCC other than defined by the selected platform.
27389 @item 128
27390 Prefer 128-bit vector width for instructions.
27392 @item 256
27393 Prefer 256-bit vector width for instructions.
27395 @item 512
27396 Prefer 512-bit vector width for instructions.
27397 @end table
27399 @item -mcx16
27400 @opindex mcx16
27401 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
27402 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
27403 objects.  This is useful for atomic updates of data structures exceeding one
27404 machine word in size.  The compiler uses this instruction to implement
27405 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
27406 128-bit integers, a library call is always used.
27408 @item -msahf
27409 @opindex msahf
27410 This option enables generation of @code{SAHF} instructions in 64-bit code.
27411 Early Intel Pentium 4 CPUs with Intel 64 support,
27412 prior to the introduction of Pentium 4 G1 step in December 2005,
27413 lacked the @code{LAHF} and @code{SAHF} instructions
27414 which are supported by AMD64.
27415 These are load and store instructions, respectively, for certain status flags.
27416 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
27417 @code{drem}, and @code{remainder} built-in functions;
27418 see @ref{Other Builtins} for details.
27420 @item -mmovbe
27421 @opindex mmovbe
27422 This option enables use of the @code{movbe} instruction to implement
27423 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
27425 @item -mibt
27426 @opindex mibt
27427 This option tells the compiler to use indirect branch tracking support
27428 (for indirect calls and jumps) from x86 Control-flow Enforcement
27429 Technology (CET).  The option has effect only if the
27430 @option{-fcf-protection=full} or @option{-fcf-protection=branch} option
27431 is specified. The option @option{-mibt} is on by default when the
27432 @code{-mcet} option is specified.
27434 @item -mshstk
27435 @opindex mshstk
27436 This option tells the compiler to use shadow stack support (return
27437 address tracking) from x86 Control-flow Enforcement Technology (CET).
27438 The option has effect only if the @option{-fcf-protection=full} or
27439 @option{-fcf-protection=return} option is specified.  The option
27440 @option{-mshstk} is on by default when the @option{-mcet} option is
27441 specified.
27443 @item -mcrc32
27444 @opindex mcrc32
27445 This option enables built-in functions @code{__builtin_ia32_crc32qi},
27446 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
27447 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
27449 @item -mrecip
27450 @opindex mrecip
27451 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
27452 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
27453 with an additional Newton-Raphson step
27454 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
27455 (and their vectorized
27456 variants) for single-precision floating-point arguments.  These instructions
27457 are generated only when @option{-funsafe-math-optimizations} is enabled
27458 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
27459 Note that while the throughput of the sequence is higher than the throughput
27460 of the non-reciprocal instruction, the precision of the sequence can be
27461 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
27463 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
27464 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
27465 combination), and doesn't need @option{-mrecip}.
27467 Also note that GCC emits the above sequence with additional Newton-Raphson step
27468 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
27469 already with @option{-ffast-math} (or the above option combination), and
27470 doesn't need @option{-mrecip}.
27472 @item -mrecip=@var{opt}
27473 @opindex mrecip=opt
27474 This option controls which reciprocal estimate instructions
27475 may be used.  @var{opt} is a comma-separated list of options, which may
27476 be preceded by a @samp{!} to invert the option:
27478 @table @samp
27479 @item all
27480 Enable all estimate instructions.
27482 @item default
27483 Enable the default instructions, equivalent to @option{-mrecip}.
27485 @item none
27486 Disable all estimate instructions, equivalent to @option{-mno-recip}.
27488 @item div
27489 Enable the approximation for scalar division.
27491 @item vec-div
27492 Enable the approximation for vectorized division.
27494 @item sqrt
27495 Enable the approximation for scalar square root.
27497 @item vec-sqrt
27498 Enable the approximation for vectorized square root.
27499 @end table
27501 So, for example, @option{-mrecip=all,!sqrt} enables
27502 all of the reciprocal approximations, except for square root.
27504 @item -mveclibabi=@var{type}
27505 @opindex mveclibabi
27506 Specifies the ABI type to use for vectorizing intrinsics using an
27507 external library.  Supported values for @var{type} are @samp{svml} 
27508 for the Intel short
27509 vector math library and @samp{acml} for the AMD math core library.
27510 To use this option, both @option{-ftree-vectorize} and
27511 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
27512 ABI-compatible library must be specified at link time.
27514 GCC currently emits calls to @code{vmldExp2},
27515 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
27516 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
27517 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
27518 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
27519 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
27520 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
27521 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
27522 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
27523 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
27524 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
27525 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
27526 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
27527 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
27528 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
27529 when @option{-mveclibabi=acml} is used.  
27531 @item -mabi=@var{name}
27532 @opindex mabi
27533 Generate code for the specified calling convention.  Permissible values
27534 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
27535 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
27536 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
27537 You can control this behavior for specific functions by
27538 using the function attributes @code{ms_abi} and @code{sysv_abi}.
27539 @xref{Function Attributes}.
27541 @item -mforce-indirect-call
27542 @opindex mforce-indirect-call
27543 Force all calls to functions to be indirect. This is useful
27544 when using Intel Processor Trace where it generates more precise timing
27545 information for function calls.
27547 @item -mcall-ms2sysv-xlogues
27548 @opindex mcall-ms2sysv-xlogues
27549 @opindex mno-call-ms2sysv-xlogues
27550 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
27551 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
27552 default, the code for saving and restoring these registers is emitted inline,
27553 resulting in fairly lengthy prologues and epilogues.  Using
27554 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
27555 use stubs in the static portion of libgcc to perform these saves and restores,
27556 thus reducing function size at the cost of a few extra instructions.
27558 @item -mtls-dialect=@var{type}
27559 @opindex mtls-dialect
27560 Generate code to access thread-local storage using the @samp{gnu} or
27561 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
27562 @samp{gnu2} is more efficient, but it may add compile- and run-time
27563 requirements that cannot be satisfied on all systems.
27565 @item -mpush-args
27566 @itemx -mno-push-args
27567 @opindex mpush-args
27568 @opindex mno-push-args
27569 Use PUSH operations to store outgoing parameters.  This method is shorter
27570 and usually equally fast as method using SUB/MOV operations and is enabled
27571 by default.  In some cases disabling it may improve performance because of
27572 improved scheduling and reduced dependencies.
27574 @item -maccumulate-outgoing-args
27575 @opindex maccumulate-outgoing-args
27576 If enabled, the maximum amount of space required for outgoing arguments is
27577 computed in the function prologue.  This is faster on most modern CPUs
27578 because of reduced dependencies, improved scheduling and reduced stack usage
27579 when the preferred stack boundary is not equal to 2.  The drawback is a notable
27580 increase in code size.  This switch implies @option{-mno-push-args}.
27582 @item -mthreads
27583 @opindex mthreads
27584 Support thread-safe exception handling on MinGW.  Programs that rely
27585 on thread-safe exception handling must compile and link all code with the
27586 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
27587 @option{-D_MT}; when linking, it links in a special thread helper library
27588 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
27590 @item -mms-bitfields
27591 @itemx -mno-ms-bitfields
27592 @opindex mms-bitfields
27593 @opindex mno-ms-bitfields
27595 Enable/disable bit-field layout compatible with the native Microsoft
27596 Windows compiler.  
27598 If @code{packed} is used on a structure, or if bit-fields are used,
27599 it may be that the Microsoft ABI lays out the structure differently
27600 than the way GCC normally does.  Particularly when moving packed
27601 data between functions compiled with GCC and the native Microsoft compiler
27602 (either via function call or as data in a file), it may be necessary to access
27603 either format.
27605 This option is enabled by default for Microsoft Windows
27606 targets.  This behavior can also be controlled locally by use of variable
27607 or type attributes.  For more information, see @ref{x86 Variable Attributes}
27608 and @ref{x86 Type Attributes}.
27610 The Microsoft structure layout algorithm is fairly simple with the exception
27611 of the bit-field packing.  
27612 The padding and alignment of members of structures and whether a bit-field 
27613 can straddle a storage-unit boundary are determine by these rules:
27615 @enumerate
27616 @item Structure members are stored sequentially in the order in which they are
27617 declared: the first member has the lowest memory address and the last member
27618 the highest.
27620 @item Every data object has an alignment requirement.  The alignment requirement
27621 for all data except structures, unions, and arrays is either the size of the
27622 object or the current packing size (specified with either the
27623 @code{aligned} attribute or the @code{pack} pragma),
27624 whichever is less.  For structures, unions, and arrays,
27625 the alignment requirement is the largest alignment requirement of its members.
27626 Every object is allocated an offset so that:
27628 @smallexample
27629 offset % alignment_requirement == 0
27630 @end smallexample
27632 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
27633 unit if the integral types are the same size and if the next bit-field fits
27634 into the current allocation unit without crossing the boundary imposed by the
27635 common alignment requirements of the bit-fields.
27636 @end enumerate
27638 MSVC interprets zero-length bit-fields in the following ways:
27640 @enumerate
27641 @item If a zero-length bit-field is inserted between two bit-fields that
27642 are normally coalesced, the bit-fields are not coalesced.
27644 For example:
27646 @smallexample
27647 struct
27648  @{
27649    unsigned long bf_1 : 12;
27650    unsigned long : 0;
27651    unsigned long bf_2 : 12;
27652  @} t1;
27653 @end smallexample
27655 @noindent
27656 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
27657 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
27659 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
27660 alignment of the zero-length bit-field is greater than the member that follows it,
27661 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
27663 For example:
27665 @smallexample
27666 struct
27667  @{
27668    char foo : 4;
27669    short : 0;
27670    char bar;
27671  @} t2;
27673 struct
27674  @{
27675    char foo : 4;
27676    short : 0;
27677    double bar;
27678  @} t3;
27679 @end smallexample
27681 @noindent
27682 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
27683 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
27684 bit-field does not affect the alignment of @code{bar} or, as a result, the size
27685 of the structure.
27687 Taking this into account, it is important to note the following:
27689 @enumerate
27690 @item If a zero-length bit-field follows a normal bit-field, the type of the
27691 zero-length bit-field may affect the alignment of the structure as whole. For
27692 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
27693 normal bit-field, and is of type short.
27695 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
27696 still affect the alignment of the structure:
27698 @smallexample
27699 struct
27700  @{
27701    char foo : 6;
27702    long : 0;
27703  @} t4;
27704 @end smallexample
27706 @noindent
27707 Here, @code{t4} takes up 4 bytes.
27708 @end enumerate
27710 @item Zero-length bit-fields following non-bit-field members are ignored:
27712 @smallexample
27713 struct
27714  @{
27715    char foo;
27716    long : 0;
27717    char bar;
27718  @} t5;
27719 @end smallexample
27721 @noindent
27722 Here, @code{t5} takes up 2 bytes.
27723 @end enumerate
27726 @item -mno-align-stringops
27727 @opindex mno-align-stringops
27728 Do not align the destination of inlined string operations.  This switch reduces
27729 code size and improves performance in case the destination is already aligned,
27730 but GCC doesn't know about it.
27732 @item -minline-all-stringops
27733 @opindex minline-all-stringops
27734 By default GCC inlines string operations only when the destination is 
27735 known to be aligned to least a 4-byte boundary.  
27736 This enables more inlining and increases code
27737 size, but may improve performance of code that depends on fast
27738 @code{memcpy}, @code{strlen},
27739 and @code{memset} for short lengths.
27741 @item -minline-stringops-dynamically
27742 @opindex minline-stringops-dynamically
27743 For string operations of unknown size, use run-time checks with
27744 inline code for small blocks and a library call for large blocks.
27746 @item -mstringop-strategy=@var{alg}
27747 @opindex mstringop-strategy=@var{alg}
27748 Override the internal decision heuristic for the particular algorithm to use
27749 for inlining string operations.  The allowed values for @var{alg} are:
27751 @table @samp
27752 @item rep_byte
27753 @itemx rep_4byte
27754 @itemx rep_8byte
27755 Expand using i386 @code{rep} prefix of the specified size.
27757 @item byte_loop
27758 @itemx loop
27759 @itemx unrolled_loop
27760 Expand into an inline loop.
27762 @item libcall
27763 Always use a library call.
27764 @end table
27766 @item -mmemcpy-strategy=@var{strategy}
27767 @opindex mmemcpy-strategy=@var{strategy}
27768 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
27769 should be inlined and what inline algorithm to use when the expected size
27770 of the copy operation is known. @var{strategy} 
27771 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
27772 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
27773 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
27774 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
27775 in the list must be specified in increasing order.  The minimal byte size for 
27776 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
27777 preceding range.
27779 @item -mmemset-strategy=@var{strategy}
27780 @opindex mmemset-strategy=@var{strategy}
27781 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
27782 @code{__builtin_memset} expansion.
27784 @item -momit-leaf-frame-pointer
27785 @opindex momit-leaf-frame-pointer
27786 Don't keep the frame pointer in a register for leaf functions.  This
27787 avoids the instructions to save, set up, and restore frame pointers and
27788 makes an extra register available in leaf functions.  The option
27789 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
27790 which might make debugging harder.
27792 @item -mtls-direct-seg-refs
27793 @itemx -mno-tls-direct-seg-refs
27794 @opindex mtls-direct-seg-refs
27795 Controls whether TLS variables may be accessed with offsets from the
27796 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
27797 or whether the thread base pointer must be added.  Whether or not this
27798 is valid depends on the operating system, and whether it maps the
27799 segment to cover the entire TLS area.
27801 For systems that use the GNU C Library, the default is on.
27803 @item -msse2avx
27804 @itemx -mno-sse2avx
27805 @opindex msse2avx
27806 Specify that the assembler should encode SSE instructions with VEX
27807 prefix.  The option @option{-mavx} turns this on by default.
27809 @item -mfentry
27810 @itemx -mno-fentry
27811 @opindex mfentry
27812 If profiling is active (@option{-pg}), put the profiling
27813 counter call before the prologue.
27814 Note: On x86 architectures the attribute @code{ms_hook_prologue}
27815 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
27817 @item -mrecord-mcount
27818 @itemx -mno-record-mcount
27819 @opindex mrecord-mcount
27820 If profiling is active (@option{-pg}), generate a __mcount_loc section
27821 that contains pointers to each profiling call. This is useful for
27822 automatically patching and out calls.
27824 @item -mnop-mcount
27825 @itemx -mno-nop-mcount
27826 @opindex mnop-mcount
27827 If profiling is active (@option{-pg}), generate the calls to
27828 the profiling functions as NOPs. This is useful when they
27829 should be patched in later dynamically. This is likely only
27830 useful together with @option{-mrecord-mcount}.
27832 @item -mskip-rax-setup
27833 @itemx -mno-skip-rax-setup
27834 @opindex mskip-rax-setup
27835 When generating code for the x86-64 architecture with SSE extensions
27836 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
27837 register when there are no variable arguments passed in vector registers.
27839 @strong{Warning:} Since RAX register is used to avoid unnecessarily
27840 saving vector registers on stack when passing variable arguments, the
27841 impacts of this option are callees may waste some stack space,
27842 misbehave or jump to a random location.  GCC 4.4 or newer don't have
27843 those issues, regardless the RAX register value.
27845 @item -m8bit-idiv
27846 @itemx -mno-8bit-idiv
27847 @opindex m8bit-idiv
27848 On some processors, like Intel Atom, 8-bit unsigned integer divide is
27849 much faster than 32-bit/64-bit integer divide.  This option generates a
27850 run-time check.  If both dividend and divisor are within range of 0
27851 to 255, 8-bit unsigned integer divide is used instead of
27852 32-bit/64-bit integer divide.
27854 @item -mavx256-split-unaligned-load
27855 @itemx -mavx256-split-unaligned-store
27856 @opindex mavx256-split-unaligned-load
27857 @opindex mavx256-split-unaligned-store
27858 Split 32-byte AVX unaligned load and store.
27860 @item -mstack-protector-guard=@var{guard}
27861 @itemx -mstack-protector-guard-reg=@var{reg}
27862 @itemx -mstack-protector-guard-offset=@var{offset}
27863 @opindex mstack-protector-guard
27864 @opindex mstack-protector-guard-reg
27865 @opindex mstack-protector-guard-offset
27866 Generate stack protection code using canary at @var{guard}.  Supported
27867 locations are @samp{global} for global canary or @samp{tls} for per-thread
27868 canary in the TLS block (the default).  This option has effect only when
27869 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
27871 With the latter choice the options
27872 @option{-mstack-protector-guard-reg=@var{reg}} and
27873 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
27874 which segment register (@code{%fs} or @code{%gs}) to use as base register
27875 for reading the canary, and from what offset from that base register.
27876 The default for those is as specified in the relevant ABI.
27878 @item -mmitigate-rop
27879 @opindex mmitigate-rop
27880 Try to avoid generating code sequences that contain unintended return
27881 opcodes, to mitigate against certain forms of attack. At the moment,
27882 this option is limited in what it can do and should not be relied
27883 on to provide serious protection.
27885 @item -mgeneral-regs-only
27886 @opindex mgeneral-regs-only
27887 Generate code that uses only the general-purpose registers.  This
27888 prevents the compiler from using floating-point, vector, mask and bound
27889 registers.
27891 @item -mindirect-branch=@var{choice}
27892 @opindex -mindirect-branch
27893 Convert indirect call and jump with @var{choice}.  The default is
27894 @samp{keep}, which keeps indirect call and jump unmodified.
27895 @samp{thunk} converts indirect call and jump to call and return thunk.
27896 @samp{thunk-inline} converts indirect call and jump to inlined call
27897 and return thunk.  @samp{thunk-extern} converts indirect call and jump
27898 to external call and return thunk provided in a separate object file.
27899 You can control this behavior for a specific function by using the
27900 function attribute @code{indirect_branch}.  @xref{Function Attributes}.
27902 Note that @option{-mcmodel=large} is incompatible with
27903 @option{-mindirect-branch=thunk} and
27904 @option{-mindirect-branch=thunk-extern} since the thunk function may
27905 not be reachable in the large code model.
27907 Note that @option{-mindirect-branch=thunk-extern} is incompatible with
27908 @option{-fcf-protection=branch} and @option{-fcheck-pointer-bounds}
27909 since the external thunk can not be modified to disable control-flow
27910 check.
27912 @item -mfunction-return=@var{choice}
27913 @opindex -mfunction-return
27914 Convert function return with @var{choice}.  The default is @samp{keep},
27915 which keeps function return unmodified.  @samp{thunk} converts function
27916 return to call and return thunk.  @samp{thunk-inline} converts function
27917 return to inlined call and return thunk.  @samp{thunk-extern} converts
27918 function return to external call and return thunk provided in a separate
27919 object file.  You can control this behavior for a specific function by
27920 using the function attribute @code{function_return}.
27921 @xref{Function Attributes}.
27923 Note that @option{-mcmodel=large} is incompatible with
27924 @option{-mfunction-return=thunk} and
27925 @option{-mfunction-return=thunk-extern} since the thunk function may
27926 not be reachable in the large code model.
27929 @item -mindirect-branch-register
27930 @opindex -mindirect-branch-register
27931 Force indirect call and jump via register.
27933 @end table
27935 These @samp{-m} switches are supported in addition to the above
27936 on x86-64 processors in 64-bit environments.
27938 @table @gcctabopt
27939 @item -m32
27940 @itemx -m64
27941 @itemx -mx32
27942 @itemx -m16
27943 @itemx -miamcu
27944 @opindex m32
27945 @opindex m64
27946 @opindex mx32
27947 @opindex m16
27948 @opindex miamcu
27949 Generate code for a 16-bit, 32-bit or 64-bit environment.
27950 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
27951 to 32 bits, and
27952 generates code that runs on any i386 system.
27954 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
27955 types to 64 bits, and generates code for the x86-64 architecture.
27956 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
27957 and @option{-mdynamic-no-pic} options.
27959 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
27960 to 32 bits, and
27961 generates code for the x86-64 architecture.
27963 The @option{-m16} option is the same as @option{-m32}, except for that
27964 it outputs the @code{.code16gcc} assembly directive at the beginning of
27965 the assembly output so that the binary can run in 16-bit mode.
27967 The @option{-miamcu} option generates code which conforms to Intel MCU
27968 psABI.  It requires the @option{-m32} option to be turned on.
27970 @item -mno-red-zone
27971 @opindex mno-red-zone
27972 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
27973 by the x86-64 ABI; it is a 128-byte area beyond the location of the
27974 stack pointer that is not modified by signal or interrupt handlers
27975 and therefore can be used for temporary data without adjusting the stack
27976 pointer.  The flag @option{-mno-red-zone} disables this red zone.
27978 @item -mcmodel=small
27979 @opindex mcmodel=small
27980 Generate code for the small code model: the program and its symbols must
27981 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
27982 Programs can be statically or dynamically linked.  This is the default
27983 code model.
27985 @item -mcmodel=kernel
27986 @opindex mcmodel=kernel
27987 Generate code for the kernel code model.  The kernel runs in the
27988 negative 2 GB of the address space.
27989 This model has to be used for Linux kernel code.
27991 @item -mcmodel=medium
27992 @opindex mcmodel=medium
27993 Generate code for the medium model: the program is linked in the lower 2
27994 GB of the address space.  Small symbols are also placed there.  Symbols
27995 with sizes larger than @option{-mlarge-data-threshold} are put into
27996 large data or BSS sections and can be located above 2GB.  Programs can
27997 be statically or dynamically linked.
27999 @item -mcmodel=large
28000 @opindex mcmodel=large
28001 Generate code for the large model.  This model makes no assumptions
28002 about addresses and sizes of sections.
28004 @item -maddress-mode=long
28005 @opindex maddress-mode=long
28006 Generate code for long address mode.  This is only supported for 64-bit
28007 and x32 environments.  It is the default address mode for 64-bit
28008 environments.
28010 @item -maddress-mode=short
28011 @opindex maddress-mode=short
28012 Generate code for short address mode.  This is only supported for 32-bit
28013 and x32 environments.  It is the default address mode for 32-bit and
28014 x32 environments.
28015 @end table
28017 @node x86 Windows Options
28018 @subsection x86 Windows Options
28019 @cindex x86 Windows Options
28020 @cindex Windows Options for x86
28022 These additional options are available for Microsoft Windows targets:
28024 @table @gcctabopt
28025 @item -mconsole
28026 @opindex mconsole
28027 This option
28028 specifies that a console application is to be generated, by
28029 instructing the linker to set the PE header subsystem type
28030 required for console applications.
28031 This option is available for Cygwin and MinGW targets and is
28032 enabled by default on those targets.
28034 @item -mdll
28035 @opindex mdll
28036 This option is available for Cygwin and MinGW targets.  It
28037 specifies that a DLL---a dynamic link library---is to be
28038 generated, enabling the selection of the required runtime
28039 startup object and entry point.
28041 @item -mnop-fun-dllimport
28042 @opindex mnop-fun-dllimport
28043 This option is available for Cygwin and MinGW targets.  It
28044 specifies that the @code{dllimport} attribute should be ignored.
28046 @item -mthread
28047 @opindex mthread
28048 This option is available for MinGW targets. It specifies
28049 that MinGW-specific thread support is to be used.
28051 @item -municode
28052 @opindex municode
28053 This option is available for MinGW-w64 targets.  It causes
28054 the @code{UNICODE} preprocessor macro to be predefined, and
28055 chooses Unicode-capable runtime startup code.
28057 @item -mwin32
28058 @opindex mwin32
28059 This option is available for Cygwin and MinGW targets.  It
28060 specifies that the typical Microsoft Windows predefined macros are to
28061 be set in the pre-processor, but does not influence the choice
28062 of runtime library/startup code.
28064 @item -mwindows
28065 @opindex mwindows
28066 This option is available for Cygwin and MinGW targets.  It
28067 specifies that a GUI application is to be generated by
28068 instructing the linker to set the PE header subsystem type
28069 appropriately.
28071 @item -fno-set-stack-executable
28072 @opindex fno-set-stack-executable
28073 This option is available for MinGW targets. It specifies that
28074 the executable flag for the stack used by nested functions isn't
28075 set. This is necessary for binaries running in kernel mode of
28076 Microsoft Windows, as there the User32 API, which is used to set executable
28077 privileges, isn't available.
28079 @item -fwritable-relocated-rdata
28080 @opindex fno-writable-relocated-rdata
28081 This option is available for MinGW and Cygwin targets.  It specifies
28082 that relocated-data in read-only section is put into the @code{.data}
28083 section.  This is a necessary for older runtimes not supporting
28084 modification of @code{.rdata} sections for pseudo-relocation.
28086 @item -mpe-aligned-commons
28087 @opindex mpe-aligned-commons
28088 This option is available for Cygwin and MinGW targets.  It
28089 specifies that the GNU extension to the PE file format that
28090 permits the correct alignment of COMMON variables should be
28091 used when generating code.  It is enabled by default if
28092 GCC detects that the target assembler found during configuration
28093 supports the feature.
28094 @end table
28096 See also under @ref{x86 Options} for standard options.
28098 @node Xstormy16 Options
28099 @subsection Xstormy16 Options
28100 @cindex Xstormy16 Options
28102 These options are defined for Xstormy16:
28104 @table @gcctabopt
28105 @item -msim
28106 @opindex msim
28107 Choose startup files and linker script suitable for the simulator.
28108 @end table
28110 @node Xtensa Options
28111 @subsection Xtensa Options
28112 @cindex Xtensa Options
28114 These options are supported for Xtensa targets:
28116 @table @gcctabopt
28117 @item -mconst16
28118 @itemx -mno-const16
28119 @opindex mconst16
28120 @opindex mno-const16
28121 Enable or disable use of @code{CONST16} instructions for loading
28122 constant values.  The @code{CONST16} instruction is currently not a
28123 standard option from Tensilica.  When enabled, @code{CONST16}
28124 instructions are always used in place of the standard @code{L32R}
28125 instructions.  The use of @code{CONST16} is enabled by default only if
28126 the @code{L32R} instruction is not available.
28128 @item -mfused-madd
28129 @itemx -mno-fused-madd
28130 @opindex mfused-madd
28131 @opindex mno-fused-madd
28132 Enable or disable use of fused multiply/add and multiply/subtract
28133 instructions in the floating-point option.  This has no effect if the
28134 floating-point option is not also enabled.  Disabling fused multiply/add
28135 and multiply/subtract instructions forces the compiler to use separate
28136 instructions for the multiply and add/subtract operations.  This may be
28137 desirable in some cases where strict IEEE 754-compliant results are
28138 required: the fused multiply add/subtract instructions do not round the
28139 intermediate result, thereby producing results with @emph{more} bits of
28140 precision than specified by the IEEE standard.  Disabling fused multiply
28141 add/subtract instructions also ensures that the program output is not
28142 sensitive to the compiler's ability to combine multiply and add/subtract
28143 operations.
28145 @item -mserialize-volatile
28146 @itemx -mno-serialize-volatile
28147 @opindex mserialize-volatile
28148 @opindex mno-serialize-volatile
28149 When this option is enabled, GCC inserts @code{MEMW} instructions before
28150 @code{volatile} memory references to guarantee sequential consistency.
28151 The default is @option{-mserialize-volatile}.  Use
28152 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
28154 @item -mforce-no-pic
28155 @opindex mforce-no-pic
28156 For targets, like GNU/Linux, where all user-mode Xtensa code must be
28157 position-independent code (PIC), this option disables PIC for compiling
28158 kernel code.
28160 @item -mtext-section-literals
28161 @itemx -mno-text-section-literals
28162 @opindex mtext-section-literals
28163 @opindex mno-text-section-literals
28164 These options control the treatment of literal pools.  The default is
28165 @option{-mno-text-section-literals}, which places literals in a separate
28166 section in the output file.  This allows the literal pool to be placed
28167 in a data RAM/ROM, and it also allows the linker to combine literal
28168 pools from separate object files to remove redundant literals and
28169 improve code size.  With @option{-mtext-section-literals}, the literals
28170 are interspersed in the text section in order to keep them as close as
28171 possible to their references.  This may be necessary for large assembly
28172 files.  Literals for each function are placed right before that function.
28174 @item -mauto-litpools
28175 @itemx -mno-auto-litpools
28176 @opindex mauto-litpools
28177 @opindex mno-auto-litpools
28178 These options control the treatment of literal pools.  The default is
28179 @option{-mno-auto-litpools}, which places literals in a separate
28180 section in the output file unless @option{-mtext-section-literals} is
28181 used.  With @option{-mauto-litpools} the literals are interspersed in
28182 the text section by the assembler.  Compiler does not produce explicit
28183 @code{.literal} directives and loads literals into registers with
28184 @code{MOVI} instructions instead of @code{L32R} to let the assembler
28185 do relaxation and place literals as necessary.  This option allows
28186 assembler to create several literal pools per function and assemble
28187 very big functions, which may not be possible with
28188 @option{-mtext-section-literals}.
28190 @item -mtarget-align
28191 @itemx -mno-target-align
28192 @opindex mtarget-align
28193 @opindex mno-target-align
28194 When this option is enabled, GCC instructs the assembler to
28195 automatically align instructions to reduce branch penalties at the
28196 expense of some code density.  The assembler attempts to widen density
28197 instructions to align branch targets and the instructions following call
28198 instructions.  If there are not enough preceding safe density
28199 instructions to align a target, no widening is performed.  The
28200 default is @option{-mtarget-align}.  These options do not affect the
28201 treatment of auto-aligned instructions like @code{LOOP}, which the
28202 assembler always aligns, either by widening density instructions or
28203 by inserting NOP instructions.
28205 @item -mlongcalls
28206 @itemx -mno-longcalls
28207 @opindex mlongcalls
28208 @opindex mno-longcalls
28209 When this option is enabled, GCC instructs the assembler to translate
28210 direct calls to indirect calls unless it can determine that the target
28211 of a direct call is in the range allowed by the call instruction.  This
28212 translation typically occurs for calls to functions in other source
28213 files.  Specifically, the assembler translates a direct @code{CALL}
28214 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
28215 The default is @option{-mno-longcalls}.  This option should be used in
28216 programs where the call target can potentially be out of range.  This
28217 option is implemented in the assembler, not the compiler, so the
28218 assembly code generated by GCC still shows direct call
28219 instructions---look at the disassembled object code to see the actual
28220 instructions.  Note that the assembler uses an indirect call for
28221 every cross-file call, not just those that really are out of range.
28222 @end table
28224 @node zSeries Options
28225 @subsection zSeries Options
28226 @cindex zSeries options
28228 These are listed under @xref{S/390 and zSeries Options}.
28231 @c man end
28233 @node Spec Files
28234 @section Specifying Subprocesses and the Switches to Pass to Them
28235 @cindex Spec Files
28237 @command{gcc} is a driver program.  It performs its job by invoking a
28238 sequence of other programs to do the work of compiling, assembling and
28239 linking.  GCC interprets its command-line parameters and uses these to
28240 deduce which programs it should invoke, and which command-line options
28241 it ought to place on their command lines.  This behavior is controlled
28242 by @dfn{spec strings}.  In most cases there is one spec string for each
28243 program that GCC can invoke, but a few programs have multiple spec
28244 strings to control their behavior.  The spec strings built into GCC can
28245 be overridden by using the @option{-specs=} command-line switch to specify
28246 a spec file.
28248 @dfn{Spec files} are plain-text files that are used to construct spec
28249 strings.  They consist of a sequence of directives separated by blank
28250 lines.  The type of directive is determined by the first non-whitespace
28251 character on the line, which can be one of the following:
28253 @table @code
28254 @item %@var{command}
28255 Issues a @var{command} to the spec file processor.  The commands that can
28256 appear here are:
28258 @table @code
28259 @item %include <@var{file}>
28260 @cindex @code{%include}
28261 Search for @var{file} and insert its text at the current point in the
28262 specs file.
28264 @item %include_noerr <@var{file}>
28265 @cindex @code{%include_noerr}
28266 Just like @samp{%include}, but do not generate an error message if the include
28267 file cannot be found.
28269 @item %rename @var{old_name} @var{new_name}
28270 @cindex @code{%rename}
28271 Rename the spec string @var{old_name} to @var{new_name}.
28273 @end table
28275 @item *[@var{spec_name}]:
28276 This tells the compiler to create, override or delete the named spec
28277 string.  All lines after this directive up to the next directive or
28278 blank line are considered to be the text for the spec string.  If this
28279 results in an empty string then the spec is deleted.  (Or, if the
28280 spec did not exist, then nothing happens.)  Otherwise, if the spec
28281 does not currently exist a new spec is created.  If the spec does
28282 exist then its contents are overridden by the text of this
28283 directive, unless the first character of that text is the @samp{+}
28284 character, in which case the text is appended to the spec.
28286 @item [@var{suffix}]:
28287 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
28288 and up to the next directive or blank line are considered to make up the
28289 spec string for the indicated suffix.  When the compiler encounters an
28290 input file with the named suffix, it processes the spec string in
28291 order to work out how to compile that file.  For example:
28293 @smallexample
28294 .ZZ:
28295 z-compile -input %i
28296 @end smallexample
28298 This says that any input file whose name ends in @samp{.ZZ} should be
28299 passed to the program @samp{z-compile}, which should be invoked with the
28300 command-line switch @option{-input} and with the result of performing the
28301 @samp{%i} substitution.  (See below.)
28303 As an alternative to providing a spec string, the text following a
28304 suffix directive can be one of the following:
28306 @table @code
28307 @item @@@var{language}
28308 This says that the suffix is an alias for a known @var{language}.  This is
28309 similar to using the @option{-x} command-line switch to GCC to specify a
28310 language explicitly.  For example:
28312 @smallexample
28313 .ZZ:
28314 @@c++
28315 @end smallexample
28317 Says that .ZZ files are, in fact, C++ source files.
28319 @item #@var{name}
28320 This causes an error messages saying:
28322 @smallexample
28323 @var{name} compiler not installed on this system.
28324 @end smallexample
28325 @end table
28327 GCC already has an extensive list of suffixes built into it.
28328 This directive adds an entry to the end of the list of suffixes, but
28329 since the list is searched from the end backwards, it is effectively
28330 possible to override earlier entries using this technique.
28332 @end table
28334 GCC has the following spec strings built into it.  Spec files can
28335 override these strings or create their own.  Note that individual
28336 targets can also add their own spec strings to this list.
28338 @smallexample
28339 asm          Options to pass to the assembler
28340 asm_final    Options to pass to the assembler post-processor
28341 cpp          Options to pass to the C preprocessor
28342 cc1          Options to pass to the C compiler
28343 cc1plus      Options to pass to the C++ compiler
28344 endfile      Object files to include at the end of the link
28345 link         Options to pass to the linker
28346 lib          Libraries to include on the command line to the linker
28347 libgcc       Decides which GCC support library to pass to the linker
28348 linker       Sets the name of the linker
28349 predefines   Defines to be passed to the C preprocessor
28350 signed_char  Defines to pass to CPP to say whether @code{char} is signed
28351              by default
28352 startfile    Object files to include at the start of the link
28353 @end smallexample
28355 Here is a small example of a spec file:
28357 @smallexample
28358 %rename lib                 old_lib
28360 *lib:
28361 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
28362 @end smallexample
28364 This example renames the spec called @samp{lib} to @samp{old_lib} and
28365 then overrides the previous definition of @samp{lib} with a new one.
28366 The new definition adds in some extra command-line options before
28367 including the text of the old definition.
28369 @dfn{Spec strings} are a list of command-line options to be passed to their
28370 corresponding program.  In addition, the spec strings can contain
28371 @samp{%}-prefixed sequences to substitute variable text or to
28372 conditionally insert text into the command line.  Using these constructs
28373 it is possible to generate quite complex command lines.
28375 Here is a table of all defined @samp{%}-sequences for spec
28376 strings.  Note that spaces are not generated automatically around the
28377 results of expanding these sequences.  Therefore you can concatenate them
28378 together or combine them with constant text in a single argument.
28380 @table @code
28381 @item %%
28382 Substitute one @samp{%} into the program name or argument.
28384 @item %i
28385 Substitute the name of the input file being processed.
28387 @item %b
28388 Substitute the basename of the input file being processed.
28389 This is the substring up to (and not including) the last period
28390 and not including the directory.
28392 @item %B
28393 This is the same as @samp{%b}, but include the file suffix (text after
28394 the last period).
28396 @item %d
28397 Marks the argument containing or following the @samp{%d} as a
28398 temporary file name, so that that file is deleted if GCC exits
28399 successfully.  Unlike @samp{%g}, this contributes no text to the
28400 argument.
28402 @item %g@var{suffix}
28403 Substitute a file name that has suffix @var{suffix} and is chosen
28404 once per compilation, and mark the argument in the same way as
28405 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
28406 name is now chosen in a way that is hard to predict even when previously
28407 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
28408 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
28409 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
28410 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
28411 was simply substituted with a file name chosen once per compilation,
28412 without regard to any appended suffix (which was therefore treated
28413 just like ordinary text), making such attacks more likely to succeed.
28415 @item %u@var{suffix}
28416 Like @samp{%g}, but generates a new temporary file name
28417 each time it appears instead of once per compilation.
28419 @item %U@var{suffix}
28420 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
28421 new one if there is no such last file name.  In the absence of any
28422 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
28423 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
28424 involves the generation of two distinct file names, one
28425 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
28426 simply substituted with a file name chosen for the previous @samp{%u},
28427 without regard to any appended suffix.
28429 @item %j@var{suffix}
28430 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
28431 writable, and if @option{-save-temps} is not used; 
28432 otherwise, substitute the name
28433 of a temporary file, just like @samp{%u}.  This temporary file is not
28434 meant for communication between processes, but rather as a junk
28435 disposal mechanism.
28437 @item %|@var{suffix}
28438 @itemx %m@var{suffix}
28439 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
28440 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
28441 all.  These are the two most common ways to instruct a program that it
28442 should read from standard input or write to standard output.  If you
28443 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
28444 construct: see for example @file{f/lang-specs.h}.
28446 @item %.@var{SUFFIX}
28447 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
28448 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
28449 terminated by the next space or %.
28451 @item %w
28452 Marks the argument containing or following the @samp{%w} as the
28453 designated output file of this compilation.  This puts the argument
28454 into the sequence of arguments that @samp{%o} substitutes.
28456 @item %o
28457 Substitutes the names of all the output files, with spaces
28458 automatically placed around them.  You should write spaces
28459 around the @samp{%o} as well or the results are undefined.
28460 @samp{%o} is for use in the specs for running the linker.
28461 Input files whose names have no recognized suffix are not compiled
28462 at all, but they are included among the output files, so they are
28463 linked.
28465 @item %O
28466 Substitutes the suffix for object files.  Note that this is
28467 handled specially when it immediately follows @samp{%g, %u, or %U},
28468 because of the need for those to form complete file names.  The
28469 handling is such that @samp{%O} is treated exactly as if it had already
28470 been substituted, except that @samp{%g, %u, and %U} do not currently
28471 support additional @var{suffix} characters following @samp{%O} as they do
28472 following, for example, @samp{.o}.
28474 @item %p
28475 Substitutes the standard macro predefinitions for the
28476 current target machine.  Use this when running @command{cpp}.
28478 @item %P
28479 Like @samp{%p}, but puts @samp{__} before and after the name of each
28480 predefined macro, except for macros that start with @samp{__} or with
28481 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
28484 @item %I
28485 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
28486 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
28487 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
28488 and @option{-imultilib} as necessary.
28490 @item %s
28491 Current argument is the name of a library or startup file of some sort.
28492 Search for that file in a standard list of directories and substitute
28493 the full name found.  The current working directory is included in the
28494 list of directories scanned.
28496 @item %T
28497 Current argument is the name of a linker script.  Search for that file
28498 in the current list of directories to scan for libraries. If the file
28499 is located insert a @option{--script} option into the command line
28500 followed by the full path name found.  If the file is not found then
28501 generate an error message.  Note: the current working directory is not
28502 searched.
28504 @item %e@var{str}
28505 Print @var{str} as an error message.  @var{str} is terminated by a newline.
28506 Use this when inconsistent options are detected.
28508 @item %(@var{name})
28509 Substitute the contents of spec string @var{name} at this point.
28511 @item %x@{@var{option}@}
28512 Accumulate an option for @samp{%X}.
28514 @item %X
28515 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
28516 spec string.
28518 @item %Y
28519 Output the accumulated assembler options specified by @option{-Wa}.
28521 @item %Z
28522 Output the accumulated preprocessor options specified by @option{-Wp}.
28524 @item %a
28525 Process the @code{asm} spec.  This is used to compute the
28526 switches to be passed to the assembler.
28528 @item %A
28529 Process the @code{asm_final} spec.  This is a spec string for
28530 passing switches to an assembler post-processor, if such a program is
28531 needed.
28533 @item %l
28534 Process the @code{link} spec.  This is the spec for computing the
28535 command line passed to the linker.  Typically it makes use of the
28536 @samp{%L %G %S %D and %E} sequences.
28538 @item %D
28539 Dump out a @option{-L} option for each directory that GCC believes might
28540 contain startup files.  If the target supports multilibs then the
28541 current multilib directory is prepended to each of these paths.
28543 @item %L
28544 Process the @code{lib} spec.  This is a spec string for deciding which
28545 libraries are included on the command line to the linker.
28547 @item %G
28548 Process the @code{libgcc} spec.  This is a spec string for deciding
28549 which GCC support library is included on the command line to the linker.
28551 @item %S
28552 Process the @code{startfile} spec.  This is a spec for deciding which
28553 object files are the first ones passed to the linker.  Typically
28554 this might be a file named @file{crt0.o}.
28556 @item %E
28557 Process the @code{endfile} spec.  This is a spec string that specifies
28558 the last object files that are passed to the linker.
28560 @item %C
28561 Process the @code{cpp} spec.  This is used to construct the arguments
28562 to be passed to the C preprocessor.
28564 @item %1
28565 Process the @code{cc1} spec.  This is used to construct the options to be
28566 passed to the actual C compiler (@command{cc1}).
28568 @item %2
28569 Process the @code{cc1plus} spec.  This is used to construct the options to be
28570 passed to the actual C++ compiler (@command{cc1plus}).
28572 @item %*
28573 Substitute the variable part of a matched option.  See below.
28574 Note that each comma in the substituted string is replaced by
28575 a single space.
28577 @item %<S
28578 Remove all occurrences of @code{-S} from the command line.  Note---this
28579 command is position dependent.  @samp{%} commands in the spec string
28580 before this one see @code{-S}, @samp{%} commands in the spec string
28581 after this one do not.
28583 @item %:@var{function}(@var{args})
28584 Call the named function @var{function}, passing it @var{args}.
28585 @var{args} is first processed as a nested spec string, then split
28586 into an argument vector in the usual fashion.  The function returns
28587 a string which is processed as if it had appeared literally as part
28588 of the current spec.
28590 The following built-in spec functions are provided:
28592 @table @code
28593 @item @code{getenv}
28594 The @code{getenv} spec function takes two arguments: an environment
28595 variable name and a string.  If the environment variable is not
28596 defined, a fatal error is issued.  Otherwise, the return value is the
28597 value of the environment variable concatenated with the string.  For
28598 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
28600 @smallexample
28601 %:getenv(TOPDIR /include)
28602 @end smallexample
28604 expands to @file{/path/to/top/include}.
28606 @item @code{if-exists}
28607 The @code{if-exists} spec function takes one argument, an absolute
28608 pathname to a file.  If the file exists, @code{if-exists} returns the
28609 pathname.  Here is a small example of its usage:
28611 @smallexample
28612 *startfile:
28613 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
28614 @end smallexample
28616 @item @code{if-exists-else}
28617 The @code{if-exists-else} spec function is similar to the @code{if-exists}
28618 spec function, except that it takes two arguments.  The first argument is
28619 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
28620 returns the pathname.  If it does not exist, it returns the second argument.
28621 This way, @code{if-exists-else} can be used to select one file or another,
28622 based on the existence of the first.  Here is a small example of its usage:
28624 @smallexample
28625 *startfile:
28626 crt0%O%s %:if-exists(crti%O%s) \
28627 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
28628 @end smallexample
28630 @item @code{replace-outfile}
28631 The @code{replace-outfile} spec function takes two arguments.  It looks for the
28632 first argument in the outfiles array and replaces it with the second argument.  Here
28633 is a small example of its usage:
28635 @smallexample
28636 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
28637 @end smallexample
28639 @item @code{remove-outfile}
28640 The @code{remove-outfile} spec function takes one argument.  It looks for the
28641 first argument in the outfiles array and removes it.  Here is a small example
28642 its usage:
28644 @smallexample
28645 %:remove-outfile(-lm)
28646 @end smallexample
28648 @item @code{pass-through-libs}
28649 The @code{pass-through-libs} spec function takes any number of arguments.  It
28650 finds any @option{-l} options and any non-options ending in @file{.a} (which it
28651 assumes are the names of linker input library archive files) and returns a
28652 result containing all the found arguments each prepended by
28653 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
28654 intended to be passed to the LTO linker plugin.
28656 @smallexample
28657 %:pass-through-libs(%G %L %G)
28658 @end smallexample
28660 @item @code{print-asm-header}
28661 The @code{print-asm-header} function takes no arguments and simply
28662 prints a banner like:
28664 @smallexample
28665 Assembler options
28666 =================
28668 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
28669 @end smallexample
28671 It is used to separate compiler options from assembler options
28672 in the @option{--target-help} output.
28673 @end table
28675 @item %@{S@}
28676 Substitutes the @code{-S} switch, if that switch is given to GCC@.
28677 If that switch is not specified, this substitutes nothing.  Note that
28678 the leading dash is omitted when specifying this option, and it is
28679 automatically inserted if the substitution is performed.  Thus the spec
28680 string @samp{%@{foo@}} matches the command-line option @option{-foo}
28681 and outputs the command-line option @option{-foo}.
28683 @item %W@{S@}
28684 Like %@{@code{S}@} but mark last argument supplied within as a file to be
28685 deleted on failure.
28687 @item %@{S*@}
28688 Substitutes all the switches specified to GCC whose names start
28689 with @code{-S}, but which also take an argument.  This is used for
28690 switches like @option{-o}, @option{-D}, @option{-I}, etc.
28691 GCC considers @option{-o foo} as being
28692 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
28693 text, including the space.  Thus two arguments are generated.
28695 @item %@{S*&T*@}
28696 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
28697 (the order of @code{S} and @code{T} in the spec is not significant).
28698 There can be any number of ampersand-separated variables; for each the
28699 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
28701 @item %@{S:X@}
28702 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
28704 @item %@{!S:X@}
28705 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
28707 @item %@{S*:X@}
28708 Substitutes @code{X} if one or more switches whose names start with
28709 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
28710 once, no matter how many such switches appeared.  However, if @code{%*}
28711 appears somewhere in @code{X}, then @code{X} is substituted once
28712 for each matching switch, with the @code{%*} replaced by the part of
28713 that switch matching the @code{*}.
28715 If @code{%*} appears as the last part of a spec sequence then a space
28716 is added after the end of the last substitution.  If there is more
28717 text in the sequence, however, then a space is not generated.  This
28718 allows the @code{%*} substitution to be used as part of a larger
28719 string.  For example, a spec string like this:
28721 @smallexample
28722 %@{mcu=*:--script=%*/memory.ld@}
28723 @end smallexample
28725 @noindent
28726 when matching an option like @option{-mcu=newchip} produces:
28728 @smallexample
28729 --script=newchip/memory.ld
28730 @end smallexample
28732 @item %@{.S:X@}
28733 Substitutes @code{X}, if processing a file with suffix @code{S}.
28735 @item %@{!.S:X@}
28736 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
28738 @item %@{,S:X@}
28739 Substitutes @code{X}, if processing a file for language @code{S}.
28741 @item %@{!,S:X@}
28742 Substitutes @code{X}, if not processing a file for language @code{S}.
28744 @item %@{S|P:X@}
28745 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
28746 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
28747 @code{*} sequences as well, although they have a stronger binding than
28748 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
28749 alternatives must be starred, and only the first matching alternative
28750 is substituted.
28752 For example, a spec string like this:
28754 @smallexample
28755 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
28756 @end smallexample
28758 @noindent
28759 outputs the following command-line options from the following input
28760 command-line options:
28762 @smallexample
28763 fred.c        -foo -baz
28764 jim.d         -bar -boggle
28765 -d fred.c     -foo -baz -boggle
28766 -d jim.d      -bar -baz -boggle
28767 @end smallexample
28769 @item %@{S:X; T:Y; :D@}
28771 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
28772 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
28773 be as many clauses as you need.  This may be combined with @code{.},
28774 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
28777 @end table
28779 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
28780 or similar construct can use a backslash to ignore the special meaning
28781 of the character following it, thus allowing literal matching of a
28782 character that is otherwise specially treated.  For example,
28783 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
28784 @option{-std=iso9899:1999} option is given.
28786 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
28787 construct may contain other nested @samp{%} constructs or spaces, or
28788 even newlines.  They are processed as usual, as described above.
28789 Trailing white space in @code{X} is ignored.  White space may also
28790 appear anywhere on the left side of the colon in these constructs,
28791 except between @code{.} or @code{*} and the corresponding word.
28793 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
28794 handled specifically in these constructs.  If another value of
28795 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
28796 @option{-W} switch is found later in the command line, the earlier
28797 switch value is ignored, except with @{@code{S}*@} where @code{S} is
28798 just one letter, which passes all matching options.
28800 The character @samp{|} at the beginning of the predicate text is used to
28801 indicate that a command should be piped to the following command, but
28802 only if @option{-pipe} is specified.
28804 It is built into GCC which switches take arguments and which do not.
28805 (You might think it would be useful to generalize this to allow each
28806 compiler's spec to say which switches take arguments.  But this cannot
28807 be done in a consistent fashion.  GCC cannot even decide which input
28808 files have been specified without knowing which switches take arguments,
28809 and it must know which input files to compile in order to tell which
28810 compilers to run).
28812 GCC also knows implicitly that arguments starting in @option{-l} are to be
28813 treated as compiler output files, and passed to the linker in their
28814 proper position among the other output files.
28816 @node Environment Variables
28817 @section Environment Variables Affecting GCC
28818 @cindex environment variables
28820 @c man begin ENVIRONMENT
28821 This section describes several environment variables that affect how GCC
28822 operates.  Some of them work by specifying directories or prefixes to use
28823 when searching for various kinds of files.  Some are used to specify other
28824 aspects of the compilation environment.
28826 Note that you can also specify places to search using options such as
28827 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
28828 take precedence over places specified using environment variables, which
28829 in turn take precedence over those specified by the configuration of GCC@.
28830 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
28831 GNU Compiler Collection (GCC) Internals}.
28833 @table @env
28834 @item LANG
28835 @itemx LC_CTYPE
28836 @c @itemx LC_COLLATE
28837 @itemx LC_MESSAGES
28838 @c @itemx LC_MONETARY
28839 @c @itemx LC_NUMERIC
28840 @c @itemx LC_TIME
28841 @itemx LC_ALL
28842 @findex LANG
28843 @findex LC_CTYPE
28844 @c @findex LC_COLLATE
28845 @findex LC_MESSAGES
28846 @c @findex LC_MONETARY
28847 @c @findex LC_NUMERIC
28848 @c @findex LC_TIME
28849 @findex LC_ALL
28850 @cindex locale
28851 These environment variables control the way that GCC uses
28852 localization information which allows GCC to work with different
28853 national conventions.  GCC inspects the locale categories
28854 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
28855 so.  These locale categories can be set to any value supported by your
28856 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
28857 Kingdom encoded in UTF-8.
28859 The @env{LC_CTYPE} environment variable specifies character
28860 classification.  GCC uses it to determine the character boundaries in
28861 a string; this is needed for some multibyte encodings that contain quote
28862 and escape characters that are otherwise interpreted as a string
28863 end or escape.
28865 The @env{LC_MESSAGES} environment variable specifies the language to
28866 use in diagnostic messages.
28868 If the @env{LC_ALL} environment variable is set, it overrides the value
28869 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
28870 and @env{LC_MESSAGES} default to the value of the @env{LANG}
28871 environment variable.  If none of these variables are set, GCC
28872 defaults to traditional C English behavior.
28874 @item TMPDIR
28875 @findex TMPDIR
28876 If @env{TMPDIR} is set, it specifies the directory to use for temporary
28877 files.  GCC uses temporary files to hold the output of one stage of
28878 compilation which is to be used as input to the next stage: for example,
28879 the output of the preprocessor, which is the input to the compiler
28880 proper.
28882 @item GCC_COMPARE_DEBUG
28883 @findex GCC_COMPARE_DEBUG
28884 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
28885 @option{-fcompare-debug} to the compiler driver.  See the documentation
28886 of this option for more details.
28888 @item GCC_EXEC_PREFIX
28889 @findex GCC_EXEC_PREFIX
28890 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
28891 names of the subprograms executed by the compiler.  No slash is added
28892 when this prefix is combined with the name of a subprogram, but you can
28893 specify a prefix that ends with a slash if you wish.
28895 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
28896 an appropriate prefix to use based on the pathname it is invoked with.
28898 If GCC cannot find the subprogram using the specified prefix, it
28899 tries looking in the usual places for the subprogram.
28901 The default value of @env{GCC_EXEC_PREFIX} is
28902 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
28903 the installed compiler. In many cases @var{prefix} is the value
28904 of @code{prefix} when you ran the @file{configure} script.
28906 Other prefixes specified with @option{-B} take precedence over this prefix.
28908 This prefix is also used for finding files such as @file{crt0.o} that are
28909 used for linking.
28911 In addition, the prefix is used in an unusual way in finding the
28912 directories to search for header files.  For each of the standard
28913 directories whose name normally begins with @samp{/usr/local/lib/gcc}
28914 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
28915 replacing that beginning with the specified prefix to produce an
28916 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
28917 @file{foo/bar} just before it searches the standard directory 
28918 @file{/usr/local/lib/bar}.
28919 If a standard directory begins with the configured
28920 @var{prefix} then the value of @var{prefix} is replaced by
28921 @env{GCC_EXEC_PREFIX} when looking for header files.
28923 @item COMPILER_PATH
28924 @findex COMPILER_PATH
28925 The value of @env{COMPILER_PATH} is a colon-separated list of
28926 directories, much like @env{PATH}.  GCC tries the directories thus
28927 specified when searching for subprograms, if it cannot find the
28928 subprograms using @env{GCC_EXEC_PREFIX}.
28930 @item LIBRARY_PATH
28931 @findex LIBRARY_PATH
28932 The value of @env{LIBRARY_PATH} is a colon-separated list of
28933 directories, much like @env{PATH}.  When configured as a native compiler,
28934 GCC tries the directories thus specified when searching for special
28935 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
28936 using GCC also uses these directories when searching for ordinary
28937 libraries for the @option{-l} option (but directories specified with
28938 @option{-L} come first).
28940 @item LANG
28941 @findex LANG
28942 @cindex locale definition
28943 This variable is used to pass locale information to the compiler.  One way in
28944 which this information is used is to determine the character set to be used
28945 when character literals, string literals and comments are parsed in C and C++.
28946 When the compiler is configured to allow multibyte characters,
28947 the following values for @env{LANG} are recognized:
28949 @table @samp
28950 @item C-JIS
28951 Recognize JIS characters.
28952 @item C-SJIS
28953 Recognize SJIS characters.
28954 @item C-EUCJP
28955 Recognize EUCJP characters.
28956 @end table
28958 If @env{LANG} is not defined, or if it has some other value, then the
28959 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
28960 recognize and translate multibyte characters.
28961 @end table
28963 @noindent
28964 Some additional environment variables affect the behavior of the
28965 preprocessor.
28967 @include cppenv.texi
28969 @c man end
28971 @node Precompiled Headers
28972 @section Using Precompiled Headers
28973 @cindex precompiled headers
28974 @cindex speed of compilation
28976 Often large projects have many header files that are included in every
28977 source file.  The time the compiler takes to process these header files
28978 over and over again can account for nearly all of the time required to
28979 build the project.  To make builds faster, GCC allows you to
28980 @dfn{precompile} a header file.
28982 To create a precompiled header file, simply compile it as you would any
28983 other file, if necessary using the @option{-x} option to make the driver
28984 treat it as a C or C++ header file.  You may want to use a
28985 tool like @command{make} to keep the precompiled header up-to-date when
28986 the headers it contains change.
28988 A precompiled header file is searched for when @code{#include} is
28989 seen in the compilation.  As it searches for the included file
28990 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
28991 compiler looks for a precompiled header in each directory just before it
28992 looks for the include file in that directory.  The name searched for is
28993 the name specified in the @code{#include} with @samp{.gch} appended.  If
28994 the precompiled header file cannot be used, it is ignored.
28996 For instance, if you have @code{#include "all.h"}, and you have
28997 @file{all.h.gch} in the same directory as @file{all.h}, then the
28998 precompiled header file is used if possible, and the original
28999 header is used otherwise.
29001 Alternatively, you might decide to put the precompiled header file in a
29002 directory and use @option{-I} to ensure that directory is searched
29003 before (or instead of) the directory containing the original header.
29004 Then, if you want to check that the precompiled header file is always
29005 used, you can put a file of the same name as the original header in this
29006 directory containing an @code{#error} command.
29008 This also works with @option{-include}.  So yet another way to use
29009 precompiled headers, good for projects not designed with precompiled
29010 header files in mind, is to simply take most of the header files used by
29011 a project, include them from another header file, precompile that header
29012 file, and @option{-include} the precompiled header.  If the header files
29013 have guards against multiple inclusion, they are skipped because
29014 they've already been included (in the precompiled header).
29016 If you need to precompile the same header file for different
29017 languages, targets, or compiler options, you can instead make a
29018 @emph{directory} named like @file{all.h.gch}, and put each precompiled
29019 header in the directory, perhaps using @option{-o}.  It doesn't matter
29020 what you call the files in the directory; every precompiled header in
29021 the directory is considered.  The first precompiled header
29022 encountered in the directory that is valid for this compilation is
29023 used; they're searched in no particular order.
29025 There are many other possibilities, limited only by your imagination,
29026 good sense, and the constraints of your build system.
29028 A precompiled header file can be used only when these conditions apply:
29030 @itemize
29031 @item
29032 Only one precompiled header can be used in a particular compilation.
29034 @item
29035 A precompiled header cannot be used once the first C token is seen.  You
29036 can have preprocessor directives before a precompiled header; you cannot
29037 include a precompiled header from inside another header.
29039 @item
29040 The precompiled header file must be produced for the same language as
29041 the current compilation.  You cannot use a C precompiled header for a C++
29042 compilation.
29044 @item
29045 The precompiled header file must have been produced by the same compiler
29046 binary as the current compilation is using.
29048 @item
29049 Any macros defined before the precompiled header is included must
29050 either be defined in the same way as when the precompiled header was
29051 generated, or must not affect the precompiled header, which usually
29052 means that they don't appear in the precompiled header at all.
29054 The @option{-D} option is one way to define a macro before a
29055 precompiled header is included; using a @code{#define} can also do it.
29056 There are also some options that define macros implicitly, like
29057 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
29058 defined this way.
29060 @item If debugging information is output when using the precompiled
29061 header, using @option{-g} or similar, the same kind of debugging information
29062 must have been output when building the precompiled header.  However,
29063 a precompiled header built using @option{-g} can be used in a compilation
29064 when no debugging information is being output.
29066 @item The same @option{-m} options must generally be used when building
29067 and using the precompiled header.  @xref{Submodel Options},
29068 for any cases where this rule is relaxed.
29070 @item Each of the following options must be the same when building and using
29071 the precompiled header:
29073 @gccoptlist{-fexceptions}
29075 @item
29076 Some other command-line options starting with @option{-f},
29077 @option{-p}, or @option{-O} must be defined in the same way as when
29078 the precompiled header was generated.  At present, it's not clear
29079 which options are safe to change and which are not; the safest choice
29080 is to use exactly the same options when generating and using the
29081 precompiled header.  The following are known to be safe:
29083 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
29084 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
29085 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
29086 -pedantic-errors}
29088 @end itemize
29090 For all of these except the last, the compiler automatically
29091 ignores the precompiled header if the conditions aren't met.  If you
29092 find an option combination that doesn't work and doesn't cause the
29093 precompiled header to be ignored, please consider filing a bug report,
29094 see @ref{Bugs}.
29096 If you do use differing options when generating and using the
29097 precompiled header, the actual behavior is a mixture of the
29098 behavior for the options.  For instance, if you use @option{-g} to
29099 generate the precompiled header but not when using it, you may or may
29100 not get debugging information for routines in the precompiled header.