RISC-V: Add RV32E support.
[official-gcc.git] / gcc / doc / invoke.texi
blobbeba295bef505ae98e7d2d6bc59bb7ffc659c878
1 @c Copyright (C) 1988-2018 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2018 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), dbx(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -ffile-prefix-map=@var{old}=@var{new}  @gol
176 -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
177 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
179 @item C Language Options
180 @xref{C Dialect Options,,Options Controlling C Dialect}.
181 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
182 -fpermitted-flt-eval-methods=@var{standard} @gol
183 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
184 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
185 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
186 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
187 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
188 -fsigned-bitfields  -fsigned-char @gol
189 -funsigned-bitfields  -funsigned-char}
191 @item C++ Language Options
192 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
193 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
194 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
195 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor -Wdeprecated-copy  -Wliteral-suffix @gol
217 -Wmultiple-inheritance @gol
218 -Wnamespaces  -Wnarrowing @gol
219 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
220 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
221 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
222 -Wno-non-template-friend  -Wold-style-cast @gol
223 -Woverloaded-virtual  -Wno-pmf-conversions @gol
224 -Wsign-promo  -Wvirtual-inheritance}
226 @item Objective-C and Objective-C++ Language Options
227 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
228 Objective-C and Objective-C++ Dialects}.
229 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
230 -fgnu-runtime  -fnext-runtime @gol
231 -fno-nil-receivers @gol
232 -fobjc-abi-version=@var{n} @gol
233 -fobjc-call-cxx-cdtors @gol
234 -fobjc-direct-dispatch @gol
235 -fobjc-exceptions @gol
236 -fobjc-gc @gol
237 -fobjc-nilcheck @gol
238 -fobjc-std=objc1 @gol
239 -fno-local-ivars @gol
240 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
241 -freplace-objc-classes @gol
242 -fzero-link @gol
243 -gen-decls @gol
244 -Wassign-intercept @gol
245 -Wno-protocol  -Wselector @gol
246 -Wstrict-selector-match @gol
247 -Wundeclared-selector}
249 @item Diagnostic Message Formatting Options
250 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
251 @gccoptlist{-fmessage-length=@var{n}  @gol
252 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
253 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
254 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
255 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
256 -fdiagnostics-show-template-tree -fno-elide-type @gol
257 -fno-show-column}
259 @item Warning Options
260 @xref{Warning Options,,Options to Request or Suppress Warnings}.
261 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
262 -pedantic-errors @gol
263 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
264 -Walloc-zero  -Walloc-size-larger-than=@var{n}
265 -Walloca  -Walloca-larger-than=@var{n} @gol
266 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
267 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
268 -Wno-builtin-declaration-mismatch @gol
269 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
270 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  @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}
871 -mpic-data-is-text-relative}
873 @emph{MIPS Options}
874 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
875 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
876 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
877 -mips16  -mno-mips16  -mflip-mips16 @gol
878 -minterlink-compressed  -mno-interlink-compressed @gol
879 -minterlink-mips16  -mno-interlink-mips16 @gol
880 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
881 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
882 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
883 -mno-float  -msingle-float  -mdouble-float @gol
884 -modd-spreg  -mno-odd-spreg @gol
885 -mabs=@var{mode}  -mnan=@var{encoding} @gol
886 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
887 -mmcu  -mmno-mcu @gol
888 -meva  -mno-eva @gol
889 -mvirt  -mno-virt @gol
890 -mxpa  -mno-xpa @gol
891 -mmicromips  -mno-micromips @gol
892 -mmsa  -mno-msa @gol
893 -mfpu=@var{fpu-type} @gol
894 -msmartmips  -mno-smartmips @gol
895 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
896 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
897 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
898 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
899 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
900 -membedded-data  -mno-embedded-data @gol
901 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
902 -mcode-readable=@var{setting} @gol
903 -msplit-addresses  -mno-split-addresses @gol
904 -mexplicit-relocs  -mno-explicit-relocs @gol
905 -mcheck-zero-division  -mno-check-zero-division @gol
906 -mdivide-traps  -mdivide-breaks @gol
907 -mload-store-pairs  -mno-load-store-pairs @gol
908 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
909 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
910 -mfix-24k  -mno-fix-24k @gol
911 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
912 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
913 -mfix-vr4120  -mno-fix-vr4120 @gol
914 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
915 -mflush-func=@var{func}  -mno-flush-func @gol
916 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
917 -mcompact-branches=@var{policy} @gol
918 -mfp-exceptions  -mno-fp-exceptions @gol
919 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
920 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
921 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
922 -mframe-header-opt  -mno-frame-header-opt}
924 @emph{MMIX Options}
925 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
926 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
927 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
928 -mno-base-addresses  -msingle-exit  -mno-single-exit}
930 @emph{MN10300 Options}
931 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
932 -mno-am33  -mam33  -mam33-2  -mam34 @gol
933 -mtune=@var{cpu-type} @gol
934 -mreturn-pointer-on-d0 @gol
935 -mno-crt0  -mrelax  -mliw  -msetlb}
937 @emph{Moxie Options}
938 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
940 @emph{MSP430 Options}
941 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
942 -mwarn-mcu @gol
943 -mcode-region=  -mdata-region= @gol
944 -msilicon-errata=  -msilicon-errata-warn= @gol
945 -mhwmult=  -minrt}
947 @emph{NDS32 Options}
948 @gccoptlist{-mbig-endian  -mlittle-endian @gol
949 -mreduced-regs  -mfull-regs @gol
950 -mcmov  -mno-cmov @gol
951 -mext-perf  -mno-ext-perf @gol
952 -mext-perf2  -mno-ext-perf2 @gol
953 -mext-string  -mno-ext-string @gol
954 -mv3push  -mno-v3push @gol
955 -m16bit  -mno-16bit @gol
956 -misr-vector-size=@var{num} @gol
957 -mcache-block-size=@var{num} @gol
958 -march=@var{arch} @gol
959 -mcmodel=@var{code-model} @gol
960 -mctor-dtor  -mrelax}
962 @emph{Nios II Options}
963 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
964 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
965 -mel  -meb @gol
966 -mno-bypass-cache  -mbypass-cache @gol
967 -mno-cache-volatile  -mcache-volatile @gol
968 -mno-fast-sw-div  -mfast-sw-div @gol
969 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
970 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
971 -mcustom-fpu-cfg=@var{name} @gol
972 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
973 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
975 @emph{Nvidia PTX Options}
976 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
978 @emph{PDP-11 Options}
979 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
980 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
981 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
982 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
983 -mbranch-expensive  -mbranch-cheap @gol
984 -munix-asm  -mdec-asm}
986 @emph{picoChip Options}
987 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
988 -msymbol-as-address  -mno-inefficient-warnings}
990 @emph{PowerPC Options}
991 See RS/6000 and PowerPC Options.
993 @emph{PowerPC SPE Options}
994 @gccoptlist{-mcpu=@var{cpu-type} @gol
995 -mtune=@var{cpu-type} @gol
996 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb @gol
997 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
998 -m32  -mxl-compat  -mno-xl-compat @gol
999 -malign-power  -malign-natural @gol
1000 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1001 -msingle-float  -mdouble-float @gol
1002 -mupdate  -mno-update @gol
1003 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1004 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1005 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1006 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1007 -msingle-pic-base @gol
1008 -mprioritize-restricted-insns=@var{priority} @gol
1009 -msched-costly-dep=@var{dependence_type} @gol
1010 -minsert-sched-nops=@var{scheme} @gol
1011 -mcall-sysv  -mcall-netbsd @gol
1012 -maix-struct-return  -msvr4-struct-return @gol
1013 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1014 -mblock-move-inline-limit=@var{num} @gol
1015 -misel  -mno-isel @gol
1016 -misel=yes  -misel=no @gol
1017 -mspe  -mno-spe @gol
1018 -mspe=yes  -mspe=no @gol
1019 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1020 -mprototype  -mno-prototype @gol
1021 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1022 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1023 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1024 -mno-recip-precision @gol
1025 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1026 -msave-toc-indirect  -mno-save-toc-indirect @gol
1027 -mcompat-align-parm  -mno-compat-align-parm @gol
1028 -mfloat128  -mno-float128 @gol
1029 -mgnu-attribute  -mno-gnu-attribute @gol
1030 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1031 -mstack-protector-guard-offset=@var{offset}}
1033 @emph{RISC-V Options}
1034 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
1035 -mplt  -mno-plt @gol
1036 -mabi=@var{ABI-string} @gol
1037 -mfdiv  -mno-fdiv @gol
1038 -mdiv  -mno-div @gol
1039 -march=@var{ISA-string} @gol
1040 -mtune=@var{processor-string} @gol
1041 -mpreferred-stack-boundary=@var{num} @gol
1042 -msmall-data-limit=@var{N-bytes} @gol
1043 -msave-restore  -mno-save-restore @gol
1044 -mstrict-align -mno-strict-align @gol
1045 -mcmodel=medlow -mcmodel=medany @gol
1046 -mexplicit-relocs  -mno-explicit-relocs @gol
1047 -mrelax -mno-relax @gol}
1049 @emph{RL78 Options}
1050 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
1051 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
1052 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1054 @emph{RS/6000 and PowerPC Options}
1055 @gccoptlist{-mcpu=@var{cpu-type} @gol
1056 -mtune=@var{cpu-type} @gol
1057 -mcmodel=@var{code-model} @gol
1058 -mpowerpc64 @gol
1059 -maltivec  -mno-altivec @gol
1060 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1061 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1062 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1063 -mfprnd  -mno-fprnd @gol
1064 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1065 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1066 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1067 -malign-power  -malign-natural @gol
1068 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @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-aixdesc  -mcall-eabi  -mcall-freebsd  @gol
1080 -mcall-linux  -mcall-netbsd  -mcall-openbsd  @gol
1081 -mcall-sysv  -mcall-sysv-eabi  -mcall-sysv-noeabi @gol
1082 -mtraceback=@var{traceback_type} @gol
1083 -maix-struct-return  -msvr4-struct-return @gol
1084 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1085 -mblock-move-inline-limit=@var{num} @gol
1086 -mblock-compare-inline-limit=@var{num} @gol
1087 -mblock-compare-inline-loop-limit=@var{num} @gol
1088 -mstring-compare-inline-limit=@var{num} @gol
1089 -misel  -mno-isel @gol
1090 -misel=yes  -misel=no @gol
1091 -mvrsave  -mno-vrsave @gol
1092 -mmulhw  -mno-mulhw @gol
1093 -mdlmzb  -mno-dlmzb @gol
1094 -mprototype  -mno-prototype @gol
1095 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1096 -msdata=@var{opt}  -mreadonly-in-sdata  -mvxworks  -G @var{num} @gol
1097 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1098 -mno-recip-precision @gol
1099 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1100 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1101 -msave-toc-indirect  -mno-save-toc-indirect @gol
1102 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1103 -mcrypto  -mno-crypto  -mhtm  -mno-htm @gol
1104 -mquad-memory  -mno-quad-memory @gol
1105 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1106 -mcompat-align-parm  -mno-compat-align-parm @gol
1107 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1108 -mgnu-attribute  -mno-gnu-attribute @gol
1109 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1110 -mstack-protector-guard-offset=@var{offset}}
1112 @emph{RX Options}
1113 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1114 -mcpu=@gol
1115 -mbig-endian-data  -mlittle-endian-data @gol
1116 -msmall-data @gol
1117 -msim  -mno-sim@gol
1118 -mas100-syntax  -mno-as100-syntax@gol
1119 -mrelax@gol
1120 -mmax-constant-size=@gol
1121 -mint-register=@gol
1122 -mpid@gol
1123 -mallow-string-insns  -mno-allow-string-insns@gol
1124 -mjsr@gol
1125 -mno-warn-multiple-fast-interrupts@gol
1126 -msave-acc-in-interrupts}
1128 @emph{S/390 and zSeries Options}
1129 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1130 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1131 -mlong-double-64  -mlong-double-128 @gol
1132 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1133 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1134 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1135 -mhtm  -mvx  -mzvector @gol
1136 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1137 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1138 -mhotpatch=@var{halfwords},@var{halfwords}}
1140 @emph{Score Options}
1141 @gccoptlist{-meb  -mel @gol
1142 -mnhwloop @gol
1143 -muls @gol
1144 -mmac @gol
1145 -mscore5  -mscore5u  -mscore7  -mscore7d}
1147 @emph{SH Options}
1148 @gccoptlist{-m1  -m2  -m2e @gol
1149 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1150 -m3  -m3e @gol
1151 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1152 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1153 -mb  -ml  -mdalign  -mrelax @gol
1154 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1155 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1156 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1157 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1158 -maccumulate-outgoing-args @gol
1159 -matomic-model=@var{atomic-model} @gol
1160 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1161 -mcbranch-force-delay-slot @gol
1162 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1163 -mpretend-cmove  -mtas}
1165 @emph{Solaris 2 Options}
1166 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1167 -pthreads}
1169 @emph{SPARC Options}
1170 @gccoptlist{-mcpu=@var{cpu-type} @gol
1171 -mtune=@var{cpu-type} @gol
1172 -mcmodel=@var{code-model} @gol
1173 -mmemory-model=@var{mem-model} @gol
1174 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1175 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1176 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1177 -mhard-quad-float  -msoft-quad-float @gol
1178 -mstack-bias  -mno-stack-bias @gol
1179 -mstd-struct-return  -mno-std-struct-return @gol
1180 -munaligned-doubles  -mno-unaligned-doubles @gol
1181 -muser-mode  -mno-user-mode @gol
1182 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1183 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1184 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1185 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1186 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1187 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1188 -mlra  -mno-lra}
1190 @emph{SPU Options}
1191 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1192 -msafe-dma  -munsafe-dma @gol
1193 -mbranch-hints @gol
1194 -msmall-mem  -mlarge-mem  -mstdmain @gol
1195 -mfixed-range=@var{register-range} @gol
1196 -mea32  -mea64 @gol
1197 -maddress-space-conversion  -mno-address-space-conversion @gol
1198 -mcache-size=@var{cache-size} @gol
1199 -matomic-updates  -mno-atomic-updates}
1201 @emph{System V Options}
1202 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1204 @emph{TILE-Gx Options}
1205 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1206 -mcmodel=@var{code-model}}
1208 @emph{TILEPro Options}
1209 @gccoptlist{-mcpu=@var{cpu}  -m32}
1211 @emph{V850 Options}
1212 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1213 -mprolog-function  -mno-prolog-function  -mspace @gol
1214 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1215 -mapp-regs  -mno-app-regs @gol
1216 -mdisable-callt  -mno-disable-callt @gol
1217 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1218 -mv850e  -mv850  -mv850e3v5 @gol
1219 -mloop @gol
1220 -mrelax @gol
1221 -mlong-jumps @gol
1222 -msoft-float @gol
1223 -mhard-float @gol
1224 -mgcc-abi @gol
1225 -mrh850-abi @gol
1226 -mbig-switch}
1228 @emph{VAX Options}
1229 @gccoptlist{-mg  -mgnu  -munix}
1231 @emph{Visium Options}
1232 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1233 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1235 @emph{VMS Options}
1236 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1237 -mpointer-size=@var{size}}
1239 @emph{VxWorks Options}
1240 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1241 -Xbind-lazy  -Xbind-now}
1243 @emph{x86 Options}
1244 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1245 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1246 -mfpmath=@var{unit} @gol
1247 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1248 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1249 -mno-wide-multiply  -mrtd  -malign-double @gol
1250 -mpreferred-stack-boundary=@var{num} @gol
1251 -mincoming-stack-boundary=@var{num} @gol
1252 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1253 -mrecip  -mrecip=@var{opt} @gol
1254 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1255 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1256 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1257 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1258 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma -mpconfig -mwbnoinvd @gol
1259 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1260 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1261 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1262 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni  -mvaes  -mwaitpkg @gol
1263 -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1264 -mvpclmulqdq -mavx512bitalg -mmovdiri -mmovdir64b -mavx512vpopcntdq
1265 -mcldemote @gol
1266 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1267 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1268 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1269 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1270 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1271 -mregparm=@var{num}  -msseregparm @gol
1272 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1273 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1274 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1275 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1276 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1277 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1278 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1279 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1280 -mstack-protector-guard-reg=@var{reg} @gol
1281 -mstack-protector-guard-offset=@var{offset} @gol
1282 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1283 -mgeneral-regs-only -mcall-ms2sysv-xlogues @gol
1284 -mindirect-branch=@var{choice} -mfunction-return=@var{choice} @gol
1285 -mindirect-branch-register}
1287 @emph{x86 Windows Options}
1288 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1289 -mnop-fun-dllimport  -mthread @gol
1290 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1292 @emph{Xstormy16 Options}
1293 @gccoptlist{-msim}
1295 @emph{Xtensa Options}
1296 @gccoptlist{-mconst16  -mno-const16 @gol
1297 -mfused-madd  -mno-fused-madd @gol
1298 -mforce-no-pic @gol
1299 -mserialize-volatile  -mno-serialize-volatile @gol
1300 -mtext-section-literals  -mno-text-section-literals @gol
1301 -mauto-litpools  -mno-auto-litpools @gol
1302 -mtarget-align  -mno-target-align @gol
1303 -mlongcalls  -mno-longcalls}
1305 @emph{zSeries Options}
1306 See S/390 and zSeries Options.
1307 @end table
1310 @node Overall Options
1311 @section Options Controlling the Kind of Output
1313 Compilation can involve up to four stages: preprocessing, compilation
1314 proper, assembly and linking, always in that order.  GCC is capable of
1315 preprocessing and compiling several files either into several
1316 assembler input files, or into one assembler input file; then each
1317 assembler input file produces an object file, and linking combines all
1318 the object files (those newly compiled, and those specified as input)
1319 into an executable file.
1321 @cindex file name suffix
1322 For any given input file, the file name suffix determines what kind of
1323 compilation is done:
1325 @table @gcctabopt
1326 @item @var{file}.c
1327 C source code that must be preprocessed.
1329 @item @var{file}.i
1330 C source code that should not be preprocessed.
1332 @item @var{file}.ii
1333 C++ source code that should not be preprocessed.
1335 @item @var{file}.m
1336 Objective-C source code.  Note that you must link with the @file{libobjc}
1337 library to make an Objective-C program work.
1339 @item @var{file}.mi
1340 Objective-C source code that should not be preprocessed.
1342 @item @var{file}.mm
1343 @itemx @var{file}.M
1344 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1345 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1346 to a literal capital M@.
1348 @item @var{file}.mii
1349 Objective-C++ source code that should not be preprocessed.
1351 @item @var{file}.h
1352 C, C++, Objective-C or Objective-C++ header file to be turned into a
1353 precompiled header (default), or C, C++ header file to be turned into an
1354 Ada spec (via the @option{-fdump-ada-spec} switch).
1356 @item @var{file}.cc
1357 @itemx @var{file}.cp
1358 @itemx @var{file}.cxx
1359 @itemx @var{file}.cpp
1360 @itemx @var{file}.CPP
1361 @itemx @var{file}.c++
1362 @itemx @var{file}.C
1363 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1364 the last two letters must both be literally @samp{x}.  Likewise,
1365 @samp{.C} refers to a literal capital C@.
1367 @item @var{file}.mm
1368 @itemx @var{file}.M
1369 Objective-C++ source code that must be preprocessed.
1371 @item @var{file}.mii
1372 Objective-C++ source code that should not be preprocessed.
1374 @item @var{file}.hh
1375 @itemx @var{file}.H
1376 @itemx @var{file}.hp
1377 @itemx @var{file}.hxx
1378 @itemx @var{file}.hpp
1379 @itemx @var{file}.HPP
1380 @itemx @var{file}.h++
1381 @itemx @var{file}.tcc
1382 C++ header file to be turned into a precompiled header or Ada spec.
1384 @item @var{file}.f
1385 @itemx @var{file}.for
1386 @itemx @var{file}.ftn
1387 Fixed form Fortran source code that should not be preprocessed.
1389 @item @var{file}.F
1390 @itemx @var{file}.FOR
1391 @itemx @var{file}.fpp
1392 @itemx @var{file}.FPP
1393 @itemx @var{file}.FTN
1394 Fixed form Fortran source code that must be preprocessed (with the traditional
1395 preprocessor).
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 should not be preprocessed.
1403 @item @var{file}.F90
1404 @itemx @var{file}.F95
1405 @itemx @var{file}.F03
1406 @itemx @var{file}.F08
1407 Free form Fortran source code that must be preprocessed (with the
1408 traditional preprocessor).
1410 @item @var{file}.go
1411 Go source code.
1413 @item @var{file}.brig
1414 BRIG files (binary representation of HSAIL).
1416 @item @var{file}.ads
1417 Ada source code file that contains a library unit declaration (a
1418 declaration of a package, subprogram, or generic, or a generic
1419 instantiation), or a library unit renaming declaration (a package,
1420 generic, or subprogram renaming declaration).  Such files are also
1421 called @dfn{specs}.
1423 @item @var{file}.adb
1424 Ada source code file containing a library unit body (a subprogram or
1425 package body).  Such files are also called @dfn{bodies}.
1427 @c GCC also knows about some suffixes for languages not yet included:
1428 @c Pascal:
1429 @c @var{file}.p
1430 @c @var{file}.pas
1431 @c Ratfor:
1432 @c @var{file}.r
1434 @item @var{file}.s
1435 Assembler code.
1437 @item @var{file}.S
1438 @itemx @var{file}.sx
1439 Assembler code that must be preprocessed.
1441 @item @var{other}
1442 An object file to be fed straight into linking.
1443 Any file name with no recognized suffix is treated this way.
1444 @end table
1446 @opindex x
1447 You can specify the input language explicitly with the @option{-x} option:
1449 @table @gcctabopt
1450 @item -x @var{language}
1451 Specify explicitly the @var{language} for the following input files
1452 (rather than letting the compiler choose a default based on the file
1453 name suffix).  This option applies to all following input files until
1454 the next @option{-x} option.  Possible values for @var{language} are:
1455 @smallexample
1456 c  c-header  cpp-output
1457 c++  c++-header  c++-cpp-output
1458 objective-c  objective-c-header  objective-c-cpp-output
1459 objective-c++ objective-c++-header objective-c++-cpp-output
1460 assembler  assembler-with-cpp
1462 f77  f77-cpp-input f95  f95-cpp-input
1464 brig
1465 @end smallexample
1467 @item -x none
1468 Turn off any specification of a language, so that subsequent files are
1469 handled according to their file name suffixes (as they are if @option{-x}
1470 has not been used at all).
1471 @end table
1473 If you only want some of the stages of compilation, you can use
1474 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1475 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1476 @command{gcc} is to stop.  Note that some combinations (for example,
1477 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1479 @table @gcctabopt
1480 @item -c
1481 @opindex c
1482 Compile or assemble the source files, but do not link.  The linking
1483 stage simply is not done.  The ultimate output is in the form of an
1484 object file for each source file.
1486 By default, the object file name for a source file is made by replacing
1487 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1489 Unrecognized input files, not requiring compilation or assembly, are
1490 ignored.
1492 @item -S
1493 @opindex S
1494 Stop after the stage of compilation proper; do not assemble.  The output
1495 is in the form of an assembler code file for each non-assembler input
1496 file specified.
1498 By default, the assembler file name for a source file is made by
1499 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1501 Input files that don't require compilation are ignored.
1503 @item -E
1504 @opindex E
1505 Stop after the preprocessing stage; do not run the compiler proper.  The
1506 output is in the form of preprocessed source code, which is sent to the
1507 standard output.
1509 Input files that don't require preprocessing are ignored.
1511 @cindex output file option
1512 @item -o @var{file}
1513 @opindex o
1514 Place output in file @var{file}.  This applies to whatever
1515 sort of output is being produced, whether it be an executable file,
1516 an object file, an assembler file or preprocessed C code.
1518 If @option{-o} is not specified, the default is to put an executable
1519 file in @file{a.out}, the object file for
1520 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1521 assembler file in @file{@var{source}.s}, a precompiled header file in
1522 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1523 standard output.
1525 @item -v
1526 @opindex v
1527 Print (on standard error output) the commands executed to run the stages
1528 of compilation.  Also print the version number of the compiler driver
1529 program and of the preprocessor and the compiler proper.
1531 @item -###
1532 @opindex ###
1533 Like @option{-v} except the commands are not executed and arguments
1534 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1535 This is useful for shell scripts to capture the driver-generated command lines.
1537 @item --help
1538 @opindex help
1539 Print (on the standard output) a description of the command-line options
1540 understood by @command{gcc}.  If the @option{-v} option is also specified
1541 then @option{--help} is also passed on to the various processes
1542 invoked by @command{gcc}, so that they can display the command-line options
1543 they accept.  If the @option{-Wextra} option has also been specified
1544 (prior to the @option{--help} option), then command-line options that
1545 have no documentation associated with them are also displayed.
1547 @item --target-help
1548 @opindex target-help
1549 Print (on the standard output) a description of target-specific command-line
1550 options for each tool.  For some targets extra target-specific
1551 information may also be printed.
1553 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1554 Print (on the standard output) a description of the command-line
1555 options understood by the compiler that fit into all specified classes
1556 and qualifiers.  These are the supported classes:
1558 @table @asis
1559 @item @samp{optimizers}
1560 Display all of the optimization options supported by the
1561 compiler.
1563 @item @samp{warnings}
1564 Display all of the options controlling warning messages
1565 produced by the compiler.
1567 @item @samp{target}
1568 Display target-specific options.  Unlike the
1569 @option{--target-help} option however, target-specific options of the
1570 linker and assembler are not displayed.  This is because those
1571 tools do not currently support the extended @option{--help=} syntax.
1573 @item @samp{params}
1574 Display the values recognized by the @option{--param}
1575 option.
1577 @item @var{language}
1578 Display the options supported for @var{language}, where
1579 @var{language} is the name of one of the languages supported in this
1580 version of GCC@.
1582 @item @samp{common}
1583 Display the options that are common to all languages.
1584 @end table
1586 These are the supported qualifiers:
1588 @table @asis
1589 @item @samp{undocumented}
1590 Display only those options that are undocumented.
1592 @item @samp{joined}
1593 Display options taking an argument that appears after an equal
1594 sign in the same continuous piece of text, such as:
1595 @samp{--help=target}.
1597 @item @samp{separate}
1598 Display options taking an argument that appears as a separate word
1599 following the original option, such as: @samp{-o output-file}.
1600 @end table
1602 Thus for example to display all the undocumented target-specific
1603 switches supported by the compiler, use:
1605 @smallexample
1606 --help=target,undocumented
1607 @end smallexample
1609 The sense of a qualifier can be inverted by prefixing it with the
1610 @samp{^} character, so for example to display all binary warning
1611 options (i.e., ones that are either on or off and that do not take an
1612 argument) that have a description, use:
1614 @smallexample
1615 --help=warnings,^joined,^undocumented
1616 @end smallexample
1618 The argument to @option{--help=} should not consist solely of inverted
1619 qualifiers.
1621 Combining several classes is possible, although this usually
1622 restricts the output so much that there is nothing to display.  One
1623 case where it does work, however, is when one of the classes is
1624 @var{target}.  For example, to display all the target-specific
1625 optimization options, use:
1627 @smallexample
1628 --help=target,optimizers
1629 @end smallexample
1631 The @option{--help=} option can be repeated on the command line.  Each
1632 successive use displays its requested class of options, skipping
1633 those that have already been displayed.
1635 If the @option{-Q} option appears on the command line before the
1636 @option{--help=} option, then the descriptive text displayed by
1637 @option{--help=} is changed.  Instead of describing the displayed
1638 options, an indication is given as to whether the option is enabled,
1639 disabled or set to a specific value (assuming that the compiler
1640 knows this at the point where the @option{--help=} option is used).
1642 Here is a truncated example from the ARM port of @command{gcc}:
1644 @smallexample
1645   % gcc -Q -mabi=2 --help=target -c
1646   The following options are target specific:
1647   -mabi=                                2
1648   -mabort-on-noreturn                   [disabled]
1649   -mapcs                                [disabled]
1650 @end smallexample
1652 The output is sensitive to the effects of previous command-line
1653 options, so for example it is possible to find out which optimizations
1654 are enabled at @option{-O2} by using:
1656 @smallexample
1657 -Q -O2 --help=optimizers
1658 @end smallexample
1660 Alternatively you can discover which binary optimizations are enabled
1661 by @option{-O3} by using:
1663 @smallexample
1664 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1665 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1666 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1667 @end smallexample
1669 @item --version
1670 @opindex version
1671 Display the version number and copyrights of the invoked GCC@.
1673 @item -pass-exit-codes
1674 @opindex pass-exit-codes
1675 Normally the @command{gcc} program exits with the code of 1 if any
1676 phase of the compiler returns a non-success return code.  If you specify
1677 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1678 the numerically highest error produced by any phase returning an error
1679 indication.  The C, C++, and Fortran front ends return 4 if an internal
1680 compiler error is encountered.
1682 @item -pipe
1683 @opindex pipe
1684 Use pipes rather than temporary files for communication between the
1685 various stages of compilation.  This fails to work on some systems where
1686 the assembler is unable to read from a pipe; but the GNU assembler has
1687 no trouble.
1689 @item -specs=@var{file}
1690 @opindex specs
1691 Process @var{file} after the compiler reads in the standard @file{specs}
1692 file, in order to override the defaults which the @command{gcc} driver
1693 program uses when determining what switches to pass to @command{cc1},
1694 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1695 @option{-specs=@var{file}} can be specified on the command line, and they
1696 are processed in order, from left to right.  @xref{Spec Files}, for
1697 information about the format of the @var{file}.
1699 @item -wrapper
1700 @opindex wrapper
1701 Invoke all subcommands under a wrapper program.  The name of the
1702 wrapper program and its parameters are passed as a comma separated
1703 list.
1705 @smallexample
1706 gcc -c t.c -wrapper gdb,--args
1707 @end smallexample
1709 @noindent
1710 This invokes all subprograms of @command{gcc} under
1711 @samp{gdb --args}, thus the invocation of @command{cc1} is
1712 @samp{gdb --args cc1 @dots{}}.
1714 @item -ffile-prefix-map=@var{old}=@var{new}
1715 @opindex ffile-prefix-map
1716 When compiling files residing in directory @file{@var{old}}, record
1717 any references to them in the result of the compilation as if the
1718 files resided in directory @file{@var{new}} instead.  Specifying this
1719 option is equivalent to specifying all the individual
1720 @option{-f*-prefix-map} options.  This can be used to make reproducible
1721 builds that are location independent.  See also
1722 @option{-fmacro-prefix-map} and @option{-fdebug-prefix-map}.
1724 @item -fplugin=@var{name}.so
1725 @opindex fplugin
1726 Load the plugin code in file @var{name}.so, assumed to be a
1727 shared object to be dlopen'd by the compiler.  The base name of
1728 the shared object file is used to identify the plugin for the
1729 purposes of argument parsing (See
1730 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1731 Each plugin should define the callback functions specified in the
1732 Plugins API.
1734 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1735 @opindex fplugin-arg
1736 Define an argument called @var{key} with a value of @var{value}
1737 for the plugin called @var{name}.
1739 @item -fdump-ada-spec@r{[}-slim@r{]}
1740 @opindex fdump-ada-spec
1741 For C and C++ source and include files, generate corresponding Ada specs.
1742 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1743 GNAT User's Guide}, which provides detailed documentation on this feature.
1745 @item -fada-spec-parent=@var{unit}
1746 @opindex fada-spec-parent
1747 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1748 Ada specs as child units of parent @var{unit}.
1750 @item -fdump-go-spec=@var{file}
1751 @opindex fdump-go-spec
1752 For input files in any language, generate corresponding Go
1753 declarations in @var{file}.  This generates Go @code{const},
1754 @code{type}, @code{var}, and @code{func} declarations which may be a
1755 useful way to start writing a Go interface to code written in some
1756 other language.
1758 @include @value{srcdir}/../libiberty/at-file.texi
1759 @end table
1761 @node Invoking G++
1762 @section Compiling C++ Programs
1764 @cindex suffixes for C++ source
1765 @cindex C++ source file suffixes
1766 C++ source files conventionally use one of the suffixes @samp{.C},
1767 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1768 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1769 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1770 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1771 files with these names and compiles them as C++ programs even if you
1772 call the compiler the same way as for compiling C programs (usually
1773 with the name @command{gcc}).
1775 @findex g++
1776 @findex c++
1777 However, the use of @command{gcc} does not add the C++ library.
1778 @command{g++} is a program that calls GCC and automatically specifies linking
1779 against the C++ library.  It treats @samp{.c},
1780 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1781 files unless @option{-x} is used.  This program is also useful when
1782 precompiling a C header file with a @samp{.h} extension for use in C++
1783 compilations.  On many systems, @command{g++} is also installed with
1784 the name @command{c++}.
1786 @cindex invoking @command{g++}
1787 When you compile C++ programs, you may specify many of the same
1788 command-line options that you use for compiling programs in any
1789 language; or command-line options meaningful for C and related
1790 languages; or options that are meaningful only for C++ programs.
1791 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1792 explanations of options for languages related to C@.
1793 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1794 explanations of options that are meaningful only for C++ programs.
1796 @node C Dialect Options
1797 @section Options Controlling C Dialect
1798 @cindex dialect options
1799 @cindex language dialect options
1800 @cindex options, dialect
1802 The following options control the dialect of C (or languages derived
1803 from C, such as C++, Objective-C and Objective-C++) that the compiler
1804 accepts:
1806 @table @gcctabopt
1807 @cindex ANSI support
1808 @cindex ISO support
1809 @item -ansi
1810 @opindex ansi
1811 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1812 equivalent to @option{-std=c++98}.
1814 This turns off certain features of GCC that are incompatible with ISO
1815 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1816 such as the @code{asm} and @code{typeof} keywords, and
1817 predefined macros such as @code{unix} and @code{vax} that identify the
1818 type of system you are using.  It also enables the undesirable and
1819 rarely used ISO trigraph feature.  For the C compiler,
1820 it disables recognition of C++ style @samp{//} comments as well as
1821 the @code{inline} keyword.
1823 The alternate keywords @code{__asm__}, @code{__extension__},
1824 @code{__inline__} and @code{__typeof__} continue to work despite
1825 @option{-ansi}.  You would not want to use them in an ISO C program, of
1826 course, but it is useful to put them in header files that might be included
1827 in compilations done with @option{-ansi}.  Alternate predefined macros
1828 such as @code{__unix__} and @code{__vax__} are also available, with or
1829 without @option{-ansi}.
1831 The @option{-ansi} option does not cause non-ISO programs to be
1832 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1833 addition to @option{-ansi}.  @xref{Warning Options}.
1835 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1836 option is used.  Some header files may notice this macro and refrain
1837 from declaring certain functions or defining certain macros that the
1838 ISO standard doesn't call for; this is to avoid interfering with any
1839 programs that might use these names for other things.
1841 Functions that are normally built in but do not have semantics
1842 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1843 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1844 built-in functions provided by GCC}, for details of the functions
1845 affected.
1847 @item -std=
1848 @opindex std
1849 Determine the language standard. @xref{Standards,,Language Standards
1850 Supported by GCC}, for details of these standard versions.  This option
1851 is currently only supported when compiling C or C++.
1853 The compiler can accept several base standards, such as @samp{c90} or
1854 @samp{c++98}, and GNU dialects of those standards, such as
1855 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1856 compiler accepts all programs following that standard plus those
1857 using GNU extensions that do not contradict it.  For example,
1858 @option{-std=c90} turns off certain features of GCC that are
1859 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1860 keywords, but not other GNU extensions that do not have a meaning in
1861 ISO C90, such as omitting the middle term of a @code{?:}
1862 expression. On the other hand, when a GNU dialect of a standard is
1863 specified, all features supported by the compiler are enabled, even when
1864 those features change the meaning of the base standard.  As a result, some
1865 strict-conforming programs may be rejected.  The particular standard
1866 is used by @option{-Wpedantic} to identify which features are GNU
1867 extensions given that version of the standard. For example
1868 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1869 comments, while @option{-std=gnu99 -Wpedantic} does not.
1871 A value for this option must be provided; possible values are
1873 @table @samp
1874 @item c90
1875 @itemx c89
1876 @itemx iso9899:1990
1877 Support all ISO C90 programs (certain GNU extensions that conflict
1878 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1880 @item iso9899:199409
1881 ISO C90 as modified in amendment 1.
1883 @item c99
1884 @itemx c9x
1885 @itemx iso9899:1999
1886 @itemx iso9899:199x
1887 ISO C99.  This standard is substantially completely supported, modulo
1888 bugs and floating-point issues
1889 (mainly but not entirely relating to optional C99 features from
1890 Annexes F and G).  See
1891 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1892 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1894 @item c11
1895 @itemx c1x
1896 @itemx iso9899:2011
1897 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1898 substantially completely supported, modulo bugs, floating-point issues
1899 (mainly but not entirely relating to optional C11 features from
1900 Annexes F and G) and the optional Annexes K (Bounds-checking
1901 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1903 @item c17
1904 @itemx c18
1905 @itemx iso9899:2017
1906 @itemx iso9899:2018
1907 ISO C17, the 2017 revision of the ISO C standard (expected to be
1908 published in 2018).  This standard is
1909 same as C11 except for corrections of defects (all of which are also
1910 applied with @option{-std=c11}) and a new value of
1911 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1913 @item gnu90
1914 @itemx gnu89
1915 GNU dialect of ISO C90 (including some C99 features).
1917 @item gnu99
1918 @itemx gnu9x
1919 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1921 @item gnu11
1922 @itemx gnu1x
1923 GNU dialect of ISO C11.
1924 The name @samp{gnu1x} is deprecated.
1926 @item gnu17
1927 @itemx gnu18
1928 GNU dialect of ISO C17.  This is the default for C code.
1930 @item c++98
1931 @itemx c++03
1932 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1933 additional defect reports. Same as @option{-ansi} for C++ code.
1935 @item gnu++98
1936 @itemx gnu++03
1937 GNU dialect of @option{-std=c++98}.
1939 @item c++11
1940 @itemx c++0x
1941 The 2011 ISO C++ standard plus amendments.
1942 The name @samp{c++0x} is deprecated.
1944 @item gnu++11
1945 @itemx gnu++0x
1946 GNU dialect of @option{-std=c++11}.
1947 The name @samp{gnu++0x} is deprecated.
1949 @item c++14
1950 @itemx c++1y
1951 The 2014 ISO C++ standard plus amendments.
1952 The name @samp{c++1y} is deprecated.
1954 @item gnu++14
1955 @itemx gnu++1y
1956 GNU dialect of @option{-std=c++14}.
1957 This is the default for C++ code.
1958 The name @samp{gnu++1y} is deprecated.
1960 @item c++17
1961 @itemx c++1z
1962 The 2017 ISO C++ standard plus amendments.
1963 The name @samp{c++1z} is deprecated.
1965 @item gnu++17
1966 @itemx gnu++1z
1967 GNU dialect of @option{-std=c++17}.
1968 The name @samp{gnu++1z} is deprecated.
1970 @item c++2a
1971 The next revision of the ISO C++ standard, tentatively planned for
1972 2020.  Support is highly experimental, and will almost certainly
1973 change in incompatible ways in future releases.
1975 @item gnu++2a
1976 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1977 and will almost certainly change in incompatible ways in future
1978 releases.
1979 @end table
1981 @item -fgnu89-inline
1982 @opindex fgnu89-inline
1983 The option @option{-fgnu89-inline} tells GCC to use the traditional
1984 GNU semantics for @code{inline} functions when in C99 mode.
1985 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1986 Using this option is roughly equivalent to adding the
1987 @code{gnu_inline} function attribute to all inline functions
1988 (@pxref{Function Attributes}).
1990 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1991 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1992 specifies the default behavior).
1993 This option is not supported in @option{-std=c90} or
1994 @option{-std=gnu90} mode.
1996 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1997 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1998 in effect for @code{inline} functions.  @xref{Common Predefined
1999 Macros,,,cpp,The C Preprocessor}.
2001 @item -fpermitted-flt-eval-methods=@var{style}
2002 @opindex fpermitted-flt-eval-methods
2003 @opindex fpermitted-flt-eval-methods=c11
2004 @opindex fpermitted-flt-eval-methods=ts-18661-3
2005 ISO/IEC TS 18661-3 defines new permissible values for
2006 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
2007 a semantic type that is an interchange or extended format should be
2008 evaluated to the precision and range of that type.  These new values are
2009 a superset of those permitted under C99/C11, which does not specify the
2010 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
2011 conforming to C11 may not have been written expecting the possibility of
2012 the new values.
2014 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
2015 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
2016 or the extended set of values specified in ISO/IEC TS 18661-3.
2018 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
2020 The default when in a standards compliant mode (@option{-std=c11} or similar)
2021 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
2022 dialect (@option{-std=gnu11} or similar) is
2023 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
2025 @item -aux-info @var{filename}
2026 @opindex aux-info
2027 Output to the given filename prototyped declarations for all functions
2028 declared and/or defined in a translation unit, including those in header
2029 files.  This option is silently ignored in any language other than C@.
2031 Besides declarations, the file indicates, in comments, the origin of
2032 each declaration (source file and line), whether the declaration was
2033 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
2034 @samp{O} for old, respectively, in the first character after the line
2035 number and the colon), and whether it came from a declaration or a
2036 definition (@samp{C} or @samp{F}, respectively, in the following
2037 character).  In the case of function definitions, a K&R-style list of
2038 arguments followed by their declarations is also provided, inside
2039 comments, after the declaration.
2041 @item -fallow-parameterless-variadic-functions
2042 @opindex fallow-parameterless-variadic-functions
2043 Accept variadic functions without named parameters.
2045 Although it is possible to define such a function, this is not very
2046 useful as it is not possible to read the arguments.  This is only
2047 supported for C as this construct is allowed by C++.
2049 @item -fno-asm
2050 @opindex fno-asm
2051 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
2052 keyword, so that code can use these words as identifiers.  You can use
2053 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
2054 instead.  @option{-ansi} implies @option{-fno-asm}.
2056 In C++, this switch only affects the @code{typeof} keyword, since
2057 @code{asm} and @code{inline} are standard keywords.  You may want to
2058 use the @option{-fno-gnu-keywords} flag instead, which has the same
2059 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
2060 switch only affects the @code{asm} and @code{typeof} keywords, since
2061 @code{inline} is a standard keyword in ISO C99.
2063 @item -fno-builtin
2064 @itemx -fno-builtin-@var{function}
2065 @opindex fno-builtin
2066 @cindex built-in functions
2067 Don't recognize built-in functions that do not begin with
2068 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2069 functions provided by GCC}, for details of the functions affected,
2070 including those which are not built-in functions when @option{-ansi} or
2071 @option{-std} options for strict ISO C conformance are used because they
2072 do not have an ISO standard meaning.
2074 GCC normally generates special code to handle certain built-in functions
2075 more efficiently; for instance, calls to @code{alloca} may become single
2076 instructions which adjust the stack directly, and calls to @code{memcpy}
2077 may become inline copy loops.  The resulting code is often both smaller
2078 and faster, but since the function calls no longer appear as such, you
2079 cannot set a breakpoint on those calls, nor can you change the behavior
2080 of the functions by linking with a different library.  In addition,
2081 when a function is recognized as a built-in function, GCC may use
2082 information about that function to warn about problems with calls to
2083 that function, or to generate more efficient code, even if the
2084 resulting code still contains calls to that function.  For example,
2085 warnings are given with @option{-Wformat} for bad calls to
2086 @code{printf} when @code{printf} is built in and @code{strlen} is
2087 known not to modify global memory.
2089 With the @option{-fno-builtin-@var{function}} option
2090 only the built-in function @var{function} is
2091 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2092 function is named that is not built-in in this version of GCC, this
2093 option is ignored.  There is no corresponding
2094 @option{-fbuiltin-@var{function}} option; if you wish to enable
2095 built-in functions selectively when using @option{-fno-builtin} or
2096 @option{-ffreestanding}, you may define macros such as:
2098 @smallexample
2099 #define abs(n)          __builtin_abs ((n))
2100 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2101 @end smallexample
2103 @item -fgimple
2104 @opindex fgimple
2106 Enable parsing of function definitions marked with @code{__GIMPLE}.
2107 This is an experimental feature that allows unit testing of GIMPLE
2108 passes.
2110 @item -fhosted
2111 @opindex fhosted
2112 @cindex hosted environment
2114 Assert that compilation targets a hosted environment.  This implies
2115 @option{-fbuiltin}.  A hosted environment is one in which the
2116 entire standard library is available, and in which @code{main} has a return
2117 type of @code{int}.  Examples are nearly everything except a kernel.
2118 This is equivalent to @option{-fno-freestanding}.
2120 @item -ffreestanding
2121 @opindex ffreestanding
2122 @cindex hosted environment
2124 Assert that compilation targets a freestanding environment.  This
2125 implies @option{-fno-builtin}.  A freestanding environment
2126 is one in which the standard library may not exist, and program startup may
2127 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2128 This is equivalent to @option{-fno-hosted}.
2130 @xref{Standards,,Language Standards Supported by GCC}, for details of
2131 freestanding and hosted environments.
2133 @item -fopenacc
2134 @opindex fopenacc
2135 @cindex OpenACC accelerator programming
2136 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2137 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2138 compiler generates accelerated code according to the OpenACC Application
2139 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2140 implies @option{-pthread}, and thus is only supported on targets that
2141 have support for @option{-pthread}.
2143 @item -fopenacc-dim=@var{geom}
2144 @opindex fopenacc-dim
2145 @cindex OpenACC accelerator programming
2146 Specify default compute dimensions for parallel offload regions that do
2147 not explicitly specify.  The @var{geom} value is a triple of
2148 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2149 can be omitted, to use a target-specific default value.
2151 @item -fopenmp
2152 @opindex fopenmp
2153 @cindex OpenMP parallel
2154 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2155 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2156 compiler generates parallel code according to the OpenMP Application
2157 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2158 implies @option{-pthread}, and thus is only supported on targets that
2159 have support for @option{-pthread}. @option{-fopenmp} implies
2160 @option{-fopenmp-simd}.
2162 @item -fopenmp-simd
2163 @opindex fopenmp-simd
2164 @cindex OpenMP SIMD
2165 @cindex SIMD
2166 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2167 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2168 are ignored.
2170 @item -fgnu-tm
2171 @opindex fgnu-tm
2172 When the option @option{-fgnu-tm} is specified, the compiler
2173 generates code for the Linux variant of Intel's current Transactional
2174 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2175 an experimental feature whose interface may change in future versions
2176 of GCC, as the official specification changes.  Please note that not
2177 all architectures are supported for this feature.
2179 For more information on GCC's support for transactional memory,
2180 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2181 Transactional Memory Library}.
2183 Note that the transactional memory feature is not supported with
2184 non-call exceptions (@option{-fnon-call-exceptions}).
2186 @item -fms-extensions
2187 @opindex fms-extensions
2188 Accept some non-standard constructs used in Microsoft header files.
2190 In C++ code, this allows member names in structures to be similar
2191 to previous types declarations.
2193 @smallexample
2194 typedef int UOW;
2195 struct ABC @{
2196   UOW UOW;
2198 @end smallexample
2200 Some cases of unnamed fields in structures and unions are only
2201 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2202 fields within structs/unions}, for details.
2204 Note that this option is off for all targets but x86 
2205 targets using ms-abi.
2207 @item -fplan9-extensions
2208 @opindex fplan9-extensions
2209 Accept some non-standard constructs used in Plan 9 code.
2211 This enables @option{-fms-extensions}, permits passing pointers to
2212 structures with anonymous fields to functions that expect pointers to
2213 elements of the type of the field, and permits referring to anonymous
2214 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2215 struct/union fields within structs/unions}, for details.  This is only
2216 supported for C, not C++.
2218 @item -fcond-mismatch
2219 @opindex fcond-mismatch
2220 Allow conditional expressions with mismatched types in the second and
2221 third arguments.  The value of such an expression is void.  This option
2222 is not supported for C++.
2224 @item -flax-vector-conversions
2225 @opindex flax-vector-conversions
2226 Allow implicit conversions between vectors with differing numbers of
2227 elements and/or incompatible element types.  This option should not be
2228 used for new code.
2230 @item -funsigned-char
2231 @opindex funsigned-char
2232 Let the type @code{char} be unsigned, like @code{unsigned char}.
2234 Each kind of machine has a default for what @code{char} should
2235 be.  It is either like @code{unsigned char} by default or like
2236 @code{signed char} by default.
2238 Ideally, a portable program should always use @code{signed char} or
2239 @code{unsigned char} when it depends on the signedness of an object.
2240 But many programs have been written to use plain @code{char} and
2241 expect it to be signed, or expect it to be unsigned, depending on the
2242 machines they were written for.  This option, and its inverse, let you
2243 make such a program work with the opposite default.
2245 The type @code{char} is always a distinct type from each of
2246 @code{signed char} or @code{unsigned char}, even though its behavior
2247 is always just like one of those two.
2249 @item -fsigned-char
2250 @opindex fsigned-char
2251 Let the type @code{char} be signed, like @code{signed char}.
2253 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2254 the negative form of @option{-funsigned-char}.  Likewise, the option
2255 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2257 @item -fsigned-bitfields
2258 @itemx -funsigned-bitfields
2259 @itemx -fno-signed-bitfields
2260 @itemx -fno-unsigned-bitfields
2261 @opindex fsigned-bitfields
2262 @opindex funsigned-bitfields
2263 @opindex fno-signed-bitfields
2264 @opindex fno-unsigned-bitfields
2265 These options control whether a bit-field is signed or unsigned, when the
2266 declaration does not use either @code{signed} or @code{unsigned}.  By
2267 default, such a bit-field is signed, because this is consistent: the
2268 basic integer types such as @code{int} are signed types.
2270 @item -fsso-struct=@var{endianness}
2271 @opindex fsso-struct
2272 Set the default scalar storage order of structures and unions to the
2273 specified endianness.  The accepted values are @samp{big-endian},
2274 @samp{little-endian} and @samp{native} for the native endianness of
2275 the target (the default).  This option is not supported for C++.
2277 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2278 code that is not binary compatible with code generated without it if the
2279 specified endianness is not the native endianness of the target.
2280 @end table
2282 @node C++ Dialect Options
2283 @section Options Controlling C++ Dialect
2285 @cindex compiler options, C++
2286 @cindex C++ options, command-line
2287 @cindex options, C++
2288 This section describes the command-line options that are only meaningful
2289 for C++ programs.  You can also use most of the GNU compiler options
2290 regardless of what language your program is in.  For example, you
2291 might compile a file @file{firstClass.C} like this:
2293 @smallexample
2294 g++ -g -fstrict-enums -O -c firstClass.C
2295 @end smallexample
2297 @noindent
2298 In this example, only @option{-fstrict-enums} is an option meant
2299 only for C++ programs; you can use the other options with any
2300 language supported by GCC@.
2302 Some options for compiling C programs, such as @option{-std}, are also
2303 relevant for C++ programs.
2304 @xref{C Dialect Options,,Options Controlling C Dialect}.
2306 Here is a list of options that are @emph{only} for compiling C++ programs:
2308 @table @gcctabopt
2310 @item -fabi-version=@var{n}
2311 @opindex fabi-version
2312 Use version @var{n} of the C++ ABI@.  The default is version 0.
2314 Version 0 refers to the version conforming most closely to
2315 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2316 will change in different versions of G++ as ABI bugs are fixed.
2318 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2320 Version 2 is the version of the C++ ABI that first appeared in G++
2321 3.4, and was the default through G++ 4.9.
2323 Version 3 corrects an error in mangling a constant address as a
2324 template argument.
2326 Version 4, which first appeared in G++ 4.5, implements a standard
2327 mangling for vector types.
2329 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2330 attribute const/volatile on function pointer types, decltype of a
2331 plain decl, and use of a function parameter in the declaration of
2332 another parameter.
2334 Version 6, which first appeared in G++ 4.7, corrects the promotion
2335 behavior of C++11 scoped enums and the mangling of template argument
2336 packs, const/static_cast, prefix ++ and --, and a class scope function
2337 used as a template argument.
2339 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2340 builtin type and corrects the mangling of lambdas in default argument
2341 scope.
2343 Version 8, which first appeared in G++ 4.9, corrects the substitution
2344 behavior of function types with function-cv-qualifiers.
2346 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2347 @code{nullptr_t}.
2349 Version 10, which first appeared in G++ 6.1, adds mangling of
2350 attributes that affect type identity, such as ia32 calling convention
2351 attributes (e.g. @samp{stdcall}).
2353 Version 11, which first appeared in G++ 7, corrects the mangling of
2354 sizeof... expressions and operator names.  For multiple entities with
2355 the same name within a function, that are declared in different scopes,
2356 the mangling now changes starting with the twelfth occurrence.  It also
2357 implies @option{-fnew-inheriting-ctors}.
2359 See also @option{-Wabi}.
2361 @item -fabi-compat-version=@var{n}
2362 @opindex fabi-compat-version
2363 On targets that support strong aliases, G++
2364 works around mangling changes by creating an alias with the correct
2365 mangled name when defining a symbol with an incorrect mangled name.
2366 This switch specifies which ABI version to use for the alias.
2368 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2369 compatibility).  If another ABI version is explicitly selected, this
2370 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2371 use @option{-fabi-compat-version=2}.
2373 If this option is not provided but @option{-Wabi=@var{n}} is, that
2374 version is used for compatibility aliases.  If this option is provided
2375 along with @option{-Wabi} (without the version), the version from this
2376 option is used for the warning.
2378 @item -fno-access-control
2379 @opindex fno-access-control
2380 Turn off all access checking.  This switch is mainly useful for working
2381 around bugs in the access control code.
2383 @item -faligned-new
2384 @opindex faligned-new
2385 Enable support for C++17 @code{new} of types that require more
2386 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2387 numeric argument such as @code{-faligned-new=32} can be used to
2388 specify how much alignment (in bytes) is provided by that function,
2389 but few users will need to override the default of
2390 @code{alignof(std::max_align_t)}.
2392 This flag is enabled by default for @option{-std=c++17}.
2394 @item -fcheck-new
2395 @opindex fcheck-new
2396 Check that the pointer returned by @code{operator new} is non-null
2397 before attempting to modify the storage allocated.  This check is
2398 normally unnecessary because the C++ standard specifies that
2399 @code{operator new} only returns @code{0} if it is declared
2400 @code{throw()}, in which case the compiler always checks the
2401 return value even without this option.  In all other cases, when
2402 @code{operator new} has a non-empty exception specification, memory
2403 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2404 @samp{new (nothrow)}.
2406 @item -fconcepts
2407 @opindex fconcepts
2408 Enable support for the C++ Extensions for Concepts Technical
2409 Specification, ISO 19217 (2015), which allows code like
2411 @smallexample
2412 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2413 template <Addable T> T add (T a, T b) @{ return a + b; @}
2414 @end smallexample
2416 @item -fconstexpr-depth=@var{n}
2417 @opindex fconstexpr-depth
2418 Set the maximum nested evaluation depth for C++11 constexpr functions
2419 to @var{n}.  A limit is needed to detect endless recursion during
2420 constant expression evaluation.  The minimum specified by the standard
2421 is 512.
2423 @item -fconstexpr-loop-limit=@var{n}
2424 @opindex fconstexpr-loop-limit
2425 Set the maximum number of iterations for a loop in C++14 constexpr functions
2426 to @var{n}.  A limit is needed to detect infinite loops during
2427 constant expression evaluation.  The default is 262144 (1<<18).
2429 @item -fdeduce-init-list
2430 @opindex fdeduce-init-list
2431 Enable deduction of a template type parameter as
2432 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2434 @smallexample
2435 template <class T> auto forward(T t) -> decltype (realfn (t))
2437   return realfn (t);
2440 void f()
2442   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2444 @end smallexample
2446 This deduction was implemented as a possible extension to the
2447 originally proposed semantics for the C++11 standard, but was not part
2448 of the final standard, so it is disabled by default.  This option is
2449 deprecated, and may be removed in a future version of G++.
2451 @item -fno-elide-constructors
2452 @opindex fno-elide-constructors
2453 The C++ standard allows an implementation to omit creating a temporary
2454 that is only used to initialize another object of the same type.
2455 Specifying this option disables that optimization, and forces G++ to
2456 call the copy constructor in all cases.  This option also causes G++
2457 to call trivial member functions which otherwise would be expanded inline.
2459 In C++17, the compiler is required to omit these temporaries, but this
2460 option still affects trivial member functions.
2462 @item -fno-enforce-eh-specs
2463 @opindex fno-enforce-eh-specs
2464 Don't generate code to check for violation of exception specifications
2465 at run time.  This option violates the C++ standard, but may be useful
2466 for reducing code size in production builds, much like defining
2467 @code{NDEBUG}.  This does not give user code permission to throw
2468 exceptions in violation of the exception specifications; the compiler
2469 still optimizes based on the specifications, so throwing an
2470 unexpected exception results in undefined behavior at run time.
2472 @item -fextern-tls-init
2473 @itemx -fno-extern-tls-init
2474 @opindex fextern-tls-init
2475 @opindex fno-extern-tls-init
2476 The C++11 and OpenMP standards allow @code{thread_local} and
2477 @code{threadprivate} variables to have dynamic (runtime)
2478 initialization.  To support this, any use of such a variable goes
2479 through a wrapper function that performs any necessary initialization.
2480 When the use and definition of the variable are in the same
2481 translation unit, this overhead can be optimized away, but when the
2482 use is in a different translation unit there is significant overhead
2483 even if the variable doesn't actually need dynamic initialization.  If
2484 the programmer can be sure that no use of the variable in a
2485 non-defining TU needs to trigger dynamic initialization (either
2486 because the variable is statically initialized, or a use of the
2487 variable in the defining TU will be executed before any uses in
2488 another TU), they can avoid this overhead with the
2489 @option{-fno-extern-tls-init} option.
2491 On targets that support symbol aliases, the default is
2492 @option{-fextern-tls-init}.  On targets that do not support symbol
2493 aliases, the default is @option{-fno-extern-tls-init}.
2495 @item -fno-gnu-keywords
2496 @opindex fno-gnu-keywords
2497 Do not recognize @code{typeof} as a keyword, so that code can use this
2498 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2499 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2500 @option{-std=c++98}, @option{-std=c++11}, etc.
2502 @item -fno-implicit-templates
2503 @opindex fno-implicit-templates
2504 Never emit code for non-inline templates that are instantiated
2505 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2506 @xref{Template Instantiation}, for more information.
2508 @item -fno-implicit-inline-templates
2509 @opindex fno-implicit-inline-templates
2510 Don't emit code for implicit instantiations of inline templates, either.
2511 The default is to handle inlines differently so that compiles with and
2512 without optimization need the same set of explicit instantiations.
2514 @item -fno-implement-inlines
2515 @opindex fno-implement-inlines
2516 To save space, do not emit out-of-line copies of inline functions
2517 controlled by @code{#pragma implementation}.  This causes linker
2518 errors if these functions are not inlined everywhere they are called.
2520 @item -fms-extensions
2521 @opindex fms-extensions
2522 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2523 int and getting a pointer to member function via non-standard syntax.
2525 @item -fnew-inheriting-ctors
2526 @opindex fnew-inheriting-ctors
2527 Enable the P0136 adjustment to the semantics of C++11 constructor
2528 inheritance.  This is part of C++17 but also considered to be a Defect
2529 Report against C++11 and C++14.  This flag is enabled by default
2530 unless @option{-fabi-version=10} or lower is specified.
2532 @item -fnew-ttp-matching
2533 @opindex fnew-ttp-matching
2534 Enable the P0522 resolution to Core issue 150, template template
2535 parameters and default arguments: this allows a template with default
2536 template arguments as an argument for a template template parameter
2537 with fewer template parameters.  This flag is enabled by default for
2538 @option{-std=c++17}.
2540 @item -fno-nonansi-builtins
2541 @opindex fno-nonansi-builtins
2542 Disable built-in declarations of functions that are not mandated by
2543 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2544 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2546 @item -fnothrow-opt
2547 @opindex fnothrow-opt
2548 Treat a @code{throw()} exception specification as if it were a
2549 @code{noexcept} specification to reduce or eliminate the text size
2550 overhead relative to a function with no exception specification.  If
2551 the function has local variables of types with non-trivial
2552 destructors, the exception specification actually makes the
2553 function smaller because the EH cleanups for those variables can be
2554 optimized away.  The semantic effect is that an exception thrown out of
2555 a function with such an exception specification results in a call
2556 to @code{terminate} rather than @code{unexpected}.
2558 @item -fno-operator-names
2559 @opindex fno-operator-names
2560 Do not treat the operator name keywords @code{and}, @code{bitand},
2561 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2562 synonyms as keywords.
2564 @item -fno-optional-diags
2565 @opindex fno-optional-diags
2566 Disable diagnostics that the standard says a compiler does not need to
2567 issue.  Currently, the only such diagnostic issued by G++ is the one for
2568 a name having multiple meanings within a class.
2570 @item -fpermissive
2571 @opindex fpermissive
2572 Downgrade some diagnostics about nonconformant code from errors to
2573 warnings.  Thus, using @option{-fpermissive} allows some
2574 nonconforming code to compile.
2576 @item -fno-pretty-templates
2577 @opindex fno-pretty-templates
2578 When an error message refers to a specialization of a function
2579 template, the compiler normally prints the signature of the
2580 template followed by the template arguments and any typedefs or
2581 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2582 rather than @code{void f(int)}) so that it's clear which template is
2583 involved.  When an error message refers to a specialization of a class
2584 template, the compiler omits any template arguments that match
2585 the default template arguments for that template.  If either of these
2586 behaviors make it harder to understand the error message rather than
2587 easier, you can use @option{-fno-pretty-templates} to disable them.
2589 @item -frepo
2590 @opindex frepo
2591 Enable automatic template instantiation at link time.  This option also
2592 implies @option{-fno-implicit-templates}.  @xref{Template
2593 Instantiation}, for more information.
2595 @item -fno-rtti
2596 @opindex fno-rtti
2597 Disable generation of information about every class with virtual
2598 functions for use by the C++ run-time type identification features
2599 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2600 of the language, you can save some space by using this flag.  Note that
2601 exception handling uses the same information, but G++ generates it as
2602 needed. The @code{dynamic_cast} operator can still be used for casts that
2603 do not require run-time type information, i.e.@: casts to @code{void *} or to
2604 unambiguous base classes.
2606 @item -fsized-deallocation
2607 @opindex fsized-deallocation
2608 Enable the built-in global declarations
2609 @smallexample
2610 void operator delete (void *, std::size_t) noexcept;
2611 void operator delete[] (void *, std::size_t) noexcept;
2612 @end smallexample
2613 as introduced in C++14.  This is useful for user-defined replacement
2614 deallocation functions that, for example, use the size of the object
2615 to make deallocation faster.  Enabled by default under
2616 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2617 warns about places that might want to add a definition.
2619 @item -fstrict-enums
2620 @opindex fstrict-enums
2621 Allow the compiler to optimize using the assumption that a value of
2622 enumerated type can only be one of the values of the enumeration (as
2623 defined in the C++ standard; basically, a value that can be
2624 represented in the minimum number of bits needed to represent all the
2625 enumerators).  This assumption may not be valid if the program uses a
2626 cast to convert an arbitrary integer value to the enumerated type.
2628 @item -fstrong-eval-order
2629 @opindex fstrong-eval-order
2630 Evaluate member access, array subscripting, and shift expressions in
2631 left-to-right order, and evaluate assignment in right-to-left order,
2632 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2633 @option{-fstrong-eval-order=some} enables just the ordering of member
2634 access and shift expressions, and is the default without
2635 @option{-std=c++17}.
2637 @item -ftemplate-backtrace-limit=@var{n}
2638 @opindex ftemplate-backtrace-limit
2639 Set the maximum number of template instantiation notes for a single
2640 warning or error to @var{n}.  The default value is 10.
2642 @item -ftemplate-depth=@var{n}
2643 @opindex ftemplate-depth
2644 Set the maximum instantiation depth for template classes to @var{n}.
2645 A limit on the template instantiation depth is needed to detect
2646 endless recursions during template class instantiation.  ANSI/ISO C++
2647 conforming programs must not rely on a maximum depth greater than 17
2648 (changed to 1024 in C++11).  The default value is 900, as the compiler
2649 can run out of stack space before hitting 1024 in some situations.
2651 @item -fno-threadsafe-statics
2652 @opindex fno-threadsafe-statics
2653 Do not emit the extra code to use the routines specified in the C++
2654 ABI for thread-safe initialization of local statics.  You can use this
2655 option to reduce code size slightly in code that doesn't need to be
2656 thread-safe.
2658 @item -fuse-cxa-atexit
2659 @opindex fuse-cxa-atexit
2660 Register destructors for objects with static storage duration with the
2661 @code{__cxa_atexit} function rather than the @code{atexit} function.
2662 This option is required for fully standards-compliant handling of static
2663 destructors, but only works if your C library supports
2664 @code{__cxa_atexit}.
2666 @item -fno-use-cxa-get-exception-ptr
2667 @opindex fno-use-cxa-get-exception-ptr
2668 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2669 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2670 if the runtime routine is not available.
2672 @item -fvisibility-inlines-hidden
2673 @opindex fvisibility-inlines-hidden
2674 This switch declares that the user does not attempt to compare
2675 pointers to inline functions or methods where the addresses of the two functions
2676 are taken in different shared objects.
2678 The effect of this is that GCC may, effectively, mark inline methods with
2679 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2680 appear in the export table of a DSO and do not require a PLT indirection
2681 when used within the DSO@.  Enabling this option can have a dramatic effect
2682 on load and link times of a DSO as it massively reduces the size of the
2683 dynamic export table when the library makes heavy use of templates.
2685 The behavior of this switch is not quite the same as marking the
2686 methods as hidden directly, because it does not affect static variables
2687 local to the function or cause the compiler to deduce that
2688 the function is defined in only one shared object.
2690 You may mark a method as having a visibility explicitly to negate the
2691 effect of the switch for that method.  For example, if you do want to
2692 compare pointers to a particular inline method, you might mark it as
2693 having default visibility.  Marking the enclosing class with explicit
2694 visibility has no effect.
2696 Explicitly instantiated inline methods are unaffected by this option
2697 as their linkage might otherwise cross a shared library boundary.
2698 @xref{Template Instantiation}.
2700 @item -fvisibility-ms-compat
2701 @opindex fvisibility-ms-compat
2702 This flag attempts to use visibility settings to make GCC's C++
2703 linkage model compatible with that of Microsoft Visual Studio.
2705 The flag makes these changes to GCC's linkage model:
2707 @enumerate
2708 @item
2709 It sets the default visibility to @code{hidden}, like
2710 @option{-fvisibility=hidden}.
2712 @item
2713 Types, but not their members, are not hidden by default.
2715 @item
2716 The One Definition Rule is relaxed for types without explicit
2717 visibility specifications that are defined in more than one
2718 shared object: those declarations are permitted if they are
2719 permitted when this option is not used.
2720 @end enumerate
2722 In new code it is better to use @option{-fvisibility=hidden} and
2723 export those classes that are intended to be externally visible.
2724 Unfortunately it is possible for code to rely, perhaps accidentally,
2725 on the Visual Studio behavior.
2727 Among the consequences of these changes are that static data members
2728 of the same type with the same name but defined in different shared
2729 objects are different, so changing one does not change the other;
2730 and that pointers to function members defined in different shared
2731 objects may not compare equal.  When this flag is given, it is a
2732 violation of the ODR to define types with the same name differently.
2734 @item -fno-weak
2735 @opindex fno-weak
2736 Do not use weak symbol support, even if it is provided by the linker.
2737 By default, G++ uses weak symbols if they are available.  This
2738 option exists only for testing, and should not be used by end-users;
2739 it results in inferior code and has no benefits.  This option may
2740 be removed in a future release of G++.
2742 @item -nostdinc++
2743 @opindex nostdinc++
2744 Do not search for header files in the standard directories specific to
2745 C++, but do still search the other standard directories.  (This option
2746 is used when building the C++ library.)
2747 @end table
2749 In addition, these optimization, warning, and code generation options
2750 have meanings only for C++ programs:
2752 @table @gcctabopt
2753 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2754 @opindex Wabi
2755 @opindex Wno-abi
2756 Warn when G++ it generates code that is probably not compatible with
2757 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2758 ABI with each major release, normally @option{-Wabi} will warn only if
2759 there is a check added later in a release series for an ABI issue
2760 discovered since the initial release.  @option{-Wabi} will warn about
2761 more things if an older ABI version is selected (with
2762 @option{-fabi-version=@var{n}}).
2764 @option{-Wabi} can also be used with an explicit version number to
2765 warn about compatibility with a particular @option{-fabi-version}
2766 level, e.g. @option{-Wabi=2} to warn about changes relative to
2767 @option{-fabi-version=2}.
2769 If an explicit version number is provided and
2770 @option{-fabi-compat-version} is not specified, the version number
2771 from this option is used for compatibility aliases.  If no explicit
2772 version number is provided with this option, but
2773 @option{-fabi-compat-version} is specified, that version number is
2774 used for ABI warnings.
2776 Although an effort has been made to warn about
2777 all such cases, there are probably some cases that are not warned about,
2778 even though G++ is generating incompatible code.  There may also be
2779 cases where warnings are emitted even though the code that is generated
2780 is compatible.
2782 You should rewrite your code to avoid these warnings if you are
2783 concerned about the fact that code generated by G++ may not be binary
2784 compatible with code generated by other compilers.
2786 Known incompatibilities in @option{-fabi-version=2} (which was the
2787 default from GCC 3.4 to 4.9) include:
2789 @itemize @bullet
2791 @item
2792 A template with a non-type template parameter of reference type was
2793 mangled incorrectly:
2794 @smallexample
2795 extern int N;
2796 template <int &> struct S @{@};
2797 void n (S<N>) @{2@}
2798 @end smallexample
2800 This was fixed in @option{-fabi-version=3}.
2802 @item
2803 SIMD vector types declared using @code{__attribute ((vector_size))} were
2804 mangled in a non-standard way that does not allow for overloading of
2805 functions taking vectors of different sizes.
2807 The mangling was changed in @option{-fabi-version=4}.
2809 @item
2810 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2811 qualifiers, and @code{decltype} of a plain declaration was folded away.
2813 These mangling issues were fixed in @option{-fabi-version=5}.
2815 @item
2816 Scoped enumerators passed as arguments to a variadic function are
2817 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2818 On most targets this does not actually affect the parameter passing
2819 ABI, as there is no way to pass an argument smaller than @code{int}.
2821 Also, the ABI changed the mangling of template argument packs,
2822 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2823 a class scope function used as a template argument.
2825 These issues were corrected in @option{-fabi-version=6}.
2827 @item
2828 Lambdas in default argument scope were mangled incorrectly, and the
2829 ABI changed the mangling of @code{nullptr_t}.
2831 These issues were corrected in @option{-fabi-version=7}.
2833 @item
2834 When mangling a function type with function-cv-qualifiers, the
2835 un-qualified function type was incorrectly treated as a substitution
2836 candidate.
2838 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2840 @item
2841 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2842 unaligned accesses.  Note that this did not affect the ABI of a
2843 function with a @code{nullptr_t} parameter, as parameters have a
2844 minimum alignment.
2846 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2848 @item
2849 Target-specific attributes that affect the identity of a type, such as
2850 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2851 did not affect the mangled name, leading to name collisions when
2852 function pointers were used as template arguments.
2854 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2856 @end itemize
2858 It also warns about psABI-related changes.  The known psABI changes at this
2859 point include:
2861 @itemize @bullet
2863 @item
2864 For SysV/x86-64, unions with @code{long double} members are 
2865 passed in memory as specified in psABI.  For example:
2867 @smallexample
2868 union U @{
2869   long double ld;
2870   int i;
2872 @end smallexample
2874 @noindent
2875 @code{union U} is always passed in memory.
2877 @end itemize
2879 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2880 @opindex Wabi-tag
2881 @opindex -Wabi-tag
2882 Warn when a type with an ABI tag is used in a context that does not
2883 have that ABI tag.  See @ref{C++ Attributes} for more information
2884 about ABI tags.
2886 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2887 @opindex Wctor-dtor-privacy
2888 @opindex Wno-ctor-dtor-privacy
2889 Warn when a class seems unusable because all the constructors or
2890 destructors in that class are private, and it has neither friends nor
2891 public static member functions.  Also warn if there are no non-private
2892 methods, and there's at least one private member function that isn't
2893 a constructor or destructor.
2895 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2896 @opindex Wdelete-non-virtual-dtor
2897 @opindex Wno-delete-non-virtual-dtor
2898 Warn when @code{delete} is used to destroy an instance of a class that
2899 has virtual functions and non-virtual destructor. It is unsafe to delete
2900 an instance of a derived class through a pointer to a base class if the
2901 base class does not have a virtual destructor.  This warning is enabled
2902 by @option{-Wall}.
2904 @item -Wdeprecated-copy @r{(C++ and Objective-C++ only)}
2905 @opindex Wdeprecated-copy
2906 @opindex Wno-deprecated-copy
2907 Warn that the implicit declaration of a copy constructor or copy
2908 assignment operator is deprecated if the class has a user-provided
2909 copy constructor, copy assignment operator, or destructor, in C++11
2910 and up.  This warning is enabled by @option{-Wall}.
2912 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2913 @opindex Wliteral-suffix
2914 @opindex Wno-literal-suffix
2915 Warn when a string or character literal is followed by a ud-suffix which does
2916 not begin with an underscore.  As a conforming extension, GCC treats such
2917 suffixes as separate preprocessing tokens in order to maintain backwards
2918 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2919 For example:
2921 @smallexample
2922 #define __STDC_FORMAT_MACROS
2923 #include <inttypes.h>
2924 #include <stdio.h>
2926 int main() @{
2927   int64_t i64 = 123;
2928   printf("My int64: %" PRId64"\n", i64);
2930 @end smallexample
2932 In this case, @code{PRId64} is treated as a separate preprocessing token.
2934 Additionally, warn when a user-defined literal operator is declared with
2935 a literal suffix identifier that doesn't begin with an underscore. Literal
2936 suffix identifiers that don't begin with an underscore are reserved for
2937 future standardization.
2939 This warning is enabled by default.
2941 @item -Wlto-type-mismatch
2942 @opindex Wlto-type-mismatch
2943 @opindex Wno-lto-type-mismatch
2945 During the link-time optimization warn about type mismatches in
2946 global declarations from different compilation units.
2947 Requires @option{-flto} to be enabled.  Enabled by default.
2949 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2950 @opindex Wnarrowing
2951 @opindex Wno-narrowing
2952 For C++11 and later standards, narrowing conversions are diagnosed by default,
2953 as required by the standard.  A narrowing conversion from a constant produces
2954 an error, and a narrowing conversion from a non-constant produces a warning,
2955 but @option{-Wno-narrowing} suppresses the diagnostic.
2956 Note that this does not affect the meaning of well-formed code;
2957 narrowing conversions are still considered ill-formed in SFINAE contexts.
2959 With @option{-Wnarrowing} in C++98, warn when a narrowing
2960 conversion prohibited by C++11 occurs within
2961 @samp{@{ @}}, e.g.
2963 @smallexample
2964 int i = @{ 2.2 @}; // error: narrowing from double to int
2965 @end smallexample
2967 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2969 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2970 @opindex Wnoexcept
2971 @opindex Wno-noexcept
2972 Warn when a noexcept-expression evaluates to false because of a call
2973 to a function that does not have a non-throwing exception
2974 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2975 the compiler to never throw an exception.
2977 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2978 @opindex Wnoexcept-type
2979 @opindex Wno-noexcept-type
2980 Warn if the C++17 feature making @code{noexcept} part of a function
2981 type changes the mangled name of a symbol relative to C++14.  Enabled
2982 by @option{-Wabi} and @option{-Wc++17-compat}.
2984 As an example:
2986 @smallexample
2987 template <class T> void f(T t) @{ t(); @};
2988 void g() noexcept;
2989 void h() @{ f(g); @} 
2990 @end smallexample
2992 @noindent
2993 In C++14, @code{f} calls calls @code{f<void(*)()>}, but in
2994 C++17 it calls @code{f<void(*)()noexcept>}.
2996 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2997 @opindex Wclass-memaccess
2998 Warn when the destination of a call to a raw memory function such as
2999 @code{memset} or @code{memcpy} is an object of class type, and when writing
3000 into such an object might bypass the class non-trivial or deleted constructor
3001 or copy assignment, violate const-correctness or encapsulation, or corrupt
3002 virtual table pointers.  Modifying the representation of such objects may
3003 violate invariants maintained by member functions of the class.  For example,
3004 the call to @code{memset} below is undefined because it modifies a non-trivial
3005 class object and is, therefore, diagnosed.  The safe way to either initialize
3006 or clear the storage of objects of such types is by using the appropriate
3007 constructor or assignment operator, if one is available.
3008 @smallexample
3009 std::string str = "abc";
3010 memset (&str, 0, sizeof str);
3011 @end smallexample
3012 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
3013 Explicitly casting the pointer to the class object to @code{void *} or
3014 to a type that can be safely accessed by the raw memory function suppresses
3015 the warning.
3017 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
3018 @opindex Wnon-virtual-dtor
3019 @opindex Wno-non-virtual-dtor
3020 Warn when a class has virtual functions and an accessible non-virtual
3021 destructor itself or in an accessible polymorphic base class, in which
3022 case it is possible but unsafe to delete an instance of a derived
3023 class through a pointer to the class itself or base class.  This
3024 warning is automatically enabled if @option{-Weffc++} is specified.
3026 @item -Wregister @r{(C++ and Objective-C++ only)}
3027 @opindex Wregister
3028 @opindex Wno-register
3029 Warn on uses of the @code{register} storage class specifier, except
3030 when it is part of the GNU @ref{Explicit Register Variables} extension.
3031 The use of the @code{register} keyword as storage class specifier has
3032 been deprecated in C++11 and removed in C++17.
3033 Enabled by default with @option{-std=c++17}.
3035 @item -Wreorder @r{(C++ and Objective-C++ only)}
3036 @opindex Wreorder
3037 @opindex Wno-reorder
3038 @cindex reordering, warning
3039 @cindex warning for reordering of member initializers
3040 Warn when the order of member initializers given in the code does not
3041 match the order in which they must be executed.  For instance:
3043 @smallexample
3044 struct A @{
3045   int i;
3046   int j;
3047   A(): j (0), i (1) @{ @}
3049 @end smallexample
3051 @noindent
3052 The compiler rearranges the member initializers for @code{i}
3053 and @code{j} to match the declaration order of the members, emitting
3054 a warning to that effect.  This warning is enabled by @option{-Wall}.
3056 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3057 @opindex fext-numeric-literals
3058 @opindex fno-ext-numeric-literals
3059 Accept imaginary, fixed-point, or machine-defined
3060 literal number suffixes as GNU extensions.
3061 When this option is turned off these suffixes are treated
3062 as C++11 user-defined literal numeric suffixes.
3063 This is on by default for all pre-C++11 dialects and all GNU dialects:
3064 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3065 @option{-std=gnu++14}.
3066 This option is off by default
3067 for ISO C++11 onwards (@option{-std=c++11}, ...).
3068 @end table
3070 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3072 @table @gcctabopt
3073 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3074 @opindex Weffc++
3075 @opindex Wno-effc++
3076 Warn about violations of the following style guidelines from Scott Meyers'
3077 @cite{Effective C++} series of books:
3079 @itemize @bullet
3080 @item
3081 Define a copy constructor and an assignment operator for classes
3082 with dynamically-allocated memory.
3084 @item
3085 Prefer initialization to assignment in constructors.
3087 @item
3088 Have @code{operator=} return a reference to @code{*this}.
3090 @item
3091 Don't try to return a reference when you must return an object.
3093 @item
3094 Distinguish between prefix and postfix forms of increment and
3095 decrement operators.
3097 @item
3098 Never overload @code{&&}, @code{||}, or @code{,}.
3100 @end itemize
3102 This option also enables @option{-Wnon-virtual-dtor}, which is also
3103 one of the effective C++ recommendations.  However, the check is
3104 extended to warn about the lack of virtual destructor in accessible
3105 non-polymorphic bases classes too.
3107 When selecting this option, be aware that the standard library
3108 headers do not obey all of these guidelines; use @samp{grep -v}
3109 to filter out those warnings.
3111 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3112 @opindex Wstrict-null-sentinel
3113 @opindex Wno-strict-null-sentinel
3114 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3115 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3116 to @code{__null}.  Although it is a null pointer constant rather than a
3117 null pointer, it is guaranteed to be of the same size as a pointer.
3118 But this use is not portable across different compilers.
3120 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3121 @opindex Wno-non-template-friend
3122 @opindex Wnon-template-friend
3123 Disable warnings when non-template friend functions are declared
3124 within a template.  In very old versions of GCC that predate implementation
3125 of the ISO standard, declarations such as 
3126 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3127 could be interpreted as a particular specialization of a template
3128 function; the warning exists to diagnose compatibility problems, 
3129 and is enabled by default.
3131 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3132 @opindex Wold-style-cast
3133 @opindex Wno-old-style-cast
3134 Warn if an old-style (C-style) cast to a non-void type is used within
3135 a C++ program.  The new-style casts (@code{dynamic_cast},
3136 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3137 less vulnerable to unintended effects and much easier to search for.
3139 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3140 @opindex Woverloaded-virtual
3141 @opindex Wno-overloaded-virtual
3142 @cindex overloaded virtual function, warning
3143 @cindex warning for overloaded virtual function
3144 Warn when a function declaration hides virtual functions from a
3145 base class.  For example, in:
3147 @smallexample
3148 struct A @{
3149   virtual void f();
3152 struct B: public A @{
3153   void f(int);
3155 @end smallexample
3157 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3158 like:
3160 @smallexample
3161 B* b;
3162 b->f();
3163 @end smallexample
3165 @noindent
3166 fails to compile.
3168 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3169 @opindex Wno-pmf-conversions
3170 @opindex Wpmf-conversions
3171 Disable the diagnostic for converting a bound pointer to member function
3172 to a plain pointer.
3174 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3175 @opindex Wsign-promo
3176 @opindex Wno-sign-promo
3177 Warn when overload resolution chooses a promotion from unsigned or
3178 enumerated type to a signed type, over a conversion to an unsigned type of
3179 the same size.  Previous versions of G++ tried to preserve
3180 unsignedness, but the standard mandates the current behavior.
3182 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3183 @opindex Wtemplates
3184 Warn when a primary template declaration is encountered.  Some coding
3185 rules disallow templates, and this may be used to enforce that rule.
3186 The warning is inactive inside a system header file, such as the STL, so
3187 one can still use the STL.  One may also instantiate or specialize
3188 templates.
3190 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3191 @opindex Wmultiple-inheritance
3192 Warn when a class is defined with multiple direct base classes.  Some
3193 coding rules disallow multiple inheritance, and this may be used to
3194 enforce that rule.  The warning is inactive inside a system header file,
3195 such as the STL, so one can still use the STL.  One may also define
3196 classes that indirectly use multiple inheritance.
3198 @item -Wvirtual-inheritance
3199 @opindex Wvirtual-inheritance
3200 Warn when a class is defined with a virtual direct base class.  Some
3201 coding rules disallow multiple inheritance, and this may be used to
3202 enforce that rule.  The warning is inactive inside a system header file,
3203 such as the STL, so one can still use the STL.  One may also define
3204 classes that indirectly use virtual inheritance.
3206 @item -Wnamespaces
3207 @opindex Wnamespaces
3208 Warn when a namespace definition is opened.  Some coding rules disallow
3209 namespaces, and this may be used to enforce that rule.  The warning is
3210 inactive inside a system header file, such as the STL, so one can still
3211 use the STL.  One may also use using directives and qualified names.
3213 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3214 @opindex Wterminate
3215 @opindex Wno-terminate
3216 Disable the warning about a throw-expression that will immediately
3217 result in a call to @code{terminate}.
3218 @end table
3220 @node Objective-C and Objective-C++ Dialect Options
3221 @section Options Controlling Objective-C and Objective-C++ Dialects
3223 @cindex compiler options, Objective-C and Objective-C++
3224 @cindex Objective-C and Objective-C++ options, command-line
3225 @cindex options, Objective-C and Objective-C++
3226 (NOTE: This manual does not describe the Objective-C and Objective-C++
3227 languages themselves.  @xref{Standards,,Language Standards
3228 Supported by GCC}, for references.)
3230 This section describes the command-line options that are only meaningful
3231 for Objective-C and Objective-C++ programs.  You can also use most of
3232 the language-independent GNU compiler options.
3233 For example, you might compile a file @file{some_class.m} like this:
3235 @smallexample
3236 gcc -g -fgnu-runtime -O -c some_class.m
3237 @end smallexample
3239 @noindent
3240 In this example, @option{-fgnu-runtime} is an option meant only for
3241 Objective-C and Objective-C++ programs; you can use the other options with
3242 any language supported by GCC@.
3244 Note that since Objective-C is an extension of the C language, Objective-C
3245 compilations may also use options specific to the C front-end (e.g.,
3246 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3247 C++-specific options (e.g., @option{-Wabi}).
3249 Here is a list of options that are @emph{only} for compiling Objective-C
3250 and Objective-C++ programs:
3252 @table @gcctabopt
3253 @item -fconstant-string-class=@var{class-name}
3254 @opindex fconstant-string-class
3255 Use @var{class-name} as the name of the class to instantiate for each
3256 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3257 class name is @code{NXConstantString} if the GNU runtime is being used, and
3258 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3259 @option{-fconstant-cfstrings} option, if also present, overrides the
3260 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3261 to be laid out as constant CoreFoundation strings.
3263 @item -fgnu-runtime
3264 @opindex fgnu-runtime
3265 Generate object code compatible with the standard GNU Objective-C
3266 runtime.  This is the default for most types of systems.
3268 @item -fnext-runtime
3269 @opindex fnext-runtime
3270 Generate output compatible with the NeXT runtime.  This is the default
3271 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3272 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3273 used.
3275 @item -fno-nil-receivers
3276 @opindex fno-nil-receivers
3277 Assume that all Objective-C message dispatches (@code{[receiver
3278 message:arg]}) in this translation unit ensure that the receiver is
3279 not @code{nil}.  This allows for more efficient entry points in the
3280 runtime to be used.  This option is only available in conjunction with
3281 the NeXT runtime and ABI version 0 or 1.
3283 @item -fobjc-abi-version=@var{n}
3284 @opindex fobjc-abi-version
3285 Use version @var{n} of the Objective-C ABI for the selected runtime.
3286 This option is currently supported only for the NeXT runtime.  In that
3287 case, Version 0 is the traditional (32-bit) ABI without support for
3288 properties and other Objective-C 2.0 additions.  Version 1 is the
3289 traditional (32-bit) ABI with support for properties and other
3290 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3291 nothing is specified, the default is Version 0 on 32-bit target
3292 machines, and Version 2 on 64-bit target machines.
3294 @item -fobjc-call-cxx-cdtors
3295 @opindex fobjc-call-cxx-cdtors
3296 For each Objective-C class, check if any of its instance variables is a
3297 C++ object with a non-trivial default constructor.  If so, synthesize a
3298 special @code{- (id) .cxx_construct} instance method which runs
3299 non-trivial default constructors on any such instance variables, in order,
3300 and then return @code{self}.  Similarly, check if any instance variable
3301 is a C++ object with a non-trivial destructor, and if so, synthesize a
3302 special @code{- (void) .cxx_destruct} method which runs
3303 all such default destructors, in reverse order.
3305 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3306 methods thusly generated only operate on instance variables
3307 declared in the current Objective-C class, and not those inherited
3308 from superclasses.  It is the responsibility of the Objective-C
3309 runtime to invoke all such methods in an object's inheritance
3310 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3311 by the runtime immediately after a new object instance is allocated;
3312 the @code{- (void) .cxx_destruct} methods are invoked immediately
3313 before the runtime deallocates an object instance.
3315 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3316 support for invoking the @code{- (id) .cxx_construct} and
3317 @code{- (void) .cxx_destruct} methods.
3319 @item -fobjc-direct-dispatch
3320 @opindex fobjc-direct-dispatch
3321 Allow fast jumps to the message dispatcher.  On Darwin this is
3322 accomplished via the comm page.
3324 @item -fobjc-exceptions
3325 @opindex fobjc-exceptions
3326 Enable syntactic support for structured exception handling in
3327 Objective-C, similar to what is offered by C++.  This option
3328 is required to use the Objective-C keywords @code{@@try},
3329 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3330 @code{@@synchronized}.  This option is available with both the GNU
3331 runtime and the NeXT runtime (but not available in conjunction with
3332 the NeXT runtime on Mac OS X 10.2 and earlier).
3334 @item -fobjc-gc
3335 @opindex fobjc-gc
3336 Enable garbage collection (GC) in Objective-C and Objective-C++
3337 programs.  This option is only available with the NeXT runtime; the
3338 GNU runtime has a different garbage collection implementation that
3339 does not require special compiler flags.
3341 @item -fobjc-nilcheck
3342 @opindex fobjc-nilcheck
3343 For the NeXT runtime with version 2 of the ABI, check for a nil
3344 receiver in method invocations before doing the actual method call.
3345 This is the default and can be disabled using
3346 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3347 checked for nil in this way no matter what this flag is set to.
3348 Currently this flag does nothing when the GNU runtime, or an older
3349 version of the NeXT runtime ABI, is used.
3351 @item -fobjc-std=objc1
3352 @opindex fobjc-std
3353 Conform to the language syntax of Objective-C 1.0, the language
3354 recognized by GCC 4.0.  This only affects the Objective-C additions to
3355 the C/C++ language; it does not affect conformance to C/C++ standards,
3356 which is controlled by the separate C/C++ dialect option flags.  When
3357 this option is used with the Objective-C or Objective-C++ compiler,
3358 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3359 This is useful if you need to make sure that your Objective-C code can
3360 be compiled with older versions of GCC@.
3362 @item -freplace-objc-classes
3363 @opindex freplace-objc-classes
3364 Emit a special marker instructing @command{ld(1)} not to statically link in
3365 the resulting object file, and allow @command{dyld(1)} to load it in at
3366 run time instead.  This is used in conjunction with the Fix-and-Continue
3367 debugging mode, where the object file in question may be recompiled and
3368 dynamically reloaded in the course of program execution, without the need
3369 to restart the program itself.  Currently, Fix-and-Continue functionality
3370 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3371 and later.
3373 @item -fzero-link
3374 @opindex fzero-link
3375 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3376 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3377 compile time) with static class references that get initialized at load time,
3378 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3379 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3380 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3381 for individual class implementations to be modified during program execution.
3382 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3383 regardless of command-line options.
3385 @item -fno-local-ivars
3386 @opindex fno-local-ivars
3387 @opindex flocal-ivars
3388 By default instance variables in Objective-C can be accessed as if
3389 they were local variables from within the methods of the class they're
3390 declared in.  This can lead to shadowing between instance variables
3391 and other variables declared either locally inside a class method or
3392 globally with the same name.  Specifying the @option{-fno-local-ivars}
3393 flag disables this behavior thus avoiding variable shadowing issues.
3395 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3396 @opindex fivar-visibility
3397 Set the default instance variable visibility to the specified option
3398 so that instance variables declared outside the scope of any access
3399 modifier directives default to the specified visibility.
3401 @item -gen-decls
3402 @opindex gen-decls
3403 Dump interface declarations for all classes seen in the source file to a
3404 file named @file{@var{sourcename}.decl}.
3406 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3407 @opindex Wassign-intercept
3408 @opindex Wno-assign-intercept
3409 Warn whenever an Objective-C assignment is being intercepted by the
3410 garbage collector.
3412 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3413 @opindex Wno-protocol
3414 @opindex Wprotocol
3415 If a class is declared to implement a protocol, a warning is issued for
3416 every method in the protocol that is not implemented by the class.  The
3417 default behavior is to issue a warning for every method not explicitly
3418 implemented in the class, even if a method implementation is inherited
3419 from the superclass.  If you use the @option{-Wno-protocol} option, then
3420 methods inherited from the superclass are considered to be implemented,
3421 and no warning is issued for them.
3423 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3424 @opindex Wselector
3425 @opindex Wno-selector
3426 Warn if multiple methods of different types for the same selector are
3427 found during compilation.  The check is performed on the list of methods
3428 in the final stage of compilation.  Additionally, a check is performed
3429 for each selector appearing in a @code{@@selector(@dots{})}
3430 expression, and a corresponding method for that selector has been found
3431 during compilation.  Because these checks scan the method table only at
3432 the end of compilation, these warnings are not produced if the final
3433 stage of compilation is not reached, for example because an error is
3434 found during compilation, or because the @option{-fsyntax-only} option is
3435 being used.
3437 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3438 @opindex Wstrict-selector-match
3439 @opindex Wno-strict-selector-match
3440 Warn if multiple methods with differing argument and/or return types are
3441 found for a given selector when attempting to send a message using this
3442 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3443 is off (which is the default behavior), the compiler omits such warnings
3444 if any differences found are confined to types that share the same size
3445 and alignment.
3447 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3448 @opindex Wundeclared-selector
3449 @opindex Wno-undeclared-selector
3450 Warn if a @code{@@selector(@dots{})} expression referring to an
3451 undeclared selector is found.  A selector is considered undeclared if no
3452 method with that name has been declared before the
3453 @code{@@selector(@dots{})} expression, either explicitly in an
3454 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3455 an @code{@@implementation} section.  This option always performs its
3456 checks as soon as a @code{@@selector(@dots{})} expression is found,
3457 while @option{-Wselector} only performs its checks in the final stage of
3458 compilation.  This also enforces the coding style convention
3459 that methods and selectors must be declared before being used.
3461 @item -print-objc-runtime-info
3462 @opindex print-objc-runtime-info
3463 Generate C header describing the largest structure that is passed by
3464 value, if any.
3466 @end table
3468 @node Diagnostic Message Formatting Options
3469 @section Options to Control Diagnostic Messages Formatting
3470 @cindex options to control diagnostics formatting
3471 @cindex diagnostic messages
3472 @cindex message formatting
3474 Traditionally, diagnostic messages have been formatted irrespective of
3475 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3476 options described below
3477 to control the formatting algorithm for diagnostic messages, 
3478 e.g.@: how many characters per line, how often source location
3479 information should be reported.  Note that some language front ends may not
3480 honor these options.
3482 @table @gcctabopt
3483 @item -fmessage-length=@var{n}
3484 @opindex fmessage-length
3485 Try to format error messages so that they fit on lines of about
3486 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3487 done; each error message appears on a single line.  This is the
3488 default for all front ends.
3490 @item -fdiagnostics-show-location=once
3491 @opindex fdiagnostics-show-location
3492 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3493 reporter to emit source location information @emph{once}; that is, in
3494 case the message is too long to fit on a single physical line and has to
3495 be wrapped, the source location won't be emitted (as prefix) again,
3496 over and over, in subsequent continuation lines.  This is the default
3497 behavior.
3499 @item -fdiagnostics-show-location=every-line
3500 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3501 messages reporter to emit the same source location information (as
3502 prefix) for physical lines that result from the process of breaking
3503 a message which is too long to fit on a single line.
3505 @item -fdiagnostics-color[=@var{WHEN}]
3506 @itemx -fno-diagnostics-color
3507 @opindex fdiagnostics-color
3508 @cindex highlight, color
3509 @vindex GCC_COLORS @r{environment variable}
3510 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3511 or @samp{auto}.  The default depends on how the compiler has been configured,
3512 it can be any of the above @var{WHEN} options or also @samp{never}
3513 if @env{GCC_COLORS} environment variable isn't present in the environment,
3514 and @samp{auto} otherwise.
3515 @samp{auto} means to use color only when the standard error is a terminal.
3516 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3517 aliases for @option{-fdiagnostics-color=always} and
3518 @option{-fdiagnostics-color=never}, respectively.
3520 The colors are defined by the environment variable @env{GCC_COLORS}.
3521 Its value is a colon-separated list of capabilities and Select Graphic
3522 Rendition (SGR) substrings. SGR commands are interpreted by the
3523 terminal or terminal emulator.  (See the section in the documentation
3524 of your text terminal for permitted values and their meanings as
3525 character attributes.)  These substring values are integers in decimal
3526 representation and can be concatenated with semicolons.
3527 Common values to concatenate include
3528 @samp{1} for bold,
3529 @samp{4} for underline,
3530 @samp{5} for blink,
3531 @samp{7} for inverse,
3532 @samp{39} for default foreground color,
3533 @samp{30} to @samp{37} for foreground colors,
3534 @samp{90} to @samp{97} for 16-color mode foreground colors,
3535 @samp{38;5;0} to @samp{38;5;255}
3536 for 88-color and 256-color modes foreground colors,
3537 @samp{49} for default background color,
3538 @samp{40} to @samp{47} for background colors,
3539 @samp{100} to @samp{107} for 16-color mode background colors,
3540 and @samp{48;5;0} to @samp{48;5;255}
3541 for 88-color and 256-color modes background colors.
3543 The default @env{GCC_COLORS} is
3544 @smallexample
3545 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3546 quote=01:fixit-insert=32:fixit-delete=31:\
3547 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3548 type-diff=01;32
3549 @end smallexample
3550 @noindent
3551 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3552 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3553 @samp{01} is bold, and @samp{31} is red.
3554 Setting @env{GCC_COLORS} to the empty string disables colors.
3555 Supported capabilities are as follows.
3557 @table @code
3558 @item error=
3559 @vindex error GCC_COLORS @r{capability}
3560 SGR substring for error: markers.
3562 @item warning=
3563 @vindex warning GCC_COLORS @r{capability}
3564 SGR substring for warning: markers.
3566 @item note=
3567 @vindex note GCC_COLORS @r{capability}
3568 SGR substring for note: markers.
3570 @item range1=
3571 @vindex range1 GCC_COLORS @r{capability}
3572 SGR substring for first additional range.
3574 @item range2=
3575 @vindex range2 GCC_COLORS @r{capability}
3576 SGR substring for second additional range.
3578 @item locus=
3579 @vindex locus GCC_COLORS @r{capability}
3580 SGR substring for location information, @samp{file:line} or
3581 @samp{file:line:column} etc.
3583 @item quote=
3584 @vindex quote GCC_COLORS @r{capability}
3585 SGR substring for information printed within quotes.
3587 @item fixit-insert=
3588 @vindex fixit-insert GCC_COLORS @r{capability}
3589 SGR substring for fix-it hints suggesting text to
3590 be inserted or replaced.
3592 @item fixit-delete=
3593 @vindex fixit-delete GCC_COLORS @r{capability}
3594 SGR substring for fix-it hints suggesting text to
3595 be deleted.
3597 @item diff-filename=
3598 @vindex diff-filename GCC_COLORS @r{capability}
3599 SGR substring for filename headers within generated patches.
3601 @item diff-hunk=
3602 @vindex diff-hunk GCC_COLORS @r{capability}
3603 SGR substring for the starts of hunks within generated patches.
3605 @item diff-delete=
3606 @vindex diff-delete GCC_COLORS @r{capability}
3607 SGR substring for deleted lines within generated patches.
3609 @item diff-insert=
3610 @vindex diff-insert GCC_COLORS @r{capability}
3611 SGR substring for inserted lines within generated patches.
3613 @item type-diff=
3614 @vindex type-diff GCC_COLORS @r{capability}
3615 SGR substring for highlighting mismatching types within template
3616 arguments in the C++ frontend.
3617 @end table
3619 @item -fno-diagnostics-show-option
3620 @opindex fno-diagnostics-show-option
3621 @opindex fdiagnostics-show-option
3622 By default, each diagnostic emitted includes text indicating the
3623 command-line option that directly controls the diagnostic (if such an
3624 option is known to the diagnostic machinery).  Specifying the
3625 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3627 @item -fno-diagnostics-show-caret
3628 @opindex fno-diagnostics-show-caret
3629 @opindex fdiagnostics-show-caret
3630 By default, each diagnostic emitted includes the original source line
3631 and a caret @samp{^} indicating the column.  This option suppresses this
3632 information.  The source line is truncated to @var{n} characters, if
3633 the @option{-fmessage-length=n} option is given.  When the output is done
3634 to the terminal, the width is limited to the width given by the
3635 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3637 @item -fdiagnostics-parseable-fixits
3638 @opindex fdiagnostics-parseable-fixits
3639 Emit fix-it hints in a machine-parseable format, suitable for consumption
3640 by IDEs.  For each fix-it, a line will be printed after the relevant
3641 diagnostic, starting with the string ``fix-it:''.  For example:
3643 @smallexample
3644 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3645 @end smallexample
3647 The location is expressed as a half-open range, expressed as a count of
3648 bytes, starting at byte 1 for the initial column.  In the above example,
3649 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3650 given string:
3652 @smallexample
3653 00000000011111111112222222222
3654 12345678901234567890123456789
3655   gtk_widget_showall (dlg);
3656   ^^^^^^^^^^^^^^^^^^
3657   gtk_widget_show_all
3658 @end smallexample
3660 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3661 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3662 (e.g. vertical tab as ``\013'').
3664 An empty replacement string indicates that the given range is to be removed.
3665 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3666 be inserted at the given position.
3668 @item -fdiagnostics-generate-patch
3669 @opindex fdiagnostics-generate-patch
3670 Print fix-it hints to stderr in unified diff format, after any diagnostics
3671 are printed.  For example:
3673 @smallexample
3674 --- test.c
3675 +++ test.c
3676 @@ -42,5 +42,5 @@
3678  void show_cb(GtkDialog *dlg)
3679  @{
3680 -  gtk_widget_showall(dlg);
3681 +  gtk_widget_show_all(dlg);
3682  @}
3684 @end smallexample
3686 The diff may or may not be colorized, following the same rules
3687 as for diagnostics (see @option{-fdiagnostics-color}).
3689 @item -fdiagnostics-show-template-tree
3690 @opindex fdiagnostics-show-template-tree
3692 In the C++ frontend, when printing diagnostics showing mismatching
3693 template types, such as:
3695 @smallexample
3696   could not convert 'std::map<int, std::vector<double> >()'
3697     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3698 @end smallexample
3700 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3701 tree-like structure showing the common and differing parts of the types,
3702 such as:
3704 @smallexample
3705   map<
3706     [...],
3707     vector<
3708       [double != float]>>
3709 @end smallexample
3711 The parts that differ are highlighted with color (``double'' and
3712 ``float'' in this case).
3714 @item -fno-elide-type
3715 @opindex fno-elide-type
3716 @opindex felide-type
3717 By default when the C++ frontend prints diagnostics showing mismatching
3718 template types, common parts of the types are printed as ``[...]'' to
3719 simplify the error message.  For example:
3721 @smallexample
3722   could not convert 'std::map<int, std::vector<double> >()'
3723     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3724 @end smallexample
3726 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3727 This flag also affects the output of the
3728 @option{-fdiagnostics-show-template-tree} flag.
3730 @item -fno-show-column
3731 @opindex fno-show-column
3732 Do not print column numbers in diagnostics.  This may be necessary if
3733 diagnostics are being scanned by a program that does not understand the
3734 column numbers, such as @command{dejagnu}.
3736 @end table
3738 @node Warning Options
3739 @section Options to Request or Suppress Warnings
3740 @cindex options to control warnings
3741 @cindex warning messages
3742 @cindex messages, warning
3743 @cindex suppressing warnings
3745 Warnings are diagnostic messages that report constructions that
3746 are not inherently erroneous but that are risky or suggest there
3747 may have been an error.
3749 The following language-independent options do not enable specific
3750 warnings but control the kinds of diagnostics produced by GCC@.
3752 @table @gcctabopt
3753 @cindex syntax checking
3754 @item -fsyntax-only
3755 @opindex fsyntax-only
3756 Check the code for syntax errors, but don't do anything beyond that.
3758 @item -fmax-errors=@var{n}
3759 @opindex fmax-errors
3760 Limits the maximum number of error messages to @var{n}, at which point
3761 GCC bails out rather than attempting to continue processing the source
3762 code.  If @var{n} is 0 (the default), there is no limit on the number
3763 of error messages produced.  If @option{-Wfatal-errors} is also
3764 specified, then @option{-Wfatal-errors} takes precedence over this
3765 option.
3767 @item -w
3768 @opindex w
3769 Inhibit all warning messages.
3771 @item -Werror
3772 @opindex Werror
3773 @opindex Wno-error
3774 Make all warnings into errors.
3776 @item -Werror=
3777 @opindex Werror=
3778 @opindex Wno-error=
3779 Make the specified warning into an error.  The specifier for a warning
3780 is appended; for example @option{-Werror=switch} turns the warnings
3781 controlled by @option{-Wswitch} into errors.  This switch takes a
3782 negative form, to be used to negate @option{-Werror} for specific
3783 warnings; for example @option{-Wno-error=switch} makes
3784 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3785 is in effect.
3787 The warning message for each controllable warning includes the
3788 option that controls the warning.  That option can then be used with
3789 @option{-Werror=} and @option{-Wno-error=} as described above.
3790 (Printing of the option in the warning message can be disabled using the
3791 @option{-fno-diagnostics-show-option} flag.)
3793 Note that specifying @option{-Werror=}@var{foo} automatically implies
3794 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3795 imply anything.
3797 @item -Wfatal-errors
3798 @opindex Wfatal-errors
3799 @opindex Wno-fatal-errors
3800 This option causes the compiler to abort compilation on the first error
3801 occurred rather than trying to keep going and printing further error
3802 messages.
3804 @end table
3806 You can request many specific warnings with options beginning with
3807 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3808 implicit declarations.  Each of these specific warning options also
3809 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3810 example, @option{-Wno-implicit}.  This manual lists only one of the
3811 two forms, whichever is not the default.  For further
3812 language-specific options also refer to @ref{C++ Dialect Options} and
3813 @ref{Objective-C and Objective-C++ Dialect Options}.
3815 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3816 options, such as @option{-Wunused}, which may turn on further options,
3817 such as @option{-Wunused-value}. The combined effect of positive and
3818 negative forms is that more specific options have priority over less
3819 specific ones, independently of their position in the command-line. For
3820 options of the same specificity, the last one takes effect. Options
3821 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3822 as if they appeared at the end of the command-line.
3824 When an unrecognized warning option is requested (e.g.,
3825 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3826 that the option is not recognized.  However, if the @option{-Wno-} form
3827 is used, the behavior is slightly different: no diagnostic is
3828 produced for @option{-Wno-unknown-warning} unless other diagnostics
3829 are being produced.  This allows the use of new @option{-Wno-} options
3830 with old compilers, but if something goes wrong, the compiler
3831 warns that an unrecognized option is present.
3833 @table @gcctabopt
3834 @item -Wpedantic
3835 @itemx -pedantic
3836 @opindex pedantic
3837 @opindex Wpedantic
3838 Issue all the warnings demanded by strict ISO C and ISO C++;
3839 reject all programs that use forbidden extensions, and some other
3840 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3841 version of the ISO C standard specified by any @option{-std} option used.
3843 Valid ISO C and ISO C++ programs should compile properly with or without
3844 this option (though a rare few require @option{-ansi} or a
3845 @option{-std} option specifying the required version of ISO C)@.  However,
3846 without this option, certain GNU extensions and traditional C and C++
3847 features are supported as well.  With this option, they are rejected.
3849 @option{-Wpedantic} does not cause warning messages for use of the
3850 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3851 warnings are also disabled in the expression that follows
3852 @code{__extension__}.  However, only system header files should use
3853 these escape routes; application programs should avoid them.
3854 @xref{Alternate Keywords}.
3856 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3857 C conformance.  They soon find that it does not do quite what they want:
3858 it finds some non-ISO practices, but not all---only those for which
3859 ISO C @emph{requires} a diagnostic, and some others for which
3860 diagnostics have been added.
3862 A feature to report any failure to conform to ISO C might be useful in
3863 some instances, but would require considerable additional work and would
3864 be quite different from @option{-Wpedantic}.  We don't have plans to
3865 support such a feature in the near future.
3867 Where the standard specified with @option{-std} represents a GNU
3868 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3869 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3870 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3871 where they are required by the base standard.  (It does not make sense
3872 for such warnings to be given only for features not in the specified GNU
3873 C dialect, since by definition the GNU dialects of C include all
3874 features the compiler supports with the given option, and there would be
3875 nothing to warn about.)
3877 @item -pedantic-errors
3878 @opindex pedantic-errors
3879 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3880 requires a diagnostic, in some cases where there is undefined behavior
3881 at compile-time and in some other cases that do not prevent compilation
3882 of programs that are valid according to the standard. This is not
3883 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3884 by this option and not enabled by the latter and vice versa.
3886 @item -Wall
3887 @opindex Wall
3888 @opindex Wno-all
3889 This enables all the warnings about constructions that some users
3890 consider questionable, and that are easy to avoid (or modify to
3891 prevent the warning), even in conjunction with macros.  This also
3892 enables some language-specific warnings described in @ref{C++ Dialect
3893 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3895 @option{-Wall} turns on the following warning flags:
3897 @gccoptlist{-Waddress   @gol
3898 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3899 -Wbool-compare  @gol
3900 -Wbool-operation  @gol
3901 -Wc++11-compat  -Wc++14-compat  @gol
3902 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3903 -Wchar-subscripts  @gol
3904 -Wcomment  @gol
3905 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3906 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3907 -Wformat   @gol
3908 -Wint-in-bool-context  @gol
3909 -Wimplicit @r{(C and Objective-C only)} @gol
3910 -Wimplicit-int @r{(C and Objective-C only)} @gol
3911 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3912 -Winit-self @r{(only for C++)} @gol
3913 -Wlogical-not-parentheses @gol
3914 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3915 -Wmaybe-uninitialized @gol
3916 -Wmemset-elt-size @gol
3917 -Wmemset-transposed-args @gol
3918 -Wmisleading-indentation @r{(only for C/C++)} @gol
3919 -Wmissing-attributes @gol
3920 -Wmissing-braces @r{(only for C/ObjC)} @gol
3921 -Wmultistatement-macros  @gol
3922 -Wnarrowing @r{(only for C++)}  @gol
3923 -Wnonnull  @gol
3924 -Wnonnull-compare  @gol
3925 -Wopenmp-simd @gol
3926 -Wparentheses  @gol
3927 -Wpointer-sign  @gol
3928 -Wreorder   @gol
3929 -Wrestrict   @gol
3930 -Wreturn-type  @gol
3931 -Wsequence-point  @gol
3932 -Wsign-compare @r{(only in C++)}  @gol
3933 -Wsizeof-pointer-div @gol
3934 -Wsizeof-pointer-memaccess @gol
3935 -Wstrict-aliasing  @gol
3936 -Wstrict-overflow=1  @gol
3937 -Wswitch  @gol
3938 -Wtautological-compare  @gol
3939 -Wtrigraphs  @gol
3940 -Wuninitialized  @gol
3941 -Wunknown-pragmas  @gol
3942 -Wunused-function  @gol
3943 -Wunused-label     @gol
3944 -Wunused-value     @gol
3945 -Wunused-variable  @gol
3946 -Wvolatile-register-var @gol
3949 Note that some warning flags are not implied by @option{-Wall}.  Some of
3950 them warn about constructions that users generally do not consider
3951 questionable, but which occasionally you might wish to check for;
3952 others warn about constructions that are necessary or hard to avoid in
3953 some cases, and there is no simple way to modify the code to suppress
3954 the warning. Some of them are enabled by @option{-Wextra} but many of
3955 them must be enabled individually.
3957 @item -Wextra
3958 @opindex W
3959 @opindex Wextra
3960 @opindex Wno-extra
3961 This enables some extra warning flags that are not enabled by
3962 @option{-Wall}. (This option used to be called @option{-W}.  The older
3963 name is still supported, but the newer name is more descriptive.)
3965 @gccoptlist{-Wclobbered  @gol
3966 -Wcast-function-type  @gol
3967 -Wempty-body  @gol
3968 -Wignored-qualifiers @gol
3969 -Wimplicit-fallthrough=3 @gol
3970 -Wmissing-field-initializers  @gol
3971 -Wmissing-parameter-type @r{(C only)}  @gol
3972 -Wold-style-declaration @r{(C only)}  @gol
3973 -Woverride-init  @gol
3974 -Wsign-compare @r{(C only)} @gol
3975 -Wtype-limits  @gol
3976 -Wuninitialized  @gol
3977 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3978 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3979 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3982 The option @option{-Wextra} also prints warning messages for the
3983 following cases:
3985 @itemize @bullet
3987 @item
3988 A pointer is compared against integer zero with @code{<}, @code{<=},
3989 @code{>}, or @code{>=}.
3991 @item
3992 (C++ only) An enumerator and a non-enumerator both appear in a
3993 conditional expression.
3995 @item
3996 (C++ only) Ambiguous virtual bases.
3998 @item
3999 (C++ only) Subscripting an array that has been declared @code{register}.
4001 @item
4002 (C++ only) Taking the address of a variable that has been declared
4003 @code{register}.
4005 @item
4006 (C++ only) A base class is not initialized in the copy constructor
4007 of a derived class.
4009 @end itemize
4011 @item -Wchar-subscripts
4012 @opindex Wchar-subscripts
4013 @opindex Wno-char-subscripts
4014 Warn if an array subscript has type @code{char}.  This is a common cause
4015 of error, as programmers often forget that this type is signed on some
4016 machines.
4017 This warning is enabled by @option{-Wall}.
4019 @item -Wchkp
4020 @opindex Wchkp
4021 Warn about an invalid memory access that is found by Pointer Bounds Checker
4022 (@option{-fcheck-pointer-bounds}).
4024 @item -Wno-coverage-mismatch
4025 @opindex Wno-coverage-mismatch
4026 Warn if feedback profiles do not match when using the
4027 @option{-fprofile-use} option.
4028 If a source file is changed between compiling with @option{-fprofile-gen} and
4029 with @option{-fprofile-use}, the files with the profile feedback can fail
4030 to match the source file and GCC cannot use the profile feedback
4031 information.  By default, this warning is enabled and is treated as an
4032 error.  @option{-Wno-coverage-mismatch} can be used to disable the
4033 warning or @option{-Wno-error=coverage-mismatch} can be used to
4034 disable the error.  Disabling the error for this warning can result in
4035 poorly optimized code and is useful only in the
4036 case of very minor changes such as bug fixes to an existing code-base.
4037 Completely disabling the warning is not recommended.
4039 @item -Wno-cpp
4040 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
4042 Suppress warning messages emitted by @code{#warning} directives.
4044 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
4045 @opindex Wdouble-promotion
4046 @opindex Wno-double-promotion
4047 Give a warning when a value of type @code{float} is implicitly
4048 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
4049 floating-point unit implement @code{float} in hardware, but emulate
4050 @code{double} in software.  On such a machine, doing computations
4051 using @code{double} values is much more expensive because of the
4052 overhead required for software emulation.
4054 It is easy to accidentally do computations with @code{double} because
4055 floating-point literals are implicitly of type @code{double}.  For
4056 example, in:
4057 @smallexample
4058 @group
4059 float area(float radius)
4061    return 3.14159 * radius * radius;
4063 @end group
4064 @end smallexample
4065 the compiler performs the entire computation with @code{double}
4066 because the floating-point literal is a @code{double}.
4068 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4069 @opindex Wduplicate-decl-specifier
4070 @opindex Wno-duplicate-decl-specifier
4071 Warn if a declaration has duplicate @code{const}, @code{volatile},
4072 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4073 @option{-Wall}.
4075 @item -Wformat
4076 @itemx -Wformat=@var{n}
4077 @opindex Wformat
4078 @opindex Wno-format
4079 @opindex ffreestanding
4080 @opindex fno-builtin
4081 @opindex Wformat=
4082 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4083 the arguments supplied have types appropriate to the format string
4084 specified, and that the conversions specified in the format string make
4085 sense.  This includes standard functions, and others specified by format
4086 attributes (@pxref{Function Attributes}), in the @code{printf},
4087 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4088 not in the C standard) families (or other target-specific families).
4089 Which functions are checked without format attributes having been
4090 specified depends on the standard version selected, and such checks of
4091 functions without the attribute specified are disabled by
4092 @option{-ffreestanding} or @option{-fno-builtin}.
4094 The formats are checked against the format features supported by GNU
4095 libc version 2.2.  These include all ISO C90 and C99 features, as well
4096 as features from the Single Unix Specification and some BSD and GNU
4097 extensions.  Other library implementations may not support all these
4098 features; GCC does not support warning about features that go beyond a
4099 particular library's limitations.  However, if @option{-Wpedantic} is used
4100 with @option{-Wformat}, warnings are given about format features not
4101 in the selected standard version (but not for @code{strfmon} formats,
4102 since those are not in any version of the C standard).  @xref{C Dialect
4103 Options,,Options Controlling C Dialect}.
4105 @table @gcctabopt
4106 @item -Wformat=1
4107 @itemx -Wformat
4108 @opindex Wformat
4109 @opindex Wformat=1
4110 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4111 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4112 @option{-Wformat} also checks for null format arguments for several
4113 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4114 aspects of this level of format checking can be disabled by the
4115 options: @option{-Wno-format-contains-nul},
4116 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4117 @option{-Wformat} is enabled by @option{-Wall}.
4119 @item -Wno-format-contains-nul
4120 @opindex Wno-format-contains-nul
4121 @opindex Wformat-contains-nul
4122 If @option{-Wformat} is specified, do not warn about format strings that
4123 contain NUL bytes.
4125 @item -Wno-format-extra-args
4126 @opindex Wno-format-extra-args
4127 @opindex Wformat-extra-args
4128 If @option{-Wformat} is specified, do not warn about excess arguments to a
4129 @code{printf} or @code{scanf} format function.  The C standard specifies
4130 that such arguments are ignored.
4132 Where the unused arguments lie between used arguments that are
4133 specified with @samp{$} operand number specifications, normally
4134 warnings are still given, since the implementation could not know what
4135 type to pass to @code{va_arg} to skip the unused arguments.  However,
4136 in the case of @code{scanf} formats, this option suppresses the
4137 warning if the unused arguments are all pointers, since the Single
4138 Unix Specification says that such unused arguments are allowed.
4140 @item -Wformat-overflow
4141 @itemx -Wformat-overflow=@var{level}
4142 @opindex Wformat-overflow
4143 @opindex Wno-format-overflow
4144 Warn about calls to formatted input/output functions such as @code{sprintf}
4145 and @code{vsprintf} that might overflow the destination buffer.  When the
4146 exact number of bytes written by a format directive cannot be determined
4147 at compile-time it is estimated based on heuristics that depend on the
4148 @var{level} argument and on optimization.  While enabling optimization
4149 will in most cases improve the accuracy of the warning, it may also
4150 result in false positives.
4152 @table @gcctabopt
4153 @item -Wformat-overflow
4154 @itemx -Wformat-overflow=1
4155 @opindex Wformat-overflow
4156 @opindex Wno-format-overflow
4157 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4158 employs a conservative approach that warns only about calls that most
4159 likely overflow the buffer.  At this level, numeric arguments to format
4160 directives with unknown values are assumed to have the value of one, and
4161 strings of unknown length to be empty.  Numeric arguments that are known
4162 to be bounded to a subrange of their type, or string arguments whose output
4163 is bounded either by their directive's precision or by a finite set of
4164 string literals, are assumed to take on the value within the range that
4165 results in the most bytes on output.  For example, the call to @code{sprintf}
4166 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4167 the terminating NUL character (@code{'\0'}) appended by the function
4168 to the destination buffer will be written past its end.  Increasing
4169 the size of the buffer by a single byte is sufficient to avoid the
4170 warning, though it may not be sufficient to avoid the overflow.
4172 @smallexample
4173 void f (int a, int b)
4175   char buf [13];
4176   sprintf (buf, "a = %i, b = %i\n", a, b);
4178 @end smallexample
4180 @item -Wformat-overflow=2
4181 Level @var{2} warns also about calls that might overflow the destination
4182 buffer given an argument of sufficient length or magnitude.  At level
4183 @var{2}, unknown numeric arguments are assumed to have the minimum
4184 representable value for signed types with a precision greater than 1, and
4185 the maximum representable value otherwise.  Unknown string arguments whose
4186 length cannot be assumed to be bounded either by the directive's precision,
4187 or by a finite set of string literals they may evaluate to, or the character
4188 array they may point to, are assumed to be 1 character long.
4190 At level @var{2}, the call in the example above is again diagnosed, but
4191 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4192 @code{%i} directive will write some of its digits beyond the end of
4193 the destination buffer.  To make the call safe regardless of the values
4194 of the two variables, the size of the destination buffer must be increased
4195 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4196 an informational note following the warning.
4198 An alternative to increasing the size of the destination buffer is to
4199 constrain the range of formatted values.  The maximum length of string
4200 arguments can be bounded by specifying the precision in the format
4201 directive.  When numeric arguments of format directives can be assumed
4202 to be bounded by less than the precision of their type, choosing
4203 an appropriate length modifier to the format specifier will reduce
4204 the required buffer size.  For example, if @var{a} and @var{b} in the
4205 example above can be assumed to be within the precision of
4206 the @code{short int} type then using either the @code{%hi} format
4207 directive or casting the argument to @code{short} reduces the maximum
4208 required size of the buffer to 24 bytes.
4210 @smallexample
4211 void f (int a, int b)
4213   char buf [23];
4214   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4216 @end smallexample
4217 @end table
4219 @item -Wno-format-zero-length
4220 @opindex Wno-format-zero-length
4221 @opindex Wformat-zero-length
4222 If @option{-Wformat} is specified, do not warn about zero-length formats.
4223 The C standard specifies that zero-length formats are allowed.
4226 @item -Wformat=2
4227 @opindex Wformat=2
4228 Enable @option{-Wformat} plus additional format checks.  Currently
4229 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4230 -Wformat-y2k}.
4232 @item -Wformat-nonliteral
4233 @opindex Wformat-nonliteral
4234 @opindex Wno-format-nonliteral
4235 If @option{-Wformat} is specified, also warn if the format string is not a
4236 string literal and so cannot be checked, unless the format function
4237 takes its format arguments as a @code{va_list}.
4239 @item -Wformat-security
4240 @opindex Wformat-security
4241 @opindex Wno-format-security
4242 If @option{-Wformat} is specified, also warn about uses of format
4243 functions that represent possible security problems.  At present, this
4244 warns about calls to @code{printf} and @code{scanf} functions where the
4245 format string is not a string literal and there are no format arguments,
4246 as in @code{printf (foo);}.  This may be a security hole if the format
4247 string came from untrusted input and contains @samp{%n}.  (This is
4248 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4249 in future warnings may be added to @option{-Wformat-security} that are not
4250 included in @option{-Wformat-nonliteral}.)
4252 @item -Wformat-signedness
4253 @opindex Wformat-signedness
4254 @opindex Wno-format-signedness
4255 If @option{-Wformat} is specified, also warn if the format string
4256 requires an unsigned argument and the argument is signed and vice versa.
4258 @item -Wformat-truncation
4259 @itemx -Wformat-truncation=@var{level}
4260 @opindex Wformat-truncation
4261 @opindex Wno-format-truncation
4262 Warn about calls to formatted input/output functions such as @code{snprintf}
4263 and @code{vsnprintf} that might result in output truncation.  When the exact
4264 number of bytes written by a format directive cannot be determined at
4265 compile-time it is estimated based on heuristics that depend on
4266 the @var{level} argument and on optimization.  While enabling optimization
4267 will in most cases improve the accuracy of the warning, it may also result
4268 in false positives.  Except as noted otherwise, the option uses the same
4269 logic @option{-Wformat-overflow}.
4271 @table @gcctabopt
4272 @item -Wformat-truncation
4273 @itemx -Wformat-truncation=1
4274 @opindex Wformat-truncation
4275 @opindex Wno-format-overflow
4276 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4277 employs a conservative approach that warns only about calls to bounded
4278 functions whose return value is unused and that will most likely result
4279 in output truncation.
4281 @item -Wformat-truncation=2
4282 Level @var{2} warns also about calls to bounded functions whose return
4283 value is used and that might result in truncation given an argument of
4284 sufficient length or magnitude.
4285 @end table
4287 @item -Wformat-y2k
4288 @opindex Wformat-y2k
4289 @opindex Wno-format-y2k
4290 If @option{-Wformat} is specified, also warn about @code{strftime}
4291 formats that may yield only a two-digit year.
4292 @end table
4294 @item -Wnonnull
4295 @opindex Wnonnull
4296 @opindex Wno-nonnull
4297 Warn about passing a null pointer for arguments marked as
4298 requiring a non-null value by the @code{nonnull} function attribute.
4300 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4301 can be disabled with the @option{-Wno-nonnull} option.
4303 @item -Wnonnull-compare
4304 @opindex Wnonnull-compare
4305 @opindex Wno-nonnull-compare
4306 Warn when comparing an argument marked with the @code{nonnull}
4307 function attribute against null inside the function.
4309 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4310 can be disabled with the @option{-Wno-nonnull-compare} option.
4312 @item -Wnull-dereference
4313 @opindex Wnull-dereference
4314 @opindex Wno-null-dereference
4315 Warn if the compiler detects paths that trigger erroneous or
4316 undefined behavior due to dereferencing a null pointer.  This option
4317 is only active when @option{-fdelete-null-pointer-checks} is active,
4318 which is enabled by optimizations in most targets.  The precision of
4319 the warnings depends on the optimization options used.
4321 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4322 @opindex Winit-self
4323 @opindex Wno-init-self
4324 Warn about uninitialized variables that are initialized with themselves.
4325 Note this option can only be used with the @option{-Wuninitialized} option.
4327 For example, GCC warns about @code{i} being uninitialized in the
4328 following snippet only when @option{-Winit-self} has been specified:
4329 @smallexample
4330 @group
4331 int f()
4333   int i = i;
4334   return i;
4336 @end group
4337 @end smallexample
4339 This warning is enabled by @option{-Wall} in C++.
4341 @item -Wimplicit-int @r{(C and Objective-C only)}
4342 @opindex Wimplicit-int
4343 @opindex Wno-implicit-int
4344 Warn when a declaration does not specify a type.
4345 This warning is enabled by @option{-Wall}.
4347 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4348 @opindex Wimplicit-function-declaration
4349 @opindex Wno-implicit-function-declaration
4350 Give a warning whenever a function is used before being declared. In
4351 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4352 enabled by default and it is made into an error by
4353 @option{-pedantic-errors}. This warning is also enabled by
4354 @option{-Wall}.
4356 @item -Wimplicit @r{(C and Objective-C only)}
4357 @opindex Wimplicit
4358 @opindex Wno-implicit
4359 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4360 This warning is enabled by @option{-Wall}.
4362 @item -Wimplicit-fallthrough
4363 @opindex Wimplicit-fallthrough
4364 @opindex Wno-implicit-fallthrough
4365 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4366 and @option{-Wno-implicit-fallthrough} is the same as
4367 @option{-Wimplicit-fallthrough=0}.
4369 @item -Wimplicit-fallthrough=@var{n}
4370 @opindex Wimplicit-fallthrough=
4371 Warn when a switch case falls through.  For example:
4373 @smallexample
4374 @group
4375 switch (cond)
4376   @{
4377   case 1:
4378     a = 1;
4379     break;
4380   case 2:
4381     a = 2;
4382   case 3:
4383     a = 3;
4384     break;
4385   @}
4386 @end group
4387 @end smallexample
4389 This warning does not warn when the last statement of a case cannot
4390 fall through, e.g. when there is a return statement or a call to function
4391 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4392 also takes into account control flow statements, such as ifs, and only
4393 warns when appropriate.  E.g.@:
4395 @smallexample
4396 @group
4397 switch (cond)
4398   @{
4399   case 1:
4400     if (i > 3) @{
4401       bar (5);
4402       break;
4403     @} else if (i < 1) @{
4404       bar (0);
4405     @} else
4406       return;
4407   default:
4408     @dots{}
4409   @}
4410 @end group
4411 @end smallexample
4413 Since there are occasions where a switch case fall through is desirable,
4414 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4415 to be used along with a null statement to suppress this warning that
4416 would normally occur:
4418 @smallexample
4419 @group
4420 switch (cond)
4421   @{
4422   case 1:
4423     bar (0);
4424     __attribute__ ((fallthrough));
4425   default:
4426     @dots{}
4427   @}
4428 @end group
4429 @end smallexample
4431 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4432 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4433 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4434 Instead of these attributes, it is also possible to add a fallthrough comment
4435 to silence the warning.  The whole body of the C or C++ style comment should
4436 match the given regular expressions listed below.  The option argument @var{n}
4437 specifies what kind of comments are accepted:
4439 @itemize @bullet
4441 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4443 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4444 expression, any comment is used as fallthrough comment.
4446 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4447 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4449 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4450 following regular expressions:
4452 @itemize @bullet
4454 @item @code{-fallthrough}
4456 @item @code{@@fallthrough@@}
4458 @item @code{lint -fallthrough[ \t]*}
4460 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4462 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4464 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4466 @end itemize
4468 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4469 following regular expressions:
4471 @itemize @bullet
4473 @item @code{-fallthrough}
4475 @item @code{@@fallthrough@@}
4477 @item @code{lint -fallthrough[ \t]*}
4479 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4481 @end itemize
4483 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4484 fallthrough comments, only attributes disable the warning.
4486 @end itemize
4488 The comment needs to be followed after optional whitespace and other comments
4489 by @code{case} or @code{default} keywords or by a user label that precedes some
4490 @code{case} or @code{default} label.
4492 @smallexample
4493 @group
4494 switch (cond)
4495   @{
4496   case 1:
4497     bar (0);
4498     /* FALLTHRU */
4499   default:
4500     @dots{}
4501   @}
4502 @end group
4503 @end smallexample
4505 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4507 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4508 @opindex Wif-not-aligned
4509 @opindex Wno-if-not-aligned
4510 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4511 should be issued.  This is is enabled by default.
4512 Use @option{-Wno-if-not-aligned} to disable it.
4514 @item -Wignored-qualifiers @r{(C and C++ only)}
4515 @opindex Wignored-qualifiers
4516 @opindex Wno-ignored-qualifiers
4517 Warn if the return type of a function has a type qualifier
4518 such as @code{const}.  For ISO C such a type qualifier has no effect,
4519 since the value returned by a function is not an lvalue.
4520 For C++, the warning is only emitted for scalar types or @code{void}.
4521 ISO C prohibits qualified @code{void} return types on function
4522 definitions, so such return types always receive a warning
4523 even without this option.
4525 This warning is also enabled by @option{-Wextra}.
4527 @item -Wignored-attributes @r{(C and C++ only)}
4528 @opindex Wignored-attributes
4529 @opindex Wno-ignored-attributes
4530 Warn when an attribute is ignored.  This is different from the
4531 @option{-Wattributes} option in that it warns whenever the compiler decides
4532 to drop an attribute, not that the attribute is either unknown, used in a
4533 wrong place, etc.  This warning is enabled by default.
4535 @item -Wmain
4536 @opindex Wmain
4537 @opindex Wno-main
4538 Warn if the type of @code{main} is suspicious.  @code{main} should be
4539 a function with external linkage, returning int, taking either zero
4540 arguments, two, or three arguments of appropriate types.  This warning
4541 is enabled by default in C++ and is enabled by either @option{-Wall}
4542 or @option{-Wpedantic}.
4544 @item -Wmisleading-indentation @r{(C and C++ only)}
4545 @opindex Wmisleading-indentation
4546 @opindex Wno-misleading-indentation
4547 Warn when the indentation of the code does not reflect the block structure.
4548 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4549 @code{for} clauses with a guarded statement that does not use braces,
4550 followed by an unguarded statement with the same indentation.
4552 In the following example, the call to ``bar'' is misleadingly indented as
4553 if it were guarded by the ``if'' conditional.
4555 @smallexample
4556   if (some_condition ())
4557     foo ();
4558     bar ();  /* Gotcha: this is not guarded by the "if".  */
4559 @end smallexample
4561 In the case of mixed tabs and spaces, the warning uses the
4562 @option{-ftabstop=} option to determine if the statements line up
4563 (defaulting to 8).
4565 The warning is not issued for code involving multiline preprocessor logic
4566 such as the following example.
4568 @smallexample
4569   if (flagA)
4570     foo (0);
4571 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4572   if (flagB)
4573 #endif
4574     foo (1);
4575 @end smallexample
4577 The warning is not issued after a @code{#line} directive, since this
4578 typically indicates autogenerated code, and no assumptions can be made
4579 about the layout of the file that the directive references.
4581 This warning is enabled by @option{-Wall} in C and C++.
4583 @item -Wmissing-attributes
4584 @opindex Wmissing-attributes
4585 @opindex Wno-missing-attributes
4586 Warn when a declaration of a function is missing one or more attributes
4587 that a related function is declared with and whose absence may adversely
4588 affect the correctness or efficiency of generated code.  For example, in
4589 C++, the warning is issued when an explicit specialization of a primary
4590 template declared with attribute @code{alloc_align}, @code{alloc_size},
4591 @code{assume_aligned}, @code{format}, @code{format_arg}, @code{malloc},
4592 or @code{nonnull} is declared without it.  Attributes @code{deprecated},
4593 @code{error}, and @code{warning} suppress the warning.
4594 (@pxref{Function Attributes}).
4596 @option{-Wmissing-attributes} is enabled by @option{-Wall}.
4598 For example, since the declaration of the primary function template
4599 below makes use of both attribute @code{malloc} and @code{alloc_size}
4600 the declaration of the explicit specialization of the template is
4601 diagnosed because it is missing one of the attributes.
4603 @smallexample
4604 template <class T>
4605 T* __attribute__ ((malloc, alloc_size (1)))
4606 allocate (size_t);
4608 template <>
4609 void* __attribute__ ((malloc))   // missing alloc_size
4610 allocate<void> (size_t);
4611 @end smallexample
4613 @item -Wmissing-braces
4614 @opindex Wmissing-braces
4615 @opindex Wno-missing-braces
4616 Warn if an aggregate or union initializer is not fully bracketed.  In
4617 the following example, the initializer for @code{a} is not fully
4618 bracketed, but that for @code{b} is fully bracketed.  This warning is
4619 enabled by @option{-Wall} in C.
4621 @smallexample
4622 int a[2][2] = @{ 0, 1, 2, 3 @};
4623 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4624 @end smallexample
4626 This warning is enabled by @option{-Wall}.
4628 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4629 @opindex Wmissing-include-dirs
4630 @opindex Wno-missing-include-dirs
4631 Warn if a user-supplied include directory does not exist.
4633 @item -Wmultistatement-macros
4634 @opindex Wmultistatement-macros
4635 @opindex Wno-multistatement-macros
4636 Warn about unsafe multiple statement macros that appear to be guarded
4637 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4638 @code{while}, in which only the first statement is actually guarded after
4639 the macro is expanded.
4641 For example:
4643 @smallexample
4644 #define DOIT x++; y++
4645 if (c)
4646   DOIT;
4647 @end smallexample
4649 will increment @code{y} unconditionally, not just when @code{c} holds.
4650 The can usually be fixed by wrapping the macro in a do-while loop:
4651 @smallexample
4652 #define DOIT do @{ x++; y++; @} while (0)
4653 if (c)
4654   DOIT;
4655 @end smallexample
4657 This warning is enabled by @option{-Wall} in C and C++.
4659 @item -Wparentheses
4660 @opindex Wparentheses
4661 @opindex Wno-parentheses
4662 Warn if parentheses are omitted in certain contexts, such
4663 as when there is an assignment in a context where a truth value
4664 is expected, or when operators are nested whose precedence people
4665 often get confused about.
4667 Also warn if a comparison like @code{x<=y<=z} appears; this is
4668 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4669 interpretation from that of ordinary mathematical notation.
4671 Also warn for dangerous uses of the GNU extension to
4672 @code{?:} with omitted middle operand. When the condition
4673 in the @code{?}: operator is a boolean expression, the omitted value is
4674 always 1.  Often programmers expect it to be a value computed
4675 inside the conditional expression instead.
4677 For C++ this also warns for some cases of unnecessary parentheses in
4678 declarations, which can indicate an attempt at a function call instead
4679 of a declaration:
4680 @smallexample
4682   // Declares a local variable called mymutex.
4683   std::unique_lock<std::mutex> (mymutex);
4684   // User meant std::unique_lock<std::mutex> lock (mymutex);
4686 @end smallexample
4688 This warning is enabled by @option{-Wall}.
4690 @item -Wsequence-point
4691 @opindex Wsequence-point
4692 @opindex Wno-sequence-point
4693 Warn about code that may have undefined semantics because of violations
4694 of sequence point rules in the C and C++ standards.
4696 The C and C++ standards define the order in which expressions in a C/C++
4697 program are evaluated in terms of @dfn{sequence points}, which represent
4698 a partial ordering between the execution of parts of the program: those
4699 executed before the sequence point, and those executed after it.  These
4700 occur after the evaluation of a full expression (one which is not part
4701 of a larger expression), after the evaluation of the first operand of a
4702 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4703 function is called (but after the evaluation of its arguments and the
4704 expression denoting the called function), and in certain other places.
4705 Other than as expressed by the sequence point rules, the order of
4706 evaluation of subexpressions of an expression is not specified.  All
4707 these rules describe only a partial order rather than a total order,
4708 since, for example, if two functions are called within one expression
4709 with no sequence point between them, the order in which the functions
4710 are called is not specified.  However, the standards committee have
4711 ruled that function calls do not overlap.
4713 It is not specified when between sequence points modifications to the
4714 values of objects take effect.  Programs whose behavior depends on this
4715 have undefined behavior; the C and C++ standards specify that ``Between
4716 the previous and next sequence point an object shall have its stored
4717 value modified at most once by the evaluation of an expression.
4718 Furthermore, the prior value shall be read only to determine the value
4719 to be stored.''.  If a program breaks these rules, the results on any
4720 particular implementation are entirely unpredictable.
4722 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4723 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4724 diagnosed by this option, and it may give an occasional false positive
4725 result, but in general it has been found fairly effective at detecting
4726 this sort of problem in programs.
4728 The C++17 standard will define the order of evaluation of operands in
4729 more cases: in particular it requires that the right-hand side of an
4730 assignment be evaluated before the left-hand side, so the above
4731 examples are no longer undefined.  But this warning will still warn
4732 about them, to help people avoid writing code that is undefined in C
4733 and earlier revisions of C++.
4735 The standard is worded confusingly, therefore there is some debate
4736 over the precise meaning of the sequence point rules in subtle cases.
4737 Links to discussions of the problem, including proposed formal
4738 definitions, may be found on the GCC readings page, at
4739 @uref{http://gcc.gnu.org/@/readings.html}.
4741 This warning is enabled by @option{-Wall} for C and C++.
4743 @item -Wno-return-local-addr
4744 @opindex Wno-return-local-addr
4745 @opindex Wreturn-local-addr
4746 Do not warn about returning a pointer (or in C++, a reference) to a
4747 variable that goes out of scope after the function returns.
4749 @item -Wreturn-type
4750 @opindex Wreturn-type
4751 @opindex Wno-return-type
4752 Warn whenever a function is defined with a return type that defaults
4753 to @code{int}.  Also warn about any @code{return} statement with no
4754 return value in a function whose return type is not @code{void}
4755 (falling off the end of the function body is considered returning
4756 without a value).
4758 For C only, warn about a @code{return} statement with an expression in a
4759 function whose return type is @code{void}, unless the expression type is
4760 also @code{void}.  As a GNU extension, the latter case is accepted
4761 without a warning unless @option{-Wpedantic} is used.
4763 For C++, a function without return type always produces a diagnostic
4764 message, even when @option{-Wno-return-type} is specified.  The only
4765 exceptions are @code{main} and functions defined in system headers.
4767 This warning is enabled by default for C++ and is enabled by @option{-Wall}.
4769 @item -Wshift-count-negative
4770 @opindex Wshift-count-negative
4771 @opindex Wno-shift-count-negative
4772 Warn if shift count is negative. This warning is enabled by default.
4774 @item -Wshift-count-overflow
4775 @opindex Wshift-count-overflow
4776 @opindex Wno-shift-count-overflow
4777 Warn if shift count >= width of type. This warning is enabled by default.
4779 @item -Wshift-negative-value
4780 @opindex Wshift-negative-value
4781 @opindex Wno-shift-negative-value
4782 Warn if left shifting a negative value.  This warning is enabled by
4783 @option{-Wextra} in C99 and C++11 modes (and newer).
4785 @item -Wshift-overflow
4786 @itemx -Wshift-overflow=@var{n}
4787 @opindex Wshift-overflow
4788 @opindex Wno-shift-overflow
4789 Warn about left shift overflows.  This warning is enabled by
4790 default in C99 and C++11 modes (and newer).
4792 @table @gcctabopt
4793 @item -Wshift-overflow=1
4794 This is the warning level of @option{-Wshift-overflow} and is enabled
4795 by default in C99 and C++11 modes (and newer).  This warning level does
4796 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4797 an overflow is still rejected in contexts where an integer constant expression
4798 is required.)
4800 @item -Wshift-overflow=2
4801 This warning level also warns about left-shifting 1 into the sign bit,
4802 unless C++14 mode is active.
4803 @end table
4805 @item -Wswitch
4806 @opindex Wswitch
4807 @opindex Wno-switch
4808 Warn whenever a @code{switch} statement has an index of enumerated type
4809 and lacks a @code{case} for one or more of the named codes of that
4810 enumeration.  (The presence of a @code{default} label prevents this
4811 warning.)  @code{case} labels outside the enumeration range also
4812 provoke warnings when this option is used (even if there is a
4813 @code{default} label).
4814 This warning is enabled by @option{-Wall}.
4816 @item -Wswitch-default
4817 @opindex Wswitch-default
4818 @opindex Wno-switch-default
4819 Warn whenever a @code{switch} statement does not have a @code{default}
4820 case.
4822 @item -Wswitch-enum
4823 @opindex Wswitch-enum
4824 @opindex Wno-switch-enum
4825 Warn whenever a @code{switch} statement has an index of enumerated type
4826 and lacks a @code{case} for one or more of the named codes of that
4827 enumeration.  @code{case} labels outside the enumeration range also
4828 provoke warnings when this option is used.  The only difference
4829 between @option{-Wswitch} and this option is that this option gives a
4830 warning about an omitted enumeration code even if there is a
4831 @code{default} label.
4833 @item -Wswitch-bool
4834 @opindex Wswitch-bool
4835 @opindex Wno-switch-bool
4836 Warn whenever a @code{switch} statement has an index of boolean type
4837 and the case values are outside the range of a boolean type.
4838 It is possible to suppress this warning by casting the controlling
4839 expression to a type other than @code{bool}.  For example:
4840 @smallexample
4841 @group
4842 switch ((int) (a == 4))
4843   @{
4844   @dots{}
4845   @}
4846 @end group
4847 @end smallexample
4848 This warning is enabled by default for C and C++ programs.
4850 @item -Wswitch-unreachable
4851 @opindex Wswitch-unreachable
4852 @opindex Wno-switch-unreachable
4853 Warn whenever a @code{switch} statement contains statements between the
4854 controlling expression and the first case label, which will never be
4855 executed.  For example:
4856 @smallexample
4857 @group
4858 switch (cond)
4859   @{
4860    i = 15;
4861   @dots{}
4862    case 5:
4863   @dots{}
4864   @}
4865 @end group
4866 @end smallexample
4867 @option{-Wswitch-unreachable} does not warn if the statement between the
4868 controlling expression and the first case label is just a declaration:
4869 @smallexample
4870 @group
4871 switch (cond)
4872   @{
4873    int i;
4874   @dots{}
4875    case 5:
4876    i = 5;
4877   @dots{}
4878   @}
4879 @end group
4880 @end smallexample
4881 This warning is enabled by default for C and C++ programs.
4883 @item -Wsync-nand @r{(C and C++ only)}
4884 @opindex Wsync-nand
4885 @opindex Wno-sync-nand
4886 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4887 built-in functions are used.  These functions changed semantics in GCC 4.4.
4889 @item -Wunused-but-set-parameter
4890 @opindex Wunused-but-set-parameter
4891 @opindex Wno-unused-but-set-parameter
4892 Warn whenever a function parameter is assigned to, but otherwise unused
4893 (aside from its declaration).
4895 To suppress this warning use the @code{unused} attribute
4896 (@pxref{Variable Attributes}).
4898 This warning is also enabled by @option{-Wunused} together with
4899 @option{-Wextra}.
4901 @item -Wunused-but-set-variable
4902 @opindex Wunused-but-set-variable
4903 @opindex Wno-unused-but-set-variable
4904 Warn whenever a local variable is assigned to, but otherwise unused
4905 (aside from its declaration).
4906 This warning is enabled by @option{-Wall}.
4908 To suppress this warning use the @code{unused} attribute
4909 (@pxref{Variable Attributes}).
4911 This warning is also enabled by @option{-Wunused}, which is enabled
4912 by @option{-Wall}.
4914 @item -Wunused-function
4915 @opindex Wunused-function
4916 @opindex Wno-unused-function
4917 Warn whenever a static function is declared but not defined or a
4918 non-inline static function is unused.
4919 This warning is enabled by @option{-Wall}.
4921 @item -Wunused-label
4922 @opindex Wunused-label
4923 @opindex Wno-unused-label
4924 Warn whenever a label is declared but not used.
4925 This warning is enabled by @option{-Wall}.
4927 To suppress this warning use the @code{unused} attribute
4928 (@pxref{Variable Attributes}).
4930 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4931 @opindex Wunused-local-typedefs
4932 Warn when a typedef locally defined in a function is not used.
4933 This warning is enabled by @option{-Wall}.
4935 @item -Wunused-parameter
4936 @opindex Wunused-parameter
4937 @opindex Wno-unused-parameter
4938 Warn whenever a function parameter is unused aside from its declaration.
4940 To suppress this warning use the @code{unused} attribute
4941 (@pxref{Variable Attributes}).
4943 @item -Wno-unused-result
4944 @opindex Wunused-result
4945 @opindex Wno-unused-result
4946 Do not warn if a caller of a function marked with attribute
4947 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4948 its return value. The default is @option{-Wunused-result}.
4950 @item -Wunused-variable
4951 @opindex Wunused-variable
4952 @opindex Wno-unused-variable
4953 Warn whenever a local or static variable is unused aside from its
4954 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4955 but not for C++. This warning is enabled by @option{-Wall}.
4957 To suppress this warning use the @code{unused} attribute
4958 (@pxref{Variable Attributes}).
4960 @item -Wunused-const-variable
4961 @itemx -Wunused-const-variable=@var{n}
4962 @opindex Wunused-const-variable
4963 @opindex Wno-unused-const-variable
4964 Warn whenever a constant static variable is unused aside from its declaration.
4965 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4966 for C, but not for C++. In C this declares variable storage, but in C++ this
4967 is not an error since const variables take the place of @code{#define}s.
4969 To suppress this warning use the @code{unused} attribute
4970 (@pxref{Variable Attributes}).
4972 @table @gcctabopt
4973 @item -Wunused-const-variable=1
4974 This is the warning level that is enabled by @option{-Wunused-variable} for
4975 C.  It warns only about unused static const variables defined in the main
4976 compilation unit, but not about static const variables declared in any
4977 header included.
4979 @item -Wunused-const-variable=2
4980 This warning level also warns for unused constant static variables in
4981 headers (excluding system headers).  This is the warning level of
4982 @option{-Wunused-const-variable} and must be explicitly requested since
4983 in C++ this isn't an error and in C it might be harder to clean up all
4984 headers included.
4985 @end table
4987 @item -Wunused-value
4988 @opindex Wunused-value
4989 @opindex Wno-unused-value
4990 Warn whenever a statement computes a result that is explicitly not
4991 used. To suppress this warning cast the unused expression to
4992 @code{void}. This includes an expression-statement or the left-hand
4993 side of a comma expression that contains no side effects. For example,
4994 an expression such as @code{x[i,j]} causes a warning, while
4995 @code{x[(void)i,j]} does not.
4997 This warning is enabled by @option{-Wall}.
4999 @item -Wunused
5000 @opindex Wunused
5001 @opindex Wno-unused
5002 All the above @option{-Wunused} options combined.
5004 In order to get a warning about an unused function parameter, you must
5005 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
5006 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
5008 @item -Wuninitialized
5009 @opindex Wuninitialized
5010 @opindex Wno-uninitialized
5011 Warn if an automatic variable is used without first being initialized
5012 or if a variable may be clobbered by a @code{setjmp} call. In C++,
5013 warn if a non-static reference or non-static @code{const} member
5014 appears in a class without constructors.
5016 If you want to warn about code that uses the uninitialized value of the
5017 variable in its own initializer, use the @option{-Winit-self} option.
5019 These warnings occur for individual uninitialized or clobbered
5020 elements of structure, union or array variables as well as for
5021 variables that are uninitialized or clobbered as a whole.  They do
5022 not occur for variables or elements declared @code{volatile}.  Because
5023 these warnings depend on optimization, the exact variables or elements
5024 for which there are warnings depends on the precise optimization
5025 options and version of GCC used.
5027 Note that there may be no warning about a variable that is used only
5028 to compute a value that itself is never used, because such
5029 computations may be deleted by data flow analysis before the warnings
5030 are printed.
5032 @item -Winvalid-memory-model
5033 @opindex Winvalid-memory-model
5034 @opindex Wno-invalid-memory-model
5035 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
5036 and the C11 atomic generic functions with a memory consistency argument
5037 that is either invalid for the operation or outside the range of values
5038 of the @code{memory_order} enumeration.  For example, since the
5039 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
5040 defined for the relaxed, release, and sequentially consistent memory
5041 orders the following code is diagnosed:
5043 @smallexample
5044 void store (int *i)
5046   __atomic_store_n (i, 0, memory_order_consume);
5048 @end smallexample
5050 @option{-Winvalid-memory-model} is enabled by default.
5052 @item -Wmaybe-uninitialized
5053 @opindex Wmaybe-uninitialized
5054 @opindex Wno-maybe-uninitialized
5055 For an automatic (i.e.@ local) variable, if there exists a path from the
5056 function entry to a use of the variable that is initialized, but there exist
5057 some other paths for which the variable is not initialized, the compiler
5058 emits a warning if it cannot prove the uninitialized paths are not
5059 executed at run time.
5061 These warnings are only possible in optimizing compilation, because otherwise
5062 GCC does not keep track of the state of variables.
5064 These warnings are made optional because GCC may not be able to determine when
5065 the code is correct in spite of appearing to have an error.  Here is one
5066 example of how this can happen:
5068 @smallexample
5069 @group
5071   int x;
5072   switch (y)
5073     @{
5074     case 1: x = 1;
5075       break;
5076     case 2: x = 4;
5077       break;
5078     case 3: x = 5;
5079     @}
5080   foo (x);
5082 @end group
5083 @end smallexample
5085 @noindent
5086 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
5087 always initialized, but GCC doesn't know this. To suppress the
5088 warning, you need to provide a default case with assert(0) or
5089 similar code.
5091 @cindex @code{longjmp} warnings
5092 This option also warns when a non-volatile automatic variable might be
5093 changed by a call to @code{longjmp}.
5094 The compiler sees only the calls to @code{setjmp}.  It cannot know
5095 where @code{longjmp} will be called; in fact, a signal handler could
5096 call it at any point in the code.  As a result, you may get a warning
5097 even when there is in fact no problem because @code{longjmp} cannot
5098 in fact be called at the place that would cause a problem.
5100 Some spurious warnings can be avoided if you declare all the functions
5101 you use that never return as @code{noreturn}.  @xref{Function
5102 Attributes}.
5104 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5106 @item -Wunknown-pragmas
5107 @opindex Wunknown-pragmas
5108 @opindex Wno-unknown-pragmas
5109 @cindex warning for unknown pragmas
5110 @cindex unknown pragmas, warning
5111 @cindex pragmas, warning of unknown
5112 Warn when a @code{#pragma} directive is encountered that is not understood by 
5113 GCC@.  If this command-line option is used, warnings are even issued
5114 for unknown pragmas in system header files.  This is not the case if
5115 the warnings are only enabled by the @option{-Wall} command-line option.
5117 @item -Wno-pragmas
5118 @opindex Wno-pragmas
5119 @opindex Wpragmas
5120 Do not warn about misuses of pragmas, such as incorrect parameters,
5121 invalid syntax, or conflicts between pragmas.  See also
5122 @option{-Wunknown-pragmas}.
5124 @item -Wstrict-aliasing
5125 @opindex Wstrict-aliasing
5126 @opindex Wno-strict-aliasing
5127 This option is only active when @option{-fstrict-aliasing} is active.
5128 It warns about code that might break the strict aliasing rules that the
5129 compiler is using for optimization.  The warning does not catch all
5130 cases, but does attempt to catch the more common pitfalls.  It is
5131 included in @option{-Wall}.
5132 It is equivalent to @option{-Wstrict-aliasing=3}
5134 @item -Wstrict-aliasing=n
5135 @opindex Wstrict-aliasing=n
5136 This option is only active when @option{-fstrict-aliasing} is active.
5137 It warns about code that might break the strict aliasing rules that the
5138 compiler is using for optimization.
5139 Higher levels correspond to higher accuracy (fewer false positives).
5140 Higher levels also correspond to more effort, similar to the way @option{-O} 
5141 works.
5142 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5144 Level 1: Most aggressive, quick, least accurate.
5145 Possibly useful when higher levels
5146 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5147 false negatives.  However, it has many false positives.
5148 Warns for all pointer conversions between possibly incompatible types,
5149 even if never dereferenced.  Runs in the front end only.
5151 Level 2: Aggressive, quick, not too precise.
5152 May still have many false positives (not as many as level 1 though),
5153 and few false negatives (but possibly more than level 1).
5154 Unlike level 1, it only warns when an address is taken.  Warns about
5155 incomplete types.  Runs in the front end only.
5157 Level 3 (default for @option{-Wstrict-aliasing}):
5158 Should have very few false positives and few false
5159 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5160 Takes care of the common pun+dereference pattern in the front end:
5161 @code{*(int*)&some_float}.
5162 If optimization is enabled, it also runs in the back end, where it deals
5163 with multiple statement cases using flow-sensitive points-to information.
5164 Only warns when the converted pointer is dereferenced.
5165 Does not warn about incomplete types.
5167 @item -Wstrict-overflow
5168 @itemx -Wstrict-overflow=@var{n}
5169 @opindex Wstrict-overflow
5170 @opindex Wno-strict-overflow
5171 This option is only active when signed overflow is undefined.
5172 It warns about cases where the compiler optimizes based on the
5173 assumption that signed overflow does not occur.  Note that it does not
5174 warn about all cases where the code might overflow: it only warns
5175 about cases where the compiler implements some optimization.  Thus
5176 this warning depends on the optimization level.
5178 An optimization that assumes that signed overflow does not occur is
5179 perfectly safe if the values of the variables involved are such that
5180 overflow never does, in fact, occur.  Therefore this warning can
5181 easily give a false positive: a warning about code that is not
5182 actually a problem.  To help focus on important issues, several
5183 warning levels are defined.  No warnings are issued for the use of
5184 undefined signed overflow when estimating how many iterations a loop
5185 requires, in particular when determining whether a loop will be
5186 executed at all.
5188 @table @gcctabopt
5189 @item -Wstrict-overflow=1
5190 Warn about cases that are both questionable and easy to avoid.  For
5191 example the compiler simplifies
5192 @code{x + 1 > x} to @code{1}.  This level of
5193 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5194 are not, and must be explicitly requested.
5196 @item -Wstrict-overflow=2
5197 Also warn about other cases where a comparison is simplified to a
5198 constant.  For example: @code{abs (x) >= 0}.  This can only be
5199 simplified when signed integer overflow is undefined, because
5200 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5201 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5202 @option{-Wstrict-overflow=2}.
5204 @item -Wstrict-overflow=3
5205 Also warn about other cases where a comparison is simplified.  For
5206 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5208 @item -Wstrict-overflow=4
5209 Also warn about other simplifications not covered by the above cases.
5210 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5212 @item -Wstrict-overflow=5
5213 Also warn about cases where the compiler reduces the magnitude of a
5214 constant involved in a comparison.  For example: @code{x + 2 > y} is
5215 simplified to @code{x + 1 >= y}.  This is reported only at the
5216 highest warning level because this simplification applies to many
5217 comparisons, so this warning level gives a very large number of
5218 false positives.
5219 @end table
5221 @item -Wstringop-overflow
5222 @itemx -Wstringop-overflow=@var{type}
5223 @opindex Wstringop-overflow
5224 @opindex Wno-stringop-overflow
5225 Warn for calls to string manipulation functions such as @code{memcpy} and
5226 @code{strcpy} that are determined to overflow the destination buffer.  The
5227 optional argument is one greater than the type of Object Size Checking to
5228 perform to determine the size of the destination.  @xref{Object Size Checking}.
5229 The argument is meaningful only for functions that operate on character arrays
5230 but not for raw memory functions like @code{memcpy} which always make use
5231 of Object Size type-0.  The option also warns for calls that specify a size
5232 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5233 The option produces the best results with optimization enabled but can detect
5234 a small subset of simple buffer overflows even without optimization in
5235 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5236 correspond to the standard functions.  In any case, the option warns about
5237 just a subset of buffer overflows detected by the corresponding overflow
5238 checking built-ins.  For example, the option will issue a warning for
5239 the @code{strcpy} call below because it copies at least 5 characters
5240 (the string @code{"blue"} including the terminating NUL) into the buffer
5241 of size 4.
5243 @smallexample
5244 enum Color @{ blue, purple, yellow @};
5245 const char* f (enum Color clr)
5247   static char buf [4];
5248   const char *str;
5249   switch (clr)
5250     @{
5251       case blue: str = "blue"; break;
5252       case purple: str = "purple"; break;
5253       case yellow: str = "yellow"; break;
5254     @}
5256   return strcpy (buf, str);   // warning here
5258 @end smallexample
5260 Option @option{-Wstringop-overflow=2} is enabled by default.
5262 @table @gcctabopt
5263 @item -Wstringop-overflow
5264 @itemx -Wstringop-overflow=1
5265 @opindex Wstringop-overflow
5266 @opindex Wno-stringop-overflow
5267 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5268 to determine the sizes of destination objects.  This is the default setting
5269 of the option.  At this setting the option will not warn for writes past
5270 the end of subobjects of larger objects accessed by pointers unless the
5271 size of the largest surrounding object is known.  When the destination may
5272 be one of several objects it is assumed to be the largest one of them.  On
5273 Linux systems, when optimization is enabled at this setting the option warns
5274 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5275 a non-zero value.
5277 @item -Wstringop-overflow=2
5278 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5279 to determine the sizes of destination objects.  At this setting the option
5280 will warn about overflows when writing to members of the largest complete
5281 objects whose exact size is known.  It will, however, not warn for excessive
5282 writes to the same members of unknown objects referenced by pointers since
5283 they may point to arrays containing unknown numbers of elements.
5285 @item -Wstringop-overflow=3
5286 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5287 to determine the sizes of destination objects.  At this setting the option
5288 warns about overflowing the smallest object or data member.  This is the
5289 most restrictive setting of the option that may result in warnings for safe
5290 code.
5292 @item -Wstringop-overflow=4
5293 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5294 to determine the sizes of destination objects.  At this setting the option
5295 will warn about overflowing any data members, and when the destination is
5296 one of several objects it uses the size of the largest of them to decide
5297 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5298 setting of the option may result in warnings for benign code.
5299 @end table
5301 @item -Wstringop-truncation
5302 @opindex Wstringop-truncation
5303 @opindex Wno-stringop-truncation
5304 Warn for calls to bounded string manipulation functions such as @code{strncat},
5305 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5306 or leave the destination unchanged.
5308 In the following example, the call to @code{strncat} specifies a bound that
5309 is less than the length of the source string.  As a result, the copy of
5310 the source will be truncated and so the call is diagnosed.  To avoid the
5311 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5313 @smallexample
5314 void append (char *buf, size_t bufsize)
5316   strncat (buf, ".txt", 3);
5318 @end smallexample
5320 As another example, the following call to @code{strncpy} results in copying
5321 to @code{d} just the characters preceding the terminating NUL, without
5322 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5323 necessarily a NUL-terminated string is a common mistake, and so the call
5324 is diagnosed.  To avoid the warning when the result is not expected to be
5325 NUL-terminated, call @code{memcpy} instead.
5327 @smallexample
5328 void copy (char *d, const char *s)
5330   strncpy (d, s, strlen (s));
5332 @end smallexample
5334 In the following example, the call to @code{strncpy} specifies the size
5335 of the destination buffer as the bound.  If the length of the source
5336 string is equal to or greater than this size the result of the copy will
5337 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5338 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5339 element of the buffer to @code{NUL}.
5341 @smallexample
5342 void copy (const char *s)
5344   char buf[80];
5345   strncpy (buf, s, sizeof buf);
5346   @dots{}
5348 @end smallexample
5350 In situations where a character array is intended to store a sequence
5351 of bytes with no terminating @code{NUL} such an array may be annotated
5352 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5353 however, are not suitable arguments to functions that expect
5354 @code{NUL}-terminated strings.  To help detect accidental misuses of
5355 such arrays GCC issues warnings unless it can prove that the use is
5356 safe.  @xref{Common Variable Attributes}.
5358 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5359 @opindex Wsuggest-attribute=
5360 @opindex Wno-suggest-attribute=
5361 Warn for cases where adding an attribute may be beneficial. The
5362 attributes currently supported are listed below.
5364 @table @gcctabopt
5365 @item -Wsuggest-attribute=pure
5366 @itemx -Wsuggest-attribute=const
5367 @itemx -Wsuggest-attribute=noreturn
5368 @itemx -Wsuggest-attribute=malloc
5369 @opindex Wsuggest-attribute=pure
5370 @opindex Wno-suggest-attribute=pure
5371 @opindex Wsuggest-attribute=const
5372 @opindex Wno-suggest-attribute=const
5373 @opindex Wsuggest-attribute=noreturn
5374 @opindex Wno-suggest-attribute=noreturn
5375 @opindex Wsuggest-attribute=malloc
5376 @opindex Wno-suggest-attribute=malloc
5378 Warn about functions that might be candidates for attributes
5379 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5380 only warns for functions visible in other compilation units or (in the case of
5381 @code{pure} and @code{const}) if it cannot prove that the function returns
5382 normally. A function returns normally if it doesn't contain an infinite loop or
5383 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5384 requires option @option{-fipa-pure-const}, which is enabled by default at
5385 @option{-O} and higher.  Higher optimization levels improve the accuracy
5386 of the analysis.
5388 @item -Wsuggest-attribute=format
5389 @itemx -Wmissing-format-attribute
5390 @opindex Wsuggest-attribute=format
5391 @opindex Wmissing-format-attribute
5392 @opindex Wno-suggest-attribute=format
5393 @opindex Wno-missing-format-attribute
5394 @opindex Wformat
5395 @opindex Wno-format
5397 Warn about function pointers that might be candidates for @code{format}
5398 attributes.  Note these are only possible candidates, not absolute ones.
5399 GCC guesses that function pointers with @code{format} attributes that
5400 are used in assignment, initialization, parameter passing or return
5401 statements should have a corresponding @code{format} attribute in the
5402 resulting type.  I.e.@: the left-hand side of the assignment or
5403 initialization, the type of the parameter variable, or the return type
5404 of the containing function respectively should also have a @code{format}
5405 attribute to avoid the warning.
5407 GCC also warns about function definitions that might be
5408 candidates for @code{format} attributes.  Again, these are only
5409 possible candidates.  GCC guesses that @code{format} attributes
5410 might be appropriate for any function that calls a function like
5411 @code{vprintf} or @code{vscanf}, but this might not always be the
5412 case, and some functions for which @code{format} attributes are
5413 appropriate may not be detected.
5415 @item -Wsuggest-attribute=cold
5416 @opindex Wsuggest-attribute=cold
5417 @opindex Wno-suggest-attribute=cold
5419 Warn about functions that might be candidates for @code{cold} attribute.  This
5420 is based on static detection and generally will only warn about functions which
5421 always leads to a call to another @code{cold} function such as wrappers of
5422 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5423 @end table
5425 @item -Wsuggest-final-types
5426 @opindex Wno-suggest-final-types
5427 @opindex Wsuggest-final-types
5428 Warn about types with virtual methods where code quality would be improved
5429 if the type were declared with the C++11 @code{final} specifier, 
5430 or, if possible,
5431 declared in an anonymous namespace. This allows GCC to more aggressively
5432 devirtualize the polymorphic calls. This warning is more effective with link
5433 time optimization, where the information about the class hierarchy graph is
5434 more complete.
5436 @item -Wsuggest-final-methods
5437 @opindex Wno-suggest-final-methods
5438 @opindex Wsuggest-final-methods
5439 Warn about virtual methods where code quality would be improved if the method
5440 were declared with the C++11 @code{final} specifier, 
5441 or, if possible, its type were
5442 declared in an anonymous namespace or with the @code{final} specifier.
5443 This warning is
5444 more effective with link-time optimization, where the information about the
5445 class hierarchy graph is more complete. It is recommended to first consider
5446 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5447 annotations.
5449 @item -Wsuggest-override
5450 Warn about overriding virtual functions that are not marked with the override
5451 keyword.
5453 @item -Walloc-zero
5454 @opindex Wno-alloc-zero
5455 @opindex Walloc-zero
5456 Warn about calls to allocation functions decorated with attribute
5457 @code{alloc_size} that specify zero bytes, including those to the built-in
5458 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5459 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5460 when called with a zero size differs among implementations (and in the case
5461 of @code{realloc} has been deprecated) relying on it may result in subtle
5462 portability bugs and should be avoided.
5464 @item -Walloc-size-larger-than=@var{n}
5465 Warn about calls to functions decorated with attribute @code{alloc_size}
5466 that attempt to allocate objects larger than the specified number of bytes,
5467 or where the result of the size computation in an integer type with infinite
5468 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5469 may end in one of the standard suffixes designating a multiple of bytes
5470 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5471 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5472 @xref{Function Attributes}.
5474 @item -Walloca
5475 @opindex Wno-alloca
5476 @opindex Walloca
5477 This option warns on all uses of @code{alloca} in the source.
5479 @item -Walloca-larger-than=@var{n}
5480 This option warns on calls to @code{alloca} that are not bounded by a
5481 controlling predicate limiting its argument of integer type to at most
5482 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5483 Arguments of non-integer types are considered unbounded even if they
5484 appear to be constrained to the expected range.
5486 For example, a bounded case of @code{alloca} could be:
5488 @smallexample
5489 void func (size_t n)
5491   void *p;
5492   if (n <= 1000)
5493     p = alloca (n);
5494   else
5495     p = malloc (n);
5496   f (p);
5498 @end smallexample
5500 In the above example, passing @code{-Walloca-larger-than=1000} would not
5501 issue a warning because the call to @code{alloca} is known to be at most
5502 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5503 the compiler would emit a warning.
5505 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5506 controlling predicate constraining its integer argument.  For example:
5508 @smallexample
5509 void func ()
5511   void *p = alloca (n);
5512   f (p);
5514 @end smallexample
5516 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5517 a warning, but this time because of the lack of bounds checking.
5519 Note, that even seemingly correct code involving signed integers could
5520 cause a warning:
5522 @smallexample
5523 void func (signed int n)
5525   if (n < 500)
5526     @{
5527       p = alloca (n);
5528       f (p);
5529     @}
5531 @end smallexample
5533 In the above example, @var{n} could be negative, causing a larger than
5534 expected argument to be implicitly cast into the @code{alloca} call.
5536 This option also warns when @code{alloca} is used in a loop.
5538 This warning is not enabled by @option{-Wall}, and is only active when
5539 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5541 See also @option{-Wvla-larger-than=@var{n}}.
5543 @item -Warray-bounds
5544 @itemx -Warray-bounds=@var{n}
5545 @opindex Wno-array-bounds
5546 @opindex Warray-bounds
5547 This option is only active when @option{-ftree-vrp} is active
5548 (default for @option{-O2} and above). It warns about subscripts to arrays
5549 that are always out of bounds. This warning is enabled by @option{-Wall}.
5551 @table @gcctabopt
5552 @item -Warray-bounds=1
5553 This is the warning level of @option{-Warray-bounds} and is enabled
5554 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5556 @item -Warray-bounds=2
5557 This warning level also warns about out of bounds access for
5558 arrays at the end of a struct and for arrays accessed through
5559 pointers. This warning level may give a larger number of
5560 false positives and is deactivated by default.
5561 @end table
5563 @item -Wattribute-alias
5564 Warn about declarations using the @code{alias} and similar attributes whose
5565 target is incompatible with the type of the alias.  @xref{Function Attributes,
5566 ,Declaring Attributes of Functions}.
5568 @item -Wbool-compare
5569 @opindex Wno-bool-compare
5570 @opindex Wbool-compare
5571 Warn about boolean expression compared with an integer value different from
5572 @code{true}/@code{false}.  For instance, the following comparison is
5573 always false:
5574 @smallexample
5575 int n = 5;
5576 @dots{}
5577 if ((n > 1) == 2) @{ @dots{} @}
5578 @end smallexample
5579 This warning is enabled by @option{-Wall}.
5581 @item -Wbool-operation
5582 @opindex Wno-bool-operation
5583 @opindex Wbool-operation
5584 Warn about suspicious operations on expressions of a boolean type.  For
5585 instance, bitwise negation of a boolean is very likely a bug in the program.
5586 For C, this warning also warns about incrementing or decrementing a boolean,
5587 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5588 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5590 This warning is enabled by @option{-Wall}.
5592 @item -Wduplicated-branches
5593 @opindex Wno-duplicated-branches
5594 @opindex Wduplicated-branches
5595 Warn when an if-else has identical branches.  This warning detects cases like
5596 @smallexample
5597 if (p != NULL)
5598   return 0;
5599 else
5600   return 0;
5601 @end smallexample
5602 It doesn't warn when both branches contain just a null statement.  This warning
5603 also warn for conditional operators:
5604 @smallexample
5605   int i = x ? *p : *p;
5606 @end smallexample
5608 @item -Wduplicated-cond
5609 @opindex Wno-duplicated-cond
5610 @opindex Wduplicated-cond
5611 Warn about duplicated conditions in an if-else-if chain.  For instance,
5612 warn for the following code:
5613 @smallexample
5614 if (p->q != NULL) @{ @dots{} @}
5615 else if (p->q != NULL) @{ @dots{} @}
5616 @end smallexample
5618 @item -Wframe-address
5619 @opindex Wno-frame-address
5620 @opindex Wframe-address
5621 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5622 is called with an argument greater than 0.  Such calls may return indeterminate
5623 values or crash the program.  The warning is included in @option{-Wall}.
5625 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5626 @opindex Wno-discarded-qualifiers
5627 @opindex Wdiscarded-qualifiers
5628 Do not warn if type qualifiers on pointers are being discarded.
5629 Typically, the compiler warns if a @code{const char *} variable is
5630 passed to a function that takes a @code{char *} parameter.  This option
5631 can be used to suppress such a warning.
5633 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5634 @opindex Wno-discarded-array-qualifiers
5635 @opindex Wdiscarded-array-qualifiers
5636 Do not warn if type qualifiers on arrays which are pointer targets
5637 are being discarded. Typically, the compiler warns if a
5638 @code{const int (*)[]} variable is passed to a function that
5639 takes a @code{int (*)[]} parameter.  This option can be used to
5640 suppress such a warning.
5642 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5643 @opindex Wno-incompatible-pointer-types
5644 @opindex Wincompatible-pointer-types
5645 Do not warn when there is a conversion between pointers that have incompatible
5646 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5647 which warns for pointer argument passing or assignment with different
5648 signedness.
5650 @item -Wno-int-conversion @r{(C and Objective-C only)}
5651 @opindex Wno-int-conversion
5652 @opindex Wint-conversion
5653 Do not warn about incompatible integer to pointer and pointer to integer
5654 conversions.  This warning is about implicit conversions; for explicit
5655 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5656 @option{-Wno-pointer-to-int-cast} may be used.
5658 @item -Wno-div-by-zero
5659 @opindex Wno-div-by-zero
5660 @opindex Wdiv-by-zero
5661 Do not warn about compile-time integer division by zero.  Floating-point
5662 division by zero is not warned about, as it can be a legitimate way of
5663 obtaining infinities and NaNs.
5665 @item -Wsystem-headers
5666 @opindex Wsystem-headers
5667 @opindex Wno-system-headers
5668 @cindex warnings from system headers
5669 @cindex system headers, warnings from
5670 Print warning messages for constructs found in system header files.
5671 Warnings from system headers are normally suppressed, on the assumption
5672 that they usually do not indicate real problems and would only make the
5673 compiler output harder to read.  Using this command-line option tells
5674 GCC to emit warnings from system headers as if they occurred in user
5675 code.  However, note that using @option{-Wall} in conjunction with this
5676 option does @emph{not} warn about unknown pragmas in system
5677 headers---for that, @option{-Wunknown-pragmas} must also be used.
5679 @item -Wtautological-compare
5680 @opindex Wtautological-compare
5681 @opindex Wno-tautological-compare
5682 Warn if a self-comparison always evaluates to true or false.  This
5683 warning detects various mistakes such as:
5684 @smallexample
5685 int i = 1;
5686 @dots{}
5687 if (i > i) @{ @dots{} @}
5688 @end smallexample
5690 This warning also warns about bitwise comparisons that always evaluate
5691 to true or false, for instance:
5692 @smallexample
5693 if ((a & 16) == 10) @{ @dots{} @}
5694 @end smallexample
5695 will always be false.
5697 This warning is enabled by @option{-Wall}.
5699 @item -Wtrampolines
5700 @opindex Wtrampolines
5701 @opindex Wno-trampolines
5702 Warn about trampolines generated for pointers to nested functions.
5703 A trampoline is a small piece of data or code that is created at run
5704 time on the stack when the address of a nested function is taken, and is
5705 used to call the nested function indirectly.  For some targets, it is
5706 made up of data only and thus requires no special treatment.  But, for
5707 most targets, it is made up of code and thus requires the stack to be
5708 made executable in order for the program to work properly.
5710 @item -Wfloat-equal
5711 @opindex Wfloat-equal
5712 @opindex Wno-float-equal
5713 Warn if floating-point values are used in equality comparisons.
5715 The idea behind this is that sometimes it is convenient (for the
5716 programmer) to consider floating-point values as approximations to
5717 infinitely precise real numbers.  If you are doing this, then you need
5718 to compute (by analyzing the code, or in some other way) the maximum or
5719 likely maximum error that the computation introduces, and allow for it
5720 when performing comparisons (and when producing output, but that's a
5721 different problem).  In particular, instead of testing for equality, you
5722 should check to see whether the two values have ranges that overlap; and
5723 this is done with the relational operators, so equality comparisons are
5724 probably mistaken.
5726 @item -Wtraditional @r{(C and Objective-C only)}
5727 @opindex Wtraditional
5728 @opindex Wno-traditional
5729 Warn about certain constructs that behave differently in traditional and
5730 ISO C@.  Also warn about ISO C constructs that have no traditional C
5731 equivalent, and/or problematic constructs that should be avoided.
5733 @itemize @bullet
5734 @item
5735 Macro parameters that appear within string literals in the macro body.
5736 In traditional C macro replacement takes place within string literals,
5737 but in ISO C it does not.
5739 @item
5740 In traditional C, some preprocessor directives did not exist.
5741 Traditional preprocessors only considered a line to be a directive
5742 if the @samp{#} appeared in column 1 on the line.  Therefore
5743 @option{-Wtraditional} warns about directives that traditional C
5744 understands but ignores because the @samp{#} does not appear as the
5745 first character on the line.  It also suggests you hide directives like
5746 @code{#pragma} not understood by traditional C by indenting them.  Some
5747 traditional implementations do not recognize @code{#elif}, so this option
5748 suggests avoiding it altogether.
5750 @item
5751 A function-like macro that appears without arguments.
5753 @item
5754 The unary plus operator.
5756 @item
5757 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5758 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5759 constants.)  Note, these suffixes appear in macros defined in the system
5760 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5761 Use of these macros in user code might normally lead to spurious
5762 warnings, however GCC's integrated preprocessor has enough context to
5763 avoid warning in these cases.
5765 @item
5766 A function declared external in one block and then used after the end of
5767 the block.
5769 @item
5770 A @code{switch} statement has an operand of type @code{long}.
5772 @item
5773 A non-@code{static} function declaration follows a @code{static} one.
5774 This construct is not accepted by some traditional C compilers.
5776 @item
5777 The ISO type of an integer constant has a different width or
5778 signedness from its traditional type.  This warning is only issued if
5779 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5780 typically represent bit patterns, are not warned about.
5782 @item
5783 Usage of ISO string concatenation is detected.
5785 @item
5786 Initialization of automatic aggregates.
5788 @item
5789 Identifier conflicts with labels.  Traditional C lacks a separate
5790 namespace for labels.
5792 @item
5793 Initialization of unions.  If the initializer is zero, the warning is
5794 omitted.  This is done under the assumption that the zero initializer in
5795 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5796 initializer warnings and relies on default initialization to zero in the
5797 traditional C case.
5799 @item
5800 Conversions by prototypes between fixed/floating-point values and vice
5801 versa.  The absence of these prototypes when compiling with traditional
5802 C causes serious problems.  This is a subset of the possible
5803 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5805 @item
5806 Use of ISO C style function definitions.  This warning intentionally is
5807 @emph{not} issued for prototype declarations or variadic functions
5808 because these ISO C features appear in your code when using
5809 libiberty's traditional C compatibility macros, @code{PARAMS} and
5810 @code{VPARAMS}.  This warning is also bypassed for nested functions
5811 because that feature is already a GCC extension and thus not relevant to
5812 traditional C compatibility.
5813 @end itemize
5815 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5816 @opindex Wtraditional-conversion
5817 @opindex Wno-traditional-conversion
5818 Warn if a prototype causes a type conversion that is different from what
5819 would happen to the same argument in the absence of a prototype.  This
5820 includes conversions of fixed point to floating and vice versa, and
5821 conversions changing the width or signedness of a fixed-point argument
5822 except when the same as the default promotion.
5824 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5825 @opindex Wdeclaration-after-statement
5826 @opindex Wno-declaration-after-statement
5827 Warn when a declaration is found after a statement in a block.  This
5828 construct, known from C++, was introduced with ISO C99 and is by default
5829 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5831 @item -Wshadow
5832 @opindex Wshadow
5833 @opindex Wno-shadow
5834 Warn whenever a local variable or type declaration shadows another
5835 variable, parameter, type, class member (in C++), or instance variable
5836 (in Objective-C) or whenever a built-in function is shadowed. Note
5837 that in C++, the compiler warns if a local variable shadows an
5838 explicit typedef, but not if it shadows a struct/class/enum.
5839 Same as @option{-Wshadow=global}.
5841 @item -Wno-shadow-ivar @r{(Objective-C only)}
5842 @opindex Wno-shadow-ivar
5843 @opindex Wshadow-ivar
5844 Do not warn whenever a local variable shadows an instance variable in an
5845 Objective-C method.
5847 @item -Wshadow=global
5848 @opindex Wshadow=local
5849 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5851 @item -Wshadow=local
5852 @opindex Wshadow=local
5853 Warn when a local variable shadows another local variable or parameter.
5854 This warning is enabled by @option{-Wshadow=global}.
5856 @item -Wshadow=compatible-local
5857 @opindex Wshadow=compatible-local
5858 Warn when a local variable shadows another local variable or parameter
5859 whose type is compatible with that of the shadowing variable. In C++,
5860 type compatibility here means the type of the shadowing variable can be
5861 converted to that of the shadowed variable. The creation of this flag
5862 (in addition to @option{-Wshadow=local}) is based on the idea that when
5863 a local variable shadows another one of incompatible type, it is most
5864 likely intentional, not a bug or typo, as shown in the following example:
5866 @smallexample
5867 @group
5868 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5870   for (int i = 0; i < N; ++i)
5871   @{
5872     ...
5873   @}
5874   ...
5876 @end group
5877 @end smallexample
5879 Since the two variable @code{i} in the example above have incompatible types,
5880 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5881 Because their types are incompatible, if a programmer accidentally uses one
5882 in place of the other, type checking will catch that and emit an error or
5883 warning. So not warning (about shadowing) in this case will not lead to
5884 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5885 possibly reduce the number of warnings triggered by intentional shadowing.
5887 This warning is enabled by @option{-Wshadow=local}.
5889 @item -Wlarger-than=@var{len}
5890 @opindex Wlarger-than=@var{len}
5891 @opindex Wlarger-than-@var{len}
5892 Warn whenever an object of larger than @var{len} bytes is defined.
5894 @item -Wframe-larger-than=@var{len}
5895 @opindex Wframe-larger-than
5896 Warn if the size of a function frame is larger than @var{len} bytes.
5897 The computation done to determine the stack frame size is approximate
5898 and not conservative.
5899 The actual requirements may be somewhat greater than @var{len}
5900 even if you do not get a warning.  In addition, any space allocated
5901 via @code{alloca}, variable-length arrays, or related constructs
5902 is not included by the compiler when determining
5903 whether or not to issue a warning.
5905 @item -Wno-free-nonheap-object
5906 @opindex Wno-free-nonheap-object
5907 @opindex Wfree-nonheap-object
5908 Do not warn when attempting to free an object that was not allocated
5909 on the heap.
5911 @item -Wstack-usage=@var{len}
5912 @opindex Wstack-usage
5913 Warn if the stack usage of a function might be larger than @var{len} bytes.
5914 The computation done to determine the stack usage is conservative.
5915 Any space allocated via @code{alloca}, variable-length arrays, or related
5916 constructs is included by the compiler when determining whether or not to
5917 issue a warning.
5919 The message is in keeping with the output of @option{-fstack-usage}.
5921 @itemize
5922 @item
5923 If the stack usage is fully static but exceeds the specified amount, it's:
5925 @smallexample
5926   warning: stack usage is 1120 bytes
5927 @end smallexample
5928 @item
5929 If the stack usage is (partly) dynamic but bounded, it's:
5931 @smallexample
5932   warning: stack usage might be 1648 bytes
5933 @end smallexample
5934 @item
5935 If the stack usage is (partly) dynamic and not bounded, it's:
5937 @smallexample
5938   warning: stack usage might be unbounded
5939 @end smallexample
5940 @end itemize
5942 @item -Wunsafe-loop-optimizations
5943 @opindex Wunsafe-loop-optimizations
5944 @opindex Wno-unsafe-loop-optimizations
5945 Warn if the loop cannot be optimized because the compiler cannot
5946 assume anything on the bounds of the loop indices.  With
5947 @option{-funsafe-loop-optimizations} warn if the compiler makes
5948 such assumptions.
5950 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5951 @opindex Wno-pedantic-ms-format
5952 @opindex Wpedantic-ms-format
5953 When used in combination with @option{-Wformat}
5954 and @option{-pedantic} without GNU extensions, this option
5955 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5956 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5957 which depend on the MS runtime.
5959 @item -Waligned-new
5960 @opindex Waligned-new
5961 @opindex Wno-aligned-new
5962 Warn about a new-expression of a type that requires greater alignment
5963 than the @code{alignof(std::max_align_t)} but uses an allocation
5964 function without an explicit alignment parameter. This option is
5965 enabled by @option{-Wall}.
5967 Normally this only warns about global allocation functions, but
5968 @option{-Waligned-new=all} also warns about class member allocation
5969 functions.
5971 @item -Wplacement-new
5972 @itemx -Wplacement-new=@var{n}
5973 @opindex Wplacement-new
5974 @opindex Wno-placement-new
5975 Warn about placement new expressions with undefined behavior, such as
5976 constructing an object in a buffer that is smaller than the type of
5977 the object.  For example, the placement new expression below is diagnosed
5978 because it attempts to construct an array of 64 integers in a buffer only
5979 64 bytes large.
5980 @smallexample
5981 char buf [64];
5982 new (buf) int[64];
5983 @end smallexample
5984 This warning is enabled by default.
5986 @table @gcctabopt
5987 @item -Wplacement-new=1
5988 This is the default warning level of @option{-Wplacement-new}.  At this
5989 level the warning is not issued for some strictly undefined constructs that
5990 GCC allows as extensions for compatibility with legacy code.  For example,
5991 the following @code{new} expression is not diagnosed at this level even
5992 though it has undefined behavior according to the C++ standard because
5993 it writes past the end of the one-element array.
5994 @smallexample
5995 struct S @{ int n, a[1]; @};
5996 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5997 new (s->a)int [32]();
5998 @end smallexample
6000 @item -Wplacement-new=2
6001 At this level, in addition to diagnosing all the same constructs as at level
6002 1, a diagnostic is also issued for placement new expressions that construct
6003 an object in the last member of structure whose type is an array of a single
6004 element and whose size is less than the size of the object being constructed.
6005 While the previous example would be diagnosed, the following construct makes
6006 use of the flexible member array extension to avoid the warning at level 2.
6007 @smallexample
6008 struct S @{ int n, a[]; @};
6009 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
6010 new (s->a)int [32]();
6011 @end smallexample
6013 @end table
6015 @item -Wpointer-arith
6016 @opindex Wpointer-arith
6017 @opindex Wno-pointer-arith
6018 Warn about anything that depends on the ``size of'' a function type or
6019 of @code{void}.  GNU C assigns these types a size of 1, for
6020 convenience in calculations with @code{void *} pointers and pointers
6021 to functions.  In C++, warn also when an arithmetic operation involves
6022 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
6024 @item -Wpointer-compare
6025 @opindex Wpointer-compare
6026 @opindex Wno-pointer-compare
6027 Warn if a pointer is compared with a zero character constant.  This usually
6028 means that the pointer was meant to be dereferenced.  For example:
6030 @smallexample
6031 const char *p = foo ();
6032 if (p == '\0')
6033   return 42;
6034 @end smallexample
6036 Note that the code above is invalid in C++11.
6038 This warning is enabled by default.
6040 @item -Wtype-limits
6041 @opindex Wtype-limits
6042 @opindex Wno-type-limits
6043 Warn if a comparison is always true or always false due to the limited
6044 range of the data type, but do not warn for constant expressions.  For
6045 example, warn if an unsigned variable is compared against zero with
6046 @code{<} or @code{>=}.  This warning is also enabled by
6047 @option{-Wextra}.
6049 @include cppwarnopts.texi
6051 @item -Wbad-function-cast @r{(C and Objective-C only)}
6052 @opindex Wbad-function-cast
6053 @opindex Wno-bad-function-cast
6054 Warn when a function call is cast to a non-matching type.
6055 For example, warn if a call to a function returning an integer type 
6056 is cast to a pointer type.
6058 @item -Wc90-c99-compat @r{(C and Objective-C only)}
6059 @opindex Wc90-c99-compat
6060 @opindex Wno-c90-c99-compat
6061 Warn about features not present in ISO C90, but present in ISO C99.
6062 For instance, warn about use of variable length arrays, @code{long long}
6063 type, @code{bool} type, compound literals, designated initializers, and so
6064 on.  This option is independent of the standards mode.  Warnings are disabled
6065 in the expression that follows @code{__extension__}.
6067 @item -Wc99-c11-compat @r{(C and Objective-C only)}
6068 @opindex Wc99-c11-compat
6069 @opindex Wno-c99-c11-compat
6070 Warn about features not present in ISO C99, but present in ISO C11.
6071 For instance, warn about use of anonymous structures and unions,
6072 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
6073 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
6074 and so on.  This option is independent of the standards mode.  Warnings are
6075 disabled in the expression that follows @code{__extension__}.
6077 @item -Wc++-compat @r{(C and Objective-C only)}
6078 @opindex Wc++-compat
6079 Warn about ISO C constructs that are outside of the common subset of
6080 ISO C and ISO C++, e.g.@: request for implicit conversion from
6081 @code{void *} to a pointer to non-@code{void} type.
6083 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
6084 @opindex Wc++11-compat
6085 Warn about C++ constructs whose meaning differs between ISO C++ 1998
6086 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
6087 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
6088 enabled by @option{-Wall}.
6090 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6091 @opindex Wc++14-compat
6092 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6093 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6095 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6096 @opindex Wc++17-compat
6097 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6098 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6100 @item -Wcast-qual
6101 @opindex Wcast-qual
6102 @opindex Wno-cast-qual
6103 Warn whenever a pointer is cast so as to remove a type qualifier from
6104 the target type.  For example, warn if a @code{const char *} is cast
6105 to an ordinary @code{char *}.
6107 Also warn when making a cast that introduces a type qualifier in an
6108 unsafe way.  For example, casting @code{char **} to @code{const char **}
6109 is unsafe, as in this example:
6111 @smallexample
6112   /* p is char ** value.  */
6113   const char **q = (const char **) p;
6114   /* Assignment of readonly string to const char * is OK.  */
6115   *q = "string";
6116   /* Now char** pointer points to read-only memory.  */
6117   **p = 'b';
6118 @end smallexample
6120 @item -Wcast-align
6121 @opindex Wcast-align
6122 @opindex Wno-cast-align
6123 Warn whenever a pointer is cast such that the required alignment of the
6124 target is increased.  For example, warn if a @code{char *} is cast to
6125 an @code{int *} on machines where integers can only be accessed at
6126 two- or four-byte boundaries.
6128 @item -Wcast-align=strict
6129 @opindex Wcast-align=strict
6130 Warn whenever a pointer is cast such that the required alignment of the
6131 target is increased.  For example, warn if a @code{char *} is cast to
6132 an @code{int *} regardless of the target machine.
6134 @item -Wcast-function-type
6135 @opindex Wcast-function-type
6136 @opindex Wno-cast-function-type
6137 Warn when a function pointer is cast to an incompatible function pointer.
6138 In a cast involving function types with a variable argument list only
6139 the types of initial arguments that are provided are considered.
6140 Any parameter of pointer-type matches any other pointer-type.  Any benign
6141 differences in integral types are ignored, like @code{int} vs. @code{long}
6142 on ILP32 targets.  Likewise type qualifiers are ignored.  The function
6143 type @code{void (*) (void)} is special and matches everything, which can
6144 be used to suppress this warning.
6145 In a cast involving pointer to member types this warning warns whenever
6146 the type cast is changing the pointer to member type.
6147 This warning is enabled by @option{-Wextra}.
6149 @item -Wwrite-strings
6150 @opindex Wwrite-strings
6151 @opindex Wno-write-strings
6152 When compiling C, give string constants the type @code{const
6153 char[@var{length}]} so that copying the address of one into a
6154 non-@code{const} @code{char *} pointer produces a warning.  These
6155 warnings help you find at compile time code that can try to write
6156 into a string constant, but only if you have been very careful about
6157 using @code{const} in declarations and prototypes.  Otherwise, it is
6158 just a nuisance. This is why we did not make @option{-Wall} request
6159 these warnings.
6161 When compiling C++, warn about the deprecated conversion from string
6162 literals to @code{char *}.  This warning is enabled by default for C++
6163 programs.
6165 @item -Wcatch-value
6166 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6167 @opindex Wcatch-value
6168 @opindex Wno-catch-value
6169 Warn about catch handlers that do not catch via reference.
6170 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6171 warn about polymorphic class types that are caught by value.
6172 With @option{-Wcatch-value=2} warn about all class types that are caught
6173 by value. With @option{-Wcatch-value=3} warn about all types that are
6174 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6176 @item -Wclobbered
6177 @opindex Wclobbered
6178 @opindex Wno-clobbered
6179 Warn for variables that might be changed by @code{longjmp} or
6180 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6182 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6183 @opindex Wconditionally-supported
6184 @opindex Wno-conditionally-supported
6185 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6187 @item -Wconversion
6188 @opindex Wconversion
6189 @opindex Wno-conversion
6190 Warn for implicit conversions that may alter a value. This includes
6191 conversions between real and integer, like @code{abs (x)} when
6192 @code{x} is @code{double}; conversions between signed and unsigned,
6193 like @code{unsigned ui = -1}; and conversions to smaller types, like
6194 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6195 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6196 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6197 conversions between signed and unsigned integers can be disabled by
6198 using @option{-Wno-sign-conversion}.
6200 For C++, also warn for confusing overload resolution for user-defined
6201 conversions; and conversions that never use a type conversion
6202 operator: conversions to @code{void}, the same type, a base class or a
6203 reference to them. Warnings about conversions between signed and
6204 unsigned integers are disabled by default in C++ unless
6205 @option{-Wsign-conversion} is explicitly enabled.
6207 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6208 @opindex Wconversion-null
6209 @opindex Wno-conversion-null
6210 Do not warn for conversions between @code{NULL} and non-pointer
6211 types. @option{-Wconversion-null} is enabled by default.
6213 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6214 @opindex Wzero-as-null-pointer-constant
6215 @opindex Wno-zero-as-null-pointer-constant
6216 Warn when a literal @samp{0} is used as null pointer constant.  This can
6217 be useful to facilitate the conversion to @code{nullptr} in C++11.
6219 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6220 @opindex Wsubobject-linkage
6221 @opindex Wno-subobject-linkage
6222 Warn if a class type has a base or a field whose type uses the anonymous
6223 namespace or depends on a type with no linkage.  If a type A depends on
6224 a type B with no or internal linkage, defining it in multiple
6225 translation units would be an ODR violation because the meaning of B
6226 is different in each translation unit.  If A only appears in a single
6227 translation unit, the best way to silence the warning is to give it
6228 internal linkage by putting it in an anonymous namespace as well.  The
6229 compiler doesn't give this warning for types defined in the main .C
6230 file, as those are unlikely to have multiple definitions.
6231 @option{-Wsubobject-linkage} is enabled by default.
6233 @item -Wdangling-else
6234 @opindex Wdangling-else
6235 @opindex Wno-dangling-else
6236 Warn about constructions where there may be confusion to which
6237 @code{if} statement an @code{else} branch belongs.  Here is an example of
6238 such a case:
6240 @smallexample
6241 @group
6243   if (a)
6244     if (b)
6245       foo ();
6246   else
6247     bar ();
6249 @end group
6250 @end smallexample
6252 In C/C++, every @code{else} branch belongs to the innermost possible
6253 @code{if} statement, which in this example is @code{if (b)}.  This is
6254 often not what the programmer expected, as illustrated in the above
6255 example by indentation the programmer chose.  When there is the
6256 potential for this confusion, GCC issues a warning when this flag
6257 is specified.  To eliminate the warning, add explicit braces around
6258 the innermost @code{if} statement so there is no way the @code{else}
6259 can belong to the enclosing @code{if}.  The resulting code
6260 looks like this:
6262 @smallexample
6263 @group
6265   if (a)
6266     @{
6267       if (b)
6268         foo ();
6269       else
6270         bar ();
6271     @}
6273 @end group
6274 @end smallexample
6276 This warning is enabled by @option{-Wparentheses}.
6278 @item -Wdate-time
6279 @opindex Wdate-time
6280 @opindex Wno-date-time
6281 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6282 are encountered as they might prevent bit-wise-identical reproducible
6283 compilations.
6285 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6286 @opindex Wdelete-incomplete
6287 @opindex Wno-delete-incomplete
6288 Warn when deleting a pointer to incomplete type, which may cause
6289 undefined behavior at runtime.  This warning is enabled by default.
6291 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6292 @opindex Wuseless-cast
6293 @opindex Wno-useless-cast
6294 Warn when an expression is casted to its own type.
6296 @item -Wempty-body
6297 @opindex Wempty-body
6298 @opindex Wno-empty-body
6299 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6300 while} statement.  This warning is also enabled by @option{-Wextra}.
6302 @item -Wenum-compare
6303 @opindex Wenum-compare
6304 @opindex Wno-enum-compare
6305 Warn about a comparison between values of different enumerated types.
6306 In C++ enumerated type mismatches in conditional expressions are also
6307 diagnosed and the warning is enabled by default.  In C this warning is 
6308 enabled by @option{-Wall}.
6310 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6311 @opindex Wextra-semi
6312 @opindex Wno-extra-semi
6313 Warn about redundant semicolon after in-class function definition.
6315 @item -Wjump-misses-init @r{(C, Objective-C only)}
6316 @opindex Wjump-misses-init
6317 @opindex Wno-jump-misses-init
6318 Warn if a @code{goto} statement or a @code{switch} statement jumps
6319 forward across the initialization of a variable, or jumps backward to a
6320 label after the variable has been initialized.  This only warns about
6321 variables that are initialized when they are declared.  This warning is
6322 only supported for C and Objective-C; in C++ this sort of branch is an
6323 error in any case.
6325 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6326 can be disabled with the @option{-Wno-jump-misses-init} option.
6328 @item -Wsign-compare
6329 @opindex Wsign-compare
6330 @opindex Wno-sign-compare
6331 @cindex warning for comparison of signed and unsigned values
6332 @cindex comparison of signed and unsigned values, warning
6333 @cindex signed and unsigned values, comparison warning
6334 Warn when a comparison between signed and unsigned values could produce
6335 an incorrect result when the signed value is converted to unsigned.
6336 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6337 also enabled by @option{-Wextra}.
6339 @item -Wsign-conversion
6340 @opindex Wsign-conversion
6341 @opindex Wno-sign-conversion
6342 Warn for implicit conversions that may change the sign of an integer
6343 value, like assigning a signed integer expression to an unsigned
6344 integer variable. An explicit cast silences the warning. In C, this
6345 option is enabled also by @option{-Wconversion}.
6347 @item -Wfloat-conversion
6348 @opindex Wfloat-conversion
6349 @opindex Wno-float-conversion
6350 Warn for implicit conversions that reduce the precision of a real value.
6351 This includes conversions from real to integer, and from higher precision
6352 real to lower precision real values.  This option is also enabled by
6353 @option{-Wconversion}.
6355 @item -Wno-scalar-storage-order
6356 @opindex -Wno-scalar-storage-order
6357 @opindex -Wscalar-storage-order
6358 Do not warn on suspicious constructs involving reverse scalar storage order.
6360 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6361 @opindex Wsized-deallocation
6362 @opindex Wno-sized-deallocation
6363 Warn about a definition of an unsized deallocation function
6364 @smallexample
6365 void operator delete (void *) noexcept;
6366 void operator delete[] (void *) noexcept;
6367 @end smallexample
6368 without a definition of the corresponding sized deallocation function
6369 @smallexample
6370 void operator delete (void *, std::size_t) noexcept;
6371 void operator delete[] (void *, std::size_t) noexcept;
6372 @end smallexample
6373 or vice versa.  Enabled by @option{-Wextra} along with
6374 @option{-fsized-deallocation}.
6376 @item -Wsizeof-pointer-div
6377 @opindex Wsizeof-pointer-div
6378 @opindex Wno-sizeof-pointer-div
6379 Warn for suspicious divisions of two sizeof expressions that divide
6380 the pointer size by the element size, which is the usual way to compute
6381 the array size but won't work out correctly with pointers.  This warning
6382 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6383 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6385 @item -Wsizeof-pointer-memaccess
6386 @opindex Wsizeof-pointer-memaccess
6387 @opindex Wno-sizeof-pointer-memaccess
6388 Warn for suspicious length parameters to certain string and memory built-in
6389 functions if the argument uses @code{sizeof}.  This warning triggers for
6390 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6391 an array, but a pointer, and suggests a possible fix, or about
6392 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6393 also warns about calls to bounded string copy functions like @code{strncat}
6394 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6395 the source array.  For example, in the following function the call to
6396 @code{strncat} specifies the size of the source string as the bound.  That
6397 is almost certainly a mistake and so the call is diagnosed.
6398 @smallexample
6399 void make_file (const char *name)
6401   char path[PATH_MAX];
6402   strncpy (path, name, sizeof path - 1);
6403   strncat (path, ".text", sizeof ".text");
6404   @dots{}
6406 @end smallexample
6408 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6410 @item -Wsizeof-array-argument
6411 @opindex Wsizeof-array-argument
6412 @opindex Wno-sizeof-array-argument
6413 Warn when the @code{sizeof} operator is applied to a parameter that is
6414 declared as an array in a function definition.  This warning is enabled by
6415 default for C and C++ programs.
6417 @item -Wmemset-elt-size
6418 @opindex Wmemset-elt-size
6419 @opindex Wno-memset-elt-size
6420 Warn for suspicious calls to the @code{memset} built-in function, if the
6421 first argument references an array, and the third argument is a number
6422 equal to the number of elements, but not equal to the size of the array
6423 in memory.  This indicates that the user has omitted a multiplication by
6424 the element size.  This warning is enabled by @option{-Wall}.
6426 @item -Wmemset-transposed-args
6427 @opindex Wmemset-transposed-args
6428 @opindex Wno-memset-transposed-args
6429 Warn for suspicious calls to the @code{memset} built-in function, if the
6430 second argument is not zero and the third argument is zero.  This warns e.g.@
6431 about @code{memset (buf, sizeof buf, 0)} where most probably
6432 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6433 is only emitted if the third argument is literal zero.  If it is some
6434 expression that is folded to zero, a cast of zero to some type, etc., 
6435 it is far less likely that the user has mistakenly exchanged the arguments 
6436 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6438 @item -Waddress
6439 @opindex Waddress
6440 @opindex Wno-address
6441 Warn about suspicious uses of memory addresses. These include using
6442 the address of a function in a conditional expression, such as
6443 @code{void func(void); if (func)}, and comparisons against the memory
6444 address of a string literal, such as @code{if (x == "abc")}.  Such
6445 uses typically indicate a programmer error: the address of a function
6446 always evaluates to true, so their use in a conditional usually
6447 indicate that the programmer forgot the parentheses in a function
6448 call; and comparisons against string literals result in unspecified
6449 behavior and are not portable in C, so they usually indicate that the
6450 programmer intended to use @code{strcmp}.  This warning is enabled by
6451 @option{-Wall}.
6453 @item -Wlogical-op
6454 @opindex Wlogical-op
6455 @opindex Wno-logical-op
6456 Warn about suspicious uses of logical operators in expressions.
6457 This includes using logical operators in contexts where a
6458 bit-wise operator is likely to be expected.  Also warns when
6459 the operands of a logical operator are the same:
6460 @smallexample
6461 extern int a;
6462 if (a < 0 && a < 0) @{ @dots{} @}
6463 @end smallexample
6465 @item -Wlogical-not-parentheses
6466 @opindex Wlogical-not-parentheses
6467 @opindex Wno-logical-not-parentheses
6468 Warn about logical not used on the left hand side operand of a comparison.
6469 This option does not warn if the right operand is considered to be a boolean
6470 expression.  Its purpose is to detect suspicious code like the following:
6471 @smallexample
6472 int a;
6473 @dots{}
6474 if (!a > 1) @{ @dots{} @}
6475 @end smallexample
6477 It is possible to suppress the warning by wrapping the LHS into
6478 parentheses:
6479 @smallexample
6480 if ((!a) > 1) @{ @dots{} @}
6481 @end smallexample
6483 This warning is enabled by @option{-Wall}.
6485 @item -Waggregate-return
6486 @opindex Waggregate-return
6487 @opindex Wno-aggregate-return
6488 Warn if any functions that return structures or unions are defined or
6489 called.  (In languages where you can return an array, this also elicits
6490 a warning.)
6492 @item -Wno-aggressive-loop-optimizations
6493 @opindex Wno-aggressive-loop-optimizations
6494 @opindex Waggressive-loop-optimizations
6495 Warn if in a loop with constant number of iterations the compiler detects
6496 undefined behavior in some statement during one or more of the iterations.
6498 @item -Wno-attributes
6499 @opindex Wno-attributes
6500 @opindex Wattributes
6501 Do not warn if an unexpected @code{__attribute__} is used, such as
6502 unrecognized attributes, function attributes applied to variables,
6503 etc.  This does not stop errors for incorrect use of supported
6504 attributes.
6506 @item -Wno-builtin-declaration-mismatch
6507 @opindex Wno-builtin-declaration-mismatch
6508 @opindex Wbuiltin-declaration-mismatch
6509 Warn if a built-in function is declared with the wrong signature or 
6510 as non-function.
6511 This warning is enabled by default.
6513 @item -Wno-builtin-macro-redefined
6514 @opindex Wno-builtin-macro-redefined
6515 @opindex Wbuiltin-macro-redefined
6516 Do not warn if certain built-in macros are redefined.  This suppresses
6517 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6518 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6520 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6521 @opindex Wstrict-prototypes
6522 @opindex Wno-strict-prototypes
6523 Warn if a function is declared or defined without specifying the
6524 argument types.  (An old-style function definition is permitted without
6525 a warning if preceded by a declaration that specifies the argument
6526 types.)
6528 @item -Wold-style-declaration @r{(C and Objective-C only)}
6529 @opindex Wold-style-declaration
6530 @opindex Wno-old-style-declaration
6531 Warn for obsolescent usages, according to the C Standard, in a
6532 declaration. For example, warn if storage-class specifiers like
6533 @code{static} are not the first things in a declaration.  This warning
6534 is also enabled by @option{-Wextra}.
6536 @item -Wold-style-definition @r{(C and Objective-C only)}
6537 @opindex Wold-style-definition
6538 @opindex Wno-old-style-definition
6539 Warn if an old-style function definition is used.  A warning is given
6540 even if there is a previous prototype.
6542 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6543 @opindex Wmissing-parameter-type
6544 @opindex Wno-missing-parameter-type
6545 A function parameter is declared without a type specifier in K&R-style
6546 functions:
6548 @smallexample
6549 void foo(bar) @{ @}
6550 @end smallexample
6552 This warning is also enabled by @option{-Wextra}.
6554 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6555 @opindex Wmissing-prototypes
6556 @opindex Wno-missing-prototypes
6557 Warn if a global function is defined without a previous prototype
6558 declaration.  This warning is issued even if the definition itself
6559 provides a prototype.  Use this option to detect global functions
6560 that do not have a matching prototype declaration in a header file.
6561 This option is not valid for C++ because all function declarations
6562 provide prototypes and a non-matching declaration declares an
6563 overload rather than conflict with an earlier declaration.
6564 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6566 @item -Wmissing-declarations
6567 @opindex Wmissing-declarations
6568 @opindex Wno-missing-declarations
6569 Warn if a global function is defined without a previous declaration.
6570 Do so even if the definition itself provides a prototype.
6571 Use this option to detect global functions that are not declared in
6572 header files.  In C, no warnings are issued for functions with previous
6573 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6574 missing prototypes.  In C++, no warnings are issued for function templates,
6575 or for inline functions, or for functions in anonymous namespaces.
6577 @item -Wmissing-field-initializers
6578 @opindex Wmissing-field-initializers
6579 @opindex Wno-missing-field-initializers
6580 @opindex W
6581 @opindex Wextra
6582 @opindex Wno-extra
6583 Warn if a structure's initializer has some fields missing.  For
6584 example, the following code causes such a warning, because
6585 @code{x.h} is implicitly zero:
6587 @smallexample
6588 struct s @{ int f, g, h; @};
6589 struct s x = @{ 3, 4 @};
6590 @end smallexample
6592 This option does not warn about designated initializers, so the following
6593 modification does not trigger a warning:
6595 @smallexample
6596 struct s @{ int f, g, h; @};
6597 struct s x = @{ .f = 3, .g = 4 @};
6598 @end smallexample
6600 In C this option does not warn about the universal zero initializer
6601 @samp{@{ 0 @}}:
6603 @smallexample
6604 struct s @{ int f, g, h; @};
6605 struct s x = @{ 0 @};
6606 @end smallexample
6608 Likewise, in C++ this option does not warn about the empty @{ @}
6609 initializer, for example:
6611 @smallexample
6612 struct s @{ int f, g, h; @};
6613 s x = @{ @};
6614 @end smallexample
6616 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6617 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6619 @item -Wno-multichar
6620 @opindex Wno-multichar
6621 @opindex Wmultichar
6622 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6623 Usually they indicate a typo in the user's code, as they have
6624 implementation-defined values, and should not be used in portable code.
6626 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6627 @opindex Wnormalized=
6628 @opindex Wnormalized
6629 @opindex Wno-normalized
6630 @cindex NFC
6631 @cindex NFKC
6632 @cindex character set, input normalization
6633 In ISO C and ISO C++, two identifiers are different if they are
6634 different sequences of characters.  However, sometimes when characters
6635 outside the basic ASCII character set are used, you can have two
6636 different character sequences that look the same.  To avoid confusion,
6637 the ISO 10646 standard sets out some @dfn{normalization rules} which
6638 when applied ensure that two sequences that look the same are turned into
6639 the same sequence.  GCC can warn you if you are using identifiers that
6640 have not been normalized; this option controls that warning.
6642 There are four levels of warning supported by GCC@.  The default is
6643 @option{-Wnormalized=nfc}, which warns about any identifier that is
6644 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6645 recommended form for most uses.  It is equivalent to
6646 @option{-Wnormalized}.
6648 Unfortunately, there are some characters allowed in identifiers by
6649 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6650 identifiers.  That is, there's no way to use these symbols in portable
6651 ISO C or C++ and have all your identifiers in NFC@.
6652 @option{-Wnormalized=id} suppresses the warning for these characters.
6653 It is hoped that future versions of the standards involved will correct
6654 this, which is why this option is not the default.
6656 You can switch the warning off for all characters by writing
6657 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6658 only do this if you are using some other normalization scheme (like
6659 ``D''), because otherwise you can easily create bugs that are
6660 literally impossible to see.
6662 Some characters in ISO 10646 have distinct meanings but look identical
6663 in some fonts or display methodologies, especially once formatting has
6664 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6665 LETTER N'', displays just like a regular @code{n} that has been
6666 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6667 normalization scheme to convert all these into a standard form as
6668 well, and GCC warns if your code is not in NFKC if you use
6669 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6670 about every identifier that contains the letter O because it might be
6671 confused with the digit 0, and so is not the default, but may be
6672 useful as a local coding convention if the programming environment 
6673 cannot be fixed to display these characters distinctly.
6675 @item -Wno-deprecated
6676 @opindex Wno-deprecated
6677 @opindex Wdeprecated
6678 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6680 @item -Wno-deprecated-declarations
6681 @opindex Wno-deprecated-declarations
6682 @opindex Wdeprecated-declarations
6683 Do not warn about uses of functions (@pxref{Function Attributes}),
6684 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6685 Attributes}) marked as deprecated by using the @code{deprecated}
6686 attribute.
6688 @item -Wno-overflow
6689 @opindex Wno-overflow
6690 @opindex Woverflow
6691 Do not warn about compile-time overflow in constant expressions.
6693 @item -Wno-odr
6694 @opindex Wno-odr
6695 @opindex Wodr
6696 Warn about One Definition Rule violations during link-time optimization.
6697 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6699 @item -Wopenmp-simd
6700 @opindex Wopenm-simd
6701 Warn if the vectorizer cost model overrides the OpenMP
6702 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6703 option can be used to relax the cost model.
6705 @item -Woverride-init @r{(C and Objective-C only)}
6706 @opindex Woverride-init
6707 @opindex Wno-override-init
6708 @opindex W
6709 @opindex Wextra
6710 @opindex Wno-extra
6711 Warn if an initialized field without side effects is overridden when
6712 using designated initializers (@pxref{Designated Inits, , Designated
6713 Initializers}).
6715 This warning is included in @option{-Wextra}.  To get other
6716 @option{-Wextra} warnings without this one, use @option{-Wextra
6717 -Wno-override-init}.
6719 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6720 @opindex Woverride-init-side-effects
6721 @opindex Wno-override-init-side-effects
6722 Warn if an initialized field with side effects is overridden when
6723 using designated initializers (@pxref{Designated Inits, , Designated
6724 Initializers}).  This warning is enabled by default.
6726 @item -Wpacked
6727 @opindex Wpacked
6728 @opindex Wno-packed
6729 Warn if a structure is given the packed attribute, but the packed
6730 attribute has no effect on the layout or size of the structure.
6731 Such structures may be mis-aligned for little benefit.  For
6732 instance, in this code, the variable @code{f.x} in @code{struct bar}
6733 is misaligned even though @code{struct bar} does not itself
6734 have the packed attribute:
6736 @smallexample
6737 @group
6738 struct foo @{
6739   int x;
6740   char a, b, c, d;
6741 @} __attribute__((packed));
6742 struct bar @{
6743   char z;
6744   struct foo f;
6746 @end group
6747 @end smallexample
6749 @item -Wpacked-bitfield-compat
6750 @opindex Wpacked-bitfield-compat
6751 @opindex Wno-packed-bitfield-compat
6752 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6753 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6754 the change can lead to differences in the structure layout.  GCC
6755 informs you when the offset of such a field has changed in GCC 4.4.
6756 For example there is no longer a 4-bit padding between field @code{a}
6757 and @code{b} in this structure:
6759 @smallexample
6760 struct foo
6762   char a:4;
6763   char b:8;
6764 @} __attribute__ ((packed));
6765 @end smallexample
6767 This warning is enabled by default.  Use
6768 @option{-Wno-packed-bitfield-compat} to disable this warning.
6770 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6771 @opindex Wpacked-not-aligned
6772 @opindex Wno-packed-not-aligned
6773 Warn if a structure field with explicitly specified alignment in a
6774 packed struct or union is misaligned.  For example, a warning will
6775 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6776 'struct S' is less than 8}, in this code:
6778 @smallexample
6779 @group
6780 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6781 struct __attribute__ ((packed)) S @{
6782   struct S8 s8;
6784 @end group
6785 @end smallexample
6787 This warning is enabled by @option{-Wall}.
6789 @item -Wpadded
6790 @opindex Wpadded
6791 @opindex Wno-padded
6792 Warn if padding is included in a structure, either to align an element
6793 of the structure or to align the whole structure.  Sometimes when this
6794 happens it is possible to rearrange the fields of the structure to
6795 reduce the padding and so make the structure smaller.
6797 @item -Wredundant-decls
6798 @opindex Wredundant-decls
6799 @opindex Wno-redundant-decls
6800 Warn if anything is declared more than once in the same scope, even in
6801 cases where multiple declaration is valid and changes nothing.
6803 @item -Wno-restrict
6804 @opindex Wrestrict
6805 @opindex Wno-restrict
6806 Warn when an object referenced by a @code{restrict}-qualified parameter
6807 (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
6808 argument, or when copies between such objects overlap.  For example,
6809 the call to the @code{strcpy} function below attempts to truncate the string
6810 by replacing its initial characters with the last four.  However, because
6811 the call writes the terminating NUL into @code{a[4]}, the copies overlap and
6812 the call is diagnosed.
6814 @smallexample
6815 void foo (void)
6817   char a[] = "abcd1234";
6818   strcpy (a, a + 4);
6819   @dots{}
6821 @end smallexample
6822 The @option{-Wrestrict} option detects some instances of simple overlap
6823 even without optimization but works best at @option{-O2} and above.  It
6824 is included in @option{-Wall}.
6826 @item -Wnested-externs @r{(C and Objective-C only)}
6827 @opindex Wnested-externs
6828 @opindex Wno-nested-externs
6829 Warn if an @code{extern} declaration is encountered within a function.
6831 @item -Wno-inherited-variadic-ctor
6832 @opindex Winherited-variadic-ctor
6833 @opindex Wno-inherited-variadic-ctor
6834 Suppress warnings about use of C++11 inheriting constructors when the
6835 base class inherited from has a C variadic constructor; the warning is
6836 on by default because the ellipsis is not inherited.
6838 @item -Winline
6839 @opindex Winline
6840 @opindex Wno-inline
6841 Warn if a function that is declared as inline cannot be inlined.
6842 Even with this option, the compiler does not warn about failures to
6843 inline functions declared in system headers.
6845 The compiler uses a variety of heuristics to determine whether or not
6846 to inline a function.  For example, the compiler takes into account
6847 the size of the function being inlined and the amount of inlining
6848 that has already been done in the current function.  Therefore,
6849 seemingly insignificant changes in the source program can cause the
6850 warnings produced by @option{-Winline} to appear or disappear.
6852 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6853 @opindex Wno-invalid-offsetof
6854 @opindex Winvalid-offsetof
6855 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6856 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6857 to a non-standard-layout type is undefined.  In existing C++ implementations,
6858 however, @code{offsetof} typically gives meaningful results.
6859 This flag is for users who are aware that they are
6860 writing nonportable code and who have deliberately chosen to ignore the
6861 warning about it.
6863 The restrictions on @code{offsetof} may be relaxed in a future version
6864 of the C++ standard.
6866 @item -Wint-in-bool-context
6867 @opindex Wint-in-bool-context
6868 @opindex Wno-int-in-bool-context
6869 Warn for suspicious use of integer values where boolean values are expected,
6870 such as conditional expressions (?:) using non-boolean integer constants in
6871 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6872 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6873 for all kinds of multiplications regardless of the data type.
6874 This warning is enabled by @option{-Wall}.
6876 @item -Wno-int-to-pointer-cast
6877 @opindex Wno-int-to-pointer-cast
6878 @opindex Wint-to-pointer-cast
6879 Suppress warnings from casts to pointer type of an integer of a
6880 different size. In C++, casting to a pointer type of smaller size is
6881 an error. @option{Wint-to-pointer-cast} is enabled by default.
6884 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6885 @opindex Wno-pointer-to-int-cast
6886 @opindex Wpointer-to-int-cast
6887 Suppress warnings from casts from a pointer to an integer type of a
6888 different size.
6890 @item -Winvalid-pch
6891 @opindex Winvalid-pch
6892 @opindex Wno-invalid-pch
6893 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6894 the search path but cannot be used.
6896 @item -Wlong-long
6897 @opindex Wlong-long
6898 @opindex Wno-long-long
6899 Warn if @code{long long} type is used.  This is enabled by either
6900 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6901 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6903 @item -Wvariadic-macros
6904 @opindex Wvariadic-macros
6905 @opindex Wno-variadic-macros
6906 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6907 alternate syntax is used in ISO C99 mode.  This is enabled by either
6908 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6909 messages, use @option{-Wno-variadic-macros}.
6911 @item -Wvarargs
6912 @opindex Wvarargs
6913 @opindex Wno-varargs
6914 Warn upon questionable usage of the macros used to handle variable
6915 arguments like @code{va_start}.  This is default.  To inhibit the
6916 warning messages, use @option{-Wno-varargs}.
6918 @item -Wvector-operation-performance
6919 @opindex Wvector-operation-performance
6920 @opindex Wno-vector-operation-performance
6921 Warn if vector operation is not implemented via SIMD capabilities of the
6922 architecture.  Mainly useful for the performance tuning.
6923 Vector operation can be implemented @code{piecewise}, which means that the
6924 scalar operation is performed on every vector element; 
6925 @code{in parallel}, which means that the vector operation is implemented
6926 using scalars of wider type, which normally is more performance efficient;
6927 and @code{as a single scalar}, which means that vector fits into a
6928 scalar type.
6930 @item -Wno-virtual-move-assign
6931 @opindex Wvirtual-move-assign
6932 @opindex Wno-virtual-move-assign
6933 Suppress warnings about inheriting from a virtual base with a
6934 non-trivial C++11 move assignment operator.  This is dangerous because
6935 if the virtual base is reachable along more than one path, it is
6936 moved multiple times, which can mean both objects end up in the
6937 moved-from state.  If the move assignment operator is written to avoid
6938 moving from a moved-from object, this warning can be disabled.
6940 @item -Wvla
6941 @opindex Wvla
6942 @opindex Wno-vla
6943 Warn if a variable-length array is used in the code.
6944 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6945 the variable-length array.
6947 @item -Wvla-larger-than=@var{n}
6948 If this option is used, the compiler will warn on uses of
6949 variable-length arrays where the size is either unbounded, or bounded
6950 by an argument that can be larger than @var{n} bytes.  This is similar
6951 to how @option{-Walloca-larger-than=@var{n}} works, but with
6952 variable-length arrays.
6954 Note that GCC may optimize small variable-length arrays of a known
6955 value into plain arrays, so this warning may not get triggered for
6956 such arrays.
6958 This warning is not enabled by @option{-Wall}, and is only active when
6959 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6961 See also @option{-Walloca-larger-than=@var{n}}.
6963 @item -Wvolatile-register-var
6964 @opindex Wvolatile-register-var
6965 @opindex Wno-volatile-register-var
6966 Warn if a register variable is declared volatile.  The volatile
6967 modifier does not inhibit all optimizations that may eliminate reads
6968 and/or writes to register variables.  This warning is enabled by
6969 @option{-Wall}.
6971 @item -Wdisabled-optimization
6972 @opindex Wdisabled-optimization
6973 @opindex Wno-disabled-optimization
6974 Warn if a requested optimization pass is disabled.  This warning does
6975 not generally indicate that there is anything wrong with your code; it
6976 merely indicates that GCC's optimizers are unable to handle the code
6977 effectively.  Often, the problem is that your code is too big or too
6978 complex; GCC refuses to optimize programs when the optimization
6979 itself is likely to take inordinate amounts of time.
6981 @item -Wpointer-sign @r{(C and Objective-C only)}
6982 @opindex Wpointer-sign
6983 @opindex Wno-pointer-sign
6984 Warn for pointer argument passing or assignment with different signedness.
6985 This option is only supported for C and Objective-C@.  It is implied by
6986 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6987 @option{-Wno-pointer-sign}.
6989 @item -Wstack-protector
6990 @opindex Wstack-protector
6991 @opindex Wno-stack-protector
6992 This option is only active when @option{-fstack-protector} is active.  It
6993 warns about functions that are not protected against stack smashing.
6995 @item -Woverlength-strings
6996 @opindex Woverlength-strings
6997 @opindex Wno-overlength-strings
6998 Warn about string constants that are longer than the ``minimum
6999 maximum'' length specified in the C standard.  Modern compilers
7000 generally allow string constants that are much longer than the
7001 standard's minimum limit, but very portable programs should avoid
7002 using longer strings.
7004 The limit applies @emph{after} string constant concatenation, and does
7005 not count the trailing NUL@.  In C90, the limit was 509 characters; in
7006 C99, it was raised to 4095.  C++98 does not specify a normative
7007 minimum maximum, so we do not diagnose overlength strings in C++@.
7009 This option is implied by @option{-Wpedantic}, and can be disabled with
7010 @option{-Wno-overlength-strings}.
7012 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
7013 @opindex Wunsuffixed-float-constants
7015 Issue a warning for any floating constant that does not have
7016 a suffix.  When used together with @option{-Wsystem-headers} it
7017 warns about such constants in system header files.  This can be useful
7018 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
7019 from the decimal floating-point extension to C99.
7021 @item -Wno-designated-init @r{(C and Objective-C only)}
7022 Suppress warnings when a positional initializer is used to initialize
7023 a structure that has been marked with the @code{designated_init}
7024 attribute.
7026 @item -Whsa
7027 Issue a warning when HSAIL cannot be emitted for the compiled function or
7028 OpenMP construct.
7030 @end table
7032 @node Debugging Options
7033 @section Options for Debugging Your Program
7034 @cindex options, debugging
7035 @cindex debugging information options
7037 To tell GCC to emit extra information for use by a debugger, in almost 
7038 all cases you need only to add @option{-g} to your other options.
7040 GCC allows you to use @option{-g} with
7041 @option{-O}.  The shortcuts taken by optimized code may occasionally
7042 be surprising: some variables you declared may not exist
7043 at all; flow of control may briefly move where you did not expect it;
7044 some statements may not be executed because they compute constant
7045 results or their values are already at hand; some statements may
7046 execute in different places because they have been moved out of loops.
7047 Nevertheless it is possible to debug optimized output.  This makes
7048 it reasonable to use the optimizer for programs that might have bugs.
7050 If you are not using some other optimization option, consider
7051 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
7052 With no @option{-O} option at all, some compiler passes that collect
7053 information useful for debugging do not run at all, so that
7054 @option{-Og} may result in a better debugging experience.
7056 @table @gcctabopt
7057 @item -g
7058 @opindex g
7059 Produce debugging information in the operating system's native format
7060 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
7061 information.
7063 On most systems that use stabs format, @option{-g} enables use of extra
7064 debugging information that only GDB can use; this extra information
7065 makes debugging work better in GDB but probably makes other debuggers
7066 crash or
7067 refuse to read the program.  If you want to control for certain whether
7068 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
7069 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
7071 @item -ggdb
7072 @opindex ggdb
7073 Produce debugging information for use by GDB@.  This means to use the
7074 most expressive format available (DWARF, stabs, or the native format
7075 if neither of those are supported), including GDB extensions if at all
7076 possible.
7078 @item -gdwarf
7079 @itemx -gdwarf-@var{version}
7080 @opindex gdwarf
7081 Produce debugging information in DWARF format (if that is supported).
7082 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7083 for most targets is 4.  DWARF Version 5 is only experimental.
7085 Note that with DWARF Version 2, some ports require and always
7086 use some non-conflicting DWARF 3 extensions in the unwind tables.
7088 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7089 for maximum benefit.
7091 GCC no longer supports DWARF Version 1, which is substantially
7092 different than Version 2 and later.  For historical reasons, some
7093 other DWARF-related options such as
7094 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7095 in their names, but apply to all currently-supported versions of DWARF.
7097 @item -gstabs
7098 @opindex gstabs
7099 Produce debugging information in stabs format (if that is supported),
7100 without GDB extensions.  This is the format used by DBX on most BSD
7101 systems.  On MIPS, Alpha and System V Release 4 systems this option
7102 produces stabs debugging output that is not understood by DBX@.
7103 On System V Release 4 systems this option requires the GNU assembler.
7105 @item -gstabs+
7106 @opindex gstabs+
7107 Produce debugging information in stabs format (if that is supported),
7108 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7109 use of these extensions is likely to make other debuggers crash or
7110 refuse to read the program.
7112 @item -gxcoff
7113 @opindex gxcoff
7114 Produce debugging information in XCOFF format (if that is supported).
7115 This is the format used by the DBX debugger on IBM RS/6000 systems.
7117 @item -gxcoff+
7118 @opindex gxcoff+
7119 Produce debugging information in XCOFF format (if that is supported),
7120 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7121 use of these extensions is likely to make other debuggers crash or
7122 refuse to read the program, and may cause assemblers other than the GNU
7123 assembler (GAS) to fail with an error.
7125 @item -gvms
7126 @opindex gvms
7127 Produce debugging information in Alpha/VMS debug format (if that is
7128 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7130 @item -g@var{level}
7131 @itemx -ggdb@var{level}
7132 @itemx -gstabs@var{level}
7133 @itemx -gxcoff@var{level}
7134 @itemx -gvms@var{level}
7135 Request debugging information and also use @var{level} to specify how
7136 much information.  The default level is 2.
7138 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7139 @option{-g}.
7141 Level 1 produces minimal information, enough for making backtraces in
7142 parts of the program that you don't plan to debug.  This includes
7143 descriptions of functions and external variables, and line number
7144 tables, but no information about local variables.
7146 Level 3 includes extra information, such as all the macro definitions
7147 present in the program.  Some debuggers support macro expansion when
7148 you use @option{-g3}.
7150 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7151 confusion with @option{-gdwarf-@var{level}}.
7152 Instead use an additional @option{-g@var{level}} option to change the
7153 debug level for DWARF.
7155 @item -feliminate-unused-debug-symbols
7156 @opindex feliminate-unused-debug-symbols
7157 Produce debugging information in stabs format (if that is supported),
7158 for only symbols that are actually used.
7160 @item -femit-class-debug-always
7161 @opindex femit-class-debug-always
7162 Instead of emitting debugging information for a C++ class in only one
7163 object file, emit it in all object files using the class.  This option
7164 should be used only with debuggers that are unable to handle the way GCC
7165 normally emits debugging information for classes because using this
7166 option increases the size of debugging information by as much as a
7167 factor of two.
7169 @item -fno-merge-debug-strings
7170 @opindex fmerge-debug-strings
7171 @opindex fno-merge-debug-strings
7172 Direct the linker to not merge together strings in the debugging
7173 information that are identical in different object files.  Merging is
7174 not supported by all assemblers or linkers.  Merging decreases the size
7175 of the debug information in the output file at the cost of increasing
7176 link processing time.  Merging is enabled by default.
7178 @item -fdebug-prefix-map=@var{old}=@var{new}
7179 @opindex fdebug-prefix-map
7180 When compiling files residing in directory @file{@var{old}}, record
7181 debugging information describing them as if the files resided in
7182 directory @file{@var{new}} instead.  This can be used to replace a
7183 build-time path with an install-time path in the debug info.  It can
7184 also be used to change an absolute path to a relative path by using
7185 @file{.} for @var{new}.  This can give more reproducible builds, which
7186 are location independent, but may require an extra command to tell GDB
7187 where to find the source files. See also @option{-ffile-prefix-map}.
7189 @item -fvar-tracking
7190 @opindex fvar-tracking
7191 Run variable tracking pass.  It computes where variables are stored at each
7192 position in code.  Better debugging information is then generated
7193 (if the debugging information format supports this information).
7195 It is enabled by default when compiling with optimization (@option{-Os},
7196 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7197 the debug info format supports it.
7199 @item -fvar-tracking-assignments
7200 @opindex fvar-tracking-assignments
7201 @opindex fno-var-tracking-assignments
7202 Annotate assignments to user variables early in the compilation and
7203 attempt to carry the annotations over throughout the compilation all the
7204 way to the end, in an attempt to improve debug information while
7205 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7207 It can be enabled even if var-tracking is disabled, in which case
7208 annotations are created and maintained, but discarded at the end.
7209 By default, this flag is enabled together with @option{-fvar-tracking},
7210 except when selective scheduling is enabled.
7212 @item -gsplit-dwarf
7213 @opindex gsplit-dwarf
7214 Separate as much DWARF debugging information as possible into a
7215 separate output file with the extension @file{.dwo}.  This option allows
7216 the build system to avoid linking files with debug information.  To
7217 be useful, this option requires a debugger capable of reading @file{.dwo}
7218 files.
7220 @item -gpubnames
7221 @opindex gpubnames
7222 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7224 @item -ggnu-pubnames
7225 @opindex ggnu-pubnames
7226 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7227 suitable for conversion into a GDB@ index.  This option is only useful
7228 with a linker that can produce GDB@ index version 7.
7230 @item -fdebug-types-section
7231 @opindex fdebug-types-section
7232 @opindex fno-debug-types-section
7233 When using DWARF Version 4 or higher, type DIEs can be put into
7234 their own @code{.debug_types} section instead of making them part of the
7235 @code{.debug_info} section.  It is more efficient to put them in a separate
7236 comdat section since the linker can then remove duplicates.
7237 But not all DWARF consumers support @code{.debug_types} sections yet
7238 and on some objects @code{.debug_types} produces larger instead of smaller
7239 debugging information.
7241 @item -grecord-gcc-switches
7242 @itemx -gno-record-gcc-switches
7243 @opindex grecord-gcc-switches
7244 @opindex gno-record-gcc-switches
7245 This switch causes the command-line options used to invoke the
7246 compiler that may affect code generation to be appended to the
7247 DW_AT_producer attribute in DWARF debugging information.  The options
7248 are concatenated with spaces separating them from each other and from
7249 the compiler version.  
7250 It is enabled by default.
7251 See also @option{-frecord-gcc-switches} for another
7252 way of storing compiler options into the object file.  
7254 @item -gstrict-dwarf
7255 @opindex gstrict-dwarf
7256 Disallow using extensions of later DWARF standard version than selected
7257 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7258 DWARF extensions from later standard versions is allowed.
7260 @item -gno-strict-dwarf
7261 @opindex gno-strict-dwarf
7262 Allow using extensions of later DWARF standard version than selected with
7263 @option{-gdwarf-@var{version}}.
7265 @item -gas-loc-support
7266 @opindex gas-loc-support
7267 Inform the compiler that the assembler supports @code{.loc} directives.
7268 It may then use them for the assembler to generate DWARF2+ line number
7269 tables.
7271 This is generally desirable, because assembler-generated line-number
7272 tables are a lot more compact than those the compiler can generate
7273 itself.
7275 This option will be enabled by default if, at GCC configure time, the
7276 assembler was found to support such directives.
7278 @item -gno-as-loc-support
7279 @opindex gno-as-loc-support
7280 Force GCC to generate DWARF2+ line number tables internally, if DWARF2+
7281 line number tables are to be generated.
7283 @item gas-locview-support
7284 @opindex gas-locview-support
7285 Inform the compiler that the assembler supports @code{view} assignment
7286 and reset assertion checking in @code{.loc} directives.
7288 This option will be enabled by default if, at GCC configure time, the
7289 assembler was found to support them.
7291 @item gno-as-locview-support
7292 Force GCC to assign view numbers internally, if
7293 @option{-gvariable-location-views} are explicitly requested.
7295 @item -gcolumn-info
7296 @itemx -gno-column-info
7297 @opindex gcolumn-info
7298 @opindex gno-column-info
7299 Emit location column information into DWARF debugging information, rather
7300 than just file and line.
7301 This option is enabled by default.
7303 @item -gstatement-frontiers
7304 @itemx -gno-statement-frontiers
7305 @opindex gstatement-frontiers
7306 @opindex gno-statement-frontiers
7307 This option causes GCC to create markers in the internal representation
7308 at the beginning of statements, and to keep them roughly in place
7309 throughout compilation, using them to guide the output of @code{is_stmt}
7310 markers in the line number table.  This is enabled by default when
7311 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7312 @dots{}), and outputting DWARF 2 debug information at the normal level.
7314 @item -gvariable-location-views
7315 @itemx -gvariable-location-views=incompat5
7316 @itemx -gno-variable-location-views
7317 @opindex gvariable-location-views
7318 @opindex gvariable-location-views=incompat5
7319 @opindex gno-variable-location-views
7320 Augment variable location lists with progressive view numbers implied
7321 from the line number table.  This enables debug information consumers to
7322 inspect state at certain points of the program, even if no instructions
7323 associated with the corresponding source locations are present at that
7324 point.  If the assembler lacks support for view numbers in line number
7325 tables, this will cause the compiler to emit the line number table,
7326 which generally makes them somewhat less compact.  The augmented line
7327 number tables and location lists are fully backward-compatible, so they
7328 can be consumed by debug information consumers that are not aware of
7329 these augmentations, but they won't derive any benefit from them either.
7331 This is enabled by default when outputting DWARF 2 debug information at
7332 the normal level, as long as there is assembler support,
7333 @option{-fvar-tracking-assignments} is enabled and
7334 @option{-gstrict-dwarf} is not.  When assembler support is not
7335 available, this may still be enabled, but it will force GCC to output
7336 internal line number tables, and if
7337 @option{-ginternal-reset-location-views} is not enabled, that will most
7338 certainly lead to silently mismatching location views.
7340 There is a proposed representation for view numbers that is not backward
7341 compatible with the location list format introduced in DWARF 5, that can
7342 be enabled with @option{-gvariable-location-views=incompat5}.  This
7343 option may be removed in the future, is only provided as a reference
7344 implementation of the proposed representation.  Debug information
7345 consumers are not expected to support this extended format, and they
7346 would be rendered unable to decode location lists using it.
7348 @item -ginternal-reset-location-views
7349 @itemx -gnointernal-reset-location-views
7350 @opindex ginternal-reset-location-views
7351 @opindex gno-internal-reset-location-views
7352 Attempt to determine location views that can be omitted from location
7353 view lists.  This requires the compiler to have very accurate insn
7354 length estimates, which isn't always the case, and it may cause
7355 incorrect view lists to be generated silently when using an assembler
7356 that does not support location view lists.  The GNU assembler will flag
7357 any such error as a @code{view number mismatch}.  This is only enabled
7358 on ports that define a reliable estimation function.
7360 @item -ginline-points
7361 @itemx -gno-inline-points
7362 @opindex ginline-points
7363 @opindex gno-inline-points
7364 Generate extended debug information for inlined functions.  Location
7365 view tracking markers are inserted at inlined entry points, so that
7366 address and view numbers can be computed and output in debug
7367 information.  This can be enabled independently of location views, in
7368 which case the view numbers won't be output, but it can only be enabled
7369 along with statement frontiers, and it is only enabled by default if
7370 location views are enabled.
7372 @item -gz@r{[}=@var{type}@r{]}
7373 @opindex gz
7374 Produce compressed debug sections in DWARF format, if that is supported.
7375 If @var{type} is not given, the default type depends on the capabilities
7376 of the assembler and linker used.  @var{type} may be one of
7377 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7378 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7379 compression in traditional GNU format).  If the linker doesn't support
7380 writing compressed debug sections, the option is rejected.  Otherwise,
7381 if the assembler does not support them, @option{-gz} is silently ignored
7382 when producing object files.
7384 @item -femit-struct-debug-baseonly
7385 @opindex femit-struct-debug-baseonly
7386 Emit debug information for struct-like types
7387 only when the base name of the compilation source file
7388 matches the base name of file in which the struct is defined.
7390 This option substantially reduces the size of debugging information,
7391 but at significant potential loss in type information to the debugger.
7392 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7393 See @option{-femit-struct-debug-detailed} for more detailed control.
7395 This option works only with DWARF debug output.
7397 @item -femit-struct-debug-reduced
7398 @opindex femit-struct-debug-reduced
7399 Emit debug information for struct-like types
7400 only when the base name of the compilation source file
7401 matches the base name of file in which the type is defined,
7402 unless the struct is a template or defined in a system header.
7404 This option significantly reduces the size of debugging information,
7405 with some potential loss in type information to the debugger.
7406 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7407 See @option{-femit-struct-debug-detailed} for more detailed control.
7409 This option works only with DWARF debug output.
7411 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7412 @opindex femit-struct-debug-detailed
7413 Specify the struct-like types
7414 for which the compiler generates debug information.
7415 The intent is to reduce duplicate struct debug information
7416 between different object files within the same program.
7418 This option is a detailed version of
7419 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7420 which serves for most needs.
7422 A specification has the syntax@*
7423 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7425 The optional first word limits the specification to
7426 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7427 A struct type is used directly when it is the type of a variable, member.
7428 Indirect uses arise through pointers to structs.
7429 That is, when use of an incomplete struct is valid, the use is indirect.
7430 An example is
7431 @samp{struct one direct; struct two * indirect;}.
7433 The optional second word limits the specification to
7434 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7435 Generic structs are a bit complicated to explain.
7436 For C++, these are non-explicit specializations of template classes,
7437 or non-template classes within the above.
7438 Other programming languages have generics,
7439 but @option{-femit-struct-debug-detailed} does not yet implement them.
7441 The third word specifies the source files for those
7442 structs for which the compiler should emit debug information.
7443 The values @samp{none} and @samp{any} have the normal meaning.
7444 The value @samp{base} means that
7445 the base of name of the file in which the type declaration appears
7446 must match the base of the name of the main compilation file.
7447 In practice, this means that when compiling @file{foo.c}, debug information
7448 is generated for types declared in that file and @file{foo.h},
7449 but not other header files.
7450 The value @samp{sys} means those types satisfying @samp{base}
7451 or declared in system or compiler headers.
7453 You may need to experiment to determine the best settings for your application.
7455 The default is @option{-femit-struct-debug-detailed=all}.
7457 This option works only with DWARF debug output.
7459 @item -fno-dwarf2-cfi-asm
7460 @opindex fdwarf2-cfi-asm
7461 @opindex fno-dwarf2-cfi-asm
7462 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7463 instead of using GAS @code{.cfi_*} directives.
7465 @item -fno-eliminate-unused-debug-types
7466 @opindex feliminate-unused-debug-types
7467 @opindex fno-eliminate-unused-debug-types
7468 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7469 output for types that are nowhere used in the source file being compiled.
7470 Sometimes it is useful to have GCC emit debugging
7471 information for all types declared in a compilation
7472 unit, regardless of whether or not they are actually used
7473 in that compilation unit, for example 
7474 if, in the debugger, you want to cast a value to a type that is
7475 not actually used in your program (but is declared).  More often,
7476 however, this results in a significant amount of wasted space.
7477 @end table
7479 @node Optimize Options
7480 @section Options That Control Optimization
7481 @cindex optimize options
7482 @cindex options, optimization
7484 These options control various sorts of optimizations.
7486 Without any optimization option, the compiler's goal is to reduce the
7487 cost of compilation and to make debugging produce the expected
7488 results.  Statements are independent: if you stop the program with a
7489 breakpoint between statements, you can then assign a new value to any
7490 variable or change the program counter to any other statement in the
7491 function and get exactly the results you expect from the source
7492 code.
7494 Turning on optimization flags makes the compiler attempt to improve
7495 the performance and/or code size at the expense of compilation time
7496 and possibly the ability to debug the program.
7498 The compiler performs optimization based on the knowledge it has of the
7499 program.  Compiling multiple files at once to a single output file mode allows
7500 the compiler to use information gained from all of the files when compiling
7501 each of them.
7503 Not all optimizations are controlled directly by a flag.  Only
7504 optimizations that have a flag are listed in this section.
7506 Most optimizations are only enabled if an @option{-O} level is set on
7507 the command line.  Otherwise they are disabled, even if individual
7508 optimization flags are specified.
7510 Depending on the target and how GCC was configured, a slightly different
7511 set of optimizations may be enabled at each @option{-O} level than
7512 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7513 to find out the exact set of optimizations that are enabled at each level.
7514 @xref{Overall Options}, for examples.
7516 @table @gcctabopt
7517 @item -O
7518 @itemx -O1
7519 @opindex O
7520 @opindex O1
7521 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7522 more memory for a large function.
7524 With @option{-O}, the compiler tries to reduce code size and execution
7525 time, without performing any optimizations that take a great deal of
7526 compilation time.
7528 @option{-O} turns on the following optimization flags:
7529 @gccoptlist{
7530 -fauto-inc-dec @gol
7531 -fbranch-count-reg @gol
7532 -fcombine-stack-adjustments @gol
7533 -fcompare-elim @gol
7534 -fcprop-registers @gol
7535 -fdce @gol
7536 -fdefer-pop @gol
7537 -fdelayed-branch @gol
7538 -fdse @gol
7539 -fforward-propagate @gol
7540 -fguess-branch-probability @gol
7541 -fif-conversion2 @gol
7542 -fif-conversion @gol
7543 -finline-functions-called-once @gol
7544 -fipa-pure-const @gol
7545 -fipa-profile @gol
7546 -fipa-reference @gol
7547 -fmerge-constants @gol
7548 -fmove-loop-invariants @gol
7549 -fomit-frame-pointer @gol
7550 -freorder-blocks @gol
7551 -fshrink-wrap @gol
7552 -fshrink-wrap-separate @gol
7553 -fsplit-wide-types @gol
7554 -fssa-backprop @gol
7555 -fssa-phiopt @gol
7556 -ftree-bit-ccp @gol
7557 -ftree-ccp @gol
7558 -ftree-ch @gol
7559 -ftree-coalesce-vars @gol
7560 -ftree-copy-prop @gol
7561 -ftree-dce @gol
7562 -ftree-dominator-opts @gol
7563 -ftree-dse @gol
7564 -ftree-forwprop @gol
7565 -ftree-fre @gol
7566 -ftree-phiprop @gol
7567 -ftree-sink @gol
7568 -ftree-slsr @gol
7569 -ftree-sra @gol
7570 -ftree-pta @gol
7571 -ftree-ter @gol
7572 -funit-at-a-time}
7574 @item -O2
7575 @opindex O2
7576 Optimize even more.  GCC performs nearly all supported optimizations
7577 that do not involve a space-speed tradeoff.
7578 As compared to @option{-O}, this option increases both compilation time
7579 and the performance of the generated code.
7581 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7582 also turns on the following optimization flags:
7583 @gccoptlist{-fthread-jumps @gol
7584 -falign-functions  -falign-jumps @gol
7585 -falign-loops  -falign-labels @gol
7586 -fcaller-saves @gol
7587 -fcrossjumping @gol
7588 -fcse-follow-jumps  -fcse-skip-blocks @gol
7589 -fdelete-null-pointer-checks @gol
7590 -fdevirtualize -fdevirtualize-speculatively @gol
7591 -fexpensive-optimizations @gol
7592 -fgcse  -fgcse-lm  @gol
7593 -fhoist-adjacent-loads @gol
7594 -finline-small-functions @gol
7595 -findirect-inlining @gol
7596 -fipa-cp @gol
7597 -fipa-bit-cp @gol
7598 -fipa-vrp @gol
7599 -fipa-sra @gol
7600 -fipa-icf @gol
7601 -fisolate-erroneous-paths-dereference @gol
7602 -flra-remat @gol
7603 -foptimize-sibling-calls @gol
7604 -foptimize-strlen @gol
7605 -fpartial-inlining @gol
7606 -fpeephole2 @gol
7607 -freorder-blocks-algorithm=stc @gol
7608 -freorder-blocks-and-partition -freorder-functions @gol
7609 -frerun-cse-after-loop  @gol
7610 -fsched-interblock  -fsched-spec @gol
7611 -fschedule-insns  -fschedule-insns2 @gol
7612 -fstore-merging @gol
7613 -fstrict-aliasing @gol
7614 -ftree-builtin-call-dce @gol
7615 -ftree-switch-conversion -ftree-tail-merge @gol
7616 -fcode-hoisting @gol
7617 -ftree-pre @gol
7618 -ftree-vrp @gol
7619 -fipa-ra}
7621 Please note the warning under @option{-fgcse} about
7622 invoking @option{-O2} on programs that use computed gotos.
7624 @item -O3
7625 @opindex O3
7626 Optimize yet more.  @option{-O3} turns on all optimizations specified
7627 by @option{-O2} and also turns on the following optimization flags:
7628 @gccoptlist{-finline-functions @gol
7629 -funswitch-loops @gol
7630 -fpredictive-commoning @gol
7631 -fgcse-after-reload @gol
7632 -ftree-loop-vectorize @gol
7633 -ftree-loop-distribution @gol
7634 -ftree-loop-distribute-patterns @gol
7635 -floop-interchange @gol
7636 -floop-unroll-and-jam @gol
7637 -fsplit-paths @gol
7638 -ftree-slp-vectorize @gol
7639 -fvect-cost-model @gol
7640 -ftree-partial-pre @gol
7641 -fpeel-loops @gol
7642 -fipa-cp-clone}
7644 @item -O0
7645 @opindex O0
7646 Reduce compilation time and make debugging produce the expected
7647 results.  This is the default.
7649 @item -Os
7650 @opindex Os
7651 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7652 do not typically increase code size.  It also performs further
7653 optimizations designed to reduce code size.
7655 @option{-Os} disables the following optimization flags:
7656 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7657 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7658 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7660 @item -Ofast
7661 @opindex Ofast
7662 Disregard strict standards compliance.  @option{-Ofast} enables all
7663 @option{-O3} optimizations.  It also enables optimizations that are not
7664 valid for all standard-compliant programs.
7665 It turns on @option{-ffast-math} and the Fortran-specific
7666 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7667 specified, and @option{-fno-protect-parens}.
7669 @item -Og
7670 @opindex Og
7671 Optimize debugging experience.  @option{-Og} enables optimizations
7672 that do not interfere with debugging. It should be the optimization
7673 level of choice for the standard edit-compile-debug cycle, offering
7674 a reasonable level of optimization while maintaining fast compilation
7675 and a good debugging experience.
7676 @end table
7678 If you use multiple @option{-O} options, with or without level numbers,
7679 the last such option is the one that is effective.
7681 Options of the form @option{-f@var{flag}} specify machine-independent
7682 flags.  Most flags have both positive and negative forms; the negative
7683 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7684 below, only one of the forms is listed---the one you typically 
7685 use.  You can figure out the other form by either removing @samp{no-}
7686 or adding it.
7688 The following options control specific optimizations.  They are either
7689 activated by @option{-O} options or are related to ones that are.  You
7690 can use the following flags in the rare cases when ``fine-tuning'' of
7691 optimizations to be performed is desired.
7693 @table @gcctabopt
7694 @item -fno-defer-pop
7695 @opindex fno-defer-pop
7696 Always pop the arguments to each function call as soon as that function
7697 returns.  For machines that must pop arguments after a function call,
7698 the compiler normally lets arguments accumulate on the stack for several
7699 function calls and pops them all at once.
7701 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7703 @item -fforward-propagate
7704 @opindex fforward-propagate
7705 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7706 instructions and checks if the result can be simplified.  If loop unrolling
7707 is active, two passes are performed and the second is scheduled after
7708 loop unrolling.
7710 This option is enabled by default at optimization levels @option{-O},
7711 @option{-O2}, @option{-O3}, @option{-Os}.
7713 @item -ffp-contract=@var{style}
7714 @opindex ffp-contract
7715 @option{-ffp-contract=off} disables floating-point expression contraction.
7716 @option{-ffp-contract=fast} enables floating-point expression contraction
7717 such as forming of fused multiply-add operations if the target has
7718 native support for them.
7719 @option{-ffp-contract=on} enables floating-point expression contraction
7720 if allowed by the language standard.  This is currently not implemented
7721 and treated equal to @option{-ffp-contract=off}.
7723 The default is @option{-ffp-contract=fast}.
7725 @item -fomit-frame-pointer
7726 @opindex fomit-frame-pointer
7727 Omit the frame pointer in functions that don't need one.  This avoids the
7728 instructions to save, set up and restore the frame pointer; on many targets
7729 it also makes an extra register available.
7731 On some targets this flag has no effect because the standard calling sequence
7732 always uses a frame pointer, so it cannot be omitted.
7734 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7735 is used in all functions.  Several targets always omit the frame pointer in
7736 leaf functions.
7738 Enabled by default at @option{-O} and higher.
7740 @item -foptimize-sibling-calls
7741 @opindex foptimize-sibling-calls
7742 Optimize sibling and tail recursive calls.
7744 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7746 @item -foptimize-strlen
7747 @opindex foptimize-strlen
7748 Optimize various standard C string functions (e.g. @code{strlen},
7749 @code{strchr} or @code{strcpy}) and
7750 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7752 Enabled at levels @option{-O2}, @option{-O3}.
7754 @item -fno-inline
7755 @opindex fno-inline
7756 Do not expand any functions inline apart from those marked with
7757 the @code{always_inline} attribute.  This is the default when not
7758 optimizing.
7760 Single functions can be exempted from inlining by marking them
7761 with the @code{noinline} attribute.
7763 @item -finline-small-functions
7764 @opindex finline-small-functions
7765 Integrate functions into their callers when their body is smaller than expected
7766 function call code (so overall size of program gets smaller).  The compiler
7767 heuristically decides which functions are simple enough to be worth integrating
7768 in this way.  This inlining applies to all functions, even those not declared
7769 inline.
7771 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7773 @item -findirect-inlining
7774 @opindex findirect-inlining
7775 Inline also indirect calls that are discovered to be known at compile
7776 time thanks to previous inlining.  This option has any effect only
7777 when inlining itself is turned on by the @option{-finline-functions}
7778 or @option{-finline-small-functions} options.
7780 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7782 @item -finline-functions
7783 @opindex finline-functions
7784 Consider all functions for inlining, even if they are not declared inline.
7785 The compiler heuristically decides which functions are worth integrating
7786 in this way.
7788 If all calls to a given function are integrated, and the function is
7789 declared @code{static}, then the function is normally not output as
7790 assembler code in its own right.
7792 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7794 @item -finline-functions-called-once
7795 @opindex finline-functions-called-once
7796 Consider all @code{static} functions called once for inlining into their
7797 caller even if they are not marked @code{inline}.  If a call to a given
7798 function is integrated, then the function is not output as assembler code
7799 in its own right.
7801 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7803 @item -fearly-inlining
7804 @opindex fearly-inlining
7805 Inline functions marked by @code{always_inline} and functions whose body seems
7806 smaller than the function call overhead early before doing
7807 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7808 makes profiling significantly cheaper and usually inlining faster on programs
7809 having large chains of nested wrapper functions.
7811 Enabled by default.
7813 @item -fipa-sra
7814 @opindex fipa-sra
7815 Perform interprocedural scalar replacement of aggregates, removal of
7816 unused parameters and replacement of parameters passed by reference
7817 by parameters passed by value.
7819 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7821 @item -finline-limit=@var{n}
7822 @opindex finline-limit
7823 By default, GCC limits the size of functions that can be inlined.  This flag
7824 allows coarse control of this limit.  @var{n} is the size of functions that
7825 can be inlined in number of pseudo instructions.
7827 Inlining is actually controlled by a number of parameters, which may be
7828 specified individually by using @option{--param @var{name}=@var{value}}.
7829 The @option{-finline-limit=@var{n}} option sets some of these parameters
7830 as follows:
7832 @table @gcctabopt
7833 @item max-inline-insns-single
7834 is set to @var{n}/2.
7835 @item max-inline-insns-auto
7836 is set to @var{n}/2.
7837 @end table
7839 See below for a documentation of the individual
7840 parameters controlling inlining and for the defaults of these parameters.
7842 @emph{Note:} there may be no value to @option{-finline-limit} that results
7843 in default behavior.
7845 @emph{Note:} pseudo instruction represents, in this particular context, an
7846 abstract measurement of function's size.  In no way does it represent a count
7847 of assembly instructions and as such its exact meaning might change from one
7848 release to an another.
7850 @item -fno-keep-inline-dllexport
7851 @opindex fno-keep-inline-dllexport
7852 This is a more fine-grained version of @option{-fkeep-inline-functions},
7853 which applies only to functions that are declared using the @code{dllexport}
7854 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7855 Functions}.
7857 @item -fkeep-inline-functions
7858 @opindex fkeep-inline-functions
7859 In C, emit @code{static} functions that are declared @code{inline}
7860 into the object file, even if the function has been inlined into all
7861 of its callers.  This switch does not affect functions using the
7862 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7863 inline functions into the object file.
7865 @item -fkeep-static-functions
7866 @opindex fkeep-static-functions
7867 Emit @code{static} functions into the object file, even if the function
7868 is never used.
7870 @item -fkeep-static-consts
7871 @opindex fkeep-static-consts
7872 Emit variables declared @code{static const} when optimization isn't turned
7873 on, even if the variables aren't referenced.
7875 GCC enables this option by default.  If you want to force the compiler to
7876 check if a variable is referenced, regardless of whether or not
7877 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7879 @item -fmerge-constants
7880 @opindex fmerge-constants
7881 Attempt to merge identical constants (string constants and floating-point
7882 constants) across compilation units.
7884 This option is the default for optimized compilation if the assembler and
7885 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7886 behavior.
7888 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7890 @item -fmerge-all-constants
7891 @opindex fmerge-all-constants
7892 Attempt to merge identical constants and identical variables.
7894 This option implies @option{-fmerge-constants}.  In addition to
7895 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7896 arrays or initialized constant variables with integral or floating-point
7897 types.  Languages like C or C++ require each variable, including multiple
7898 instances of the same variable in recursive calls, to have distinct locations,
7899 so using this option results in non-conforming
7900 behavior.
7902 @item -fmodulo-sched
7903 @opindex fmodulo-sched
7904 Perform swing modulo scheduling immediately before the first scheduling
7905 pass.  This pass looks at innermost loops and reorders their
7906 instructions by overlapping different iterations.
7908 @item -fmodulo-sched-allow-regmoves
7909 @opindex fmodulo-sched-allow-regmoves
7910 Perform more aggressive SMS-based modulo scheduling with register moves
7911 allowed.  By setting this flag certain anti-dependences edges are
7912 deleted, which triggers the generation of reg-moves based on the
7913 life-range analysis.  This option is effective only with
7914 @option{-fmodulo-sched} enabled.
7916 @item -fno-branch-count-reg
7917 @opindex fno-branch-count-reg
7918 Avoid running a pass scanning for opportunities to use ``decrement and
7919 branch'' instructions on a count register instead of generating sequences
7920 of instructions that decrement a register, compare it against zero, and
7921 then branch based upon the result.  This option is only meaningful on
7922 architectures that support such instructions, which include x86, PowerPC,
7923 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7924 doesn't remove the decrement and branch instructions from the generated
7925 instruction stream introduced by other optimization passes.
7927 Enabled by default at @option{-O1} and higher.
7929 The default is @option{-fbranch-count-reg}.
7931 @item -fno-function-cse
7932 @opindex fno-function-cse
7933 Do not put function addresses in registers; make each instruction that
7934 calls a constant function contain the function's address explicitly.
7936 This option results in less efficient code, but some strange hacks
7937 that alter the assembler output may be confused by the optimizations
7938 performed when this option is not used.
7940 The default is @option{-ffunction-cse}
7942 @item -fno-zero-initialized-in-bss
7943 @opindex fno-zero-initialized-in-bss
7944 If the target supports a BSS section, GCC by default puts variables that
7945 are initialized to zero into BSS@.  This can save space in the resulting
7946 code.
7948 This option turns off this behavior because some programs explicitly
7949 rely on variables going to the data section---e.g., so that the
7950 resulting executable can find the beginning of that section and/or make
7951 assumptions based on that.
7953 The default is @option{-fzero-initialized-in-bss}.
7955 @item -fthread-jumps
7956 @opindex fthread-jumps
7957 Perform optimizations that check to see if a jump branches to a
7958 location where another comparison subsumed by the first is found.  If
7959 so, the first branch is redirected to either the destination of the
7960 second branch or a point immediately following it, depending on whether
7961 the condition is known to be true or false.
7963 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7965 @item -fsplit-wide-types
7966 @opindex fsplit-wide-types
7967 When using a type that occupies multiple registers, such as @code{long
7968 long} on a 32-bit system, split the registers apart and allocate them
7969 independently.  This normally generates better code for those types,
7970 but may make debugging more difficult.
7972 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7973 @option{-Os}.
7975 @item -fcse-follow-jumps
7976 @opindex fcse-follow-jumps
7977 In common subexpression elimination (CSE), scan through jump instructions
7978 when the target of the jump is not reached by any other path.  For
7979 example, when CSE encounters an @code{if} statement with an
7980 @code{else} clause, CSE follows the jump when the condition
7981 tested is false.
7983 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7985 @item -fcse-skip-blocks
7986 @opindex fcse-skip-blocks
7987 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7988 follow jumps that conditionally skip over blocks.  When CSE
7989 encounters a simple @code{if} statement with no else clause,
7990 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7991 body of the @code{if}.
7993 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7995 @item -frerun-cse-after-loop
7996 @opindex frerun-cse-after-loop
7997 Re-run common subexpression elimination after loop optimizations are
7998 performed.
8000 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8002 @item -fgcse
8003 @opindex fgcse
8004 Perform a global common subexpression elimination pass.
8005 This pass also performs global constant and copy propagation.
8007 @emph{Note:} When compiling a program using computed gotos, a GCC
8008 extension, you may get better run-time performance if you disable
8009 the global common subexpression elimination pass by adding
8010 @option{-fno-gcse} to the command line.
8012 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8014 @item -fgcse-lm
8015 @opindex fgcse-lm
8016 When @option{-fgcse-lm} is enabled, global common subexpression elimination
8017 attempts to move loads that are only killed by stores into themselves.  This
8018 allows a loop containing a load/store sequence to be changed to a load outside
8019 the loop, and a copy/store within the loop.
8021 Enabled by default when @option{-fgcse} is enabled.
8023 @item -fgcse-sm
8024 @opindex fgcse-sm
8025 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8026 global common subexpression elimination.  This pass attempts to move
8027 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8028 loops containing a load/store sequence can be changed to a load before
8029 the loop and a store after the loop.
8031 Not enabled at any optimization level.
8033 @item -fgcse-las
8034 @opindex fgcse-las
8035 When @option{-fgcse-las} is enabled, the global common subexpression
8036 elimination pass eliminates redundant loads that come after stores to the
8037 same memory location (both partial and full redundancies).
8039 Not enabled at any optimization level.
8041 @item -fgcse-after-reload
8042 @opindex fgcse-after-reload
8043 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8044 pass is performed after reload.  The purpose of this pass is to clean up
8045 redundant spilling.
8047 @item -faggressive-loop-optimizations
8048 @opindex faggressive-loop-optimizations
8049 This option tells the loop optimizer to use language constraints to
8050 derive bounds for the number of iterations of a loop.  This assumes that
8051 loop code does not invoke undefined behavior by for example causing signed
8052 integer overflows or out-of-bound array accesses.  The bounds for the
8053 number of iterations of a loop are used to guide loop unrolling and peeling
8054 and loop exit test optimizations.
8055 This option is enabled by default.
8057 @item -funconstrained-commons
8058 @opindex funconstrained-commons
8059 This option tells the compiler that variables declared in common blocks
8060 (e.g. Fortran) may later be overridden with longer trailing arrays. This
8061 prevents certain optimizations that depend on knowing the array bounds.
8063 @item -fcrossjumping
8064 @opindex fcrossjumping
8065 Perform cross-jumping transformation.
8066 This transformation unifies equivalent code and saves code size.  The
8067 resulting code may or may not perform better than without cross-jumping.
8069 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8071 @item -fauto-inc-dec
8072 @opindex fauto-inc-dec
8073 Combine increments or decrements of addresses with memory accesses.
8074 This pass is always skipped on architectures that do not have
8075 instructions to support this.  Enabled by default at @option{-O} and
8076 higher on architectures that support this.
8078 @item -fdce
8079 @opindex fdce
8080 Perform dead code elimination (DCE) on RTL@.
8081 Enabled by default at @option{-O} and higher.
8083 @item -fdse
8084 @opindex fdse
8085 Perform dead store elimination (DSE) on RTL@.
8086 Enabled by default at @option{-O} and higher.
8088 @item -fif-conversion
8089 @opindex fif-conversion
8090 Attempt to transform conditional jumps into branch-less equivalents.  This
8091 includes use of conditional moves, min, max, set flags and abs instructions, and
8092 some tricks doable by standard arithmetics.  The use of conditional execution
8093 on chips where it is available is controlled by @option{-fif-conversion2}.
8095 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8097 @item -fif-conversion2
8098 @opindex fif-conversion2
8099 Use conditional execution (where available) to transform conditional jumps into
8100 branch-less equivalents.
8102 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8104 @item -fdeclone-ctor-dtor
8105 @opindex fdeclone-ctor-dtor
8106 The C++ ABI requires multiple entry points for constructors and
8107 destructors: one for a base subobject, one for a complete object, and
8108 one for a virtual destructor that calls operator delete afterwards.
8109 For a hierarchy with virtual bases, the base and complete variants are
8110 clones, which means two copies of the function.  With this option, the
8111 base and complete variants are changed to be thunks that call a common
8112 implementation.
8114 Enabled by @option{-Os}.
8116 @item -fdelete-null-pointer-checks
8117 @opindex fdelete-null-pointer-checks
8118 Assume that programs cannot safely dereference null pointers, and that
8119 no code or data element resides at address zero.
8120 This option enables simple constant
8121 folding optimizations at all optimization levels.  In addition, other
8122 optimization passes in GCC use this flag to control global dataflow
8123 analyses that eliminate useless checks for null pointers; these assume
8124 that a memory access to address zero always results in a trap, so
8125 that if a pointer is checked after it has already been dereferenced,
8126 it cannot be null.
8128 Note however that in some environments this assumption is not true.
8129 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8130 for programs that depend on that behavior.
8132 This option is enabled by default on most targets.  On Nios II ELF, it
8133 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
8135 Passes that use the dataflow information
8136 are enabled independently at different optimization levels.
8138 @item -fdevirtualize
8139 @opindex fdevirtualize
8140 Attempt to convert calls to virtual functions to direct calls.  This
8141 is done both within a procedure and interprocedurally as part of
8142 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8143 propagation (@option{-fipa-cp}).
8144 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8146 @item -fdevirtualize-speculatively
8147 @opindex fdevirtualize-speculatively
8148 Attempt to convert calls to virtual functions to speculative direct calls.
8149 Based on the analysis of the type inheritance graph, determine for a given call
8150 the set of likely targets. If the set is small, preferably of size 1, change
8151 the call into a conditional deciding between direct and indirect calls.  The
8152 speculative calls enable more optimizations, such as inlining.  When they seem
8153 useless after further optimization, they are converted back into original form.
8155 @item -fdevirtualize-at-ltrans
8156 @opindex fdevirtualize-at-ltrans
8157 Stream extra information needed for aggressive devirtualization when running
8158 the link-time optimizer in local transformation mode.  
8159 This option enables more devirtualization but
8160 significantly increases the size of streamed data. For this reason it is
8161 disabled by default.
8163 @item -fexpensive-optimizations
8164 @opindex fexpensive-optimizations
8165 Perform a number of minor optimizations that are relatively expensive.
8167 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8169 @item -free
8170 @opindex free
8171 Attempt to remove redundant extension instructions.  This is especially
8172 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8173 registers after writing to their lower 32-bit half.
8175 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8176 @option{-O3}, @option{-Os}.
8178 @item -fno-lifetime-dse
8179 @opindex fno-lifetime-dse
8180 In C++ the value of an object is only affected by changes within its
8181 lifetime: when the constructor begins, the object has an indeterminate
8182 value, and any changes during the lifetime of the object are dead when
8183 the object is destroyed.  Normally dead store elimination will take
8184 advantage of this; if your code relies on the value of the object
8185 storage persisting beyond the lifetime of the object, you can use this
8186 flag to disable this optimization.  To preserve stores before the
8187 constructor starts (e.g. because your operator new clears the object
8188 storage) but still treat the object as dead after the destructor you,
8189 can use @option{-flifetime-dse=1}.  The default behavior can be
8190 explicitly selected with @option{-flifetime-dse=2}.
8191 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8193 @item -flive-range-shrinkage
8194 @opindex flive-range-shrinkage
8195 Attempt to decrease register pressure through register live range
8196 shrinkage.  This is helpful for fast processors with small or moderate
8197 size register sets.
8199 @item -fira-algorithm=@var{algorithm}
8200 @opindex fira-algorithm
8201 Use the specified coloring algorithm for the integrated register
8202 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8203 specifies Chow's priority coloring, or @samp{CB}, which specifies
8204 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8205 for all architectures, but for those targets that do support it, it is
8206 the default because it generates better code.
8208 @item -fira-region=@var{region}
8209 @opindex fira-region
8210 Use specified regions for the integrated register allocator.  The
8211 @var{region} argument should be one of the following:
8213 @table @samp
8215 @item all
8216 Use all loops as register allocation regions.
8217 This can give the best results for machines with a small and/or
8218 irregular register set.
8220 @item mixed
8221 Use all loops except for loops with small register pressure 
8222 as the regions.  This value usually gives
8223 the best results in most cases and for most architectures,
8224 and is enabled by default when compiling with optimization for speed
8225 (@option{-O}, @option{-O2}, @dots{}).
8227 @item one
8228 Use all functions as a single region.  
8229 This typically results in the smallest code size, and is enabled by default for
8230 @option{-Os} or @option{-O0}.
8232 @end table
8234 @item -fira-hoist-pressure
8235 @opindex fira-hoist-pressure
8236 Use IRA to evaluate register pressure in the code hoisting pass for
8237 decisions to hoist expressions.  This option usually results in smaller
8238 code, but it can slow the compiler down.
8240 This option is enabled at level @option{-Os} for all targets.
8242 @item -fira-loop-pressure
8243 @opindex fira-loop-pressure
8244 Use IRA to evaluate register pressure in loops for decisions to move
8245 loop invariants.  This option usually results in generation
8246 of faster and smaller code on machines with large register files (>= 32
8247 registers), but it can slow the compiler down.
8249 This option is enabled at level @option{-O3} for some targets.
8251 @item -fno-ira-share-save-slots
8252 @opindex fno-ira-share-save-slots
8253 Disable sharing of stack slots used for saving call-used hard
8254 registers living through a call.  Each hard register gets a
8255 separate stack slot, and as a result function stack frames are
8256 larger.
8258 @item -fno-ira-share-spill-slots
8259 @opindex fno-ira-share-spill-slots
8260 Disable sharing of stack slots allocated for pseudo-registers.  Each
8261 pseudo-register that does not get a hard register gets a separate
8262 stack slot, and as a result function stack frames are larger.
8264 @item -flra-remat
8265 @opindex flra-remat
8266 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8267 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8268 values if it is profitable.
8270 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8272 @item -fdelayed-branch
8273 @opindex fdelayed-branch
8274 If supported for the target machine, attempt to reorder instructions
8275 to exploit instruction slots available after delayed branch
8276 instructions.
8278 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8280 @item -fschedule-insns
8281 @opindex fschedule-insns
8282 If supported for the target machine, attempt to reorder instructions to
8283 eliminate execution stalls due to required data being unavailable.  This
8284 helps machines that have slow floating point or memory load instructions
8285 by allowing other instructions to be issued until the result of the load
8286 or floating-point instruction is required.
8288 Enabled at levels @option{-O2}, @option{-O3}.
8290 @item -fschedule-insns2
8291 @opindex fschedule-insns2
8292 Similar to @option{-fschedule-insns}, but requests an additional pass of
8293 instruction scheduling after register allocation has been done.  This is
8294 especially useful on machines with a relatively small number of
8295 registers and where memory load instructions take more than one cycle.
8297 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8299 @item -fno-sched-interblock
8300 @opindex fno-sched-interblock
8301 Don't schedule instructions across basic blocks.  This is normally
8302 enabled by default when scheduling before register allocation, i.e.@:
8303 with @option{-fschedule-insns} or at @option{-O2} or higher.
8305 @item -fno-sched-spec
8306 @opindex fno-sched-spec
8307 Don't allow speculative motion of non-load instructions.  This is normally
8308 enabled by default when scheduling before register allocation, i.e.@:
8309 with @option{-fschedule-insns} or at @option{-O2} or higher.
8311 @item -fsched-pressure
8312 @opindex fsched-pressure
8313 Enable register pressure sensitive insn scheduling before register
8314 allocation.  This only makes sense when scheduling before register
8315 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8316 @option{-O2} or higher.  Usage of this option can improve the
8317 generated code and decrease its size by preventing register pressure
8318 increase above the number of available hard registers and subsequent
8319 spills in register allocation.
8321 @item -fsched-spec-load
8322 @opindex fsched-spec-load
8323 Allow speculative motion of some load instructions.  This only makes
8324 sense when scheduling before register allocation, i.e.@: with
8325 @option{-fschedule-insns} or at @option{-O2} or higher.
8327 @item -fsched-spec-load-dangerous
8328 @opindex fsched-spec-load-dangerous
8329 Allow speculative motion of more load instructions.  This only makes
8330 sense when scheduling before register allocation, i.e.@: with
8331 @option{-fschedule-insns} or at @option{-O2} or higher.
8333 @item -fsched-stalled-insns
8334 @itemx -fsched-stalled-insns=@var{n}
8335 @opindex fsched-stalled-insns
8336 Define how many insns (if any) can be moved prematurely from the queue
8337 of stalled insns into the ready list during the second scheduling pass.
8338 @option{-fno-sched-stalled-insns} means that no insns are moved
8339 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8340 on how many queued insns can be moved prematurely.
8341 @option{-fsched-stalled-insns} without a value is equivalent to
8342 @option{-fsched-stalled-insns=1}.
8344 @item -fsched-stalled-insns-dep
8345 @itemx -fsched-stalled-insns-dep=@var{n}
8346 @opindex fsched-stalled-insns-dep
8347 Define how many insn groups (cycles) are examined for a dependency
8348 on a stalled insn that is a candidate for premature removal from the queue
8349 of stalled insns.  This has an effect only during the second scheduling pass,
8350 and only if @option{-fsched-stalled-insns} is used.
8351 @option{-fno-sched-stalled-insns-dep} is equivalent to
8352 @option{-fsched-stalled-insns-dep=0}.
8353 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8354 @option{-fsched-stalled-insns-dep=1}.
8356 @item -fsched2-use-superblocks
8357 @opindex fsched2-use-superblocks
8358 When scheduling after register allocation, use superblock scheduling.
8359 This allows motion across basic block boundaries,
8360 resulting in faster schedules.  This option is experimental, as not all machine
8361 descriptions used by GCC model the CPU closely enough to avoid unreliable
8362 results from the algorithm.
8364 This only makes sense when scheduling after register allocation, i.e.@: with
8365 @option{-fschedule-insns2} or at @option{-O2} or higher.
8367 @item -fsched-group-heuristic
8368 @opindex fsched-group-heuristic
8369 Enable the group heuristic in the scheduler.  This heuristic favors
8370 the instruction that belongs to a schedule group.  This is enabled
8371 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8372 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8374 @item -fsched-critical-path-heuristic
8375 @opindex fsched-critical-path-heuristic
8376 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8377 instructions on the critical path.  This is enabled by default when
8378 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8379 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8381 @item -fsched-spec-insn-heuristic
8382 @opindex fsched-spec-insn-heuristic
8383 Enable the speculative instruction heuristic in the scheduler.  This
8384 heuristic favors speculative instructions with greater dependency weakness.
8385 This is enabled by default when scheduling is enabled, i.e.@:
8386 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8387 or at @option{-O2} or higher.
8389 @item -fsched-rank-heuristic
8390 @opindex fsched-rank-heuristic
8391 Enable the rank heuristic in the scheduler.  This heuristic favors
8392 the instruction belonging to a basic block with greater size or frequency.
8393 This is enabled by default when scheduling is enabled, i.e.@:
8394 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8395 at @option{-O2} or higher.
8397 @item -fsched-last-insn-heuristic
8398 @opindex fsched-last-insn-heuristic
8399 Enable the last-instruction heuristic in the scheduler.  This heuristic
8400 favors the instruction that is less dependent on the last instruction
8401 scheduled.  This is enabled by default when scheduling is enabled,
8402 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8403 at @option{-O2} or higher.
8405 @item -fsched-dep-count-heuristic
8406 @opindex fsched-dep-count-heuristic
8407 Enable the dependent-count heuristic in the scheduler.  This heuristic
8408 favors the instruction that has more instructions depending on it.
8409 This is enabled by default when scheduling is enabled, i.e.@:
8410 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8411 at @option{-O2} or higher.
8413 @item -freschedule-modulo-scheduled-loops
8414 @opindex freschedule-modulo-scheduled-loops
8415 Modulo scheduling is performed before traditional scheduling.  If a loop
8416 is modulo scheduled, later scheduling passes may change its schedule.  
8417 Use this option to control that behavior.
8419 @item -fselective-scheduling
8420 @opindex fselective-scheduling
8421 Schedule instructions using selective scheduling algorithm.  Selective
8422 scheduling runs instead of the first scheduler pass.
8424 @item -fselective-scheduling2
8425 @opindex fselective-scheduling2
8426 Schedule instructions using selective scheduling algorithm.  Selective
8427 scheduling runs instead of the second scheduler pass.
8429 @item -fsel-sched-pipelining
8430 @opindex fsel-sched-pipelining
8431 Enable software pipelining of innermost loops during selective scheduling.
8432 This option has no effect unless one of @option{-fselective-scheduling} or
8433 @option{-fselective-scheduling2} is turned on.
8435 @item -fsel-sched-pipelining-outer-loops
8436 @opindex fsel-sched-pipelining-outer-loops
8437 When pipelining loops during selective scheduling, also pipeline outer loops.
8438 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8440 @item -fsemantic-interposition
8441 @opindex fsemantic-interposition
8442 Some object formats, like ELF, allow interposing of symbols by the 
8443 dynamic linker.
8444 This means that for symbols exported from the DSO, the compiler cannot perform
8445 interprocedural propagation, inlining and other optimizations in anticipation
8446 that the function or variable in question may change. While this feature is
8447 useful, for example, to rewrite memory allocation functions by a debugging
8448 implementation, it is expensive in the terms of code quality.
8449 With @option{-fno-semantic-interposition} the compiler assumes that 
8450 if interposition happens for functions the overwriting function will have 
8451 precisely the same semantics (and side effects). 
8452 Similarly if interposition happens
8453 for variables, the constructor of the variable will be the same. The flag
8454 has no effect for functions explicitly declared inline 
8455 (where it is never allowed for interposition to change semantics) 
8456 and for symbols explicitly declared weak.
8458 @item -fshrink-wrap
8459 @opindex fshrink-wrap
8460 Emit function prologues only before parts of the function that need it,
8461 rather than at the top of the function.  This flag is enabled by default at
8462 @option{-O} and higher.
8464 @item -fshrink-wrap-separate
8465 @opindex fshrink-wrap-separate
8466 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8467 those parts are only executed when needed.
8468 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8469 is also turned on and the target supports this.
8471 @item -fcaller-saves
8472 @opindex fcaller-saves
8473 Enable allocation of values to registers that are clobbered by
8474 function calls, by emitting extra instructions to save and restore the
8475 registers around such calls.  Such allocation is done only when it
8476 seems to result in better code.
8478 This option is always enabled by default on certain machines, usually
8479 those which have no call-preserved registers to use instead.
8481 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8483 @item -fcombine-stack-adjustments
8484 @opindex fcombine-stack-adjustments
8485 Tracks stack adjustments (pushes and pops) and stack memory references
8486 and then tries to find ways to combine them.
8488 Enabled by default at @option{-O1} and higher.
8490 @item -fipa-ra
8491 @opindex fipa-ra
8492 Use caller save registers for allocation if those registers are not used by
8493 any called function.  In that case it is not necessary to save and restore
8494 them around calls.  This is only possible if called functions are part of
8495 same compilation unit as current function and they are compiled before it.
8497 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8498 is disabled if generated code will be instrumented for profiling
8499 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8500 exactly (this happens on targets that do not expose prologues
8501 and epilogues in RTL).
8503 @item -fconserve-stack
8504 @opindex fconserve-stack
8505 Attempt to minimize stack usage.  The compiler attempts to use less
8506 stack space, even if that makes the program slower.  This option
8507 implies setting the @option{large-stack-frame} parameter to 100
8508 and the @option{large-stack-frame-growth} parameter to 400.
8510 @item -ftree-reassoc
8511 @opindex ftree-reassoc
8512 Perform reassociation on trees.  This flag is enabled by default
8513 at @option{-O} and higher.
8515 @item -fcode-hoisting
8516 @opindex fcode-hoisting
8517 Perform code hoisting.  Code hoisting tries to move the
8518 evaluation of expressions executed on all paths to the function exit
8519 as early as possible.  This is especially useful as a code size
8520 optimization, but it often helps for code speed as well.
8521 This flag is enabled by default at @option{-O2} and higher.
8523 @item -ftree-pre
8524 @opindex ftree-pre
8525 Perform partial redundancy elimination (PRE) on trees.  This flag is
8526 enabled by default at @option{-O2} and @option{-O3}.
8528 @item -ftree-partial-pre
8529 @opindex ftree-partial-pre
8530 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8531 enabled by default at @option{-O3}.
8533 @item -ftree-forwprop
8534 @opindex ftree-forwprop
8535 Perform forward propagation on trees.  This flag is enabled by default
8536 at @option{-O} and higher.
8538 @item -ftree-fre
8539 @opindex ftree-fre
8540 Perform full redundancy elimination (FRE) on trees.  The difference
8541 between FRE and PRE is that FRE only considers expressions
8542 that are computed on all paths leading to the redundant computation.
8543 This analysis is faster than PRE, though it exposes fewer redundancies.
8544 This flag is enabled by default at @option{-O} and higher.
8546 @item -ftree-phiprop
8547 @opindex ftree-phiprop
8548 Perform hoisting of loads from conditional pointers on trees.  This
8549 pass is enabled by default at @option{-O} and higher.
8551 @item -fhoist-adjacent-loads
8552 @opindex fhoist-adjacent-loads
8553 Speculatively hoist loads from both branches of an if-then-else if the
8554 loads are from adjacent locations in the same structure and the target
8555 architecture has a conditional move instruction.  This flag is enabled
8556 by default at @option{-O2} and higher.
8558 @item -ftree-copy-prop
8559 @opindex ftree-copy-prop
8560 Perform copy propagation on trees.  This pass eliminates unnecessary
8561 copy operations.  This flag is enabled by default at @option{-O} and
8562 higher.
8564 @item -fipa-pure-const
8565 @opindex fipa-pure-const
8566 Discover which functions are pure or constant.
8567 Enabled by default at @option{-O} and higher.
8569 @item -fipa-reference
8570 @opindex fipa-reference
8571 Discover which static variables do not escape the
8572 compilation unit.
8573 Enabled by default at @option{-O} and higher.
8575 @item -fipa-pta
8576 @opindex fipa-pta
8577 Perform interprocedural pointer analysis and interprocedural modification
8578 and reference analysis.  This option can cause excessive memory and
8579 compile-time usage on large compilation units.  It is not enabled by
8580 default at any optimization level.
8582 @item -fipa-profile
8583 @opindex fipa-profile
8584 Perform interprocedural profile propagation.  The functions called only from
8585 cold functions are marked as cold. Also functions executed once (such as
8586 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8587 functions and loop less parts of functions executed once are then optimized for
8588 size.
8589 Enabled by default at @option{-O} and higher.
8591 @item -fipa-cp
8592 @opindex fipa-cp
8593 Perform interprocedural constant propagation.
8594 This optimization analyzes the program to determine when values passed
8595 to functions are constants and then optimizes accordingly.
8596 This optimization can substantially increase performance
8597 if the application has constants passed to functions.
8598 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8600 @item -fipa-cp-clone
8601 @opindex fipa-cp-clone
8602 Perform function cloning to make interprocedural constant propagation stronger.
8603 When enabled, interprocedural constant propagation performs function cloning
8604 when externally visible function can be called with constant arguments.
8605 Because this optimization can create multiple copies of functions,
8606 it may significantly increase code size
8607 (see @option{--param ipcp-unit-growth=@var{value}}).
8608 This flag is enabled by default at @option{-O3}.
8610 @item -fipa-bit-cp
8611 @opindex -fipa-bit-cp
8612 When enabled, perform interprocedural bitwise constant
8613 propagation. This flag is enabled by default at @option{-O2}. It
8614 requires that @option{-fipa-cp} is enabled.
8616 @item -fipa-vrp
8617 @opindex -fipa-vrp
8618 When enabled, perform interprocedural propagation of value
8619 ranges. This flag is enabled by default at @option{-O2}. It requires
8620 that @option{-fipa-cp} is enabled.
8622 @item -fipa-icf
8623 @opindex fipa-icf
8624 Perform Identical Code Folding for functions and read-only variables.
8625 The optimization reduces code size and may disturb unwind stacks by replacing
8626 a function by equivalent one with a different name. The optimization works
8627 more effectively with link-time optimization enabled.
8629 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8630 works on different levels and thus the optimizations are not same - there are
8631 equivalences that are found only by GCC and equivalences found only by Gold.
8633 This flag is enabled by default at @option{-O2} and @option{-Os}.
8635 @item -fisolate-erroneous-paths-dereference
8636 @opindex fisolate-erroneous-paths-dereference
8637 Detect paths that trigger erroneous or undefined behavior due to
8638 dereferencing a null pointer.  Isolate those paths from the main control
8639 flow and turn the statement with erroneous or undefined behavior into a trap.
8640 This flag is enabled by default at @option{-O2} and higher and depends on
8641 @option{-fdelete-null-pointer-checks} also being enabled.
8643 @item -fisolate-erroneous-paths-attribute
8644 @opindex fisolate-erroneous-paths-attribute
8645 Detect paths that trigger erroneous or undefined behavior due to a null value
8646 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8647 attribute.  Isolate those paths from the main control flow and turn the
8648 statement with erroneous or undefined behavior into a trap.  This is not
8649 currently enabled, but may be enabled by @option{-O2} in the future.
8651 @item -ftree-sink
8652 @opindex ftree-sink
8653 Perform forward store motion on trees.  This flag is
8654 enabled by default at @option{-O} and higher.
8656 @item -ftree-bit-ccp
8657 @opindex ftree-bit-ccp
8658 Perform sparse conditional bit constant propagation on trees and propagate
8659 pointer alignment information.
8660 This pass only operates on local scalar variables and is enabled by default
8661 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8663 @item -ftree-ccp
8664 @opindex ftree-ccp
8665 Perform sparse conditional constant propagation (CCP) on trees.  This
8666 pass only operates on local scalar variables and is enabled by default
8667 at @option{-O} and higher.
8669 @item -fssa-backprop
8670 @opindex fssa-backprop
8671 Propagate information about uses of a value up the definition chain
8672 in order to simplify the definitions.  For example, this pass strips
8673 sign operations if the sign of a value never matters.  The flag is
8674 enabled by default at @option{-O} and higher.
8676 @item -fssa-phiopt
8677 @opindex fssa-phiopt
8678 Perform pattern matching on SSA PHI nodes to optimize conditional
8679 code.  This pass is enabled by default at @option{-O} and higher.
8681 @item -ftree-switch-conversion
8682 @opindex ftree-switch-conversion
8683 Perform conversion of simple initializations in a switch to
8684 initializations from a scalar array.  This flag is enabled by default
8685 at @option{-O2} and higher.
8687 @item -ftree-tail-merge
8688 @opindex ftree-tail-merge
8689 Look for identical code sequences.  When found, replace one with a jump to the
8690 other.  This optimization is known as tail merging or cross jumping.  This flag
8691 is enabled by default at @option{-O2} and higher.  The compilation time
8692 in this pass can
8693 be limited using @option{max-tail-merge-comparisons} parameter and
8694 @option{max-tail-merge-iterations} parameter.
8696 @item -ftree-dce
8697 @opindex ftree-dce
8698 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8699 default at @option{-O} and higher.
8701 @item -ftree-builtin-call-dce
8702 @opindex ftree-builtin-call-dce
8703 Perform conditional dead code elimination (DCE) for calls to built-in functions
8704 that may set @code{errno} but are otherwise free of side effects.  This flag is
8705 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8706 specified.
8708 @item -ftree-dominator-opts
8709 @opindex ftree-dominator-opts
8710 Perform a variety of simple scalar cleanups (constant/copy
8711 propagation, redundancy elimination, range propagation and expression
8712 simplification) based on a dominator tree traversal.  This also
8713 performs jump threading (to reduce jumps to jumps). This flag is
8714 enabled by default at @option{-O} and higher.
8716 @item -ftree-dse
8717 @opindex ftree-dse
8718 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8719 a memory location that is later overwritten by another store without
8720 any intervening loads.  In this case the earlier store can be deleted.  This
8721 flag is enabled by default at @option{-O} and higher.
8723 @item -ftree-ch
8724 @opindex ftree-ch
8725 Perform loop header copying on trees.  This is beneficial since it increases
8726 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8727 is enabled by default at @option{-O} and higher.  It is not enabled
8728 for @option{-Os}, since it usually increases code size.
8730 @item -ftree-loop-optimize
8731 @opindex ftree-loop-optimize
8732 Perform loop optimizations on trees.  This flag is enabled by default
8733 at @option{-O} and higher.
8735 @item -ftree-loop-linear
8736 @itemx -floop-strip-mine
8737 @itemx -floop-block
8738 @opindex ftree-loop-linear
8739 @opindex floop-strip-mine
8740 @opindex floop-block
8741 Perform loop nest optimizations.  Same as
8742 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8743 to be configured with @option{--with-isl} to enable the Graphite loop
8744 transformation infrastructure.
8746 @item -fgraphite-identity
8747 @opindex fgraphite-identity
8748 Enable the identity transformation for graphite.  For every SCoP we generate
8749 the polyhedral representation and transform it back to gimple.  Using
8750 @option{-fgraphite-identity} we can check the costs or benefits of the
8751 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8752 are also performed by the code generator isl, like index splitting and
8753 dead code elimination in loops.
8755 @item -floop-nest-optimize
8756 @opindex floop-nest-optimize
8757 Enable the isl based loop nest optimizer.  This is a generic loop nest
8758 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8759 structure optimized for data-locality and parallelism.  This option
8760 is experimental.
8762 @item -floop-parallelize-all
8763 @opindex floop-parallelize-all
8764 Use the Graphite data dependence analysis to identify loops that can
8765 be parallelized.  Parallelize all the loops that can be analyzed to
8766 not contain loop carried dependences without checking that it is
8767 profitable to parallelize the loops.
8769 @item -ftree-coalesce-vars
8770 @opindex ftree-coalesce-vars
8771 While transforming the program out of the SSA representation, attempt to
8772 reduce copying by coalescing versions of different user-defined
8773 variables, instead of just compiler temporaries.  This may severely
8774 limit the ability to debug an optimized program compiled with
8775 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8776 prevents SSA coalescing of user variables.  This option is enabled by
8777 default if optimization is enabled, and it does very little otherwise.
8779 @item -ftree-loop-if-convert
8780 @opindex ftree-loop-if-convert
8781 Attempt to transform conditional jumps in the innermost loops to
8782 branch-less equivalents.  The intent is to remove control-flow from
8783 the innermost loops in order to improve the ability of the
8784 vectorization pass to handle these loops.  This is enabled by default
8785 if vectorization is enabled.
8787 @item -ftree-loop-distribution
8788 @opindex ftree-loop-distribution
8789 Perform loop distribution.  This flag can improve cache performance on
8790 big loop bodies and allow further loop optimizations, like
8791 parallelization or vectorization, to take place.  For example, the loop
8792 @smallexample
8793 DO I = 1, N
8794   A(I) = B(I) + C
8795   D(I) = E(I) * F
8796 ENDDO
8797 @end smallexample
8798 is transformed to
8799 @smallexample
8800 DO I = 1, N
8801    A(I) = B(I) + C
8802 ENDDO
8803 DO I = 1, N
8804    D(I) = E(I) * F
8805 ENDDO
8806 @end smallexample
8808 @item -ftree-loop-distribute-patterns
8809 @opindex ftree-loop-distribute-patterns
8810 Perform loop distribution of patterns that can be code generated with
8811 calls to a library.  This flag is enabled by default at @option{-O3}.
8813 This pass distributes the initialization loops and generates a call to
8814 memset zero.  For example, the loop
8815 @smallexample
8816 DO I = 1, N
8817   A(I) = 0
8818   B(I) = A(I) + I
8819 ENDDO
8820 @end smallexample
8821 is transformed to
8822 @smallexample
8823 DO I = 1, N
8824    A(I) = 0
8825 ENDDO
8826 DO I = 1, N
8827    B(I) = A(I) + I
8828 ENDDO
8829 @end smallexample
8830 and the initialization loop is transformed into a call to memset zero.
8832 @item -floop-interchange
8833 @opindex floop-interchange
8834 Perform loop interchange outside of graphite.  This flag can improve cache
8835 performance on loop nest and allow further loop optimizations, like
8836 vectorization, to take place.  For example, the loop
8837 @smallexample
8838 for (int i = 0; i < N; i++)
8839   for (int j = 0; j < N; j++)
8840     for (int k = 0; k < N; k++)
8841       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8842 @end smallexample
8843 is transformed to
8844 @smallexample
8845 for (int i = 0; i < N; i++)
8846   for (int k = 0; k < N; k++)
8847     for (int j = 0; j < N; j++)
8848       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8849 @end smallexample
8850 This flag is enabled by default at @option{-O3}.
8852 @item -floop-unroll-and-jam
8853 @opindex floop-unroll-and-jam
8854 Apply unroll and jam transformations on feasible loops.  In a loop
8855 nest this unrolls the outer loop by some factor and fuses the resulting
8856 multiple inner loops.  This flag is enabled by default at @option{-O3}.
8858 @item -ftree-loop-im
8859 @opindex ftree-loop-im
8860 Perform loop invariant motion on trees.  This pass moves only invariants that
8861 are hard to handle at RTL level (function calls, operations that expand to
8862 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8863 operands of conditions that are invariant out of the loop, so that we can use
8864 just trivial invariantness analysis in loop unswitching.  The pass also includes
8865 store motion.
8867 @item -ftree-loop-ivcanon
8868 @opindex ftree-loop-ivcanon
8869 Create a canonical counter for number of iterations in loops for which
8870 determining number of iterations requires complicated analysis.  Later
8871 optimizations then may determine the number easily.  Useful especially
8872 in connection with unrolling.
8874 @item -fivopts
8875 @opindex fivopts
8876 Perform induction variable optimizations (strength reduction, induction
8877 variable merging and induction variable elimination) on trees.
8879 @item -ftree-parallelize-loops=n
8880 @opindex ftree-parallelize-loops
8881 Parallelize loops, i.e., split their iteration space to run in n threads.
8882 This is only possible for loops whose iterations are independent
8883 and can be arbitrarily reordered.  The optimization is only
8884 profitable on multiprocessor machines, for loops that are CPU-intensive,
8885 rather than constrained e.g.@: by memory bandwidth.  This option
8886 implies @option{-pthread}, and thus is only supported on targets
8887 that have support for @option{-pthread}.
8889 @item -ftree-pta
8890 @opindex ftree-pta
8891 Perform function-local points-to analysis on trees.  This flag is
8892 enabled by default at @option{-O} and higher.
8894 @item -ftree-sra
8895 @opindex ftree-sra
8896 Perform scalar replacement of aggregates.  This pass replaces structure
8897 references with scalars to prevent committing structures to memory too
8898 early.  This flag is enabled by default at @option{-O} and higher.
8900 @item -fstore-merging
8901 @opindex fstore-merging
8902 Perform merging of narrow stores to consecutive memory addresses.  This pass
8903 merges contiguous stores of immediate values narrower than a word into fewer
8904 wider stores to reduce the number of instructions.  This is enabled by default
8905 at @option{-O2} and higher as well as @option{-Os}.
8907 @item -ftree-ter
8908 @opindex ftree-ter
8909 Perform temporary expression replacement during the SSA->normal phase.  Single
8910 use/single def temporaries are replaced at their use location with their
8911 defining expression.  This results in non-GIMPLE code, but gives the expanders
8912 much more complex trees to work on resulting in better RTL generation.  This is
8913 enabled by default at @option{-O} and higher.
8915 @item -ftree-slsr
8916 @opindex ftree-slsr
8917 Perform straight-line strength reduction on trees.  This recognizes related
8918 expressions involving multiplications and replaces them by less expensive
8919 calculations when possible.  This is enabled by default at @option{-O} and
8920 higher.
8922 @item -ftree-vectorize
8923 @opindex ftree-vectorize
8924 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8925 and @option{-ftree-slp-vectorize} if not explicitly specified.
8927 @item -ftree-loop-vectorize
8928 @opindex ftree-loop-vectorize
8929 Perform loop vectorization on trees. This flag is enabled by default at
8930 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8932 @item -ftree-slp-vectorize
8933 @opindex ftree-slp-vectorize
8934 Perform basic block vectorization on trees. This flag is enabled by default at
8935 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8937 @item -fvect-cost-model=@var{model}
8938 @opindex fvect-cost-model
8939 Alter the cost model used for vectorization.  The @var{model} argument
8940 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8941 With the @samp{unlimited} model the vectorized code-path is assumed
8942 to be profitable while with the @samp{dynamic} model a runtime check
8943 guards the vectorized code-path to enable it only for iteration
8944 counts that will likely execute faster than when executing the original
8945 scalar loop.  The @samp{cheap} model disables vectorization of
8946 loops where doing so would be cost prohibitive for example due to
8947 required runtime checks for data dependence or alignment but otherwise
8948 is equal to the @samp{dynamic} model.
8949 The default cost model depends on other optimization flags and is
8950 either @samp{dynamic} or @samp{cheap}.
8952 @item -fsimd-cost-model=@var{model}
8953 @opindex fsimd-cost-model
8954 Alter the cost model used for vectorization of loops marked with the OpenMP
8955 simd directive.  The @var{model} argument should be one of
8956 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8957 have the same meaning as described in @option{-fvect-cost-model} and by
8958 default a cost model defined with @option{-fvect-cost-model} is used.
8960 @item -ftree-vrp
8961 @opindex ftree-vrp
8962 Perform Value Range Propagation on trees.  This is similar to the
8963 constant propagation pass, but instead of values, ranges of values are
8964 propagated.  This allows the optimizers to remove unnecessary range
8965 checks like array bound checks and null pointer checks.  This is
8966 enabled by default at @option{-O2} and higher.  Null pointer check
8967 elimination is only done if @option{-fdelete-null-pointer-checks} is
8968 enabled.
8970 @item -fsplit-paths
8971 @opindex fsplit-paths
8972 Split paths leading to loop backedges.  This can improve dead code
8973 elimination and common subexpression elimination.  This is enabled by
8974 default at @option{-O2} and above.
8976 @item -fsplit-ivs-in-unroller
8977 @opindex fsplit-ivs-in-unroller
8978 Enables expression of values of induction variables in later iterations
8979 of the unrolled loop using the value in the first iteration.  This breaks
8980 long dependency chains, thus improving efficiency of the scheduling passes.
8982 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8983 same effect.  However, that is not reliable in cases where the loop body
8984 is more complicated than a single basic block.  It also does not work at all
8985 on some architectures due to restrictions in the CSE pass.
8987 This optimization is enabled by default.
8989 @item -fvariable-expansion-in-unroller
8990 @opindex fvariable-expansion-in-unroller
8991 With this option, the compiler creates multiple copies of some
8992 local variables when unrolling a loop, which can result in superior code.
8994 @item -fpartial-inlining
8995 @opindex fpartial-inlining
8996 Inline parts of functions.  This option has any effect only
8997 when inlining itself is turned on by the @option{-finline-functions}
8998 or @option{-finline-small-functions} options.
9000 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9002 @item -fpredictive-commoning
9003 @opindex fpredictive-commoning
9004 Perform predictive commoning optimization, i.e., reusing computations
9005 (especially memory loads and stores) performed in previous
9006 iterations of loops.
9008 This option is enabled at level @option{-O3}.
9010 @item -fprefetch-loop-arrays
9011 @opindex fprefetch-loop-arrays
9012 If supported by the target machine, generate instructions to prefetch
9013 memory to improve the performance of loops that access large arrays.
9015 This option may generate better or worse code; results are highly
9016 dependent on the structure of loops within the source code.
9018 Disabled at level @option{-Os}.
9020 @item -fno-printf-return-value
9021 @opindex fno-printf-return-value
9022 Do not substitute constants for known return value of formatted output
9023 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
9024 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
9025 transformation allows GCC to optimize or even eliminate branches based
9026 on the known return value of these functions called with arguments that
9027 are either constant, or whose values are known to be in a range that
9028 makes determining the exact return value possible.  For example, when
9029 @option{-fprintf-return-value} is in effect, both the branch and the
9030 body of the @code{if} statement (but not the call to @code{snprint})
9031 can be optimized away when @code{i} is a 32-bit or smaller integer
9032 because the return value is guaranteed to be at most 8.
9034 @smallexample
9035 char buf[9];
9036 if (snprintf (buf, "%08x", i) >= sizeof buf)
9037   @dots{}
9038 @end smallexample
9040 The @option{-fprintf-return-value} option relies on other optimizations
9041 and yields best results with @option{-O2} and above.  It works in tandem
9042 with the @option{-Wformat-overflow} and @option{-Wformat-truncation}
9043 options.  The @option{-fprintf-return-value} option is enabled by default.
9045 @item -fno-peephole
9046 @itemx -fno-peephole2
9047 @opindex fno-peephole
9048 @opindex fno-peephole2
9049 Disable any machine-specific peephole optimizations.  The difference
9050 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9051 are implemented in the compiler; some targets use one, some use the
9052 other, a few use both.
9054 @option{-fpeephole} is enabled by default.
9055 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9057 @item -fno-guess-branch-probability
9058 @opindex fno-guess-branch-probability
9059 Do not guess branch probabilities using heuristics.
9061 GCC uses heuristics to guess branch probabilities if they are
9062 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9063 heuristics are based on the control flow graph.  If some branch probabilities
9064 are specified by @code{__builtin_expect}, then the heuristics are
9065 used to guess branch probabilities for the rest of the control flow graph,
9066 taking the @code{__builtin_expect} info into account.  The interactions
9067 between the heuristics and @code{__builtin_expect} can be complex, and in
9068 some cases, it may be useful to disable the heuristics so that the effects
9069 of @code{__builtin_expect} are easier to understand.
9071 The default is @option{-fguess-branch-probability} at levels
9072 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9074 @item -freorder-blocks
9075 @opindex freorder-blocks
9076 Reorder basic blocks in the compiled function in order to reduce number of
9077 taken branches and improve code locality.
9079 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9081 @item -freorder-blocks-algorithm=@var{algorithm}
9082 @opindex freorder-blocks-algorithm
9083 Use the specified algorithm for basic block reordering.  The
9084 @var{algorithm} argument can be @samp{simple}, which does not increase
9085 code size (except sometimes due to secondary effects like alignment),
9086 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
9087 put all often executed code together, minimizing the number of branches
9088 executed by making extra copies of code.
9090 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
9091 @samp{stc} at levels @option{-O2}, @option{-O3}.
9093 @item -freorder-blocks-and-partition
9094 @opindex freorder-blocks-and-partition
9095 In addition to reordering basic blocks in the compiled function, in order
9096 to reduce number of taken branches, partitions hot and cold basic blocks
9097 into separate sections of the assembly and @file{.o} files, to improve
9098 paging and cache locality performance.
9100 This optimization is automatically turned off in the presence of
9101 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
9102 section attribute and on any architecture that does not support named
9103 sections.  When @option{-fsplit-stack} is used this option is not
9104 enabled by default (to avoid linker errors), but may be enabled
9105 explicitly (if using a working linker).
9107 Enabled for x86 at levels @option{-O2}, @option{-O3}, @option{-Os}.
9109 @item -freorder-functions
9110 @opindex freorder-functions
9111 Reorder functions in the object file in order to
9112 improve code locality.  This is implemented by using special
9113 subsections @code{.text.hot} for most frequently executed functions and
9114 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9115 the linker so object file format must support named sections and linker must
9116 place them in a reasonable way.
9118 Also profile feedback must be available to make this option effective.  See
9119 @option{-fprofile-arcs} for details.
9121 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9123 @item -fstrict-aliasing
9124 @opindex fstrict-aliasing
9125 Allow the compiler to assume the strictest aliasing rules applicable to
9126 the language being compiled.  For C (and C++), this activates
9127 optimizations based on the type of expressions.  In particular, an
9128 object of one type is assumed never to reside at the same address as an
9129 object of a different type, unless the types are almost the same.  For
9130 example, an @code{unsigned int} can alias an @code{int}, but not a
9131 @code{void*} or a @code{double}.  A character type may alias any other
9132 type.
9134 @anchor{Type-punning}Pay special attention to code like this:
9135 @smallexample
9136 union a_union @{
9137   int i;
9138   double d;
9141 int f() @{
9142   union a_union t;
9143   t.d = 3.0;
9144   return t.i;
9146 @end smallexample
9147 The practice of reading from a different union member than the one most
9148 recently written to (called ``type-punning'') is common.  Even with
9149 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9150 is accessed through the union type.  So, the code above works as
9151 expected.  @xref{Structures unions enumerations and bit-fields
9152 implementation}.  However, this code might not:
9153 @smallexample
9154 int f() @{
9155   union a_union t;
9156   int* ip;
9157   t.d = 3.0;
9158   ip = &t.i;
9159   return *ip;
9161 @end smallexample
9163 Similarly, access by taking the address, casting the resulting pointer
9164 and dereferencing the result has undefined behavior, even if the cast
9165 uses a union type, e.g.:
9166 @smallexample
9167 int f() @{
9168   double d = 3.0;
9169   return ((union a_union *) &d)->i;
9171 @end smallexample
9173 The @option{-fstrict-aliasing} option is enabled at levels
9174 @option{-O2}, @option{-O3}, @option{-Os}.
9176 @item -falign-functions
9177 @itemx -falign-functions=@var{n}
9178 @opindex falign-functions
9179 Align the start of functions to the next power-of-two greater than
9180 @var{n}, skipping up to @var{n} bytes.  For instance,
9181 @option{-falign-functions=32} aligns functions to the next 32-byte
9182 boundary, but @option{-falign-functions=24} aligns to the next
9183 32-byte boundary only if this can be done by skipping 23 bytes or less.
9185 @option{-fno-align-functions} and @option{-falign-functions=1} are
9186 equivalent and mean that functions are not aligned.
9188 Some assemblers only support this flag when @var{n} is a power of two;
9189 in that case, it is rounded up.
9191 If @var{n} is not specified or is zero, use a machine-dependent default.
9192 The maximum allowed @var{n} option value is 65536.
9194 Enabled at levels @option{-O2}, @option{-O3}.
9196 @item -flimit-function-alignment
9197 If this option is enabled, the compiler tries to avoid unnecessarily
9198 overaligning functions. It attempts to instruct the assembler to align
9199 by the amount specified by @option{-falign-functions}, but not to
9200 skip more bytes than the size of the function.
9202 @item -falign-labels
9203 @itemx -falign-labels=@var{n}
9204 @opindex falign-labels
9205 Align all branch targets to a power-of-two boundary, skipping up to
9206 @var{n} bytes like @option{-falign-functions}.  This option can easily
9207 make code slower, because it must insert dummy operations for when the
9208 branch target is reached in the usual flow of the code.
9210 @option{-fno-align-labels} and @option{-falign-labels=1} are
9211 equivalent and mean that labels are not aligned.
9213 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9214 are greater than this value, then their values are used instead.
9216 If @var{n} is not specified or is zero, use a machine-dependent default
9217 which is very likely to be @samp{1}, meaning no alignment.
9218 The maximum allowed @var{n} option value is 65536.
9220 Enabled at levels @option{-O2}, @option{-O3}.
9222 @item -falign-loops
9223 @itemx -falign-loops=@var{n}
9224 @opindex falign-loops
9225 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9226 like @option{-falign-functions}.  If the loops are
9227 executed many times, this makes up for any execution of the dummy
9228 operations.
9230 @option{-fno-align-loops} and @option{-falign-loops=1} are
9231 equivalent and mean that loops are not aligned.
9232 The maximum allowed @var{n} option value is 65536.
9234 If @var{n} is not specified or is zero, use a machine-dependent default.
9236 Enabled at levels @option{-O2}, @option{-O3}.
9238 @item -falign-jumps
9239 @itemx -falign-jumps=@var{n}
9240 @opindex falign-jumps
9241 Align branch targets to a power-of-two boundary, for branch targets
9242 where the targets can only be reached by jumping, skipping up to @var{n}
9243 bytes like @option{-falign-functions}.  In this case, no dummy operations
9244 need be executed.
9246 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9247 equivalent and mean that loops are not aligned.
9249 If @var{n} is not specified or is zero, use a machine-dependent default.
9250 The maximum allowed @var{n} option value is 65536.
9252 Enabled at levels @option{-O2}, @option{-O3}.
9254 @item -funit-at-a-time
9255 @opindex funit-at-a-time
9256 This option is left for compatibility reasons. @option{-funit-at-a-time}
9257 has no effect, while @option{-fno-unit-at-a-time} implies
9258 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9260 Enabled by default.
9262 @item -fno-toplevel-reorder
9263 @opindex fno-toplevel-reorder
9264 Do not reorder top-level functions, variables, and @code{asm}
9265 statements.  Output them in the same order that they appear in the
9266 input file.  When this option is used, unreferenced static variables
9267 are not removed.  This option is intended to support existing code
9268 that relies on a particular ordering.  For new code, it is better to
9269 use attributes when possible.
9271 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9272 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9273 targets.
9275 @item -fweb
9276 @opindex fweb
9277 Constructs webs as commonly used for register allocation purposes and assign
9278 each web individual pseudo register.  This allows the register allocation pass
9279 to operate on pseudos directly, but also strengthens several other optimization
9280 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9281 however, make debugging impossible, since variables no longer stay in a
9282 ``home register''.
9284 Enabled by default with @option{-funroll-loops}.
9286 @item -fwhole-program
9287 @opindex fwhole-program
9288 Assume that the current compilation unit represents the whole program being
9289 compiled.  All public functions and variables with the exception of @code{main}
9290 and those merged by attribute @code{externally_visible} become static functions
9291 and in effect are optimized more aggressively by interprocedural optimizers.
9293 This option should not be used in combination with @option{-flto}.
9294 Instead relying on a linker plugin should provide safer and more precise
9295 information.
9297 @item -flto[=@var{n}]
9298 @opindex flto
9299 This option runs the standard link-time optimizer.  When invoked
9300 with source code, it generates GIMPLE (one of GCC's internal
9301 representations) and writes it to special ELF sections in the object
9302 file.  When the object files are linked together, all the function
9303 bodies are read from these ELF sections and instantiated as if they
9304 had been part of the same translation unit.
9306 To use the link-time optimizer, @option{-flto} and optimization
9307 options should be specified at compile time and during the final link.
9308 It is recommended that you compile all the files participating in the
9309 same link with the same options and also specify those options at
9310 link time.  
9311 For example:
9313 @smallexample
9314 gcc -c -O2 -flto foo.c
9315 gcc -c -O2 -flto bar.c
9316 gcc -o myprog -flto -O2 foo.o bar.o
9317 @end smallexample
9319 The first two invocations to GCC save a bytecode representation
9320 of GIMPLE into special ELF sections inside @file{foo.o} and
9321 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9322 @file{foo.o} and @file{bar.o}, merges the two files into a single
9323 internal image, and compiles the result as usual.  Since both
9324 @file{foo.o} and @file{bar.o} are merged into a single image, this
9325 causes all the interprocedural analyses and optimizations in GCC to
9326 work across the two files as if they were a single one.  This means,
9327 for example, that the inliner is able to inline functions in
9328 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9330 Another (simpler) way to enable link-time optimization is:
9332 @smallexample
9333 gcc -o myprog -flto -O2 foo.c bar.c
9334 @end smallexample
9336 The above generates bytecode for @file{foo.c} and @file{bar.c},
9337 merges them together into a single GIMPLE representation and optimizes
9338 them as usual to produce @file{myprog}.
9340 The only important thing to keep in mind is that to enable link-time
9341 optimizations you need to use the GCC driver to perform the link step.
9342 GCC then automatically performs link-time optimization if any of the
9343 objects involved were compiled with the @option{-flto} command-line option.  
9344 You generally
9345 should specify the optimization options to be used for link-time
9346 optimization though GCC tries to be clever at guessing an
9347 optimization level to use from the options used at compile time
9348 if you fail to specify one at link time.  You can always override
9349 the automatic decision to do link-time optimization
9350 by passing @option{-fno-lto} to the link command.
9352 To make whole program optimization effective, it is necessary to make
9353 certain whole program assumptions.  The compiler needs to know
9354 what functions and variables can be accessed by libraries and runtime
9355 outside of the link-time optimized unit.  When supported by the linker,
9356 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9357 to the compiler about used and externally visible symbols.  When
9358 the linker plugin is not available, @option{-fwhole-program} should be
9359 used to allow the compiler to make these assumptions, which leads
9360 to more aggressive optimization decisions.
9362 When @option{-fuse-linker-plugin} is not enabled, when a file is
9363 compiled with @option{-flto}, the generated object file is larger than
9364 a regular object file because it contains GIMPLE bytecodes and the usual
9365 final code (see @option{-ffat-lto-objects}.  This means that
9366 object files with LTO information can be linked as normal object
9367 files; if @option{-fno-lto} is passed to the linker, no
9368 interprocedural optimizations are applied.  Note that when
9369 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9370 but you cannot perform a regular, non-LTO link on them.
9372 Additionally, the optimization flags used to compile individual files
9373 are not necessarily related to those used at link time.  For instance,
9375 @smallexample
9376 gcc -c -O0 -ffat-lto-objects -flto foo.c
9377 gcc -c -O0 -ffat-lto-objects -flto bar.c
9378 gcc -o myprog -O3 foo.o bar.o
9379 @end smallexample
9381 This produces individual object files with unoptimized assembler
9382 code, but the resulting binary @file{myprog} is optimized at
9383 @option{-O3}.  If, instead, the final binary is generated with
9384 @option{-fno-lto}, then @file{myprog} is not optimized.
9386 When producing the final binary, GCC only
9387 applies link-time optimizations to those files that contain bytecode.
9388 Therefore, you can mix and match object files and libraries with
9389 GIMPLE bytecodes and final object code.  GCC automatically selects
9390 which files to optimize in LTO mode and which files to link without
9391 further processing.
9393 There are some code generation flags preserved by GCC when
9394 generating bytecodes, as they need to be used during the final link
9395 stage.  Generally options specified at link time override those
9396 specified at compile time.
9398 If you do not specify an optimization level option @option{-O} at
9399 link time, then GCC uses the highest optimization level 
9400 used when compiling the object files.
9402 Currently, the following options and their settings are taken from
9403 the first object file that explicitly specifies them: 
9404 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9405 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9406 and all the @option{-m} target flags.
9408 Certain ABI-changing flags are required to match in all compilation units,
9409 and trying to override this at link time with a conflicting value
9410 is ignored.  This includes options such as @option{-freg-struct-return}
9411 and @option{-fpcc-struct-return}. 
9413 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9414 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9415 are passed through to the link stage and merged conservatively for
9416 conflicting translation units.  Specifically
9417 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9418 precedence; and for example @option{-ffp-contract=off} takes precedence
9419 over @option{-ffp-contract=fast}.  You can override them at link time.
9421 If LTO encounters objects with C linkage declared with incompatible
9422 types in separate translation units to be linked together (undefined
9423 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9424 issued.  The behavior is still undefined at run time.  Similar
9425 diagnostics may be raised for other languages.
9427 Another feature of LTO is that it is possible to apply interprocedural
9428 optimizations on files written in different languages:
9430 @smallexample
9431 gcc -c -flto foo.c
9432 g++ -c -flto bar.cc
9433 gfortran -c -flto baz.f90
9434 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9435 @end smallexample
9437 Notice that the final link is done with @command{g++} to get the C++
9438 runtime libraries and @option{-lgfortran} is added to get the Fortran
9439 runtime libraries.  In general, when mixing languages in LTO mode, you
9440 should use the same link command options as when mixing languages in a
9441 regular (non-LTO) compilation.
9443 If object files containing GIMPLE bytecode are stored in a library archive, say
9444 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9445 are using a linker with plugin support.  To create static libraries suitable
9446 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9447 and @command{ranlib}; 
9448 to show the symbols of object files with GIMPLE bytecode, use
9449 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9450 and @command{nm} have been compiled with plugin support.  At link time, use the the
9451 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9452 the LTO optimization process:
9454 @smallexample
9455 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9456 @end smallexample
9458 With the linker plugin enabled, the linker extracts the needed
9459 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9460 to make them part of the aggregated GIMPLE image to be optimized.
9462 If you are not using a linker with plugin support and/or do not
9463 enable the linker plugin, then the objects inside @file{libfoo.a}
9464 are extracted and linked as usual, but they do not participate
9465 in the LTO optimization process.  In order to make a static library suitable
9466 for both LTO optimization and usual linkage, compile its object files with
9467 @option{-flto} @option{-ffat-lto-objects}.
9469 Link-time optimizations do not require the presence of the whole program to
9470 operate.  If the program does not require any symbols to be exported, it is
9471 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9472 the interprocedural optimizers to use more aggressive assumptions which may
9473 lead to improved optimization opportunities.
9474 Use of @option{-fwhole-program} is not needed when linker plugin is
9475 active (see @option{-fuse-linker-plugin}).
9477 The current implementation of LTO makes no
9478 attempt to generate bytecode that is portable between different
9479 types of hosts.  The bytecode files are versioned and there is a
9480 strict version check, so bytecode files generated in one version of
9481 GCC do not work with an older or newer version of GCC.
9483 Link-time optimization does not work well with generation of debugging
9484 information on systems other than those using a combination of ELF and
9485 DWARF.
9487 If you specify the optional @var{n}, the optimization and code
9488 generation done at link time is executed in parallel using @var{n}
9489 parallel jobs by utilizing an installed @command{make} program.  The
9490 environment variable @env{MAKE} may be used to override the program
9491 used.  The default value for @var{n} is 1.
9493 You can also specify @option{-flto=jobserver} to use GNU make's
9494 job server mode to determine the number of parallel jobs. This
9495 is useful when the Makefile calling GCC is already executing in parallel.
9496 You must prepend a @samp{+} to the command recipe in the parent Makefile
9497 for this to work.  This option likely only works if @env{MAKE} is
9498 GNU make.
9500 @item -flto-partition=@var{alg}
9501 @opindex flto-partition
9502 Specify the partitioning algorithm used by the link-time optimizer.
9503 The value is either @samp{1to1} to specify a partitioning mirroring
9504 the original source files or @samp{balanced} to specify partitioning
9505 into equally sized chunks (whenever possible) or @samp{max} to create
9506 new partition for every symbol where possible.  Specifying @samp{none}
9507 as an algorithm disables partitioning and streaming completely. 
9508 The default value is @samp{balanced}. While @samp{1to1} can be used
9509 as an workaround for various code ordering issues, the @samp{max}
9510 partitioning is intended for internal testing only.
9511 The value @samp{one} specifies that exactly one partition should be
9512 used while the value @samp{none} bypasses partitioning and executes
9513 the link-time optimization step directly from the WPA phase.
9515 @item -flto-odr-type-merging
9516 @opindex flto-odr-type-merging
9517 Enable streaming of mangled types names of C++ types and their unification
9518 at link time.  This increases size of LTO object files, but enables
9519 diagnostics about One Definition Rule violations.
9521 @item -flto-compression-level=@var{n}
9522 @opindex flto-compression-level
9523 This option specifies the level of compression used for intermediate
9524 language written to LTO object files, and is only meaningful in
9525 conjunction with LTO mode (@option{-flto}).  Valid
9526 values are 0 (no compression) to 9 (maximum compression).  Values
9527 outside this range are clamped to either 0 or 9.  If the option is not
9528 given, a default balanced compression setting is used.
9530 @item -fuse-linker-plugin
9531 @opindex fuse-linker-plugin
9532 Enables the use of a linker plugin during link-time optimization.  This
9533 option relies on plugin support in the linker, which is available in gold
9534 or in GNU ld 2.21 or newer.
9536 This option enables the extraction of object files with GIMPLE bytecode out
9537 of library archives. This improves the quality of optimization by exposing
9538 more code to the link-time optimizer.  This information specifies what
9539 symbols can be accessed externally (by non-LTO object or during dynamic
9540 linking).  Resulting code quality improvements on binaries (and shared
9541 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9542 See @option{-flto} for a description of the effect of this flag and how to
9543 use it.
9545 This option is enabled by default when LTO support in GCC is enabled
9546 and GCC was configured for use with
9547 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9549 @item -ffat-lto-objects
9550 @opindex ffat-lto-objects
9551 Fat LTO objects are object files that contain both the intermediate language
9552 and the object code. This makes them usable for both LTO linking and normal
9553 linking. This option is effective only when compiling with @option{-flto}
9554 and is ignored at link time.
9556 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9557 requires the complete toolchain to be aware of LTO. It requires a linker with
9558 linker plugin support for basic functionality.  Additionally,
9559 @command{nm}, @command{ar} and @command{ranlib}
9560 need to support linker plugins to allow a full-featured build environment
9561 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9562 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9563 to these tools. With non fat LTO makefiles need to be modified to use them.
9565 Note that modern binutils provide plugin auto-load mechanism.
9566 Installing the linker plugin into @file{$libdir/bfd-plugins} has the same
9567 effect as usage of the command wrappers (@command{gcc-ar}, @command{gcc-nm} and
9568 @command{gcc-ranlib}).
9570 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9571 support.
9573 @item -fcompare-elim
9574 @opindex fcompare-elim
9575 After register allocation and post-register allocation instruction splitting,
9576 identify arithmetic instructions that compute processor flags similar to a
9577 comparison operation based on that arithmetic.  If possible, eliminate the
9578 explicit comparison operation.
9580 This pass only applies to certain targets that cannot explicitly represent
9581 the comparison operation before register allocation is complete.
9583 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9585 @item -fcprop-registers
9586 @opindex fcprop-registers
9587 After register allocation and post-register allocation instruction splitting,
9588 perform a copy-propagation pass to try to reduce scheduling dependencies
9589 and occasionally eliminate the copy.
9591 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9593 @item -fprofile-correction
9594 @opindex fprofile-correction
9595 Profiles collected using an instrumented binary for multi-threaded programs may
9596 be inconsistent due to missed counter updates. When this option is specified,
9597 GCC uses heuristics to correct or smooth out such inconsistencies. By
9598 default, GCC emits an error message when an inconsistent profile is detected.
9600 @item -fprofile-use
9601 @itemx -fprofile-use=@var{path}
9602 @opindex fprofile-use
9603 Enable profile feedback-directed optimizations, 
9604 and the following optimizations
9605 which are generally profitable only with profile feedback available:
9606 @option{-fbranch-probabilities}, @option{-fvpt},
9607 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9608 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9610 Before you can use this option, you must first generate profiling information.
9611 @xref{Instrumentation Options}, for information about the
9612 @option{-fprofile-generate} option.
9614 By default, GCC emits an error message if the feedback profiles do not
9615 match the source code.  This error can be turned into a warning by using
9616 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9617 code.
9619 If @var{path} is specified, GCC looks at the @var{path} to find
9620 the profile feedback data files. See @option{-fprofile-dir}.
9622 @item -fauto-profile
9623 @itemx -fauto-profile=@var{path}
9624 @opindex fauto-profile
9625 Enable sampling-based feedback-directed optimizations, 
9626 and the following optimizations
9627 which are generally profitable only with profile feedback available:
9628 @option{-fbranch-probabilities}, @option{-fvpt},
9629 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9630 @option{-ftree-vectorize},
9631 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9632 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9633 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9635 @var{path} is the name of a file containing AutoFDO profile information.
9636 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9638 Producing an AutoFDO profile data file requires running your program
9639 with the @command{perf} utility on a supported GNU/Linux target system.
9640 For more information, see @uref{https://perf.wiki.kernel.org/}.
9642 E.g.
9643 @smallexample
9644 perf record -e br_inst_retired:near_taken -b -o perf.data \
9645     -- your_program
9646 @end smallexample
9648 Then use the @command{create_gcov} tool to convert the raw profile data
9649 to a format that can be used by GCC.@  You must also supply the 
9650 unstripped binary for your program to this tool.  
9651 See @uref{https://github.com/google/autofdo}.
9653 E.g.
9654 @smallexample
9655 create_gcov --binary=your_program.unstripped --profile=perf.data \
9656     --gcov=profile.afdo
9657 @end smallexample
9658 @end table
9660 The following options control compiler behavior regarding floating-point 
9661 arithmetic.  These options trade off between speed and
9662 correctness.  All must be specifically enabled.
9664 @table @gcctabopt
9665 @item -ffloat-store
9666 @opindex ffloat-store
9667 Do not store floating-point variables in registers, and inhibit other
9668 options that might change whether a floating-point value is taken from a
9669 register or memory.
9671 @cindex floating-point precision
9672 This option prevents undesirable excess precision on machines such as
9673 the 68000 where the floating registers (of the 68881) keep more
9674 precision than a @code{double} is supposed to have.  Similarly for the
9675 x86 architecture.  For most programs, the excess precision does only
9676 good, but a few programs rely on the precise definition of IEEE floating
9677 point.  Use @option{-ffloat-store} for such programs, after modifying
9678 them to store all pertinent intermediate computations into variables.
9680 @item -fexcess-precision=@var{style}
9681 @opindex fexcess-precision
9682 This option allows further control over excess precision on machines
9683 where floating-point operations occur in a format with more precision or
9684 range than the IEEE standard and interchange floating-point types.  By
9685 default, @option{-fexcess-precision=fast} is in effect; this means that
9686 operations may be carried out in a wider precision than the types specified
9687 in the source if that would result in faster code, and it is unpredictable
9688 when rounding to the types specified in the source code takes place.
9689 When compiling C, if @option{-fexcess-precision=standard} is specified then
9690 excess precision follows the rules specified in ISO C99; in particular,
9691 both casts and assignments cause values to be rounded to their
9692 semantic types (whereas @option{-ffloat-store} only affects
9693 assignments).  This option is enabled by default for C if a strict
9694 conformance option such as @option{-std=c99} is used.
9695 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9696 regardless of whether a strict conformance option is used.
9698 @opindex mfpmath
9699 @option{-fexcess-precision=standard} is not implemented for languages
9700 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9701 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9702 semantics apply without excess precision, and in the latter, rounding
9703 is unpredictable.
9705 @item -ffast-math
9706 @opindex ffast-math
9707 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9708 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9709 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9710 @option{-fexcess-precision=fast}.
9712 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9714 This option is not turned on by any @option{-O} option besides
9715 @option{-Ofast} since it can result in incorrect output for programs
9716 that depend on an exact implementation of IEEE or ISO rules/specifications
9717 for math functions. It may, however, yield faster code for programs
9718 that do not require the guarantees of these specifications.
9720 @item -fno-math-errno
9721 @opindex fno-math-errno
9722 Do not set @code{errno} after calling math functions that are executed
9723 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9724 IEEE exceptions for math error handling may want to use this flag
9725 for speed while maintaining IEEE arithmetic compatibility.
9727 This option is not turned on by any @option{-O} option since
9728 it can result in incorrect output for programs that depend on
9729 an exact implementation of IEEE or ISO rules/specifications for
9730 math functions. It may, however, yield faster code for programs
9731 that do not require the guarantees of these specifications.
9733 The default is @option{-fmath-errno}.
9735 On Darwin systems, the math library never sets @code{errno}.  There is
9736 therefore no reason for the compiler to consider the possibility that
9737 it might, and @option{-fno-math-errno} is the default.
9739 @item -funsafe-math-optimizations
9740 @opindex funsafe-math-optimizations
9742 Allow optimizations for floating-point arithmetic that (a) assume
9743 that arguments and results are valid and (b) may violate IEEE or
9744 ANSI standards.  When used at link time, it may include libraries
9745 or startup files that change the default FPU control word or other
9746 similar optimizations.
9748 This option is not turned on by any @option{-O} option since
9749 it can result in incorrect output for programs that depend on
9750 an exact implementation of IEEE or ISO rules/specifications for
9751 math functions. It may, however, yield faster code for programs
9752 that do not require the guarantees of these specifications.
9753 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9754 @option{-fassociative-math} and @option{-freciprocal-math}.
9756 The default is @option{-fno-unsafe-math-optimizations}.
9758 @item -fassociative-math
9759 @opindex fassociative-math
9761 Allow re-association of operands in series of floating-point operations.
9762 This violates the ISO C and C++ language standard by possibly changing
9763 computation result.  NOTE: re-ordering may change the sign of zero as
9764 well as ignore NaNs and inhibit or create underflow or overflow (and
9765 thus cannot be used on code that relies on rounding behavior like
9766 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9767 and thus may not be used when ordered comparisons are required.
9768 This option requires that both @option{-fno-signed-zeros} and
9769 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9770 much sense with @option{-frounding-math}. For Fortran the option
9771 is automatically enabled when both @option{-fno-signed-zeros} and
9772 @option{-fno-trapping-math} are in effect.
9774 The default is @option{-fno-associative-math}.
9776 @item -freciprocal-math
9777 @opindex freciprocal-math
9779 Allow the reciprocal of a value to be used instead of dividing by
9780 the value if this enables optimizations.  For example @code{x / y}
9781 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9782 is subject to common subexpression elimination.  Note that this loses
9783 precision and increases the number of flops operating on the value.
9785 The default is @option{-fno-reciprocal-math}.
9787 @item -ffinite-math-only
9788 @opindex ffinite-math-only
9789 Allow optimizations for floating-point arithmetic that assume
9790 that arguments and results are not NaNs or +-Infs.
9792 This option is not turned on by any @option{-O} option since
9793 it can result in incorrect output for programs that depend on
9794 an exact implementation of IEEE or ISO rules/specifications for
9795 math functions. It may, however, yield faster code for programs
9796 that do not require the guarantees of these specifications.
9798 The default is @option{-fno-finite-math-only}.
9800 @item -fno-signed-zeros
9801 @opindex fno-signed-zeros
9802 Allow optimizations for floating-point arithmetic that ignore the
9803 signedness of zero.  IEEE arithmetic specifies the behavior of
9804 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9805 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9806 This option implies that the sign of a zero result isn't significant.
9808 The default is @option{-fsigned-zeros}.
9810 @item -fno-trapping-math
9811 @opindex fno-trapping-math
9812 Compile code assuming that floating-point operations cannot generate
9813 user-visible traps.  These traps include division by zero, overflow,
9814 underflow, inexact result and invalid operation.  This option requires
9815 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9816 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9818 This option should never be turned on by any @option{-O} option since
9819 it can result in incorrect output for programs that depend on
9820 an exact implementation of IEEE or ISO rules/specifications for
9821 math functions.
9823 The default is @option{-ftrapping-math}.
9825 @item -frounding-math
9826 @opindex frounding-math
9827 Disable transformations and optimizations that assume default floating-point
9828 rounding behavior.  This is round-to-zero for all floating point
9829 to integer conversions, and round-to-nearest for all other arithmetic
9830 truncations.  This option should be specified for programs that change
9831 the FP rounding mode dynamically, or that may be executed with a
9832 non-default rounding mode.  This option disables constant folding of
9833 floating-point expressions at compile time (which may be affected by
9834 rounding mode) and arithmetic transformations that are unsafe in the
9835 presence of sign-dependent rounding modes.
9837 The default is @option{-fno-rounding-math}.
9839 This option is experimental and does not currently guarantee to
9840 disable all GCC optimizations that are affected by rounding mode.
9841 Future versions of GCC may provide finer control of this setting
9842 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9843 will be used to specify the default state for @code{FENV_ACCESS}.
9845 @item -fsignaling-nans
9846 @opindex fsignaling-nans
9847 Compile code assuming that IEEE signaling NaNs may generate user-visible
9848 traps during floating-point operations.  Setting this option disables
9849 optimizations that may change the number of exceptions visible with
9850 signaling NaNs.  This option implies @option{-ftrapping-math}.
9852 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9853 be defined.
9855 The default is @option{-fno-signaling-nans}.
9857 This option is experimental and does not currently guarantee to
9858 disable all GCC optimizations that affect signaling NaN behavior.
9860 @item -fno-fp-int-builtin-inexact
9861 @opindex fno-fp-int-builtin-inexact
9862 Do not allow the built-in functions @code{ceil}, @code{floor},
9863 @code{round} and @code{trunc}, and their @code{float} and @code{long
9864 double} variants, to generate code that raises the ``inexact''
9865 floating-point exception for noninteger arguments.  ISO C99 and C11
9866 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9867 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9868 functions to do so.
9870 The default is @option{-ffp-int-builtin-inexact}, allowing the
9871 exception to be raised.  This option does nothing unless
9872 @option{-ftrapping-math} is in effect.
9874 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9875 generate a call to a library function then the ``inexact'' exception
9876 may be raised if the library implementation does not follow TS 18661.
9878 @item -fsingle-precision-constant
9879 @opindex fsingle-precision-constant
9880 Treat floating-point constants as single precision instead of
9881 implicitly converting them to double-precision constants.
9883 @item -fcx-limited-range
9884 @opindex fcx-limited-range
9885 When enabled, this option states that a range reduction step is not
9886 needed when performing complex division.  Also, there is no checking
9887 whether the result of a complex multiplication or division is @code{NaN
9888 + I*NaN}, with an attempt to rescue the situation in that case.  The
9889 default is @option{-fno-cx-limited-range}, but is enabled by
9890 @option{-ffast-math}.
9892 This option controls the default setting of the ISO C99
9893 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9894 all languages.
9896 @item -fcx-fortran-rules
9897 @opindex fcx-fortran-rules
9898 Complex multiplication and division follow Fortran rules.  Range
9899 reduction is done as part of complex division, but there is no checking
9900 whether the result of a complex multiplication or division is @code{NaN
9901 + I*NaN}, with an attempt to rescue the situation in that case.
9903 The default is @option{-fno-cx-fortran-rules}.
9905 @end table
9907 The following options control optimizations that may improve
9908 performance, but are not enabled by any @option{-O} options.  This
9909 section includes experimental options that may produce broken code.
9911 @table @gcctabopt
9912 @item -fbranch-probabilities
9913 @opindex fbranch-probabilities
9914 After running a program compiled with @option{-fprofile-arcs}
9915 (@pxref{Instrumentation Options}),
9916 you can compile it a second time using
9917 @option{-fbranch-probabilities}, to improve optimizations based on
9918 the number of times each branch was taken.  When a program
9919 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9920 counts to a file called @file{@var{sourcename}.gcda} for each source
9921 file.  The information in this data file is very dependent on the
9922 structure of the generated code, so you must use the same source code
9923 and the same optimization options for both compilations.
9925 With @option{-fbranch-probabilities}, GCC puts a
9926 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9927 These can be used to improve optimization.  Currently, they are only
9928 used in one place: in @file{reorg.c}, instead of guessing which path a
9929 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9930 exactly determine which path is taken more often.
9932 @item -fprofile-values
9933 @opindex fprofile-values
9934 If combined with @option{-fprofile-arcs}, it adds code so that some
9935 data about values of expressions in the program is gathered.
9937 With @option{-fbranch-probabilities}, it reads back the data gathered
9938 from profiling values of expressions for usage in optimizations.
9940 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9942 @item -fprofile-reorder-functions
9943 @opindex fprofile-reorder-functions
9944 Function reordering based on profile instrumentation collects
9945 first time of execution of a function and orders these functions
9946 in ascending order.
9948 Enabled with @option{-fprofile-use}.
9950 @item -fvpt
9951 @opindex fvpt
9952 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9953 to add code to gather information about values of expressions.
9955 With @option{-fbranch-probabilities}, it reads back the data gathered
9956 and actually performs the optimizations based on them.
9957 Currently the optimizations include specialization of division operations
9958 using the knowledge about the value of the denominator.
9960 @item -frename-registers
9961 @opindex frename-registers
9962 Attempt to avoid false dependencies in scheduled code by making use
9963 of registers left over after register allocation.  This optimization
9964 most benefits processors with lots of registers.  Depending on the
9965 debug information format adopted by the target, however, it can
9966 make debugging impossible, since variables no longer stay in
9967 a ``home register''.
9969 Enabled by default with @option{-funroll-loops}.
9971 @item -fschedule-fusion
9972 @opindex fschedule-fusion
9973 Performs a target dependent pass over the instruction stream to schedule
9974 instructions of same type together because target machine can execute them
9975 more efficiently if they are adjacent to each other in the instruction flow.
9977 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9979 @item -ftracer
9980 @opindex ftracer
9981 Perform tail duplication to enlarge superblock size.  This transformation
9982 simplifies the control flow of the function allowing other optimizations to do
9983 a better job.
9985 Enabled with @option{-fprofile-use}.
9987 @item -funroll-loops
9988 @opindex funroll-loops
9989 Unroll loops whose number of iterations can be determined at compile time or
9990 upon entry to the loop.  @option{-funroll-loops} implies
9991 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9992 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9993 a small constant number of iterations).  This option makes code larger, and may
9994 or may not make it run faster.
9996 Enabled with @option{-fprofile-use}.
9998 @item -funroll-all-loops
9999 @opindex funroll-all-loops
10000 Unroll all loops, even if their number of iterations is uncertain when
10001 the loop is entered.  This usually makes programs run more slowly.
10002 @option{-funroll-all-loops} implies the same options as
10003 @option{-funroll-loops}.
10005 @item -fpeel-loops
10006 @opindex fpeel-loops
10007 Peels loops for which there is enough information that they do not
10008 roll much (from profile feedback or static analysis).  It also turns on
10009 complete loop peeling (i.e.@: complete removal of loops with small constant
10010 number of iterations).
10012 Enabled with @option{-O3} and/or @option{-fprofile-use}.
10014 @item -fmove-loop-invariants
10015 @opindex fmove-loop-invariants
10016 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10017 at level @option{-O1}
10019 @item -fsplit-loops
10020 @opindex fsplit-loops
10021 Split a loop into two if it contains a condition that's always true
10022 for one side of the iteration space and false for the other.
10024 @item -funswitch-loops
10025 @opindex funswitch-loops
10026 Move branches with loop invariant conditions out of the loop, with duplicates
10027 of the loop on both branches (modified according to result of the condition).
10029 @item -ffunction-sections
10030 @itemx -fdata-sections
10031 @opindex ffunction-sections
10032 @opindex fdata-sections
10033 Place each function or data item into its own section in the output
10034 file if the target supports arbitrary sections.  The name of the
10035 function or the name of the data item determines the section's name
10036 in the output file.
10038 Use these options on systems where the linker can perform optimizations to
10039 improve locality of reference in the instruction space.  Most systems using the
10040 ELF object format have linkers with such optimizations.  On AIX, the linker
10041 rearranges sections (CSECTs) based on the call graph.  The performance impact
10042 varies.
10044 Together with a linker garbage collection (linker @option{--gc-sections}
10045 option) these options may lead to smaller statically-linked executables (after
10046 stripping).
10048 On ELF/DWARF systems these options do not degenerate the quality of the debug
10049 information.  There could be issues with other object files/debug info formats.
10051 Only use these options when there are significant benefits from doing so.  When
10052 you specify these options, the assembler and linker create larger object and
10053 executable files and are also slower.  These options affect code generation.
10054 They prevent optimizations by the compiler and assembler using relative
10055 locations inside a translation unit since the locations are unknown until
10056 link time.  An example of such an optimization is relaxing calls to short call
10057 instructions.
10059 @item -fbranch-target-load-optimize
10060 @opindex fbranch-target-load-optimize
10061 Perform branch target register load optimization before prologue / epilogue
10062 threading.
10063 The use of target registers can typically be exposed only during reload,
10064 thus hoisting loads out of loops and doing inter-block scheduling needs
10065 a separate optimization pass.
10067 @item -fbranch-target-load-optimize2
10068 @opindex fbranch-target-load-optimize2
10069 Perform branch target register load optimization after prologue / epilogue
10070 threading.
10072 @item -fbtr-bb-exclusive
10073 @opindex fbtr-bb-exclusive
10074 When performing branch target register load optimization, don't reuse
10075 branch target registers within any basic block.
10077 @item -fstdarg-opt
10078 @opindex fstdarg-opt
10079 Optimize the prologue of variadic argument functions with respect to usage of
10080 those arguments.
10082 @item -fsection-anchors
10083 @opindex fsection-anchors
10084 Try to reduce the number of symbolic address calculations by using
10085 shared ``anchor'' symbols to address nearby objects.  This transformation
10086 can help to reduce the number of GOT entries and GOT accesses on some
10087 targets.
10089 For example, the implementation of the following function @code{foo}:
10091 @smallexample
10092 static int a, b, c;
10093 int foo (void) @{ return a + b + c; @}
10094 @end smallexample
10096 @noindent
10097 usually calculates the addresses of all three variables, but if you
10098 compile it with @option{-fsection-anchors}, it accesses the variables
10099 from a common anchor point instead.  The effect is similar to the
10100 following pseudocode (which isn't valid C):
10102 @smallexample
10103 int foo (void)
10105   register int *xr = &x;
10106   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10108 @end smallexample
10110 Not all targets support this option.
10112 @item --param @var{name}=@var{value}
10113 @opindex param
10114 In some places, GCC uses various constants to control the amount of
10115 optimization that is done.  For example, GCC does not inline functions
10116 that contain more than a certain number of instructions.  You can
10117 control some of these constants on the command line using the
10118 @option{--param} option.
10120 The names of specific parameters, and the meaning of the values, are
10121 tied to the internals of the compiler, and are subject to change
10122 without notice in future releases.
10124 In each case, the @var{value} is an integer.  The allowable choices for
10125 @var{name} are:
10127 @table @gcctabopt
10128 @item predictable-branch-outcome
10129 When branch is predicted to be taken with probability lower than this threshold
10130 (in percent), then it is considered well predictable. The default is 10.
10132 @item max-rtl-if-conversion-insns
10133 RTL if-conversion tries to remove conditional branches around a block and
10134 replace them with conditionally executed instructions.  This parameter
10135 gives the maximum number of instructions in a block which should be
10136 considered for if-conversion.  The default is 10, though the compiler will
10137 also use other heuristics to decide whether if-conversion is likely to be
10138 profitable.
10140 @item max-rtl-if-conversion-predictable-cost
10141 @itemx max-rtl-if-conversion-unpredictable-cost
10142 RTL if-conversion will try to remove conditional branches around a block
10143 and replace them with conditionally executed instructions.  These parameters
10144 give the maximum permissible cost for the sequence that would be generated
10145 by if-conversion depending on whether the branch is statically determined
10146 to be predictable or not.  The units for this parameter are the same as
10147 those for the GCC internal seq_cost metric.  The compiler will try to
10148 provide a reasonable default for this parameter using the BRANCH_COST
10149 target macro.
10151 @item max-crossjump-edges
10152 The maximum number of incoming edges to consider for cross-jumping.
10153 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10154 the number of edges incoming to each block.  Increasing values mean
10155 more aggressive optimization, making the compilation time increase with
10156 probably small improvement in executable size.
10158 @item min-crossjump-insns
10159 The minimum number of instructions that must be matched at the end
10160 of two blocks before cross-jumping is performed on them.  This
10161 value is ignored in the case where all instructions in the block being
10162 cross-jumped from are matched.  The default value is 5.
10164 @item max-grow-copy-bb-insns
10165 The maximum code size expansion factor when copying basic blocks
10166 instead of jumping.  The expansion is relative to a jump instruction.
10167 The default value is 8.
10169 @item max-goto-duplication-insns
10170 The maximum number of instructions to duplicate to a block that jumps
10171 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10172 passes, GCC factors computed gotos early in the compilation process,
10173 and unfactors them as late as possible.  Only computed jumps at the
10174 end of a basic blocks with no more than max-goto-duplication-insns are
10175 unfactored.  The default value is 8.
10177 @item max-delay-slot-insn-search
10178 The maximum number of instructions to consider when looking for an
10179 instruction to fill a delay slot.  If more than this arbitrary number of
10180 instructions are searched, the time savings from filling the delay slot
10181 are minimal, so stop searching.  Increasing values mean more
10182 aggressive optimization, making the compilation time increase with probably
10183 small improvement in execution time.
10185 @item max-delay-slot-live-search
10186 When trying to fill delay slots, the maximum number of instructions to
10187 consider when searching for a block with valid live register
10188 information.  Increasing this arbitrarily chosen value means more
10189 aggressive optimization, increasing the compilation time.  This parameter
10190 should be removed when the delay slot code is rewritten to maintain the
10191 control-flow graph.
10193 @item max-gcse-memory
10194 The approximate maximum amount of memory that can be allocated in
10195 order to perform the global common subexpression elimination
10196 optimization.  If more memory than specified is required, the
10197 optimization is not done.
10199 @item max-gcse-insertion-ratio
10200 If the ratio of expression insertions to deletions is larger than this value
10201 for any expression, then RTL PRE inserts or removes the expression and thus
10202 leaves partially redundant computations in the instruction stream.  The default value is 20.
10204 @item max-pending-list-length
10205 The maximum number of pending dependencies scheduling allows
10206 before flushing the current state and starting over.  Large functions
10207 with few branches or calls can create excessively large lists which
10208 needlessly consume memory and resources.
10210 @item max-modulo-backtrack-attempts
10211 The maximum number of backtrack attempts the scheduler should make
10212 when modulo scheduling a loop.  Larger values can exponentially increase
10213 compilation time.
10215 @item max-inline-insns-single
10216 Several parameters control the tree inliner used in GCC@.
10217 This number sets the maximum number of instructions (counted in GCC's
10218 internal representation) in a single function that the tree inliner
10219 considers for inlining.  This only affects functions declared
10220 inline and methods implemented in a class declaration (C++).
10221 The default value is 400.
10223 @item max-inline-insns-auto
10224 When you use @option{-finline-functions} (included in @option{-O3}),
10225 a lot of functions that would otherwise not be considered for inlining
10226 by the compiler are investigated.  To those functions, a different
10227 (more restrictive) limit compared to functions declared inline can
10228 be applied.
10229 The default value is 30.
10231 @item inline-min-speedup
10232 When estimated performance improvement of caller + callee runtime exceeds this
10233 threshold (in percent), the function can be inlined regardless of the limit on
10234 @option{--param max-inline-insns-single} and @option{--param
10235 max-inline-insns-auto}.
10236 The default value is 15.
10238 @item large-function-insns
10239 The limit specifying really large functions.  For functions larger than this
10240 limit after inlining, inlining is constrained by
10241 @option{--param large-function-growth}.  This parameter is useful primarily
10242 to avoid extreme compilation time caused by non-linear algorithms used by the
10243 back end.
10244 The default value is 2700.
10246 @item large-function-growth
10247 Specifies maximal growth of large function caused by inlining in percents.
10248 The default value is 100 which limits large function growth to 2.0 times
10249 the original size.
10251 @item large-unit-insns
10252 The limit specifying large translation unit.  Growth caused by inlining of
10253 units larger than this limit is limited by @option{--param inline-unit-growth}.
10254 For small units this might be too tight.
10255 For example, consider a unit consisting of function A
10256 that is inline and B that just calls A three times.  If B is small relative to
10257 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10258 large units consisting of small inlineable functions, however, the overall unit
10259 growth limit is needed to avoid exponential explosion of code size.  Thus for
10260 smaller units, the size is increased to @option{--param large-unit-insns}
10261 before applying @option{--param inline-unit-growth}.  The default is 10000.
10263 @item inline-unit-growth
10264 Specifies maximal overall growth of the compilation unit caused by inlining.
10265 The default value is 20 which limits unit growth to 1.2 times the original
10266 size. Cold functions (either marked cold via an attribute or by profile
10267 feedback) are not accounted into the unit size.
10269 @item ipcp-unit-growth
10270 Specifies maximal overall growth of the compilation unit caused by
10271 interprocedural constant propagation.  The default value is 10 which limits
10272 unit growth to 1.1 times the original size.
10274 @item large-stack-frame
10275 The limit specifying large stack frames.  While inlining the algorithm is trying
10276 to not grow past this limit too much.  The default value is 256 bytes.
10278 @item large-stack-frame-growth
10279 Specifies maximal growth of large stack frames caused by inlining in percents.
10280 The default value is 1000 which limits large stack frame growth to 11 times
10281 the original size.
10283 @item max-inline-insns-recursive
10284 @itemx max-inline-insns-recursive-auto
10285 Specifies the maximum number of instructions an out-of-line copy of a
10286 self-recursive inline
10287 function can grow into by performing recursive inlining.
10289 @option{--param max-inline-insns-recursive} applies to functions
10290 declared inline.
10291 For functions not declared inline, recursive inlining
10292 happens only when @option{-finline-functions} (included in @option{-O3}) is
10293 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10294 default value is 450.
10296 @item max-inline-recursive-depth
10297 @itemx max-inline-recursive-depth-auto
10298 Specifies the maximum recursion depth used for recursive inlining.
10300 @option{--param max-inline-recursive-depth} applies to functions
10301 declared inline.  For functions not declared inline, recursive inlining
10302 happens only when @option{-finline-functions} (included in @option{-O3}) is
10303 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10304 default value is 8.
10306 @item min-inline-recursive-probability
10307 Recursive inlining is profitable only for function having deep recursion
10308 in average and can hurt for function having little recursion depth by
10309 increasing the prologue size or complexity of function body to other
10310 optimizers.
10312 When profile feedback is available (see @option{-fprofile-generate}) the actual
10313 recursion depth can be guessed from the probability that function recurses
10314 via a given call expression.  This parameter limits inlining only to call
10315 expressions whose probability exceeds the given threshold (in percents).
10316 The default value is 10.
10318 @item early-inlining-insns
10319 Specify growth that the early inliner can make.  In effect it increases
10320 the amount of inlining for code having a large abstraction penalty.
10321 The default value is 14.
10323 @item max-early-inliner-iterations
10324 Limit of iterations of the early inliner.  This basically bounds
10325 the number of nested indirect calls the early inliner can resolve.
10326 Deeper chains are still handled by late inlining.
10328 @item comdat-sharing-probability
10329 Probability (in percent) that C++ inline function with comdat visibility
10330 are shared across multiple compilation units.  The default value is 20.
10332 @item profile-func-internal-id
10333 A parameter to control whether to use function internal id in profile
10334 database lookup. If the value is 0, the compiler uses an id that
10335 is based on function assembler name and filename, which makes old profile
10336 data more tolerant to source changes such as function reordering etc.
10337 The default value is 0.
10339 @item min-vect-loop-bound
10340 The minimum number of iterations under which loops are not vectorized
10341 when @option{-ftree-vectorize} is used.  The number of iterations after
10342 vectorization needs to be greater than the value specified by this option
10343 to allow vectorization.  The default value is 0.
10345 @item gcse-cost-distance-ratio
10346 Scaling factor in calculation of maximum distance an expression
10347 can be moved by GCSE optimizations.  This is currently supported only in the
10348 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10349 is with simple expressions, i.e., the expressions that have cost
10350 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10351 hoisting of simple expressions.  The default value is 10.
10353 @item gcse-unrestricted-cost
10354 Cost, roughly measured as the cost of a single typical machine
10355 instruction, at which GCSE optimizations do not constrain
10356 the distance an expression can travel.  This is currently
10357 supported only in the code hoisting pass.  The lesser the cost,
10358 the more aggressive code hoisting is.  Specifying 0 
10359 allows all expressions to travel unrestricted distances.
10360 The default value is 3.
10362 @item max-hoist-depth
10363 The depth of search in the dominator tree for expressions to hoist.
10364 This is used to avoid quadratic behavior in hoisting algorithm.
10365 The value of 0 does not limit on the search, but may slow down compilation
10366 of huge functions.  The default value is 30.
10368 @item max-tail-merge-comparisons
10369 The maximum amount of similar bbs to compare a bb with.  This is used to
10370 avoid quadratic behavior in tree tail merging.  The default value is 10.
10372 @item max-tail-merge-iterations
10373 The maximum amount of iterations of the pass over the function.  This is used to
10374 limit compilation time in tree tail merging.  The default value is 2.
10376 @item store-merging-allow-unaligned
10377 Allow the store merging pass to introduce unaligned stores if it is legal to
10378 do so.  The default value is 1.
10380 @item max-stores-to-merge
10381 The maximum number of stores to attempt to merge into wider stores in the store
10382 merging pass.  The minimum value is 2 and the default is 64.
10384 @item max-unrolled-insns
10385 The maximum number of instructions that a loop may have to be unrolled.
10386 If a loop is unrolled, this parameter also determines how many times
10387 the loop code is unrolled.
10389 @item max-average-unrolled-insns
10390 The maximum number of instructions biased by probabilities of their execution
10391 that a loop may have to be unrolled.  If a loop is unrolled,
10392 this parameter also determines how many times the loop code is unrolled.
10394 @item max-unroll-times
10395 The maximum number of unrollings of a single loop.
10397 @item max-peeled-insns
10398 The maximum number of instructions that a loop may have to be peeled.
10399 If a loop is peeled, this parameter also determines how many times
10400 the loop code is peeled.
10402 @item max-peel-times
10403 The maximum number of peelings of a single loop.
10405 @item max-peel-branches
10406 The maximum number of branches on the hot path through the peeled sequence.
10408 @item max-completely-peeled-insns
10409 The maximum number of insns of a completely peeled loop.
10411 @item max-completely-peel-times
10412 The maximum number of iterations of a loop to be suitable for complete peeling.
10414 @item max-completely-peel-loop-nest-depth
10415 The maximum depth of a loop nest suitable for complete peeling.
10417 @item max-unswitch-insns
10418 The maximum number of insns of an unswitched loop.
10420 @item max-unswitch-level
10421 The maximum number of branches unswitched in a single loop.
10423 @item max-loop-headers-insns
10424 The maximum number of insns in loop header duplicated by the copy loop headers
10425 pass.
10427 @item lim-expensive
10428 The minimum cost of an expensive expression in the loop invariant motion.
10430 @item iv-consider-all-candidates-bound
10431 Bound on number of candidates for induction variables, below which
10432 all candidates are considered for each use in induction variable
10433 optimizations.  If there are more candidates than this,
10434 only the most relevant ones are considered to avoid quadratic time complexity.
10436 @item iv-max-considered-uses
10437 The induction variable optimizations give up on loops that contain more
10438 induction variable uses.
10440 @item iv-always-prune-cand-set-bound
10441 If the number of candidates in the set is smaller than this value,
10442 always try to remove unnecessary ivs from the set
10443 when adding a new one.
10445 @item avg-loop-niter
10446 Average number of iterations of a loop.
10448 @item dse-max-object-size
10449 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10450 Larger values may result in larger compilation times.
10452 @item dse-max-alias-queries-per-store
10453 Maximum number of queries into the alias oracle per store.
10454 Larger values result in larger compilation times and may result in more
10455 removed dead stores.
10457 @item scev-max-expr-size
10458 Bound on size of expressions used in the scalar evolutions analyzer.
10459 Large expressions slow the analyzer.
10461 @item scev-max-expr-complexity
10462 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10463 Complex expressions slow the analyzer.
10465 @item max-tree-if-conversion-phi-args
10466 Maximum number of arguments in a PHI supported by TREE if conversion
10467 unless the loop is marked with simd pragma.
10469 @item vect-max-version-for-alignment-checks
10470 The maximum number of run-time checks that can be performed when
10471 doing loop versioning for alignment in the vectorizer.
10473 @item vect-max-version-for-alias-checks
10474 The maximum number of run-time checks that can be performed when
10475 doing loop versioning for alias in the vectorizer.
10477 @item vect-max-peeling-for-alignment
10478 The maximum number of loop peels to enhance access alignment
10479 for vectorizer. Value -1 means no limit.
10481 @item max-iterations-to-track
10482 The maximum number of iterations of a loop the brute-force algorithm
10483 for analysis of the number of iterations of the loop tries to evaluate.
10485 @item hot-bb-count-ws-permille
10486 A basic block profile count is considered hot if it contributes to 
10487 the given permillage (i.e. 0...1000) of the entire profiled execution.
10489 @item hot-bb-frequency-fraction
10490 Select fraction of the entry block frequency of executions of basic block in
10491 function given basic block needs to have to be considered hot.
10493 @item max-predicted-iterations
10494 The maximum number of loop iterations we predict statically.  This is useful
10495 in cases where a function contains a single loop with known bound and
10496 another loop with unknown bound.
10497 The known number of iterations is predicted correctly, while
10498 the unknown number of iterations average to roughly 10.  This means that the
10499 loop without bounds appears artificially cold relative to the other one.
10501 @item builtin-expect-probability
10502 Control the probability of the expression having the specified value. This
10503 parameter takes a percentage (i.e. 0 ... 100) as input.
10504 The default probability of 90 is obtained empirically.
10506 @item align-threshold
10508 Select fraction of the maximal frequency of executions of a basic block in
10509 a function to align the basic block.
10511 @item align-loop-iterations
10513 A loop expected to iterate at least the selected number of iterations is
10514 aligned.
10516 @item tracer-dynamic-coverage
10517 @itemx tracer-dynamic-coverage-feedback
10519 This value is used to limit superblock formation once the given percentage of
10520 executed instructions is covered.  This limits unnecessary code size
10521 expansion.
10523 The @option{tracer-dynamic-coverage-feedback} parameter
10524 is used only when profile
10525 feedback is available.  The real profiles (as opposed to statically estimated
10526 ones) are much less balanced allowing the threshold to be larger value.
10528 @item tracer-max-code-growth
10529 Stop tail duplication once code growth has reached given percentage.  This is
10530 a rather artificial limit, as most of the duplicates are eliminated later in
10531 cross jumping, so it may be set to much higher values than is the desired code
10532 growth.
10534 @item tracer-min-branch-ratio
10536 Stop reverse growth when the reverse probability of best edge is less than this
10537 threshold (in percent).
10539 @item tracer-min-branch-probability
10540 @itemx tracer-min-branch-probability-feedback
10542 Stop forward growth if the best edge has probability lower than this
10543 threshold.
10545 Similarly to @option{tracer-dynamic-coverage} two parameters are
10546 provided.  @option{tracer-min-branch-probability-feedback} is used for
10547 compilation with profile feedback and @option{tracer-min-branch-probability}
10548 compilation without.  The value for compilation with profile feedback
10549 needs to be more conservative (higher) in order to make tracer
10550 effective.
10552 @item stack-clash-protection-guard-size
10553 Specify the size of the operating system provided stack guard as
10554 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10555 Acceptable values are between 12 and 30.  Higher values may reduce the
10556 number of explicit probes, but a value larger than the operating system
10557 provided guard will leave code vulnerable to stack clash style attacks.
10559 @item stack-clash-protection-probe-interval
10560 Stack clash protection involves probing stack space as it is allocated.  This
10561 param controls the maximum distance between probes into the stack as 2 raised
10562 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10563 12.  Higher values may reduce the number of explicit probes, but a value
10564 larger than the operating system provided guard will leave code vulnerable to
10565 stack clash style attacks.
10567 @item max-cse-path-length
10569 The maximum number of basic blocks on path that CSE considers.
10570 The default is 10.
10572 @item max-cse-insns
10573 The maximum number of instructions CSE processes before flushing.
10574 The default is 1000.
10576 @item ggc-min-expand
10578 GCC uses a garbage collector to manage its own memory allocation.  This
10579 parameter specifies the minimum percentage by which the garbage
10580 collector's heap should be allowed to expand between collections.
10581 Tuning this may improve compilation speed; it has no effect on code
10582 generation.
10584 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10585 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10586 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10587 GCC is not able to calculate RAM on a particular platform, the lower
10588 bound of 30% is used.  Setting this parameter and
10589 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10590 every opportunity.  This is extremely slow, but can be useful for
10591 debugging.
10593 @item ggc-min-heapsize
10595 Minimum size of the garbage collector's heap before it begins bothering
10596 to collect garbage.  The first collection occurs after the heap expands
10597 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10598 tuning this may improve compilation speed, and has no effect on code
10599 generation.
10601 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10602 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10603 with a lower bound of 4096 (four megabytes) and an upper bound of
10604 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10605 particular platform, the lower bound is used.  Setting this parameter
10606 very large effectively disables garbage collection.  Setting this
10607 parameter and @option{ggc-min-expand} to zero causes a full collection
10608 to occur at every opportunity.
10610 @item max-reload-search-insns
10611 The maximum number of instruction reload should look backward for equivalent
10612 register.  Increasing values mean more aggressive optimization, making the
10613 compilation time increase with probably slightly better performance.
10614 The default value is 100.
10616 @item max-cselib-memory-locations
10617 The maximum number of memory locations cselib should take into account.
10618 Increasing values mean more aggressive optimization, making the compilation time
10619 increase with probably slightly better performance.  The default value is 500.
10621 @item max-sched-ready-insns
10622 The maximum number of instructions ready to be issued the scheduler should
10623 consider at any given time during the first scheduling pass.  Increasing
10624 values mean more thorough searches, making the compilation time increase
10625 with probably little benefit.  The default value is 100.
10627 @item max-sched-region-blocks
10628 The maximum number of blocks in a region to be considered for
10629 interblock scheduling.  The default value is 10.
10631 @item max-pipeline-region-blocks
10632 The maximum number of blocks in a region to be considered for
10633 pipelining in the selective scheduler.  The default value is 15.
10635 @item max-sched-region-insns
10636 The maximum number of insns in a region to be considered for
10637 interblock scheduling.  The default value is 100.
10639 @item max-pipeline-region-insns
10640 The maximum number of insns in a region to be considered for
10641 pipelining in the selective scheduler.  The default value is 200.
10643 @item min-spec-prob
10644 The minimum probability (in percents) of reaching a source block
10645 for interblock speculative scheduling.  The default value is 40.
10647 @item max-sched-extend-regions-iters
10648 The maximum number of iterations through CFG to extend regions.
10649 A value of 0 (the default) disables region extensions.
10651 @item max-sched-insn-conflict-delay
10652 The maximum conflict delay for an insn to be considered for speculative motion.
10653 The default value is 3.
10655 @item sched-spec-prob-cutoff
10656 The minimal probability of speculation success (in percents), so that
10657 speculative insns are scheduled.
10658 The default value is 40.
10660 @item sched-state-edge-prob-cutoff
10661 The minimum probability an edge must have for the scheduler to save its
10662 state across it.
10663 The default value is 10.
10665 @item sched-mem-true-dep-cost
10666 Minimal distance (in CPU cycles) between store and load targeting same
10667 memory locations.  The default value is 1.
10669 @item selsched-max-lookahead
10670 The maximum size of the lookahead window of selective scheduling.  It is a
10671 depth of search for available instructions.
10672 The default value is 50.
10674 @item selsched-max-sched-times
10675 The maximum number of times that an instruction is scheduled during
10676 selective scheduling.  This is the limit on the number of iterations
10677 through which the instruction may be pipelined.  The default value is 2.
10679 @item selsched-insns-to-rename
10680 The maximum number of best instructions in the ready list that are considered
10681 for renaming in the selective scheduler.  The default value is 2.
10683 @item sms-min-sc
10684 The minimum value of stage count that swing modulo scheduler
10685 generates.  The default value is 2.
10687 @item max-last-value-rtl
10688 The maximum size measured as number of RTLs that can be recorded in an expression
10689 in combiner for a pseudo register as last known value of that register.  The default
10690 is 10000.
10692 @item max-combine-insns
10693 The maximum number of instructions the RTL combiner tries to combine.
10694 The default value is 2 at @option{-Og} and 4 otherwise.
10696 @item integer-share-limit
10697 Small integer constants can use a shared data structure, reducing the
10698 compiler's memory usage and increasing its speed.  This sets the maximum
10699 value of a shared integer constant.  The default value is 256.
10701 @item ssp-buffer-size
10702 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10703 protection when @option{-fstack-protection} is used.
10705 @item min-size-for-stack-sharing
10706 The minimum size of variables taking part in stack slot sharing when not
10707 optimizing. The default value is 32.
10709 @item max-jump-thread-duplication-stmts
10710 Maximum number of statements allowed in a block that needs to be
10711 duplicated when threading jumps.
10713 @item max-fields-for-field-sensitive
10714 Maximum number of fields in a structure treated in
10715 a field sensitive manner during pointer analysis.  The default is zero
10716 for @option{-O0} and @option{-O1},
10717 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10719 @item prefetch-latency
10720 Estimate on average number of instructions that are executed before
10721 prefetch finishes.  The distance prefetched ahead is proportional
10722 to this constant.  Increasing this number may also lead to less
10723 streams being prefetched (see @option{simultaneous-prefetches}).
10725 @item simultaneous-prefetches
10726 Maximum number of prefetches that can run at the same time.
10728 @item l1-cache-line-size
10729 The size of cache line in L1 cache, in bytes.
10731 @item l1-cache-size
10732 The size of L1 cache, in kilobytes.
10734 @item l2-cache-size
10735 The size of L2 cache, in kilobytes.
10737 @item loop-interchange-max-num-stmts
10738 The maximum number of stmts in a loop to be interchanged.
10740 @item loop-interchange-stride-ratio
10741 The minimum ratio between stride of two loops for interchange to be profitable.
10743 @item min-insn-to-prefetch-ratio
10744 The minimum ratio between the number of instructions and the
10745 number of prefetches to enable prefetching in a loop.
10747 @item prefetch-min-insn-to-mem-ratio
10748 The minimum ratio between the number of instructions and the
10749 number of memory references to enable prefetching in a loop.
10751 @item use-canonical-types
10752 Whether the compiler should use the ``canonical'' type system.  By
10753 default, this should always be 1, which uses a more efficient internal
10754 mechanism for comparing types in C++ and Objective-C++.  However, if
10755 bugs in the canonical type system are causing compilation failures,
10756 set this value to 0 to disable canonical types.
10758 @item switch-conversion-max-branch-ratio
10759 Switch initialization conversion refuses to create arrays that are
10760 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10761 branches in the switch.
10763 @item max-partial-antic-length
10764 Maximum length of the partial antic set computed during the tree
10765 partial redundancy elimination optimization (@option{-ftree-pre}) when
10766 optimizing at @option{-O3} and above.  For some sorts of source code
10767 the enhanced partial redundancy elimination optimization can run away,
10768 consuming all of the memory available on the host machine.  This
10769 parameter sets a limit on the length of the sets that are computed,
10770 which prevents the runaway behavior.  Setting a value of 0 for
10771 this parameter allows an unlimited set length.
10773 @item sccvn-max-scc-size
10774 Maximum size of a strongly connected component (SCC) during SCCVN
10775 processing.  If this limit is hit, SCCVN processing for the whole
10776 function is not done and optimizations depending on it are
10777 disabled.  The default maximum SCC size is 10000.
10779 @item sccvn-max-alias-queries-per-access
10780 Maximum number of alias-oracle queries we perform when looking for
10781 redundancies for loads and stores.  If this limit is hit the search
10782 is aborted and the load or store is not considered redundant.  The
10783 number of queries is algorithmically limited to the number of
10784 stores on all paths from the load to the function entry.
10785 The default maximum number of queries is 1000.
10787 @item ira-max-loops-num
10788 IRA uses regional register allocation by default.  If a function
10789 contains more loops than the number given by this parameter, only at most
10790 the given number of the most frequently-executed loops form regions
10791 for regional register allocation.  The default value of the
10792 parameter is 100.
10794 @item ira-max-conflict-table-size 
10795 Although IRA uses a sophisticated algorithm to compress the conflict
10796 table, the table can still require excessive amounts of memory for
10797 huge functions.  If the conflict table for a function could be more
10798 than the size in MB given by this parameter, the register allocator
10799 instead uses a faster, simpler, and lower-quality
10800 algorithm that does not require building a pseudo-register conflict table.  
10801 The default value of the parameter is 2000.
10803 @item ira-loop-reserved-regs
10804 IRA can be used to evaluate more accurate register pressure in loops
10805 for decisions to move loop invariants (see @option{-O3}).  The number
10806 of available registers reserved for some other purposes is given
10807 by this parameter.  The default value of the parameter is 2, which is
10808 the minimal number of registers needed by typical instructions.
10809 This value is the best found from numerous experiments.
10811 @item lra-inheritance-ebb-probability-cutoff
10812 LRA tries to reuse values reloaded in registers in subsequent insns.
10813 This optimization is called inheritance.  EBB is used as a region to
10814 do this optimization.  The parameter defines a minimal fall-through
10815 edge probability in percentage used to add BB to inheritance EBB in
10816 LRA.  The default value of the parameter is 40.  The value was chosen
10817 from numerous runs of SPEC2000 on x86-64.
10819 @item loop-invariant-max-bbs-in-loop
10820 Loop invariant motion can be very expensive, both in compilation time and
10821 in amount of needed compile-time memory, with very large loops.  Loops
10822 with more basic blocks than this parameter won't have loop invariant
10823 motion optimization performed on them.  The default value of the
10824 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10826 @item loop-max-datarefs-for-datadeps
10827 Building data dependencies is expensive for very large loops.  This
10828 parameter limits the number of data references in loops that are
10829 considered for data dependence analysis.  These large loops are no
10830 handled by the optimizations using loop data dependencies.
10831 The default value is 1000.
10833 @item max-vartrack-size
10834 Sets a maximum number of hash table slots to use during variable
10835 tracking dataflow analysis of any function.  If this limit is exceeded
10836 with variable tracking at assignments enabled, analysis for that
10837 function is retried without it, after removing all debug insns from
10838 the function.  If the limit is exceeded even without debug insns, var
10839 tracking analysis is completely disabled for the function.  Setting
10840 the parameter to zero makes it unlimited.
10842 @item max-vartrack-expr-depth
10843 Sets a maximum number of recursion levels when attempting to map
10844 variable names or debug temporaries to value expressions.  This trades
10845 compilation time for more complete debug information.  If this is set too
10846 low, value expressions that are available and could be represented in
10847 debug information may end up not being used; setting this higher may
10848 enable the compiler to find more complex debug expressions, but compile
10849 time and memory use may grow.  The default is 12.
10851 @item max-debug-marker-count
10852 Sets a threshold on the number of debug markers (e.g. begin stmt
10853 markers) to avoid complexity explosion at inlining or expanding to RTL.
10854 If a function has more such gimple stmts than the set limit, such stmts
10855 will be dropped from the inlined copy of a function, and from its RTL
10856 expansion.  The default is 100000.
10858 @item min-nondebug-insn-uid
10859 Use uids starting at this parameter for nondebug insns.  The range below
10860 the parameter is reserved exclusively for debug insns created by
10861 @option{-fvar-tracking-assignments}, but debug insns may get
10862 (non-overlapping) uids above it if the reserved range is exhausted.
10864 @item ipa-sra-ptr-growth-factor
10865 IPA-SRA replaces a pointer to an aggregate with one or more new
10866 parameters only when their cumulative size is less or equal to
10867 @option{ipa-sra-ptr-growth-factor} times the size of the original
10868 pointer parameter.
10870 @item sra-max-scalarization-size-Ospeed
10871 @itemx sra-max-scalarization-size-Osize
10872 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10873 replace scalar parts of aggregates with uses of independent scalar
10874 variables.  These parameters control the maximum size, in storage units,
10875 of aggregate which is considered for replacement when compiling for
10876 speed
10877 (@option{sra-max-scalarization-size-Ospeed}) or size
10878 (@option{sra-max-scalarization-size-Osize}) respectively.
10880 @item tm-max-aggregate-size
10881 When making copies of thread-local variables in a transaction, this
10882 parameter specifies the size in bytes after which variables are
10883 saved with the logging functions as opposed to save/restore code
10884 sequence pairs.  This option only applies when using
10885 @option{-fgnu-tm}.
10887 @item graphite-max-nb-scop-params
10888 To avoid exponential effects in the Graphite loop transforms, the
10889 number of parameters in a Static Control Part (SCoP) is bounded.  The
10890 default value is 10 parameters, a value of zero can be used to lift
10891 the bound.  A variable whose value is unknown at compilation time and
10892 defined outside a SCoP is a parameter of the SCoP.
10894 @item loop-block-tile-size
10895 Loop blocking or strip mining transforms, enabled with
10896 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10897 loop in the loop nest by a given number of iterations.  The strip
10898 length can be changed using the @option{loop-block-tile-size}
10899 parameter.  The default value is 51 iterations.
10901 @item loop-unroll-jam-size
10902 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10903 default value is 4.
10905 @item loop-unroll-jam-depth
10906 Specify the dimension to be unrolled (counting from the most inner loop)
10907 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10909 @item ipa-cp-value-list-size
10910 IPA-CP attempts to track all possible values and types passed to a function's
10911 parameter in order to propagate them and perform devirtualization.
10912 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10913 stores per one formal parameter of a function.
10915 @item ipa-cp-eval-threshold
10916 IPA-CP calculates its own score of cloning profitability heuristics
10917 and performs those cloning opportunities with scores that exceed
10918 @option{ipa-cp-eval-threshold}.
10920 @item ipa-cp-recursion-penalty
10921 Percentage penalty the recursive functions will receive when they
10922 are evaluated for cloning.
10924 @item ipa-cp-single-call-penalty
10925 Percentage penalty functions containing a single call to another
10926 function will receive when they are evaluated for cloning.
10929 @item ipa-max-agg-items
10930 IPA-CP is also capable to propagate a number of scalar values passed
10931 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10932 number of such values per one parameter.
10934 @item ipa-cp-loop-hint-bonus
10935 When IPA-CP determines that a cloning candidate would make the number
10936 of iterations of a loop known, it adds a bonus of
10937 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10938 the candidate.
10940 @item ipa-cp-array-index-hint-bonus
10941 When IPA-CP determines that a cloning candidate would make the index of
10942 an array access known, it adds a bonus of
10943 @option{ipa-cp-array-index-hint-bonus} to the profitability
10944 score of the candidate.
10946 @item ipa-max-aa-steps
10947 During its analysis of function bodies, IPA-CP employs alias analysis
10948 in order to track values pointed to by function parameters.  In order
10949 not spend too much time analyzing huge functions, it gives up and
10950 consider all memory clobbered after examining
10951 @option{ipa-max-aa-steps} statements modifying memory.
10953 @item lto-partitions
10954 Specify desired number of partitions produced during WHOPR compilation.
10955 The number of partitions should exceed the number of CPUs used for compilation.
10956 The default value is 32.
10958 @item lto-min-partition
10959 Size of minimal partition for WHOPR (in estimated instructions).
10960 This prevents expenses of splitting very small programs into too many
10961 partitions.
10963 @item lto-max-partition
10964 Size of max partition for WHOPR (in estimated instructions).
10965 to provide an upper bound for individual size of partition.
10966 Meant to be used only with balanced partitioning.
10968 @item cxx-max-namespaces-for-diagnostic-help
10969 The maximum number of namespaces to consult for suggestions when C++
10970 name lookup fails for an identifier.  The default is 1000.
10972 @item sink-frequency-threshold
10973 The maximum relative execution frequency (in percents) of the target block
10974 relative to a statement's original block to allow statement sinking of a
10975 statement.  Larger numbers result in more aggressive statement sinking.
10976 The default value is 75.  A small positive adjustment is applied for
10977 statements with memory operands as those are even more profitable so sink.
10979 @item max-stores-to-sink
10980 The maximum number of conditional store pairs that can be sunk.  Set to 0
10981 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10982 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10984 @item allow-store-data-races
10985 Allow optimizers to introduce new data races on stores.
10986 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10987 at optimization level @option{-Ofast}.
10989 @item case-values-threshold
10990 The smallest number of different values for which it is best to use a
10991 jump-table instead of a tree of conditional branches.  If the value is
10992 0, use the default for the machine.  The default is 0.
10994 @item tree-reassoc-width
10995 Set the maximum number of instructions executed in parallel in
10996 reassociated tree. This parameter overrides target dependent
10997 heuristics used by default if has non zero value.
10999 @item sched-pressure-algorithm
11000 Choose between the two available implementations of
11001 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
11002 and is the more likely to prevent instructions from being reordered.
11003 Algorithm 2 was designed to be a compromise between the relatively
11004 conservative approach taken by algorithm 1 and the rather aggressive
11005 approach taken by the default scheduler.  It relies more heavily on
11006 having a regular register file and accurate register pressure classes.
11007 See @file{haifa-sched.c} in the GCC sources for more details.
11009 The default choice depends on the target.
11011 @item max-slsr-cand-scan
11012 Set the maximum number of existing candidates that are considered when
11013 seeking a basis for a new straight-line strength reduction candidate.
11015 @item asan-globals
11016 Enable buffer overflow detection for global objects.  This kind
11017 of protection is enabled by default if you are using
11018 @option{-fsanitize=address} option.
11019 To disable global objects protection use @option{--param asan-globals=0}.
11021 @item asan-stack
11022 Enable buffer overflow detection for stack objects.  This kind of
11023 protection is enabled by default when using @option{-fsanitize=address}.
11024 To disable stack protection use @option{--param asan-stack=0} option.
11026 @item asan-instrument-reads
11027 Enable buffer overflow detection for memory reads.  This kind of
11028 protection is enabled by default when using @option{-fsanitize=address}.
11029 To disable memory reads protection use
11030 @option{--param asan-instrument-reads=0}.
11032 @item asan-instrument-writes
11033 Enable buffer overflow detection for memory writes.  This kind of
11034 protection is enabled by default when using @option{-fsanitize=address}.
11035 To disable memory writes protection use
11036 @option{--param asan-instrument-writes=0} option.
11038 @item asan-memintrin
11039 Enable detection for built-in functions.  This kind of protection
11040 is enabled by default when using @option{-fsanitize=address}.
11041 To disable built-in functions protection use
11042 @option{--param asan-memintrin=0}.
11044 @item asan-use-after-return
11045 Enable detection of use-after-return.  This kind of protection
11046 is enabled by default when using the @option{-fsanitize=address} option.
11047 To disable it use @option{--param asan-use-after-return=0}.
11049 Note: By default the check is disabled at run time.  To enable it,
11050 add @code{detect_stack_use_after_return=1} to the environment variable
11051 @env{ASAN_OPTIONS}.
11053 @item asan-instrumentation-with-call-threshold
11054 If number of memory accesses in function being instrumented
11055 is greater or equal to this number, use callbacks instead of inline checks.
11056 E.g. to disable inline code use
11057 @option{--param asan-instrumentation-with-call-threshold=0}.
11059 @item use-after-scope-direct-emission-threshold
11060 If the size of a local variable in bytes is smaller or equal to this
11061 number, directly poison (or unpoison) shadow memory instead of using
11062 run-time callbacks.  The default value is 256.
11064 @item chkp-max-ctor-size
11065 Static constructors generated by Pointer Bounds Checker may become very
11066 large and significantly increase compile time at optimization level
11067 @option{-O1} and higher.  This parameter is a maximum number of statements
11068 in a single generated constructor.  Default value is 5000.
11070 @item max-fsm-thread-path-insns
11071 Maximum number of instructions to copy when duplicating blocks on a
11072 finite state automaton jump thread path.  The default is 100.
11074 @item max-fsm-thread-length
11075 Maximum number of basic blocks on a finite state automaton jump thread
11076 path.  The default is 10.
11078 @item max-fsm-thread-paths
11079 Maximum number of new jump thread paths to create for a finite state
11080 automaton.  The default is 50.
11082 @item parloops-chunk-size
11083 Chunk size of omp schedule for loops parallelized by parloops.  The default
11084 is 0.
11086 @item parloops-schedule
11087 Schedule type of omp schedule for loops parallelized by parloops (static,
11088 dynamic, guided, auto, runtime).  The default is static.
11090 @item parloops-min-per-thread
11091 The minimum number of iterations per thread of an innermost parallelized
11092 loop for which the parallelized variant is prefered over the single threaded
11093 one.  The default is 100.  Note that for a parallelized loop nest the
11094 minimum number of iterations of the outermost loop per thread is two.
11096 @item max-ssa-name-query-depth
11097 Maximum depth of recursion when querying properties of SSA names in things
11098 like fold routines.  One level of recursion corresponds to following a
11099 use-def chain.
11101 @item hsa-gen-debug-stores
11102 Enable emission of special debug stores within HSA kernels which are
11103 then read and reported by libgomp plugin.  Generation of these stores
11104 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
11105 enable it.
11107 @item max-speculative-devirt-maydefs
11108 The maximum number of may-defs we analyze when looking for a must-def
11109 specifying the dynamic type of an object that invokes a virtual call
11110 we may be able to devirtualize speculatively.
11112 @item max-vrp-switch-assertions
11113 The maximum number of assertions to add along the default edge of a switch
11114 statement during VRP.  The default is 10.
11116 @item unroll-jam-min-percent
11117 The minimum percentage of memory references that must be optimized
11118 away for the unroll-and-jam transformation to be considered profitable.
11120 @item unroll-jam-max-unroll
11121 The maximum number of times the outer loop should be unrolled by
11122 the unroll-and-jam transformation.
11123 @end table
11124 @end table
11126 @node Instrumentation Options
11127 @section Program Instrumentation Options
11128 @cindex instrumentation options
11129 @cindex program instrumentation options
11130 @cindex run-time error checking options
11131 @cindex profiling options
11132 @cindex options, program instrumentation
11133 @cindex options, run-time error checking
11134 @cindex options, profiling
11136 GCC supports a number of command-line options that control adding
11137 run-time instrumentation to the code it normally generates.  
11138 For example, one purpose of instrumentation is collect profiling
11139 statistics for use in finding program hot spots, code coverage
11140 analysis, or profile-guided optimizations.
11141 Another class of program instrumentation is adding run-time checking 
11142 to detect programming errors like invalid pointer
11143 dereferences or out-of-bounds array accesses, as well as deliberately
11144 hostile attacks such as stack smashing or C++ vtable hijacking.
11145 There is also a general hook which can be used to implement other
11146 forms of tracing or function-level instrumentation for debug or
11147 program analysis purposes.
11149 @table @gcctabopt
11150 @cindex @command{prof}
11151 @item -p
11152 @opindex p
11153 Generate extra code to write profile information suitable for the
11154 analysis program @command{prof}.  You must use this option when compiling
11155 the source files you want data about, and you must also use it when
11156 linking.
11158 @cindex @command{gprof}
11159 @item -pg
11160 @opindex pg
11161 Generate extra code to write profile information suitable for the
11162 analysis program @command{gprof}.  You must use this option when compiling
11163 the source files you want data about, and you must also use it when
11164 linking.
11166 @item -fprofile-arcs
11167 @opindex fprofile-arcs
11168 Add code so that program flow @dfn{arcs} are instrumented.  During
11169 execution the program records how many times each branch and call is
11170 executed and how many times it is taken or returns.  On targets that support
11171 constructors with priority support, profiling properly handles constructors,
11172 destructors and C++ constructors (and destructors) of classes which are used
11173 as a type of a global variable.
11175 When the compiled
11176 program exits it saves this data to a file called
11177 @file{@var{auxname}.gcda} for each source file.  The data may be used for
11178 profile-directed optimizations (@option{-fbranch-probabilities}), or for
11179 test coverage analysis (@option{-ftest-coverage}).  Each object file's
11180 @var{auxname} is generated from the name of the output file, if
11181 explicitly specified and it is not the final executable, otherwise it is
11182 the basename of the source file.  In both cases any suffix is removed
11183 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
11184 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
11185 @xref{Cross-profiling}.
11187 @cindex @command{gcov}
11188 @item --coverage
11189 @opindex coverage
11191 This option is used to compile and link code instrumented for coverage
11192 analysis.  The option is a synonym for @option{-fprofile-arcs}
11193 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11194 linking).  See the documentation for those options for more details.
11196 @itemize
11198 @item
11199 Compile the source files with @option{-fprofile-arcs} plus optimization
11200 and code generation options.  For test coverage analysis, use the
11201 additional @option{-ftest-coverage} option.  You do not need to profile
11202 every source file in a program.
11204 @item
11205 Compile the source files additionally with @option{-fprofile-abs-path}
11206 to create absolute path names in the @file{.gcno} files.  This allows
11207 @command{gcov} to find the correct sources in projects where compilations
11208 occur with different working directories.
11210 @item
11211 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11212 (the latter implies the former).
11214 @item
11215 Run the program on a representative workload to generate the arc profile
11216 information.  This may be repeated any number of times.  You can run
11217 concurrent instances of your program, and provided that the file system
11218 supports locking, the data files will be correctly updated.  Unless
11219 a strict ISO C dialect option is in effect, @code{fork} calls are
11220 detected and correctly handled without double counting.
11222 @item
11223 For profile-directed optimizations, compile the source files again with
11224 the same optimization and code generation options plus
11225 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11226 Control Optimization}).
11228 @item
11229 For test coverage analysis, use @command{gcov} to produce human readable
11230 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11231 @command{gcov} documentation for further information.
11233 @end itemize
11235 With @option{-fprofile-arcs}, for each function of your program GCC
11236 creates a program flow graph, then finds a spanning tree for the graph.
11237 Only arcs that are not on the spanning tree have to be instrumented: the
11238 compiler adds code to count the number of times that these arcs are
11239 executed.  When an arc is the only exit or only entrance to a block, the
11240 instrumentation code can be added to the block; otherwise, a new basic
11241 block must be created to hold the instrumentation code.
11243 @need 2000
11244 @item -ftest-coverage
11245 @opindex ftest-coverage
11246 Produce a notes file that the @command{gcov} code-coverage utility
11247 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11248 show program coverage.  Each source file's note file is called
11249 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11250 above for a description of @var{auxname} and instructions on how to
11251 generate test coverage data.  Coverage data matches the source files
11252 more closely if you do not optimize.
11254 @item -fprofile-abs-path
11255 @opindex fprofile-abs-path
11256 Automatically convert relative source file names to absolute path names
11257 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11258 sources in projects where compilations occur with different working
11259 directories.
11261 @item -fprofile-dir=@var{path}
11262 @opindex fprofile-dir
11264 Set the directory to search for the profile data files in to @var{path}.
11265 This option affects only the profile data generated by
11266 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11267 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11268 and its related options.  Both absolute and relative paths can be used.
11269 By default, GCC uses the current directory as @var{path}, thus the
11270 profile data file appears in the same directory as the object file.
11272 @item -fprofile-generate
11273 @itemx -fprofile-generate=@var{path}
11274 @opindex fprofile-generate
11276 Enable options usually used for instrumenting application to produce
11277 profile useful for later recompilation with profile feedback based
11278 optimization.  You must use @option{-fprofile-generate} both when
11279 compiling and when linking your program.
11281 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11283 If @var{path} is specified, GCC looks at the @var{path} to find
11284 the profile feedback data files. See @option{-fprofile-dir}.
11286 To optimize the program based on the collected profile information, use
11287 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11289 @item -fprofile-update=@var{method}
11290 @opindex fprofile-update
11292 Alter the update method for an application instrumented for profile
11293 feedback based optimization.  The @var{method} argument should be one of
11294 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11295 The first one is useful for single-threaded applications,
11296 while the second one prevents profile corruption by emitting thread-safe code.
11298 @strong{Warning:} When an application does not properly join all threads
11299 (or creates an detached thread), a profile file can be still corrupted.
11301 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11302 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11303 automatically selects @samp{prefer-atomic} when @option{-pthread}
11304 is present in the command line.
11306 @item -fsanitize=address
11307 @opindex fsanitize=address
11308 Enable AddressSanitizer, a fast memory error detector.
11309 Memory access instructions are instrumented to detect
11310 out-of-bounds and use-after-free bugs.
11311 The option enables @option{-fsanitize-address-use-after-scope}.
11312 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11313 more details.  The run-time behavior can be influenced using the
11314 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11315 the available options are shown at startup of the instrumented program.  See
11316 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11317 for a list of supported options.
11318 The option cannot be combined with @option{-fsanitize=thread}
11319 and/or @option{-fcheck-pointer-bounds}.
11321 @item -fsanitize=kernel-address
11322 @opindex fsanitize=kernel-address
11323 Enable AddressSanitizer for Linux kernel.
11324 See @uref{https://github.com/google/kasan/wiki} for more details.
11325 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11327 @item -fsanitize=pointer-compare
11328 @opindex fsanitize=pointer-compare
11329 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11330 The option must be combined with either @option{-fsanitize=kernel-address} or
11331 @option{-fsanitize=address}
11332 The option cannot be combined with @option{-fsanitize=thread}
11333 and/or @option{-fcheck-pointer-bounds}.
11334 Note: By default the check is disabled at run time.  To enable it,
11335 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11336 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11337 invalid operation only when both pointers are non-null.
11339 @item -fsanitize=pointer-subtract
11340 @opindex fsanitize=pointer-subtract
11341 Instrument subtraction with pointer operands.
11342 The option must be combined with either @option{-fsanitize=kernel-address} or
11343 @option{-fsanitize=address}
11344 The option cannot be combined with @option{-fsanitize=thread}
11345 and/or @option{-fcheck-pointer-bounds}.
11346 Note: By default the check is disabled at run time.  To enable it,
11347 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11348 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11349 invalid operation only when both pointers are non-null.
11351 @item -fsanitize=thread
11352 @opindex fsanitize=thread
11353 Enable ThreadSanitizer, a fast data race detector.
11354 Memory access instructions are instrumented to detect
11355 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11356 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11357 environment variable; see
11358 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11359 supported options.
11360 The option cannot be combined with @option{-fsanitize=address},
11361 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11363 Note that sanitized atomic builtins cannot throw exceptions when
11364 operating on invalid memory addresses with non-call exceptions
11365 (@option{-fnon-call-exceptions}).
11367 @item -fsanitize=leak
11368 @opindex fsanitize=leak
11369 Enable LeakSanitizer, a memory leak detector.
11370 This option only matters for linking of executables and
11371 the executable is linked against a library that overrides @code{malloc}
11372 and other allocator functions.  See
11373 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11374 details.  The run-time behavior can be influenced using the
11375 @env{LSAN_OPTIONS} environment variable.
11376 The option cannot be combined with @option{-fsanitize=thread}.
11378 @item -fsanitize=undefined
11379 @opindex fsanitize=undefined
11380 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11381 Various computations are instrumented to detect undefined behavior
11382 at runtime.  Current suboptions are:
11384 @table @gcctabopt
11386 @item -fsanitize=shift
11387 @opindex fsanitize=shift
11388 This option enables checking that the result of a shift operation is
11389 not undefined.  Note that what exactly is considered undefined differs
11390 slightly between C and C++, as well as between ISO C90 and C99, etc.
11391 This option has two suboptions, @option{-fsanitize=shift-base} and
11392 @option{-fsanitize=shift-exponent}.
11394 @item -fsanitize=shift-exponent
11395 @opindex fsanitize=shift-exponent
11396 This option enables checking that the second argument of a shift operation
11397 is not negative and is smaller than the precision of the promoted first
11398 argument.
11400 @item -fsanitize=shift-base
11401 @opindex fsanitize=shift-base
11402 If the second argument of a shift operation is within range, check that the
11403 result of a shift operation is not undefined.  Note that what exactly is
11404 considered undefined differs slightly between C and C++, as well as between
11405 ISO C90 and C99, etc.
11407 @item -fsanitize=integer-divide-by-zero
11408 @opindex fsanitize=integer-divide-by-zero
11409 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11411 @item -fsanitize=unreachable
11412 @opindex fsanitize=unreachable
11413 With this option, the compiler turns the @code{__builtin_unreachable}
11414 call into a diagnostics message call instead.  When reaching the
11415 @code{__builtin_unreachable} call, the behavior is undefined.
11417 @item -fsanitize=vla-bound
11418 @opindex fsanitize=vla-bound
11419 This option instructs the compiler to check that the size of a variable
11420 length array is positive.
11422 @item -fsanitize=null
11423 @opindex fsanitize=null
11424 This option enables pointer checking.  Particularly, the application
11425 built with this option turned on will issue an error message when it
11426 tries to dereference a NULL pointer, or if a reference (possibly an
11427 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11428 on an object pointed by a NULL pointer.
11430 @item -fsanitize=return
11431 @opindex fsanitize=return
11432 This option enables return statement checking.  Programs
11433 built with this option turned on will issue an error message
11434 when the end of a non-void function is reached without actually
11435 returning a value.  This option works in C++ only.
11437 @item -fsanitize=signed-integer-overflow
11438 @opindex fsanitize=signed-integer-overflow
11439 This option enables signed integer overflow checking.  We check that
11440 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11441 does not overflow in the signed arithmetics.  Note, integer promotion
11442 rules must be taken into account.  That is, the following is not an
11443 overflow:
11444 @smallexample
11445 signed char a = SCHAR_MAX;
11446 a++;
11447 @end smallexample
11449 @item -fsanitize=bounds
11450 @opindex fsanitize=bounds
11451 This option enables instrumentation of array bounds.  Various out of bounds
11452 accesses are detected.  Flexible array members, flexible array member-like
11453 arrays, and initializers of variables with static storage are not instrumented.
11454 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11456 @item -fsanitize=bounds-strict
11457 @opindex fsanitize=bounds-strict
11458 This option enables strict instrumentation of array bounds.  Most out of bounds
11459 accesses are detected, including flexible array members and flexible array
11460 member-like arrays.  Initializers of variables with static storage are not
11461 instrumented.  The option cannot be combined
11462 with @option{-fcheck-pointer-bounds}.
11464 @item -fsanitize=alignment
11465 @opindex fsanitize=alignment
11467 This option enables checking of alignment of pointers when they are
11468 dereferenced, or when a reference is bound to insufficiently aligned target,
11469 or when a method or constructor is invoked on insufficiently aligned object.
11471 @item -fsanitize=object-size
11472 @opindex fsanitize=object-size
11473 This option enables instrumentation of memory references using the
11474 @code{__builtin_object_size} function.  Various out of bounds pointer
11475 accesses are detected.
11477 @item -fsanitize=float-divide-by-zero
11478 @opindex fsanitize=float-divide-by-zero
11479 Detect floating-point division by zero.  Unlike other similar options,
11480 @option{-fsanitize=float-divide-by-zero} is not enabled by
11481 @option{-fsanitize=undefined}, since floating-point division by zero can
11482 be a legitimate way of obtaining infinities and NaNs.
11484 @item -fsanitize=float-cast-overflow
11485 @opindex fsanitize=float-cast-overflow
11486 This option enables floating-point type to integer conversion checking.
11487 We check that the result of the conversion does not overflow.
11488 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11489 not enabled by @option{-fsanitize=undefined}.
11490 This option does not work well with @code{FE_INVALID} exceptions enabled.
11492 @item -fsanitize=nonnull-attribute
11493 @opindex fsanitize=nonnull-attribute
11495 This option enables instrumentation of calls, checking whether null values
11496 are not passed to arguments marked as requiring a non-null value by the
11497 @code{nonnull} function attribute.
11499 @item -fsanitize=returns-nonnull-attribute
11500 @opindex fsanitize=returns-nonnull-attribute
11502 This option enables instrumentation of return statements in functions
11503 marked with @code{returns_nonnull} function attribute, to detect returning
11504 of null values from such functions.
11506 @item -fsanitize=bool
11507 @opindex fsanitize=bool
11509 This option enables instrumentation of loads from bool.  If a value other
11510 than 0/1 is loaded, a run-time error is issued.
11512 @item -fsanitize=enum
11513 @opindex fsanitize=enum
11515 This option enables instrumentation of loads from an enum type.  If
11516 a value outside the range of values for the enum type is loaded,
11517 a run-time error is issued.
11519 @item -fsanitize=vptr
11520 @opindex fsanitize=vptr
11522 This option enables instrumentation of C++ member function calls, member
11523 accesses and some conversions between pointers to base and derived classes,
11524 to verify the referenced object has the correct dynamic type.
11526 @item -fsanitize=pointer-overflow
11527 @opindex fsanitize=pointer-overflow
11529 This option enables instrumentation of pointer arithmetics.  If the pointer
11530 arithmetics overflows, a run-time error is issued.
11532 @item -fsanitize=builtin
11533 @opindex fsanitize=builtin
11535 This option enables instrumentation of arguments to selected builtin
11536 functions.  If an invalid value is passed to such arguments, a run-time
11537 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11538 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11539 by this option.
11541 @end table
11543 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11544 @option{-fsanitize=undefined} gives a diagnostic message.
11545 This currently works only for the C family of languages.
11547 @item -fno-sanitize=all
11548 @opindex fno-sanitize=all
11550 This option disables all previously enabled sanitizers.
11551 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11552 together.
11554 @item -fasan-shadow-offset=@var{number}
11555 @opindex fasan-shadow-offset
11556 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11557 It is useful for experimenting with different shadow memory layouts in
11558 Kernel AddressSanitizer.
11560 @item -fsanitize-sections=@var{s1},@var{s2},...
11561 @opindex fsanitize-sections
11562 Sanitize global variables in selected user-defined sections.  @var{si} may
11563 contain wildcards.
11565 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11566 @opindex fsanitize-recover
11567 @opindex fno-sanitize-recover
11568 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11569 mentioned in comma-separated list of @var{opts}.  Enabling this option
11570 for a sanitizer component causes it to attempt to continue
11571 running the program as if no error happened.  This means multiple
11572 runtime errors can be reported in a single program run, and the exit
11573 code of the program may indicate success even when errors
11574 have been reported.  The @option{-fno-sanitize-recover=} option
11575 can be used to alter
11576 this behavior: only the first detected error is reported
11577 and program then exits with a non-zero exit code.
11579 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11580 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11581 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11582 @option{-fsanitize=bounds-strict},
11583 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11584 For these sanitizers error recovery is turned on by default,
11585 except @option{-fsanitize=address}, for which this feature is experimental.
11586 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11587 accepted, the former enables recovery for all sanitizers that support it,
11588 the latter disables recovery for all sanitizers that support it.
11590 Even if a recovery mode is turned on the compiler side, it needs to be also
11591 enabled on the runtime library side, otherwise the failures are still fatal.
11592 The runtime library defaults to @code{halt_on_error=0} for
11593 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11594 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11595 setting the @code{halt_on_error} flag in the corresponding environment variable.
11597 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11598 equivalent to specifying an @var{opts} list of:
11600 @smallexample
11601 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11602 @end smallexample
11604 @item -fsanitize-address-use-after-scope
11605 @opindex fsanitize-address-use-after-scope
11606 Enable sanitization of local variables to detect use-after-scope bugs.
11607 The option sets @option{-fstack-reuse} to @samp{none}.
11609 @item -fsanitize-undefined-trap-on-error
11610 @opindex fsanitize-undefined-trap-on-error
11611 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11612 report undefined behavior using @code{__builtin_trap} rather than
11613 a @code{libubsan} library routine.  The advantage of this is that the
11614 @code{libubsan} library is not needed and is not linked in, so this
11615 is usable even in freestanding environments.
11617 @item -fsanitize-coverage=trace-pc
11618 @opindex fsanitize-coverage=trace-pc
11619 Enable coverage-guided fuzzing code instrumentation.
11620 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11622 @item -fsanitize-coverage=trace-cmp
11623 @opindex fsanitize-coverage=trace-cmp
11624 Enable dataflow guided fuzzing code instrumentation.
11625 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11626 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11627 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11628 variable or @code{__sanitizer_cov_trace_const_cmp1},
11629 @code{__sanitizer_cov_trace_const_cmp2},
11630 @code{__sanitizer_cov_trace_const_cmp4} or
11631 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11632 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11633 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11634 @code{__sanitizer_cov_trace_switch} for switch statements.
11636 @item -fbounds-check
11637 @opindex fbounds-check
11638 For front ends that support it, generate additional code to check that
11639 indices used to access arrays are within the declared range.  This is
11640 currently only supported by the Fortran front end, where this option
11641 defaults to false.
11643 @item -fcheck-pointer-bounds
11644 @opindex fcheck-pointer-bounds
11645 @opindex fno-check-pointer-bounds
11646 @cindex Pointer Bounds Checker options
11647 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11648 is instrumented with checks of the pointer used for memory access against
11649 bounds associated with that pointer.  
11651 Currently there
11652 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11653 and @option{-mmpx} are required to enable this feature.  
11654 MPX-based instrumentation requires
11655 a runtime library to enable MPX in hardware and handle bounds
11656 violation signals.  By default when @option{-fcheck-pointer-bounds}
11657 and @option{-mmpx} options are used to link a program, the GCC driver
11658 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11659 Bounds checking on calls to dynamic libraries requires a linker
11660 with @option{-z bndplt} support; if GCC was configured with a linker
11661 without support for this option (including the Gold linker and older
11662 versions of ld), a warning is given if you link with @option{-mmpx}
11663 without also specifying @option{-static}, since the overall effectiveness
11664 of the bounds checking protection is reduced.
11665 See also @option{-static-libmpxwrappers}.
11667 MPX-based instrumentation
11668 may be used for debugging and also may be included in production code
11669 to increase program security.  Depending on usage, you may
11670 have different requirements for the runtime library.  The current version
11671 of the MPX runtime library is more oriented for use as a debugging
11672 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11673 also @option{-static-libmpx}.  The runtime library  behavior can be
11674 influenced using various @env{CHKP_RT_*} environment variables.  See
11675 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11676 for more details.
11678 Generated instrumentation may be controlled by various
11679 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11680 structure field attribute (@pxref{Type Attributes}) and
11681 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11682 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11683 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11684 Bounds Checker builtins}, for more information.
11686 @item -fchkp-check-incomplete-type
11687 @opindex fchkp-check-incomplete-type
11688 @opindex fno-chkp-check-incomplete-type
11689 Generate pointer bounds checks for variables with incomplete type.
11690 Enabled by default.
11692 @item -fchkp-narrow-bounds
11693 @opindex fchkp-narrow-bounds
11694 @opindex fno-chkp-narrow-bounds
11695 Controls bounds used by Pointer Bounds Checker for pointers to object
11696 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11697 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11698 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11700 @item -fchkp-first-field-has-own-bounds
11701 @opindex fchkp-first-field-has-own-bounds
11702 @opindex fno-chkp-first-field-has-own-bounds
11703 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11704 first field in the structure.  By default a pointer to the first field has
11705 the same bounds as a pointer to the whole structure.
11707 @item -fchkp-flexible-struct-trailing-arrays
11708 @opindex fchkp-flexible-struct-trailing-arrays
11709 @opindex fno-chkp-flexible-struct-trailing-arrays
11710 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11711 possibly flexible.  By default only array fields with zero length or that are
11712 marked with attribute bnd_variable_size are treated as flexible.
11714 @item -fchkp-narrow-to-innermost-array
11715 @opindex fchkp-narrow-to-innermost-array
11716 @opindex fno-chkp-narrow-to-innermost-array
11717 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11718 case of nested static array access.  By default this option is disabled and
11719 bounds of the outermost array are used.
11721 @item -fchkp-optimize
11722 @opindex fchkp-optimize
11723 @opindex fno-chkp-optimize
11724 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11725 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11727 @item -fchkp-use-fast-string-functions
11728 @opindex fchkp-use-fast-string-functions
11729 @opindex fno-chkp-use-fast-string-functions
11730 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11731 by Pointer Bounds Checker.  Disabled by default.
11733 @item -fchkp-use-nochk-string-functions
11734 @opindex fchkp-use-nochk-string-functions
11735 @opindex fno-chkp-use-nochk-string-functions
11736 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11737 by Pointer Bounds Checker.  Disabled by default.
11739 @item -fchkp-use-static-bounds
11740 @opindex fchkp-use-static-bounds
11741 @opindex fno-chkp-use-static-bounds
11742 Allow Pointer Bounds Checker to generate static bounds holding
11743 bounds of static variables.  Enabled by default.
11745 @item -fchkp-use-static-const-bounds
11746 @opindex fchkp-use-static-const-bounds
11747 @opindex fno-chkp-use-static-const-bounds
11748 Use statically-initialized bounds for constant bounds instead of
11749 generating them each time they are required.  By default enabled when
11750 @option{-fchkp-use-static-bounds} is enabled.
11752 @item -fchkp-treat-zero-dynamic-size-as-infinite
11753 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11754 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11755 With this option, objects with incomplete type whose
11756 dynamically-obtained size is zero are treated as having infinite size
11757 instead by Pointer Bounds
11758 Checker.  This option may be helpful if a program is linked with a library
11759 missing size information for some symbols.  Disabled by default.
11761 @item -fchkp-check-read
11762 @opindex fchkp-check-read
11763 @opindex fno-chkp-check-read
11764 Instructs Pointer Bounds Checker to generate checks for all read
11765 accesses to memory.  Enabled by default.
11767 @item -fchkp-check-write
11768 @opindex fchkp-check-write
11769 @opindex fno-chkp-check-write
11770 Instructs Pointer Bounds Checker to generate checks for all write
11771 accesses to memory.  Enabled by default.
11773 @item -fchkp-store-bounds
11774 @opindex fchkp-store-bounds
11775 @opindex fno-chkp-store-bounds
11776 Instructs Pointer Bounds Checker to generate bounds stores for
11777 pointer writes.  Enabled by default.
11779 @item -fchkp-instrument-calls
11780 @opindex fchkp-instrument-calls
11781 @opindex fno-chkp-instrument-calls
11782 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11783 Enabled by default.
11785 @item -fchkp-instrument-marked-only
11786 @opindex fchkp-instrument-marked-only
11787 @opindex fno-chkp-instrument-marked-only
11788 Instructs Pointer Bounds Checker to instrument only functions
11789 marked with the @code{bnd_instrument} attribute
11790 (@pxref{Function Attributes}).  Disabled by default.
11792 @item -fchkp-use-wrappers
11793 @opindex fchkp-use-wrappers
11794 @opindex fno-chkp-use-wrappers
11795 Allows Pointer Bounds Checker to replace calls to built-in functions
11796 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11797 is used to link a program, the GCC driver automatically links
11798 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11799 Enabled by default.
11801 @item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11802 @opindex fcf-protection
11803 Enable code instrumentation of control-flow transfers to increase
11804 program security by checking that target addresses of control-flow
11805 transfer instructions (such as indirect function call, function return,
11806 indirect jump) are valid.  This prevents diverting the flow of control
11807 to an unexpected target.  This is intended to protect against such
11808 threats as Return-oriented Programming (ROP), and similarly
11809 call/jmp-oriented programming (COP/JOP).
11811 The value @code{branch} tells the compiler to implement checking of
11812 validity of control-flow transfer at the point of indirect branch
11813 instructions, i.e. call/jmp instructions.  The value @code{return}
11814 implements checking of validity at the point of returning from a
11815 function.  The value @code{full} is an alias for specifying both
11816 @code{branch} and @code{return}. The value @code{none} turns off
11817 instrumentation.
11819 The macro @code{__CET__} is defined when @option{-fcf-protection} is
11820 used.  The first bit of @code{__CET__} is set to 1 for the value
11821 @code{branch} and the second bit of @code{__CET__} is set to 1 for
11822 the @code{return}.
11824 You can also use the @code{nocf_check} attribute to identify
11825 which functions and calls should be skipped from instrumentation
11826 (@pxref{Function Attributes}).
11828 Currently the x86 GNU/Linux target provides an implementation based
11829 on Intel Control-flow Enforcement Technology (CET).
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 the
13084 generated position-independent code can be only linked into executables.
13085 Usually these options are used to compile code that will be linked using
13086 the @option{-pie} GCC option.
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 Many developer options that cause GCC to dump output to a file take an
13348 optional @samp{=@var{filename}} suffix. You can specify @samp{stdout}
13349 or @samp{-} to dump to standard output, and @samp{stderr} for standard
13350 error.
13352 If @samp{=@var{filename}} is omitted, a default dump file name is
13353 constructed by concatenating the base dump file name, a pass number,
13354 phase letter, and pass name.  The base dump file name is the name of
13355 output file produced by the compiler if explicitly specified and not
13356 an executable; otherwise it is the source file name.
13357 The pass number is determined by the order passes are registered with
13358 the compiler's pass manager. 
13359 This is generally the same as the order of execution, but passes
13360 registered by plugins, target-specific passes, or passes that are
13361 otherwise registered late are numbered higher than the pass named
13362 @samp{final}, even if they are executed earlier.  The phase letter is
13363 one of @samp{i} (inter-procedural analysis), @samp{l}
13364 (language-specific), @samp{r} (RTL), or @samp{t} (tree). 
13365 The files are created in the directory of the output file. 
13367 @table @gcctabopt
13369 @item -d@var{letters}
13370 @itemx -fdump-rtl-@var{pass}
13371 @itemx -fdump-rtl-@var{pass}=@var{filename}
13372 @opindex d
13373 @opindex fdump-rtl-@var{pass}
13374 Says to make debugging dumps during compilation at times specified by
13375 @var{letters}.  This is used for debugging the RTL-based passes of the
13376 compiler.
13378 Some @option{-d@var{letters}} switches have different meaning when
13379 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13380 for information about preprocessor-specific dump options.
13382 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13383 @option{-d} option @var{letters}.  Here are the possible
13384 letters for use in @var{pass} and @var{letters}, and their meanings:
13386 @table @gcctabopt
13388 @item -fdump-rtl-alignments
13389 @opindex fdump-rtl-alignments
13390 Dump after branch alignments have been computed.
13392 @item -fdump-rtl-asmcons
13393 @opindex fdump-rtl-asmcons
13394 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13396 @item -fdump-rtl-auto_inc_dec
13397 @opindex fdump-rtl-auto_inc_dec
13398 Dump after auto-inc-dec discovery.  This pass is only run on
13399 architectures that have auto inc or auto dec instructions.
13401 @item -fdump-rtl-barriers
13402 @opindex fdump-rtl-barriers
13403 Dump after cleaning up the barrier instructions.
13405 @item -fdump-rtl-bbpart
13406 @opindex fdump-rtl-bbpart
13407 Dump after partitioning hot and cold basic blocks.
13409 @item -fdump-rtl-bbro
13410 @opindex fdump-rtl-bbro
13411 Dump after block reordering.
13413 @item -fdump-rtl-btl1
13414 @itemx -fdump-rtl-btl2
13415 @opindex fdump-rtl-btl2
13416 @opindex fdump-rtl-btl2
13417 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13418 after the two branch
13419 target load optimization passes.
13421 @item -fdump-rtl-bypass
13422 @opindex fdump-rtl-bypass
13423 Dump after jump bypassing and control flow optimizations.
13425 @item -fdump-rtl-combine
13426 @opindex fdump-rtl-combine
13427 Dump after the RTL instruction combination pass.
13429 @item -fdump-rtl-compgotos
13430 @opindex fdump-rtl-compgotos
13431 Dump after duplicating the computed gotos.
13433 @item -fdump-rtl-ce1
13434 @itemx -fdump-rtl-ce2
13435 @itemx -fdump-rtl-ce3
13436 @opindex fdump-rtl-ce1
13437 @opindex fdump-rtl-ce2
13438 @opindex fdump-rtl-ce3
13439 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13440 @option{-fdump-rtl-ce3} enable dumping after the three
13441 if conversion passes.
13443 @item -fdump-rtl-cprop_hardreg
13444 @opindex fdump-rtl-cprop_hardreg
13445 Dump after hard register copy propagation.
13447 @item -fdump-rtl-csa
13448 @opindex fdump-rtl-csa
13449 Dump after combining stack adjustments.
13451 @item -fdump-rtl-cse1
13452 @itemx -fdump-rtl-cse2
13453 @opindex fdump-rtl-cse1
13454 @opindex fdump-rtl-cse2
13455 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13456 the two common subexpression elimination passes.
13458 @item -fdump-rtl-dce
13459 @opindex fdump-rtl-dce
13460 Dump after the standalone dead code elimination passes.
13462 @item -fdump-rtl-dbr
13463 @opindex fdump-rtl-dbr
13464 Dump after delayed branch scheduling.
13466 @item -fdump-rtl-dce1
13467 @itemx -fdump-rtl-dce2
13468 @opindex fdump-rtl-dce1
13469 @opindex fdump-rtl-dce2
13470 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13471 the two dead store elimination passes.
13473 @item -fdump-rtl-eh
13474 @opindex fdump-rtl-eh
13475 Dump after finalization of EH handling code.
13477 @item -fdump-rtl-eh_ranges
13478 @opindex fdump-rtl-eh_ranges
13479 Dump after conversion of EH handling range regions.
13481 @item -fdump-rtl-expand
13482 @opindex fdump-rtl-expand
13483 Dump after RTL generation.
13485 @item -fdump-rtl-fwprop1
13486 @itemx -fdump-rtl-fwprop2
13487 @opindex fdump-rtl-fwprop1
13488 @opindex fdump-rtl-fwprop2
13489 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13490 dumping after the two forward propagation passes.
13492 @item -fdump-rtl-gcse1
13493 @itemx -fdump-rtl-gcse2
13494 @opindex fdump-rtl-gcse1
13495 @opindex fdump-rtl-gcse2
13496 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13497 after global common subexpression elimination.
13499 @item -fdump-rtl-init-regs
13500 @opindex fdump-rtl-init-regs
13501 Dump after the initialization of the registers.
13503 @item -fdump-rtl-initvals
13504 @opindex fdump-rtl-initvals
13505 Dump after the computation of the initial value sets.
13507 @item -fdump-rtl-into_cfglayout
13508 @opindex fdump-rtl-into_cfglayout
13509 Dump after converting to cfglayout mode.
13511 @item -fdump-rtl-ira
13512 @opindex fdump-rtl-ira
13513 Dump after iterated register allocation.
13515 @item -fdump-rtl-jump
13516 @opindex fdump-rtl-jump
13517 Dump after the second jump optimization.
13519 @item -fdump-rtl-loop2
13520 @opindex fdump-rtl-loop2
13521 @option{-fdump-rtl-loop2} enables dumping after the rtl
13522 loop optimization passes.
13524 @item -fdump-rtl-mach
13525 @opindex fdump-rtl-mach
13526 Dump after performing the machine dependent reorganization pass, if that
13527 pass exists.
13529 @item -fdump-rtl-mode_sw
13530 @opindex fdump-rtl-mode_sw
13531 Dump after removing redundant mode switches.
13533 @item -fdump-rtl-rnreg
13534 @opindex fdump-rtl-rnreg
13535 Dump after register renumbering.
13537 @item -fdump-rtl-outof_cfglayout
13538 @opindex fdump-rtl-outof_cfglayout
13539 Dump after converting from cfglayout mode.
13541 @item -fdump-rtl-peephole2
13542 @opindex fdump-rtl-peephole2
13543 Dump after the peephole pass.
13545 @item -fdump-rtl-postreload
13546 @opindex fdump-rtl-postreload
13547 Dump after post-reload optimizations.
13549 @item -fdump-rtl-pro_and_epilogue
13550 @opindex fdump-rtl-pro_and_epilogue
13551 Dump after generating the function prologues and epilogues.
13553 @item -fdump-rtl-sched1
13554 @itemx -fdump-rtl-sched2
13555 @opindex fdump-rtl-sched1
13556 @opindex fdump-rtl-sched2
13557 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13558 after the basic block scheduling passes.
13560 @item -fdump-rtl-ree
13561 @opindex fdump-rtl-ree
13562 Dump after sign/zero extension elimination.
13564 @item -fdump-rtl-seqabstr
13565 @opindex fdump-rtl-seqabstr
13566 Dump after common sequence discovery.
13568 @item -fdump-rtl-shorten
13569 @opindex fdump-rtl-shorten
13570 Dump after shortening branches.
13572 @item -fdump-rtl-sibling
13573 @opindex fdump-rtl-sibling
13574 Dump after sibling call optimizations.
13576 @item -fdump-rtl-split1
13577 @itemx -fdump-rtl-split2
13578 @itemx -fdump-rtl-split3
13579 @itemx -fdump-rtl-split4
13580 @itemx -fdump-rtl-split5
13581 @opindex fdump-rtl-split1
13582 @opindex fdump-rtl-split2
13583 @opindex fdump-rtl-split3
13584 @opindex fdump-rtl-split4
13585 @opindex fdump-rtl-split5
13586 These options enable dumping after five rounds of
13587 instruction splitting.
13589 @item -fdump-rtl-sms
13590 @opindex fdump-rtl-sms
13591 Dump after modulo scheduling.  This pass is only run on some
13592 architectures.
13594 @item -fdump-rtl-stack
13595 @opindex fdump-rtl-stack
13596 Dump after conversion from GCC's ``flat register file'' registers to the
13597 x87's stack-like registers.  This pass is only run on x86 variants.
13599 @item -fdump-rtl-subreg1
13600 @itemx -fdump-rtl-subreg2
13601 @opindex fdump-rtl-subreg1
13602 @opindex fdump-rtl-subreg2
13603 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13604 the two subreg expansion passes.
13606 @item -fdump-rtl-unshare
13607 @opindex fdump-rtl-unshare
13608 Dump after all rtl has been unshared.
13610 @item -fdump-rtl-vartrack
13611 @opindex fdump-rtl-vartrack
13612 Dump after variable tracking.
13614 @item -fdump-rtl-vregs
13615 @opindex fdump-rtl-vregs
13616 Dump after converting virtual registers to hard registers.
13618 @item -fdump-rtl-web
13619 @opindex fdump-rtl-web
13620 Dump after live range splitting.
13622 @item -fdump-rtl-regclass
13623 @itemx -fdump-rtl-subregs_of_mode_init
13624 @itemx -fdump-rtl-subregs_of_mode_finish
13625 @itemx -fdump-rtl-dfinit
13626 @itemx -fdump-rtl-dfinish
13627 @opindex fdump-rtl-regclass
13628 @opindex fdump-rtl-subregs_of_mode_init
13629 @opindex fdump-rtl-subregs_of_mode_finish
13630 @opindex fdump-rtl-dfinit
13631 @opindex fdump-rtl-dfinish
13632 These dumps are defined but always produce empty files.
13634 @item -da
13635 @itemx -fdump-rtl-all
13636 @opindex da
13637 @opindex fdump-rtl-all
13638 Produce all the dumps listed above.
13640 @item -dA
13641 @opindex dA
13642 Annotate the assembler output with miscellaneous debugging information.
13644 @item -dD
13645 @opindex dD
13646 Dump all macro definitions, at the end of preprocessing, in addition to
13647 normal output.
13649 @item -dH
13650 @opindex dH
13651 Produce a core dump whenever an error occurs.
13653 @item -dp
13654 @opindex dp
13655 Annotate the assembler output with a comment indicating which
13656 pattern and alternative is used.  The length and cost of each instruction are
13657 also printed.
13659 @item -dP
13660 @opindex dP
13661 Dump the RTL in the assembler output as a comment before each instruction.
13662 Also turns on @option{-dp} annotation.
13664 @item -dx
13665 @opindex dx
13666 Just generate RTL for a function instead of compiling it.  Usually used
13667 with @option{-fdump-rtl-expand}.
13668 @end table
13670 @item -fdump-noaddr
13671 @opindex fdump-noaddr
13672 When doing debugging dumps, suppress address output.  This makes it more
13673 feasible to use diff on debugging dumps for compiler invocations with
13674 different compiler binaries and/or different
13675 text / bss / data / heap / stack / dso start locations.
13677 @item -freport-bug
13678 @opindex freport-bug
13679 Collect and dump debug information into a temporary file if an
13680 internal compiler error (ICE) occurs.
13682 @item -fdump-unnumbered
13683 @opindex fdump-unnumbered
13684 When doing debugging dumps, suppress instruction numbers and address output.
13685 This makes it more feasible to use diff on debugging dumps for compiler
13686 invocations with different options, in particular with and without
13687 @option{-g}.
13689 @item -fdump-unnumbered-links
13690 @opindex fdump-unnumbered-links
13691 When doing debugging dumps (see @option{-d} option above), suppress
13692 instruction numbers for the links to the previous and next instructions
13693 in a sequence.
13695 @item -fdump-ipa-@var{switch}
13696 @opindex fdump-ipa
13697 Control the dumping at various stages of inter-procedural analysis
13698 language tree to a file.  The file name is generated by appending a
13699 switch specific suffix to the source file name, and the file is created
13700 in the same directory as the output file.  The following dumps are
13701 possible:
13703 @table @samp
13704 @item all
13705 Enables all inter-procedural analysis dumps.
13707 @item cgraph
13708 Dumps information about call-graph optimization, unused function removal,
13709 and inlining decisions.
13711 @item inline
13712 Dump after function inlining.
13714 @end table
13716 @item -fdump-lang-all
13717 @itemx -fdump-lang-@var{switch}
13718 @itemx -fdump-lang-@var{switch}-@var{options}
13719 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13720 @opindex fdump-lang-all
13721 @opindex fdump-lang
13722 Control the dumping of language-specific information.  The @var{options}
13723 and @var{filename} portions behave as described in the
13724 @option{-fdump-tree} option.  The following @var{switch} values are
13725 accepted:
13727 @table @samp
13728 @item all
13730 Enable all language-specific dumps.
13732 @item class
13733 Dump class hierarchy information.  Virtual table information is emitted
13734 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13736 @item raw
13737 Dump the raw internal tree data.  This option is applicable to C++ only.
13739 @end table
13741 @item -fdump-passes
13742 @opindex fdump-passes
13743 Print on @file{stderr} the list of optimization passes that are turned
13744 on and off by the current command-line options.
13746 @item -fdump-statistics-@var{option}
13747 @opindex fdump-statistics
13748 Enable and control dumping of pass statistics in a separate file.  The
13749 file name is generated by appending a suffix ending in
13750 @samp{.statistics} to the source file name, and the file is created in
13751 the same directory as the output file.  If the @samp{-@var{option}}
13752 form is used, @samp{-stats} causes counters to be summed over the
13753 whole compilation unit while @samp{-details} dumps every event as
13754 the passes generate them.  The default with no option is to sum
13755 counters for each function compiled.
13757 @item -fdump-tree-all
13758 @itemx -fdump-tree-@var{switch}
13759 @itemx -fdump-tree-@var{switch}-@var{options}
13760 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13761 @opindex fdump-tree-all
13762 @opindex fdump-tree
13763 Control the dumping at various stages of processing the intermediate
13764 language tree to a file.  If the @samp{-@var{options}}
13765 form is used, @var{options} is a list of @samp{-} separated options
13766 which control the details of the dump.  Not all options are applicable
13767 to all dumps; those that are not meaningful are ignored.  The
13768 following options are available
13770 @table @samp
13771 @item address
13772 Print the address of each node.  Usually this is not meaningful as it
13773 changes according to the environment and source file.  Its primary use
13774 is for tying up a dump file with a debug environment.
13775 @item asmname
13776 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13777 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13778 use working backward from mangled names in the assembly file.
13779 @item slim
13780 When dumping front-end intermediate representations, inhibit dumping
13781 of members of a scope or body of a function merely because that scope
13782 has been reached.  Only dump such items when they are directly reachable
13783 by some other path.
13785 When dumping pretty-printed trees, this option inhibits dumping the
13786 bodies of control structures.
13788 When dumping RTL, print the RTL in slim (condensed) form instead of
13789 the default LISP-like representation.
13790 @item raw
13791 Print a raw representation of the tree.  By default, trees are
13792 pretty-printed into a C-like representation.
13793 @item details
13794 Enable more detailed dumps (not honored by every dump option). Also
13795 include information from the optimization passes.
13796 @item stats
13797 Enable dumping various statistics about the pass (not honored by every dump
13798 option).
13799 @item blocks
13800 Enable showing basic block boundaries (disabled in raw dumps).
13801 @item graph
13802 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13803 dump a representation of the control flow graph suitable for viewing with
13804 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13805 the file is pretty-printed as a subgraph, so that GraphViz can render them
13806 all in a single plot.
13808 This option currently only works for RTL dumps, and the RTL is always
13809 dumped in slim form.
13810 @item vops
13811 Enable showing virtual operands for every statement.
13812 @item lineno
13813 Enable showing line numbers for statements.
13814 @item uid
13815 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13816 @item verbose
13817 Enable showing the tree dump for each statement.
13818 @item eh
13819 Enable showing the EH region number holding each statement.
13820 @item scev
13821 Enable showing scalar evolution analysis details.
13822 @item optimized
13823 Enable showing optimization information (only available in certain
13824 passes).
13825 @item missed
13826 Enable showing missed optimization information (only available in certain
13827 passes).
13828 @item note
13829 Enable other detailed optimization information (only available in
13830 certain passes).
13831 @item all
13832 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13833 and @option{lineno}.
13834 @item optall
13835 Turn on all optimization options, i.e., @option{optimized},
13836 @option{missed}, and @option{note}.
13837 @end table
13839 To determine what tree dumps are available or find the dump for a pass
13840 of interest follow the steps below.
13842 @enumerate
13843 @item
13844 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13845 look for a code that corresponds to the pass you are interested in.
13846 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13847 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13848 The number at the end distinguishes distinct invocations of the same pass.
13849 @item
13850 To enable the creation of the dump file, append the pass code to
13851 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13852 to enable the dump from the Early Value Range Propagation pass, invoke
13853 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13854 specify the name of the dump file.  If you don't specify one, GCC
13855 creates as described below.
13856 @item
13857 Find the pass dump in a file whose name is composed of three components
13858 separated by a period: the name of the source file GCC was invoked to
13859 compile, a numeric suffix indicating the pass number followed by the
13860 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13861 and finally the pass code.  For example, the Early VRP pass dump might
13862 be in a file named @file{myfile.c.038t.evrp} in the current working
13863 directory.  Note that the numeric codes are not stable and may change
13864 from one version of GCC to another.
13865 @end enumerate
13867 @item -fopt-info
13868 @itemx -fopt-info-@var{options}
13869 @itemx -fopt-info-@var{options}=@var{filename}
13870 @opindex fopt-info
13871 Controls optimization dumps from various optimization passes. If the
13872 @samp{-@var{options}} form is used, @var{options} is a list of
13873 @samp{-} separated option keywords to select the dump details and
13874 optimizations.  
13876 The @var{options} can be divided into two groups: options describing the
13877 verbosity of the dump, and options describing which optimizations
13878 should be included. The options from both the groups can be freely
13879 mixed as they are non-overlapping. However, in case of any conflicts,
13880 the later options override the earlier options on the command
13881 line. 
13883 The following options control the dump verbosity:
13885 @table @samp
13886 @item optimized
13887 Print information when an optimization is successfully applied. It is
13888 up to a pass to decide which information is relevant. For example, the
13889 vectorizer passes print the source location of loops which are
13890 successfully vectorized.
13891 @item missed
13892 Print information about missed optimizations. Individual passes
13893 control which information to include in the output. 
13894 @item note
13895 Print verbose information about optimizations, such as certain
13896 transformations, more detailed messages about decisions etc.
13897 @item all
13898 Print detailed optimization information. This includes
13899 @samp{optimized}, @samp{missed}, and @samp{note}.
13900 @end table
13902 One or more of the following option keywords can be used to describe a
13903 group of optimizations:
13905 @table @samp
13906 @item ipa
13907 Enable dumps from all interprocedural optimizations.
13908 @item loop
13909 Enable dumps from all loop optimizations.
13910 @item inline
13911 Enable dumps from all inlining optimizations.
13912 @item omp
13913 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13914 @item vec
13915 Enable dumps from all vectorization optimizations.
13916 @item optall
13917 Enable dumps from all optimizations. This is a superset of
13918 the optimization groups listed above.
13919 @end table
13921 If @var{options} is
13922 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13923 info about successful optimizations from all the passes.  
13925 If the @var{filename} is provided, then the dumps from all the
13926 applicable optimizations are concatenated into the @var{filename}.
13927 Otherwise the dump is output onto @file{stderr}. Though multiple
13928 @option{-fopt-info} options are accepted, only one of them can include
13929 a @var{filename}. If other filenames are provided then all but the
13930 first such option are ignored.
13932 Note that the output @var{filename} is overwritten
13933 in case of multiple translation units. If a combined output from
13934 multiple translation units is desired, @file{stderr} should be used
13935 instead.
13937 In the following example, the optimization info is output to
13938 @file{stderr}:
13940 @smallexample
13941 gcc -O3 -fopt-info
13942 @end smallexample
13944 This example:
13945 @smallexample
13946 gcc -O3 -fopt-info-missed=missed.all
13947 @end smallexample
13949 @noindent
13950 outputs missed optimization report from all the passes into
13951 @file{missed.all}, and this one:
13953 @smallexample
13954 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13955 @end smallexample
13957 @noindent
13958 prints information about missed optimization opportunities from
13959 vectorization passes on @file{stderr}.  
13960 Note that @option{-fopt-info-vec-missed} is equivalent to 
13961 @option{-fopt-info-missed-vec}.  The order of the optimization group
13962 names and message types listed after @option{-fopt-info} does not matter.
13964 As another example,
13965 @smallexample
13966 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13967 @end smallexample
13969 @noindent
13970 outputs information about missed optimizations as well as
13971 optimized locations from all the inlining passes into
13972 @file{inline.txt}.
13974 Finally, consider:
13976 @smallexample
13977 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13978 @end smallexample
13980 @noindent
13981 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13982 in conflict since only one output file is allowed. In this case, only
13983 the first option takes effect and the subsequent options are
13984 ignored. Thus only @file{vec.miss} is produced which contains
13985 dumps from the vectorizer about missed opportunities.
13987 @item -fsched-verbose=@var{n}
13988 @opindex fsched-verbose
13989 On targets that use instruction scheduling, this option controls the
13990 amount of debugging output the scheduler prints to the dump files.
13992 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13993 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13994 For @var{n} greater than one, it also output basic block probabilities,
13995 detailed ready list information and unit/insn info.  For @var{n} greater
13996 than two, it includes RTL at abort point, control-flow and regions info.
13997 And for @var{n} over four, @option{-fsched-verbose} also includes
13998 dependence info.
14002 @item -fenable-@var{kind}-@var{pass}
14003 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
14004 @opindex fdisable-
14005 @opindex fenable-
14007 This is a set of options that are used to explicitly disable/enable
14008 optimization passes.  These options are intended for use for debugging GCC.
14009 Compiler users should use regular options for enabling/disabling
14010 passes instead.
14012 @table @gcctabopt
14014 @item -fdisable-ipa-@var{pass}
14015 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
14016 statically invoked in the compiler multiple times, the pass name should be
14017 appended with a sequential number starting from 1.
14019 @item -fdisable-rtl-@var{pass}
14020 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
14021 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14022 statically invoked in the compiler multiple times, the pass name should be
14023 appended with a sequential number starting from 1.  @var{range-list} is a 
14024 comma-separated list of function ranges or assembler names.  Each range is a number
14025 pair separated by a colon.  The range is inclusive in both ends.  If the range
14026 is trivial, the number pair can be simplified as a single number.  If the
14027 function's call graph node's @var{uid} falls within one of the specified ranges,
14028 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
14029 function header of a dump file, and the pass names can be dumped by using
14030 option @option{-fdump-passes}.
14032 @item -fdisable-tree-@var{pass}
14033 @itemx -fdisable-tree-@var{pass}=@var{range-list}
14034 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
14035 option arguments.
14037 @item -fenable-ipa-@var{pass}
14038 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14039 statically invoked in the compiler multiple times, the pass name should be
14040 appended with a sequential number starting from 1.
14042 @item -fenable-rtl-@var{pass}
14043 @itemx -fenable-rtl-@var{pass}=@var{range-list}
14044 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
14045 description and examples.
14047 @item -fenable-tree-@var{pass}
14048 @itemx -fenable-tree-@var{pass}=@var{range-list}
14049 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
14050 of option arguments.
14052 @end table
14054 Here are some examples showing uses of these options.
14056 @smallexample
14058 # disable ccp1 for all functions
14059    -fdisable-tree-ccp1
14060 # disable complete unroll for function whose cgraph node uid is 1
14061    -fenable-tree-cunroll=1
14062 # disable gcse2 for functions at the following ranges [1,1],
14063 # [300,400], and [400,1000]
14064 # disable gcse2 for functions foo and foo2
14065    -fdisable-rtl-gcse2=foo,foo2
14066 # disable early inlining
14067    -fdisable-tree-einline
14068 # disable ipa inlining
14069    -fdisable-ipa-inline
14070 # enable tree full unroll
14071    -fenable-tree-unroll
14073 @end smallexample
14075 @item -fchecking
14076 @itemx -fchecking=@var{n}
14077 @opindex fchecking
14078 @opindex fno-checking
14079 Enable internal consistency checking.  The default depends on
14080 the compiler configuration.  @option{-fchecking=2} enables further
14081 internal consistency checking that might affect code generation.
14083 @item -frandom-seed=@var{string}
14084 @opindex frandom-seed
14085 This option provides a seed that GCC uses in place of
14086 random numbers in generating certain symbol names
14087 that have to be different in every compiled file.  It is also used to
14088 place unique stamps in coverage data files and the object files that
14089 produce them.  You can use the @option{-frandom-seed} option to produce
14090 reproducibly identical object files.
14092 The @var{string} can either be a number (decimal, octal or hex) or an
14093 arbitrary string (in which case it's converted to a number by
14094 computing CRC32).
14096 The @var{string} should be different for every file you compile.
14098 @item -save-temps
14099 @itemx -save-temps=cwd
14100 @opindex save-temps
14101 Store the usual ``temporary'' intermediate files permanently; place them
14102 in the current directory and name them based on the source file.  Thus,
14103 compiling @file{foo.c} with @option{-c -save-temps} produces files
14104 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
14105 preprocessed @file{foo.i} output file even though the compiler now
14106 normally uses an integrated preprocessor.
14108 When used in combination with the @option{-x} command-line option,
14109 @option{-save-temps} is sensible enough to avoid over writing an
14110 input source file with the same extension as an intermediate file.
14111 The corresponding intermediate file may be obtained by renaming the
14112 source file before using @option{-save-temps}.
14114 If you invoke GCC in parallel, compiling several different source
14115 files that share a common base name in different subdirectories or the
14116 same source file compiled for multiple output destinations, it is
14117 likely that the different parallel compilers will interfere with each
14118 other, and overwrite the temporary files.  For instance:
14120 @smallexample
14121 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
14122 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
14123 @end smallexample
14125 may result in @file{foo.i} and @file{foo.o} being written to
14126 simultaneously by both compilers.
14128 @item -save-temps=obj
14129 @opindex save-temps=obj
14130 Store the usual ``temporary'' intermediate files permanently.  If the
14131 @option{-o} option is used, the temporary files are based on the
14132 object file.  If the @option{-o} option is not used, the
14133 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
14135 For example:
14137 @smallexample
14138 gcc -save-temps=obj -c foo.c
14139 gcc -save-temps=obj -c bar.c -o dir/xbar.o
14140 gcc -save-temps=obj foobar.c -o dir2/yfoobar
14141 @end smallexample
14143 @noindent
14144 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
14145 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
14146 @file{dir2/yfoobar.o}.
14148 @item -time@r{[}=@var{file}@r{]}
14149 @opindex time
14150 Report the CPU time taken by each subprocess in the compilation
14151 sequence.  For C source files, this is the compiler proper and assembler
14152 (plus the linker if linking is done).
14154 Without the specification of an output file, the output looks like this:
14156 @smallexample
14157 # cc1 0.12 0.01
14158 # as 0.00 0.01
14159 @end smallexample
14161 The first number on each line is the ``user time'', that is time spent
14162 executing the program itself.  The second number is ``system time'',
14163 time spent executing operating system routines on behalf of the program.
14164 Both numbers are in seconds.
14166 With the specification of an output file, the output is appended to the
14167 named file, and it looks like this:
14169 @smallexample
14170 0.12 0.01 cc1 @var{options}
14171 0.00 0.01 as @var{options}
14172 @end smallexample
14174 The ``user time'' and the ``system time'' are moved before the program
14175 name, and the options passed to the program are displayed, so that one
14176 can later tell what file was being compiled, and with which options.
14178 @item -fdump-final-insns@r{[}=@var{file}@r{]}
14179 @opindex fdump-final-insns
14180 Dump the final internal representation (RTL) to @var{file}.  If the
14181 optional argument is omitted (or if @var{file} is @code{.}), the name
14182 of the dump file is determined by appending @code{.gkd} to the
14183 compilation output file name.
14185 @item -fcompare-debug@r{[}=@var{opts}@r{]}
14186 @opindex fcompare-debug
14187 @opindex fno-compare-debug
14188 If no error occurs during compilation, run the compiler a second time,
14189 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14190 passed to the second compilation.  Dump the final internal
14191 representation in both compilations, and print an error if they differ.
14193 If the equal sign is omitted, the default @option{-gtoggle} is used.
14195 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14196 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14197 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14198 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14199 is used.
14201 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14202 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14203 of the final representation and the second compilation, preventing even
14204 @env{GCC_COMPARE_DEBUG} from taking effect.
14206 To verify full coverage during @option{-fcompare-debug} testing, set
14207 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14208 which GCC rejects as an invalid option in any actual compilation
14209 (rather than preprocessing, assembly or linking).  To get just a
14210 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14211 not overridden} will do.
14213 @item -fcompare-debug-second
14214 @opindex fcompare-debug-second
14215 This option is implicitly passed to the compiler for the second
14216 compilation requested by @option{-fcompare-debug}, along with options to
14217 silence warnings, and omitting other options that would cause the compiler
14218 to produce output to files or to standard output as a side effect.  Dump
14219 files and preserved temporary files are renamed so as to contain the
14220 @code{.gk} additional extension during the second compilation, to avoid
14221 overwriting those generated by the first.
14223 When this option is passed to the compiler driver, it causes the
14224 @emph{first} compilation to be skipped, which makes it useful for little
14225 other than debugging the compiler proper.
14227 @item -gtoggle
14228 @opindex gtoggle
14229 Turn off generation of debug info, if leaving out this option
14230 generates it, or turn it on at level 2 otherwise.  The position of this
14231 argument in the command line does not matter; it takes effect after all
14232 other options are processed, and it does so only once, no matter how
14233 many times it is given.  This is mainly intended to be used with
14234 @option{-fcompare-debug}.
14236 @item -fvar-tracking-assignments-toggle
14237 @opindex fvar-tracking-assignments-toggle
14238 @opindex fno-var-tracking-assignments-toggle
14239 Toggle @option{-fvar-tracking-assignments}, in the same way that
14240 @option{-gtoggle} toggles @option{-g}.
14242 @item -Q
14243 @opindex Q
14244 Makes the compiler print out each function name as it is compiled, and
14245 print some statistics about each pass when it finishes.
14247 @item -ftime-report
14248 @opindex ftime-report
14249 Makes the compiler print some statistics about the time consumed by each
14250 pass when it finishes.
14252 @item -ftime-report-details
14253 @opindex ftime-report-details
14254 Record the time consumed by infrastructure parts separately for each pass.
14256 @item -fira-verbose=@var{n}
14257 @opindex fira-verbose
14258 Control the verbosity of the dump file for the integrated register allocator.
14259 The default value is 5.  If the value @var{n} is greater or equal to 10,
14260 the dump output is sent to stderr using the same format as @var{n} minus 10.
14262 @item -flto-report
14263 @opindex flto-report
14264 Prints a report with internal details on the workings of the link-time
14265 optimizer.  The contents of this report vary from version to version.
14266 It is meant to be useful to GCC developers when processing object
14267 files in LTO mode (via @option{-flto}).
14269 Disabled by default.
14271 @item -flto-report-wpa
14272 @opindex flto-report-wpa
14273 Like @option{-flto-report}, but only print for the WPA phase of Link
14274 Time Optimization.
14276 @item -fmem-report
14277 @opindex fmem-report
14278 Makes the compiler print some statistics about permanent memory
14279 allocation when it finishes.
14281 @item -fmem-report-wpa
14282 @opindex fmem-report-wpa
14283 Makes the compiler print some statistics about permanent memory
14284 allocation for the WPA phase only.
14286 @item -fpre-ipa-mem-report
14287 @opindex fpre-ipa-mem-report
14288 @item -fpost-ipa-mem-report
14289 @opindex fpost-ipa-mem-report
14290 Makes the compiler print some statistics about permanent memory
14291 allocation before or after interprocedural optimization.
14293 @item -fprofile-report
14294 @opindex fprofile-report
14295 Makes the compiler print some statistics about consistency of the
14296 (estimated) profile and effect of individual passes.
14298 @item -fstack-usage
14299 @opindex fstack-usage
14300 Makes the compiler output stack usage information for the program, on a
14301 per-function basis.  The filename for the dump is made by appending
14302 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14303 the output file, if explicitly specified and it is not an executable,
14304 otherwise it is the basename of the source file.  An entry is made up
14305 of three fields:
14307 @itemize
14308 @item
14309 The name of the function.
14310 @item
14311 A number of bytes.
14312 @item
14313 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14314 @end itemize
14316 The qualifier @code{static} means that the function manipulates the stack
14317 statically: a fixed number of bytes are allocated for the frame on function
14318 entry and released on function exit; no stack adjustments are otherwise made
14319 in the function.  The second field is this fixed number of bytes.
14321 The qualifier @code{dynamic} means that the function manipulates the stack
14322 dynamically: in addition to the static allocation described above, stack
14323 adjustments are made in the body of the function, for example to push/pop
14324 arguments around function calls.  If the qualifier @code{bounded} is also
14325 present, the amount of these adjustments is bounded at compile time and
14326 the second field is an upper bound of the total amount of stack used by
14327 the function.  If it is not present, the amount of these adjustments is
14328 not bounded at compile time and the second field only represents the
14329 bounded part.
14331 @item -fstats
14332 @opindex fstats
14333 Emit statistics about front-end processing at the end of the compilation.
14334 This option is supported only by the C++ front end, and
14335 the information is generally only useful to the G++ development team.
14337 @item -fdbg-cnt-list
14338 @opindex fdbg-cnt-list
14339 Print the name and the counter upper bound for all debug counters.
14342 @item -fdbg-cnt=@var{counter-value-list}
14343 @opindex fdbg-cnt
14344 Set the internal debug counter lower and upper bound.  @var{counter-value-list}
14345 is a comma-separated list of @var{name}:@var{lower_bound}:@var{upper_bound}
14346 tuples which sets the lower and the upper bound of each debug
14347 counter @var{name}.  The @var{lower_bound} is optional and is zero
14348 initialized if not set.
14349 All debug counters have the initial upper bound of @code{UINT_MAX};
14350 thus @code{dbg_cnt} returns true always unless the upper bound
14351 is set by this option.
14352 For example, with @option{-fdbg-cnt=dce:2:4,tail_call:10},
14353 @code{dbg_cnt(dce)} returns true only for third and fourth invocation.
14354 For @code{dbg_cnt(tail_call)} true is returned for first 10 invocations.
14356 @item -print-file-name=@var{library}
14357 @opindex print-file-name
14358 Print the full absolute name of the library file @var{library} that
14359 would be used when linking---and don't do anything else.  With this
14360 option, GCC does not compile or link anything; it just prints the
14361 file name.
14363 @item -print-multi-directory
14364 @opindex print-multi-directory
14365 Print the directory name corresponding to the multilib selected by any
14366 other switches present in the command line.  This directory is supposed
14367 to exist in @env{GCC_EXEC_PREFIX}.
14369 @item -print-multi-lib
14370 @opindex print-multi-lib
14371 Print the mapping from multilib directory names to compiler switches
14372 that enable them.  The directory name is separated from the switches by
14373 @samp{;}, and each switch starts with an @samp{@@} instead of the
14374 @samp{-}, without spaces between multiple switches.  This is supposed to
14375 ease shell processing.
14377 @item -print-multi-os-directory
14378 @opindex print-multi-os-directory
14379 Print the path to OS libraries for the selected
14380 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14381 present in the @file{lib} subdirectory and no multilibs are used, this is
14382 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14383 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14384 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14385 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14387 @item -print-multiarch
14388 @opindex print-multiarch
14389 Print the path to OS libraries for the selected multiarch,
14390 relative to some @file{lib} subdirectory.
14392 @item -print-prog-name=@var{program}
14393 @opindex print-prog-name
14394 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14396 @item -print-libgcc-file-name
14397 @opindex print-libgcc-file-name
14398 Same as @option{-print-file-name=libgcc.a}.
14400 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14401 but you do want to link with @file{libgcc.a}.  You can do:
14403 @smallexample
14404 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14405 @end smallexample
14407 @item -print-search-dirs
14408 @opindex print-search-dirs
14409 Print the name of the configured installation directory and a list of
14410 program and library directories @command{gcc} searches---and don't do anything else.
14412 This is useful when @command{gcc} prints the error message
14413 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14414 To resolve this you either need to put @file{cpp0} and the other compiler
14415 components where @command{gcc} expects to find them, or you can set the environment
14416 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14417 Don't forget the trailing @samp{/}.
14418 @xref{Environment Variables}.
14420 @item -print-sysroot
14421 @opindex print-sysroot
14422 Print the target sysroot directory that is used during
14423 compilation.  This is the target sysroot specified either at configure
14424 time or using the @option{--sysroot} option, possibly with an extra
14425 suffix that depends on compilation options.  If no target sysroot is
14426 specified, the option prints nothing.
14428 @item -print-sysroot-headers-suffix
14429 @opindex print-sysroot-headers-suffix
14430 Print the suffix added to the target sysroot when searching for
14431 headers, or give an error if the compiler is not configured with such
14432 a suffix---and don't do anything else.
14434 @item -dumpmachine
14435 @opindex dumpmachine
14436 Print the compiler's target machine (for example,
14437 @samp{i686-pc-linux-gnu})---and don't do anything else.
14439 @item -dumpversion
14440 @opindex dumpversion
14441 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14442 anything else.  This is the compiler version used in filesystem paths,
14443 specs, can be depending on how the compiler has been configured just
14444 a single number (major version), two numbers separated by dot (major and
14445 minor version) or three numbers separated by dots (major, minor and patchlevel
14446 version).
14448 @item -dumpfullversion
14449 @opindex dumpfullversion
14450 Print the full compiler version, always 3 numbers separated by dots,
14451 major, minor and patchlevel version.
14453 @item -dumpspecs
14454 @opindex dumpspecs
14455 Print the compiler's built-in specs---and don't do anything else.  (This
14456 is used when GCC itself is being built.)  @xref{Spec Files}.
14457 @end table
14459 @node Submodel Options
14460 @section Machine-Dependent Options
14461 @cindex submodel options
14462 @cindex specifying hardware config
14463 @cindex hardware models and configurations, specifying
14464 @cindex target-dependent options
14465 @cindex machine-dependent options
14467 Each target machine supported by GCC can have its own options---for
14468 example, to allow you to compile for a particular processor variant or
14469 ABI, or to control optimizations specific to that machine.  By
14470 convention, the names of machine-specific options start with
14471 @samp{-m}.
14473 Some configurations of the compiler also support additional target-specific
14474 options, usually for compatibility with other compilers on the same
14475 platform.
14477 @c This list is ordered alphanumerically by subsection name.
14478 @c It should be the same order and spelling as these options are listed
14479 @c in Machine Dependent Options
14481 @menu
14482 * AArch64 Options::
14483 * Adapteva Epiphany Options::
14484 * ARC Options::
14485 * ARM Options::
14486 * AVR Options::
14487 * Blackfin Options::
14488 * C6X Options::
14489 * CRIS Options::
14490 * CR16 Options::
14491 * Darwin Options::
14492 * DEC Alpha Options::
14493 * FR30 Options::
14494 * FT32 Options::
14495 * FRV Options::
14496 * GNU/Linux Options::
14497 * H8/300 Options::
14498 * HPPA Options::
14499 * IA-64 Options::
14500 * LM32 Options::
14501 * M32C Options::
14502 * M32R/D Options::
14503 * M680x0 Options::
14504 * MCore Options::
14505 * MeP Options::
14506 * MicroBlaze Options::
14507 * MIPS Options::
14508 * MMIX Options::
14509 * MN10300 Options::
14510 * Moxie Options::
14511 * MSP430 Options::
14512 * NDS32 Options::
14513 * Nios II Options::
14514 * Nvidia PTX Options::
14515 * PDP-11 Options::
14516 * picoChip Options::
14517 * PowerPC Options::
14518 * PowerPC SPE Options::
14519 * RISC-V Options::
14520 * RL78 Options::
14521 * RS/6000 and PowerPC Options::
14522 * RX Options::
14523 * S/390 and zSeries Options::
14524 * Score Options::
14525 * SH Options::
14526 * Solaris 2 Options::
14527 * SPARC Options::
14528 * SPU Options::
14529 * System V Options::
14530 * TILE-Gx Options::
14531 * TILEPro Options::
14532 * V850 Options::
14533 * VAX Options::
14534 * Visium Options::
14535 * VMS Options::
14536 * VxWorks Options::
14537 * x86 Options::
14538 * x86 Windows Options::
14539 * Xstormy16 Options::
14540 * Xtensa Options::
14541 * zSeries Options::
14542 @end menu
14544 @node AArch64 Options
14545 @subsection AArch64 Options
14546 @cindex AArch64 Options
14548 These options are defined for AArch64 implementations:
14550 @table @gcctabopt
14552 @item -mabi=@var{name}
14553 @opindex mabi
14554 Generate code for the specified data model.  Permissible values
14555 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14556 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14557 but long int and pointers are 64 bits.
14559 The default depends on the specific target configuration.  Note that
14560 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14561 entire program with the same ABI, and link with a compatible set of libraries.
14563 @item -mbig-endian
14564 @opindex mbig-endian
14565 Generate big-endian code.  This is the default when GCC is configured for an
14566 @samp{aarch64_be-*-*} target.
14568 @item -mgeneral-regs-only
14569 @opindex mgeneral-regs-only
14570 Generate code which uses only the general-purpose registers.  This will prevent
14571 the compiler from using floating-point and Advanced SIMD registers but will not
14572 impose any restrictions on the assembler.
14574 @item -mlittle-endian
14575 @opindex mlittle-endian
14576 Generate little-endian code.  This is the default when GCC is configured for an
14577 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14579 @item -mcmodel=tiny
14580 @opindex mcmodel=tiny
14581 Generate code for the tiny code model.  The program and its statically defined
14582 symbols must be within 1MB of each other.  Programs can be statically or
14583 dynamically linked.
14585 @item -mcmodel=small
14586 @opindex mcmodel=small
14587 Generate code for the small code model.  The program and its statically defined
14588 symbols must be within 4GB of each other.  Programs can be statically or
14589 dynamically linked.  This is the default code model.
14591 @item -mcmodel=large
14592 @opindex mcmodel=large
14593 Generate code for the large code model.  This makes no assumptions about
14594 addresses and sizes of sections.  Programs can be statically linked only.
14596 @item -mstrict-align
14597 @opindex mstrict-align
14598 Avoid generating memory accesses that may not be aligned on a natural object
14599 boundary as described in the architecture specification.
14601 @item -momit-leaf-frame-pointer
14602 @itemx -mno-omit-leaf-frame-pointer
14603 @opindex momit-leaf-frame-pointer
14604 @opindex mno-omit-leaf-frame-pointer
14605 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14606 default.
14608 @item -mtls-dialect=desc
14609 @opindex mtls-dialect=desc
14610 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14611 of TLS variables.  This is the default.
14613 @item -mtls-dialect=traditional
14614 @opindex mtls-dialect=traditional
14615 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14616 of TLS variables.
14618 @item -mtls-size=@var{size}
14619 @opindex mtls-size
14620 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14621 This option requires binutils 2.26 or newer.
14623 @item -mfix-cortex-a53-835769
14624 @itemx -mno-fix-cortex-a53-835769
14625 @opindex mfix-cortex-a53-835769
14626 @opindex mno-fix-cortex-a53-835769
14627 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14628 This involves inserting a NOP instruction between memory instructions and
14629 64-bit integer multiply-accumulate instructions.
14631 @item -mfix-cortex-a53-843419
14632 @itemx -mno-fix-cortex-a53-843419
14633 @opindex mfix-cortex-a53-843419
14634 @opindex mno-fix-cortex-a53-843419
14635 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14636 This erratum workaround is made at link time and this will only pass the
14637 corresponding flag to the linker.
14639 @item -mlow-precision-recip-sqrt
14640 @itemx -mno-low-precision-recip-sqrt
14641 @opindex mlow-precision-recip-sqrt
14642 @opindex mno-low-precision-recip-sqrt
14643 Enable or disable the reciprocal square root approximation.
14644 This option only has an effect if @option{-ffast-math} or
14645 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14646 precision of reciprocal square root results to about 16 bits for
14647 single precision and to 32 bits for double precision.
14649 @item -mlow-precision-sqrt
14650 @itemx -mno-low-precision-sqrt
14651 @opindex -mlow-precision-sqrt
14652 @opindex -mno-low-precision-sqrt
14653 Enable or disable the square root approximation.
14654 This option only has an effect if @option{-ffast-math} or
14655 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14656 precision of square root results to about 16 bits for
14657 single precision and to 32 bits for double precision.
14658 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14660 @item -mlow-precision-div
14661 @itemx -mno-low-precision-div
14662 @opindex -mlow-precision-div
14663 @opindex -mno-low-precision-div
14664 Enable or disable the division 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 division results to about 16 bits for
14668 single precision and to 32 bits for double precision.
14670 @item -march=@var{name}
14671 @opindex march
14672 Specify the name of the target architecture and, optionally, one or
14673 more feature modifiers.  This option has the form
14674 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14676 The permissible values for @var{arch} are @samp{armv8-a},
14677 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @samp{armv8.4-a}
14678 or @var{native}.
14680 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
14681 support for the ARMv8.4-A architecture extensions.
14683 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14684 support for the ARMv8.3-A architecture extensions.
14686 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14687 support for the ARMv8.2-A architecture extensions.
14689 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14690 support for the ARMv8.1-A architecture extension.  In particular, it
14691 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14693 The value @samp{native} is available on native AArch64 GNU/Linux and
14694 causes the compiler to pick the architecture of the host system.  This
14695 option has no effect if the compiler is unable to recognize the
14696 architecture of the host system,
14698 The permissible values for @var{feature} are listed in the sub-section
14699 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14700 Feature Modifiers}.  Where conflicting feature modifiers are
14701 specified, the right-most feature is used.
14703 GCC uses @var{name} to determine what kind of instructions it can emit
14704 when generating assembly code.  If @option{-march} is specified
14705 without either of @option{-mtune} or @option{-mcpu} also being
14706 specified, the code is tuned to perform well across a range of target
14707 processors implementing the target architecture.
14709 @item -mtune=@var{name}
14710 @opindex mtune
14711 Specify the name of the target processor for which GCC should tune the
14712 performance of the code.  Permissible values for this option are:
14713 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14714 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14715 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14716 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14717 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14718 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14719 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14720 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14721 @samp{native}.
14723 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14724 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14725 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14726 big.LITTLE system.
14728 Additionally on native AArch64 GNU/Linux systems the value
14729 @samp{native} tunes performance to the host system.  This option has no effect
14730 if the compiler is unable to recognize the processor of the host system.
14732 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14733 are specified, the code is tuned to perform well across a range
14734 of target processors.
14736 This option cannot be suffixed by feature modifiers.
14738 @item -mcpu=@var{name}
14739 @opindex mcpu
14740 Specify the name of the target processor, optionally suffixed by one
14741 or more feature modifiers.  This option has the form
14742 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14743 the permissible values for @var{cpu} are the same as those available
14744 for @option{-mtune}.  The permissible values for @var{feature} are
14745 documented in the sub-section on
14746 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14747 Feature Modifiers}.  Where conflicting feature modifiers are
14748 specified, the right-most feature is used.
14750 GCC uses @var{name} to determine what kind of instructions it can emit when
14751 generating assembly code (as if by @option{-march}) and to determine
14752 the target processor for which to tune for performance (as if
14753 by @option{-mtune}).  Where this option is used in conjunction
14754 with @option{-march} or @option{-mtune}, those options take precedence
14755 over the appropriate part of this option.
14757 @item -moverride=@var{string}
14758 @opindex moverride
14759 Override tuning decisions made by the back-end in response to a
14760 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14761 for @var{string} in this option are not guaranteed to be consistent
14762 across releases.
14764 This option is only intended to be useful when developing GCC.
14766 @item -mverbose-cost-dump
14767 @opindex mverbose-cost-dump
14768 Enable verbose cost model dumping in the debug dump files.  This option is
14769 provided for use in debugging the compiler.
14771 @item -mpc-relative-literal-loads
14772 @itemx -mno-pc-relative-literal-loads
14773 @opindex mpc-relative-literal-loads
14774 @opindex mno-pc-relative-literal-loads
14775 Enable or disable PC-relative literal loads.  With this option literal pools are
14776 accessed using a single instruction and emitted after each function.  This
14777 limits the maximum size of functions to 1MB.  This is enabled by default for
14778 @option{-mcmodel=tiny}.
14780 @item -msign-return-address=@var{scope}
14781 @opindex msign-return-address
14782 Select the function scope on which return address signing will be applied.
14783 Permissible values are @samp{none}, which disables return address signing,
14784 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14785 functions, and @samp{all}, which enables pointer signing for all functions.  The
14786 default value is @samp{none}.
14788 @item -msve-vector-bits=@var{bits}
14789 @opindex msve-vector-bits
14790 Specify the number of bits in an SVE vector register.  This option only has
14791 an effect when SVE is enabled.
14793 GCC supports two forms of SVE code generation: ``vector-length
14794 agnostic'' output that works with any size of vector register and
14795 ``vector-length specific'' output that only works when the vector
14796 registers are a particular size.  Replacing @var{bits} with
14797 @samp{scalable} selects vector-length agnostic output while
14798 replacing it with a number selects vector-length specific output.
14799 The possible lengths in the latter case are: 128, 256, 512, 1024
14800 and 2048.  @samp{scalable} is the default.
14802 At present, @samp{-msve-vector-bits=128} produces the same output
14803 as @samp{-msve-vector-bits=scalable}.
14805 @end table
14807 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14808 @anchor{aarch64-feature-modifiers}
14809 @cindex @option{-march} feature modifiers
14810 @cindex @option{-mcpu} feature modifiers
14811 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14812 the following and their inverses @option{no@var{feature}}:
14814 @table @samp
14815 @item crc
14816 Enable CRC extension.  This is on by default for
14817 @option{-march=armv8.1-a}.
14818 @item crypto
14819 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14820 instructions.
14821 @item fp
14822 Enable floating-point instructions.  This is on by default for all possible
14823 values for options @option{-march} and @option{-mcpu}.
14824 @item simd
14825 Enable Advanced SIMD instructions.  This also enables floating-point
14826 instructions.  This is on by default for all possible values for options
14827 @option{-march} and @option{-mcpu}.
14828 @item sve
14829 Enable Scalable Vector Extension instructions.  This also enables Advanced
14830 SIMD and floating-point instructions.
14831 @item lse
14832 Enable Large System Extension instructions.  This is on by default for
14833 @option{-march=armv8.1-a}.
14834 @item rdma
14835 Enable Round Double Multiply Accumulate instructions.  This is on by default
14836 for @option{-march=armv8.1-a}.
14837 @item fp16
14838 Enable FP16 extension.  This also enables floating-point instructions.
14839 @item fp16fml
14840 Enable FP16 fmla extension.  This also enables FP16 extensions and
14841 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.
14843 @item rcpc
14844 Enable the RcPc extension.  This does not change code generation from GCC,
14845 but is passed on to the assembler, enabling inline asm statements to use
14846 instructions from the RcPc extension.
14847 @item dotprod
14848 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14849 @item aes
14850 Enable the Armv8-a aes and pmull crypto extension.  This also enables Advanced
14851 SIMD instructions.
14852 @item sha2
14853 Enable the Armv8-a sha2 crypto extension.  This also enables Advanced SIMD instructions.
14854 @item sha3
14855 Enable the sha512 and sha3 crypto extension.  This also enables Advanced SIMD
14856 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
14857 @item sm4
14858 Enable the sm3 and sm4 crypto extension.  This also enables Advanced SIMD instructions.
14859 Use of this option with architectures prior to Armv8.2-A is not supported.
14861 @end table
14863 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
14864 which implies @option{fp}.
14865 Conversely, @option{nofp} implies @option{nosimd}, which implies
14866 @option{nocrypto}, @option{noaes} and @option{nosha2}.
14868 @node Adapteva Epiphany Options
14869 @subsection Adapteva Epiphany Options
14871 These @samp{-m} options are defined for Adapteva Epiphany:
14873 @table @gcctabopt
14874 @item -mhalf-reg-file
14875 @opindex mhalf-reg-file
14876 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14877 That allows code to run on hardware variants that lack these registers.
14879 @item -mprefer-short-insn-regs
14880 @opindex mprefer-short-insn-regs
14881 Preferentially allocate registers that allow short instruction generation.
14882 This can result in increased instruction count, so this may either reduce or
14883 increase overall code size.
14885 @item -mbranch-cost=@var{num}
14886 @opindex mbranch-cost
14887 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14888 This cost is only a heuristic and is not guaranteed to produce
14889 consistent results across releases.
14891 @item -mcmove
14892 @opindex mcmove
14893 Enable the generation of conditional moves.
14895 @item -mnops=@var{num}
14896 @opindex mnops
14897 Emit @var{num} NOPs before every other generated instruction.
14899 @item -mno-soft-cmpsf
14900 @opindex mno-soft-cmpsf
14901 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14902 and test the flags.  This is faster than a software comparison, but can
14903 get incorrect results in the presence of NaNs, or when two different small
14904 numbers are compared such that their difference is calculated as zero.
14905 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14906 software comparisons.
14908 @item -mstack-offset=@var{num}
14909 @opindex mstack-offset
14910 Set the offset between the top of the stack and the stack pointer.
14911 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14912 can be used by leaf functions without stack allocation.
14913 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14914 Note also that this option changes the ABI; compiling a program with a
14915 different stack offset than the libraries have been compiled with
14916 generally does not work.
14917 This option can be useful if you want to evaluate if a different stack
14918 offset would give you better code, but to actually use a different stack
14919 offset to build working programs, it is recommended to configure the
14920 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14922 @item -mno-round-nearest
14923 @opindex mno-round-nearest
14924 Make the scheduler assume that the rounding mode has been set to
14925 truncating.  The default is @option{-mround-nearest}.
14927 @item -mlong-calls
14928 @opindex mlong-calls
14929 If not otherwise specified by an attribute, assume all calls might be beyond
14930 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14931 function address into a register before performing a (otherwise direct) call.
14932 This is the default.
14934 @item -mshort-calls
14935 @opindex short-calls
14936 If not otherwise specified by an attribute, assume all direct calls are
14937 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14938 for direct calls.  The default is @option{-mlong-calls}.
14940 @item -msmall16
14941 @opindex msmall16
14942 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14943 apply to function addresses for which @option{-mlong-calls} semantics
14944 are in effect.
14946 @item -mfp-mode=@var{mode}
14947 @opindex mfp-mode
14948 Set the prevailing mode of the floating-point unit.
14949 This determines the floating-point mode that is provided and expected
14950 at function call and return time.  Making this mode match the mode you
14951 predominantly need at function start can make your programs smaller and
14952 faster by avoiding unnecessary mode switches.
14954 @var{mode} can be set to one the following values:
14956 @table @samp
14957 @item caller
14958 Any mode at function entry is valid, and retained or restored when
14959 the function returns, and when it calls other functions.
14960 This mode is useful for compiling libraries or other compilation units
14961 you might want to incorporate into different programs with different
14962 prevailing FPU modes, and the convenience of being able to use a single
14963 object file outweighs the size and speed overhead for any extra
14964 mode switching that might be needed, compared with what would be needed
14965 with a more specific choice of prevailing FPU mode.
14967 @item truncate
14968 This is the mode used for floating-point calculations with
14969 truncating (i.e.@: round towards zero) rounding mode.  That includes
14970 conversion from floating point to integer.
14972 @item round-nearest
14973 This is the mode used for floating-point calculations with
14974 round-to-nearest-or-even rounding mode.
14976 @item int
14977 This is the mode used to perform integer calculations in the FPU, e.g.@:
14978 integer multiply, or integer multiply-and-accumulate.
14979 @end table
14981 The default is @option{-mfp-mode=caller}
14983 @item -mnosplit-lohi
14984 @itemx -mno-postinc
14985 @itemx -mno-postmodify
14986 @opindex mnosplit-lohi
14987 @opindex mno-postinc
14988 @opindex mno-postmodify
14989 Code generation tweaks that disable, respectively, splitting of 32-bit
14990 loads, generation of post-increment addresses, and generation of
14991 post-modify addresses.  The defaults are @option{msplit-lohi},
14992 @option{-mpost-inc}, and @option{-mpost-modify}.
14994 @item -mnovect-double
14995 @opindex mno-vect-double
14996 Change the preferred SIMD mode to SImode.  The default is
14997 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14999 @item -max-vect-align=@var{num}
15000 @opindex max-vect-align
15001 The maximum alignment for SIMD vector mode types.
15002 @var{num} may be 4 or 8.  The default is 8.
15003 Note that this is an ABI change, even though many library function
15004 interfaces are unaffected if they don't use SIMD vector modes
15005 in places that affect size and/or alignment of relevant types.
15007 @item -msplit-vecmove-early
15008 @opindex msplit-vecmove-early
15009 Split vector moves into single word moves before reload.  In theory this
15010 can give better register allocation, but so far the reverse seems to be
15011 generally the case.
15013 @item -m1reg-@var{reg}
15014 @opindex m1reg-
15015 Specify a register to hold the constant @minus{}1, which makes loading small negative
15016 constants and certain bitmasks faster.
15017 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
15018 which specify use of that register as a fixed register,
15019 and @samp{none}, which means that no register is used for this
15020 purpose.  The default is @option{-m1reg-none}.
15022 @end table
15024 @node ARC Options
15025 @subsection ARC Options
15026 @cindex ARC options
15028 The following options control the architecture variant for which code
15029 is being compiled:
15031 @c architecture variants
15032 @table @gcctabopt
15034 @item -mbarrel-shifter
15035 @opindex mbarrel-shifter
15036 Generate instructions supported by barrel shifter.  This is the default
15037 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
15039 @item -mjli-always
15040 @opindex mjli-alawys
15041 Force to call a function using jli_s instruction.  This option is
15042 valid only for ARCv2 architecture.
15044 @item -mcpu=@var{cpu}
15045 @opindex mcpu
15046 Set architecture type, register usage, and instruction scheduling
15047 parameters for @var{cpu}.  There are also shortcut alias options
15048 available for backward compatibility and convenience.  Supported
15049 values for @var{cpu} are
15051 @table @samp
15052 @opindex mA6
15053 @opindex mARC600
15054 @item arc600
15055 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
15057 @item arc601
15058 @opindex mARC601
15059 Compile for ARC601.  Alias: @option{-mARC601}.
15061 @item arc700
15062 @opindex mA7
15063 @opindex mARC700
15064 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
15065 This is the default when configured with @option{--with-cpu=arc700}@.
15067 @item arcem
15068 Compile for ARC EM.
15070 @item archs
15071 Compile for ARC HS.
15073 @item em
15074 Compile for ARC EM CPU with no hardware extensions.
15076 @item em4
15077 Compile for ARC EM4 CPU.
15079 @item em4_dmips
15080 Compile for ARC EM4 DMIPS CPU.
15082 @item em4_fpus
15083 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
15084 extension.
15086 @item em4_fpuda
15087 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
15088 double assist instructions.
15090 @item hs
15091 Compile for ARC HS CPU with no hardware extensions except the atomic
15092 instructions.
15094 @item hs34
15095 Compile for ARC HS34 CPU.
15097 @item hs38
15098 Compile for ARC HS38 CPU.
15100 @item hs38_linux
15101 Compile for ARC HS38 CPU with all hardware extensions on.
15103 @item arc600_norm
15104 Compile for ARC 600 CPU with @code{norm} instructions enabled.
15106 @item arc600_mul32x16
15107 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
15108 instructions enabled.
15110 @item arc600_mul64
15111 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
15112 instructions enabled.
15114 @item arc601_norm
15115 Compile for ARC 601 CPU with @code{norm} instructions enabled.
15117 @item arc601_mul32x16
15118 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
15119 instructions enabled.
15121 @item arc601_mul64
15122 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
15123 instructions enabled.
15125 @item nps400
15126 Compile for ARC 700 on NPS400 chip.
15128 @item em_mini
15129 Compile for ARC EM minimalist configuration featuring reduced register
15130 set.
15132 @end table
15134 @item -mdpfp
15135 @opindex mdpfp
15136 @itemx -mdpfp-compact
15137 @opindex mdpfp-compact
15138 Generate double-precision FPX instructions, tuned for the compact
15139 implementation.
15141 @item -mdpfp-fast
15142 @opindex mdpfp-fast
15143 Generate double-precision FPX instructions, tuned for the fast
15144 implementation.
15146 @item -mno-dpfp-lrsr
15147 @opindex mno-dpfp-lrsr
15148 Disable @code{lr} and @code{sr} instructions from using FPX extension
15149 aux registers.
15151 @item -mea
15152 @opindex mea
15153 Generate extended arithmetic instructions.  Currently only
15154 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
15155 supported.  This is always enabled for @option{-mcpu=ARC700}.
15157 @item -mno-mpy
15158 @opindex mno-mpy
15159 Do not generate @code{mpy}-family instructions for ARC700.  This option is
15160 deprecated.
15162 @item -mmul32x16
15163 @opindex mmul32x16
15164 Generate 32x16-bit multiply and multiply-accumulate instructions.
15166 @item -mmul64
15167 @opindex mmul64
15168 Generate @code{mul64} and @code{mulu64} instructions.  
15169 Only valid for @option{-mcpu=ARC600}.
15171 @item -mnorm
15172 @opindex mnorm
15173 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
15174 is in effect.
15176 @item -mspfp
15177 @opindex mspfp
15178 @itemx -mspfp-compact
15179 @opindex mspfp-compact
15180 Generate single-precision FPX instructions, tuned for the compact
15181 implementation.
15183 @item -mspfp-fast
15184 @opindex mspfp-fast
15185 Generate single-precision FPX instructions, tuned for the fast
15186 implementation.
15188 @item -msimd
15189 @opindex msimd
15190 Enable generation of ARC SIMD instructions via target-specific
15191 builtins.  Only valid for @option{-mcpu=ARC700}.
15193 @item -msoft-float
15194 @opindex msoft-float
15195 This option ignored; it is provided for compatibility purposes only.
15196 Software floating-point code is emitted by default, and this default
15197 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
15198 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
15199 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
15201 @item -mswap
15202 @opindex mswap
15203 Generate @code{swap} instructions.
15205 @item -matomic
15206 @opindex matomic
15207 This enables use of the locked load/store conditional extension to implement
15208 atomic memory built-in functions.  Not available for ARC 6xx or ARC
15209 EM cores.
15211 @item -mdiv-rem
15212 @opindex mdiv-rem
15213 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
15215 @item -mcode-density
15216 @opindex mcode-density
15217 Enable code density instructions for ARC EM.  
15218 This option is on by default for ARC HS.
15220 @item -mll64
15221 @opindex mll64
15222 Enable double load/store operations for ARC HS cores.
15224 @item -mtp-regno=@var{regno}
15225 @opindex mtp-regno
15226 Specify thread pointer register number.
15228 @item -mmpy-option=@var{multo}
15229 @opindex mmpy-option
15230 Compile ARCv2 code with a multiplier design option.  You can specify 
15231 the option using either a string or numeric value for @var{multo}.  
15232 @samp{wlh1} is the default value.  The recognized values are:
15234 @table @samp
15235 @item 0
15236 @itemx none
15237 No multiplier available.
15239 @item 1
15240 @itemx w
15241 16x16 multiplier, fully pipelined.
15242 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15244 @item 2
15245 @itemx wlh1
15246 32x32 multiplier, fully
15247 pipelined (1 stage).  The following instructions are additionally
15248 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15250 @item 3
15251 @itemx wlh2
15252 32x32 multiplier, fully pipelined
15253 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15254 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15256 @item 4
15257 @itemx wlh3
15258 Two 16x16 multipliers, blocking,
15259 sequential.  The following instructions are additionally enabled: @code{mpy},
15260 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15262 @item 5
15263 @itemx wlh4
15264 One 16x16 multiplier, blocking,
15265 sequential.  The following instructions are additionally enabled: @code{mpy},
15266 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15268 @item 6
15269 @itemx wlh5
15270 One 32x4 multiplier, blocking,
15271 sequential.  The following instructions are additionally enabled: @code{mpy},
15272 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15274 @item 7
15275 @itemx plus_dmpy
15276 ARC HS SIMD support.
15278 @item 8
15279 @itemx plus_macd
15280 ARC HS SIMD support.
15282 @item 9
15283 @itemx plus_qmacw
15284 ARC HS SIMD support.
15286 @end table
15288 This option is only available for ARCv2 cores@.
15290 @item -mfpu=@var{fpu}
15291 @opindex mfpu
15292 Enables support for specific floating-point hardware extensions for ARCv2
15293 cores.  Supported values for @var{fpu} are:
15295 @table @samp
15297 @item fpus
15298 Enables support for single-precision floating-point hardware
15299 extensions@.
15301 @item fpud
15302 Enables support for double-precision floating-point hardware
15303 extensions.  The single-precision floating-point extension is also
15304 enabled.  Not available for ARC EM@.
15306 @item fpuda
15307 Enables support for double-precision floating-point hardware
15308 extensions using double-precision assist instructions.  The single-precision
15309 floating-point extension is also enabled.  This option is
15310 only available for ARC EM@.
15312 @item fpuda_div
15313 Enables support for double-precision floating-point hardware
15314 extensions using double-precision assist instructions.
15315 The single-precision floating-point, square-root, and divide 
15316 extensions are also enabled.  This option is
15317 only available for ARC EM@.
15319 @item fpuda_fma
15320 Enables support for double-precision floating-point hardware
15321 extensions using double-precision assist instructions.
15322 The single-precision floating-point and fused multiply and add 
15323 hardware extensions are also enabled.  This option is
15324 only available for ARC EM@.
15326 @item fpuda_all
15327 Enables support for double-precision floating-point hardware
15328 extensions using double-precision assist instructions.
15329 All single-precision floating-point hardware extensions are also
15330 enabled.  This option is only available for ARC EM@.
15332 @item fpus_div
15333 Enables support for single-precision floating-point, square-root and divide 
15334 hardware extensions@.
15336 @item fpud_div
15337 Enables support for double-precision floating-point, square-root and divide 
15338 hardware extensions.  This option
15339 includes option @samp{fpus_div}. Not available for ARC EM@.
15341 @item fpus_fma
15342 Enables support for single-precision floating-point and 
15343 fused multiply and add hardware extensions@.
15345 @item fpud_fma
15346 Enables support for double-precision floating-point and 
15347 fused multiply and add hardware extensions.  This option
15348 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15350 @item fpus_all
15351 Enables support for all single-precision floating-point hardware
15352 extensions@.
15354 @item fpud_all
15355 Enables support for all single- and double-precision floating-point
15356 hardware extensions.  Not available for ARC EM@.
15358 @end table
15360 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15361 @opindex mirq-ctrl-saved
15362 Specifies general-purposes registers that the processor automatically
15363 saves/restores on interrupt entry and exit.  @var{register-range} is
15364 specified as two registers separated by a dash.  The register range
15365 always starts with @code{r0}, the upper limit is @code{fp} register.
15366 @var{blink} and @var{lp_count} are optional.  This option is only
15367 valid for ARC EM and ARC HS cores.
15369 @item -mrgf-banked-regs=@var{number}
15370 @opindex mrgf-banked-regs
15371 Specifies the number of registers replicated in second register bank
15372 on entry to fast interrupt.  Fast interrupts are interrupts with the
15373 highest priority level P0.  These interrupts save only PC and STATUS32
15374 registers to avoid memory transactions during interrupt entry and exit
15375 sequences.  Use this option when you are using fast interrupts in an
15376 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15378 @item -mlpc-width=@var{width}
15379 @opindex mlpc-width
15380 Specify the width of the @code{lp_count} register.  Valid values for
15381 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15382 fixed to 32 bits.  If the width is less than 32, the compiler does not
15383 attempt to transform loops in your program to use the zero-delay loop
15384 mechanism unless it is known that the @code{lp_count} register can
15385 hold the required loop-counter value.  Depending on the width
15386 specified, the compiler and run-time library might continue to use the
15387 loop mechanism for various needs.  This option defines macro
15388 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15390 @item -mrf16
15391 @opindex mrf16
15392 This option instructs the compiler to generate code for a 16-entry
15393 register file.  This option defines the @code{__ARC_RF16__}
15394 preprocessor macro.
15396 @end table
15398 The following options are passed through to the assembler, and also
15399 define preprocessor macro symbols.
15401 @c Flags used by the assembler, but for which we define preprocessor
15402 @c macro symbols as well.
15403 @table @gcctabopt
15404 @item -mdsp-packa
15405 @opindex mdsp-packa
15406 Passed down to the assembler to enable the DSP Pack A extensions.
15407 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15408 deprecated.
15410 @item -mdvbf
15411 @opindex mdvbf
15412 Passed down to the assembler to enable the dual Viterbi butterfly
15413 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15414 option is deprecated.
15416 @c ARC700 4.10 extension instruction
15417 @item -mlock
15418 @opindex mlock
15419 Passed down to the assembler to enable the locked load/store
15420 conditional extension.  Also sets the preprocessor symbol
15421 @code{__Xlock}.
15423 @item -mmac-d16
15424 @opindex mmac-d16
15425 Passed down to the assembler.  Also sets the preprocessor symbol
15426 @code{__Xxmac_d16}.  This option is deprecated.
15428 @item -mmac-24
15429 @opindex mmac-24
15430 Passed down to the assembler.  Also sets the preprocessor symbol
15431 @code{__Xxmac_24}.  This option is deprecated.
15433 @c ARC700 4.10 extension instruction
15434 @item -mrtsc
15435 @opindex mrtsc
15436 Passed down to the assembler to enable the 64-bit time-stamp counter
15437 extension instruction.  Also sets the preprocessor symbol
15438 @code{__Xrtsc}.  This option is deprecated.
15440 @c ARC700 4.10 extension instruction
15441 @item -mswape
15442 @opindex mswape
15443 Passed down to the assembler to enable the swap byte ordering
15444 extension instruction.  Also sets the preprocessor symbol
15445 @code{__Xswape}.
15447 @item -mtelephony
15448 @opindex mtelephony
15449 Passed down to the assembler to enable dual- and single-operand
15450 instructions for telephony.  Also sets the preprocessor symbol
15451 @code{__Xtelephony}.  This option is deprecated.
15453 @item -mxy
15454 @opindex mxy
15455 Passed down to the assembler to enable the XY memory extension.  Also
15456 sets the preprocessor symbol @code{__Xxy}.
15458 @end table
15460 The following options control how the assembly code is annotated:
15462 @c Assembly annotation options
15463 @table @gcctabopt
15464 @item -misize
15465 @opindex misize
15466 Annotate assembler instructions with estimated addresses.
15468 @item -mannotate-align
15469 @opindex mannotate-align
15470 Explain what alignment considerations lead to the decision to make an
15471 instruction short or long.
15473 @end table
15475 The following options are passed through to the linker:
15477 @c options passed through to the linker
15478 @table @gcctabopt
15479 @item -marclinux
15480 @opindex marclinux
15481 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15482 This option is enabled by default in tool chains built for
15483 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15484 when profiling is not requested.
15486 @item -marclinux_prof
15487 @opindex marclinux_prof
15488 Passed through to the linker, to specify use of the
15489 @code{arclinux_prof} emulation.  This option is enabled by default in
15490 tool chains built for @w{@code{arc-linux-uclibc}} and
15491 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15493 @end table
15495 The following options control the semantics of generated code:
15497 @c semantically relevant code generation options
15498 @table @gcctabopt
15499 @item -mlong-calls
15500 @opindex mlong-calls
15501 Generate calls as register indirect calls, thus providing access
15502 to the full 32-bit address range.
15504 @item -mmedium-calls
15505 @opindex mmedium-calls
15506 Don't use less than 25-bit addressing range for calls, which is the
15507 offset available for an unconditional branch-and-link
15508 instruction.  Conditional execution of function calls is suppressed, to
15509 allow use of the 25-bit range, rather than the 21-bit range with
15510 conditional branch-and-link.  This is the default for tool chains built
15511 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15513 @item -G @var{num}
15514 @opindex G
15515 Put definitions of externally-visible data in a small data section if
15516 that data is no bigger than @var{num} bytes.  The default value of
15517 @var{num} is 4 for any ARC configuration, or 8 when we have double
15518 load/store operations.
15520 @item -mno-sdata
15521 @opindex mno-sdata
15522 Do not generate sdata references.  This is the default for tool chains
15523 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15524 targets.
15526 @item -mvolatile-cache
15527 @opindex mvolatile-cache
15528 Use ordinarily cached memory accesses for volatile references.  This is the
15529 default.
15531 @item -mno-volatile-cache
15532 @opindex mno-volatile-cache
15533 Enable cache bypass for volatile references.
15535 @end table
15537 The following options fine tune code generation:
15538 @c code generation tuning options
15539 @table @gcctabopt
15540 @item -malign-call
15541 @opindex malign-call
15542 Do alignment optimizations for call instructions.
15544 @item -mauto-modify-reg
15545 @opindex mauto-modify-reg
15546 Enable the use of pre/post modify with register displacement.
15548 @item -mbbit-peephole
15549 @opindex mbbit-peephole
15550 Enable bbit peephole2.
15552 @item -mno-brcc
15553 @opindex mno-brcc
15554 This option disables a target-specific pass in @file{arc_reorg} to
15555 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15556 It has no effect on
15557 generation of these instructions driven by the combiner pass.
15559 @item -mcase-vector-pcrel
15560 @opindex mcase-vector-pcrel
15561 Use PC-relative switch case tables to enable case table shortening.
15562 This is the default for @option{-Os}.
15564 @item -mcompact-casesi
15565 @opindex mcompact-casesi
15566 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15567 and only available for ARCv1 cores.
15569 @item -mno-cond-exec
15570 @opindex mno-cond-exec
15571 Disable the ARCompact-specific pass to generate conditional 
15572 execution instructions.
15574 Due to delay slot scheduling and interactions between operand numbers,
15575 literal sizes, instruction lengths, and the support for conditional execution,
15576 the target-independent pass to generate conditional execution is often lacking,
15577 so the ARC port has kept a special pass around that tries to find more
15578 conditional execution generation opportunities after register allocation,
15579 branch shortening, and delay slot scheduling have been done.  This pass
15580 generally, but not always, improves performance and code size, at the cost of
15581 extra compilation time, which is why there is an option to switch it off.
15582 If you have a problem with call instructions exceeding their allowable
15583 offset range because they are conditionalized, you should consider using
15584 @option{-mmedium-calls} instead.
15586 @item -mearly-cbranchsi
15587 @opindex mearly-cbranchsi
15588 Enable pre-reload use of the @code{cbranchsi} pattern.
15590 @item -mexpand-adddi
15591 @opindex mexpand-adddi
15592 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15593 @code{add.f}, @code{adc} etc.  This option is deprecated.
15595 @item -mindexed-loads
15596 @opindex mindexed-loads
15597 Enable the use of indexed loads.  This can be problematic because some
15598 optimizers then assume that indexed stores exist, which is not
15599 the case.
15601 @item -mlra
15602 @opindex mlra
15603 Enable Local Register Allocation.  This is still experimental for ARC,
15604 so by default the compiler uses standard reload
15605 (i.e. @option{-mno-lra}).
15607 @item -mlra-priority-none
15608 @opindex mlra-priority-none
15609 Don't indicate any priority for target registers.
15611 @item -mlra-priority-compact
15612 @opindex mlra-priority-compact
15613 Indicate target register priority for r0..r3 / r12..r15.
15615 @item -mlra-priority-noncompact
15616 @opindex mlra-priority-noncompact
15617 Reduce target register priority for r0..r3 / r12..r15.
15619 @item -mno-millicode
15620 @opindex mno-millicode
15621 When optimizing for size (using @option{-Os}), prologues and epilogues
15622 that have to save or restore a large number of registers are often
15623 shortened by using call to a special function in libgcc; this is
15624 referred to as a @emph{millicode} call.  As these calls can pose
15625 performance issues, and/or cause linking issues when linking in a
15626 nonstandard way, this option is provided to turn off millicode call
15627 generation.
15629 @item -mmixed-code
15630 @opindex mmixed-code
15631 Tweak register allocation to help 16-bit instruction generation.
15632 This generally has the effect of decreasing the average instruction size
15633 while increasing the instruction count.
15635 @item -mq-class
15636 @opindex mq-class
15637 Enable @samp{q} instruction alternatives.
15638 This is the default for @option{-Os}.
15640 @item -mRcq
15641 @opindex mRcq
15642 Enable @samp{Rcq} constraint handling.  
15643 Most short code generation depends on this.
15644 This is the default.
15646 @item -mRcw
15647 @opindex mRcw
15648 Enable @samp{Rcw} constraint handling.  
15649 Most ccfsm condexec mostly depends on this.
15650 This is the default.
15652 @item -msize-level=@var{level}
15653 @opindex msize-level
15654 Fine-tune size optimization with regards to instruction lengths and alignment.
15655 The recognized values for @var{level} are:
15656 @table @samp
15657 @item 0
15658 No size optimization.  This level is deprecated and treated like @samp{1}.
15660 @item 1
15661 Short instructions are used opportunistically.
15663 @item 2
15664 In addition, alignment of loops and of code after barriers are dropped.
15666 @item 3
15667 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15669 @end table
15671 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15672 the behavior when this is not set is equivalent to level @samp{1}.
15674 @item -mtune=@var{cpu}
15675 @opindex mtune
15676 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15677 by @option{-mcpu=}.
15679 Supported values for @var{cpu} are
15681 @table @samp
15682 @item ARC600
15683 Tune for ARC600 CPU.
15685 @item ARC601
15686 Tune for ARC601 CPU.
15688 @item ARC700
15689 Tune for ARC700 CPU with standard multiplier block.
15691 @item ARC700-xmac
15692 Tune for ARC700 CPU with XMAC block.
15694 @item ARC725D
15695 Tune for ARC725D CPU.
15697 @item ARC750D
15698 Tune for ARC750D CPU.
15700 @end table
15702 @item -mmultcost=@var{num}
15703 @opindex mmultcost
15704 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15705 normal instruction.
15707 @item -munalign-prob-threshold=@var{probability}
15708 @opindex munalign-prob-threshold
15709 Set probability threshold for unaligning branches.
15710 When tuning for @samp{ARC700} and optimizing for speed, branches without
15711 filled delay slot are preferably emitted unaligned and long, unless
15712 profiling indicates that the probability for the branch to be taken
15713 is below @var{probability}.  @xref{Cross-profiling}.
15714 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15716 @end table
15718 The following options are maintained for backward compatibility, but
15719 are now deprecated and will be removed in a future release:
15721 @c Deprecated options
15722 @table @gcctabopt
15724 @item -margonaut
15725 @opindex margonaut
15726 Obsolete FPX.
15728 @item -mbig-endian
15729 @opindex mbig-endian
15730 @itemx -EB
15731 @opindex EB
15732 Compile code for big-endian targets.  Use of these options is now
15733 deprecated.  Big-endian code is supported by configuring GCC to build
15734 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15735 for which big endian is the default.
15737 @item -mlittle-endian
15738 @opindex mlittle-endian
15739 @itemx -EL
15740 @opindex EL
15741 Compile code for little-endian targets.  Use of these options is now
15742 deprecated.  Little-endian code is supported by configuring GCC to build 
15743 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15744 for which little endian is the default.
15746 @item -mbarrel_shifter
15747 @opindex mbarrel_shifter
15748 Replaced by @option{-mbarrel-shifter}.
15750 @item -mdpfp_compact
15751 @opindex mdpfp_compact
15752 Replaced by @option{-mdpfp-compact}.
15754 @item -mdpfp_fast
15755 @opindex mdpfp_fast
15756 Replaced by @option{-mdpfp-fast}.
15758 @item -mdsp_packa
15759 @opindex mdsp_packa
15760 Replaced by @option{-mdsp-packa}.
15762 @item -mEA
15763 @opindex mEA
15764 Replaced by @option{-mea}.
15766 @item -mmac_24
15767 @opindex mmac_24
15768 Replaced by @option{-mmac-24}.
15770 @item -mmac_d16
15771 @opindex mmac_d16
15772 Replaced by @option{-mmac-d16}.
15774 @item -mspfp_compact
15775 @opindex mspfp_compact
15776 Replaced by @option{-mspfp-compact}.
15778 @item -mspfp_fast
15779 @opindex mspfp_fast
15780 Replaced by @option{-mspfp-fast}.
15782 @item -mtune=@var{cpu}
15783 @opindex mtune
15784 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15785 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15786 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15788 @item -multcost=@var{num}
15789 @opindex multcost
15790 Replaced by @option{-mmultcost}.
15792 @end table
15794 @node ARM Options
15795 @subsection ARM Options
15796 @cindex ARM options
15798 These @samp{-m} options are defined for the ARM port:
15800 @table @gcctabopt
15801 @item -mabi=@var{name}
15802 @opindex mabi
15803 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15804 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15806 @item -mapcs-frame
15807 @opindex mapcs-frame
15808 Generate a stack frame that is compliant with the ARM Procedure Call
15809 Standard for all functions, even if this is not strictly necessary for
15810 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15811 with this option causes the stack frames not to be generated for
15812 leaf functions.  The default is @option{-mno-apcs-frame}.
15813 This option is deprecated.
15815 @item -mapcs
15816 @opindex mapcs
15817 This is a synonym for @option{-mapcs-frame} and is deprecated.
15819 @ignore
15820 @c not currently implemented
15821 @item -mapcs-stack-check
15822 @opindex mapcs-stack-check
15823 Generate code to check the amount of stack space available upon entry to
15824 every function (that actually uses some stack space).  If there is
15825 insufficient space available then either the function
15826 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15827 called, depending upon the amount of stack space required.  The runtime
15828 system is required to provide these functions.  The default is
15829 @option{-mno-apcs-stack-check}, since this produces smaller code.
15831 @c not currently implemented
15832 @item -mapcs-reentrant
15833 @opindex mapcs-reentrant
15834 Generate reentrant, position-independent code.  The default is
15835 @option{-mno-apcs-reentrant}.
15836 @end ignore
15838 @item -mthumb-interwork
15839 @opindex mthumb-interwork
15840 Generate code that supports calling between the ARM and Thumb
15841 instruction sets.  Without this option, on pre-v5 architectures, the
15842 two instruction sets cannot be reliably used inside one program.  The
15843 default is @option{-mno-thumb-interwork}, since slightly larger code
15844 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15845 configurations this option is meaningless.
15847 @item -mno-sched-prolog
15848 @opindex mno-sched-prolog
15849 Prevent the reordering of instructions in the function prologue, or the
15850 merging of those instruction with the instructions in the function's
15851 body.  This means that all functions start with a recognizable set
15852 of instructions (or in fact one of a choice from a small set of
15853 different function prologues), and this information can be used to
15854 locate the start of functions inside an executable piece of code.  The
15855 default is @option{-msched-prolog}.
15857 @item -mfloat-abi=@var{name}
15858 @opindex mfloat-abi
15859 Specifies which floating-point ABI to use.  Permissible values
15860 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15862 Specifying @samp{soft} causes GCC to generate output containing
15863 library calls for floating-point operations.
15864 @samp{softfp} allows the generation of code using hardware floating-point
15865 instructions, but still uses the soft-float calling conventions.
15866 @samp{hard} allows generation of floating-point instructions
15867 and uses FPU-specific calling conventions.
15869 The default depends on the specific target configuration.  Note that
15870 the hard-float and soft-float ABIs are not link-compatible; you must
15871 compile your entire program with the same ABI, and link with a
15872 compatible set of libraries.
15874 @item -mlittle-endian
15875 @opindex mlittle-endian
15876 Generate code for a processor running in little-endian mode.  This is
15877 the default for all standard configurations.
15879 @item -mbig-endian
15880 @opindex mbig-endian
15881 Generate code for a processor running in big-endian mode; the default is
15882 to compile code for a little-endian processor.
15884 @item -mbe8
15885 @itemx -mbe32
15886 @opindex mbe8
15887 When linking a big-endian image select between BE8 and BE32 formats.
15888 The option has no effect for little-endian images and is ignored.  The
15889 default is dependent on the selected target architecture.  For ARMv6
15890 and later architectures the default is BE8, for older architectures
15891 the default is BE32.  BE32 format has been deprecated by ARM.
15893 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15894 @opindex march
15895 This specifies the name of the target ARM architecture.  GCC uses this
15896 name to determine what kind of instructions it can emit when generating
15897 assembly code.  This option can be used in conjunction with or instead
15898 of the @option{-mcpu=} option.
15900 Permissible names are:
15901 @samp{armv4t},
15902 @samp{armv5t}, @samp{armv5te},
15903 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15904 @samp{armv6z}, @samp{armv6zk},
15905 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15906 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15907 @samp{armv8.4-a},
15908 @samp{armv7-r},
15909 @samp{armv8-r},
15910 @samp{armv6-m}, @samp{armv6s-m},
15911 @samp{armv7-m}, @samp{armv7e-m},
15912 @samp{armv8-m.base}, @samp{armv8-m.main},
15913 @samp{iwmmxt} and @samp{iwmmxt2}.
15915 Additionally, the following architectures, which lack support for the
15916 Thumb execution state, are recognized but support is deprecated: @samp{armv4}.
15918 Many of the architectures support extensions.  These can be added by
15919 appending @samp{+@var{extension}} to the architecture name.  Extension
15920 options are processed in order and capabilities accumulate.  An extension
15921 will also enable any necessary base extensions
15922 upon which it depends.  For example, the @samp{+crypto} extension
15923 will always enable the @samp{+simd} extension.  The exception to the
15924 additive construction is for extensions that are prefixed with
15925 @samp{+no@dots{}}: these extensions disable the specified option and
15926 any other extensions that may depend on the presence of that
15927 extension.
15929 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15930 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15931 entirely disabled by the @samp{+nofp} option that follows it.
15933 Most extension names are generically named, but have an effect that is
15934 dependent upon the architecture to which it is applied.  For example,
15935 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15936 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15937 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15938 variant for @samp{armv8-a}.
15940 The table below lists the supported extensions for each architecture.
15941 Architectures not mentioned do not support any extensions.
15943 @table @samp
15944 @itemx armv5te
15945 @itemx armv6
15946 @itemx armv6j
15947 @itemx armv6k
15948 @itemx armv6kz
15949 @itemx armv6t2
15950 @itemx armv6z
15951 @itemx armv6zk
15952 @table @samp
15953 @item +fp
15954 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15955 used as an alias for this extension.
15957 @item +nofp
15958 Disable the floating-point instructions.
15959 @end table
15961 @item armv7
15962 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15963 @table @samp
15964 @item +fp
15965 The VFPv3 floating-point instructions, with 16 double-precision
15966 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15967 for this extension.  Note that floating-point is not supported by the
15968 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15969 ARMv7-R architectures.
15971 @item +nofp
15972 Disable the floating-point instructions.
15973 @end table
15975 @item armv7-a
15976 @table @samp
15977 @item +fp
15978 The VFPv3 floating-point instructions, with 16 double-precision
15979 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15980 for this extension.
15982 @item +simd
15983 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15984 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15985 for this extension.
15987 @item +vfpv3
15988 The VFPv3 floating-point instructions, with 32 double-precision
15989 registers.
15991 @item +vfpv3-d16-fp16
15992 The VFPv3 floating-point instructions, with 16 double-precision
15993 registers and the half-precision floating-point conversion operations.
15995 @item +vfpv3-fp16
15996 The VFPv3 floating-point instructions, with 32 double-precision
15997 registers and the half-precision floating-point conversion operations.
15999 @item +vfpv4-d16
16000 The VFPv4 floating-point instructions, with 16 double-precision
16001 registers.
16003 @item +vfpv4
16004 The VFPv4 floating-point instructions, with 32 double-precision
16005 registers.
16007 @item +neon-fp16
16008 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16009 the half-precision floating-point conversion operations.
16011 @item +neon-vfpv4
16012 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
16014 @item +nosimd
16015 Disable the Advanced SIMD instructions (does not disable floating point).
16017 @item +nofp
16018 Disable the floating-point and Advanced SIMD instructions.
16019 @end table
16021 @item armv7ve
16022 The extended version of the ARMv7-A architecture with support for
16023 virtualization.
16024 @table @samp
16025 @item +fp
16026 The VFPv4 floating-point instructions, with 16 double-precision registers.
16027 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
16029 @item +simd
16030 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
16031 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
16033 @item +vfpv3-d16
16034 The VFPv3 floating-point instructions, with 16 double-precision
16035 registers.
16037 @item +vfpv3
16038 The VFPv3 floating-point instructions, with 32 double-precision
16039 registers.
16041 @item +vfpv3-d16-fp16
16042 The VFPv3 floating-point instructions, with 16 double-precision
16043 registers and the half-precision floating-point conversion operations.
16045 @item +vfpv3-fp16
16046 The VFPv3 floating-point instructions, with 32 double-precision
16047 registers and the half-precision floating-point conversion operations.
16049 @item +vfpv4-d16
16050 The VFPv4 floating-point instructions, with 16 double-precision
16051 registers.
16053 @item +vfpv4
16054 The VFPv4 floating-point instructions, with 32 double-precision
16055 registers.
16057 @item +neon
16058 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16059 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
16061 @item +neon-fp16
16062 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16063 the half-precision floating-point conversion operations.
16065 @item +nosimd
16066 Disable the Advanced SIMD instructions (does not disable floating point).
16068 @item +nofp
16069 Disable the floating-point and Advanced SIMD instructions.
16070 @end table
16072 @item armv8-a
16073 @table @samp
16074 @item +crc
16075 The Cyclic Redundancy Check (CRC) instructions.
16076 @item +simd
16077 The ARMv8-A Advanced SIMD and floating-point instructions.
16078 @item +crypto
16079 The cryptographic instructions.
16080 @item +nocrypto
16081 Disable the cryptographic instructions.
16082 @item +nofp
16083 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16084 @end table
16086 @item armv8.1-a
16087 @table @samp
16088 @item +simd
16089 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16091 @item +crypto
16092 The cryptographic instructions.  This also enables the Advanced SIMD and
16093 floating-point instructions.
16095 @item +nocrypto
16096 Disable the cryptographic instructions.
16098 @item +nofp
16099 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16100 @end table
16102 @item armv8.2-a
16103 @itemx armv8.3-a
16104 @table @samp
16105 @item +fp16
16106 The half-precision floating-point data processing instructions.
16107 This also enables the Advanced SIMD and floating-point instructions.
16109 @item +fp16fml
16110 The half-precision floating-point fmla extension.  This also enables
16111 the half-precision floating-point extension and Advanced SIMD and
16112 floating-point instructions.
16114 @item +simd
16115 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16117 @item +crypto
16118 The cryptographic instructions.  This also enables the Advanced SIMD and
16119 floating-point instructions.
16121 @item +dotprod
16122 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
16124 @item +nocrypto
16125 Disable the cryptographic extension.
16127 @item +nofp
16128 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16129 @end table
16131 @item armv8.4-a
16132 @table @samp
16133 @item +fp16
16134 The half-precision floating-point data processing instructions.
16135 This also enables the Advanced SIMD and floating-point instructions as well
16136 as the Dot Product extension and the half-precision floating-point fmla
16137 extension.
16139 @item +simd
16140 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
16141 Dot Product extension.
16143 @item +crypto
16144 The cryptographic instructions.  This also enables the Advanced SIMD and
16145 floating-point instructions as well as the Dot Product extension.
16147 @item +nocrypto
16148 Disable the cryptographic extension.
16150 @item +nofp
16151 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16152 @end table
16154 @item armv7-r
16155 @table @samp
16156 @item +fp.sp
16157 The single-precision VFPv3 floating-point instructions.  The extension
16158 @samp{+vfpv3xd} can be used as an alias for this extension.
16160 @item +fp
16161 The VFPv3 floating-point instructions with 16 double-precision registers.
16162 The extension +vfpv3-d16 can be used as an alias for this extension.
16164 @item +nofp
16165 Disable the floating-point extension.
16167 @item +idiv
16168 The ARM-state integer division instructions.
16170 @item +noidiv
16171 Disable the ARM-state integer division extension.
16172 @end table
16174 @item armv7e-m
16175 @table @samp
16176 @item +fp
16177 The single-precision VFPv4 floating-point instructions.
16179 @item +fpv5
16180 The single-precision FPv5 floating-point instructions.
16182 @item +fp.dp
16183 The single- and double-precision FPv5 floating-point instructions.
16185 @item +nofp
16186 Disable the floating-point extensions.
16187 @end table
16189 @item  armv8-m.main
16190 @table @samp
16191 @item +dsp
16192 The DSP instructions.
16194 @item +nodsp
16195 Disable the DSP extension.
16197 @item +fp
16198 The single-precision floating-point instructions.
16200 @item +fp.dp
16201 The single- and double-precision floating-point instructions.
16203 @item +nofp
16204 Disable the floating-point extension.
16205 @end table
16207 @item armv8-r
16208 @table @samp
16209 @item +crc
16210 The Cyclic Redundancy Check (CRC) instructions.
16211 @item +fp.sp
16212 The single-precision FPv5 floating-point instructions.
16213 @item +simd
16214 The ARMv8-A Advanced SIMD and floating-point instructions.
16215 @item +crypto
16216 The cryptographic instructions.
16217 @item +nocrypto
16218 Disable the cryptographic instructions.
16219 @item +nofp
16220 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16221 @end table
16223 @end table
16225 @option{-march=native} causes the compiler to auto-detect the architecture
16226 of the build computer.  At present, this feature is only supported on
16227 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16228 is unsuccessful the option has no effect.
16230 @item -mtune=@var{name}
16231 @opindex mtune
16232 This option specifies the name of the target ARM processor for
16233 which GCC should tune the performance of the code.
16234 For some ARM implementations better performance can be obtained by using
16235 this option.
16236 Permissible names are: @samp{arm2}, @samp{arm250},
16237 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
16238 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
16239 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
16240 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
16241 @samp{arm720},
16242 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
16243 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
16244 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
16245 @samp{strongarm1110},
16246 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
16247 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
16248 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
16249 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
16250 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
16251 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
16252 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
16253 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
16254 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
16255 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
16256 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
16257 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
16258 @samp{cortex-r8}, @samp{cortex-r52},
16259 @samp{cortex-m33},
16260 @samp{cortex-m23},
16261 @samp{cortex-m7},
16262 @samp{cortex-m4},
16263 @samp{cortex-m3},
16264 @samp{cortex-m1},
16265 @samp{cortex-m0},
16266 @samp{cortex-m0plus},
16267 @samp{cortex-m1.small-multiply},
16268 @samp{cortex-m0.small-multiply},
16269 @samp{cortex-m0plus.small-multiply},
16270 @samp{exynos-m1},
16271 @samp{marvell-pj4},
16272 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
16273 @samp{fa526}, @samp{fa626},
16274 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16275 @samp{xgene1}.
16277 Additionally, this option can specify that GCC should tune the performance
16278 of the code for a big.LITTLE system.  Permissible names are:
16279 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16280 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16281 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16282 @samp{cortex-a75.cortex-a55}.
16284 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16285 performance for a blend of processors within architecture @var{arch}.
16286 The aim is to generate code that run well on the current most popular
16287 processors, balancing between optimizations that benefit some CPUs in the
16288 range, and avoiding performance pitfalls of other CPUs.  The effects of
16289 this option may change in future GCC versions as CPU models come and go.
16291 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16292 the extension options do not affect the tuning of the generated code.
16294 @option{-mtune=native} causes the compiler to auto-detect the CPU
16295 of the build computer.  At present, this feature is only supported on
16296 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16297 unsuccessful the option has no effect.
16299 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16300 @opindex mcpu
16301 This specifies the name of the target ARM processor.  GCC uses this name
16302 to derive the name of the target ARM architecture (as if specified
16303 by @option{-march}) and the ARM processor type for which to tune for
16304 performance (as if specified by @option{-mtune}).  Where this option
16305 is used in conjunction with @option{-march} or @option{-mtune},
16306 those options take precedence over the appropriate part of this option.
16308 Many of the supported CPUs implement optional architectural
16309 extensions.  Where this is so the architectural extensions are
16310 normally enabled by default.  If implementations that lack the
16311 extension exist, then the extension syntax can be used to disable
16312 those extensions that have been omitted.  For floating-point and
16313 Advanced SIMD (Neon) instructions, the settings of the options
16314 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16315 floating-point and Advanced SIMD instructions will only be used if
16316 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16317 @option{-mfpu} other than @samp{auto} will override the available
16318 floating-point and SIMD extension instructions.
16320 For example, @samp{cortex-a9} can be found in three major
16321 configurations: integer only, with just a floating-point unit or with
16322 floating-point and Advanced SIMD.  The default is to enable all the
16323 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16324 be used to disable just the SIMD or both the SIMD and floating-point
16325 instructions respectively.
16327 Permissible names for this option are the same as those for
16328 @option{-mtune}.
16330 The following extension options are common to the listed CPUs:
16332 @table @samp
16333 @item +nodsp
16334 Disable the DSP instructions on @samp{cortex-m33}.
16336 @item  +nofp
16337 Disables the floating-point instructions on @samp{arm9e},
16338 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16339 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16340 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16341 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16342 Disables the floating-point and SIMD instructions on
16343 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16344 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16345 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16346 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16347 @samp{cortex-a53} and @samp{cortex-a55}.
16349 @item +nofp.dp
16350 Disables the double-precision component of the floating-point instructions
16351 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16353 @item +nosimd
16354 Disables the SIMD (but not floating-point) instructions on
16355 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16356 and @samp{cortex-a9}.
16358 @item +crypto
16359 Enables the cryptographic instructions on @samp{cortex-a32},
16360 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16361 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16362 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16363 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16364 @samp{cortex-a75.cortex-a55}.
16365 @end table
16367 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16368 VFPv3 with 16 double-precision registers.  It supports the following
16369 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16370 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16371 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16372 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16373 @option{-march=armv7-a}.
16375 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16376 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16377 See @option{-mtune} for more information.
16379 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16380 of the build computer.  At present, this feature is only supported on
16381 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16382 is unsuccessful the option has no effect.
16384 @item -mfpu=@var{name}
16385 @opindex mfpu
16386 This specifies what floating-point hardware (or hardware emulation) is
16387 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16388 @samp{vfpv3},
16389 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16390 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16391 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16392 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16393 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16394 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16395 is an alias for @samp{vfpv2}.
16397 The setting @samp{auto} is the default and is special.  It causes the
16398 compiler to select the floating-point and Advanced SIMD instructions
16399 based on the settings of @option{-mcpu} and @option{-march}.
16401 If the selected floating-point hardware includes the NEON extension
16402 (e.g. @option{-mfpu=neon}), note that floating-point
16403 operations are not generated by GCC's auto-vectorization pass unless
16404 @option{-funsafe-math-optimizations} is also specified.  This is
16405 because NEON hardware does not fully implement the IEEE 754 standard for
16406 floating-point arithmetic (in particular denormal values are treated as
16407 zero), so the use of NEON instructions may lead to a loss of precision.
16409 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}).
16411 @item -mfp16-format=@var{name}
16412 @opindex mfp16-format
16413 Specify the format of the @code{__fp16} half-precision floating-point type.
16414 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16415 the default is @samp{none}, in which case the @code{__fp16} type is not
16416 defined.  @xref{Half-Precision}, for more information.
16418 @item -mstructure-size-boundary=@var{n}
16419 @opindex mstructure-size-boundary
16420 The sizes of all structures and unions are rounded up to a multiple
16421 of the number of bits set by this option.  Permissible values are 8, 32
16422 and 64.  The default value varies for different toolchains.  For the COFF
16423 targeted toolchain the default value is 8.  A value of 64 is only allowed
16424 if the underlying ABI supports it.
16426 Specifying a larger number can produce faster, more efficient code, but
16427 can also increase the size of the program.  Different values are potentially
16428 incompatible.  Code compiled with one value cannot necessarily expect to
16429 work with code or libraries compiled with another value, if they exchange
16430 information using structures or unions.
16432 This option is deprecated.
16434 @item -mabort-on-noreturn
16435 @opindex mabort-on-noreturn
16436 Generate a call to the function @code{abort} at the end of a
16437 @code{noreturn} function.  It is executed if the function tries to
16438 return.
16440 @item -mlong-calls
16441 @itemx -mno-long-calls
16442 @opindex mlong-calls
16443 @opindex mno-long-calls
16444 Tells the compiler to perform function calls by first loading the
16445 address of the function into a register and then performing a subroutine
16446 call on this register.  This switch is needed if the target function
16447 lies outside of the 64-megabyte addressing range of the offset-based
16448 version of subroutine call instruction.
16450 Even if this switch is enabled, not all function calls are turned
16451 into long calls.  The heuristic is that static functions, functions
16452 that have the @code{short_call} attribute, functions that are inside
16453 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16454 definitions have already been compiled within the current compilation
16455 unit are not turned into long calls.  The exceptions to this rule are
16456 that weak function definitions, functions with the @code{long_call}
16457 attribute or the @code{section} attribute, and functions that are within
16458 the scope of a @code{#pragma long_calls} directive are always
16459 turned into long calls.
16461 This feature is not enabled by default.  Specifying
16462 @option{-mno-long-calls} restores the default behavior, as does
16463 placing the function calls within the scope of a @code{#pragma
16464 long_calls_off} directive.  Note these switches have no effect on how
16465 the compiler generates code to handle function calls via function
16466 pointers.
16468 @item -msingle-pic-base
16469 @opindex msingle-pic-base
16470 Treat the register used for PIC addressing as read-only, rather than
16471 loading it in the prologue for each function.  The runtime system is
16472 responsible for initializing this register with an appropriate value
16473 before execution begins.
16475 @item -mpic-register=@var{reg}
16476 @opindex mpic-register
16477 Specify the register to be used for PIC addressing.
16478 For standard PIC base case, the default is any suitable register
16479 determined by compiler.  For single PIC base case, the default is
16480 @samp{R9} if target is EABI based or stack-checking is enabled,
16481 otherwise the default is @samp{R10}.
16483 @item -mpic-data-is-text-relative
16484 @opindex mpic-data-is-text-relative
16485 Assume that the displacement between the text and data segments is fixed
16486 at static link time.  This permits using PC-relative addressing
16487 operations to access data known to be in the data segment.  For
16488 non-VxWorks RTP targets, this option is enabled by default.  When
16489 disabled on such targets, it will enable @option{-msingle-pic-base} by
16490 default.
16492 @item -mpoke-function-name
16493 @opindex mpoke-function-name
16494 Write the name of each function into the text section, directly
16495 preceding the function prologue.  The generated code is similar to this:
16497 @smallexample
16498      t0
16499          .ascii "arm_poke_function_name", 0
16500          .align
16501      t1
16502          .word 0xff000000 + (t1 - t0)
16503      arm_poke_function_name
16504          mov     ip, sp
16505          stmfd   sp!, @{fp, ip, lr, pc@}
16506          sub     fp, ip, #4
16507 @end smallexample
16509 When performing a stack backtrace, code can inspect the value of
16510 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16511 location @code{pc - 12} and the top 8 bits are set, then we know that
16512 there is a function name embedded immediately preceding this location
16513 and has length @code{((pc[-3]) & 0xff000000)}.
16515 @item -mthumb
16516 @itemx -marm
16517 @opindex marm
16518 @opindex mthumb
16520 Select between generating code that executes in ARM and Thumb
16521 states.  The default for most configurations is to generate code
16522 that executes in ARM state, but the default can be changed by
16523 configuring GCC with the @option{--with-mode=}@var{state}
16524 configure option.
16526 You can also override the ARM and Thumb mode for each function
16527 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16528 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16530 @item -mflip-thumb 
16531 @opindex mflip-thumb
16532 Switch ARM/Thumb modes on alternating functions.
16533 This option is provided for regression testing of mixed Thumb/ARM code
16534 generation, and is not intended for ordinary use in compiling code.
16536 @item -mtpcs-frame
16537 @opindex mtpcs-frame
16538 Generate a stack frame that is compliant with the Thumb Procedure Call
16539 Standard for all non-leaf functions.  (A leaf function is one that does
16540 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16542 @item -mtpcs-leaf-frame
16543 @opindex mtpcs-leaf-frame
16544 Generate a stack frame that is compliant with the Thumb Procedure Call
16545 Standard for all leaf functions.  (A leaf function is one that does
16546 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16548 @item -mcallee-super-interworking
16549 @opindex mcallee-super-interworking
16550 Gives all externally visible functions in the file being compiled an ARM
16551 instruction set header which switches to Thumb mode before executing the
16552 rest of the function.  This allows these functions to be called from
16553 non-interworking code.  This option is not valid in AAPCS configurations
16554 because interworking is enabled by default.
16556 @item -mcaller-super-interworking
16557 @opindex mcaller-super-interworking
16558 Allows calls via function pointers (including virtual functions) to
16559 execute correctly regardless of whether the target code has been
16560 compiled for interworking or not.  There is a small overhead in the cost
16561 of executing a function pointer if this option is enabled.  This option
16562 is not valid in AAPCS configurations because interworking is enabled
16563 by default.
16565 @item -mtp=@var{name}
16566 @opindex mtp
16567 Specify the access model for the thread local storage pointer.  The valid
16568 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16569 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16570 (supported in the arm6k architecture), and @samp{auto}, which uses the
16571 best available method for the selected processor.  The default setting is
16572 @samp{auto}.
16574 @item -mtls-dialect=@var{dialect}
16575 @opindex mtls-dialect
16576 Specify the dialect to use for accessing thread local storage.  Two
16577 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16578 @samp{gnu} dialect selects the original GNU scheme for supporting
16579 local and global dynamic TLS models.  The @samp{gnu2} dialect
16580 selects the GNU descriptor scheme, which provides better performance
16581 for shared libraries.  The GNU descriptor scheme is compatible with
16582 the original scheme, but does require new assembler, linker and
16583 library support.  Initial and local exec TLS models are unaffected by
16584 this option and always use the original scheme.
16586 @item -mword-relocations
16587 @opindex mword-relocations
16588 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16589 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16590 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16591 is specified.
16593 @item -mfix-cortex-m3-ldrd
16594 @opindex mfix-cortex-m3-ldrd
16595 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16596 with overlapping destination and base registers are used.  This option avoids
16597 generating these instructions.  This option is enabled by default when
16598 @option{-mcpu=cortex-m3} is specified.
16600 @item -munaligned-access
16601 @itemx -mno-unaligned-access
16602 @opindex munaligned-access
16603 @opindex mno-unaligned-access
16604 Enables (or disables) reading and writing of 16- and 32- bit values
16605 from addresses that are not 16- or 32- bit aligned.  By default
16606 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16607 ARMv8-M Baseline architectures, and enabled for all other
16608 architectures.  If unaligned access is not enabled then words in packed
16609 data structures are accessed a byte at a time.
16611 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16612 generated object file to either true or false, depending upon the
16613 setting of this option.  If unaligned access is enabled then the
16614 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16615 defined.
16617 @item -mneon-for-64bits
16618 @opindex mneon-for-64bits
16619 Enables using Neon to handle scalar 64-bits operations. This is
16620 disabled by default since the cost of moving data from core registers
16621 to Neon is high.
16623 @item -mslow-flash-data
16624 @opindex mslow-flash-data
16625 Assume loading data from flash is slower than fetching instruction.
16626 Therefore literal load is minimized for better performance.
16627 This option is only supported when compiling for ARMv7 M-profile and
16628 off by default.
16630 @item -masm-syntax-unified
16631 @opindex masm-syntax-unified
16632 Assume inline assembler is using unified asm syntax.  The default is
16633 currently off which implies divided syntax.  This option has no impact
16634 on Thumb2. However, this may change in future releases of GCC.
16635 Divided syntax should be considered deprecated.
16637 @item -mrestrict-it
16638 @opindex mrestrict-it
16639 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16640 IT blocks can only contain a single 16-bit instruction from a select
16641 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16643 @item -mprint-tune-info
16644 @opindex mprint-tune-info
16645 Print CPU tuning information as comment in assembler file.  This is
16646 an option used only for regression testing of the compiler and not
16647 intended for ordinary use in compiling code.  This option is disabled
16648 by default.
16650 @item -mverbose-cost-dump
16651 @opindex mverbose-cost-dump
16652 Enable verbose cost model dumping in the debug dump files.  This option is
16653 provided for use in debugging the compiler.
16655 @item -mpure-code
16656 @opindex mpure-code
16657 Do not allow constant data to be placed in code sections.
16658 Additionally, when compiling for ELF object format give all text sections the
16659 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16660 is only available when generating non-pic code for M-profile targets with the
16661 MOVT instruction.
16663 @item -mcmse
16664 @opindex mcmse
16665 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16666 Development Tools Engineering Specification", which can be found on
16667 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16668 @end table
16670 @node AVR Options
16671 @subsection AVR Options
16672 @cindex AVR Options
16674 These options are defined for AVR implementations:
16676 @table @gcctabopt
16677 @item -mmcu=@var{mcu}
16678 @opindex mmcu
16679 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16681 The default for this option is@tie{}@samp{avr2}.
16683 GCC supports the following AVR devices and ISAs:
16685 @include avr-mmcu.texi
16687 @item -mabsdata
16688 @opindex mabsdata
16690 Assume that all data in static storage can be accessed by LDS / STS
16691 instructions.  This option has only an effect on reduced Tiny devices like
16692 ATtiny40.  See also the @code{absdata}
16693 @ref{AVR Variable Attributes,variable attribute}.
16695 @item -maccumulate-args
16696 @opindex maccumulate-args
16697 Accumulate outgoing function arguments and acquire/release the needed
16698 stack space for outgoing function arguments once in function
16699 prologue/epilogue.  Without this option, outgoing arguments are pushed
16700 before calling a function and popped afterwards.
16702 Popping the arguments after the function call can be expensive on
16703 AVR so that accumulating the stack space might lead to smaller
16704 executables because arguments need not be removed from the
16705 stack after such a function call.
16707 This option can lead to reduced code size for functions that perform
16708 several calls to functions that get their arguments on the stack like
16709 calls to printf-like functions.
16711 @item -mbranch-cost=@var{cost}
16712 @opindex mbranch-cost
16713 Set the branch costs for conditional branch instructions to
16714 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16715 integers. The default branch cost is 0.
16717 @item -mcall-prologues
16718 @opindex mcall-prologues
16719 Functions prologues/epilogues are expanded as calls to appropriate
16720 subroutines.  Code size is smaller.
16722 @item -mgas-isr-prologues
16723 @opindex mgas-isr-prologues
16724 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16725 instruction supported by GNU Binutils.
16726 If this option is on, the feature can still be disabled for individual
16727 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16728 function attribute.  This feature is activated per default
16729 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16730 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16732 @item -mint8
16733 @opindex mint8
16734 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16735 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16736 and @code{long long} is 4 bytes.  Please note that this option does not
16737 conform to the C standards, but it results in smaller code
16738 size.
16740 @item -mmain-is-OS_task
16741 @opindex mmain-is-OS_task
16742 Do not save registers in @code{main}.  The effect is the same like
16743 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
16744 to @code{main}. It is activated per default if optimization is on.
16746 @item -mn-flash=@var{num}
16747 @opindex mn-flash
16748 Assume that the flash memory has a size of 
16749 @var{num} times 64@tie{}KiB.
16751 @item -mno-interrupts
16752 @opindex mno-interrupts
16753 Generated code is not compatible with hardware interrupts.
16754 Code size is smaller.
16756 @item -mrelax
16757 @opindex mrelax
16758 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16759 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16760 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16761 the assembler's command line and the @option{--relax} option to the
16762 linker's command line.
16764 Jump relaxing is performed by the linker because jump offsets are not
16765 known before code is located. Therefore, the assembler code generated by the
16766 compiler is the same, but the instructions in the executable may
16767 differ from instructions in the assembler code.
16769 Relaxing must be turned on if linker stubs are needed, see the
16770 section on @code{EIND} and linker stubs below.
16772 @item -mrmw
16773 @opindex mrmw
16774 Assume that the device supports the Read-Modify-Write
16775 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16777 @item -mshort-calls
16778 @opindex mshort-calls
16780 Assume that @code{RJMP} and @code{RCALL} can target the whole
16781 program memory.
16783 This option is used internally for multilib selection.  It is
16784 not an optimization option, and you don't need to set it by hand.
16786 @item -msp8
16787 @opindex msp8
16788 Treat the stack pointer register as an 8-bit register,
16789 i.e.@: assume the high byte of the stack pointer is zero.
16790 In general, you don't need to set this option by hand.
16792 This option is used internally by the compiler to select and
16793 build multilibs for architectures @code{avr2} and @code{avr25}.
16794 These architectures mix devices with and without @code{SPH}.
16795 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16796 the compiler driver adds or removes this option from the compiler
16797 proper's command line, because the compiler then knows if the device
16798 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16799 register or not.
16801 @item -mstrict-X
16802 @opindex mstrict-X
16803 Use address register @code{X} in a way proposed by the hardware.  This means
16804 that @code{X} is only used in indirect, post-increment or
16805 pre-decrement addressing.
16807 Without this option, the @code{X} register may be used in the same way
16808 as @code{Y} or @code{Z} which then is emulated by additional
16809 instructions.  
16810 For example, loading a value with @code{X+const} addressing with a
16811 small non-negative @code{const < 64} to a register @var{Rn} is
16812 performed as
16814 @example
16815 adiw r26, const   ; X += const
16816 ld   @var{Rn}, X        ; @var{Rn} = *X
16817 sbiw r26, const   ; X -= const
16818 @end example
16820 @item -mtiny-stack
16821 @opindex mtiny-stack
16822 Only change the lower 8@tie{}bits of the stack pointer.
16824 @item -mfract-convert-truncate
16825 @opindex mfract-convert-truncate
16826 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16828 @item -nodevicelib
16829 @opindex nodevicelib
16830 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16832 @item -Waddr-space-convert
16833 @opindex Waddr-space-convert
16834 Warn about conversions between address spaces in the case where the
16835 resulting address space is not contained in the incoming address space.
16837 @item -Wmisspelled-isr
16838 @opindex Wmisspelled-isr
16839 Warn if the ISR is misspelled, i.e. without __vector prefix.
16840 Enabled by default.
16841 @end table
16843 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16844 @cindex @code{EIND}
16845 Pointers in the implementation are 16@tie{}bits wide.
16846 The address of a function or label is represented as word address so
16847 that indirect jumps and calls can target any code address in the
16848 range of 64@tie{}Ki words.
16850 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16851 bytes of program memory space, there is a special function register called
16852 @code{EIND} that serves as most significant part of the target address
16853 when @code{EICALL} or @code{EIJMP} instructions are used.
16855 Indirect jumps and calls on these devices are handled as follows by
16856 the compiler and are subject to some limitations:
16858 @itemize @bullet
16860 @item
16861 The compiler never sets @code{EIND}.
16863 @item
16864 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16865 instructions or might read @code{EIND} directly in order to emulate an
16866 indirect call/jump by means of a @code{RET} instruction.
16868 @item
16869 The compiler assumes that @code{EIND} never changes during the startup
16870 code or during the application. In particular, @code{EIND} is not
16871 saved/restored in function or interrupt service routine
16872 prologue/epilogue.
16874 @item
16875 For indirect calls to functions and computed goto, the linker
16876 generates @emph{stubs}. Stubs are jump pads sometimes also called
16877 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16878 The stub contains a direct jump to the desired address.
16880 @item
16881 Linker relaxation must be turned on so that the linker generates
16882 the stubs correctly in all situations. See the compiler option
16883 @option{-mrelax} and the linker option @option{--relax}.
16884 There are corner cases where the linker is supposed to generate stubs
16885 but aborts without relaxation and without a helpful error message.
16887 @item
16888 The default linker script is arranged for code with @code{EIND = 0}.
16889 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16890 linker script has to be used in order to place the sections whose
16891 name start with @code{.trampolines} into the segment where @code{EIND}
16892 points to.
16894 @item
16895 The startup code from libgcc never sets @code{EIND}.
16896 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16897 For the impact of AVR-LibC on @code{EIND}, see the
16898 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16900 @item
16901 It is legitimate for user-specific startup code to set up @code{EIND}
16902 early, for example by means of initialization code located in
16903 section @code{.init3}. Such code runs prior to general startup code
16904 that initializes RAM and calls constructors, but after the bit
16905 of startup code from AVR-LibC that sets @code{EIND} to the segment
16906 where the vector table is located.
16907 @example
16908 #include <avr/io.h>
16910 static void
16911 __attribute__((section(".init3"),naked,used,no_instrument_function))
16912 init3_set_eind (void)
16914   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16915                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16917 @end example
16919 @noindent
16920 The @code{__trampolines_start} symbol is defined in the linker script.
16922 @item
16923 Stubs are generated automatically by the linker if
16924 the following two conditions are met:
16925 @itemize @minus
16927 @item The address of a label is taken by means of the @code{gs} modifier
16928 (short for @emph{generate stubs}) like so:
16929 @example
16930 LDI r24, lo8(gs(@var{func}))
16931 LDI r25, hi8(gs(@var{func}))
16932 @end example
16933 @item The final location of that label is in a code segment
16934 @emph{outside} the segment where the stubs are located.
16935 @end itemize
16937 @item
16938 The compiler emits such @code{gs} modifiers for code labels in the
16939 following situations:
16940 @itemize @minus
16941 @item Taking address of a function or code label.
16942 @item Computed goto.
16943 @item If prologue-save function is used, see @option{-mcall-prologues}
16944 command-line option.
16945 @item Switch/case dispatch tables. If you do not want such dispatch
16946 tables you can specify the @option{-fno-jump-tables} command-line option.
16947 @item C and C++ constructors/destructors called during startup/shutdown.
16948 @item If the tools hit a @code{gs()} modifier explained above.
16949 @end itemize
16951 @item
16952 Jumping to non-symbolic addresses like so is @emph{not} supported:
16954 @example
16955 int main (void)
16957     /* Call function at word address 0x2 */
16958     return ((int(*)(void)) 0x2)();
16960 @end example
16962 Instead, a stub has to be set up, i.e.@: the function has to be called
16963 through a symbol (@code{func_4} in the example):
16965 @example
16966 int main (void)
16968     extern int func_4 (void);
16970     /* Call function at byte address 0x4 */
16971     return func_4();
16973 @end example
16975 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16976 Alternatively, @code{func_4} can be defined in the linker script.
16977 @end itemize
16979 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16980 @cindex @code{RAMPD}
16981 @cindex @code{RAMPX}
16982 @cindex @code{RAMPY}
16983 @cindex @code{RAMPZ}
16984 Some AVR devices support memories larger than the 64@tie{}KiB range
16985 that can be accessed with 16-bit pointers.  To access memory locations
16986 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16987 register is used as high part of the address:
16988 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16989 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16990 register, respectively, to get a wide address. Similarly,
16991 @code{RAMPD} is used together with direct addressing.
16993 @itemize
16994 @item
16995 The startup code initializes the @code{RAMP} special function
16996 registers with zero.
16998 @item
16999 If a @ref{AVR Named Address Spaces,named address space} other than
17000 generic or @code{__flash} is used, then @code{RAMPZ} is set
17001 as needed before the operation.
17003 @item
17004 If the device supports RAM larger than 64@tie{}KiB and the compiler
17005 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
17006 is reset to zero after the operation.
17008 @item
17009 If the device comes with a specific @code{RAMP} register, the ISR
17010 prologue/epilogue saves/restores that SFR and initializes it with
17011 zero in case the ISR code might (implicitly) use it.
17013 @item
17014 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
17015 If you use inline assembler to read from locations outside the
17016 16-bit address range and change one of the @code{RAMP} registers,
17017 you must reset it to zero after the access.
17019 @end itemize
17021 @subsubsection AVR Built-in Macros
17023 GCC defines several built-in macros so that the user code can test
17024 for the presence or absence of features.  Almost any of the following
17025 built-in macros are deduced from device capabilities and thus
17026 triggered by the @option{-mmcu=} command-line option.
17028 For even more AVR-specific built-in macros see
17029 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
17031 @table @code
17033 @item __AVR_ARCH__
17034 Build-in macro that resolves to a decimal number that identifies the
17035 architecture and depends on the @option{-mmcu=@var{mcu}} option.
17036 Possible values are:
17038 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
17039 @code{4}, @code{5}, @code{51}, @code{6}
17041 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
17042 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
17044 respectively and
17046 @code{100},
17047 @code{102}, @code{103}, @code{104},
17048 @code{105}, @code{106}, @code{107}
17050 for @var{mcu}=@code{avrtiny},
17051 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
17052 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
17053 If @var{mcu} specifies a device, this built-in macro is set
17054 accordingly. For example, with @option{-mmcu=atmega8} the macro is
17055 defined to @code{4}.
17057 @item __AVR_@var{Device}__
17058 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
17059 the device's name. For example, @option{-mmcu=atmega8} defines the
17060 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
17061 @code{__AVR_ATtiny261A__}, etc.
17063 The built-in macros' names follow
17064 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
17065 the device name as from the AVR user manual. The difference between
17066 @var{Device} in the built-in macro and @var{device} in
17067 @option{-mmcu=@var{device}} is that the latter is always lowercase.
17069 If @var{device} is not a device but only a core architecture like
17070 @samp{avr51}, this macro is not defined.
17072 @item __AVR_DEVICE_NAME__
17073 Setting @option{-mmcu=@var{device}} defines this built-in macro to
17074 the device's name. For example, with @option{-mmcu=atmega8} the macro
17075 is defined to @code{atmega8}.
17077 If @var{device} is not a device but only a core architecture like
17078 @samp{avr51}, this macro is not defined.
17080 @item __AVR_XMEGA__
17081 The device / architecture belongs to the XMEGA family of devices.
17083 @item __AVR_HAVE_ELPM__
17084 The device has the @code{ELPM} instruction.
17086 @item __AVR_HAVE_ELPMX__
17087 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
17088 R@var{n},Z+} instructions.
17090 @item __AVR_HAVE_MOVW__
17091 The device has the @code{MOVW} instruction to perform 16-bit
17092 register-register moves.
17094 @item __AVR_HAVE_LPMX__
17095 The device has the @code{LPM R@var{n},Z} and
17096 @code{LPM R@var{n},Z+} instructions.
17098 @item __AVR_HAVE_MUL__
17099 The device has a hardware multiplier. 
17101 @item __AVR_HAVE_JMP_CALL__
17102 The device has the @code{JMP} and @code{CALL} instructions.
17103 This is the case for devices with more than 8@tie{}KiB of program
17104 memory.
17106 @item __AVR_HAVE_EIJMP_EICALL__
17107 @itemx __AVR_3_BYTE_PC__
17108 The device has the @code{EIJMP} and @code{EICALL} instructions.
17109 This is the case for devices with more than 128@tie{}KiB of program memory.
17110 This also means that the program counter
17111 (PC) is 3@tie{}bytes wide.
17113 @item __AVR_2_BYTE_PC__
17114 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
17115 with up to 128@tie{}KiB of program memory.
17117 @item __AVR_HAVE_8BIT_SP__
17118 @itemx __AVR_HAVE_16BIT_SP__
17119 The stack pointer (SP) register is treated as 8-bit respectively
17120 16-bit register by the compiler.
17121 The definition of these macros is affected by @option{-mtiny-stack}.
17123 @item __AVR_HAVE_SPH__
17124 @itemx __AVR_SP8__
17125 The device has the SPH (high part of stack pointer) special function
17126 register or has an 8-bit stack pointer, respectively.
17127 The definition of these macros is affected by @option{-mmcu=} and
17128 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
17129 by @option{-msp8}.
17131 @item __AVR_HAVE_RAMPD__
17132 @itemx __AVR_HAVE_RAMPX__
17133 @itemx __AVR_HAVE_RAMPY__
17134 @itemx __AVR_HAVE_RAMPZ__
17135 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
17136 @code{RAMPZ} special function register, respectively.
17138 @item __NO_INTERRUPTS__
17139 This macro reflects the @option{-mno-interrupts} command-line option.
17141 @item __AVR_ERRATA_SKIP__
17142 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
17143 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
17144 instructions because of a hardware erratum.  Skip instructions are
17145 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
17146 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
17147 set.
17149 @item __AVR_ISA_RMW__
17150 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
17152 @item __AVR_SFR_OFFSET__=@var{offset}
17153 Instructions that can address I/O special function registers directly
17154 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
17155 address as if addressed by an instruction to access RAM like @code{LD}
17156 or @code{STS}. This offset depends on the device architecture and has
17157 to be subtracted from the RAM address in order to get the
17158 respective I/O@tie{}address.
17160 @item __AVR_SHORT_CALLS__
17161 The @option{-mshort-calls} command line option is set.
17163 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
17164 Some devices support reading from flash memory by means of @code{LD*}
17165 instructions.  The flash memory is seen in the data address space
17166 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
17167 is not defined, this feature is not available.  If defined,
17168 the address space is linear and there is no need to put
17169 @code{.rodata} into RAM.  This is handled by the default linker
17170 description file, and is currently available for
17171 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
17172 there is no need to use address spaces like @code{__flash} or
17173 features like attribute @code{progmem} and @code{pgm_read_*}.
17175 @item __WITH_AVRLIBC__
17176 The compiler is configured to be used together with AVR-Libc.
17177 See the @option{--with-avrlibc} configure option.
17179 @end table
17181 @node Blackfin Options
17182 @subsection Blackfin Options
17183 @cindex Blackfin Options
17185 @table @gcctabopt
17186 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
17187 @opindex mcpu=
17188 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
17189 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
17190 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
17191 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
17192 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
17193 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
17194 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
17195 @samp{bf561}, @samp{bf592}.
17197 The optional @var{sirevision} specifies the silicon revision of the target
17198 Blackfin processor.  Any workarounds available for the targeted silicon revision
17199 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
17200 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
17201 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
17202 hexadecimal digits representing the major and minor numbers in the silicon
17203 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
17204 is not defined.  If @var{sirevision} is @samp{any}, the
17205 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
17206 If this optional @var{sirevision} is not used, GCC assumes the latest known
17207 silicon revision of the targeted Blackfin processor.
17209 GCC defines a preprocessor macro for the specified @var{cpu}.
17210 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
17211 provided by libgloss to be linked in if @option{-msim} is not given.
17213 Without this option, @samp{bf532} is used as the processor by default.
17215 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
17216 only the preprocessor macro is defined.
17218 @item -msim
17219 @opindex msim
17220 Specifies that the program will be run on the simulator.  This causes
17221 the simulator BSP provided by libgloss to be linked in.  This option
17222 has effect only for @samp{bfin-elf} toolchain.
17223 Certain other options, such as @option{-mid-shared-library} and
17224 @option{-mfdpic}, imply @option{-msim}.
17226 @item -momit-leaf-frame-pointer
17227 @opindex momit-leaf-frame-pointer
17228 Don't keep the frame pointer in a register for leaf functions.  This
17229 avoids the instructions to save, set up and restore frame pointers and
17230 makes an extra register available in leaf functions.
17232 @item -mspecld-anomaly
17233 @opindex mspecld-anomaly
17234 When enabled, the compiler ensures that the generated code does not
17235 contain speculative loads after jump instructions. If this option is used,
17236 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
17238 @item -mno-specld-anomaly
17239 @opindex mno-specld-anomaly
17240 Don't generate extra code to prevent speculative loads from occurring.
17242 @item -mcsync-anomaly
17243 @opindex mcsync-anomaly
17244 When enabled, the compiler ensures that the generated code does not
17245 contain CSYNC or SSYNC instructions too soon after conditional branches.
17246 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
17248 @item -mno-csync-anomaly
17249 @opindex mno-csync-anomaly
17250 Don't generate extra code to prevent CSYNC or SSYNC instructions from
17251 occurring too soon after a conditional branch.
17253 @item -mlow-64k
17254 @opindex mlow-64k
17255 When enabled, the compiler is free to take advantage of the knowledge that
17256 the entire program fits into the low 64k of memory.
17258 @item -mno-low-64k
17259 @opindex mno-low-64k
17260 Assume that the program is arbitrarily large.  This is the default.
17262 @item -mstack-check-l1
17263 @opindex mstack-check-l1
17264 Do stack checking using information placed into L1 scratchpad memory by the
17265 uClinux kernel.
17267 @item -mid-shared-library
17268 @opindex mid-shared-library
17269 Generate code that supports shared libraries via the library ID method.
17270 This allows for execute in place and shared libraries in an environment
17271 without virtual memory management.  This option implies @option{-fPIC}.
17272 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17274 @item -mno-id-shared-library
17275 @opindex mno-id-shared-library
17276 Generate code that doesn't assume ID-based shared libraries are being used.
17277 This is the default.
17279 @item -mleaf-id-shared-library
17280 @opindex mleaf-id-shared-library
17281 Generate code that supports shared libraries via the library ID method,
17282 but assumes that this library or executable won't link against any other
17283 ID shared libraries.  That allows the compiler to use faster code for jumps
17284 and calls.
17286 @item -mno-leaf-id-shared-library
17287 @opindex mno-leaf-id-shared-library
17288 Do not assume that the code being compiled won't link against any ID shared
17289 libraries.  Slower code is generated for jump and call insns.
17291 @item -mshared-library-id=n
17292 @opindex mshared-library-id
17293 Specifies the identification number of the ID-based shared library being
17294 compiled.  Specifying a value of 0 generates more compact code; specifying
17295 other values forces the allocation of that number to the current
17296 library but is no more space- or time-efficient than omitting this option.
17298 @item -msep-data
17299 @opindex msep-data
17300 Generate code that allows the data segment to be located in a different
17301 area of memory from the text segment.  This allows for execute in place in
17302 an environment without virtual memory management by eliminating relocations
17303 against the text section.
17305 @item -mno-sep-data
17306 @opindex mno-sep-data
17307 Generate code that assumes that the data segment follows the text segment.
17308 This is the default.
17310 @item -mlong-calls
17311 @itemx -mno-long-calls
17312 @opindex mlong-calls
17313 @opindex mno-long-calls
17314 Tells the compiler to perform function calls by first loading the
17315 address of the function into a register and then performing a subroutine
17316 call on this register.  This switch is needed if the target function
17317 lies outside of the 24-bit addressing range of the offset-based
17318 version of subroutine call instruction.
17320 This feature is not enabled by default.  Specifying
17321 @option{-mno-long-calls} restores the default behavior.  Note these
17322 switches have no effect on how the compiler generates code to handle
17323 function calls via function pointers.
17325 @item -mfast-fp
17326 @opindex mfast-fp
17327 Link with the fast floating-point library. This library relaxes some of
17328 the IEEE floating-point standard's rules for checking inputs against
17329 Not-a-Number (NAN), in the interest of performance.
17331 @item -minline-plt
17332 @opindex minline-plt
17333 Enable inlining of PLT entries in function calls to functions that are
17334 not known to bind locally.  It has no effect without @option{-mfdpic}.
17336 @item -mmulticore
17337 @opindex mmulticore
17338 Build a standalone application for multicore Blackfin processors. 
17339 This option causes proper start files and link scripts supporting 
17340 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17341 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17343 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17344 selects the one-application-per-core programming model.  Without
17345 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17346 programming model is used. In this model, the main function of Core B
17347 should be named as @code{coreb_main}.
17349 If this option is not used, the single-core application programming
17350 model is used.
17352 @item -mcorea
17353 @opindex mcorea
17354 Build a standalone application for Core A of BF561 when using
17355 the one-application-per-core programming model. Proper start files
17356 and link scripts are used to support Core A, and the macro
17357 @code{__BFIN_COREA} is defined.
17358 This option can only be used in conjunction with @option{-mmulticore}.
17360 @item -mcoreb
17361 @opindex mcoreb
17362 Build a standalone application for Core B of BF561 when using
17363 the one-application-per-core programming model. Proper start files
17364 and link scripts are used to support Core B, and the macro
17365 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17366 should be used instead of @code{main}. 
17367 This option can only be used in conjunction with @option{-mmulticore}.
17369 @item -msdram
17370 @opindex msdram
17371 Build a standalone application for SDRAM. Proper start files and
17372 link scripts are used to put the application into SDRAM, and the macro
17373 @code{__BFIN_SDRAM} is defined.
17374 The loader should initialize SDRAM before loading the application.
17376 @item -micplb
17377 @opindex micplb
17378 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17379 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17380 are enabled; for standalone applications the default is off.
17381 @end table
17383 @node C6X Options
17384 @subsection C6X Options
17385 @cindex C6X Options
17387 @table @gcctabopt
17388 @item -march=@var{name}
17389 @opindex march
17390 This specifies the name of the target architecture.  GCC uses this
17391 name to determine what kind of instructions it can emit when generating
17392 assembly code.  Permissible names are: @samp{c62x},
17393 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17395 @item -mbig-endian
17396 @opindex mbig-endian
17397 Generate code for a big-endian target.
17399 @item -mlittle-endian
17400 @opindex mlittle-endian
17401 Generate code for a little-endian target.  This is the default.
17403 @item -msim
17404 @opindex msim
17405 Choose startup files and linker script suitable for the simulator.
17407 @item -msdata=default
17408 @opindex msdata=default
17409 Put small global and static data in the @code{.neardata} section,
17410 which is pointed to by register @code{B14}.  Put small uninitialized
17411 global and static data in the @code{.bss} section, which is adjacent
17412 to the @code{.neardata} section.  Put small read-only data into the
17413 @code{.rodata} section.  The corresponding sections used for large
17414 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17416 @item -msdata=all
17417 @opindex msdata=all
17418 Put all data, not just small objects, into the sections reserved for
17419 small data, and use addressing relative to the @code{B14} register to
17420 access them.
17422 @item -msdata=none
17423 @opindex msdata=none
17424 Make no use of the sections reserved for small data, and use absolute
17425 addresses to access all data.  Put all initialized global and static
17426 data in the @code{.fardata} section, and all uninitialized data in the
17427 @code{.far} section.  Put all constant data into the @code{.const}
17428 section.
17429 @end table
17431 @node CRIS Options
17432 @subsection CRIS Options
17433 @cindex CRIS Options
17435 These options are defined specifically for the CRIS ports.
17437 @table @gcctabopt
17438 @item -march=@var{architecture-type}
17439 @itemx -mcpu=@var{architecture-type}
17440 @opindex march
17441 @opindex mcpu
17442 Generate code for the specified architecture.  The choices for
17443 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17444 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17445 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17446 @samp{v10}.
17448 @item -mtune=@var{architecture-type}
17449 @opindex mtune
17450 Tune to @var{architecture-type} everything applicable about the generated
17451 code, except for the ABI and the set of available instructions.  The
17452 choices for @var{architecture-type} are the same as for
17453 @option{-march=@var{architecture-type}}.
17455 @item -mmax-stack-frame=@var{n}
17456 @opindex mmax-stack-frame
17457 Warn when the stack frame of a function exceeds @var{n} bytes.
17459 @item -metrax4
17460 @itemx -metrax100
17461 @opindex metrax4
17462 @opindex metrax100
17463 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17464 @option{-march=v3} and @option{-march=v8} respectively.
17466 @item -mmul-bug-workaround
17467 @itemx -mno-mul-bug-workaround
17468 @opindex mmul-bug-workaround
17469 @opindex mno-mul-bug-workaround
17470 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17471 models where it applies.  This option is active by default.
17473 @item -mpdebug
17474 @opindex mpdebug
17475 Enable CRIS-specific verbose debug-related information in the assembly
17476 code.  This option also has the effect of turning off the @samp{#NO_APP}
17477 formatted-code indicator to the assembler at the beginning of the
17478 assembly file.
17480 @item -mcc-init
17481 @opindex mcc-init
17482 Do not use condition-code results from previous instruction; always emit
17483 compare and test instructions before use of condition codes.
17485 @item -mno-side-effects
17486 @opindex mno-side-effects
17487 Do not emit instructions with side effects in addressing modes other than
17488 post-increment.
17490 @item -mstack-align
17491 @itemx -mno-stack-align
17492 @itemx -mdata-align
17493 @itemx -mno-data-align
17494 @itemx -mconst-align
17495 @itemx -mno-const-align
17496 @opindex mstack-align
17497 @opindex mno-stack-align
17498 @opindex mdata-align
17499 @opindex mno-data-align
17500 @opindex mconst-align
17501 @opindex mno-const-align
17502 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17503 stack frame, individual data and constants to be aligned for the maximum
17504 single data access size for the chosen CPU model.  The default is to
17505 arrange for 32-bit alignment.  ABI details such as structure layout are
17506 not affected by these options.
17508 @item -m32-bit
17509 @itemx -m16-bit
17510 @itemx -m8-bit
17511 @opindex m32-bit
17512 @opindex m16-bit
17513 @opindex m8-bit
17514 Similar to the stack- data- and const-align options above, these options
17515 arrange for stack frame, writable data and constants to all be 32-bit,
17516 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17518 @item -mno-prologue-epilogue
17519 @itemx -mprologue-epilogue
17520 @opindex mno-prologue-epilogue
17521 @opindex mprologue-epilogue
17522 With @option{-mno-prologue-epilogue}, the normal function prologue and
17523 epilogue which set up the stack frame are omitted and no return
17524 instructions or return sequences are generated in the code.  Use this
17525 option only together with visual inspection of the compiled code: no
17526 warnings or errors are generated when call-saved registers must be saved,
17527 or storage for local variables needs to be allocated.
17529 @item -mno-gotplt
17530 @itemx -mgotplt
17531 @opindex mno-gotplt
17532 @opindex mgotplt
17533 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17534 instruction sequences that load addresses for functions from the PLT part
17535 of the GOT rather than (traditional on other architectures) calls to the
17536 PLT@.  The default is @option{-mgotplt}.
17538 @item -melf
17539 @opindex melf
17540 Legacy no-op option only recognized with the cris-axis-elf and
17541 cris-axis-linux-gnu targets.
17543 @item -mlinux
17544 @opindex mlinux
17545 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17547 @item -sim
17548 @opindex sim
17549 This option, recognized for the cris-axis-elf, arranges
17550 to link with input-output functions from a simulator library.  Code,
17551 initialized data and zero-initialized data are allocated consecutively.
17553 @item -sim2
17554 @opindex sim2
17555 Like @option{-sim}, but pass linker options to locate initialized data at
17556 0x40000000 and zero-initialized data at 0x80000000.
17557 @end table
17559 @node CR16 Options
17560 @subsection CR16 Options
17561 @cindex CR16 Options
17563 These options are defined specifically for the CR16 ports.
17565 @table @gcctabopt
17567 @item -mmac
17568 @opindex mmac
17569 Enable the use of multiply-accumulate instructions. Disabled by default.
17571 @item -mcr16cplus
17572 @itemx -mcr16c
17573 @opindex mcr16cplus
17574 @opindex mcr16c
17575 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17576 is default.
17578 @item -msim
17579 @opindex msim
17580 Links the library libsim.a which is in compatible with simulator. Applicable
17581 to ELF compiler only.
17583 @item -mint32
17584 @opindex mint32
17585 Choose integer type as 32-bit wide.
17587 @item -mbit-ops
17588 @opindex mbit-ops
17589 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17591 @item -mdata-model=@var{model}
17592 @opindex mdata-model
17593 Choose a data model. The choices for @var{model} are @samp{near},
17594 @samp{far} or @samp{medium}. @samp{medium} is default.
17595 However, @samp{far} is not valid with @option{-mcr16c}, as the
17596 CR16C architecture does not support the far data model.
17597 @end table
17599 @node Darwin Options
17600 @subsection Darwin Options
17601 @cindex Darwin options
17603 These options are defined for all architectures running the Darwin operating
17604 system.
17606 FSF GCC on Darwin does not create ``fat'' object files; it creates
17607 an object file for the single architecture that GCC was built to
17608 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17609 @option{-arch} options are used; it does so by running the compiler or
17610 linker multiple times and joining the results together with
17611 @file{lipo}.
17613 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17614 @samp{i686}) is determined by the flags that specify the ISA
17615 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17616 @option{-force_cpusubtype_ALL} option can be used to override this.
17618 The Darwin tools vary in their behavior when presented with an ISA
17619 mismatch.  The assembler, @file{as}, only permits instructions to
17620 be used that are valid for the subtype of the file it is generating,
17621 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17622 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17623 and prints an error if asked to create a shared library with a less
17624 restrictive subtype than its input files (for instance, trying to put
17625 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17626 for executables, @command{ld}, quietly gives the executable the most
17627 restrictive subtype of any of its input files.
17629 @table @gcctabopt
17630 @item -F@var{dir}
17631 @opindex F
17632 Add the framework directory @var{dir} to the head of the list of
17633 directories to be searched for header files.  These directories are
17634 interleaved with those specified by @option{-I} options and are
17635 scanned in a left-to-right order.
17637 A framework directory is a directory with frameworks in it.  A
17638 framework is a directory with a @file{Headers} and/or
17639 @file{PrivateHeaders} directory contained directly in it that ends
17640 in @file{.framework}.  The name of a framework is the name of this
17641 directory excluding the @file{.framework}.  Headers associated with
17642 the framework are found in one of those two directories, with
17643 @file{Headers} being searched first.  A subframework is a framework
17644 directory that is in a framework's @file{Frameworks} directory.
17645 Includes of subframework headers can only appear in a header of a
17646 framework that contains the subframework, or in a sibling subframework
17647 header.  Two subframeworks are siblings if they occur in the same
17648 framework.  A subframework should not have the same name as a
17649 framework; a warning is issued if this is violated.  Currently a
17650 subframework cannot have subframeworks; in the future, the mechanism
17651 may be extended to support this.  The standard frameworks can be found
17652 in @file{/System/Library/Frameworks} and
17653 @file{/Library/Frameworks}.  An example include looks like
17654 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17655 the name of the framework and @file{header.h} is found in the
17656 @file{PrivateHeaders} or @file{Headers} directory.
17658 @item -iframework@var{dir}
17659 @opindex iframework
17660 Like @option{-F} except the directory is a treated as a system
17661 directory.  The main difference between this @option{-iframework} and
17662 @option{-F} is that with @option{-iframework} the compiler does not
17663 warn about constructs contained within header files found via
17664 @var{dir}.  This option is valid only for the C family of languages.
17666 @item -gused
17667 @opindex gused
17668 Emit debugging information for symbols that are used.  For stabs
17669 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17670 This is by default ON@.
17672 @item -gfull
17673 @opindex gfull
17674 Emit debugging information for all symbols and types.
17676 @item -mmacosx-version-min=@var{version}
17677 The earliest version of MacOS X that this executable will run on
17678 is @var{version}.  Typical values of @var{version} include @code{10.1},
17679 @code{10.2}, and @code{10.3.9}.
17681 If the compiler was built to use the system's headers by default,
17682 then the default for this option is the system version on which the
17683 compiler is running, otherwise the default is to make choices that
17684 are compatible with as many systems and code bases as possible.
17686 @item -mkernel
17687 @opindex mkernel
17688 Enable kernel development mode.  The @option{-mkernel} option sets
17689 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17690 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17691 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17692 applicable.  This mode also sets @option{-mno-altivec},
17693 @option{-msoft-float}, @option{-fno-builtin} and
17694 @option{-mlong-branch} for PowerPC targets.
17696 @item -mone-byte-bool
17697 @opindex mone-byte-bool
17698 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17699 By default @code{sizeof(bool)} is @code{4} when compiling for
17700 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17701 option has no effect on x86.
17703 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17704 to generate code that is not binary compatible with code generated
17705 without that switch.  Using this switch may require recompiling all
17706 other modules in a program, including system libraries.  Use this
17707 switch to conform to a non-default data model.
17709 @item -mfix-and-continue
17710 @itemx -ffix-and-continue
17711 @itemx -findirect-data
17712 @opindex mfix-and-continue
17713 @opindex ffix-and-continue
17714 @opindex findirect-data
17715 Generate code suitable for fast turnaround development, such as to
17716 allow GDB to dynamically load @file{.o} files into already-running
17717 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17718 are provided for backwards compatibility.
17720 @item -all_load
17721 @opindex all_load
17722 Loads all members of static archive libraries.
17723 See man ld(1) for more information.
17725 @item -arch_errors_fatal
17726 @opindex arch_errors_fatal
17727 Cause the errors having to do with files that have the wrong architecture
17728 to be fatal.
17730 @item -bind_at_load
17731 @opindex bind_at_load
17732 Causes the output file to be marked such that the dynamic linker will
17733 bind all undefined references when the file is loaded or launched.
17735 @item -bundle
17736 @opindex bundle
17737 Produce a Mach-o bundle format file.
17738 See man ld(1) for more information.
17740 @item -bundle_loader @var{executable}
17741 @opindex bundle_loader
17742 This option specifies the @var{executable} that will load the build
17743 output file being linked.  See man ld(1) for more information.
17745 @item -dynamiclib
17746 @opindex dynamiclib
17747 When passed this option, GCC produces a dynamic library instead of
17748 an executable when linking, using the Darwin @file{libtool} command.
17750 @item -force_cpusubtype_ALL
17751 @opindex force_cpusubtype_ALL
17752 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17753 one controlled by the @option{-mcpu} or @option{-march} option.
17755 @item -allowable_client  @var{client_name}
17756 @itemx -client_name
17757 @itemx -compatibility_version
17758 @itemx -current_version
17759 @itemx -dead_strip
17760 @itemx -dependency-file
17761 @itemx -dylib_file
17762 @itemx -dylinker_install_name
17763 @itemx -dynamic
17764 @itemx -exported_symbols_list
17765 @itemx -filelist
17766 @need 800
17767 @itemx -flat_namespace
17768 @itemx -force_flat_namespace
17769 @itemx -headerpad_max_install_names
17770 @itemx -image_base
17771 @itemx -init
17772 @itemx -install_name
17773 @itemx -keep_private_externs
17774 @itemx -multi_module
17775 @itemx -multiply_defined
17776 @itemx -multiply_defined_unused
17777 @need 800
17778 @itemx -noall_load
17779 @itemx -no_dead_strip_inits_and_terms
17780 @itemx -nofixprebinding
17781 @itemx -nomultidefs
17782 @itemx -noprebind
17783 @itemx -noseglinkedit
17784 @itemx -pagezero_size
17785 @itemx -prebind
17786 @itemx -prebind_all_twolevel_modules
17787 @itemx -private_bundle
17788 @need 800
17789 @itemx -read_only_relocs
17790 @itemx -sectalign
17791 @itemx -sectobjectsymbols
17792 @itemx -whyload
17793 @itemx -seg1addr
17794 @itemx -sectcreate
17795 @itemx -sectobjectsymbols
17796 @itemx -sectorder
17797 @itemx -segaddr
17798 @itemx -segs_read_only_addr
17799 @need 800
17800 @itemx -segs_read_write_addr
17801 @itemx -seg_addr_table
17802 @itemx -seg_addr_table_filename
17803 @itemx -seglinkedit
17804 @itemx -segprot
17805 @itemx -segs_read_only_addr
17806 @itemx -segs_read_write_addr
17807 @itemx -single_module
17808 @itemx -static
17809 @itemx -sub_library
17810 @need 800
17811 @itemx -sub_umbrella
17812 @itemx -twolevel_namespace
17813 @itemx -umbrella
17814 @itemx -undefined
17815 @itemx -unexported_symbols_list
17816 @itemx -weak_reference_mismatches
17817 @itemx -whatsloaded
17818 @opindex allowable_client
17819 @opindex client_name
17820 @opindex compatibility_version
17821 @opindex current_version
17822 @opindex dead_strip
17823 @opindex dependency-file
17824 @opindex dylib_file
17825 @opindex dylinker_install_name
17826 @opindex dynamic
17827 @opindex exported_symbols_list
17828 @opindex filelist
17829 @opindex flat_namespace
17830 @opindex force_flat_namespace
17831 @opindex headerpad_max_install_names
17832 @opindex image_base
17833 @opindex init
17834 @opindex install_name
17835 @opindex keep_private_externs
17836 @opindex multi_module
17837 @opindex multiply_defined
17838 @opindex multiply_defined_unused
17839 @opindex noall_load
17840 @opindex no_dead_strip_inits_and_terms
17841 @opindex nofixprebinding
17842 @opindex nomultidefs
17843 @opindex noprebind
17844 @opindex noseglinkedit
17845 @opindex pagezero_size
17846 @opindex prebind
17847 @opindex prebind_all_twolevel_modules
17848 @opindex private_bundle
17849 @opindex read_only_relocs
17850 @opindex sectalign
17851 @opindex sectobjectsymbols
17852 @opindex whyload
17853 @opindex seg1addr
17854 @opindex sectcreate
17855 @opindex sectobjectsymbols
17856 @opindex sectorder
17857 @opindex segaddr
17858 @opindex segs_read_only_addr
17859 @opindex segs_read_write_addr
17860 @opindex seg_addr_table
17861 @opindex seg_addr_table_filename
17862 @opindex seglinkedit
17863 @opindex segprot
17864 @opindex segs_read_only_addr
17865 @opindex segs_read_write_addr
17866 @opindex single_module
17867 @opindex static
17868 @opindex sub_library
17869 @opindex sub_umbrella
17870 @opindex twolevel_namespace
17871 @opindex umbrella
17872 @opindex undefined
17873 @opindex unexported_symbols_list
17874 @opindex weak_reference_mismatches
17875 @opindex whatsloaded
17876 These options are passed to the Darwin linker.  The Darwin linker man page
17877 describes them in detail.
17878 @end table
17880 @node DEC Alpha Options
17881 @subsection DEC Alpha Options
17883 These @samp{-m} options are defined for the DEC Alpha implementations:
17885 @table @gcctabopt
17886 @item -mno-soft-float
17887 @itemx -msoft-float
17888 @opindex mno-soft-float
17889 @opindex msoft-float
17890 Use (do not use) the hardware floating-point instructions for
17891 floating-point operations.  When @option{-msoft-float} is specified,
17892 functions in @file{libgcc.a} are used to perform floating-point
17893 operations.  Unless they are replaced by routines that emulate the
17894 floating-point operations, or compiled in such a way as to call such
17895 emulations routines, these routines issue floating-point
17896 operations.   If you are compiling for an Alpha without floating-point
17897 operations, you must ensure that the library is built so as not to call
17898 them.
17900 Note that Alpha implementations without floating-point operations are
17901 required to have floating-point registers.
17903 @item -mfp-reg
17904 @itemx -mno-fp-regs
17905 @opindex mfp-reg
17906 @opindex mno-fp-regs
17907 Generate code that uses (does not use) the floating-point register set.
17908 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17909 register set is not used, floating-point operands are passed in integer
17910 registers as if they were integers and floating-point results are passed
17911 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17912 so any function with a floating-point argument or return value called by code
17913 compiled with @option{-mno-fp-regs} must also be compiled with that
17914 option.
17916 A typical use of this option is building a kernel that does not use,
17917 and hence need not save and restore, any floating-point registers.
17919 @item -mieee
17920 @opindex mieee
17921 The Alpha architecture implements floating-point hardware optimized for
17922 maximum performance.  It is mostly compliant with the IEEE floating-point
17923 standard.  However, for full compliance, software assistance is
17924 required.  This option generates code fully IEEE-compliant code
17925 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17926 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17927 defined during compilation.  The resulting code is less efficient but is
17928 able to correctly support denormalized numbers and exceptional IEEE
17929 values such as not-a-number and plus/minus infinity.  Other Alpha
17930 compilers call this option @option{-ieee_with_no_inexact}.
17932 @item -mieee-with-inexact
17933 @opindex mieee-with-inexact
17934 This is like @option{-mieee} except the generated code also maintains
17935 the IEEE @var{inexact-flag}.  Turning on this option causes the
17936 generated code to implement fully-compliant IEEE math.  In addition to
17937 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17938 macro.  On some Alpha implementations the resulting code may execute
17939 significantly slower than the code generated by default.  Since there is
17940 very little code that depends on the @var{inexact-flag}, you should
17941 normally not specify this option.  Other Alpha compilers call this
17942 option @option{-ieee_with_inexact}.
17944 @item -mfp-trap-mode=@var{trap-mode}
17945 @opindex mfp-trap-mode
17946 This option controls what floating-point related traps are enabled.
17947 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17948 The trap mode can be set to one of four values:
17950 @table @samp
17951 @item n
17952 This is the default (normal) setting.  The only traps that are enabled
17953 are the ones that cannot be disabled in software (e.g., division by zero
17954 trap).
17956 @item u
17957 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17958 as well.
17960 @item su
17961 Like @samp{u}, but the instructions are marked to be safe for software
17962 completion (see Alpha architecture manual for details).
17964 @item sui
17965 Like @samp{su}, but inexact traps are enabled as well.
17966 @end table
17968 @item -mfp-rounding-mode=@var{rounding-mode}
17969 @opindex mfp-rounding-mode
17970 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17971 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17974 @table @samp
17975 @item n
17976 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17977 the nearest machine number or towards the even machine number in case
17978 of a tie.
17980 @item m
17981 Round towards minus infinity.
17983 @item c
17984 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17986 @item d
17987 Dynamic rounding mode.  A field in the floating-point control register
17988 (@var{fpcr}, see Alpha architecture reference manual) controls the
17989 rounding mode in effect.  The C library initializes this register for
17990 rounding towards plus infinity.  Thus, unless your program modifies the
17991 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17992 @end table
17994 @item -mtrap-precision=@var{trap-precision}
17995 @opindex mtrap-precision
17996 In the Alpha architecture, floating-point traps are imprecise.  This
17997 means without software assistance it is impossible to recover from a
17998 floating trap and program execution normally needs to be terminated.
17999 GCC can generate code that can assist operating system trap handlers
18000 in determining the exact location that caused a floating-point trap.
18001 Depending on the requirements of an application, different levels of
18002 precisions can be selected:
18004 @table @samp
18005 @item p
18006 Program precision.  This option is the default and means a trap handler
18007 can only identify which program caused a floating-point exception.
18009 @item f
18010 Function precision.  The trap handler can determine the function that
18011 caused a floating-point exception.
18013 @item i
18014 Instruction precision.  The trap handler can determine the exact
18015 instruction that caused a floating-point exception.
18016 @end table
18018 Other Alpha compilers provide the equivalent options called
18019 @option{-scope_safe} and @option{-resumption_safe}.
18021 @item -mieee-conformant
18022 @opindex mieee-conformant
18023 This option marks the generated code as IEEE conformant.  You must not
18024 use this option unless you also specify @option{-mtrap-precision=i} and either
18025 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
18026 is to emit the line @samp{.eflag 48} in the function prologue of the
18027 generated assembly file.
18029 @item -mbuild-constants
18030 @opindex mbuild-constants
18031 Normally GCC examines a 32- or 64-bit integer constant to
18032 see if it can construct it from smaller constants in two or three
18033 instructions.  If it cannot, it outputs the constant as a literal and
18034 generates code to load it from the data segment at run time.
18036 Use this option to require GCC to construct @emph{all} integer constants
18037 using code, even if it takes more instructions (the maximum is six).
18039 You typically use this option to build a shared library dynamic
18040 loader.  Itself a shared library, it must relocate itself in memory
18041 before it can find the variables and constants in its own data segment.
18043 @item -mbwx
18044 @itemx -mno-bwx
18045 @itemx -mcix
18046 @itemx -mno-cix
18047 @itemx -mfix
18048 @itemx -mno-fix
18049 @itemx -mmax
18050 @itemx -mno-max
18051 @opindex mbwx
18052 @opindex mno-bwx
18053 @opindex mcix
18054 @opindex mno-cix
18055 @opindex mfix
18056 @opindex mno-fix
18057 @opindex mmax
18058 @opindex mno-max
18059 Indicate whether GCC should generate code to use the optional BWX,
18060 CIX, FIX and MAX instruction sets.  The default is to use the instruction
18061 sets supported by the CPU type specified via @option{-mcpu=} option or that
18062 of the CPU on which GCC was built if none is specified.
18064 @item -mfloat-vax
18065 @itemx -mfloat-ieee
18066 @opindex mfloat-vax
18067 @opindex mfloat-ieee
18068 Generate code that uses (does not use) VAX F and G floating-point
18069 arithmetic instead of IEEE single and double precision.
18071 @item -mexplicit-relocs
18072 @itemx -mno-explicit-relocs
18073 @opindex mexplicit-relocs
18074 @opindex mno-explicit-relocs
18075 Older Alpha assemblers provided no way to generate symbol relocations
18076 except via assembler macros.  Use of these macros does not allow
18077 optimal instruction scheduling.  GNU binutils as of version 2.12
18078 supports a new syntax that allows the compiler to explicitly mark
18079 which relocations should apply to which instructions.  This option
18080 is mostly useful for debugging, as GCC detects the capabilities of
18081 the assembler when it is built and sets the default accordingly.
18083 @item -msmall-data
18084 @itemx -mlarge-data
18085 @opindex msmall-data
18086 @opindex mlarge-data
18087 When @option{-mexplicit-relocs} is in effect, static data is
18088 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
18089 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
18090 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
18091 16-bit relocations off of the @code{$gp} register.  This limits the
18092 size of the small data area to 64KB, but allows the variables to be
18093 directly accessed via a single instruction.
18095 The default is @option{-mlarge-data}.  With this option the data area
18096 is limited to just below 2GB@.  Programs that require more than 2GB of
18097 data must use @code{malloc} or @code{mmap} to allocate the data in the
18098 heap instead of in the program's data segment.
18100 When generating code for shared libraries, @option{-fpic} implies
18101 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
18103 @item -msmall-text
18104 @itemx -mlarge-text
18105 @opindex msmall-text
18106 @opindex mlarge-text
18107 When @option{-msmall-text} is used, the compiler assumes that the
18108 code of the entire program (or shared library) fits in 4MB, and is
18109 thus reachable with a branch instruction.  When @option{-msmall-data}
18110 is used, the compiler can assume that all local symbols share the
18111 same @code{$gp} value, and thus reduce the number of instructions
18112 required for a function call from 4 to 1.
18114 The default is @option{-mlarge-text}.
18116 @item -mcpu=@var{cpu_type}
18117 @opindex mcpu
18118 Set the instruction set and instruction scheduling parameters for
18119 machine type @var{cpu_type}.  You can specify either the @samp{EV}
18120 style name or the corresponding chip number.  GCC supports scheduling
18121 parameters for the EV4, EV5 and EV6 family of processors and
18122 chooses the default values for the instruction set from the processor
18123 you specify.  If you do not specify a processor type, GCC defaults
18124 to the processor on which the compiler was built.
18126 Supported values for @var{cpu_type} are
18128 @table @samp
18129 @item ev4
18130 @itemx ev45
18131 @itemx 21064
18132 Schedules as an EV4 and has no instruction set extensions.
18134 @item ev5
18135 @itemx 21164
18136 Schedules as an EV5 and has no instruction set extensions.
18138 @item ev56
18139 @itemx 21164a
18140 Schedules as an EV5 and supports the BWX extension.
18142 @item pca56
18143 @itemx 21164pc
18144 @itemx 21164PC
18145 Schedules as an EV5 and supports the BWX and MAX extensions.
18147 @item ev6
18148 @itemx 21264
18149 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
18151 @item ev67
18152 @itemx 21264a
18153 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
18154 @end table
18156 Native toolchains also support the value @samp{native},
18157 which selects the best architecture option for the host processor.
18158 @option{-mcpu=native} has no effect if GCC does not recognize
18159 the processor.
18161 @item -mtune=@var{cpu_type}
18162 @opindex mtune
18163 Set only the instruction scheduling parameters for machine type
18164 @var{cpu_type}.  The instruction set is not changed.
18166 Native toolchains also support the value @samp{native},
18167 which selects the best architecture option for the host processor.
18168 @option{-mtune=native} has no effect if GCC does not recognize
18169 the processor.
18171 @item -mmemory-latency=@var{time}
18172 @opindex mmemory-latency
18173 Sets the latency the scheduler should assume for typical memory
18174 references as seen by the application.  This number is highly
18175 dependent on the memory access patterns used by the application
18176 and the size of the external cache on the machine.
18178 Valid options for @var{time} are
18180 @table @samp
18181 @item @var{number}
18182 A decimal number representing clock cycles.
18184 @item L1
18185 @itemx L2
18186 @itemx L3
18187 @itemx main
18188 The compiler contains estimates of the number of clock cycles for
18189 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
18190 (also called Dcache, Scache, and Bcache), as well as to main memory.
18191 Note that L3 is only valid for EV5.
18193 @end table
18194 @end table
18196 @node FR30 Options
18197 @subsection FR30 Options
18198 @cindex FR30 Options
18200 These options are defined specifically for the FR30 port.
18202 @table @gcctabopt
18204 @item -msmall-model
18205 @opindex msmall-model
18206 Use the small address space model.  This can produce smaller code, but
18207 it does assume that all symbolic values and addresses fit into a
18208 20-bit range.
18210 @item -mno-lsim
18211 @opindex mno-lsim
18212 Assume that runtime support has been provided and so there is no need
18213 to include the simulator library (@file{libsim.a}) on the linker
18214 command line.
18216 @end table
18218 @node FT32 Options
18219 @subsection FT32 Options
18220 @cindex FT32 Options
18222 These options are defined specifically for the FT32 port.
18224 @table @gcctabopt
18226 @item -msim
18227 @opindex msim
18228 Specifies that the program will be run on the simulator.  This causes
18229 an alternate runtime startup and library to be linked.
18230 You must not use this option when generating programs that will run on
18231 real hardware; you must provide your own runtime library for whatever
18232 I/O functions are needed.
18234 @item -mlra
18235 @opindex mlra
18236 Enable Local Register Allocation.  This is still experimental for FT32,
18237 so by default the compiler uses standard reload.
18239 @item -mnodiv
18240 @opindex mnodiv
18241 Do not use div and mod instructions.
18243 @item -mft32b
18244 @opindex mft32b
18245 Enable use of the extended instructions of the FT32B processor.
18247 @item -mcompress
18248 @opindex mcompress
18249 Compress all code using the Ft32B code compression scheme.
18251 @item -mnopm
18252 @opindex  mnopm
18253 Do not generate code that reads program memory.
18255 @end table
18257 @node FRV Options
18258 @subsection FRV Options
18259 @cindex FRV Options
18261 @table @gcctabopt
18262 @item -mgpr-32
18263 @opindex mgpr-32
18265 Only use the first 32 general-purpose registers.
18267 @item -mgpr-64
18268 @opindex mgpr-64
18270 Use all 64 general-purpose registers.
18272 @item -mfpr-32
18273 @opindex mfpr-32
18275 Use only the first 32 floating-point registers.
18277 @item -mfpr-64
18278 @opindex mfpr-64
18280 Use all 64 floating-point registers.
18282 @item -mhard-float
18283 @opindex mhard-float
18285 Use hardware instructions for floating-point operations.
18287 @item -msoft-float
18288 @opindex msoft-float
18290 Use library routines for floating-point operations.
18292 @item -malloc-cc
18293 @opindex malloc-cc
18295 Dynamically allocate condition code registers.
18297 @item -mfixed-cc
18298 @opindex mfixed-cc
18300 Do not try to dynamically allocate condition code registers, only
18301 use @code{icc0} and @code{fcc0}.
18303 @item -mdword
18304 @opindex mdword
18306 Change ABI to use double word insns.
18308 @item -mno-dword
18309 @opindex mno-dword
18311 Do not use double word instructions.
18313 @item -mdouble
18314 @opindex mdouble
18316 Use floating-point double instructions.
18318 @item -mno-double
18319 @opindex mno-double
18321 Do not use floating-point double instructions.
18323 @item -mmedia
18324 @opindex mmedia
18326 Use media instructions.
18328 @item -mno-media
18329 @opindex mno-media
18331 Do not use media instructions.
18333 @item -mmuladd
18334 @opindex mmuladd
18336 Use multiply and add/subtract instructions.
18338 @item -mno-muladd
18339 @opindex mno-muladd
18341 Do not use multiply and add/subtract instructions.
18343 @item -mfdpic
18344 @opindex mfdpic
18346 Select the FDPIC ABI, which uses function descriptors to represent
18347 pointers to functions.  Without any PIC/PIE-related options, it
18348 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18349 assumes GOT entries and small data are within a 12-bit range from the
18350 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18351 are computed with 32 bits.
18352 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18354 @item -minline-plt
18355 @opindex minline-plt
18357 Enable inlining of PLT entries in function calls to functions that are
18358 not known to bind locally.  It has no effect without @option{-mfdpic}.
18359 It's enabled by default if optimizing for speed and compiling for
18360 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18361 optimization option such as @option{-O3} or above is present in the
18362 command line.
18364 @item -mTLS
18365 @opindex mTLS
18367 Assume a large TLS segment when generating thread-local code.
18369 @item -mtls
18370 @opindex mtls
18372 Do not assume a large TLS segment when generating thread-local code.
18374 @item -mgprel-ro
18375 @opindex mgprel-ro
18377 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18378 that is known to be in read-only sections.  It's enabled by default,
18379 except for @option{-fpic} or @option{-fpie}: even though it may help
18380 make the global offset table smaller, it trades 1 instruction for 4.
18381 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18382 one of which may be shared by multiple symbols, and it avoids the need
18383 for a GOT entry for the referenced symbol, so it's more likely to be a
18384 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18386 @item -multilib-library-pic
18387 @opindex multilib-library-pic
18389 Link with the (library, not FD) pic libraries.  It's implied by
18390 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18391 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18392 it explicitly.
18394 @item -mlinked-fp
18395 @opindex mlinked-fp
18397 Follow the EABI requirement of always creating a frame pointer whenever
18398 a stack frame is allocated.  This option is enabled by default and can
18399 be disabled with @option{-mno-linked-fp}.
18401 @item -mlong-calls
18402 @opindex mlong-calls
18404 Use indirect addressing to call functions outside the current
18405 compilation unit.  This allows the functions to be placed anywhere
18406 within the 32-bit address space.
18408 @item -malign-labels
18409 @opindex malign-labels
18411 Try to align labels to an 8-byte boundary by inserting NOPs into the
18412 previous packet.  This option only has an effect when VLIW packing
18413 is enabled.  It doesn't create new packets; it merely adds NOPs to
18414 existing ones.
18416 @item -mlibrary-pic
18417 @opindex mlibrary-pic
18419 Generate position-independent EABI code.
18421 @item -macc-4
18422 @opindex macc-4
18424 Use only the first four media accumulator registers.
18426 @item -macc-8
18427 @opindex macc-8
18429 Use all eight media accumulator registers.
18431 @item -mpack
18432 @opindex mpack
18434 Pack VLIW instructions.
18436 @item -mno-pack
18437 @opindex mno-pack
18439 Do not pack VLIW instructions.
18441 @item -mno-eflags
18442 @opindex mno-eflags
18444 Do not mark ABI switches in e_flags.
18446 @item -mcond-move
18447 @opindex mcond-move
18449 Enable the use of conditional-move instructions (default).
18451 This switch is mainly for debugging the compiler and will likely be removed
18452 in a future version.
18454 @item -mno-cond-move
18455 @opindex mno-cond-move
18457 Disable the use of conditional-move instructions.
18459 This switch is mainly for debugging the compiler and will likely be removed
18460 in a future version.
18462 @item -mscc
18463 @opindex mscc
18465 Enable the use of conditional set instructions (default).
18467 This switch is mainly for debugging the compiler and will likely be removed
18468 in a future version.
18470 @item -mno-scc
18471 @opindex mno-scc
18473 Disable the use of conditional set instructions.
18475 This switch is mainly for debugging the compiler and will likely be removed
18476 in a future version.
18478 @item -mcond-exec
18479 @opindex mcond-exec
18481 Enable the use of conditional execution (default).
18483 This switch is mainly for debugging the compiler and will likely be removed
18484 in a future version.
18486 @item -mno-cond-exec
18487 @opindex mno-cond-exec
18489 Disable the use of conditional execution.
18491 This switch is mainly for debugging the compiler and will likely be removed
18492 in a future version.
18494 @item -mvliw-branch
18495 @opindex mvliw-branch
18497 Run a pass to pack branches into VLIW instructions (default).
18499 This switch is mainly for debugging the compiler and will likely be removed
18500 in a future version.
18502 @item -mno-vliw-branch
18503 @opindex mno-vliw-branch
18505 Do not run a pass to pack branches into VLIW instructions.
18507 This switch is mainly for debugging the compiler and will likely be removed
18508 in a future version.
18510 @item -mmulti-cond-exec
18511 @opindex mmulti-cond-exec
18513 Enable optimization of @code{&&} and @code{||} in conditional execution
18514 (default).
18516 This switch is mainly for debugging the compiler and will likely be removed
18517 in a future version.
18519 @item -mno-multi-cond-exec
18520 @opindex mno-multi-cond-exec
18522 Disable optimization of @code{&&} and @code{||} in conditional execution.
18524 This switch is mainly for debugging the compiler and will likely be removed
18525 in a future version.
18527 @item -mnested-cond-exec
18528 @opindex mnested-cond-exec
18530 Enable nested conditional execution optimizations (default).
18532 This switch is mainly for debugging the compiler and will likely be removed
18533 in a future version.
18535 @item -mno-nested-cond-exec
18536 @opindex mno-nested-cond-exec
18538 Disable nested conditional execution optimizations.
18540 This switch is mainly for debugging the compiler and will likely be removed
18541 in a future version.
18543 @item -moptimize-membar
18544 @opindex moptimize-membar
18546 This switch removes redundant @code{membar} instructions from the
18547 compiler-generated code.  It is enabled by default.
18549 @item -mno-optimize-membar
18550 @opindex mno-optimize-membar
18552 This switch disables the automatic removal of redundant @code{membar}
18553 instructions from the generated code.
18555 @item -mtomcat-stats
18556 @opindex mtomcat-stats
18558 Cause gas to print out tomcat statistics.
18560 @item -mcpu=@var{cpu}
18561 @opindex mcpu
18563 Select the processor type for which to generate code.  Possible values are
18564 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18565 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18567 @end table
18569 @node GNU/Linux Options
18570 @subsection GNU/Linux Options
18572 These @samp{-m} options are defined for GNU/Linux targets:
18574 @table @gcctabopt
18575 @item -mglibc
18576 @opindex mglibc
18577 Use the GNU C library.  This is the default except
18578 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18579 @samp{*-*-linux-*android*} targets.
18581 @item -muclibc
18582 @opindex muclibc
18583 Use uClibc C library.  This is the default on
18584 @samp{*-*-linux-*uclibc*} targets.
18586 @item -mmusl
18587 @opindex mmusl
18588 Use the musl C library.  This is the default on
18589 @samp{*-*-linux-*musl*} targets.
18591 @item -mbionic
18592 @opindex mbionic
18593 Use Bionic C library.  This is the default on
18594 @samp{*-*-linux-*android*} targets.
18596 @item -mandroid
18597 @opindex mandroid
18598 Compile code compatible with Android platform.  This is the default on
18599 @samp{*-*-linux-*android*} targets.
18601 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18602 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18603 this option makes the GCC driver pass Android-specific options to the linker.
18604 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18605 to be defined.
18607 @item -tno-android-cc
18608 @opindex tno-android-cc
18609 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18610 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18611 @option{-fno-rtti} by default.
18613 @item -tno-android-ld
18614 @opindex tno-android-ld
18615 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18616 linking options to the linker.
18618 @end table
18620 @node H8/300 Options
18621 @subsection H8/300 Options
18623 These @samp{-m} options are defined for the H8/300 implementations:
18625 @table @gcctabopt
18626 @item -mrelax
18627 @opindex mrelax
18628 Shorten some address references at link time, when possible; uses the
18629 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18630 ld, Using ld}, for a fuller description.
18632 @item -mh
18633 @opindex mh
18634 Generate code for the H8/300H@.
18636 @item -ms
18637 @opindex ms
18638 Generate code for the H8S@.
18640 @item -mn
18641 @opindex mn
18642 Generate code for the H8S and H8/300H in the normal mode.  This switch
18643 must be used either with @option{-mh} or @option{-ms}.
18645 @item -ms2600
18646 @opindex ms2600
18647 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18649 @item -mexr
18650 @opindex mexr
18651 Extended registers are stored on stack before execution of function
18652 with monitor attribute. Default option is @option{-mexr}.
18653 This option is valid only for H8S targets.
18655 @item -mno-exr
18656 @opindex mno-exr
18657 Extended registers are not stored on stack before execution of function 
18658 with monitor attribute. Default option is @option{-mno-exr}. 
18659 This option is valid only for H8S targets.
18661 @item -mint32
18662 @opindex mint32
18663 Make @code{int} data 32 bits by default.
18665 @item -malign-300
18666 @opindex malign-300
18667 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18668 The default for the H8/300H and H8S is to align longs and floats on
18669 4-byte boundaries.
18670 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18671 This option has no effect on the H8/300.
18672 @end table
18674 @node HPPA Options
18675 @subsection HPPA Options
18676 @cindex HPPA Options
18678 These @samp{-m} options are defined for the HPPA family of computers:
18680 @table @gcctabopt
18681 @item -march=@var{architecture-type}
18682 @opindex march
18683 Generate code for the specified architecture.  The choices for
18684 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18685 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18686 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18687 architecture option for your machine.  Code compiled for lower numbered
18688 architectures runs on higher numbered architectures, but not the
18689 other way around.
18691 @item -mpa-risc-1-0
18692 @itemx -mpa-risc-1-1
18693 @itemx -mpa-risc-2-0
18694 @opindex mpa-risc-1-0
18695 @opindex mpa-risc-1-1
18696 @opindex mpa-risc-2-0
18697 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18699 @item -mcaller-copies
18700 @opindex mcaller-copies
18701 The caller copies function arguments passed by hidden reference.  This
18702 option should be used with care as it is not compatible with the default
18703 32-bit runtime.  However, only aggregates larger than eight bytes are
18704 passed by hidden reference and the option provides better compatibility
18705 with OpenMP.
18707 @item -mjump-in-delay
18708 @opindex mjump-in-delay
18709 This option is ignored and provided for compatibility purposes only.
18711 @item -mdisable-fpregs
18712 @opindex mdisable-fpregs
18713 Prevent floating-point registers from being used in any manner.  This is
18714 necessary for compiling kernels that perform lazy context switching of
18715 floating-point registers.  If you use this option and attempt to perform
18716 floating-point operations, the compiler aborts.
18718 @item -mdisable-indexing
18719 @opindex mdisable-indexing
18720 Prevent the compiler from using indexing address modes.  This avoids some
18721 rather obscure problems when compiling MIG generated code under MACH@.
18723 @item -mno-space-regs
18724 @opindex mno-space-regs
18725 Generate code that assumes the target has no space registers.  This allows
18726 GCC to generate faster indirect calls and use unscaled index address modes.
18728 Such code is suitable for level 0 PA systems and kernels.
18730 @item -mfast-indirect-calls
18731 @opindex mfast-indirect-calls
18732 Generate code that assumes calls never cross space boundaries.  This
18733 allows GCC to emit code that performs faster indirect calls.
18735 This option does not work in the presence of shared libraries or nested
18736 functions.
18738 @item -mfixed-range=@var{register-range}
18739 @opindex mfixed-range
18740 Generate code treating the given register range as fixed registers.
18741 A fixed register is one that the register allocator cannot use.  This is
18742 useful when compiling kernel code.  A register range is specified as
18743 two registers separated by a dash.  Multiple register ranges can be
18744 specified separated by a comma.
18746 @item -mlong-load-store
18747 @opindex mlong-load-store
18748 Generate 3-instruction load and store sequences as sometimes required by
18749 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18750 the HP compilers.
18752 @item -mportable-runtime
18753 @opindex mportable-runtime
18754 Use the portable calling conventions proposed by HP for ELF systems.
18756 @item -mgas
18757 @opindex mgas
18758 Enable the use of assembler directives only GAS understands.
18760 @item -mschedule=@var{cpu-type}
18761 @opindex mschedule
18762 Schedule code according to the constraints for the machine type
18763 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18764 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18765 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18766 proper scheduling option for your machine.  The default scheduling is
18767 @samp{8000}.
18769 @item -mlinker-opt
18770 @opindex mlinker-opt
18771 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18772 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18773 linkers in which they give bogus error messages when linking some programs.
18775 @item -msoft-float
18776 @opindex msoft-float
18777 Generate output containing library calls for floating point.
18778 @strong{Warning:} the requisite libraries are not available for all HPPA
18779 targets.  Normally the facilities of the machine's usual C compiler are
18780 used, but this cannot be done directly in cross-compilation.  You must make
18781 your own arrangements to provide suitable library functions for
18782 cross-compilation.
18784 @option{-msoft-float} changes the calling convention in the output file;
18785 therefore, it is only useful if you compile @emph{all} of a program with
18786 this option.  In particular, you need to compile @file{libgcc.a}, the
18787 library that comes with GCC, with @option{-msoft-float} in order for
18788 this to work.
18790 @item -msio
18791 @opindex msio
18792 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18793 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18794 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18795 options are available under HP-UX and HI-UX@.
18797 @item -mgnu-ld
18798 @opindex mgnu-ld
18799 Use options specific to GNU @command{ld}.
18800 This passes @option{-shared} to @command{ld} when
18801 building a shared library.  It is the default when GCC is configured,
18802 explicitly or implicitly, with the GNU linker.  This option does not
18803 affect which @command{ld} is called; it only changes what parameters
18804 are passed to that @command{ld}.
18805 The @command{ld} that is called is determined by the
18806 @option{--with-ld} configure option, GCC's program search path, and
18807 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18808 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18809 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18811 @item -mhp-ld
18812 @opindex mhp-ld
18813 Use options specific to HP @command{ld}.
18814 This passes @option{-b} to @command{ld} when building
18815 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18816 links.  It is the default when GCC is configured, explicitly or
18817 implicitly, with the HP linker.  This option does not affect
18818 which @command{ld} is called; it only changes what parameters are passed to that
18819 @command{ld}.
18820 The @command{ld} that is called is determined by the @option{--with-ld}
18821 configure option, GCC's program search path, and finally by the user's
18822 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18823 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18824 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18826 @item -mlong-calls
18827 @opindex mno-long-calls
18828 Generate code that uses long call sequences.  This ensures that a call
18829 is always able to reach linker generated stubs.  The default is to generate
18830 long calls only when the distance from the call site to the beginning
18831 of the function or translation unit, as the case may be, exceeds a
18832 predefined limit set by the branch type being used.  The limits for
18833 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18834 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18835 240,000 bytes.
18837 Distances are measured from the beginning of functions when using the
18838 @option{-ffunction-sections} option, or when using the @option{-mgas}
18839 and @option{-mno-portable-runtime} options together under HP-UX with
18840 the SOM linker.
18842 It is normally not desirable to use this option as it degrades
18843 performance.  However, it may be useful in large applications,
18844 particularly when partial linking is used to build the application.
18846 The types of long calls used depends on the capabilities of the
18847 assembler and linker, and the type of code being generated.  The
18848 impact on systems that support long absolute calls, and long pic
18849 symbol-difference or pc-relative calls should be relatively small.
18850 However, an indirect call is used on 32-bit ELF systems in pic code
18851 and it is quite long.
18853 @item -munix=@var{unix-std}
18854 @opindex march
18855 Generate compiler predefines and select a startfile for the specified
18856 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18857 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18858 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18859 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18860 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18861 and later.
18863 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18864 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18865 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18866 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18867 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18868 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18870 It is @emph{important} to note that this option changes the interfaces
18871 for various library routines.  It also affects the operational behavior
18872 of the C library.  Thus, @emph{extreme} care is needed in using this
18873 option.
18875 Library code that is intended to operate with more than one UNIX
18876 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18877 as appropriate.  Most GNU software doesn't provide this capability.
18879 @item -nolibdld
18880 @opindex nolibdld
18881 Suppress the generation of link options to search libdld.sl when the
18882 @option{-static} option is specified on HP-UX 10 and later.
18884 @item -static
18885 @opindex static
18886 The HP-UX implementation of setlocale in libc has a dependency on
18887 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18888 when the @option{-static} option is specified, special link options
18889 are needed to resolve this dependency.
18891 On HP-UX 10 and later, the GCC driver adds the necessary options to
18892 link with libdld.sl when the @option{-static} option is specified.
18893 This causes the resulting binary to be dynamic.  On the 64-bit port,
18894 the linkers generate dynamic binaries by default in any case.  The
18895 @option{-nolibdld} option can be used to prevent the GCC driver from
18896 adding these link options.
18898 @item -threads
18899 @opindex threads
18900 Add support for multithreading with the @dfn{dce thread} library
18901 under HP-UX@.  This option sets flags for both the preprocessor and
18902 linker.
18903 @end table
18905 @node IA-64 Options
18906 @subsection IA-64 Options
18907 @cindex IA-64 Options
18909 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18911 @table @gcctabopt
18912 @item -mbig-endian
18913 @opindex mbig-endian
18914 Generate code for a big-endian target.  This is the default for HP-UX@.
18916 @item -mlittle-endian
18917 @opindex mlittle-endian
18918 Generate code for a little-endian target.  This is the default for AIX5
18919 and GNU/Linux.
18921 @item -mgnu-as
18922 @itemx -mno-gnu-as
18923 @opindex mgnu-as
18924 @opindex mno-gnu-as
18925 Generate (or don't) code for the GNU assembler.  This is the default.
18926 @c Also, this is the default if the configure option @option{--with-gnu-as}
18927 @c is used.
18929 @item -mgnu-ld
18930 @itemx -mno-gnu-ld
18931 @opindex mgnu-ld
18932 @opindex mno-gnu-ld
18933 Generate (or don't) code for the GNU linker.  This is the default.
18934 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18935 @c is used.
18937 @item -mno-pic
18938 @opindex mno-pic
18939 Generate code that does not use a global pointer register.  The result
18940 is not position independent code, and violates the IA-64 ABI@.
18942 @item -mvolatile-asm-stop
18943 @itemx -mno-volatile-asm-stop
18944 @opindex mvolatile-asm-stop
18945 @opindex mno-volatile-asm-stop
18946 Generate (or don't) a stop bit immediately before and after volatile asm
18947 statements.
18949 @item -mregister-names
18950 @itemx -mno-register-names
18951 @opindex mregister-names
18952 @opindex mno-register-names
18953 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18954 the stacked registers.  This may make assembler output more readable.
18956 @item -mno-sdata
18957 @itemx -msdata
18958 @opindex mno-sdata
18959 @opindex msdata
18960 Disable (or enable) optimizations that use the small data section.  This may
18961 be useful for working around optimizer bugs.
18963 @item -mconstant-gp
18964 @opindex mconstant-gp
18965 Generate code that uses a single constant global pointer value.  This is
18966 useful when compiling kernel code.
18968 @item -mauto-pic
18969 @opindex mauto-pic
18970 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18971 This is useful when compiling firmware code.
18973 @item -minline-float-divide-min-latency
18974 @opindex minline-float-divide-min-latency
18975 Generate code for inline divides of floating-point values
18976 using the minimum latency algorithm.
18978 @item -minline-float-divide-max-throughput
18979 @opindex minline-float-divide-max-throughput
18980 Generate code for inline divides of floating-point values
18981 using the maximum throughput algorithm.
18983 @item -mno-inline-float-divide
18984 @opindex mno-inline-float-divide
18985 Do not generate inline code for divides of floating-point values.
18987 @item -minline-int-divide-min-latency
18988 @opindex minline-int-divide-min-latency
18989 Generate code for inline divides of integer values
18990 using the minimum latency algorithm.
18992 @item -minline-int-divide-max-throughput
18993 @opindex minline-int-divide-max-throughput
18994 Generate code for inline divides of integer values
18995 using the maximum throughput algorithm.
18997 @item -mno-inline-int-divide
18998 @opindex mno-inline-int-divide
18999 Do not generate inline code for divides of integer values.
19001 @item -minline-sqrt-min-latency
19002 @opindex minline-sqrt-min-latency
19003 Generate code for inline square roots
19004 using the minimum latency algorithm.
19006 @item -minline-sqrt-max-throughput
19007 @opindex minline-sqrt-max-throughput
19008 Generate code for inline square roots
19009 using the maximum throughput algorithm.
19011 @item -mno-inline-sqrt
19012 @opindex mno-inline-sqrt
19013 Do not generate inline code for @code{sqrt}.
19015 @item -mfused-madd
19016 @itemx -mno-fused-madd
19017 @opindex mfused-madd
19018 @opindex mno-fused-madd
19019 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
19020 instructions.  The default is to use these instructions.
19022 @item -mno-dwarf2-asm
19023 @itemx -mdwarf2-asm
19024 @opindex mno-dwarf2-asm
19025 @opindex mdwarf2-asm
19026 Don't (or do) generate assembler code for the DWARF line number debugging
19027 info.  This may be useful when not using the GNU assembler.
19029 @item -mearly-stop-bits
19030 @itemx -mno-early-stop-bits
19031 @opindex mearly-stop-bits
19032 @opindex mno-early-stop-bits
19033 Allow stop bits to be placed earlier than immediately preceding the
19034 instruction that triggered the stop bit.  This can improve instruction
19035 scheduling, but does not always do so.
19037 @item -mfixed-range=@var{register-range}
19038 @opindex mfixed-range
19039 Generate code treating the given register range as fixed registers.
19040 A fixed register is one that the register allocator cannot use.  This is
19041 useful when compiling kernel code.  A register range is specified as
19042 two registers separated by a dash.  Multiple register ranges can be
19043 specified separated by a comma.
19045 @item -mtls-size=@var{tls-size}
19046 @opindex mtls-size
19047 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
19050 @item -mtune=@var{cpu-type}
19051 @opindex mtune
19052 Tune the instruction scheduling for a particular CPU, Valid values are
19053 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
19054 and @samp{mckinley}.
19056 @item -milp32
19057 @itemx -mlp64
19058 @opindex milp32
19059 @opindex mlp64
19060 Generate code for a 32-bit or 64-bit environment.
19061 The 32-bit environment sets int, long and pointer to 32 bits.
19062 The 64-bit environment sets int to 32 bits and long and pointer
19063 to 64 bits.  These are HP-UX specific flags.
19065 @item -mno-sched-br-data-spec
19066 @itemx -msched-br-data-spec
19067 @opindex mno-sched-br-data-spec
19068 @opindex msched-br-data-spec
19069 (Dis/En)able data speculative scheduling before reload.
19070 This results in generation of @code{ld.a} instructions and
19071 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19072 The default setting is disabled.
19074 @item -msched-ar-data-spec
19075 @itemx -mno-sched-ar-data-spec
19076 @opindex msched-ar-data-spec
19077 @opindex mno-sched-ar-data-spec
19078 (En/Dis)able data speculative scheduling after reload.
19079 This results in generation of @code{ld.a} instructions and
19080 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19081 The default setting is enabled.
19083 @item -mno-sched-control-spec
19084 @itemx -msched-control-spec
19085 @opindex mno-sched-control-spec
19086 @opindex msched-control-spec
19087 (Dis/En)able control speculative scheduling.  This feature is
19088 available only during region scheduling (i.e.@: before reload).
19089 This results in generation of the @code{ld.s} instructions and
19090 the corresponding check instructions @code{chk.s}.
19091 The default setting is disabled.
19093 @item -msched-br-in-data-spec
19094 @itemx -mno-sched-br-in-data-spec
19095 @opindex msched-br-in-data-spec
19096 @opindex mno-sched-br-in-data-spec
19097 (En/Dis)able speculative scheduling of the instructions that
19098 are dependent on the data speculative loads before reload.
19099 This is effective only with @option{-msched-br-data-spec} enabled.
19100 The default setting is enabled.
19102 @item -msched-ar-in-data-spec
19103 @itemx -mno-sched-ar-in-data-spec
19104 @opindex msched-ar-in-data-spec
19105 @opindex mno-sched-ar-in-data-spec
19106 (En/Dis)able speculative scheduling of the instructions that
19107 are dependent on the data speculative loads after reload.
19108 This is effective only with @option{-msched-ar-data-spec} enabled.
19109 The default setting is enabled.
19111 @item -msched-in-control-spec
19112 @itemx -mno-sched-in-control-spec
19113 @opindex msched-in-control-spec
19114 @opindex mno-sched-in-control-spec
19115 (En/Dis)able speculative scheduling of the instructions that
19116 are dependent on the control speculative loads.
19117 This is effective only with @option{-msched-control-spec} enabled.
19118 The default setting is enabled.
19120 @item -mno-sched-prefer-non-data-spec-insns
19121 @itemx -msched-prefer-non-data-spec-insns
19122 @opindex mno-sched-prefer-non-data-spec-insns
19123 @opindex msched-prefer-non-data-spec-insns
19124 If enabled, data-speculative instructions are chosen for schedule
19125 only if there are no other choices at the moment.  This makes
19126 the use of the data speculation much more conservative.
19127 The default setting is disabled.
19129 @item -mno-sched-prefer-non-control-spec-insns
19130 @itemx -msched-prefer-non-control-spec-insns
19131 @opindex mno-sched-prefer-non-control-spec-insns
19132 @opindex msched-prefer-non-control-spec-insns
19133 If enabled, control-speculative instructions are chosen for schedule
19134 only if there are no other choices at the moment.  This makes
19135 the use of the control speculation much more conservative.
19136 The default setting is disabled.
19138 @item -mno-sched-count-spec-in-critical-path
19139 @itemx -msched-count-spec-in-critical-path
19140 @opindex mno-sched-count-spec-in-critical-path
19141 @opindex msched-count-spec-in-critical-path
19142 If enabled, speculative dependencies are considered during
19143 computation of the instructions priorities.  This makes the use of the
19144 speculation a bit more conservative.
19145 The default setting is disabled.
19147 @item -msched-spec-ldc
19148 @opindex msched-spec-ldc
19149 Use a simple data speculation check.  This option is on by default.
19151 @item -msched-control-spec-ldc
19152 @opindex msched-spec-ldc
19153 Use a simple check for control speculation.  This option is on by default.
19155 @item -msched-stop-bits-after-every-cycle
19156 @opindex msched-stop-bits-after-every-cycle
19157 Place a stop bit after every cycle when scheduling.  This option is on
19158 by default.
19160 @item -msched-fp-mem-deps-zero-cost
19161 @opindex msched-fp-mem-deps-zero-cost
19162 Assume that floating-point stores and loads are not likely to cause a conflict
19163 when placed into the same instruction group.  This option is disabled by
19164 default.
19166 @item -msel-sched-dont-check-control-spec
19167 @opindex msel-sched-dont-check-control-spec
19168 Generate checks for control speculation in selective scheduling.
19169 This flag is disabled by default.
19171 @item -msched-max-memory-insns=@var{max-insns}
19172 @opindex msched-max-memory-insns
19173 Limit on the number of memory insns per instruction group, giving lower
19174 priority to subsequent memory insns attempting to schedule in the same
19175 instruction group. Frequently useful to prevent cache bank conflicts.
19176 The default value is 1.
19178 @item -msched-max-memory-insns-hard-limit
19179 @opindex msched-max-memory-insns-hard-limit
19180 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
19181 disallowing more than that number in an instruction group.
19182 Otherwise, the limit is ``soft'', meaning that non-memory operations
19183 are preferred when the limit is reached, but memory operations may still
19184 be scheduled.
19186 @end table
19188 @node LM32 Options
19189 @subsection LM32 Options
19190 @cindex LM32 options
19192 These @option{-m} options are defined for the LatticeMico32 architecture:
19194 @table @gcctabopt
19195 @item -mbarrel-shift-enabled
19196 @opindex mbarrel-shift-enabled
19197 Enable barrel-shift instructions.
19199 @item -mdivide-enabled
19200 @opindex mdivide-enabled
19201 Enable divide and modulus instructions.
19203 @item -mmultiply-enabled
19204 @opindex multiply-enabled
19205 Enable multiply instructions.
19207 @item -msign-extend-enabled
19208 @opindex msign-extend-enabled
19209 Enable sign extend instructions.
19211 @item -muser-enabled
19212 @opindex muser-enabled
19213 Enable user-defined instructions.
19215 @end table
19217 @node M32C Options
19218 @subsection M32C Options
19219 @cindex M32C options
19221 @table @gcctabopt
19222 @item -mcpu=@var{name}
19223 @opindex mcpu=
19224 Select the CPU for which code is generated.  @var{name} may be one of
19225 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
19226 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
19227 the M32C/80 series.
19229 @item -msim
19230 @opindex msim
19231 Specifies that the program will be run on the simulator.  This causes
19232 an alternate runtime library to be linked in which supports, for
19233 example, file I/O@.  You must not use this option when generating
19234 programs that will run on real hardware; you must provide your own
19235 runtime library for whatever I/O functions are needed.
19237 @item -memregs=@var{number}
19238 @opindex memregs=
19239 Specifies the number of memory-based pseudo-registers GCC uses
19240 during code generation.  These pseudo-registers are used like real
19241 registers, so there is a tradeoff between GCC's ability to fit the
19242 code into available registers, and the performance penalty of using
19243 memory instead of registers.  Note that all modules in a program must
19244 be compiled with the same value for this option.  Because of that, you
19245 must not use this option with GCC's default runtime libraries.
19247 @end table
19249 @node M32R/D Options
19250 @subsection M32R/D Options
19251 @cindex M32R/D options
19253 These @option{-m} options are defined for Renesas M32R/D architectures:
19255 @table @gcctabopt
19256 @item -m32r2
19257 @opindex m32r2
19258 Generate code for the M32R/2@.
19260 @item -m32rx
19261 @opindex m32rx
19262 Generate code for the M32R/X@.
19264 @item -m32r
19265 @opindex m32r
19266 Generate code for the M32R@.  This is the default.
19268 @item -mmodel=small
19269 @opindex mmodel=small
19270 Assume all objects live in the lower 16MB of memory (so that their addresses
19271 can be loaded with the @code{ld24} instruction), and assume all subroutines
19272 are reachable with the @code{bl} instruction.
19273 This is the default.
19275 The addressability of a particular object can be set with the
19276 @code{model} attribute.
19278 @item -mmodel=medium
19279 @opindex mmodel=medium
19280 Assume objects may be anywhere in the 32-bit address space (the compiler
19281 generates @code{seth/add3} instructions to load their addresses), and
19282 assume all subroutines are reachable with the @code{bl} instruction.
19284 @item -mmodel=large
19285 @opindex mmodel=large
19286 Assume objects may be anywhere in the 32-bit address space (the compiler
19287 generates @code{seth/add3} instructions to load their addresses), and
19288 assume subroutines may not be reachable with the @code{bl} instruction
19289 (the compiler generates the much slower @code{seth/add3/jl}
19290 instruction sequence).
19292 @item -msdata=none
19293 @opindex msdata=none
19294 Disable use of the small data area.  Variables are put into
19295 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19296 @code{section} attribute has been specified).
19297 This is the default.
19299 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19300 Objects may be explicitly put in the small data area with the
19301 @code{section} attribute using one of these sections.
19303 @item -msdata=sdata
19304 @opindex msdata=sdata
19305 Put small global and static data in the small data area, but do not
19306 generate special code to reference them.
19308 @item -msdata=use
19309 @opindex msdata=use
19310 Put small global and static data in the small data area, and generate
19311 special instructions to reference them.
19313 @item -G @var{num}
19314 @opindex G
19315 @cindex smaller data references
19316 Put global and static objects less than or equal to @var{num} bytes
19317 into the small data or BSS sections instead of the normal data or BSS
19318 sections.  The default value of @var{num} is 8.
19319 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
19320 for this option to have any effect.
19322 All modules should be compiled with the same @option{-G @var{num}} value.
19323 Compiling with different values of @var{num} may or may not work; if it
19324 doesn't the linker gives an error message---incorrect code is not
19325 generated.
19327 @item -mdebug
19328 @opindex mdebug
19329 Makes the M32R-specific code in the compiler display some statistics
19330 that might help in debugging programs.
19332 @item -malign-loops
19333 @opindex malign-loops
19334 Align all loops to a 32-byte boundary.
19336 @item -mno-align-loops
19337 @opindex mno-align-loops
19338 Do not enforce a 32-byte alignment for loops.  This is the default.
19340 @item -missue-rate=@var{number}
19341 @opindex missue-rate=@var{number}
19342 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19343 or 2.
19345 @item -mbranch-cost=@var{number}
19346 @opindex mbranch-cost=@var{number}
19347 @var{number} can only be 1 or 2.  If it is 1 then branches are
19348 preferred over conditional code, if it is 2, then the opposite applies.
19350 @item -mflush-trap=@var{number}
19351 @opindex mflush-trap=@var{number}
19352 Specifies the trap number to use to flush the cache.  The default is
19353 12.  Valid numbers are between 0 and 15 inclusive.
19355 @item -mno-flush-trap
19356 @opindex mno-flush-trap
19357 Specifies that the cache cannot be flushed by using a trap.
19359 @item -mflush-func=@var{name}
19360 @opindex mflush-func=@var{name}
19361 Specifies the name of the operating system function to call to flush
19362 the cache.  The default is @samp{_flush_cache}, but a function call
19363 is only used if a trap is not available.
19365 @item -mno-flush-func
19366 @opindex mno-flush-func
19367 Indicates that there is no OS function for flushing the cache.
19369 @end table
19371 @node M680x0 Options
19372 @subsection M680x0 Options
19373 @cindex M680x0 options
19375 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19376 The default settings depend on which architecture was selected when
19377 the compiler was configured; the defaults for the most common choices
19378 are given below.
19380 @table @gcctabopt
19381 @item -march=@var{arch}
19382 @opindex march
19383 Generate code for a specific M680x0 or ColdFire instruction set
19384 architecture.  Permissible values of @var{arch} for M680x0
19385 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19386 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19387 architectures are selected according to Freescale's ISA classification
19388 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19389 @samp{isab} and @samp{isac}.
19391 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19392 code for a ColdFire target.  The @var{arch} in this macro is one of the
19393 @option{-march} arguments given above.
19395 When used together, @option{-march} and @option{-mtune} select code
19396 that runs on a family of similar processors but that is optimized
19397 for a particular microarchitecture.
19399 @item -mcpu=@var{cpu}
19400 @opindex mcpu
19401 Generate code for a specific M680x0 or ColdFire processor.
19402 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19403 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19404 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19405 below, which also classifies the CPUs into families:
19407 @multitable @columnfractions 0.20 0.80
19408 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19409 @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}
19410 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19411 @item @samp{5206e} @tab @samp{5206e}
19412 @item @samp{5208} @tab @samp{5207} @samp{5208}
19413 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19414 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19415 @item @samp{5216} @tab @samp{5214} @samp{5216}
19416 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19417 @item @samp{5225} @tab @samp{5224} @samp{5225}
19418 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19419 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19420 @item @samp{5249} @tab @samp{5249}
19421 @item @samp{5250} @tab @samp{5250}
19422 @item @samp{5271} @tab @samp{5270} @samp{5271}
19423 @item @samp{5272} @tab @samp{5272}
19424 @item @samp{5275} @tab @samp{5274} @samp{5275}
19425 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19426 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19427 @item @samp{5307} @tab @samp{5307}
19428 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19429 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19430 @item @samp{5407} @tab @samp{5407}
19431 @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}
19432 @end multitable
19434 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19435 @var{arch} is compatible with @var{cpu}.  Other combinations of
19436 @option{-mcpu} and @option{-march} are rejected.
19438 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19439 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19440 where the value of @var{family} is given by the table above.
19442 @item -mtune=@var{tune}
19443 @opindex mtune
19444 Tune the code for a particular microarchitecture within the
19445 constraints set by @option{-march} and @option{-mcpu}.
19446 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19447 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19448 and @samp{cpu32}.  The ColdFire microarchitectures
19449 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19451 You can also use @option{-mtune=68020-40} for code that needs
19452 to run relatively well on 68020, 68030 and 68040 targets.
19453 @option{-mtune=68020-60} is similar but includes 68060 targets
19454 as well.  These two options select the same tuning decisions as
19455 @option{-m68020-40} and @option{-m68020-60} respectively.
19457 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19458 when tuning for 680x0 architecture @var{arch}.  It also defines
19459 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19460 option is used.  If GCC is tuning for a range of architectures,
19461 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19462 it defines the macros for every architecture in the range.
19464 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19465 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19466 of the arguments given above.
19468 @item -m68000
19469 @itemx -mc68000
19470 @opindex m68000
19471 @opindex mc68000
19472 Generate output for a 68000.  This is the default
19473 when the compiler is configured for 68000-based systems.
19474 It is equivalent to @option{-march=68000}.
19476 Use this option for microcontrollers with a 68000 or EC000 core,
19477 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19479 @item -m68010
19480 @opindex m68010
19481 Generate output for a 68010.  This is the default
19482 when the compiler is configured for 68010-based systems.
19483 It is equivalent to @option{-march=68010}.
19485 @item -m68020
19486 @itemx -mc68020
19487 @opindex m68020
19488 @opindex mc68020
19489 Generate output for a 68020.  This is the default
19490 when the compiler is configured for 68020-based systems.
19491 It is equivalent to @option{-march=68020}.
19493 @item -m68030
19494 @opindex m68030
19495 Generate output for a 68030.  This is the default when the compiler is
19496 configured for 68030-based systems.  It is equivalent to
19497 @option{-march=68030}.
19499 @item -m68040
19500 @opindex m68040
19501 Generate output for a 68040.  This is the default when the compiler is
19502 configured for 68040-based systems.  It is equivalent to
19503 @option{-march=68040}.
19505 This option inhibits the use of 68881/68882 instructions that have to be
19506 emulated by software on the 68040.  Use this option if your 68040 does not
19507 have code to emulate those instructions.
19509 @item -m68060
19510 @opindex m68060
19511 Generate output for a 68060.  This is the default when the compiler is
19512 configured for 68060-based systems.  It is equivalent to
19513 @option{-march=68060}.
19515 This option inhibits the use of 68020 and 68881/68882 instructions that
19516 have to be emulated by software on the 68060.  Use this option if your 68060
19517 does not have code to emulate those instructions.
19519 @item -mcpu32
19520 @opindex mcpu32
19521 Generate output for a CPU32.  This is the default
19522 when the compiler is configured for CPU32-based systems.
19523 It is equivalent to @option{-march=cpu32}.
19525 Use this option for microcontrollers with a
19526 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19527 68336, 68340, 68341, 68349 and 68360.
19529 @item -m5200
19530 @opindex m5200
19531 Generate output for a 520X ColdFire CPU@.  This is the default
19532 when the compiler is configured for 520X-based systems.
19533 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19534 in favor of that option.
19536 Use this option for microcontroller with a 5200 core, including
19537 the MCF5202, MCF5203, MCF5204 and MCF5206.
19539 @item -m5206e
19540 @opindex m5206e
19541 Generate output for a 5206e ColdFire CPU@.  The option is now
19542 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19544 @item -m528x
19545 @opindex m528x
19546 Generate output for a member of the ColdFire 528X family.
19547 The option is now deprecated in favor of the equivalent
19548 @option{-mcpu=528x}.
19550 @item -m5307
19551 @opindex m5307
19552 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19553 in favor of the equivalent @option{-mcpu=5307}.
19555 @item -m5407
19556 @opindex m5407
19557 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19558 in favor of the equivalent @option{-mcpu=5407}.
19560 @item -mcfv4e
19561 @opindex mcfv4e
19562 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19563 This includes use of hardware floating-point instructions.
19564 The option is equivalent to @option{-mcpu=547x}, and is now
19565 deprecated in favor of that option.
19567 @item -m68020-40
19568 @opindex m68020-40
19569 Generate output for a 68040, without using any of the new instructions.
19570 This results in code that can run relatively efficiently on either a
19571 68020/68881 or a 68030 or a 68040.  The generated code does use the
19572 68881 instructions that are emulated on the 68040.
19574 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19576 @item -m68020-60
19577 @opindex m68020-60
19578 Generate output for a 68060, without using any of the new instructions.
19579 This results in code that can run relatively efficiently on either a
19580 68020/68881 or a 68030 or a 68040.  The generated code does use the
19581 68881 instructions that are emulated on the 68060.
19583 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19585 @item -mhard-float
19586 @itemx -m68881
19587 @opindex mhard-float
19588 @opindex m68881
19589 Generate floating-point instructions.  This is the default for 68020
19590 and above, and for ColdFire devices that have an FPU@.  It defines the
19591 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19592 on ColdFire targets.
19594 @item -msoft-float
19595 @opindex msoft-float
19596 Do not generate floating-point instructions; use library calls instead.
19597 This is the default for 68000, 68010, and 68832 targets.  It is also
19598 the default for ColdFire devices that have no FPU.
19600 @item -mdiv
19601 @itemx -mno-div
19602 @opindex mdiv
19603 @opindex mno-div
19604 Generate (do not generate) ColdFire hardware divide and remainder
19605 instructions.  If @option{-march} is used without @option{-mcpu},
19606 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19607 architectures.  Otherwise, the default is taken from the target CPU
19608 (either the default CPU, or the one specified by @option{-mcpu}).  For
19609 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19610 @option{-mcpu=5206e}.
19612 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19614 @item -mshort
19615 @opindex mshort
19616 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19617 Additionally, parameters passed on the stack are also aligned to a
19618 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19620 @item -mno-short
19621 @opindex mno-short
19622 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19624 @item -mnobitfield
19625 @itemx -mno-bitfield
19626 @opindex mnobitfield
19627 @opindex mno-bitfield
19628 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19629 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19631 @item -mbitfield
19632 @opindex mbitfield
19633 Do use the bit-field instructions.  The @option{-m68020} option implies
19634 @option{-mbitfield}.  This is the default if you use a configuration
19635 designed for a 68020.
19637 @item -mrtd
19638 @opindex mrtd
19639 Use a different function-calling convention, in which functions
19640 that take a fixed number of arguments return with the @code{rtd}
19641 instruction, which pops their arguments while returning.  This
19642 saves one instruction in the caller since there is no need to pop
19643 the arguments there.
19645 This calling convention is incompatible with the one normally
19646 used on Unix, so you cannot use it if you need to call libraries
19647 compiled with the Unix compiler.
19649 Also, you must provide function prototypes for all functions that
19650 take variable numbers of arguments (including @code{printf});
19651 otherwise incorrect code is generated for calls to those
19652 functions.
19654 In addition, seriously incorrect code results if you call a
19655 function with too many arguments.  (Normally, extra arguments are
19656 harmlessly ignored.)
19658 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19659 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19661 @item -mno-rtd
19662 @opindex mno-rtd
19663 Do not use the calling conventions selected by @option{-mrtd}.
19664 This is the default.
19666 @item -malign-int
19667 @itemx -mno-align-int
19668 @opindex malign-int
19669 @opindex mno-align-int
19670 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19671 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19672 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19673 Aligning variables on 32-bit boundaries produces code that runs somewhat
19674 faster on processors with 32-bit busses at the expense of more memory.
19676 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19677 aligns structures containing the above types differently than
19678 most published application binary interface specifications for the m68k.
19680 @item -mpcrel
19681 @opindex mpcrel
19682 Use the pc-relative addressing mode of the 68000 directly, instead of
19683 using a global offset table.  At present, this option implies @option{-fpic},
19684 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19685 not presently supported with @option{-mpcrel}, though this could be supported for
19686 68020 and higher processors.
19688 @item -mno-strict-align
19689 @itemx -mstrict-align
19690 @opindex mno-strict-align
19691 @opindex mstrict-align
19692 Do not (do) assume that unaligned memory references are handled by
19693 the system.
19695 @item -msep-data
19696 Generate code that allows the data segment to be located in a different
19697 area of memory from the text segment.  This allows for execute-in-place in
19698 an environment without virtual memory management.  This option implies
19699 @option{-fPIC}.
19701 @item -mno-sep-data
19702 Generate code that assumes that the data segment follows the text segment.
19703 This is the default.
19705 @item -mid-shared-library
19706 Generate code that supports shared libraries via the library ID method.
19707 This allows for execute-in-place and shared libraries in an environment
19708 without virtual memory management.  This option implies @option{-fPIC}.
19710 @item -mno-id-shared-library
19711 Generate code that doesn't assume ID-based shared libraries are being used.
19712 This is the default.
19714 @item -mshared-library-id=n
19715 Specifies the identification number of the ID-based shared library being
19716 compiled.  Specifying a value of 0 generates more compact code; specifying
19717 other values forces the allocation of that number to the current
19718 library, but is no more space- or time-efficient than omitting this option.
19720 @item -mxgot
19721 @itemx -mno-xgot
19722 @opindex mxgot
19723 @opindex mno-xgot
19724 When generating position-independent code for ColdFire, generate code
19725 that works if the GOT has more than 8192 entries.  This code is
19726 larger and slower than code generated without this option.  On M680x0
19727 processors, this option is not needed; @option{-fPIC} suffices.
19729 GCC normally uses a single instruction to load values from the GOT@.
19730 While this is relatively efficient, it only works if the GOT
19731 is smaller than about 64k.  Anything larger causes the linker
19732 to report an error such as:
19734 @cindex relocation truncated to fit (ColdFire)
19735 @smallexample
19736 relocation truncated to fit: R_68K_GOT16O foobar
19737 @end smallexample
19739 If this happens, you should recompile your code with @option{-mxgot}.
19740 It should then work with very large GOTs.  However, code generated with
19741 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19742 the value of a global symbol.
19744 Note that some linkers, including newer versions of the GNU linker,
19745 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19746 you should only need to use @option{-mxgot} when compiling a single
19747 object file that accesses more than 8192 GOT entries.  Very few do.
19749 These options have no effect unless GCC is generating
19750 position-independent code.
19752 @item -mlong-jump-table-offsets
19753 @opindex mlong-jump-table-offsets
19754 Use 32-bit offsets in @code{switch} tables.  The default is to use
19755 16-bit offsets.
19757 @end table
19759 @node MCore Options
19760 @subsection MCore Options
19761 @cindex MCore options
19763 These are the @samp{-m} options defined for the Motorola M*Core
19764 processors.
19766 @table @gcctabopt
19768 @item -mhardlit
19769 @itemx -mno-hardlit
19770 @opindex mhardlit
19771 @opindex mno-hardlit
19772 Inline constants into the code stream if it can be done in two
19773 instructions or less.
19775 @item -mdiv
19776 @itemx -mno-div
19777 @opindex mdiv
19778 @opindex mno-div
19779 Use the divide instruction.  (Enabled by default).
19781 @item -mrelax-immediate
19782 @itemx -mno-relax-immediate
19783 @opindex mrelax-immediate
19784 @opindex mno-relax-immediate
19785 Allow arbitrary-sized immediates in bit operations.
19787 @item -mwide-bitfields
19788 @itemx -mno-wide-bitfields
19789 @opindex mwide-bitfields
19790 @opindex mno-wide-bitfields
19791 Always treat bit-fields as @code{int}-sized.
19793 @item -m4byte-functions
19794 @itemx -mno-4byte-functions
19795 @opindex m4byte-functions
19796 @opindex mno-4byte-functions
19797 Force all functions to be aligned to a 4-byte boundary.
19799 @item -mcallgraph-data
19800 @itemx -mno-callgraph-data
19801 @opindex mcallgraph-data
19802 @opindex mno-callgraph-data
19803 Emit callgraph information.
19805 @item -mslow-bytes
19806 @itemx -mno-slow-bytes
19807 @opindex mslow-bytes
19808 @opindex mno-slow-bytes
19809 Prefer word access when reading byte quantities.
19811 @item -mlittle-endian
19812 @itemx -mbig-endian
19813 @opindex mlittle-endian
19814 @opindex mbig-endian
19815 Generate code for a little-endian target.
19817 @item -m210
19818 @itemx -m340
19819 @opindex m210
19820 @opindex m340
19821 Generate code for the 210 processor.
19823 @item -mno-lsim
19824 @opindex mno-lsim
19825 Assume that runtime support has been provided and so omit the
19826 simulator library (@file{libsim.a)} from the linker command line.
19828 @item -mstack-increment=@var{size}
19829 @opindex mstack-increment
19830 Set the maximum amount for a single stack increment operation.  Large
19831 values can increase the speed of programs that contain functions
19832 that need a large amount of stack space, but they can also trigger a
19833 segmentation fault if the stack is extended too much.  The default
19834 value is 0x1000.
19836 @end table
19838 @node MeP Options
19839 @subsection MeP Options
19840 @cindex MeP options
19842 @table @gcctabopt
19844 @item -mabsdiff
19845 @opindex mabsdiff
19846 Enables the @code{abs} instruction, which is the absolute difference
19847 between two registers.
19849 @item -mall-opts
19850 @opindex mall-opts
19851 Enables all the optional instructions---average, multiply, divide, bit
19852 operations, leading zero, absolute difference, min/max, clip, and
19853 saturation.
19856 @item -maverage
19857 @opindex maverage
19858 Enables the @code{ave} instruction, which computes the average of two
19859 registers.
19861 @item -mbased=@var{n}
19862 @opindex mbased=
19863 Variables of size @var{n} bytes or smaller are placed in the
19864 @code{.based} section by default.  Based variables use the @code{$tp}
19865 register as a base register, and there is a 128-byte limit to the
19866 @code{.based} section.
19868 @item -mbitops
19869 @opindex mbitops
19870 Enables the bit operation instructions---bit test (@code{btstm}), set
19871 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19872 test-and-set (@code{tas}).
19874 @item -mc=@var{name}
19875 @opindex mc=
19876 Selects which section constant data is placed in.  @var{name} may
19877 be @samp{tiny}, @samp{near}, or @samp{far}.
19879 @item -mclip
19880 @opindex mclip
19881 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19882 useful unless you also provide @option{-mminmax}.
19884 @item -mconfig=@var{name}
19885 @opindex mconfig=
19886 Selects one of the built-in core configurations.  Each MeP chip has
19887 one or more modules in it; each module has a core CPU and a variety of
19888 coprocessors, optional instructions, and peripherals.  The
19889 @code{MeP-Integrator} tool, not part of GCC, provides these
19890 configurations through this option; using this option is the same as
19891 using all the corresponding command-line options.  The default
19892 configuration is @samp{default}.
19894 @item -mcop
19895 @opindex mcop
19896 Enables the coprocessor instructions.  By default, this is a 32-bit
19897 coprocessor.  Note that the coprocessor is normally enabled via the
19898 @option{-mconfig=} option.
19900 @item -mcop32
19901 @opindex mcop32
19902 Enables the 32-bit coprocessor's instructions.
19904 @item -mcop64
19905 @opindex mcop64
19906 Enables the 64-bit coprocessor's instructions.
19908 @item -mivc2
19909 @opindex mivc2
19910 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19912 @item -mdc
19913 @opindex mdc
19914 Causes constant variables to be placed in the @code{.near} section.
19916 @item -mdiv
19917 @opindex mdiv
19918 Enables the @code{div} and @code{divu} instructions.
19920 @item -meb
19921 @opindex meb
19922 Generate big-endian code.
19924 @item -mel
19925 @opindex mel
19926 Generate little-endian code.
19928 @item -mio-volatile
19929 @opindex mio-volatile
19930 Tells the compiler that any variable marked with the @code{io}
19931 attribute is to be considered volatile.
19933 @item -ml
19934 @opindex ml
19935 Causes variables to be assigned to the @code{.far} section by default.
19937 @item -mleadz
19938 @opindex mleadz
19939 Enables the @code{leadz} (leading zero) instruction.
19941 @item -mm
19942 @opindex mm
19943 Causes variables to be assigned to the @code{.near} section by default.
19945 @item -mminmax
19946 @opindex mminmax
19947 Enables the @code{min} and @code{max} instructions.
19949 @item -mmult
19950 @opindex mmult
19951 Enables the multiplication and multiply-accumulate instructions.
19953 @item -mno-opts
19954 @opindex mno-opts
19955 Disables all the optional instructions enabled by @option{-mall-opts}.
19957 @item -mrepeat
19958 @opindex mrepeat
19959 Enables the @code{repeat} and @code{erepeat} instructions, used for
19960 low-overhead looping.
19962 @item -ms
19963 @opindex ms
19964 Causes all variables to default to the @code{.tiny} section.  Note
19965 that there is a 65536-byte limit to this section.  Accesses to these
19966 variables use the @code{%gp} base register.
19968 @item -msatur
19969 @opindex msatur
19970 Enables the saturation instructions.  Note that the compiler does not
19971 currently generate these itself, but this option is included for
19972 compatibility with other tools, like @code{as}.
19974 @item -msdram
19975 @opindex msdram
19976 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19978 @item -msim
19979 @opindex msim
19980 Link the simulator run-time libraries.
19982 @item -msimnovec
19983 @opindex msimnovec
19984 Link the simulator runtime libraries, excluding built-in support
19985 for reset and exception vectors and tables.
19987 @item -mtf
19988 @opindex mtf
19989 Causes all functions to default to the @code{.far} section.  Without
19990 this option, functions default to the @code{.near} section.
19992 @item -mtiny=@var{n}
19993 @opindex mtiny=
19994 Variables that are @var{n} bytes or smaller are allocated to the
19995 @code{.tiny} section.  These variables use the @code{$gp} base
19996 register.  The default for this option is 4, but note that there's a
19997 65536-byte limit to the @code{.tiny} section.
19999 @end table
20001 @node MicroBlaze Options
20002 @subsection MicroBlaze Options
20003 @cindex MicroBlaze Options
20005 @table @gcctabopt
20007 @item -msoft-float
20008 @opindex msoft-float
20009 Use software emulation for floating point (default).
20011 @item -mhard-float
20012 @opindex mhard-float
20013 Use hardware floating-point instructions.
20015 @item -mmemcpy
20016 @opindex mmemcpy
20017 Do not optimize block moves, use @code{memcpy}.
20019 @item -mno-clearbss
20020 @opindex mno-clearbss
20021 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
20023 @item -mcpu=@var{cpu-type}
20024 @opindex mcpu=
20025 Use features of, and schedule code for, the given CPU.
20026 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
20027 where @var{X} is a major version, @var{YY} is the minor version, and
20028 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
20029 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
20031 @item -mxl-soft-mul
20032 @opindex mxl-soft-mul
20033 Use software multiply emulation (default).
20035 @item -mxl-soft-div
20036 @opindex mxl-soft-div
20037 Use software emulation for divides (default).
20039 @item -mxl-barrel-shift
20040 @opindex mxl-barrel-shift
20041 Use the hardware barrel shifter.
20043 @item -mxl-pattern-compare
20044 @opindex mxl-pattern-compare
20045 Use pattern compare instructions.
20047 @item -msmall-divides
20048 @opindex msmall-divides
20049 Use table lookup optimization for small signed integer divisions.
20051 @item -mxl-stack-check
20052 @opindex mxl-stack-check
20053 This option is deprecated.  Use @option{-fstack-check} instead.
20055 @item -mxl-gp-opt
20056 @opindex mxl-gp-opt
20057 Use GP-relative @code{.sdata}/@code{.sbss} sections.
20059 @item -mxl-multiply-high
20060 @opindex mxl-multiply-high
20061 Use multiply high instructions for high part of 32x32 multiply.
20063 @item -mxl-float-convert
20064 @opindex mxl-float-convert
20065 Use hardware floating-point conversion instructions.
20067 @item -mxl-float-sqrt
20068 @opindex mxl-float-sqrt
20069 Use hardware floating-point square root instruction.
20071 @item -mbig-endian
20072 @opindex mbig-endian
20073 Generate code for a big-endian target.
20075 @item -mlittle-endian
20076 @opindex mlittle-endian
20077 Generate code for a little-endian target.
20079 @item -mxl-reorder
20080 @opindex mxl-reorder
20081 Use reorder instructions (swap and byte reversed load/store).
20083 @item -mxl-mode-@var{app-model}
20084 Select application model @var{app-model}.  Valid models are
20085 @table @samp
20086 @item executable
20087 normal executable (default), uses startup code @file{crt0.o}.
20089 @item -mpic-data-is-text-relative
20090 @opindex mpic-data-is-text-relative
20091 Assume that the displacement between the text and data segments is fixed
20092 at static link time.  This allows data to be referenced by offset from start of
20093 text address instead of GOT since PC-relative addressing is not supported.
20095 @item xmdstub
20096 for use with Xilinx Microprocessor Debugger (XMD) based
20097 software intrusive debug agent called xmdstub. This uses startup file
20098 @file{crt1.o} and sets the start address of the program to 0x800.
20100 @item bootstrap
20101 for applications that are loaded using a bootloader.
20102 This model uses startup file @file{crt2.o} which does not contain a processor
20103 reset vector handler. This is suitable for transferring control on a
20104 processor reset to the bootloader rather than the application.
20106 @item novectors
20107 for applications that do not require any of the
20108 MicroBlaze vectors. This option may be useful for applications running
20109 within a monitoring application. This model uses @file{crt3.o} as a startup file.
20110 @end table
20112 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
20113 @option{-mxl-mode-@var{app-model}}.
20115 @end table
20117 @node MIPS Options
20118 @subsection MIPS Options
20119 @cindex MIPS options
20121 @table @gcctabopt
20123 @item -EB
20124 @opindex EB
20125 Generate big-endian code.
20127 @item -EL
20128 @opindex EL
20129 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
20130 configurations.
20132 @item -march=@var{arch}
20133 @opindex march
20134 Generate code that runs on @var{arch}, which can be the name of a
20135 generic MIPS ISA, or the name of a particular processor.
20136 The ISA names are:
20137 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
20138 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
20139 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
20140 @samp{mips64r5} and @samp{mips64r6}.
20141 The processor names are:
20142 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
20143 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
20144 @samp{5kc}, @samp{5kf},
20145 @samp{20kc},
20146 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
20147 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
20148 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
20149 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
20150 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
20151 @samp{i6400},
20152 @samp{interaptiv},
20153 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
20154 @samp{m4k},
20155 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
20156 @samp{m5100}, @samp{m5101},
20157 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
20158 @samp{orion},
20159 @samp{p5600},
20160 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
20161 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
20162 @samp{rm7000}, @samp{rm9000},
20163 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
20164 @samp{sb1},
20165 @samp{sr71000},
20166 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
20167 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
20168 @samp{xlr} and @samp{xlp}.
20169 The special value @samp{from-abi} selects the
20170 most compatible architecture for the selected ABI (that is,
20171 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
20173 The native Linux/GNU toolchain also supports the value @samp{native},
20174 which selects the best architecture option for the host processor.
20175 @option{-march=native} has no effect if GCC does not recognize
20176 the processor.
20178 In processor names, a final @samp{000} can be abbreviated as @samp{k}
20179 (for example, @option{-march=r2k}).  Prefixes are optional, and
20180 @samp{vr} may be written @samp{r}.
20182 Names of the form @samp{@var{n}f2_1} refer to processors with
20183 FPUs clocked at half the rate of the core, names of the form
20184 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
20185 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
20186 processors with FPUs clocked a ratio of 3:2 with respect to the core.
20187 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
20188 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
20189 accepted as synonyms for @samp{@var{n}f1_1}.
20191 GCC defines two macros based on the value of this option.  The first
20192 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
20193 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
20194 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
20195 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
20196 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
20198 Note that the @code{_MIPS_ARCH} macro uses the processor names given
20199 above.  In other words, it has the full prefix and does not
20200 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
20201 the macro names the resolved architecture (either @code{"mips1"} or
20202 @code{"mips3"}).  It names the default architecture when no
20203 @option{-march} option is given.
20205 @item -mtune=@var{arch}
20206 @opindex mtune
20207 Optimize for @var{arch}.  Among other things, this option controls
20208 the way instructions are scheduled, and the perceived cost of arithmetic
20209 operations.  The list of @var{arch} values is the same as for
20210 @option{-march}.
20212 When this option is not used, GCC optimizes for the processor
20213 specified by @option{-march}.  By using @option{-march} and
20214 @option{-mtune} together, it is possible to generate code that
20215 runs on a family of processors, but optimize the code for one
20216 particular member of that family.
20218 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
20219 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
20220 @option{-march} ones described above.
20222 @item -mips1
20223 @opindex mips1
20224 Equivalent to @option{-march=mips1}.
20226 @item -mips2
20227 @opindex mips2
20228 Equivalent to @option{-march=mips2}.
20230 @item -mips3
20231 @opindex mips3
20232 Equivalent to @option{-march=mips3}.
20234 @item -mips4
20235 @opindex mips4
20236 Equivalent to @option{-march=mips4}.
20238 @item -mips32
20239 @opindex mips32
20240 Equivalent to @option{-march=mips32}.
20242 @item -mips32r3
20243 @opindex mips32r3
20244 Equivalent to @option{-march=mips32r3}.
20246 @item -mips32r5
20247 @opindex mips32r5
20248 Equivalent to @option{-march=mips32r5}.
20250 @item -mips32r6
20251 @opindex mips32r6
20252 Equivalent to @option{-march=mips32r6}.
20254 @item -mips64
20255 @opindex mips64
20256 Equivalent to @option{-march=mips64}.
20258 @item -mips64r2
20259 @opindex mips64r2
20260 Equivalent to @option{-march=mips64r2}.
20262 @item -mips64r3
20263 @opindex mips64r3
20264 Equivalent to @option{-march=mips64r3}.
20266 @item -mips64r5
20267 @opindex mips64r5
20268 Equivalent to @option{-march=mips64r5}.
20270 @item -mips64r6
20271 @opindex mips64r6
20272 Equivalent to @option{-march=mips64r6}.
20274 @item -mips16
20275 @itemx -mno-mips16
20276 @opindex mips16
20277 @opindex mno-mips16
20278 Generate (do not generate) MIPS16 code.  If GCC is targeting a
20279 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
20281 MIPS16 code generation can also be controlled on a per-function basis
20282 by means of @code{mips16} and @code{nomips16} attributes.
20283 @xref{Function Attributes}, for more information.
20285 @item -mflip-mips16
20286 @opindex mflip-mips16
20287 Generate MIPS16 code on alternating functions.  This option is provided
20288 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20289 not intended for ordinary use in compiling user code.
20291 @item -minterlink-compressed
20292 @itemx -mno-interlink-compressed
20293 @opindex minterlink-compressed
20294 @opindex mno-interlink-compressed
20295 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20296 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20298 For example, code using the standard ISA encoding cannot jump directly
20299 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20300 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20301 knows that the target of the jump is not compressed.
20303 @item -minterlink-mips16
20304 @itemx -mno-interlink-mips16
20305 @opindex minterlink-mips16
20306 @opindex mno-interlink-mips16
20307 Aliases of @option{-minterlink-compressed} and
20308 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
20309 and are retained for backwards compatibility.
20311 @item -mabi=32
20312 @itemx -mabi=o64
20313 @itemx -mabi=n32
20314 @itemx -mabi=64
20315 @itemx -mabi=eabi
20316 @opindex mabi=32
20317 @opindex mabi=o64
20318 @opindex mabi=n32
20319 @opindex mabi=64
20320 @opindex mabi=eabi
20321 Generate code for the given ABI@.
20323 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
20324 generates 64-bit code when you select a 64-bit architecture, but you
20325 can use @option{-mgp32} to get 32-bit code instead.
20327 For information about the O64 ABI, see
20328 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20330 GCC supports a variant of the o32 ABI in which floating-point registers
20331 are 64 rather than 32 bits wide.  You can select this combination with
20332 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20333 and @code{mfhc1} instructions and is therefore only supported for
20334 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20336 The register assignments for arguments and return values remain the
20337 same, but each scalar value is passed in a single 64-bit register
20338 rather than a pair of 32-bit registers.  For example, scalar
20339 floating-point values are returned in @samp{$f0} only, not a
20340 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20341 remains the same in that the even-numbered double-precision registers
20342 are saved.
20344 Two additional variants of the o32 ABI are supported to enable
20345 a transition from 32-bit to 64-bit registers.  These are FPXX
20346 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20347 The FPXX extension mandates that all code must execute correctly
20348 when run using 32-bit or 64-bit registers.  The code can be interlinked
20349 with either FP32 or FP64, but not both.
20350 The FP64A extension is similar to the FP64 extension but forbids the
20351 use of odd-numbered single-precision registers.  This can be used
20352 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20353 processors and allows both FP32 and FP64A code to interlink and
20354 run in the same process without changing FPU modes.
20356 @item -mabicalls
20357 @itemx -mno-abicalls
20358 @opindex mabicalls
20359 @opindex mno-abicalls
20360 Generate (do not generate) code that is suitable for SVR4-style
20361 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20362 systems.
20364 @item -mshared
20365 @itemx -mno-shared
20366 Generate (do not generate) code that is fully position-independent,
20367 and that can therefore be linked into shared libraries.  This option
20368 only affects @option{-mabicalls}.
20370 All @option{-mabicalls} code has traditionally been position-independent,
20371 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20372 as an extension, the GNU toolchain allows executables to use absolute
20373 accesses for locally-binding symbols.  It can also use shorter GP
20374 initialization sequences and generate direct calls to locally-defined
20375 functions.  This mode is selected by @option{-mno-shared}.
20377 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20378 objects that can only be linked by the GNU linker.  However, the option
20379 does not affect the ABI of the final executable; it only affects the ABI
20380 of relocatable objects.  Using @option{-mno-shared} generally makes
20381 executables both smaller and quicker.
20383 @option{-mshared} is the default.
20385 @item -mplt
20386 @itemx -mno-plt
20387 @opindex mplt
20388 @opindex mno-plt
20389 Assume (do not assume) that the static and dynamic linkers
20390 support PLTs and copy relocations.  This option only affects
20391 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20392 has no effect without @option{-msym32}.
20394 You can make @option{-mplt} the default by configuring
20395 GCC with @option{--with-mips-plt}.  The default is
20396 @option{-mno-plt} otherwise.
20398 @item -mxgot
20399 @itemx -mno-xgot
20400 @opindex mxgot
20401 @opindex mno-xgot
20402 Lift (do not lift) the usual restrictions on the size of the global
20403 offset table.
20405 GCC normally uses a single instruction to load values from the GOT@.
20406 While this is relatively efficient, it only works if the GOT
20407 is smaller than about 64k.  Anything larger causes the linker
20408 to report an error such as:
20410 @cindex relocation truncated to fit (MIPS)
20411 @smallexample
20412 relocation truncated to fit: R_MIPS_GOT16 foobar
20413 @end smallexample
20415 If this happens, you should recompile your code with @option{-mxgot}.
20416 This works with very large GOTs, although the code is also
20417 less efficient, since it takes three instructions to fetch the
20418 value of a global symbol.
20420 Note that some linkers can create multiple GOTs.  If you have such a
20421 linker, you should only need to use @option{-mxgot} when a single object
20422 file accesses more than 64k's worth of GOT entries.  Very few do.
20424 These options have no effect unless GCC is generating position
20425 independent code.
20427 @item -mgp32
20428 @opindex mgp32
20429 Assume that general-purpose registers are 32 bits wide.
20431 @item -mgp64
20432 @opindex mgp64
20433 Assume that general-purpose registers are 64 bits wide.
20435 @item -mfp32
20436 @opindex mfp32
20437 Assume that floating-point registers are 32 bits wide.
20439 @item -mfp64
20440 @opindex mfp64
20441 Assume that floating-point registers are 64 bits wide.
20443 @item -mfpxx
20444 @opindex mfpxx
20445 Do not assume the width of floating-point registers.
20447 @item -mhard-float
20448 @opindex mhard-float
20449 Use floating-point coprocessor instructions.
20451 @item -msoft-float
20452 @opindex msoft-float
20453 Do not use floating-point coprocessor instructions.  Implement
20454 floating-point calculations using library calls instead.
20456 @item -mno-float
20457 @opindex mno-float
20458 Equivalent to @option{-msoft-float}, but additionally asserts that the
20459 program being compiled does not perform any floating-point operations.
20460 This option is presently supported only by some bare-metal MIPS
20461 configurations, where it may select a special set of libraries
20462 that lack all floating-point support (including, for example, the
20463 floating-point @code{printf} formats).  
20464 If code compiled with @option{-mno-float} accidentally contains
20465 floating-point operations, it is likely to suffer a link-time
20466 or run-time failure.
20468 @item -msingle-float
20469 @opindex msingle-float
20470 Assume that the floating-point coprocessor only supports single-precision
20471 operations.
20473 @item -mdouble-float
20474 @opindex mdouble-float
20475 Assume that the floating-point coprocessor supports double-precision
20476 operations.  This is the default.
20478 @item -modd-spreg
20479 @itemx -mno-odd-spreg
20480 @opindex modd-spreg
20481 @opindex mno-odd-spreg
20482 Enable the use of odd-numbered single-precision floating-point registers
20483 for the o32 ABI.  This is the default for processors that are known to
20484 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20485 is set by default.
20487 @item -mabs=2008
20488 @itemx -mabs=legacy
20489 @opindex mabs=2008
20490 @opindex mabs=legacy
20491 These options control the treatment of the special not-a-number (NaN)
20492 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20493 @code{neg.@i{fmt}} machine instructions.
20495 By default or when @option{-mabs=legacy} is used the legacy
20496 treatment is selected.  In this case these instructions are considered
20497 arithmetic and avoided where correct operation is required and the
20498 input operand might be a NaN.  A longer sequence of instructions that
20499 manipulate the sign bit of floating-point datum manually is used
20500 instead unless the @option{-ffinite-math-only} option has also been
20501 specified.
20503 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20504 this case these instructions are considered non-arithmetic and therefore
20505 operating correctly in all cases, including in particular where the
20506 input operand is a NaN.  These instructions are therefore always used
20507 for the respective operations.
20509 @item -mnan=2008
20510 @itemx -mnan=legacy
20511 @opindex mnan=2008
20512 @opindex mnan=legacy
20513 These options control the encoding of the special not-a-number (NaN)
20514 IEEE 754 floating-point data.
20516 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20517 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20518 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20519 by the first bit of their trailing significand field being 1.
20521 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20522 this case qNaNs are denoted by the first bit of their trailing
20523 significand field being 1, whereas sNaNs are denoted by the first bit of
20524 their trailing significand field being 0.
20526 The default is @option{-mnan=legacy} unless GCC has been configured with
20527 @option{--with-nan=2008}.
20529 @item -mllsc
20530 @itemx -mno-llsc
20531 @opindex mllsc
20532 @opindex mno-llsc
20533 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20534 implement atomic memory built-in functions.  When neither option is
20535 specified, GCC uses the instructions if the target architecture
20536 supports them.
20538 @option{-mllsc} is useful if the runtime environment can emulate the
20539 instructions and @option{-mno-llsc} can be useful when compiling for
20540 nonstandard ISAs.  You can make either option the default by
20541 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20542 respectively.  @option{--with-llsc} is the default for some
20543 configurations; see the installation documentation for details.
20545 @item -mdsp
20546 @itemx -mno-dsp
20547 @opindex mdsp
20548 @opindex mno-dsp
20549 Use (do not use) revision 1 of the MIPS DSP ASE@.
20550 @xref{MIPS DSP Built-in Functions}.  This option defines the
20551 preprocessor macro @code{__mips_dsp}.  It also defines
20552 @code{__mips_dsp_rev} to 1.
20554 @item -mdspr2
20555 @itemx -mno-dspr2
20556 @opindex mdspr2
20557 @opindex mno-dspr2
20558 Use (do not use) revision 2 of the MIPS DSP ASE@.
20559 @xref{MIPS DSP Built-in Functions}.  This option defines the
20560 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20561 It also defines @code{__mips_dsp_rev} to 2.
20563 @item -msmartmips
20564 @itemx -mno-smartmips
20565 @opindex msmartmips
20566 @opindex mno-smartmips
20567 Use (do not use) the MIPS SmartMIPS ASE.
20569 @item -mpaired-single
20570 @itemx -mno-paired-single
20571 @opindex mpaired-single
20572 @opindex mno-paired-single
20573 Use (do not use) paired-single floating-point instructions.
20574 @xref{MIPS Paired-Single Support}.  This option requires
20575 hardware floating-point support to be enabled.
20577 @item -mdmx
20578 @itemx -mno-mdmx
20579 @opindex mdmx
20580 @opindex mno-mdmx
20581 Use (do not use) MIPS Digital Media Extension instructions.
20582 This option can only be used when generating 64-bit code and requires
20583 hardware floating-point support to be enabled.
20585 @item -mips3d
20586 @itemx -mno-mips3d
20587 @opindex mips3d
20588 @opindex mno-mips3d
20589 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20590 The option @option{-mips3d} implies @option{-mpaired-single}.
20592 @item -mmicromips
20593 @itemx -mno-micromips
20594 @opindex mmicromips
20595 @opindex mno-mmicromips
20596 Generate (do not generate) microMIPS code.
20598 MicroMIPS code generation can also be controlled on a per-function basis
20599 by means of @code{micromips} and @code{nomicromips} attributes.
20600 @xref{Function Attributes}, for more information.
20602 @item -mmt
20603 @itemx -mno-mt
20604 @opindex mmt
20605 @opindex mno-mt
20606 Use (do not use) MT Multithreading instructions.
20608 @item -mmcu
20609 @itemx -mno-mcu
20610 @opindex mmcu
20611 @opindex mno-mcu
20612 Use (do not use) the MIPS MCU ASE instructions.
20614 @item -meva
20615 @itemx -mno-eva
20616 @opindex meva
20617 @opindex mno-eva
20618 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20620 @item -mvirt
20621 @itemx -mno-virt
20622 @opindex mvirt
20623 @opindex mno-virt
20624 Use (do not use) the MIPS Virtualization (VZ) instructions.
20626 @item -mxpa
20627 @itemx -mno-xpa
20628 @opindex mxpa
20629 @opindex mno-xpa
20630 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20632 @item -mlong64
20633 @opindex mlong64
20634 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20635 an explanation of the default and the way that the pointer size is
20636 determined.
20638 @item -mlong32
20639 @opindex mlong32
20640 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20642 The default size of @code{int}s, @code{long}s and pointers depends on
20643 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20644 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20645 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20646 or the same size as integer registers, whichever is smaller.
20648 @item -msym32
20649 @itemx -mno-sym32
20650 @opindex msym32
20651 @opindex mno-sym32
20652 Assume (do not assume) that all symbols have 32-bit values, regardless
20653 of the selected ABI@.  This option is useful in combination with
20654 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20655 to generate shorter and faster references to symbolic addresses.
20657 @item -G @var{num}
20658 @opindex G
20659 Put definitions of externally-visible data in a small data section
20660 if that data is no bigger than @var{num} bytes.  GCC can then generate
20661 more efficient accesses to the data; see @option{-mgpopt} for details.
20663 The default @option{-G} option depends on the configuration.
20665 @item -mlocal-sdata
20666 @itemx -mno-local-sdata
20667 @opindex mlocal-sdata
20668 @opindex mno-local-sdata
20669 Extend (do not extend) the @option{-G} behavior to local data too,
20670 such as to static variables in C@.  @option{-mlocal-sdata} is the
20671 default for all configurations.
20673 If the linker complains that an application is using too much small data,
20674 you might want to try rebuilding the less performance-critical parts with
20675 @option{-mno-local-sdata}.  You might also want to build large
20676 libraries with @option{-mno-local-sdata}, so that the libraries leave
20677 more room for the main program.
20679 @item -mextern-sdata
20680 @itemx -mno-extern-sdata
20681 @opindex mextern-sdata
20682 @opindex mno-extern-sdata
20683 Assume (do not assume) that externally-defined data is in
20684 a small data section if the size of that data is within the @option{-G} limit.
20685 @option{-mextern-sdata} is the default for all configurations.
20687 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20688 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20689 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20690 is placed in a small data section.  If @var{Var} is defined by another
20691 module, you must either compile that module with a high-enough
20692 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20693 definition.  If @var{Var} is common, you must link the application
20694 with a high-enough @option{-G} setting.
20696 The easiest way of satisfying these restrictions is to compile
20697 and link every module with the same @option{-G} option.  However,
20698 you may wish to build a library that supports several different
20699 small data limits.  You can do this by compiling the library with
20700 the highest supported @option{-G} setting and additionally using
20701 @option{-mno-extern-sdata} to stop the library from making assumptions
20702 about externally-defined data.
20704 @item -mgpopt
20705 @itemx -mno-gpopt
20706 @opindex mgpopt
20707 @opindex mno-gpopt
20708 Use (do not use) GP-relative accesses for symbols that are known to be
20709 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20710 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20711 configurations.
20713 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20714 might not hold the value of @code{_gp}.  For example, if the code is
20715 part of a library that might be used in a boot monitor, programs that
20716 call boot monitor routines pass an unknown value in @code{$gp}.
20717 (In such situations, the boot monitor itself is usually compiled
20718 with @option{-G0}.)
20720 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20721 @option{-mno-extern-sdata}.
20723 @item -membedded-data
20724 @itemx -mno-embedded-data
20725 @opindex membedded-data
20726 @opindex mno-embedded-data
20727 Allocate variables to the read-only data section first if possible, then
20728 next in the small data section if possible, otherwise in data.  This gives
20729 slightly slower code than the default, but reduces the amount of RAM required
20730 when executing, and thus may be preferred for some embedded systems.
20732 @item -muninit-const-in-rodata
20733 @itemx -mno-uninit-const-in-rodata
20734 @opindex muninit-const-in-rodata
20735 @opindex mno-uninit-const-in-rodata
20736 Put uninitialized @code{const} variables in the read-only data section.
20737 This option is only meaningful in conjunction with @option{-membedded-data}.
20739 @item -mcode-readable=@var{setting}
20740 @opindex mcode-readable
20741 Specify whether GCC may generate code that reads from executable sections.
20742 There are three possible settings:
20744 @table @gcctabopt
20745 @item -mcode-readable=yes
20746 Instructions may freely access executable sections.  This is the
20747 default setting.
20749 @item -mcode-readable=pcrel
20750 MIPS16 PC-relative load instructions can access executable sections,
20751 but other instructions must not do so.  This option is useful on 4KSc
20752 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20753 It is also useful on processors that can be configured to have a dual
20754 instruction/data SRAM interface and that, like the M4K, automatically
20755 redirect PC-relative loads to the instruction RAM.
20757 @item -mcode-readable=no
20758 Instructions must not access executable sections.  This option can be
20759 useful on targets that are configured to have a dual instruction/data
20760 SRAM interface but that (unlike the M4K) do not automatically redirect
20761 PC-relative loads to the instruction RAM.
20762 @end table
20764 @item -msplit-addresses
20765 @itemx -mno-split-addresses
20766 @opindex msplit-addresses
20767 @opindex mno-split-addresses
20768 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20769 relocation operators.  This option has been superseded by
20770 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20772 @item -mexplicit-relocs
20773 @itemx -mno-explicit-relocs
20774 @opindex mexplicit-relocs
20775 @opindex mno-explicit-relocs
20776 Use (do not use) assembler relocation operators when dealing with symbolic
20777 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20778 is to use assembler macros instead.
20780 @option{-mexplicit-relocs} is the default if GCC was configured
20781 to use an assembler that supports relocation operators.
20783 @item -mcheck-zero-division
20784 @itemx -mno-check-zero-division
20785 @opindex mcheck-zero-division
20786 @opindex mno-check-zero-division
20787 Trap (do not trap) on integer division by zero.
20789 The default is @option{-mcheck-zero-division}.
20791 @item -mdivide-traps
20792 @itemx -mdivide-breaks
20793 @opindex mdivide-traps
20794 @opindex mdivide-breaks
20795 MIPS systems check for division by zero by generating either a
20796 conditional trap or a break instruction.  Using traps results in
20797 smaller code, but is only supported on MIPS II and later.  Also, some
20798 versions of the Linux kernel have a bug that prevents trap from
20799 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20800 allow conditional traps on architectures that support them and
20801 @option{-mdivide-breaks} to force the use of breaks.
20803 The default is usually @option{-mdivide-traps}, but this can be
20804 overridden at configure time using @option{--with-divide=breaks}.
20805 Divide-by-zero checks can be completely disabled using
20806 @option{-mno-check-zero-division}.
20808 @item -mload-store-pairs
20809 @itemx -mno-load-store-pairs
20810 @opindex mload-store-pairs
20811 @opindex mno-load-store-pairs
20812 Enable (disable) an optimization that pairs consecutive load or store
20813 instructions to enable load/store bonding.  This option is enabled by
20814 default but only takes effect when the selected architecture is known
20815 to support bonding.
20817 @item -mmemcpy
20818 @itemx -mno-memcpy
20819 @opindex mmemcpy
20820 @opindex mno-memcpy
20821 Force (do not force) the use of @code{memcpy} for non-trivial block
20822 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20823 most constant-sized copies.
20825 @item -mlong-calls
20826 @itemx -mno-long-calls
20827 @opindex mlong-calls
20828 @opindex mno-long-calls
20829 Disable (do not disable) use of the @code{jal} instruction.  Calling
20830 functions using @code{jal} is more efficient but requires the caller
20831 and callee to be in the same 256 megabyte segment.
20833 This option has no effect on abicalls code.  The default is
20834 @option{-mno-long-calls}.
20836 @item -mmad
20837 @itemx -mno-mad
20838 @opindex mmad
20839 @opindex mno-mad
20840 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20841 instructions, as provided by the R4650 ISA@.
20843 @item -mimadd
20844 @itemx -mno-imadd
20845 @opindex mimadd
20846 @opindex mno-imadd
20847 Enable (disable) use of the @code{madd} and @code{msub} integer
20848 instructions.  The default is @option{-mimadd} on architectures
20849 that support @code{madd} and @code{msub} except for the 74k 
20850 architecture where it was found to generate slower code.
20852 @item -mfused-madd
20853 @itemx -mno-fused-madd
20854 @opindex mfused-madd
20855 @opindex mno-fused-madd
20856 Enable (disable) use of the floating-point multiply-accumulate
20857 instructions, when they are available.  The default is
20858 @option{-mfused-madd}.
20860 On the R8000 CPU when multiply-accumulate instructions are used,
20861 the intermediate product is calculated to infinite precision
20862 and is not subject to the FCSR Flush to Zero bit.  This may be
20863 undesirable in some circumstances.  On other processors the result
20864 is numerically identical to the equivalent computation using
20865 separate multiply, add, subtract and negate instructions.
20867 @item -nocpp
20868 @opindex nocpp
20869 Tell the MIPS assembler to not run its preprocessor over user
20870 assembler files (with a @samp{.s} suffix) when assembling them.
20872 @item -mfix-24k
20873 @itemx -mno-fix-24k
20874 @opindex mfix-24k
20875 @opindex mno-fix-24k
20876 Work around the 24K E48 (lost data on stores during refill) errata.
20877 The workarounds are implemented by the assembler rather than by GCC@.
20879 @item -mfix-r4000
20880 @itemx -mno-fix-r4000
20881 @opindex mfix-r4000
20882 @opindex mno-fix-r4000
20883 Work around certain R4000 CPU errata:
20884 @itemize @minus
20885 @item
20886 A double-word or a variable shift may give an incorrect result if executed
20887 immediately after starting an integer division.
20888 @item
20889 A double-word or a variable shift may give an incorrect result if executed
20890 while an integer multiplication is in progress.
20891 @item
20892 An integer division may give an incorrect result if started in a delay slot
20893 of a taken branch or a jump.
20894 @end itemize
20896 @item -mfix-r4400
20897 @itemx -mno-fix-r4400
20898 @opindex mfix-r4400
20899 @opindex mno-fix-r4400
20900 Work around certain R4400 CPU errata:
20901 @itemize @minus
20902 @item
20903 A double-word or a variable shift may give an incorrect result if executed
20904 immediately after starting an integer division.
20905 @end itemize
20907 @item -mfix-r10000
20908 @itemx -mno-fix-r10000
20909 @opindex mfix-r10000
20910 @opindex mno-fix-r10000
20911 Work around certain R10000 errata:
20912 @itemize @minus
20913 @item
20914 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20915 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20916 @end itemize
20918 This option can only be used if the target architecture supports
20919 branch-likely instructions.  @option{-mfix-r10000} is the default when
20920 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20921 otherwise.
20923 @item -mfix-rm7000
20924 @itemx -mno-fix-rm7000
20925 @opindex mfix-rm7000
20926 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20927 workarounds are implemented by the assembler rather than by GCC@.
20929 @item -mfix-vr4120
20930 @itemx -mno-fix-vr4120
20931 @opindex mfix-vr4120
20932 Work around certain VR4120 errata:
20933 @itemize @minus
20934 @item
20935 @code{dmultu} does not always produce the correct result.
20936 @item
20937 @code{div} and @code{ddiv} do not always produce the correct result if one
20938 of the operands is negative.
20939 @end itemize
20940 The workarounds for the division errata rely on special functions in
20941 @file{libgcc.a}.  At present, these functions are only provided by
20942 the @code{mips64vr*-elf} configurations.
20944 Other VR4120 errata require a NOP to be inserted between certain pairs of
20945 instructions.  These errata are handled by the assembler, not by GCC itself.
20947 @item -mfix-vr4130
20948 @opindex mfix-vr4130
20949 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20950 workarounds are implemented by the assembler rather than by GCC,
20951 although GCC avoids using @code{mflo} and @code{mfhi} if the
20952 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20953 instructions are available instead.
20955 @item -mfix-sb1
20956 @itemx -mno-fix-sb1
20957 @opindex mfix-sb1
20958 Work around certain SB-1 CPU core errata.
20959 (This flag currently works around the SB-1 revision 2
20960 ``F1'' and ``F2'' floating-point errata.)
20962 @item -mr10k-cache-barrier=@var{setting}
20963 @opindex mr10k-cache-barrier
20964 Specify whether GCC should insert cache barriers to avoid the
20965 side effects of speculation on R10K processors.
20967 In common with many processors, the R10K tries to predict the outcome
20968 of a conditional branch and speculatively executes instructions from
20969 the ``taken'' branch.  It later aborts these instructions if the
20970 predicted outcome is wrong.  However, on the R10K, even aborted
20971 instructions can have side effects.
20973 This problem only affects kernel stores and, depending on the system,
20974 kernel loads.  As an example, a speculatively-executed store may load
20975 the target memory into cache and mark the cache line as dirty, even if
20976 the store itself is later aborted.  If a DMA operation writes to the
20977 same area of memory before the ``dirty'' line is flushed, the cached
20978 data overwrites the DMA-ed data.  See the R10K processor manual
20979 for a full description, including other potential problems.
20981 One workaround is to insert cache barrier instructions before every memory
20982 access that might be speculatively executed and that might have side
20983 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20984 controls GCC's implementation of this workaround.  It assumes that
20985 aborted accesses to any byte in the following regions does not have
20986 side effects:
20988 @enumerate
20989 @item
20990 the memory occupied by the current function's stack frame;
20992 @item
20993 the memory occupied by an incoming stack argument;
20995 @item
20996 the memory occupied by an object with a link-time-constant address.
20997 @end enumerate
20999 It is the kernel's responsibility to ensure that speculative
21000 accesses to these regions are indeed safe.
21002 If the input program contains a function declaration such as:
21004 @smallexample
21005 void foo (void);
21006 @end smallexample
21008 then the implementation of @code{foo} must allow @code{j foo} and
21009 @code{jal foo} to be executed speculatively.  GCC honors this
21010 restriction for functions it compiles itself.  It expects non-GCC
21011 functions (such as hand-written assembly code) to do the same.
21013 The option has three forms:
21015 @table @gcctabopt
21016 @item -mr10k-cache-barrier=load-store
21017 Insert a cache barrier before a load or store that might be
21018 speculatively executed and that might have side effects even
21019 if aborted.
21021 @item -mr10k-cache-barrier=store
21022 Insert a cache barrier before a store that might be speculatively
21023 executed and that might have side effects even if aborted.
21025 @item -mr10k-cache-barrier=none
21026 Disable the insertion of cache barriers.  This is the default setting.
21027 @end table
21029 @item -mflush-func=@var{func}
21030 @itemx -mno-flush-func
21031 @opindex mflush-func
21032 Specifies the function to call to flush the I and D caches, or to not
21033 call any such function.  If called, the function must take the same
21034 arguments as the common @code{_flush_func}, that is, the address of the
21035 memory range for which the cache is being flushed, the size of the
21036 memory range, and the number 3 (to flush both caches).  The default
21037 depends on the target GCC was configured for, but commonly is either
21038 @code{_flush_func} or @code{__cpu_flush}.
21040 @item mbranch-cost=@var{num}
21041 @opindex mbranch-cost
21042 Set the cost of branches to roughly @var{num} ``simple'' instructions.
21043 This cost is only a heuristic and is not guaranteed to produce
21044 consistent results across releases.  A zero cost redundantly selects
21045 the default, which is based on the @option{-mtune} setting.
21047 @item -mbranch-likely
21048 @itemx -mno-branch-likely
21049 @opindex mbranch-likely
21050 @opindex mno-branch-likely
21051 Enable or disable use of Branch Likely instructions, regardless of the
21052 default for the selected architecture.  By default, Branch Likely
21053 instructions may be generated if they are supported by the selected
21054 architecture.  An exception is for the MIPS32 and MIPS64 architectures
21055 and processors that implement those architectures; for those, Branch
21056 Likely instructions are not be generated by default because the MIPS32
21057 and MIPS64 architectures specifically deprecate their use.
21059 @item -mcompact-branches=never
21060 @itemx -mcompact-branches=optimal
21061 @itemx -mcompact-branches=always
21062 @opindex mcompact-branches=never
21063 @opindex mcompact-branches=optimal
21064 @opindex mcompact-branches=always
21065 These options control which form of branches will be generated.  The
21066 default is @option{-mcompact-branches=optimal}.
21068 The @option{-mcompact-branches=never} option ensures that compact branch
21069 instructions will never be generated.
21071 The @option{-mcompact-branches=always} option ensures that a compact
21072 branch instruction will be generated if available.  If a compact branch
21073 instruction is not available, a delay slot form of the branch will be
21074 used instead.
21076 This option is supported from MIPS Release 6 onwards.
21078 The @option{-mcompact-branches=optimal} option will cause a delay slot
21079 branch to be used if one is available in the current ISA and the delay
21080 slot is successfully filled.  If the delay slot is not filled, a compact
21081 branch will be chosen if one is available.
21083 @item -mfp-exceptions
21084 @itemx -mno-fp-exceptions
21085 @opindex mfp-exceptions
21086 Specifies whether FP exceptions are enabled.  This affects how
21087 FP instructions are scheduled for some processors.
21088 The default is that FP exceptions are
21089 enabled.
21091 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
21092 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
21093 FP pipe.
21095 @item -mvr4130-align
21096 @itemx -mno-vr4130-align
21097 @opindex mvr4130-align
21098 The VR4130 pipeline is two-way superscalar, but can only issue two
21099 instructions together if the first one is 8-byte aligned.  When this
21100 option is enabled, GCC aligns pairs of instructions that it
21101 thinks should execute in parallel.
21103 This option only has an effect when optimizing for the VR4130.
21104 It normally makes code faster, but at the expense of making it bigger.
21105 It is enabled by default at optimization level @option{-O3}.
21107 @item -msynci
21108 @itemx -mno-synci
21109 @opindex msynci
21110 Enable (disable) generation of @code{synci} instructions on
21111 architectures that support it.  The @code{synci} instructions (if
21112 enabled) are generated when @code{__builtin___clear_cache} is
21113 compiled.
21115 This option defaults to @option{-mno-synci}, but the default can be
21116 overridden by configuring GCC with @option{--with-synci}.
21118 When compiling code for single processor systems, it is generally safe
21119 to use @code{synci}.  However, on many multi-core (SMP) systems, it
21120 does not invalidate the instruction caches on all cores and may lead
21121 to undefined behavior.
21123 @item -mrelax-pic-calls
21124 @itemx -mno-relax-pic-calls
21125 @opindex mrelax-pic-calls
21126 Try to turn PIC calls that are normally dispatched via register
21127 @code{$25} into direct calls.  This is only possible if the linker can
21128 resolve the destination at link time and if the destination is within
21129 range for a direct call.
21131 @option{-mrelax-pic-calls} is the default if GCC was configured to use
21132 an assembler and a linker that support the @code{.reloc} assembly
21133 directive and @option{-mexplicit-relocs} is in effect.  With
21134 @option{-mno-explicit-relocs}, this optimization can be performed by the
21135 assembler and the linker alone without help from the compiler.
21137 @item -mmcount-ra-address
21138 @itemx -mno-mcount-ra-address
21139 @opindex mmcount-ra-address
21140 @opindex mno-mcount-ra-address
21141 Emit (do not emit) code that allows @code{_mcount} to modify the
21142 calling function's return address.  When enabled, this option extends
21143 the usual @code{_mcount} interface with a new @var{ra-address}
21144 parameter, which has type @code{intptr_t *} and is passed in register
21145 @code{$12}.  @code{_mcount} can then modify the return address by
21146 doing both of the following:
21147 @itemize
21148 @item
21149 Returning the new address in register @code{$31}.
21150 @item
21151 Storing the new address in @code{*@var{ra-address}},
21152 if @var{ra-address} is nonnull.
21153 @end itemize
21155 The default is @option{-mno-mcount-ra-address}.
21157 @item -mframe-header-opt
21158 @itemx -mno-frame-header-opt
21159 @opindex mframe-header-opt
21160 Enable (disable) frame header optimization in the o32 ABI.  When using the
21161 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
21162 function to write out register arguments.  When enabled, this optimization
21163 will suppress the allocation of the frame header if it can be determined that
21164 it is unused.
21166 This optimization is off by default at all optimization levels.
21168 @item -mlxc1-sxc1
21169 @itemx -mno-lxc1-sxc1
21170 @opindex mlxc1-sxc1
21171 When applicable, enable (disable) the generation of @code{lwxc1},
21172 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
21174 @item -mmadd4
21175 @itemx -mno-madd4
21176 @opindex mmadd4
21177 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
21178 @code{madd.d} and related instructions.  Enabled by default.
21180 @end table
21182 @node MMIX Options
21183 @subsection MMIX Options
21184 @cindex MMIX Options
21186 These options are defined for the MMIX:
21188 @table @gcctabopt
21189 @item -mlibfuncs
21190 @itemx -mno-libfuncs
21191 @opindex mlibfuncs
21192 @opindex mno-libfuncs
21193 Specify that intrinsic library functions are being compiled, passing all
21194 values in registers, no matter the size.
21196 @item -mepsilon
21197 @itemx -mno-epsilon
21198 @opindex mepsilon
21199 @opindex mno-epsilon
21200 Generate floating-point comparison instructions that compare with respect
21201 to the @code{rE} epsilon register.
21203 @item -mabi=mmixware
21204 @itemx -mabi=gnu
21205 @opindex mabi=mmixware
21206 @opindex mabi=gnu
21207 Generate code that passes function parameters and return values that (in
21208 the called function) are seen as registers @code{$0} and up, as opposed to
21209 the GNU ABI which uses global registers @code{$231} and up.
21211 @item -mzero-extend
21212 @itemx -mno-zero-extend
21213 @opindex mzero-extend
21214 @opindex mno-zero-extend
21215 When reading data from memory in sizes shorter than 64 bits, use (do not
21216 use) zero-extending load instructions by default, rather than
21217 sign-extending ones.
21219 @item -mknuthdiv
21220 @itemx -mno-knuthdiv
21221 @opindex mknuthdiv
21222 @opindex mno-knuthdiv
21223 Make the result of a division yielding a remainder have the same sign as
21224 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
21225 remainder follows the sign of the dividend.  Both methods are
21226 arithmetically valid, the latter being almost exclusively used.
21228 @item -mtoplevel-symbols
21229 @itemx -mno-toplevel-symbols
21230 @opindex mtoplevel-symbols
21231 @opindex mno-toplevel-symbols
21232 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
21233 code can be used with the @code{PREFIX} assembly directive.
21235 @item -melf
21236 @opindex melf
21237 Generate an executable in the ELF format, rather than the default
21238 @samp{mmo} format used by the @command{mmix} simulator.
21240 @item -mbranch-predict
21241 @itemx -mno-branch-predict
21242 @opindex mbranch-predict
21243 @opindex mno-branch-predict
21244 Use (do not use) the probable-branch instructions, when static branch
21245 prediction indicates a probable branch.
21247 @item -mbase-addresses
21248 @itemx -mno-base-addresses
21249 @opindex mbase-addresses
21250 @opindex mno-base-addresses
21251 Generate (do not generate) code that uses @emph{base addresses}.  Using a
21252 base address automatically generates a request (handled by the assembler
21253 and the linker) for a constant to be set up in a global register.  The
21254 register is used for one or more base address requests within the range 0
21255 to 255 from the value held in the register.  The generally leads to short
21256 and fast code, but the number of different data items that can be
21257 addressed is limited.  This means that a program that uses lots of static
21258 data may require @option{-mno-base-addresses}.
21260 @item -msingle-exit
21261 @itemx -mno-single-exit
21262 @opindex msingle-exit
21263 @opindex mno-single-exit
21264 Force (do not force) generated code to have a single exit point in each
21265 function.
21266 @end table
21268 @node MN10300 Options
21269 @subsection MN10300 Options
21270 @cindex MN10300 options
21272 These @option{-m} options are defined for Matsushita MN10300 architectures:
21274 @table @gcctabopt
21275 @item -mmult-bug
21276 @opindex mmult-bug
21277 Generate code to avoid bugs in the multiply instructions for the MN10300
21278 processors.  This is the default.
21280 @item -mno-mult-bug
21281 @opindex mno-mult-bug
21282 Do not generate code to avoid bugs in the multiply instructions for the
21283 MN10300 processors.
21285 @item -mam33
21286 @opindex mam33
21287 Generate code using features specific to the AM33 processor.
21289 @item -mno-am33
21290 @opindex mno-am33
21291 Do not generate code using features specific to the AM33 processor.  This
21292 is the default.
21294 @item -mam33-2
21295 @opindex mam33-2
21296 Generate code using features specific to the AM33/2.0 processor.
21298 @item -mam34
21299 @opindex mam34
21300 Generate code using features specific to the AM34 processor.
21302 @item -mtune=@var{cpu-type}
21303 @opindex mtune
21304 Use the timing characteristics of the indicated CPU type when
21305 scheduling instructions.  This does not change the targeted processor
21306 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
21307 @samp{am33-2} or @samp{am34}.
21309 @item -mreturn-pointer-on-d0
21310 @opindex mreturn-pointer-on-d0
21311 When generating a function that returns a pointer, return the pointer
21312 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
21313 only in @code{a0}, and attempts to call such functions without a prototype
21314 result in errors.  Note that this option is on by default; use
21315 @option{-mno-return-pointer-on-d0} to disable it.
21317 @item -mno-crt0
21318 @opindex mno-crt0
21319 Do not link in the C run-time initialization object file.
21321 @item -mrelax
21322 @opindex mrelax
21323 Indicate to the linker that it should perform a relaxation optimization pass
21324 to shorten branches, calls and absolute memory addresses.  This option only
21325 has an effect when used on the command line for the final link step.
21327 This option makes symbolic debugging impossible.
21329 @item -mliw
21330 @opindex mliw
21331 Allow the compiler to generate @emph{Long Instruction Word}
21332 instructions if the target is the @samp{AM33} or later.  This is the
21333 default.  This option defines the preprocessor macro @code{__LIW__}.
21335 @item -mnoliw
21336 @opindex mnoliw
21337 Do not allow the compiler to generate @emph{Long Instruction Word}
21338 instructions.  This option defines the preprocessor macro
21339 @code{__NO_LIW__}.
21341 @item -msetlb
21342 @opindex msetlb
21343 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21344 instructions if the target is the @samp{AM33} or later.  This is the
21345 default.  This option defines the preprocessor macro @code{__SETLB__}.
21347 @item -mnosetlb
21348 @opindex mnosetlb
21349 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21350 instructions.  This option defines the preprocessor macro
21351 @code{__NO_SETLB__}.
21353 @end table
21355 @node Moxie Options
21356 @subsection Moxie Options
21357 @cindex Moxie Options
21359 @table @gcctabopt
21361 @item -meb
21362 @opindex meb
21363 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21364 configurations.
21366 @item -mel
21367 @opindex mel
21368 Generate little-endian code.
21370 @item -mmul.x
21371 @opindex mmul.x
21372 Generate mul.x and umul.x instructions.  This is the default for
21373 @samp{moxiebox-*-*} configurations.
21375 @item -mno-crt0
21376 @opindex mno-crt0
21377 Do not link in the C run-time initialization object file.
21379 @end table
21381 @node MSP430 Options
21382 @subsection MSP430 Options
21383 @cindex MSP430 Options
21385 These options are defined for the MSP430:
21387 @table @gcctabopt
21389 @item -masm-hex
21390 @opindex masm-hex
21391 Force assembly output to always use hex constants.  Normally such
21392 constants are signed decimals, but this option is available for
21393 testsuite and/or aesthetic purposes.
21395 @item -mmcu=
21396 @opindex mmcu=
21397 Select the MCU to target.  This is used to create a C preprocessor
21398 symbol based upon the MCU name, converted to upper case and pre- and
21399 post-fixed with @samp{__}.  This in turn is used by the
21400 @file{msp430.h} header file to select an MCU-specific supplementary
21401 header file.
21403 The option also sets the ISA to use.  If the MCU name is one that is
21404 known to only support the 430 ISA then that is selected, otherwise the
21405 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21406 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21407 name selects the 430X ISA.
21409 In addition an MCU-specific linker script is added to the linker
21410 command line.  The script's name is the name of the MCU with
21411 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21412 command line defines the C preprocessor symbol @code{__XXX__} and
21413 cause the linker to search for a script called @file{xxx.ld}.
21415 This option is also passed on to the assembler.
21417 @item -mwarn-mcu
21418 @itemx -mno-warn-mcu
21419 @opindex mwarn-mcu
21420 @opindex mno-warn-mcu
21421 This option enables or disables warnings about conflicts between the
21422 MCU name specified by the @option{-mmcu} option and the ISA set by the
21423 @option{-mcpu} option and/or the hardware multiply support set by the
21424 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21425 MCU names.  This option is on by default.
21427 @item -mcpu=
21428 @opindex mcpu=
21429 Specifies the ISA to use.  Accepted values are @samp{msp430},
21430 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21431 @option{-mmcu=} option should be used to select the ISA.
21433 @item -msim
21434 @opindex msim
21435 Link to the simulator runtime libraries and linker script.  Overrides
21436 any scripts that would be selected by the @option{-mmcu=} option.
21438 @item -mlarge
21439 @opindex mlarge
21440 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21442 @item -msmall
21443 @opindex msmall
21444 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21446 @item -mrelax
21447 @opindex mrelax
21448 This option is passed to the assembler and linker, and allows the
21449 linker to perform certain optimizations that cannot be done until
21450 the final link.
21452 @item mhwmult=
21453 @opindex mhwmult=
21454 Describes the type of hardware multiply supported by the target.
21455 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21456 for the original 16-bit-only multiply supported by early MCUs.
21457 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21458 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21459 A value of @samp{auto} can also be given.  This tells GCC to deduce
21460 the hardware multiply support based upon the MCU name provided by the
21461 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21462 the MCU name is not recognized then no hardware multiply support is
21463 assumed.  @code{auto} is the default setting.
21465 Hardware multiplies are normally performed by calling a library
21466 routine.  This saves space in the generated code.  When compiling at
21467 @option{-O3} or higher however the hardware multiplier is invoked
21468 inline.  This makes for bigger, but faster code.
21470 The hardware multiply routines disable interrupts whilst running and
21471 restore the previous interrupt state when they finish.  This makes
21472 them safe to use inside interrupt handlers as well as in normal code.
21474 @item -minrt
21475 @opindex minrt
21476 Enable the use of a minimum runtime environment - no static
21477 initializers or constructors.  This is intended for memory-constrained
21478 devices.  The compiler includes special symbols in some objects
21479 that tell the linker and runtime which code fragments are required.
21481 @item -mcode-region=
21482 @itemx -mdata-region=
21483 @opindex mcode-region
21484 @opindex mdata-region
21485 These options tell the compiler where to place functions and data that
21486 do not have one of the @code{lower}, @code{upper}, @code{either} or
21487 @code{section} attributes.  Possible values are @code{lower},
21488 @code{upper}, @code{either} or @code{any}.  The first three behave
21489 like the corresponding attribute.  The fourth possible value -
21490 @code{any} - is the default.  It leaves placement entirely up to the
21491 linker script and how it assigns the standard sections
21492 (@code{.text}, @code{.data}, etc) to the memory regions.
21494 @item -msilicon-errata=
21495 @opindex msilicon-errata
21496 This option passes on a request to assembler to enable the fixes for
21497 the named silicon errata.
21499 @item -msilicon-errata-warn=
21500 @opindex msilicon-errata-warn
21501 This option passes on a request to the assembler to enable warning
21502 messages when a silicon errata might need to be applied.
21504 @end table
21506 @node NDS32 Options
21507 @subsection NDS32 Options
21508 @cindex NDS32 Options
21510 These options are defined for NDS32 implementations:
21512 @table @gcctabopt
21514 @item -mbig-endian
21515 @opindex mbig-endian
21516 Generate code in big-endian mode.
21518 @item -mlittle-endian
21519 @opindex mlittle-endian
21520 Generate code in little-endian mode.
21522 @item -mreduced-regs
21523 @opindex mreduced-regs
21524 Use reduced-set registers for register allocation.
21526 @item -mfull-regs
21527 @opindex mfull-regs
21528 Use full-set registers for register allocation.
21530 @item -mcmov
21531 @opindex mcmov
21532 Generate conditional move instructions.
21534 @item -mno-cmov
21535 @opindex mno-cmov
21536 Do not generate conditional move instructions.
21538 @item -mext-perf
21539 @opindex mperf-ext
21540 Generate performance extension instructions.
21542 @item -mno-ext-perf
21543 @opindex mno-perf-ext
21544 Do not generate performance extension instructions.
21546 @item -mext-perf2
21547 @opindex mperf-ext
21548 Generate performance extension 2 instructions.
21550 @item -mno-ext-perf2
21551 @opindex mno-perf-ext
21552 Do not generate performance extension 2 instructions.
21554 @item -mext-string
21555 @opindex mperf-ext
21556 Generate string extension instructions.
21558 @item -mno-ext-string
21559 @opindex mno-perf-ext
21560 Do not generate string extension instructions.
21562 @item -mv3push
21563 @opindex mv3push
21564 Generate v3 push25/pop25 instructions.
21566 @item -mno-v3push
21567 @opindex mno-v3push
21568 Do not generate v3 push25/pop25 instructions.
21570 @item -m16-bit
21571 @opindex m16-bit
21572 Generate 16-bit instructions.
21574 @item -mno-16-bit
21575 @opindex mno-16-bit
21576 Do not generate 16-bit instructions.
21578 @item -misr-vector-size=@var{num}
21579 @opindex misr-vector-size
21580 Specify the size of each interrupt vector, which must be 4 or 16.
21582 @item -mcache-block-size=@var{num}
21583 @opindex mcache-block-size
21584 Specify the size of each cache block,
21585 which must be a power of 2 between 4 and 512.
21587 @item -march=@var{arch}
21588 @opindex march
21589 Specify the name of the target architecture.
21591 @item -mcmodel=@var{code-model}
21592 @opindex mcmodel
21593 Set the code model to one of
21594 @table @asis
21595 @item @samp{small}
21596 All the data and read-only data segments must be within 512KB addressing space.
21597 The text segment must be within 16MB addressing space.
21598 @item @samp{medium}
21599 The data segment must be within 512KB while the read-only data segment can be
21600 within 4GB addressing space.  The text segment should be still within 16MB
21601 addressing space.
21602 @item @samp{large}
21603 All the text and data segments can be within 4GB addressing space.
21604 @end table
21606 @item -mctor-dtor
21607 @opindex mctor-dtor
21608 Enable constructor/destructor feature.
21610 @item -mrelax
21611 @opindex mrelax
21612 Guide linker to relax instructions.
21614 @end table
21616 @node Nios II Options
21617 @subsection Nios II Options
21618 @cindex Nios II options
21619 @cindex Altera Nios II options
21621 These are the options defined for the Altera Nios II processor.
21623 @table @gcctabopt
21625 @item -G @var{num}
21626 @opindex G
21627 @cindex smaller data references
21628 Put global and static objects less than or equal to @var{num} bytes
21629 into the small data or BSS sections instead of the normal data or BSS
21630 sections.  The default value of @var{num} is 8.
21632 @item -mgpopt=@var{option}
21633 @itemx -mgpopt
21634 @itemx -mno-gpopt
21635 @opindex mgpopt
21636 @opindex mno-gpopt
21637 Generate (do not generate) GP-relative accesses.  The following 
21638 @var{option} names are recognized:
21640 @table @samp
21642 @item none
21643 Do not generate GP-relative accesses.
21645 @item local
21646 Generate GP-relative accesses for small data objects that are not 
21647 external, weak, or uninitialized common symbols.  
21648 Also use GP-relative addressing for objects that
21649 have been explicitly placed in a small data section via a @code{section}
21650 attribute.
21652 @item global
21653 As for @samp{local}, but also generate GP-relative accesses for
21654 small data objects that are external, weak, or common.  If you use this option,
21655 you must ensure that all parts of your program (including libraries) are
21656 compiled with the same @option{-G} setting.
21658 @item data
21659 Generate GP-relative accesses for all data objects in the program.  If you
21660 use this option, the entire data and BSS segments
21661 of your program must fit in 64K of memory and you must use an appropriate
21662 linker script to allocate them within the addressable range of the
21663 global pointer.
21665 @item all
21666 Generate GP-relative addresses for function pointers as well as data
21667 pointers.  If you use this option, the entire text, data, and BSS segments
21668 of your program must fit in 64K of memory and you must use an appropriate
21669 linker script to allocate them within the addressable range of the
21670 global pointer.
21672 @end table
21674 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21675 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21677 The default is @option{-mgpopt} except when @option{-fpic} or
21678 @option{-fPIC} is specified to generate position-independent code.
21679 Note that the Nios II ABI does not permit GP-relative accesses from
21680 shared libraries.
21682 You may need to specify @option{-mno-gpopt} explicitly when building
21683 programs that include large amounts of small data, including large
21684 GOT data sections.  In this case, the 16-bit offset for GP-relative
21685 addressing may not be large enough to allow access to the entire 
21686 small data section.
21688 @item -mgprel-sec=@var{regexp}
21689 @opindex mgprel-sec
21690 This option specifies additional section names that can be accessed via
21691 GP-relative addressing.  It is most useful in conjunction with 
21692 @code{section} attributes on variable declarations 
21693 (@pxref{Common Variable Attributes}) and a custom linker script.  
21694 The @var{regexp} is a POSIX Extended Regular Expression.
21696 This option does not affect the behavior of the @option{-G} option, and 
21697 and the specified sections are in addition to the standard @code{.sdata} 
21698 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21700 @item -mr0rel-sec=@var{regexp}
21701 @opindex mr0rel-sec
21702 This option specifies names of sections that can be accessed via a 
21703 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21704 of the 32-bit address space.  It is most useful in conjunction with 
21705 @code{section} attributes on variable declarations 
21706 (@pxref{Common Variable Attributes}) and a custom linker script.  
21707 The @var{regexp} is a POSIX Extended Regular Expression.
21709 In contrast to the use of GP-relative addressing for small data, 
21710 zero-based addressing is never generated by default and there are no 
21711 conventional section names used in standard linker scripts for sections
21712 in the low or high areas of memory.
21714 @item -mel
21715 @itemx -meb
21716 @opindex mel
21717 @opindex meb
21718 Generate little-endian (default) or big-endian (experimental) code,
21719 respectively.
21721 @item -march=@var{arch}
21722 @opindex march
21723 This specifies the name of the target Nios II architecture.  GCC uses this
21724 name to determine what kind of instructions it can emit when generating
21725 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21727 The preprocessor macro @code{__nios2_arch__} is available to programs,
21728 with value 1 or 2, indicating the targeted ISA level.
21730 @item -mbypass-cache
21731 @itemx -mno-bypass-cache
21732 @opindex mno-bypass-cache
21733 @opindex mbypass-cache
21734 Force all load and store instructions to always bypass cache by 
21735 using I/O variants of the instructions. The default is not to
21736 bypass the cache.
21738 @item -mno-cache-volatile 
21739 @itemx -mcache-volatile       
21740 @opindex mcache-volatile 
21741 @opindex mno-cache-volatile
21742 Volatile memory access bypass the cache using the I/O variants of 
21743 the load and store instructions. The default is not to bypass the cache.
21745 @item -mno-fast-sw-div
21746 @itemx -mfast-sw-div
21747 @opindex mno-fast-sw-div
21748 @opindex mfast-sw-div
21749 Do not use table-based fast divide for small numbers. The default 
21750 is to use the fast divide at @option{-O3} and above.
21752 @item -mno-hw-mul
21753 @itemx -mhw-mul
21754 @itemx -mno-hw-mulx
21755 @itemx -mhw-mulx
21756 @itemx -mno-hw-div
21757 @itemx -mhw-div
21758 @opindex mno-hw-mul
21759 @opindex mhw-mul
21760 @opindex mno-hw-mulx
21761 @opindex mhw-mulx
21762 @opindex mno-hw-div
21763 @opindex mhw-div
21764 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21765 instructions by the compiler. The default is to emit @code{mul}
21766 and not emit @code{div} and @code{mulx}.
21768 @item -mbmx
21769 @itemx -mno-bmx
21770 @itemx -mcdx
21771 @itemx -mno-cdx
21772 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21773 CDX (code density) instructions.  Enabling these instructions also
21774 requires @option{-march=r2}.  Since these instructions are optional
21775 extensions to the R2 architecture, the default is not to emit them.
21777 @item -mcustom-@var{insn}=@var{N}
21778 @itemx -mno-custom-@var{insn}
21779 @opindex mcustom-@var{insn}
21780 @opindex mno-custom-@var{insn}
21781 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21782 custom instruction with encoding @var{N} when generating code that uses 
21783 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21784 instruction 253 for single-precision floating-point add operations instead
21785 of the default behavior of using a library call.
21787 The following values of @var{insn} are supported.  Except as otherwise
21788 noted, floating-point operations are expected to be implemented with
21789 normal IEEE 754 semantics and correspond directly to the C operators or the
21790 equivalent GCC built-in functions (@pxref{Other Builtins}).
21792 Single-precision floating point:
21793 @table @asis
21795 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21796 Binary arithmetic operations.
21798 @item @samp{fnegs}
21799 Unary negation.
21801 @item @samp{fabss}
21802 Unary absolute value.
21804 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21805 Comparison operations.
21807 @item @samp{fmins}, @samp{fmaxs}
21808 Floating-point minimum and maximum.  These instructions are only
21809 generated if @option{-ffinite-math-only} is specified.
21811 @item @samp{fsqrts}
21812 Unary square root operation.
21814 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21815 Floating-point trigonometric and exponential functions.  These instructions
21816 are only generated if @option{-funsafe-math-optimizations} is also specified.
21818 @end table
21820 Double-precision floating point:
21821 @table @asis
21823 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21824 Binary arithmetic operations.
21826 @item @samp{fnegd}
21827 Unary negation.
21829 @item @samp{fabsd}
21830 Unary absolute value.
21832 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21833 Comparison operations.
21835 @item @samp{fmind}, @samp{fmaxd}
21836 Double-precision minimum and maximum.  These instructions are only
21837 generated if @option{-ffinite-math-only} is specified.
21839 @item @samp{fsqrtd}
21840 Unary square root operation.
21842 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21843 Double-precision trigonometric and exponential functions.  These instructions
21844 are only generated if @option{-funsafe-math-optimizations} is also specified.
21846 @end table
21848 Conversions:
21849 @table @asis
21850 @item @samp{fextsd}
21851 Conversion from single precision to double precision.
21853 @item @samp{ftruncds}
21854 Conversion from double precision to single precision.
21856 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21857 Conversion from floating point to signed or unsigned integer types, with
21858 truncation towards zero.
21860 @item @samp{round}
21861 Conversion from single-precision floating point to signed integer,
21862 rounding to the nearest integer and ties away from zero.
21863 This corresponds to the @code{__builtin_lroundf} function when
21864 @option{-fno-math-errno} is used.
21866 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21867 Conversion from signed or unsigned integer types to floating-point types.
21869 @end table
21871 In addition, all of the following transfer instructions for internal
21872 registers X and Y must be provided to use any of the double-precision
21873 floating-point instructions.  Custom instructions taking two
21874 double-precision source operands expect the first operand in the
21875 64-bit register X.  The other operand (or only operand of a unary
21876 operation) is given to the custom arithmetic instruction with the
21877 least significant half in source register @var{src1} and the most
21878 significant half in @var{src2}.  A custom instruction that returns a
21879 double-precision result returns the most significant 32 bits in the
21880 destination register and the other half in 32-bit register Y.  
21881 GCC automatically generates the necessary code sequences to write
21882 register X and/or read register Y when double-precision floating-point
21883 instructions are used.
21885 @table @asis
21887 @item @samp{fwrx}
21888 Write @var{src1} into the least significant half of X and @var{src2} into
21889 the most significant half of X.
21891 @item @samp{fwry}
21892 Write @var{src1} into Y.
21894 @item @samp{frdxhi}, @samp{frdxlo}
21895 Read the most or least (respectively) significant half of X and store it in
21896 @var{dest}.
21898 @item @samp{frdy}
21899 Read the value of Y and store it into @var{dest}.
21900 @end table
21902 Note that you can gain more local control over generation of Nios II custom
21903 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21904 and @code{target("no-custom-@var{insn}")} function attributes
21905 (@pxref{Function Attributes})
21906 or pragmas (@pxref{Function Specific Option Pragmas}).
21908 @item -mcustom-fpu-cfg=@var{name}
21909 @opindex mcustom-fpu-cfg
21911 This option enables a predefined, named set of custom instruction encodings
21912 (see @option{-mcustom-@var{insn}} above).  
21913 Currently, the following sets are defined:
21915 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21916 @gccoptlist{-mcustom-fmuls=252 @gol
21917 -mcustom-fadds=253 @gol
21918 -mcustom-fsubs=254 @gol
21919 -fsingle-precision-constant}
21921 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21922 @gccoptlist{-mcustom-fmuls=252 @gol
21923 -mcustom-fadds=253 @gol
21924 -mcustom-fsubs=254 @gol
21925 -mcustom-fdivs=255 @gol
21926 -fsingle-precision-constant}
21928 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21929 @gccoptlist{-mcustom-floatus=243 @gol
21930 -mcustom-fixsi=244 @gol
21931 -mcustom-floatis=245 @gol
21932 -mcustom-fcmpgts=246 @gol
21933 -mcustom-fcmples=249 @gol
21934 -mcustom-fcmpeqs=250 @gol
21935 -mcustom-fcmpnes=251 @gol
21936 -mcustom-fmuls=252 @gol
21937 -mcustom-fadds=253 @gol
21938 -mcustom-fsubs=254 @gol
21939 -mcustom-fdivs=255 @gol
21940 -fsingle-precision-constant}
21942 Custom instruction assignments given by individual
21943 @option{-mcustom-@var{insn}=} options override those given by
21944 @option{-mcustom-fpu-cfg=}, regardless of the
21945 order of the options on the command line.
21947 Note that you can gain more local control over selection of a FPU
21948 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21949 function attribute (@pxref{Function Attributes})
21950 or pragma (@pxref{Function Specific Option Pragmas}).
21952 @end table
21954 These additional @samp{-m} options are available for the Altera Nios II
21955 ELF (bare-metal) target:
21957 @table @gcctabopt
21959 @item -mhal
21960 @opindex mhal
21961 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21962 startup and termination code, and is typically used in conjunction with
21963 @option{-msys-crt0=} to specify the location of the alternate startup code
21964 provided by the HAL BSP.
21966 @item -msmallc
21967 @opindex msmallc
21968 Link with a limited version of the C library, @option{-lsmallc}, rather than
21969 Newlib.
21971 @item -msys-crt0=@var{startfile}
21972 @opindex msys-crt0
21973 @var{startfile} is the file name of the startfile (crt0) to use 
21974 when linking.  This option is only useful in conjunction with @option{-mhal}.
21976 @item -msys-lib=@var{systemlib}
21977 @opindex msys-lib
21978 @var{systemlib} is the library name of the library that provides
21979 low-level system calls required by the C library,
21980 e.g. @code{read} and @code{write}.
21981 This option is typically used to link with a library provided by a HAL BSP.
21983 @end table
21985 @node Nvidia PTX Options
21986 @subsection Nvidia PTX Options
21987 @cindex Nvidia PTX options
21988 @cindex nvptx options
21990 These options are defined for Nvidia PTX:
21992 @table @gcctabopt
21994 @item -m32
21995 @itemx -m64
21996 @opindex m32
21997 @opindex m64
21998 Generate code for 32-bit or 64-bit ABI.
22000 @item -mmainkernel
22001 @opindex mmainkernel
22002 Link in code for a __main kernel.  This is for stand-alone instead of
22003 offloading execution.
22005 @item -moptimize
22006 @opindex moptimize
22007 Apply partitioned execution optimizations.  This is the default when any
22008 level of optimization is selected.
22010 @item -msoft-stack
22011 @opindex msoft-stack
22012 Generate code that does not use @code{.local} memory
22013 directly for stack storage. Instead, a per-warp stack pointer is
22014 maintained explicitly. This enables variable-length stack allocation (with
22015 variable-length arrays or @code{alloca}), and when global memory is used for
22016 underlying storage, makes it possible to access automatic variables from other
22017 threads, or with atomic instructions. This code generation variant is used
22018 for OpenMP offloading, but the option is exposed on its own for the purpose
22019 of testing the compiler; to generate code suitable for linking into programs
22020 using OpenMP offloading, use option @option{-mgomp}.
22022 @item -muniform-simt
22023 @opindex muniform-simt
22024 Switch to code generation variant that allows to execute all threads in each
22025 warp, while maintaining memory state and side effects as if only one thread
22026 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
22027 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
22028 current lane index equals the master lane index), and the register being
22029 assigned is copied via a shuffle instruction from the master lane.  Outside of
22030 SIMD regions lane 0 is the master; inside, each thread sees itself as the
22031 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
22032 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
22033 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
22034 with current lane index to compute the master lane index.
22036 @item -mgomp
22037 @opindex mgomp
22038 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
22039 @option{-muniform-simt} options, and selects corresponding multilib variant.
22041 @end table
22043 @node PDP-11 Options
22044 @subsection PDP-11 Options
22045 @cindex PDP-11 Options
22047 These options are defined for the PDP-11:
22049 @table @gcctabopt
22050 @item -mfpu
22051 @opindex mfpu
22052 Use hardware FPP floating point.  This is the default.  (FIS floating
22053 point on the PDP-11/40 is not supported.)
22055 @item -msoft-float
22056 @opindex msoft-float
22057 Do not use hardware floating point.
22059 @item -mac0
22060 @opindex mac0
22061 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
22063 @item -mno-ac0
22064 @opindex mno-ac0
22065 Return floating-point results in memory.  This is the default.
22067 @item -m40
22068 @opindex m40
22069 Generate code for a PDP-11/40.
22071 @item -m45
22072 @opindex m45
22073 Generate code for a PDP-11/45.  This is the default.
22075 @item -m10
22076 @opindex m10
22077 Generate code for a PDP-11/10.
22079 @item -mbcopy-builtin
22080 @opindex mbcopy-builtin
22081 Use inline @code{movmemhi} patterns for copying memory.  This is the
22082 default.
22084 @item -mbcopy
22085 @opindex mbcopy
22086 Do not use inline @code{movmemhi} patterns for copying memory.
22088 @item -mint16
22089 @itemx -mno-int32
22090 @opindex mint16
22091 @opindex mno-int32
22092 Use 16-bit @code{int}.  This is the default.
22094 @item -mint32
22095 @itemx -mno-int16
22096 @opindex mint32
22097 @opindex mno-int16
22098 Use 32-bit @code{int}.
22100 @item -mfloat64
22101 @itemx -mno-float32
22102 @opindex mfloat64
22103 @opindex mno-float32
22104 Use 64-bit @code{float}.  This is the default.
22106 @item -mfloat32
22107 @itemx -mno-float64
22108 @opindex mfloat32
22109 @opindex mno-float64
22110 Use 32-bit @code{float}.
22112 @item -mabshi
22113 @opindex mabshi
22114 Use @code{abshi2} pattern.  This is the default.
22116 @item -mno-abshi
22117 @opindex mno-abshi
22118 Do not use @code{abshi2} pattern.
22120 @item -mbranch-expensive
22121 @opindex mbranch-expensive
22122 Pretend that branches are expensive.  This is for experimenting with
22123 code generation only.
22125 @item -mbranch-cheap
22126 @opindex mbranch-cheap
22127 Do not pretend that branches are expensive.  This is the default.
22129 @item -munix-asm
22130 @opindex munix-asm
22131 Use Unix assembler syntax.  This is the default when configured for
22132 @samp{pdp11-*-bsd}.
22134 @item -mdec-asm
22135 @opindex mdec-asm
22136 Use DEC assembler syntax.  This is the default when configured for any
22137 PDP-11 target other than @samp{pdp11-*-bsd}.
22138 @end table
22140 @node picoChip Options
22141 @subsection picoChip Options
22142 @cindex picoChip options
22144 These @samp{-m} options are defined for picoChip implementations:
22146 @table @gcctabopt
22148 @item -mae=@var{ae_type}
22149 @opindex mcpu
22150 Set the instruction set, register set, and instruction scheduling
22151 parameters for array element type @var{ae_type}.  Supported values
22152 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
22154 @option{-mae=ANY} selects a completely generic AE type.  Code
22155 generated with this option runs on any of the other AE types.  The
22156 code is not as efficient as it would be if compiled for a specific
22157 AE type, and some types of operation (e.g., multiplication) do not
22158 work properly on all types of AE.
22160 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
22161 for compiled code, and is the default.
22163 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
22164 option may suffer from poor performance of byte (char) manipulation,
22165 since the DSP AE does not provide hardware support for byte load/stores.
22167 @item -msymbol-as-address
22168 Enable the compiler to directly use a symbol name as an address in a
22169 load/store instruction, without first loading it into a
22170 register.  Typically, the use of this option generates larger
22171 programs, which run faster than when the option isn't used.  However, the
22172 results vary from program to program, so it is left as a user option,
22173 rather than being permanently enabled.
22175 @item -mno-inefficient-warnings
22176 Disables warnings about the generation of inefficient code.  These
22177 warnings can be generated, for example, when compiling code that
22178 performs byte-level memory operations on the MAC AE type.  The MAC AE has
22179 no hardware support for byte-level memory operations, so all byte
22180 load/stores must be synthesized from word load/store operations.  This is
22181 inefficient and a warning is generated to indicate
22182 that you should rewrite the code to avoid byte operations, or to target
22183 an AE type that has the necessary hardware support.  This option disables
22184 these warnings.
22186 @end table
22188 @node PowerPC Options
22189 @subsection PowerPC Options
22190 @cindex PowerPC options
22192 These are listed under @xref{RS/6000 and PowerPC Options}.
22194 @node PowerPC SPE Options
22195 @subsection PowerPC SPE Options
22196 @cindex PowerPC SPE options
22198 These @samp{-m} options are defined for PowerPC SPE:
22199 @table @gcctabopt
22200 @item -mmfcrf
22201 @itemx -mno-mfcrf
22202 @itemx -mpopcntb
22203 @itemx -mno-popcntb
22204 @opindex mmfcrf
22205 @opindex mno-mfcrf
22206 @opindex mpopcntb
22207 @opindex mno-popcntb
22208 You use these options to specify which instructions are available on the
22209 processor you are using.  The default value of these options is
22210 determined when configuring GCC@.  Specifying the
22211 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22212 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22213 rather than the options listed above.
22215 The @option{-mmfcrf} option allows GCC to generate the move from
22216 condition register field instruction implemented on the POWER4
22217 processor and other processors that support the PowerPC V2.01
22218 architecture.
22219 The @option{-mpopcntb} option allows GCC to generate the popcount and
22220 double-precision FP reciprocal estimate instruction implemented on the
22221 POWER5 processor and other processors that support the PowerPC V2.02
22222 architecture.
22224 @item -mcpu=@var{cpu_type}
22225 @opindex mcpu
22226 Set architecture type, register usage, and
22227 instruction scheduling parameters for machine type @var{cpu_type}.
22228 Supported values for @var{cpu_type} are @samp{8540}, @samp{8548},
22229 and @samp{native}.
22231 @option{-mcpu=powerpc} specifies pure 32-bit PowerPC (either
22232 endian), with an appropriate, generic processor model assumed for
22233 scheduling purposes.
22235 Specifying @samp{native} as cpu type detects and selects the
22236 architecture option that corresponds to the host processor of the
22237 system performing the compilation.
22238 @option{-mcpu=native} has no effect if GCC does not recognize the
22239 processor.
22241 The other options specify a specific processor.  Code generated under
22242 those options runs best on that processor, and may not run at all on
22243 others.
22245 The @option{-mcpu} options automatically enable or disable the
22246 following options:
22248 @gccoptlist{-mhard-float  -mmfcrf  -mmultiple @gol
22249 -mpopcntb -mpopcntd @gol
22250 -msingle-float -mdouble-float @gol
22251 -mfloat128}
22253 The particular options set for any particular CPU varies between
22254 compiler versions, depending on what setting seems to produce optimal
22255 code for that CPU; it doesn't necessarily reflect the actual hardware's
22256 capabilities.  If you wish to set an individual option to a particular
22257 value, you may specify it after the @option{-mcpu} option, like
22258 @option{-mcpu=8548}.
22260 @item -mtune=@var{cpu_type}
22261 @opindex mtune
22262 Set the instruction scheduling parameters for machine type
22263 @var{cpu_type}, but do not set the architecture type or register usage,
22264 as @option{-mcpu=@var{cpu_type}} does.  The same
22265 values for @var{cpu_type} are used for @option{-mtune} as for
22266 @option{-mcpu}.  If both are specified, the code generated uses the
22267 architecture and registers set by @option{-mcpu}, but the
22268 scheduling parameters set by @option{-mtune}.
22270 @item -msecure-plt
22271 @opindex msecure-plt
22272 Generate code that allows @command{ld} and @command{ld.so}
22273 to build executables and shared
22274 libraries with non-executable @code{.plt} and @code{.got} sections.
22275 This is a PowerPC
22276 32-bit SYSV ABI option.
22278 @item -mbss-plt
22279 @opindex mbss-plt
22280 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22281 fills in, and
22282 requires @code{.plt} and @code{.got}
22283 sections that are both writable and executable.
22284 This is a PowerPC 32-bit SYSV ABI option.
22286 @item -misel
22287 @itemx -mno-isel
22288 @opindex misel
22289 @opindex mno-isel
22290 This switch enables or disables the generation of ISEL instructions.
22292 @item -misel=@var{yes/no}
22293 This switch has been deprecated.  Use @option{-misel} and
22294 @option{-mno-isel} instead.
22296 @item -mspe
22297 @itemx -mno-spe
22298 @opindex mspe
22299 @opindex mno-spe
22300 This switch enables or disables the generation of SPE simd
22301 instructions.
22303 @item -mspe=@var{yes/no}
22304 This option has been deprecated.  Use @option{-mspe} and
22305 @option{-mno-spe} instead.
22307 @item -mfloat128
22308 @itemx -mno-float128
22309 @opindex mfloat128
22310 @opindex mno-float128
22311 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22312 and use either software emulation for IEEE 128-bit floating point or
22313 hardware instructions.
22315 @item -mfloat-gprs=@var{yes/single/double/no}
22316 @itemx -mfloat-gprs
22317 @opindex mfloat-gprs
22318 This switch enables or disables the generation of floating-point
22319 operations on the general-purpose registers for architectures that
22320 support it.
22322 The argument @samp{yes} or @samp{single} enables the use of
22323 single-precision floating-point operations.
22325 The argument @samp{double} enables the use of single and
22326 double-precision floating-point operations.
22328 The argument @samp{no} disables floating-point operations on the
22329 general-purpose registers.
22331 This option is currently only available on the MPC854x.
22333 @item -mfull-toc
22334 @itemx -mno-fp-in-toc
22335 @itemx -mno-sum-in-toc
22336 @itemx -mminimal-toc
22337 @opindex mfull-toc
22338 @opindex mno-fp-in-toc
22339 @opindex mno-sum-in-toc
22340 @opindex mminimal-toc
22341 Modify generation of the TOC (Table Of Contents), which is created for
22342 every executable file.  The @option{-mfull-toc} option is selected by
22343 default.  In that case, GCC allocates at least one TOC entry for
22344 each unique non-automatic variable reference in your program.  GCC
22345 also places floating-point constants in the TOC@.  However, only
22346 16,384 entries are available in the TOC@.
22348 If you receive a linker error message that saying you have overflowed
22349 the available TOC space, you can reduce the amount of TOC space used
22350 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22351 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22352 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22353 generate code to calculate the sum of an address and a constant at
22354 run time instead of putting that sum into the TOC@.  You may specify one
22355 or both of these options.  Each causes GCC to produce very slightly
22356 slower and larger code at the expense of conserving TOC space.
22358 If you still run out of space in the TOC even when you specify both of
22359 these options, specify @option{-mminimal-toc} instead.  This option causes
22360 GCC to make only one TOC entry for every file.  When you specify this
22361 option, GCC produces code that is slower and larger but which
22362 uses extremely little TOC space.  You may wish to use this option
22363 only on files that contain less frequently-executed code.
22365 @item -maix32
22366 @opindex maix32
22367 Disables the 64-bit ABI.  GCC defaults to @option{-maix32}.
22369 @item -mxl-compat
22370 @itemx -mno-xl-compat
22371 @opindex mxl-compat
22372 @opindex mno-xl-compat
22373 Produce code that conforms more closely to IBM XL compiler semantics
22374 when using AIX-compatible ABI@.  Pass floating-point arguments to
22375 prototyped functions beyond the register save area (RSA) on the stack
22376 in addition to argument FPRs.  Do not assume that most significant
22377 double in 128-bit long double value is properly rounded when comparing
22378 values and converting to double.  Use XL symbol names for long double
22379 support routines.
22381 The AIX calling convention was extended but not initially documented to
22382 handle an obscure K&R C case of calling a function that takes the
22383 address of its arguments with fewer arguments than declared.  IBM XL
22384 compilers access floating-point arguments that do not fit in the
22385 RSA from the stack when a subroutine is compiled without
22386 optimization.  Because always storing floating-point arguments on the
22387 stack is inefficient and rarely needed, this option is not enabled by
22388 default and only is necessary when calling subroutines compiled by IBM
22389 XL compilers without optimization.
22391 @item -malign-natural
22392 @itemx -malign-power
22393 @opindex malign-natural
22394 @opindex malign-power
22395 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22396 @option{-malign-natural} overrides the ABI-defined alignment of larger
22397 types, such as floating-point doubles, on their natural size-based boundary.
22398 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22399 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22401 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22402 is not supported.
22404 @item -msoft-float
22405 @itemx -mhard-float
22406 @opindex msoft-float
22407 @opindex mhard-float
22408 Generate code that does not use (uses) the floating-point register set.
22409 Software floating-point emulation is provided if you use the
22410 @option{-msoft-float} option, and pass the option to GCC when linking.
22412 @item -msingle-float
22413 @itemx -mdouble-float
22414 @opindex msingle-float
22415 @opindex mdouble-float
22416 Generate code for single- or double-precision floating-point operations.
22417 @option{-mdouble-float} implies @option{-msingle-float}.
22419 @item -mmultiple
22420 @itemx -mno-multiple
22421 @opindex mmultiple
22422 @opindex mno-multiple
22423 Generate code that uses (does not use) the load multiple word
22424 instructions and the store multiple word instructions.  These
22425 instructions are generated by default on POWER systems, and not
22426 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22427 PowerPC systems, since those instructions do not work when the
22428 processor is in little-endian mode.  The exceptions are PPC740 and
22429 PPC750 which permit these instructions in little-endian mode.
22431 @item -mupdate
22432 @itemx -mno-update
22433 @opindex mupdate
22434 @opindex mno-update
22435 Generate code that uses (does not use) the load or store instructions
22436 that update the base register to the address of the calculated memory
22437 location.  These instructions are generated by default.  If you use
22438 @option{-mno-update}, there is a small window between the time that the
22439 stack pointer is updated and the address of the previous frame is
22440 stored, which means code that walks the stack frame across interrupts or
22441 signals may get corrupted data.
22443 @item -mavoid-indexed-addresses
22444 @itemx -mno-avoid-indexed-addresses
22445 @opindex mavoid-indexed-addresses
22446 @opindex mno-avoid-indexed-addresses
22447 Generate code that tries to avoid (not avoid) the use of indexed load
22448 or store instructions. These instructions can incur a performance
22449 penalty on Power6 processors in certain situations, such as when
22450 stepping through large arrays that cross a 16M boundary.  This option
22451 is enabled by default when targeting Power6 and disabled otherwise.
22453 @item -mfused-madd
22454 @itemx -mno-fused-madd
22455 @opindex mfused-madd
22456 @opindex mno-fused-madd
22457 Generate code that uses (does not use) the floating-point multiply and
22458 accumulate instructions.  These instructions are generated by default
22459 if hardware floating point is used.  The machine-dependent
22460 @option{-mfused-madd} option is now mapped to the machine-independent
22461 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22462 mapped to @option{-ffp-contract=off}.
22464 @item -mno-strict-align
22465 @itemx -mstrict-align
22466 @opindex mno-strict-align
22467 @opindex mstrict-align
22468 On System V.4 and embedded PowerPC systems do not (do) assume that
22469 unaligned memory references are handled by the system.
22471 @item -mrelocatable
22472 @itemx -mno-relocatable
22473 @opindex mrelocatable
22474 @opindex mno-relocatable
22475 Generate code that allows (does not allow) a static executable to be
22476 relocated to a different address at run time.  A simple embedded
22477 PowerPC system loader should relocate the entire contents of
22478 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22479 a table of 32-bit addresses generated by this option.  For this to
22480 work, all objects linked together must be compiled with
22481 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22482 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22484 @item -mrelocatable-lib
22485 @itemx -mno-relocatable-lib
22486 @opindex mrelocatable-lib
22487 @opindex mno-relocatable-lib
22488 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22489 @code{.fixup} section to allow static executables to be relocated at
22490 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22491 alignment of @option{-mrelocatable}.  Objects compiled with
22492 @option{-mrelocatable-lib} may be linked with objects compiled with
22493 any combination of the @option{-mrelocatable} options.
22495 @item -mno-toc
22496 @itemx -mtoc
22497 @opindex mno-toc
22498 @opindex mtoc
22499 On System V.4 and embedded PowerPC systems do not (do) assume that
22500 register 2 contains a pointer to a global area pointing to the addresses
22501 used in the program.
22503 @item -mlittle
22504 @itemx -mlittle-endian
22505 @opindex mlittle
22506 @opindex mlittle-endian
22507 On System V.4 and embedded PowerPC systems compile code for the
22508 processor in little-endian mode.  The @option{-mlittle-endian} option is
22509 the same as @option{-mlittle}.
22511 @item -mbig
22512 @itemx -mbig-endian
22513 @opindex mbig
22514 @opindex mbig-endian
22515 On System V.4 and embedded PowerPC systems compile code for the
22516 processor in big-endian mode.  The @option{-mbig-endian} option is
22517 the same as @option{-mbig}.
22519 @item -mdynamic-no-pic
22520 @opindex mdynamic-no-pic
22521 On Darwin and Mac OS X systems, compile code so that it is not
22522 relocatable, but that its external references are relocatable.  The
22523 resulting code is suitable for applications, but not shared
22524 libraries.
22526 @item -msingle-pic-base
22527 @opindex msingle-pic-base
22528 Treat the register used for PIC addressing as read-only, rather than
22529 loading it in the prologue for each function.  The runtime system is
22530 responsible for initializing this register with an appropriate value
22531 before execution begins.
22533 @item -mprioritize-restricted-insns=@var{priority}
22534 @opindex mprioritize-restricted-insns
22535 This option controls the priority that is assigned to
22536 dispatch-slot restricted instructions during the second scheduling
22537 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22538 or @samp{2} to assign no, highest, or second-highest (respectively)
22539 priority to dispatch-slot restricted
22540 instructions.
22542 @item -msched-costly-dep=@var{dependence_type}
22543 @opindex msched-costly-dep
22544 This option controls which dependences are considered costly
22545 by the target during instruction scheduling.  The argument
22546 @var{dependence_type} takes one of the following values:
22548 @table @asis
22549 @item @samp{no}
22550 No dependence is costly.
22552 @item @samp{all}
22553 All dependences are costly.
22555 @item @samp{true_store_to_load}
22556 A true dependence from store to load is costly.
22558 @item @samp{store_to_load}
22559 Any dependence from store to load is costly.
22561 @item @var{number}
22562 Any dependence for which the latency is greater than or equal to
22563 @var{number} is costly.
22564 @end table
22566 @item -minsert-sched-nops=@var{scheme}
22567 @opindex minsert-sched-nops
22568 This option controls which NOP insertion scheme is used during
22569 the second scheduling pass.  The argument @var{scheme} takes one of the
22570 following values:
22572 @table @asis
22573 @item @samp{no}
22574 Don't insert NOPs.
22576 @item @samp{pad}
22577 Pad with NOPs any dispatch group that has vacant issue slots,
22578 according to the scheduler's grouping.
22580 @item @samp{regroup_exact}
22581 Insert NOPs to force costly dependent insns into
22582 separate groups.  Insert exactly as many NOPs as needed to force an insn
22583 to a new group, according to the estimated processor grouping.
22585 @item @var{number}
22586 Insert NOPs to force costly dependent insns into
22587 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22588 @end table
22590 @item -mcall-sysv
22591 @opindex mcall-sysv
22592 On System V.4 and embedded PowerPC systems compile code using calling
22593 conventions that adhere to the March 1995 draft of the System V
22594 Application Binary Interface, PowerPC processor supplement.  This is the
22595 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22597 @item -mcall-sysv-eabi
22598 @itemx -mcall-eabi
22599 @opindex mcall-sysv-eabi
22600 @opindex mcall-eabi
22601 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22603 @item -mcall-sysv-noeabi
22604 @opindex mcall-sysv-noeabi
22605 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22607 @item -mcall-aixdesc
22608 @opindex m
22609 On System V.4 and embedded PowerPC systems compile code for the AIX
22610 operating system.
22612 @item -mcall-linux
22613 @opindex mcall-linux
22614 On System V.4 and embedded PowerPC systems compile code for the
22615 Linux-based GNU system.
22617 @item -mcall-freebsd
22618 @opindex mcall-freebsd
22619 On System V.4 and embedded PowerPC systems compile code for the
22620 FreeBSD operating system.
22622 @item -mcall-netbsd
22623 @opindex mcall-netbsd
22624 On System V.4 and embedded PowerPC systems compile code for the
22625 NetBSD operating system.
22627 @item -mcall-openbsd
22628 @opindex mcall-netbsd
22629 On System V.4 and embedded PowerPC systems compile code for the
22630 OpenBSD operating system.
22632 @item -maix-struct-return
22633 @opindex maix-struct-return
22634 Return all structures in memory (as specified by the AIX ABI)@.
22636 @item -msvr4-struct-return
22637 @opindex msvr4-struct-return
22638 Return structures smaller than 8 bytes in registers (as specified by the
22639 SVR4 ABI)@.
22641 @item -mabi=@var{abi-type}
22642 @opindex mabi
22643 Extend the current ABI with a particular extension, or remove such extension.
22644 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22645 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22646 @samp{elfv1}, @samp{elfv2}@.
22648 @item -mabi=spe
22649 @opindex mabi=spe
22650 Extend the current ABI with SPE ABI extensions.  This does not change
22651 the default ABI, instead it adds the SPE ABI extensions to the current
22652 ABI@.
22654 @item -mabi=no-spe
22655 @opindex mabi=no-spe
22656 Disable Book-E SPE ABI extensions for the current ABI@.
22658 @item -mabi=ibmlongdouble
22659 @opindex mabi=ibmlongdouble
22660 Change the current ABI to use IBM extended-precision long double.
22661 This is not likely to work if your system defaults to using IEEE
22662 extended-precision long double.  If you change the long double type
22663 from IEEE extended-precision, the compiler will issue a warning unless
22664 you use the @option{-Wno-psabi} option.
22666 @item -mabi=ieeelongdouble
22667 @opindex mabi=ieeelongdouble
22668 Change the current ABI to use IEEE extended-precision long double.
22669 This is not likely to work if your system defaults to using IBM
22670 extended-precision long double.  If you change the long double type
22671 from IBM extended-precision, the compiler will issue a warning unless
22672 you use the @option{-Wno-psabi} option.
22674 @item -mabi=elfv1
22675 @opindex mabi=elfv1
22676 Change the current ABI to use the ELFv1 ABI.
22677 This is the default ABI for big-endian PowerPC 64-bit Linux.
22678 Overriding the default ABI requires special system support and is
22679 likely to fail in spectacular ways.
22681 @item -mabi=elfv2
22682 @opindex mabi=elfv2
22683 Change the current ABI to use the ELFv2 ABI.
22684 This is the default ABI for little-endian PowerPC 64-bit Linux.
22685 Overriding the default ABI requires special system support and is
22686 likely to fail in spectacular ways.
22688 @item -mgnu-attribute
22689 @itemx -mno-gnu-attribute
22690 @opindex mgnu-attribute
22691 @opindex mno-gnu-attribute
22692 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22693 .gnu.attributes section that specify ABI variations in function
22694 parameters or return values.
22696 @item -mprototype
22697 @itemx -mno-prototype
22698 @opindex mprototype
22699 @opindex mno-prototype
22700 On System V.4 and embedded PowerPC systems assume that all calls to
22701 variable argument functions are properly prototyped.  Otherwise, the
22702 compiler must insert an instruction before every non-prototyped call to
22703 set or clear bit 6 of the condition code register (@code{CR}) to
22704 indicate whether floating-point values are passed in the floating-point
22705 registers in case the function takes variable arguments.  With
22706 @option{-mprototype}, only calls to prototyped variable argument functions
22707 set or clear the bit.
22709 @item -msim
22710 @opindex msim
22711 On embedded PowerPC systems, assume that the startup module is called
22712 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22713 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22714 configurations.
22716 @item -mmvme
22717 @opindex mmvme
22718 On embedded PowerPC systems, assume that the startup module is called
22719 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22720 @file{libc.a}.
22722 @item -mads
22723 @opindex mads
22724 On embedded PowerPC systems, assume that the startup module is called
22725 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22726 @file{libc.a}.
22728 @item -myellowknife
22729 @opindex myellowknife
22730 On embedded PowerPC systems, assume that the startup module is called
22731 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22732 @file{libc.a}.
22734 @item -mvxworks
22735 @opindex mvxworks
22736 On System V.4 and embedded PowerPC systems, specify that you are
22737 compiling for a VxWorks system.
22739 @item -memb
22740 @opindex memb
22741 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22742 header to indicate that @samp{eabi} extended relocations are used.
22744 @item -meabi
22745 @itemx -mno-eabi
22746 @opindex meabi
22747 @opindex mno-eabi
22748 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22749 Embedded Applications Binary Interface (EABI), which is a set of
22750 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22751 means that the stack is aligned to an 8-byte boundary, a function
22752 @code{__eabi} is called from @code{main} to set up the EABI
22753 environment, and the @option{-msdata} option can use both @code{r2} and
22754 @code{r13} to point to two separate small data areas.  Selecting
22755 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22756 no EABI initialization function is called from @code{main}, and the
22757 @option{-msdata} option only uses @code{r13} to point to a single
22758 small data area.  The @option{-meabi} option is on by default if you
22759 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22761 @item -msdata=eabi
22762 @opindex msdata=eabi
22763 On System V.4 and embedded PowerPC systems, put small initialized
22764 @code{const} global and static data in the @code{.sdata2} section, which
22765 is pointed to by register @code{r2}.  Put small initialized
22766 non-@code{const} global and static data in the @code{.sdata} section,
22767 which is pointed to by register @code{r13}.  Put small uninitialized
22768 global and static data in the @code{.sbss} section, which is adjacent to
22769 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22770 incompatible with the @option{-mrelocatable} option.  The
22771 @option{-msdata=eabi} option also sets the @option{-memb} option.
22773 @item -msdata=sysv
22774 @opindex msdata=sysv
22775 On System V.4 and embedded PowerPC systems, put small global and static
22776 data in the @code{.sdata} section, which is pointed to by register
22777 @code{r13}.  Put small uninitialized global and static data in the
22778 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22779 The @option{-msdata=sysv} option is incompatible with the
22780 @option{-mrelocatable} option.
22782 @item -msdata=default
22783 @itemx -msdata
22784 @opindex msdata=default
22785 @opindex msdata
22786 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22787 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22788 same as @option{-msdata=sysv}.
22790 @item -msdata=data
22791 @opindex msdata=data
22792 On System V.4 and embedded PowerPC systems, put small global
22793 data in the @code{.sdata} section.  Put small uninitialized global
22794 data in the @code{.sbss} section.  Do not use register @code{r13}
22795 to address small data however.  This is the default behavior unless
22796 other @option{-msdata} options are used.
22798 @item -msdata=none
22799 @itemx -mno-sdata
22800 @opindex msdata=none
22801 @opindex mno-sdata
22802 On embedded PowerPC systems, put all initialized global and static data
22803 in the @code{.data} section, and all uninitialized data in the
22804 @code{.bss} section.
22806 @item -mblock-move-inline-limit=@var{num}
22807 @opindex mblock-move-inline-limit
22808 Inline all block moves (such as calls to @code{memcpy} or structure
22809 copies) less than or equal to @var{num} bytes.  The minimum value for
22810 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22811 targets.  The default value is target-specific.
22813 @item -G @var{num}
22814 @opindex G
22815 @cindex smaller data references (PowerPC)
22816 @cindex .sdata/.sdata2 references (PowerPC)
22817 On embedded PowerPC systems, put global and static items less than or
22818 equal to @var{num} bytes into the small data or BSS sections instead of
22819 the normal data or BSS section.  By default, @var{num} is 8.  The
22820 @option{-G @var{num}} switch is also passed to the linker.
22821 All modules should be compiled with the same @option{-G @var{num}} value.
22823 @item -mregnames
22824 @itemx -mno-regnames
22825 @opindex mregnames
22826 @opindex mno-regnames
22827 On System V.4 and embedded PowerPC systems do (do not) emit register
22828 names in the assembly language output using symbolic forms.
22830 @item -mlongcall
22831 @itemx -mno-longcall
22832 @opindex mlongcall
22833 @opindex mno-longcall
22834 By default assume that all calls are far away so that a longer and more
22835 expensive calling sequence is required.  This is required for calls
22836 farther than 32 megabytes (33,554,432 bytes) from the current location.
22837 A short call is generated if the compiler knows
22838 the call cannot be that far away.  This setting can be overridden by
22839 the @code{shortcall} function attribute, or by @code{#pragma
22840 longcall(0)}.
22842 Some linkers are capable of detecting out-of-range calls and generating
22843 glue code on the fly.  On these systems, long calls are unnecessary and
22844 generate slower code.  As of this writing, the AIX linker can do this,
22845 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22846 to the GNU linker for 32-bit PowerPC systems as well.
22848 In the future, GCC may ignore all longcall specifications
22849 when the linker is known to generate glue.
22851 @item -mtls-markers
22852 @itemx -mno-tls-markers
22853 @opindex mtls-markers
22854 @opindex mno-tls-markers
22855 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22856 specifying the function argument.  The relocation allows the linker to
22857 reliably associate function call with argument setup instructions for
22858 TLS optimization, which in turn allows GCC to better schedule the
22859 sequence.
22861 @item -mrecip
22862 @itemx -mno-recip
22863 @opindex mrecip
22864 This option enables use of the reciprocal estimate and
22865 reciprocal square root estimate instructions with additional
22866 Newton-Raphson steps to increase precision instead of doing a divide or
22867 square root and divide for floating-point arguments.  You should use
22868 the @option{-ffast-math} option when using @option{-mrecip} (or at
22869 least @option{-funsafe-math-optimizations},
22870 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22871 @option{-fno-trapping-math}).  Note that while the throughput of the
22872 sequence is generally higher than the throughput of the non-reciprocal
22873 instruction, the precision of the sequence can be decreased by up to 2
22874 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22875 roots.
22877 @item -mrecip=@var{opt}
22878 @opindex mrecip=opt
22879 This option controls which reciprocal estimate instructions
22880 may be used.  @var{opt} is a comma-separated list of options, which may
22881 be preceded by a @code{!} to invert the option:
22883 @table @samp
22885 @item all
22886 Enable all estimate instructions.
22888 @item default
22889 Enable the default instructions, equivalent to @option{-mrecip}.
22891 @item none
22892 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22894 @item div
22895 Enable the reciprocal approximation instructions for both
22896 single and double precision.
22898 @item divf
22899 Enable the single-precision reciprocal approximation instructions.
22901 @item divd
22902 Enable the double-precision reciprocal approximation instructions.
22904 @item rsqrt
22905 Enable the reciprocal square root approximation instructions for both
22906 single and double precision.
22908 @item rsqrtf
22909 Enable the single-precision reciprocal square root approximation instructions.
22911 @item rsqrtd
22912 Enable the double-precision reciprocal square root approximation instructions.
22914 @end table
22916 So, for example, @option{-mrecip=all,!rsqrtd} enables
22917 all of the reciprocal estimate instructions, except for the
22918 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22919 which handle the double-precision reciprocal square root calculations.
22921 @item -mrecip-precision
22922 @itemx -mno-recip-precision
22923 @opindex mrecip-precision
22924 Assume (do not assume) that the reciprocal estimate instructions
22925 provide higher-precision estimates than is mandated by the PowerPC
22926 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22927 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22928 The double-precision square root estimate instructions are not generated by
22929 default on low-precision machines, since they do not provide an
22930 estimate that converges after three steps.
22932 @item -mpointers-to-nested-functions
22933 @itemx -mno-pointers-to-nested-functions
22934 @opindex mpointers-to-nested-functions
22935 Generate (do not generate) code to load up the static chain register
22936 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22937 systems where a function pointer points to a 3-word descriptor giving
22938 the function address, TOC value to be loaded in register @code{r2}, and
22939 static chain value to be loaded in register @code{r11}.  The
22940 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22941 call through pointers to nested functions or pointers
22942 to functions compiled in other languages that use the static chain if
22943 you use @option{-mno-pointers-to-nested-functions}.
22945 @item -msave-toc-indirect
22946 @itemx -mno-save-toc-indirect
22947 @opindex msave-toc-indirect
22948 Generate (do not generate) code to save the TOC value in the reserved
22949 stack location in the function prologue if the function calls through
22950 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22951 saved in the prologue, it is saved just before the call through the
22952 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22954 @item -mcompat-align-parm
22955 @itemx -mno-compat-align-parm
22956 @opindex mcompat-align-parm
22957 Generate (do not generate) code to pass structure parameters with a
22958 maximum alignment of 64 bits, for compatibility with older versions
22959 of GCC.
22961 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22962 structure parameter on a 128-bit boundary when that structure contained
22963 a member requiring 128-bit alignment.  This is corrected in more
22964 recent versions of GCC.  This option may be used to generate code
22965 that is compatible with functions compiled with older versions of
22966 GCC.
22968 The @option{-mno-compat-align-parm} option is the default.
22970 @item -mstack-protector-guard=@var{guard}
22971 @itemx -mstack-protector-guard-reg=@var{reg}
22972 @itemx -mstack-protector-guard-offset=@var{offset}
22973 @itemx -mstack-protector-guard-symbol=@var{symbol}
22974 @opindex mstack-protector-guard
22975 @opindex mstack-protector-guard-reg
22976 @opindex mstack-protector-guard-offset
22977 @opindex mstack-protector-guard-symbol
22978 Generate stack protection code using canary at @var{guard}.  Supported
22979 locations are @samp{global} for global canary or @samp{tls} for per-thread
22980 canary in the TLS block (the default with GNU libc version 2.4 or later).
22982 With the latter choice the options
22983 @option{-mstack-protector-guard-reg=@var{reg}} and
22984 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22985 which register to use as base register for reading the canary, and from what
22986 offset from that base register. The default for those is as specified in the
22987 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
22988 the offset with a symbol reference to a canary in the TLS block.
22989 @end table
22992 @node RISC-V Options
22993 @subsection RISC-V Options
22994 @cindex RISC-V Options
22996 These command-line options are defined for RISC-V targets:
22998 @table @gcctabopt
22999 @item -mbranch-cost=@var{n}
23000 @opindex mbranch-cost
23001 Set the cost of branches to roughly @var{n} instructions.
23003 @item -mplt
23004 @itemx -mno-plt
23005 @opindex plt
23006 When generating PIC code, do or don't allow the use of PLTs. Ignored for
23007 non-PIC.  The default is @option{-mplt}.
23009 @item -mabi=@var{ABI-string}
23010 @opindex mabi
23011 Specify integer and floating-point calling convention.  @var{ABI-string}
23012 contains two parts: the size of integer types and the registers used for
23013 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
23014 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
23015 32-bit), and that floating-point values up to 64 bits wide are passed in F
23016 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
23017 allows the compiler to generate code that uses the F and D extensions but only
23018 allows floating-point values up to 32 bits long to be passed in registers; or
23019 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
23020 passed in registers.
23022 The default for this argument is system dependent, users who want a specific
23023 calling convention should specify one explicitly.  The valid calling
23024 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
23025 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
23026 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
23027 invalid because the ABI requires 64-bit values be passed in F registers, but F
23028 registers are only 32 bits wide.  There is also the @samp{ilp32e} ABI that can
23029 only be used with the @samp{rv32e} architecture.  This ABI is not well
23030 specified at present, and is subject to change.
23032 @item -mfdiv
23033 @itemx -mno-fdiv
23034 @opindex mfdiv
23035 Do or don't use hardware floating-point divide and square root instructions.
23036 This requires the F or D extensions for floating-point registers.  The default
23037 is to use them if the specified architecture has these instructions.
23039 @item -mdiv
23040 @itemx -mno-div
23041 @opindex mdiv
23042 Do or don't use hardware instructions for integer division.  This requires the
23043 M extension.  The default is to use them if the specified architecture has
23044 these instructions.
23046 @item -march=@var{ISA-string}
23047 @opindex march
23048 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
23049 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, @samp{rv32e}, and
23050 @samp{rv32imaf}.
23052 @item -mtune=@var{processor-string}
23053 @opindex mtune
23054 Optimize the output for the given processor, specified by microarchitecture
23055 name.
23057 @item -mpreferred-stack-boundary=@var{num}
23058 @opindex mpreferred-stack-boundary
23059 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
23060 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
23061 the default is 4 (16 bytes or 128-bits).
23063 @strong{Warning:} If you use this switch, then you must build all modules with
23064 the same value, including any libraries.  This includes the system libraries
23065 and startup modules.
23067 @item -msmall-data-limit=@var{n}
23068 @opindex msmall-data-limit
23069 Put global and static data smaller than @var{n} bytes into a special section
23070 (on some targets).
23072 @item -msave-restore
23073 @itemx -mno-save-restore
23074 @opindex msave-restore
23075 Do or don't use smaller but slower prologue and epilogue code that uses
23076 library function calls.  The default is to use fast inline prologues and
23077 epilogues.
23079 @item -mstrict-align
23080 @itemx -mno-strict-align
23081 @opindex mstrict-align
23082 Do not or do generate unaligned memory accesses.  The default is set depending
23083 on whether the processor we are optimizing for supports fast unaligned access
23084 or not.
23086 @item -mcmodel=medlow
23087 @opindex mcmodel=medlow
23088 Generate code for the medium-low code model. The program and its statically
23089 defined symbols must lie within a single 2 GiB address range and must lie
23090 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
23091 statically or dynamically linked. This is the default code model.
23093 @item -mcmodel=medany
23094 @opindex mcmodel=medany
23095 Generate code for the medium-any code model. The program and its statically
23096 defined symbols must be within any single 2 GiB address range. Programs can be
23097 statically or dynamically linked.
23099 @item -mexplicit-relocs
23100 @itemx -mno-exlicit-relocs
23101 Use or do not use assembler relocation operators when dealing with symbolic
23102 addresses.  The alternative is to use assembler macros instead, which may
23103 limit optimization.
23105 @item -mrelax
23106 @itemx -mno-relax
23107 Take advantage of linker relaxations to reduce the number of instructions
23108 required to materialize symbol addresses. The default is to take advantage of
23109 linker relaxations.
23111 @end table
23113 @node RL78 Options
23114 @subsection RL78 Options
23115 @cindex RL78 Options
23117 @table @gcctabopt
23119 @item -msim
23120 @opindex msim
23121 Links in additional target libraries to support operation within a
23122 simulator.
23124 @item -mmul=none
23125 @itemx -mmul=g10
23126 @itemx -mmul=g13
23127 @itemx -mmul=g14
23128 @itemx -mmul=rl78
23129 @opindex mmul
23130 Specifies the type of hardware multiplication and division support to
23131 be used.  The simplest is @code{none}, which uses software for both
23132 multiplication and division.  This is the default.  The @code{g13}
23133 value is for the hardware multiply/divide peripheral found on the
23134 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
23135 the multiplication and division instructions supported by the RL78/G14
23136 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
23137 the value @code{mg10} is an alias for @code{none}.
23139 In addition a C preprocessor macro is defined, based upon the setting
23140 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
23141 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
23143 @item -mcpu=g10
23144 @itemx -mcpu=g13
23145 @itemx -mcpu=g14
23146 @itemx -mcpu=rl78
23147 @opindex mcpu
23148 Specifies the RL78 core to target.  The default is the G14 core, also
23149 known as an S3 core or just RL78.  The G13 or S2 core does not have
23150 multiply or divide instructions, instead it uses a hardware peripheral
23151 for these operations.  The G10 or S1 core does not have register
23152 banks, so it uses a different calling convention.
23154 If this option is set it also selects the type of hardware multiply
23155 support to use, unless this is overridden by an explicit
23156 @option{-mmul=none} option on the command line.  Thus specifying
23157 @option{-mcpu=g13} enables the use of the G13 hardware multiply
23158 peripheral and specifying @option{-mcpu=g10} disables the use of
23159 hardware multiplications altogether.
23161 Note, although the RL78/G14 core is the default target, specifying
23162 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
23163 change the behavior of the toolchain since it also enables G14
23164 hardware multiply support.  If these options are not specified on the
23165 command line then software multiplication routines will be used even
23166 though the code targets the RL78 core.  This is for backwards
23167 compatibility with older toolchains which did not have hardware
23168 multiply and divide support.
23170 In addition a C preprocessor macro is defined, based upon the setting
23171 of this option.  Possible values are: @code{__RL78_G10__},
23172 @code{__RL78_G13__} or @code{__RL78_G14__}.
23174 @item -mg10
23175 @itemx -mg13
23176 @itemx -mg14
23177 @itemx -mrl78
23178 @opindex mg10
23179 @opindex mg13
23180 @opindex mg14
23181 @opindex mrl78
23182 These are aliases for the corresponding @option{-mcpu=} option.  They
23183 are provided for backwards compatibility.
23185 @item -mallregs
23186 @opindex mallregs
23187 Allow the compiler to use all of the available registers.  By default
23188 registers @code{r24..r31} are reserved for use in interrupt handlers.
23189 With this option enabled these registers can be used in ordinary
23190 functions as well.
23192 @item -m64bit-doubles
23193 @itemx -m32bit-doubles
23194 @opindex m64bit-doubles
23195 @opindex m32bit-doubles
23196 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23197 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23198 @option{-m32bit-doubles}.
23200 @item -msave-mduc-in-interrupts
23201 @itemx -mno-save-mduc-in-interrupts
23202 @opindex msave-mduc-in-interrupts
23203 @opindex mno-save-mduc-in-interrupts
23204 Specifies that interrupt handler functions should preserve the
23205 MDUC registers.  This is only necessary if normal code might use
23206 the MDUC registers, for example because it performs multiplication
23207 and division operations.  The default is to ignore the MDUC registers
23208 as this makes the interrupt handlers faster.  The target option -mg13
23209 needs to be passed for this to work as this feature is only available
23210 on the G13 target (S2 core).  The MDUC registers will only be saved
23211 if the interrupt handler performs a multiplication or division
23212 operation or it calls another function.
23214 @end table
23216 @node RS/6000 and PowerPC Options
23217 @subsection IBM RS/6000 and PowerPC Options
23218 @cindex RS/6000 and PowerPC Options
23219 @cindex IBM RS/6000 and PowerPC Options
23221 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
23222 @table @gcctabopt
23223 @item -mpowerpc-gpopt
23224 @itemx -mno-powerpc-gpopt
23225 @itemx -mpowerpc-gfxopt
23226 @itemx -mno-powerpc-gfxopt
23227 @need 800
23228 @itemx -mpowerpc64
23229 @itemx -mno-powerpc64
23230 @itemx -mmfcrf
23231 @itemx -mno-mfcrf
23232 @itemx -mpopcntb
23233 @itemx -mno-popcntb
23234 @itemx -mpopcntd
23235 @itemx -mno-popcntd
23236 @itemx -mfprnd
23237 @itemx -mno-fprnd
23238 @need 800
23239 @itemx -mcmpb
23240 @itemx -mno-cmpb
23241 @itemx -mmfpgpr
23242 @itemx -mno-mfpgpr
23243 @itemx -mhard-dfp
23244 @itemx -mno-hard-dfp
23245 @opindex mpowerpc-gpopt
23246 @opindex mno-powerpc-gpopt
23247 @opindex mpowerpc-gfxopt
23248 @opindex mno-powerpc-gfxopt
23249 @opindex mpowerpc64
23250 @opindex mno-powerpc64
23251 @opindex mmfcrf
23252 @opindex mno-mfcrf
23253 @opindex mpopcntb
23254 @opindex mno-popcntb
23255 @opindex mpopcntd
23256 @opindex mno-popcntd
23257 @opindex mfprnd
23258 @opindex mno-fprnd
23259 @opindex mcmpb
23260 @opindex mno-cmpb
23261 @opindex mmfpgpr
23262 @opindex mno-mfpgpr
23263 @opindex mhard-dfp
23264 @opindex mno-hard-dfp
23265 You use these options to specify which instructions are available on the
23266 processor you are using.  The default value of these options is
23267 determined when configuring GCC@.  Specifying the
23268 @option{-mcpu=@var{cpu_type}} overrides the specification of these
23269 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
23270 rather than the options listed above.
23272 Specifying @option{-mpowerpc-gpopt} allows
23273 GCC to use the optional PowerPC architecture instructions in the
23274 General Purpose group, including floating-point square root.  Specifying
23275 @option{-mpowerpc-gfxopt} allows GCC to
23276 use the optional PowerPC architecture instructions in the Graphics
23277 group, including floating-point select.
23279 The @option{-mmfcrf} option allows GCC to generate the move from
23280 condition register field instruction implemented on the POWER4
23281 processor and other processors that support the PowerPC V2.01
23282 architecture.
23283 The @option{-mpopcntb} option allows GCC to generate the popcount and
23284 double-precision FP reciprocal estimate instruction implemented on the
23285 POWER5 processor and other processors that support the PowerPC V2.02
23286 architecture.
23287 The @option{-mpopcntd} option allows GCC to generate the popcount
23288 instruction implemented on the POWER7 processor and other processors
23289 that support the PowerPC V2.06 architecture.
23290 The @option{-mfprnd} option allows GCC to generate the FP round to
23291 integer instructions implemented on the POWER5+ processor and other
23292 processors that support the PowerPC V2.03 architecture.
23293 The @option{-mcmpb} option allows GCC to generate the compare bytes
23294 instruction implemented on the POWER6 processor and other processors
23295 that support the PowerPC V2.05 architecture.
23296 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
23297 general-purpose register instructions implemented on the POWER6X
23298 processor and other processors that support the extended PowerPC V2.05
23299 architecture.
23300 The @option{-mhard-dfp} option allows GCC to generate the decimal
23301 floating-point instructions implemented on some POWER processors.
23303 The @option{-mpowerpc64} option allows GCC to generate the additional
23304 64-bit instructions that are found in the full PowerPC64 architecture
23305 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
23306 @option{-mno-powerpc64}.
23308 @item -mcpu=@var{cpu_type}
23309 @opindex mcpu
23310 Set architecture type, register usage, and
23311 instruction scheduling parameters for machine type @var{cpu_type}.
23312 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
23313 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
23314 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
23315 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
23316 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
23317 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
23318 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
23319 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
23320 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
23321 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
23322 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
23323 @samp{rs64}, and @samp{native}.
23325 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
23326 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
23327 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
23328 architecture machine types, with an appropriate, generic processor
23329 model assumed for scheduling purposes.
23331 Specifying @samp{native} as cpu type detects and selects the
23332 architecture option that corresponds to the host processor of the
23333 system performing the compilation.
23334 @option{-mcpu=native} has no effect if GCC does not recognize the
23335 processor.
23337 The other options specify a specific processor.  Code generated under
23338 those options runs best on that processor, and may not run at all on
23339 others.
23341 The @option{-mcpu} options automatically enable or disable the
23342 following options:
23344 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
23345 -mpopcntb -mpopcntd  -mpowerpc64 @gol
23346 -mpowerpc-gpopt  -mpowerpc-gfxopt @gol
23347 -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
23348 -mcrypto -mhtm -mpower8-fusion -mpower8-vector @gol
23349 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
23351 The particular options set for any particular CPU varies between
23352 compiler versions, depending on what setting seems to produce optimal
23353 code for that CPU; it doesn't necessarily reflect the actual hardware's
23354 capabilities.  If you wish to set an individual option to a particular
23355 value, you may specify it after the @option{-mcpu} option, like
23356 @option{-mcpu=970 -mno-altivec}.
23358 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
23359 not enabled or disabled by the @option{-mcpu} option at present because
23360 AIX does not have full support for these options.  You may still
23361 enable or disable them individually if you're sure it'll work in your
23362 environment.
23364 @item -mtune=@var{cpu_type}
23365 @opindex mtune
23366 Set the instruction scheduling parameters for machine type
23367 @var{cpu_type}, but do not set the architecture type or register usage,
23368 as @option{-mcpu=@var{cpu_type}} does.  The same
23369 values for @var{cpu_type} are used for @option{-mtune} as for
23370 @option{-mcpu}.  If both are specified, the code generated uses the
23371 architecture and registers set by @option{-mcpu}, but the
23372 scheduling parameters set by @option{-mtune}.
23374 @item -mcmodel=small
23375 @opindex mcmodel=small
23376 Generate PowerPC64 code for the small model: The TOC is limited to
23377 64k.
23379 @item -mcmodel=medium
23380 @opindex mcmodel=medium
23381 Generate PowerPC64 code for the medium model: The TOC and other static
23382 data may be up to a total of 4G in size.  This is the default for 64-bit
23383 Linux.
23385 @item -mcmodel=large
23386 @opindex mcmodel=large
23387 Generate PowerPC64 code for the large model: The TOC may be up to 4G
23388 in size.  Other data and code is only limited by the 64-bit address
23389 space.
23391 @item -maltivec
23392 @itemx -mno-altivec
23393 @opindex maltivec
23394 @opindex mno-altivec
23395 Generate code that uses (does not use) AltiVec instructions, and also
23396 enable the use of built-in functions that allow more direct access to
23397 the AltiVec instruction set.  You may also need to set
23398 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
23399 enhancements.
23401 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
23402 @option{-maltivec=be}, the element order for AltiVec intrinsics such
23403 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
23404 match array element order corresponding to the endianness of the
23405 target.  That is, element zero identifies the leftmost element in a
23406 vector register when targeting a big-endian platform, and identifies
23407 the rightmost element in a vector register when targeting a
23408 little-endian platform.
23410 @item -maltivec=be
23411 @opindex maltivec=be
23412 Generate AltiVec instructions using big-endian element order,
23413 regardless of whether the target is big- or little-endian.  This is
23414 the default when targeting a big-endian platform.  Using this option
23415 is currently deprecated.  Support for this feature will be removed in
23416 GCC 9.
23418 The element order is used to interpret element numbers in AltiVec
23419 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23420 @code{vec_insert}.  By default, these match array element order
23421 corresponding to the endianness for the target.
23423 @item -maltivec=le
23424 @opindex maltivec=le
23425 Generate AltiVec instructions using little-endian element order,
23426 regardless of whether the target is big- or little-endian.  This is
23427 the default when targeting a little-endian platform.  This option is
23428 currently ignored when targeting a big-endian platform.
23430 The element order is used to interpret element numbers in AltiVec
23431 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23432 @code{vec_insert}.  By default, these match array element order
23433 corresponding to the endianness for the target.
23435 @item -mvrsave
23436 @itemx -mno-vrsave
23437 @opindex mvrsave
23438 @opindex mno-vrsave
23439 Generate VRSAVE instructions when generating AltiVec code.
23441 @item -msecure-plt
23442 @opindex msecure-plt
23443 Generate code that allows @command{ld} and @command{ld.so}
23444 to build executables and shared
23445 libraries with non-executable @code{.plt} and @code{.got} sections.
23446 This is a PowerPC
23447 32-bit SYSV ABI option.
23449 @item -mbss-plt
23450 @opindex mbss-plt
23451 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
23452 fills in, and
23453 requires @code{.plt} and @code{.got}
23454 sections that are both writable and executable.
23455 This is a PowerPC 32-bit SYSV ABI option.
23457 @item -misel
23458 @itemx -mno-isel
23459 @opindex misel
23460 @opindex mno-isel
23461 This switch enables or disables the generation of ISEL instructions.
23463 @item -misel=@var{yes/no}
23464 This switch has been deprecated.  Use @option{-misel} and
23465 @option{-mno-isel} instead.
23467 @item -mvsx
23468 @itemx -mno-vsx
23469 @opindex mvsx
23470 @opindex mno-vsx
23471 Generate code that uses (does not use) vector/scalar (VSX)
23472 instructions, and also enable the use of built-in functions that allow
23473 more direct access to the VSX instruction set.
23475 @item -mcrypto
23476 @itemx -mno-crypto
23477 @opindex mcrypto
23478 @opindex mno-crypto
23479 Enable the use (disable) of the built-in functions that allow direct
23480 access to the cryptographic instructions that were added in version
23481 2.07 of the PowerPC ISA.
23483 @item -mhtm
23484 @itemx -mno-htm
23485 @opindex mhtm
23486 @opindex mno-htm
23487 Enable (disable) the use of the built-in functions that allow direct
23488 access to the Hardware Transactional Memory (HTM) instructions that
23489 were added in version 2.07 of the PowerPC ISA.
23491 @item -mpower8-fusion
23492 @itemx -mno-power8-fusion
23493 @opindex mpower8-fusion
23494 @opindex mno-power8-fusion
23495 Generate code that keeps (does not keeps) some integer operations
23496 adjacent so that the instructions can be fused together on power8 and
23497 later processors.
23499 @item -mpower8-vector
23500 @itemx -mno-power8-vector
23501 @opindex mpower8-vector
23502 @opindex mno-power8-vector
23503 Generate code that uses (does not use) the vector and scalar
23504 instructions that were added in version 2.07 of the PowerPC ISA.  Also
23505 enable the use of built-in functions that allow more direct access to
23506 the vector instructions.
23508 @item -mquad-memory
23509 @itemx -mno-quad-memory
23510 @opindex mquad-memory
23511 @opindex mno-quad-memory
23512 Generate code that uses (does not use) the non-atomic quad word memory
23513 instructions.  The @option{-mquad-memory} option requires use of
23514 64-bit mode.
23516 @item -mquad-memory-atomic
23517 @itemx -mno-quad-memory-atomic
23518 @opindex mquad-memory-atomic
23519 @opindex mno-quad-memory-atomic
23520 Generate code that uses (does not use) the atomic quad word memory
23521 instructions.  The @option{-mquad-memory-atomic} option requires use of
23522 64-bit mode.
23524 @item -mfloat128
23525 @itemx -mno-float128
23526 @opindex mfloat128
23527 @opindex mno-float128
23528 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
23529 and use either software emulation for IEEE 128-bit floating point or
23530 hardware instructions.
23532 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
23533 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
23534 use the IEEE 128-bit floating point support.  The IEEE 128-bit
23535 floating point support only works on PowerPC Linux systems.
23537 The default for @option{-mfloat128} is enabled on PowerPC Linux
23538 systems using the VSX instruction set, and disabled on other systems.
23540 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
23541 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
23542 point support will also enable the generation of ISA 3.0 IEEE 128-bit
23543 floating point instructions.  Otherwise, if you do not specify to
23544 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
23545 system, IEEE 128-bit floating point will be done with software
23546 emulation.
23548 @item -mfloat128-hardware
23549 @itemx -mno-float128-hardware
23550 @opindex mfloat128-hardware
23551 @opindex mno-float128-hardware
23552 Enable/disable using ISA 3.0 hardware instructions to support the
23553 @var{__float128} data type.
23555 The default for @option{-mfloat128-hardware} is enabled on PowerPC
23556 Linux systems using the ISA 3.0 instruction set, and disabled on other
23557 systems.
23559 @item -m32
23560 @itemx -m64
23561 @opindex m32
23562 @opindex m64
23563 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
23564 targets (including GNU/Linux).  The 32-bit environment sets int, long
23565 and pointer to 32 bits and generates code that runs on any PowerPC
23566 variant.  The 64-bit environment sets int to 32 bits and long and
23567 pointer to 64 bits, and generates code for PowerPC64, as for
23568 @option{-mpowerpc64}.
23570 @item -mfull-toc
23571 @itemx -mno-fp-in-toc
23572 @itemx -mno-sum-in-toc
23573 @itemx -mminimal-toc
23574 @opindex mfull-toc
23575 @opindex mno-fp-in-toc
23576 @opindex mno-sum-in-toc
23577 @opindex mminimal-toc
23578 Modify generation of the TOC (Table Of Contents), which is created for
23579 every executable file.  The @option{-mfull-toc} option is selected by
23580 default.  In that case, GCC allocates at least one TOC entry for
23581 each unique non-automatic variable reference in your program.  GCC
23582 also places floating-point constants in the TOC@.  However, only
23583 16,384 entries are available in the TOC@.
23585 If you receive a linker error message that saying you have overflowed
23586 the available TOC space, you can reduce the amount of TOC space used
23587 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
23588 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
23589 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
23590 generate code to calculate the sum of an address and a constant at
23591 run time instead of putting that sum into the TOC@.  You may specify one
23592 or both of these options.  Each causes GCC to produce very slightly
23593 slower and larger code at the expense of conserving TOC space.
23595 If you still run out of space in the TOC even when you specify both of
23596 these options, specify @option{-mminimal-toc} instead.  This option causes
23597 GCC to make only one TOC entry for every file.  When you specify this
23598 option, GCC produces code that is slower and larger but which
23599 uses extremely little TOC space.  You may wish to use this option
23600 only on files that contain less frequently-executed code.
23602 @item -maix64
23603 @itemx -maix32
23604 @opindex maix64
23605 @opindex maix32
23606 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
23607 @code{long} type, and the infrastructure needed to support them.
23608 Specifying @option{-maix64} implies @option{-mpowerpc64},
23609 while @option{-maix32} disables the 64-bit ABI and
23610 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
23612 @item -mxl-compat
23613 @itemx -mno-xl-compat
23614 @opindex mxl-compat
23615 @opindex mno-xl-compat
23616 Produce code that conforms more closely to IBM XL compiler semantics
23617 when using AIX-compatible ABI@.  Pass floating-point arguments to
23618 prototyped functions beyond the register save area (RSA) on the stack
23619 in addition to argument FPRs.  Do not assume that most significant
23620 double in 128-bit long double value is properly rounded when comparing
23621 values and converting to double.  Use XL symbol names for long double
23622 support routines.
23624 The AIX calling convention was extended but not initially documented to
23625 handle an obscure K&R C case of calling a function that takes the
23626 address of its arguments with fewer arguments than declared.  IBM XL
23627 compilers access floating-point arguments that do not fit in the
23628 RSA from the stack when a subroutine is compiled without
23629 optimization.  Because always storing floating-point arguments on the
23630 stack is inefficient and rarely needed, this option is not enabled by
23631 default and only is necessary when calling subroutines compiled by IBM
23632 XL compilers without optimization.
23634 @item -mpe
23635 @opindex mpe
23636 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
23637 application written to use message passing with special startup code to
23638 enable the application to run.  The system must have PE installed in the
23639 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
23640 must be overridden with the @option{-specs=} option to specify the
23641 appropriate directory location.  The Parallel Environment does not
23642 support threads, so the @option{-mpe} option and the @option{-pthread}
23643 option are incompatible.
23645 @item -malign-natural
23646 @itemx -malign-power
23647 @opindex malign-natural
23648 @opindex malign-power
23649 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
23650 @option{-malign-natural} overrides the ABI-defined alignment of larger
23651 types, such as floating-point doubles, on their natural size-based boundary.
23652 The option @option{-malign-power} instructs GCC to follow the ABI-specified
23653 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
23655 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
23656 is not supported.
23658 @item -msoft-float
23659 @itemx -mhard-float
23660 @opindex msoft-float
23661 @opindex mhard-float
23662 Generate code that does not use (uses) the floating-point register set.
23663 Software floating-point emulation is provided if you use the
23664 @option{-msoft-float} option, and pass the option to GCC when linking.
23666 @item -mmultiple
23667 @itemx -mno-multiple
23668 @opindex mmultiple
23669 @opindex mno-multiple
23670 Generate code that uses (does not use) the load multiple word
23671 instructions and the store multiple word instructions.  These
23672 instructions are generated by default on POWER systems, and not
23673 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
23674 PowerPC systems, since those instructions do not work when the
23675 processor is in little-endian mode.  The exceptions are PPC740 and
23676 PPC750 which permit these instructions in little-endian mode.
23678 @item -mupdate
23679 @itemx -mno-update
23680 @opindex mupdate
23681 @opindex mno-update
23682 Generate code that uses (does not use) the load or store instructions
23683 that update the base register to the address of the calculated memory
23684 location.  These instructions are generated by default.  If you use
23685 @option{-mno-update}, there is a small window between the time that the
23686 stack pointer is updated and the address of the previous frame is
23687 stored, which means code that walks the stack frame across interrupts or
23688 signals may get corrupted data.
23690 @item -mavoid-indexed-addresses
23691 @itemx -mno-avoid-indexed-addresses
23692 @opindex mavoid-indexed-addresses
23693 @opindex mno-avoid-indexed-addresses
23694 Generate code that tries to avoid (not avoid) the use of indexed load
23695 or store instructions. These instructions can incur a performance
23696 penalty on Power6 processors in certain situations, such as when
23697 stepping through large arrays that cross a 16M boundary.  This option
23698 is enabled by default when targeting Power6 and disabled otherwise.
23700 @item -mfused-madd
23701 @itemx -mno-fused-madd
23702 @opindex mfused-madd
23703 @opindex mno-fused-madd
23704 Generate code that uses (does not use) the floating-point multiply and
23705 accumulate instructions.  These instructions are generated by default
23706 if hardware floating point is used.  The machine-dependent
23707 @option{-mfused-madd} option is now mapped to the machine-independent
23708 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23709 mapped to @option{-ffp-contract=off}.
23711 @item -mmulhw
23712 @itemx -mno-mulhw
23713 @opindex mmulhw
23714 @opindex mno-mulhw
23715 Generate code that uses (does not use) the half-word multiply and
23716 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
23717 These instructions are generated by default when targeting those
23718 processors.
23720 @item -mdlmzb
23721 @itemx -mno-dlmzb
23722 @opindex mdlmzb
23723 @opindex mno-dlmzb
23724 Generate code that uses (does not use) the string-search @samp{dlmzb}
23725 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
23726 generated by default when targeting those processors.
23728 @item -mno-bit-align
23729 @itemx -mbit-align
23730 @opindex mno-bit-align
23731 @opindex mbit-align
23732 On System V.4 and embedded PowerPC systems do not (do) force structures
23733 and unions that contain bit-fields to be aligned to the base type of the
23734 bit-field.
23736 For example, by default a structure containing nothing but 8
23737 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
23738 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
23739 the structure is aligned to a 1-byte boundary and is 1 byte in
23740 size.
23742 @item -mno-strict-align
23743 @itemx -mstrict-align
23744 @opindex mno-strict-align
23745 @opindex mstrict-align
23746 On System V.4 and embedded PowerPC systems do not (do) assume that
23747 unaligned memory references are handled by the system.
23749 @item -mrelocatable
23750 @itemx -mno-relocatable
23751 @opindex mrelocatable
23752 @opindex mno-relocatable
23753 Generate code that allows (does not allow) a static executable to be
23754 relocated to a different address at run time.  A simple embedded
23755 PowerPC system loader should relocate the entire contents of
23756 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
23757 a table of 32-bit addresses generated by this option.  For this to
23758 work, all objects linked together must be compiled with
23759 @option{-mrelocatable} or @option{-mrelocatable-lib}.
23760 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
23762 @item -mrelocatable-lib
23763 @itemx -mno-relocatable-lib
23764 @opindex mrelocatable-lib
23765 @opindex mno-relocatable-lib
23766 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
23767 @code{.fixup} section to allow static executables to be relocated at
23768 run time, but @option{-mrelocatable-lib} does not use the smaller stack
23769 alignment of @option{-mrelocatable}.  Objects compiled with
23770 @option{-mrelocatable-lib} may be linked with objects compiled with
23771 any combination of the @option{-mrelocatable} options.
23773 @item -mno-toc
23774 @itemx -mtoc
23775 @opindex mno-toc
23776 @opindex mtoc
23777 On System V.4 and embedded PowerPC systems do not (do) assume that
23778 register 2 contains a pointer to a global area pointing to the addresses
23779 used in the program.
23781 @item -mlittle
23782 @itemx -mlittle-endian
23783 @opindex mlittle
23784 @opindex mlittle-endian
23785 On System V.4 and embedded PowerPC systems compile code for the
23786 processor in little-endian mode.  The @option{-mlittle-endian} option is
23787 the same as @option{-mlittle}.
23789 @item -mbig
23790 @itemx -mbig-endian
23791 @opindex mbig
23792 @opindex mbig-endian
23793 On System V.4 and embedded PowerPC systems compile code for the
23794 processor in big-endian mode.  The @option{-mbig-endian} option is
23795 the same as @option{-mbig}.
23797 @item -mdynamic-no-pic
23798 @opindex mdynamic-no-pic
23799 On Darwin and Mac OS X systems, compile code so that it is not
23800 relocatable, but that its external references are relocatable.  The
23801 resulting code is suitable for applications, but not shared
23802 libraries.
23804 @item -msingle-pic-base
23805 @opindex msingle-pic-base
23806 Treat the register used for PIC addressing as read-only, rather than
23807 loading it in the prologue for each function.  The runtime system is
23808 responsible for initializing this register with an appropriate value
23809 before execution begins.
23811 @item -mprioritize-restricted-insns=@var{priority}
23812 @opindex mprioritize-restricted-insns
23813 This option controls the priority that is assigned to
23814 dispatch-slot restricted instructions during the second scheduling
23815 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
23816 or @samp{2} to assign no, highest, or second-highest (respectively) 
23817 priority to dispatch-slot restricted
23818 instructions.
23820 @item -msched-costly-dep=@var{dependence_type}
23821 @opindex msched-costly-dep
23822 This option controls which dependences are considered costly
23823 by the target during instruction scheduling.  The argument
23824 @var{dependence_type} takes one of the following values:
23826 @table @asis
23827 @item @samp{no}
23828 No dependence is costly.
23830 @item @samp{all}
23831 All dependences are costly.
23833 @item @samp{true_store_to_load}
23834 A true dependence from store to load is costly.
23836 @item @samp{store_to_load}
23837 Any dependence from store to load is costly.
23839 @item @var{number}
23840 Any dependence for which the latency is greater than or equal to 
23841 @var{number} is costly.
23842 @end table
23844 @item -minsert-sched-nops=@var{scheme}
23845 @opindex minsert-sched-nops
23846 This option controls which NOP insertion scheme is used during
23847 the second scheduling pass.  The argument @var{scheme} takes one of the
23848 following values:
23850 @table @asis
23851 @item @samp{no}
23852 Don't insert NOPs.
23854 @item @samp{pad}
23855 Pad with NOPs any dispatch group that has vacant issue slots,
23856 according to the scheduler's grouping.
23858 @item @samp{regroup_exact}
23859 Insert NOPs to force costly dependent insns into
23860 separate groups.  Insert exactly as many NOPs as needed to force an insn
23861 to a new group, according to the estimated processor grouping.
23863 @item @var{number}
23864 Insert NOPs to force costly dependent insns into
23865 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
23866 @end table
23868 @item -mcall-sysv
23869 @opindex mcall-sysv
23870 On System V.4 and embedded PowerPC systems compile code using calling
23871 conventions that adhere to the March 1995 draft of the System V
23872 Application Binary Interface, PowerPC processor supplement.  This is the
23873 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
23875 @item -mcall-sysv-eabi
23876 @itemx -mcall-eabi
23877 @opindex mcall-sysv-eabi
23878 @opindex mcall-eabi
23879 Specify both @option{-mcall-sysv} and @option{-meabi} options.
23881 @item -mcall-sysv-noeabi
23882 @opindex mcall-sysv-noeabi
23883 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
23885 @item -mcall-aixdesc
23886 @opindex m
23887 On System V.4 and embedded PowerPC systems compile code for the AIX
23888 operating system.
23890 @item -mcall-linux
23891 @opindex mcall-linux
23892 On System V.4 and embedded PowerPC systems compile code for the
23893 Linux-based GNU system.
23895 @item -mcall-freebsd
23896 @opindex mcall-freebsd
23897 On System V.4 and embedded PowerPC systems compile code for the
23898 FreeBSD operating system.
23900 @item -mcall-netbsd
23901 @opindex mcall-netbsd
23902 On System V.4 and embedded PowerPC systems compile code for the
23903 NetBSD operating system.
23905 @item -mcall-openbsd
23906 @opindex mcall-netbsd
23907 On System V.4 and embedded PowerPC systems compile code for the
23908 OpenBSD operating system.
23910 @item -mtraceback=@var{traceback_type}
23911 @opindex mtraceback
23912 Select the type of traceback table. Valid values for @var{traceback_type}
23913 are @samp{full}, @samp{part}, and @samp{no}.
23915 @item -maix-struct-return
23916 @opindex maix-struct-return
23917 Return all structures in memory (as specified by the AIX ABI)@.
23919 @item -msvr4-struct-return
23920 @opindex msvr4-struct-return
23921 Return structures smaller than 8 bytes in registers (as specified by the
23922 SVR4 ABI)@.
23924 @item -mabi=@var{abi-type}
23925 @opindex mabi
23926 Extend the current ABI with a particular extension, or remove such extension.
23927 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
23928 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
23929 @samp{elfv1}, @samp{elfv2}@.
23931 @item -mabi=ibmlongdouble
23932 @opindex mabi=ibmlongdouble
23933 Change the current ABI to use IBM extended-precision long double.
23934 This is not likely to work if your system defaults to using IEEE
23935 extended-precision long double.  If you change the long double type
23936 from IEEE extended-precision, the compiler will issue a warning unless
23937 you use the @option{-Wno-psabi} option.
23939 @item -mabi=ieeelongdouble
23940 @opindex mabi=ieeelongdouble
23941 Change the current ABI to use IEEE extended-precision long double.
23942 This is not likely to work if your system defaults to using IBM
23943 extended-precision long double.  If you change the long double type
23944 from IBM extended-precision, the compiler will issue a warning unless
23945 you use the @option{-Wno-psabi} option.
23947 @item -mabi=elfv1
23948 @opindex mabi=elfv1
23949 Change the current ABI to use the ELFv1 ABI.
23950 This is the default ABI for big-endian PowerPC 64-bit Linux.
23951 Overriding the default ABI requires special system support and is
23952 likely to fail in spectacular ways.
23954 @item -mabi=elfv2
23955 @opindex mabi=elfv2
23956 Change the current ABI to use the ELFv2 ABI.
23957 This is the default ABI for little-endian PowerPC 64-bit Linux.
23958 Overriding the default ABI requires special system support and is
23959 likely to fail in spectacular ways.
23961 @item -mgnu-attribute
23962 @itemx -mno-gnu-attribute
23963 @opindex mgnu-attribute
23964 @opindex mno-gnu-attribute
23965 Emit .gnu_attribute assembly directives to set tag/value pairs in a
23966 .gnu.attributes section that specify ABI variations in function
23967 parameters or return values.
23969 @item -mprototype
23970 @itemx -mno-prototype
23971 @opindex mprototype
23972 @opindex mno-prototype
23973 On System V.4 and embedded PowerPC systems assume that all calls to
23974 variable argument functions are properly prototyped.  Otherwise, the
23975 compiler must insert an instruction before every non-prototyped call to
23976 set or clear bit 6 of the condition code register (@code{CR}) to
23977 indicate whether floating-point values are passed in the floating-point
23978 registers in case the function takes variable arguments.  With
23979 @option{-mprototype}, only calls to prototyped variable argument functions
23980 set or clear the bit.
23982 @item -msim
23983 @opindex msim
23984 On embedded PowerPC systems, assume that the startup module is called
23985 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
23986 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
23987 configurations.
23989 @item -mmvme
23990 @opindex mmvme
23991 On embedded PowerPC systems, assume that the startup module is called
23992 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
23993 @file{libc.a}.
23995 @item -mads
23996 @opindex mads
23997 On embedded PowerPC systems, assume that the startup module is called
23998 @file{crt0.o} and the standard C libraries are @file{libads.a} and
23999 @file{libc.a}.
24001 @item -myellowknife
24002 @opindex myellowknife
24003 On embedded PowerPC systems, assume that the startup module is called
24004 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
24005 @file{libc.a}.
24007 @item -mvxworks
24008 @opindex mvxworks
24009 On System V.4 and embedded PowerPC systems, specify that you are
24010 compiling for a VxWorks system.
24012 @item -memb
24013 @opindex memb
24014 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
24015 header to indicate that @samp{eabi} extended relocations are used.
24017 @item -meabi
24018 @itemx -mno-eabi
24019 @opindex meabi
24020 @opindex mno-eabi
24021 On System V.4 and embedded PowerPC systems do (do not) adhere to the
24022 Embedded Applications Binary Interface (EABI), which is a set of
24023 modifications to the System V.4 specifications.  Selecting @option{-meabi}
24024 means that the stack is aligned to an 8-byte boundary, a function
24025 @code{__eabi} is called from @code{main} to set up the EABI
24026 environment, and the @option{-msdata} option can use both @code{r2} and
24027 @code{r13} to point to two separate small data areas.  Selecting
24028 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
24029 no EABI initialization function is called from @code{main}, and the
24030 @option{-msdata} option only uses @code{r13} to point to a single
24031 small data area.  The @option{-meabi} option is on by default if you
24032 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
24034 @item -msdata=eabi
24035 @opindex msdata=eabi
24036 On System V.4 and embedded PowerPC systems, put small initialized
24037 @code{const} global and static data in the @code{.sdata2} section, which
24038 is pointed to by register @code{r2}.  Put small initialized
24039 non-@code{const} global and static data in the @code{.sdata} section,
24040 which is pointed to by register @code{r13}.  Put small uninitialized
24041 global and static data in the @code{.sbss} section, which is adjacent to
24042 the @code{.sdata} section.  The @option{-msdata=eabi} option is
24043 incompatible with the @option{-mrelocatable} option.  The
24044 @option{-msdata=eabi} option also sets the @option{-memb} option.
24046 @item -msdata=sysv
24047 @opindex msdata=sysv
24048 On System V.4 and embedded PowerPC systems, put small global and static
24049 data in the @code{.sdata} section, which is pointed to by register
24050 @code{r13}.  Put small uninitialized global and static data in the
24051 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
24052 The @option{-msdata=sysv} option is incompatible with the
24053 @option{-mrelocatable} option.
24055 @item -msdata=default
24056 @itemx -msdata
24057 @opindex msdata=default
24058 @opindex msdata
24059 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
24060 compile code the same as @option{-msdata=eabi}, otherwise compile code the
24061 same as @option{-msdata=sysv}.
24063 @item -msdata=data
24064 @opindex msdata=data
24065 On System V.4 and embedded PowerPC systems, put small global
24066 data in the @code{.sdata} section.  Put small uninitialized global
24067 data in the @code{.sbss} section.  Do not use register @code{r13}
24068 to address small data however.  This is the default behavior unless
24069 other @option{-msdata} options are used.
24071 @item -msdata=none
24072 @itemx -mno-sdata
24073 @opindex msdata=none
24074 @opindex mno-sdata
24075 On embedded PowerPC systems, put all initialized global and static data
24076 in the @code{.data} section, and all uninitialized data in the
24077 @code{.bss} section.
24079 @item -mreadonly-in-sdata
24080 @opindex mreadonly-in-sdata
24081 @opindex mno-readonly-in-sdata
24082 Put read-only objects in the @code{.sdata} section as well.  This is the
24083 default.
24085 @item -mblock-move-inline-limit=@var{num}
24086 @opindex mblock-move-inline-limit
24087 Inline all block moves (such as calls to @code{memcpy} or structure
24088 copies) less than or equal to @var{num} bytes.  The minimum value for
24089 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
24090 targets.  The default value is target-specific.
24092 @item -mblock-compare-inline-limit=@var{num}
24093 @opindex mblock-compare-inline-limit
24094 Generate non-looping inline code for all block compares (such as calls
24095 to @code{memcmp} or structure compares) less than or equal to @var{num}
24096 bytes. If @var{num} is 0, all inline expansion (non-loop and loop) of
24097 block compare is disabled. The default value is target-specific.
24099 @item -mblock-compare-inline-loop-limit=@var{num}
24100 @opindex mblock-compare-inline-loop-limit
24101 Generate an inline expansion using loop code for all block compares that
24102 are less than or equal to @var{num} bytes, but greater than the limit
24103 for non-loop inline block compare expansion. If the block length is not
24104 constant, at most @var{num} bytes will be compared before @code{memcmp}
24105 is called to compare the remainder of the block. The default value is
24106 target-specific.
24108 @item -mstring-compare-inline-limit=@var{num}
24109 @opindex mstring-compare-inline-limit
24110 Generate at most @var{num} pairs of load instructions to compare the
24111 string inline. If the difference or end of string is not found at the
24112 end of the inline compare a call to @code{strcmp} or @code{strncmp} will
24113 take care of the rest of the comparison. The default is 8 pairs of
24114 loads, which will compare 64 bytes on a 64-bit target and 32 bytes on a
24115 32-bit target.
24117 @item -G @var{num}
24118 @opindex G
24119 @cindex smaller data references (PowerPC)
24120 @cindex .sdata/.sdata2 references (PowerPC)
24121 On embedded PowerPC systems, put global and static items less than or
24122 equal to @var{num} bytes into the small data or BSS sections instead of
24123 the normal data or BSS section.  By default, @var{num} is 8.  The
24124 @option{-G @var{num}} switch is also passed to the linker.
24125 All modules should be compiled with the same @option{-G @var{num}} value.
24127 @item -mregnames
24128 @itemx -mno-regnames
24129 @opindex mregnames
24130 @opindex mno-regnames
24131 On System V.4 and embedded PowerPC systems do (do not) emit register
24132 names in the assembly language output using symbolic forms.
24134 @item -mlongcall
24135 @itemx -mno-longcall
24136 @opindex mlongcall
24137 @opindex mno-longcall
24138 By default assume that all calls are far away so that a longer and more
24139 expensive calling sequence is required.  This is required for calls
24140 farther than 32 megabytes (33,554,432 bytes) from the current location.
24141 A short call is generated if the compiler knows
24142 the call cannot be that far away.  This setting can be overridden by
24143 the @code{shortcall} function attribute, or by @code{#pragma
24144 longcall(0)}.
24146 Some linkers are capable of detecting out-of-range calls and generating
24147 glue code on the fly.  On these systems, long calls are unnecessary and
24148 generate slower code.  As of this writing, the AIX linker can do this,
24149 as can the GNU linker for PowerPC/64.  It is planned to add this feature
24150 to the GNU linker for 32-bit PowerPC systems as well.
24152 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
24153 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
24154 addresses represent the callee and the branch island.  The
24155 Darwin/PPC linker prefers the first address and generates a @code{bl
24156 callee} if the PPC @code{bl} instruction reaches the callee directly;
24157 otherwise, the linker generates @code{bl L42} to call the branch
24158 island.  The branch island is appended to the body of the
24159 calling function; it computes the full 32-bit address of the callee
24160 and jumps to it.
24162 On Mach-O (Darwin) systems, this option directs the compiler emit to
24163 the glue for every direct call, and the Darwin linker decides whether
24164 to use or discard it.
24166 In the future, GCC may ignore all longcall specifications
24167 when the linker is known to generate glue.
24169 @item -mtls-markers
24170 @itemx -mno-tls-markers
24171 @opindex mtls-markers
24172 @opindex mno-tls-markers
24173 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
24174 specifying the function argument.  The relocation allows the linker to
24175 reliably associate function call with argument setup instructions for
24176 TLS optimization, which in turn allows GCC to better schedule the
24177 sequence.
24179 @item -mrecip
24180 @itemx -mno-recip
24181 @opindex mrecip
24182 This option enables use of the reciprocal estimate and
24183 reciprocal square root estimate instructions with additional
24184 Newton-Raphson steps to increase precision instead of doing a divide or
24185 square root and divide for floating-point arguments.  You should use
24186 the @option{-ffast-math} option when using @option{-mrecip} (or at
24187 least @option{-funsafe-math-optimizations},
24188 @option{-ffinite-math-only}, @option{-freciprocal-math} and
24189 @option{-fno-trapping-math}).  Note that while the throughput of the
24190 sequence is generally higher than the throughput of the non-reciprocal
24191 instruction, the precision of the sequence can be decreased by up to 2
24192 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
24193 roots.
24195 @item -mrecip=@var{opt}
24196 @opindex mrecip=opt
24197 This option controls which reciprocal estimate instructions
24198 may be used.  @var{opt} is a comma-separated list of options, which may
24199 be preceded by a @code{!} to invert the option:
24201 @table @samp
24203 @item all
24204 Enable all estimate instructions.
24206 @item default 
24207 Enable the default instructions, equivalent to @option{-mrecip}.
24209 @item none 
24210 Disable all estimate instructions, equivalent to @option{-mno-recip}.
24212 @item div 
24213 Enable the reciprocal approximation instructions for both 
24214 single and double precision.
24216 @item divf 
24217 Enable the single-precision reciprocal approximation instructions.
24219 @item divd 
24220 Enable the double-precision reciprocal approximation instructions.
24222 @item rsqrt 
24223 Enable the reciprocal square root approximation instructions for both
24224 single and double precision.
24226 @item rsqrtf 
24227 Enable the single-precision reciprocal square root approximation instructions.
24229 @item rsqrtd 
24230 Enable the double-precision reciprocal square root approximation instructions.
24232 @end table
24234 So, for example, @option{-mrecip=all,!rsqrtd} enables
24235 all of the reciprocal estimate instructions, except for the
24236 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
24237 which handle the double-precision reciprocal square root calculations.
24239 @item -mrecip-precision
24240 @itemx -mno-recip-precision
24241 @opindex mrecip-precision
24242 Assume (do not assume) that the reciprocal estimate instructions
24243 provide higher-precision estimates than is mandated by the PowerPC
24244 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
24245 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
24246 The double-precision square root estimate instructions are not generated by
24247 default on low-precision machines, since they do not provide an
24248 estimate that converges after three steps.
24250 @item -mveclibabi=@var{type}
24251 @opindex mveclibabi
24252 Specifies the ABI type to use for vectorizing intrinsics using an
24253 external library.  The only type supported at present is @samp{mass},
24254 which specifies to use IBM's Mathematical Acceleration Subsystem
24255 (MASS) libraries for vectorizing intrinsics using external libraries.
24256 GCC currently emits calls to @code{acosd2}, @code{acosf4},
24257 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
24258 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
24259 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
24260 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
24261 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
24262 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
24263 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
24264 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
24265 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
24266 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
24267 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
24268 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
24269 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
24270 for power7.  Both @option{-ftree-vectorize} and
24271 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
24272 libraries must be specified at link time.
24274 @item -mfriz
24275 @itemx -mno-friz
24276 @opindex mfriz
24277 Generate (do not generate) the @code{friz} instruction when the
24278 @option{-funsafe-math-optimizations} option is used to optimize
24279 rounding of floating-point values to 64-bit integer and back to floating
24280 point.  The @code{friz} instruction does not return the same value if
24281 the floating-point number is too large to fit in an integer.
24283 @item -mpointers-to-nested-functions
24284 @itemx -mno-pointers-to-nested-functions
24285 @opindex mpointers-to-nested-functions
24286 Generate (do not generate) code to load up the static chain register
24287 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
24288 systems where a function pointer points to a 3-word descriptor giving
24289 the function address, TOC value to be loaded in register @code{r2}, and
24290 static chain value to be loaded in register @code{r11}.  The
24291 @option{-mpointers-to-nested-functions} is on by default.  You cannot
24292 call through pointers to nested functions or pointers
24293 to functions compiled in other languages that use the static chain if
24294 you use @option{-mno-pointers-to-nested-functions}.
24296 @item -msave-toc-indirect
24297 @itemx -mno-save-toc-indirect
24298 @opindex msave-toc-indirect
24299 Generate (do not generate) code to save the TOC value in the reserved
24300 stack location in the function prologue if the function calls through
24301 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
24302 saved in the prologue, it is saved just before the call through the
24303 pointer.  The @option{-mno-save-toc-indirect} option is the default.
24305 @item -mcompat-align-parm
24306 @itemx -mno-compat-align-parm
24307 @opindex mcompat-align-parm
24308 Generate (do not generate) code to pass structure parameters with a
24309 maximum alignment of 64 bits, for compatibility with older versions
24310 of GCC.
24312 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
24313 structure parameter on a 128-bit boundary when that structure contained
24314 a member requiring 128-bit alignment.  This is corrected in more
24315 recent versions of GCC.  This option may be used to generate code
24316 that is compatible with functions compiled with older versions of
24317 GCC.
24319 The @option{-mno-compat-align-parm} option is the default.
24321 @item -mstack-protector-guard=@var{guard}
24322 @itemx -mstack-protector-guard-reg=@var{reg}
24323 @itemx -mstack-protector-guard-offset=@var{offset}
24324 @itemx -mstack-protector-guard-symbol=@var{symbol}
24325 @opindex mstack-protector-guard
24326 @opindex mstack-protector-guard-reg
24327 @opindex mstack-protector-guard-offset
24328 @opindex mstack-protector-guard-symbol
24329 Generate stack protection code using canary at @var{guard}.  Supported
24330 locations are @samp{global} for global canary or @samp{tls} for per-thread
24331 canary in the TLS block (the default with GNU libc version 2.4 or later).
24333 With the latter choice the options
24334 @option{-mstack-protector-guard-reg=@var{reg}} and
24335 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
24336 which register to use as base register for reading the canary, and from what
24337 offset from that base register. The default for those is as specified in the
24338 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
24339 the offset with a symbol reference to a canary in the TLS block.
24340 @end table
24342 @node RX Options
24343 @subsection RX Options
24344 @cindex RX Options
24346 These command-line options are defined for RX targets:
24348 @table @gcctabopt
24349 @item -m64bit-doubles
24350 @itemx -m32bit-doubles
24351 @opindex m64bit-doubles
24352 @opindex m32bit-doubles
24353 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
24354 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
24355 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
24356 works on 32-bit values, which is why the default is
24357 @option{-m32bit-doubles}.
24359 @item -fpu
24360 @itemx -nofpu
24361 @opindex fpu
24362 @opindex nofpu
24363 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
24364 floating-point hardware.  The default is enabled for the RX600
24365 series and disabled for the RX200 series.
24367 Floating-point instructions are only generated for 32-bit floating-point 
24368 values, however, so the FPU hardware is not used for doubles if the
24369 @option{-m64bit-doubles} option is used.
24371 @emph{Note} If the @option{-fpu} option is enabled then
24372 @option{-funsafe-math-optimizations} is also enabled automatically.
24373 This is because the RX FPU instructions are themselves unsafe.
24375 @item -mcpu=@var{name}
24376 @opindex mcpu
24377 Selects the type of RX CPU to be targeted.  Currently three types are
24378 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
24379 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
24381 The only difference between @samp{RX600} and @samp{RX610} is that the
24382 @samp{RX610} does not support the @code{MVTIPL} instruction.
24384 The @samp{RX200} series does not have a hardware floating-point unit
24385 and so @option{-nofpu} is enabled by default when this type is
24386 selected.
24388 @item -mbig-endian-data
24389 @itemx -mlittle-endian-data
24390 @opindex mbig-endian-data
24391 @opindex mlittle-endian-data
24392 Store data (but not code) in the big-endian format.  The default is
24393 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
24394 format.
24396 @item -msmall-data-limit=@var{N}
24397 @opindex msmall-data-limit
24398 Specifies the maximum size in bytes of global and static variables
24399 which can be placed into the small data area.  Using the small data
24400 area can lead to smaller and faster code, but the size of area is
24401 limited and it is up to the programmer to ensure that the area does
24402 not overflow.  Also when the small data area is used one of the RX's
24403 registers (usually @code{r13}) is reserved for use pointing to this
24404 area, so it is no longer available for use by the compiler.  This
24405 could result in slower and/or larger code if variables are pushed onto
24406 the stack instead of being held in this register.
24408 Note, common variables (variables that have not been initialized) and
24409 constants are not placed into the small data area as they are assigned
24410 to other sections in the output executable.
24412 The default value is zero, which disables this feature.  Note, this
24413 feature is not enabled by default with higher optimization levels
24414 (@option{-O2} etc) because of the potentially detrimental effects of
24415 reserving a register.  It is up to the programmer to experiment and
24416 discover whether this feature is of benefit to their program.  See the
24417 description of the @option{-mpid} option for a description of how the
24418 actual register to hold the small data area pointer is chosen.
24420 @item -msim
24421 @itemx -mno-sim
24422 @opindex msim
24423 @opindex mno-sim
24424 Use the simulator runtime.  The default is to use the libgloss
24425 board-specific runtime.
24427 @item -mas100-syntax
24428 @itemx -mno-as100-syntax
24429 @opindex mas100-syntax
24430 @opindex mno-as100-syntax
24431 When generating assembler output use a syntax that is compatible with
24432 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
24433 assembler, but it has some restrictions so it is not generated by default.
24435 @item -mmax-constant-size=@var{N}
24436 @opindex mmax-constant-size
24437 Specifies the maximum size, in bytes, of a constant that can be used as
24438 an operand in a RX instruction.  Although the RX instruction set does
24439 allow constants of up to 4 bytes in length to be used in instructions,
24440 a longer value equates to a longer instruction.  Thus in some
24441 circumstances it can be beneficial to restrict the size of constants
24442 that are used in instructions.  Constants that are too big are instead
24443 placed into a constant pool and referenced via register indirection.
24445 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
24446 or 4 means that constants of any size are allowed.
24448 @item -mrelax
24449 @opindex mrelax
24450 Enable linker relaxation.  Linker relaxation is a process whereby the
24451 linker attempts to reduce the size of a program by finding shorter
24452 versions of various instructions.  Disabled by default.
24454 @item -mint-register=@var{N}
24455 @opindex mint-register
24456 Specify the number of registers to reserve for fast interrupt handler
24457 functions.  The value @var{N} can be between 0 and 4.  A value of 1
24458 means that register @code{r13} is reserved for the exclusive use
24459 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
24460 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
24461 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
24462 A value of 0, the default, does not reserve any registers.
24464 @item -msave-acc-in-interrupts
24465 @opindex msave-acc-in-interrupts
24466 Specifies that interrupt handler functions should preserve the
24467 accumulator register.  This is only necessary if normal code might use
24468 the accumulator register, for example because it performs 64-bit
24469 multiplications.  The default is to ignore the accumulator as this
24470 makes the interrupt handlers faster.
24472 @item -mpid
24473 @itemx -mno-pid
24474 @opindex mpid
24475 @opindex mno-pid
24476 Enables the generation of position independent data.  When enabled any
24477 access to constant data is done via an offset from a base address
24478 held in a register.  This allows the location of constant data to be
24479 determined at run time without requiring the executable to be
24480 relocated, which is a benefit to embedded applications with tight
24481 memory constraints.  Data that can be modified is not affected by this
24482 option.
24484 Note, using this feature reserves a register, usually @code{r13}, for
24485 the constant data base address.  This can result in slower and/or
24486 larger code, especially in complicated functions.
24488 The actual register chosen to hold the constant data base address
24489 depends upon whether the @option{-msmall-data-limit} and/or the
24490 @option{-mint-register} command-line options are enabled.  Starting
24491 with register @code{r13} and proceeding downwards, registers are
24492 allocated first to satisfy the requirements of @option{-mint-register},
24493 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
24494 is possible for the small data area register to be @code{r8} if both
24495 @option{-mint-register=4} and @option{-mpid} are specified on the
24496 command line.
24498 By default this feature is not enabled.  The default can be restored
24499 via the @option{-mno-pid} command-line option.
24501 @item -mno-warn-multiple-fast-interrupts
24502 @itemx -mwarn-multiple-fast-interrupts
24503 @opindex mno-warn-multiple-fast-interrupts
24504 @opindex mwarn-multiple-fast-interrupts
24505 Prevents GCC from issuing a warning message if it finds more than one
24506 fast interrupt handler when it is compiling a file.  The default is to
24507 issue a warning for each extra fast interrupt handler found, as the RX
24508 only supports one such interrupt.
24510 @item -mallow-string-insns
24511 @itemx -mno-allow-string-insns
24512 @opindex mallow-string-insns
24513 @opindex mno-allow-string-insns
24514 Enables or disables the use of the string manipulation instructions
24515 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
24516 @code{SWHILE} and also the @code{RMPA} instruction.  These
24517 instructions may prefetch data, which is not safe to do if accessing
24518 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
24519 for more information).
24521 The default is to allow these instructions, but it is not possible for
24522 GCC to reliably detect all circumstances where a string instruction
24523 might be used to access an I/O register, so their use cannot be
24524 disabled automatically.  Instead it is reliant upon the programmer to
24525 use the @option{-mno-allow-string-insns} option if their program
24526 accesses I/O space.
24528 When the instructions are enabled GCC defines the C preprocessor
24529 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
24530 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
24532 @item -mjsr
24533 @itemx -mno-jsr
24534 @opindex mjsr
24535 @opindex mno-jsr
24536 Use only (or not only) @code{JSR} instructions to access functions.
24537 This option can be used when code size exceeds the range of @code{BSR}
24538 instructions.  Note that @option{-mno-jsr} does not mean to not use
24539 @code{JSR} but instead means that any type of branch may be used.
24540 @end table
24542 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
24543 has special significance to the RX port when used with the
24544 @code{interrupt} function attribute.  This attribute indicates a
24545 function intended to process fast interrupts.  GCC ensures
24546 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
24547 and/or @code{r13} and only provided that the normal use of the
24548 corresponding registers have been restricted via the
24549 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
24550 options.
24552 @node S/390 and zSeries Options
24553 @subsection S/390 and zSeries Options
24554 @cindex S/390 and zSeries Options
24556 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
24558 @table @gcctabopt
24559 @item -mhard-float
24560 @itemx -msoft-float
24561 @opindex mhard-float
24562 @opindex msoft-float
24563 Use (do not use) the hardware floating-point instructions and registers
24564 for floating-point operations.  When @option{-msoft-float} is specified,
24565 functions in @file{libgcc.a} are used to perform floating-point
24566 operations.  When @option{-mhard-float} is specified, the compiler
24567 generates IEEE floating-point instructions.  This is the default.
24569 @item -mhard-dfp
24570 @itemx -mno-hard-dfp
24571 @opindex mhard-dfp
24572 @opindex mno-hard-dfp
24573 Use (do not use) the hardware decimal-floating-point instructions for
24574 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
24575 specified, functions in @file{libgcc.a} are used to perform
24576 decimal-floating-point operations.  When @option{-mhard-dfp} is
24577 specified, the compiler generates decimal-floating-point hardware
24578 instructions.  This is the default for @option{-march=z9-ec} or higher.
24580 @item -mlong-double-64
24581 @itemx -mlong-double-128
24582 @opindex mlong-double-64
24583 @opindex mlong-double-128
24584 These switches control the size of @code{long double} type. A size
24585 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24586 type. This is the default.
24588 @item -mbackchain
24589 @itemx -mno-backchain
24590 @opindex mbackchain
24591 @opindex mno-backchain
24592 Store (do not store) the address of the caller's frame as backchain pointer
24593 into the callee's stack frame.
24594 A backchain may be needed to allow debugging using tools that do not understand
24595 DWARF call frame information.
24596 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
24597 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
24598 the backchain is placed into the topmost word of the 96/160 byte register
24599 save area.
24601 In general, code compiled with @option{-mbackchain} is call-compatible with
24602 code compiled with @option{-mmo-backchain}; however, use of the backchain
24603 for debugging purposes usually requires that the whole binary is built with
24604 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
24605 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24606 to build a linux kernel use @option{-msoft-float}.
24608 The default is to not maintain the backchain.
24610 @item -mpacked-stack
24611 @itemx -mno-packed-stack
24612 @opindex mpacked-stack
24613 @opindex mno-packed-stack
24614 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
24615 specified, the compiler uses the all fields of the 96/160 byte register save
24616 area only for their default purpose; unused fields still take up stack space.
24617 When @option{-mpacked-stack} is specified, register save slots are densely
24618 packed at the top of the register save area; unused space is reused for other
24619 purposes, allowing for more efficient use of the available stack space.
24620 However, when @option{-mbackchain} is also in effect, the topmost word of
24621 the save area is always used to store the backchain, and the return address
24622 register is always saved two words below the backchain.
24624 As long as the stack frame backchain is not used, code generated with
24625 @option{-mpacked-stack} is call-compatible with code generated with
24626 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
24627 S/390 or zSeries generated code that uses the stack frame backchain at run
24628 time, not just for debugging purposes.  Such code is not call-compatible
24629 with code compiled with @option{-mpacked-stack}.  Also, note that the
24630 combination of @option{-mbackchain},
24631 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24632 to build a linux kernel use @option{-msoft-float}.
24634 The default is to not use the packed stack layout.
24636 @item -msmall-exec
24637 @itemx -mno-small-exec
24638 @opindex msmall-exec
24639 @opindex mno-small-exec
24640 Generate (or do not generate) code using the @code{bras} instruction
24641 to do subroutine calls.
24642 This only works reliably if the total executable size does not
24643 exceed 64k.  The default is to use the @code{basr} instruction instead,
24644 which does not have this limitation.
24646 @item -m64
24647 @itemx -m31
24648 @opindex m64
24649 @opindex m31
24650 When @option{-m31} is specified, generate code compliant to the
24651 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
24652 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
24653 particular to generate 64-bit instructions.  For the @samp{s390}
24654 targets, the default is @option{-m31}, while the @samp{s390x}
24655 targets default to @option{-m64}.
24657 @item -mzarch
24658 @itemx -mesa
24659 @opindex mzarch
24660 @opindex mesa
24661 When @option{-mzarch} is specified, generate code using the
24662 instructions available on z/Architecture.
24663 When @option{-mesa} is specified, generate code using the
24664 instructions available on ESA/390.  Note that @option{-mesa} is
24665 not possible with @option{-m64}.
24666 When generating code compliant to the GNU/Linux for S/390 ABI,
24667 the default is @option{-mesa}.  When generating code compliant
24668 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
24670 @item -mhtm
24671 @itemx -mno-htm
24672 @opindex mhtm
24673 @opindex mno-htm
24674 The @option{-mhtm} option enables a set of builtins making use of
24675 instructions available with the transactional execution facility
24676 introduced with the IBM zEnterprise EC12 machine generation
24677 @ref{S/390 System z Built-in Functions}.
24678 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
24680 @item -mvx
24681 @itemx -mno-vx
24682 @opindex mvx
24683 @opindex mno-vx
24684 When @option{-mvx} is specified, generate code using the instructions
24685 available with the vector extension facility introduced with the IBM
24686 z13 machine generation.
24687 This option changes the ABI for some vector type values with regard to
24688 alignment and calling conventions.  In case vector type values are
24689 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
24690 command will be added to mark the resulting binary with the ABI used.
24691 @option{-mvx} is enabled by default when using @option{-march=z13}.
24693 @item -mzvector
24694 @itemx -mno-zvector
24695 @opindex mzvector
24696 @opindex mno-zvector
24697 The @option{-mzvector} option enables vector language extensions and
24698 builtins using instructions available with the vector extension
24699 facility introduced with the IBM z13 machine generation.
24700 This option adds support for @samp{vector} to be used as a keyword to
24701 define vector type variables and arguments.  @samp{vector} is only
24702 available when GNU extensions are enabled.  It will not be expanded
24703 when requesting strict standard compliance e.g. with @option{-std=c99}.
24704 In addition to the GCC low-level builtins @option{-mzvector} enables
24705 a set of builtins added for compatibility with AltiVec-style
24706 implementations like Power and Cell.  In order to make use of these
24707 builtins the header file @file{vecintrin.h} needs to be included.
24708 @option{-mzvector} is disabled by default.
24710 @item -mmvcle
24711 @itemx -mno-mvcle
24712 @opindex mmvcle
24713 @opindex mno-mvcle
24714 Generate (or do not generate) code using the @code{mvcle} instruction
24715 to perform block moves.  When @option{-mno-mvcle} is specified,
24716 use a @code{mvc} loop instead.  This is the default unless optimizing for
24717 size.
24719 @item -mdebug
24720 @itemx -mno-debug
24721 @opindex mdebug
24722 @opindex mno-debug
24723 Print (or do not print) additional debug information when compiling.
24724 The default is to not print debug information.
24726 @item -march=@var{cpu-type}
24727 @opindex march
24728 Generate code that runs on @var{cpu-type}, which is the name of a
24729 system representing a certain processor type.  Possible values for
24730 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
24731 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
24732 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
24733 @samp{native}.
24735 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
24736 @samp{g6} are deprecated and will be removed with future releases.
24738 Specifying @samp{native} as cpu type can be used to select the best
24739 architecture option for the host processor.
24740 @option{-march=native} has no effect if GCC does not recognize the
24741 processor.
24743 @item -mtune=@var{cpu-type}
24744 @opindex mtune
24745 Tune to @var{cpu-type} everything applicable about the generated code,
24746 except for the ABI and the set of available instructions.
24747 The list of @var{cpu-type} values is the same as for @option{-march}.
24748 The default is the value used for @option{-march}.
24750 @item -mtpf-trace
24751 @itemx -mno-tpf-trace
24752 @opindex mtpf-trace
24753 @opindex mno-tpf-trace
24754 Generate code that adds (does not add) in TPF OS specific branches to trace
24755 routines in the operating system.  This option is off by default, even
24756 when compiling for the TPF OS@.
24758 @item -mfused-madd
24759 @itemx -mno-fused-madd
24760 @opindex mfused-madd
24761 @opindex mno-fused-madd
24762 Generate code that uses (does not use) the floating-point multiply and
24763 accumulate instructions.  These instructions are generated by default if
24764 hardware floating point is used.
24766 @item -mwarn-framesize=@var{framesize}
24767 @opindex mwarn-framesize
24768 Emit a warning if the current function exceeds the given frame size.  Because
24769 this is a compile-time check it doesn't need to be a real problem when the program
24770 runs.  It is intended to identify functions that most probably cause
24771 a stack overflow.  It is useful to be used in an environment with limited stack
24772 size e.g.@: the linux kernel.
24774 @item -mwarn-dynamicstack
24775 @opindex mwarn-dynamicstack
24776 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
24777 arrays.  This is generally a bad idea with a limited stack size.
24779 @item -mstack-guard=@var{stack-guard}
24780 @itemx -mstack-size=@var{stack-size}
24781 @opindex mstack-guard
24782 @opindex mstack-size
24783 If these options are provided the S/390 back end emits additional instructions in
24784 the function prologue that trigger a trap if the stack size is @var{stack-guard}
24785 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
24786 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
24787 the frame size of the compiled function is chosen.
24788 These options are intended to be used to help debugging stack overflow problems.
24789 The additionally emitted code causes only little overhead and hence can also be
24790 used in production-like systems without greater performance degradation.  The given
24791 values have to be exact powers of 2 and @var{stack-size} has to be greater than
24792 @var{stack-guard} without exceeding 64k.
24793 In order to be efficient the extra code makes the assumption that the stack starts
24794 at an address aligned to the value given by @var{stack-size}.
24795 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
24797 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
24798 @opindex mhotpatch
24799 If the hotpatch option is enabled, a ``hot-patching'' function
24800 prologue is generated for all functions in the compilation unit.
24801 The funtion label is prepended with the given number of two-byte
24802 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
24803 the label, 2 * @var{post-halfwords} bytes are appended, using the
24804 largest NOP like instructions the architecture allows (maximum
24805 1000000).
24807 If both arguments are zero, hotpatching is disabled.
24809 This option can be overridden for individual functions with the
24810 @code{hotpatch} attribute.
24811 @end table
24813 @node Score Options
24814 @subsection Score Options
24815 @cindex Score Options
24817 These options are defined for Score implementations:
24819 @table @gcctabopt
24820 @item -meb
24821 @opindex meb
24822 Compile code for big-endian mode.  This is the default.
24824 @item -mel
24825 @opindex mel
24826 Compile code for little-endian mode.
24828 @item -mnhwloop
24829 @opindex mnhwloop
24830 Disable generation of @code{bcnz} instructions.
24832 @item -muls
24833 @opindex muls
24834 Enable generation of unaligned load and store instructions.
24836 @item -mmac
24837 @opindex mmac
24838 Enable the use of multiply-accumulate instructions. Disabled by default.
24840 @item -mscore5
24841 @opindex mscore5
24842 Specify the SCORE5 as the target architecture.
24844 @item -mscore5u
24845 @opindex mscore5u
24846 Specify the SCORE5U of the target architecture.
24848 @item -mscore7
24849 @opindex mscore7
24850 Specify the SCORE7 as the target architecture. This is the default.
24852 @item -mscore7d
24853 @opindex mscore7d
24854 Specify the SCORE7D as the target architecture.
24855 @end table
24857 @node SH Options
24858 @subsection SH Options
24860 These @samp{-m} options are defined for the SH implementations:
24862 @table @gcctabopt
24863 @item -m1
24864 @opindex m1
24865 Generate code for the SH1.
24867 @item -m2
24868 @opindex m2
24869 Generate code for the SH2.
24871 @item -m2e
24872 Generate code for the SH2e.
24874 @item -m2a-nofpu
24875 @opindex m2a-nofpu
24876 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
24877 that the floating-point unit is not used.
24879 @item -m2a-single-only
24880 @opindex m2a-single-only
24881 Generate code for the SH2a-FPU, in such a way that no double-precision
24882 floating-point operations are used.
24884 @item -m2a-single
24885 @opindex m2a-single
24886 Generate code for the SH2a-FPU assuming the floating-point unit is in
24887 single-precision mode by default.
24889 @item -m2a
24890 @opindex m2a
24891 Generate code for the SH2a-FPU assuming the floating-point unit is in
24892 double-precision mode by default.
24894 @item -m3
24895 @opindex m3
24896 Generate code for the SH3.
24898 @item -m3e
24899 @opindex m3e
24900 Generate code for the SH3e.
24902 @item -m4-nofpu
24903 @opindex m4-nofpu
24904 Generate code for the SH4 without a floating-point unit.
24906 @item -m4-single-only
24907 @opindex m4-single-only
24908 Generate code for the SH4 with a floating-point unit that only
24909 supports single-precision arithmetic.
24911 @item -m4-single
24912 @opindex m4-single
24913 Generate code for the SH4 assuming the floating-point unit is in
24914 single-precision mode by default.
24916 @item -m4
24917 @opindex m4
24918 Generate code for the SH4.
24920 @item -m4-100
24921 @opindex m4-100
24922 Generate code for SH4-100.
24924 @item -m4-100-nofpu
24925 @opindex m4-100-nofpu
24926 Generate code for SH4-100 in such a way that the
24927 floating-point unit is not used.
24929 @item -m4-100-single
24930 @opindex m4-100-single
24931 Generate code for SH4-100 assuming the floating-point unit is in
24932 single-precision mode by default.
24934 @item -m4-100-single-only
24935 @opindex m4-100-single-only
24936 Generate code for SH4-100 in such a way that no double-precision
24937 floating-point operations are used.
24939 @item -m4-200
24940 @opindex m4-200
24941 Generate code for SH4-200.
24943 @item -m4-200-nofpu
24944 @opindex m4-200-nofpu
24945 Generate code for SH4-200 without in such a way that the
24946 floating-point unit is not used.
24948 @item -m4-200-single
24949 @opindex m4-200-single
24950 Generate code for SH4-200 assuming the floating-point unit is in
24951 single-precision mode by default.
24953 @item -m4-200-single-only
24954 @opindex m4-200-single-only
24955 Generate code for SH4-200 in such a way that no double-precision
24956 floating-point operations are used.
24958 @item -m4-300
24959 @opindex m4-300
24960 Generate code for SH4-300.
24962 @item -m4-300-nofpu
24963 @opindex m4-300-nofpu
24964 Generate code for SH4-300 without in such a way that the
24965 floating-point unit is not used.
24967 @item -m4-300-single
24968 @opindex m4-300-single
24969 Generate code for SH4-300 in such a way that no double-precision
24970 floating-point operations are used.
24972 @item -m4-300-single-only
24973 @opindex m4-300-single-only
24974 Generate code for SH4-300 in such a way that no double-precision
24975 floating-point operations are used.
24977 @item -m4-340
24978 @opindex m4-340
24979 Generate code for SH4-340 (no MMU, no FPU).
24981 @item -m4-500
24982 @opindex m4-500
24983 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
24984 assembler.
24986 @item -m4a-nofpu
24987 @opindex m4a-nofpu
24988 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
24989 floating-point unit is not used.
24991 @item -m4a-single-only
24992 @opindex m4a-single-only
24993 Generate code for the SH4a, in such a way that no double-precision
24994 floating-point operations are used.
24996 @item -m4a-single
24997 @opindex m4a-single
24998 Generate code for the SH4a assuming the floating-point unit is in
24999 single-precision mode by default.
25001 @item -m4a
25002 @opindex m4a
25003 Generate code for the SH4a.
25005 @item -m4al
25006 @opindex m4al
25007 Same as @option{-m4a-nofpu}, except that it implicitly passes
25008 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
25009 instructions at the moment.
25011 @item -mb
25012 @opindex mb
25013 Compile code for the processor in big-endian mode.
25015 @item -ml
25016 @opindex ml
25017 Compile code for the processor in little-endian mode.
25019 @item -mdalign
25020 @opindex mdalign
25021 Align doubles at 64-bit boundaries.  Note that this changes the calling
25022 conventions, and thus some functions from the standard C library do
25023 not work unless you recompile it first with @option{-mdalign}.
25025 @item -mrelax
25026 @opindex mrelax
25027 Shorten some address references at link time, when possible; uses the
25028 linker option @option{-relax}.
25030 @item -mbigtable
25031 @opindex mbigtable
25032 Use 32-bit offsets in @code{switch} tables.  The default is to use
25033 16-bit offsets.
25035 @item -mbitops
25036 @opindex mbitops
25037 Enable the use of bit manipulation instructions on SH2A.
25039 @item -mfmovd
25040 @opindex mfmovd
25041 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
25042 alignment constraints.
25044 @item -mrenesas
25045 @opindex mrenesas
25046 Comply with the calling conventions defined by Renesas.
25048 @item -mno-renesas
25049 @opindex mno-renesas
25050 Comply with the calling conventions defined for GCC before the Renesas
25051 conventions were available.  This option is the default for all
25052 targets of the SH toolchain.
25054 @item -mnomacsave
25055 @opindex mnomacsave
25056 Mark the @code{MAC} register as call-clobbered, even if
25057 @option{-mrenesas} is given.
25059 @item -mieee
25060 @itemx -mno-ieee
25061 @opindex mieee
25062 @opindex mno-ieee
25063 Control the IEEE compliance of floating-point comparisons, which affects the
25064 handling of cases where the result of a comparison is unordered.  By default
25065 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
25066 enabled @option{-mno-ieee} is implicitly set, which results in faster
25067 floating-point greater-equal and less-equal comparisons.  The implicit settings
25068 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
25070 @item -minline-ic_invalidate
25071 @opindex minline-ic_invalidate
25072 Inline code to invalidate instruction cache entries after setting up
25073 nested function trampolines.
25074 This option has no effect if @option{-musermode} is in effect and the selected
25075 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
25076 instruction.
25077 If the selected code generation option does not allow the use of the @code{icbi}
25078 instruction, and @option{-musermode} is not in effect, the inlined code
25079 manipulates the instruction cache address array directly with an associative
25080 write.  This not only requires privileged mode at run time, but it also
25081 fails if the cache line had been mapped via the TLB and has become unmapped.
25083 @item -misize
25084 @opindex misize
25085 Dump instruction size and location in the assembly code.
25087 @item -mpadstruct
25088 @opindex mpadstruct
25089 This option is deprecated.  It pads structures to multiple of 4 bytes,
25090 which is incompatible with the SH ABI@.
25092 @item -matomic-model=@var{model}
25093 @opindex matomic-model=@var{model}
25094 Sets the model of atomic operations and additional parameters as a comma
25095 separated list.  For details on the atomic built-in functions see
25096 @ref{__atomic Builtins}.  The following models and parameters are supported:
25098 @table @samp
25100 @item none
25101 Disable compiler generated atomic sequences and emit library calls for atomic
25102 operations.  This is the default if the target is not @code{sh*-*-linux*}.
25104 @item soft-gusa
25105 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
25106 built-in functions.  The generated atomic sequences require additional support
25107 from the interrupt/exception handling code of the system and are only suitable
25108 for SH3* and SH4* single-core systems.  This option is enabled by default when
25109 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
25110 this option also partially utilizes the hardware atomic instructions
25111 @code{movli.l} and @code{movco.l} to create more efficient code, unless
25112 @samp{strict} is specified.  
25114 @item soft-tcb
25115 Generate software atomic sequences that use a variable in the thread control
25116 block.  This is a variation of the gUSA sequences which can also be used on
25117 SH1* and SH2* targets.  The generated atomic sequences require additional
25118 support from the interrupt/exception handling code of the system and are only
25119 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
25120 parameter has to be specified as well.
25122 @item soft-imask
25123 Generate software atomic sequences that temporarily disable interrupts by
25124 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
25125 in privileged mode and is only suitable for single-core systems.  Additional
25126 support from the interrupt/exception handling code of the system is not
25127 required.  This model is enabled by default when the target is
25128 @code{sh*-*-linux*} and SH1* or SH2*.
25130 @item hard-llcs
25131 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
25132 instructions only.  This is only available on SH4A and is suitable for
25133 multi-core systems.  Since the hardware instructions support only 32 bit atomic
25134 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
25135 Code compiled with this option is also compatible with other software
25136 atomic model interrupt/exception handling systems if executed on an SH4A
25137 system.  Additional support from the interrupt/exception handling code of the
25138 system is not required for this model.
25140 @item gbr-offset=
25141 This parameter specifies the offset in bytes of the variable in the thread
25142 control block structure that should be used by the generated atomic sequences
25143 when the @samp{soft-tcb} model has been selected.  For other models this
25144 parameter is ignored.  The specified value must be an integer multiple of four
25145 and in the range 0-1020.
25147 @item strict
25148 This parameter prevents mixed usage of multiple atomic models, even if they
25149 are compatible, and makes the compiler generate atomic sequences of the
25150 specified model only.
25152 @end table
25154 @item -mtas
25155 @opindex mtas
25156 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
25157 Notice that depending on the particular hardware and software configuration
25158 this can degrade overall performance due to the operand cache line flushes
25159 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
25160 processors the @code{tas.b} instruction must be used with caution since it
25161 can result in data corruption for certain cache configurations.
25163 @item -mprefergot
25164 @opindex mprefergot
25165 When generating position-independent code, emit function calls using
25166 the Global Offset Table instead of the Procedure Linkage Table.
25168 @item -musermode
25169 @itemx -mno-usermode
25170 @opindex musermode
25171 @opindex mno-usermode
25172 Don't allow (allow) the compiler generating privileged mode code.  Specifying
25173 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
25174 inlined code would not work in user mode.  @option{-musermode} is the default
25175 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
25176 @option{-musermode} has no effect, since there is no user mode.
25178 @item -multcost=@var{number}
25179 @opindex multcost=@var{number}
25180 Set the cost to assume for a multiply insn.
25182 @item -mdiv=@var{strategy}
25183 @opindex mdiv=@var{strategy}
25184 Set the division strategy to be used for integer division operations.
25185 @var{strategy} can be one of: 
25187 @table @samp
25189 @item call-div1
25190 Calls a library function that uses the single-step division instruction
25191 @code{div1} to perform the operation.  Division by zero calculates an
25192 unspecified result and does not trap.  This is the default except for SH4,
25193 SH2A and SHcompact.
25195 @item call-fp
25196 Calls a library function that performs the operation in double precision
25197 floating point.  Division by zero causes a floating-point exception.  This is
25198 the default for SHcompact with FPU.  Specifying this for targets that do not
25199 have a double precision FPU defaults to @code{call-div1}.
25201 @item call-table
25202 Calls a library function that uses a lookup table for small divisors and
25203 the @code{div1} instruction with case distinction for larger divisors.  Division
25204 by zero calculates an unspecified result and does not trap.  This is the default
25205 for SH4.  Specifying this for targets that do not have dynamic shift
25206 instructions defaults to @code{call-div1}.
25208 @end table
25210 When a division strategy has not been specified the default strategy is
25211 selected based on the current target.  For SH2A the default strategy is to
25212 use the @code{divs} and @code{divu} instructions instead of library function
25213 calls.
25215 @item -maccumulate-outgoing-args
25216 @opindex maccumulate-outgoing-args
25217 Reserve space once for outgoing arguments in the function prologue rather
25218 than around each call.  Generally beneficial for performance and size.  Also
25219 needed for unwinding to avoid changing the stack frame around conditional code.
25221 @item -mdivsi3_libfunc=@var{name}
25222 @opindex mdivsi3_libfunc=@var{name}
25223 Set the name of the library function used for 32-bit signed division to
25224 @var{name}.
25225 This only affects the name used in the @samp{call} division strategies, and
25226 the compiler still expects the same sets of input/output/clobbered registers as
25227 if this option were not present.
25229 @item -mfixed-range=@var{register-range}
25230 @opindex mfixed-range
25231 Generate code treating the given register range as fixed registers.
25232 A fixed register is one that the register allocator can not use.  This is
25233 useful when compiling kernel code.  A register range is specified as
25234 two registers separated by a dash.  Multiple register ranges can be
25235 specified separated by a comma.
25237 @item -mbranch-cost=@var{num}
25238 @opindex mbranch-cost=@var{num}
25239 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
25240 make the compiler try to generate more branch-free code if possible.  
25241 If not specified the value is selected depending on the processor type that
25242 is being compiled for.
25244 @item -mzdcbranch
25245 @itemx -mno-zdcbranch
25246 @opindex mzdcbranch
25247 @opindex mno-zdcbranch
25248 Assume (do not assume) that zero displacement conditional branch instructions
25249 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
25250 compiler prefers zero displacement branch code sequences.  This is
25251 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
25252 disabled by specifying @option{-mno-zdcbranch}.
25254 @item -mcbranch-force-delay-slot
25255 @opindex mcbranch-force-delay-slot
25256 Force the usage of delay slots for conditional branches, which stuffs the delay
25257 slot with a @code{nop} if a suitable instruction cannot be found.  By default
25258 this option is disabled.  It can be enabled to work around hardware bugs as
25259 found in the original SH7055.
25261 @item -mfused-madd
25262 @itemx -mno-fused-madd
25263 @opindex mfused-madd
25264 @opindex mno-fused-madd
25265 Generate code that uses (does not use) the floating-point multiply and
25266 accumulate instructions.  These instructions are generated by default
25267 if hardware floating point is used.  The machine-dependent
25268 @option{-mfused-madd} option is now mapped to the machine-independent
25269 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
25270 mapped to @option{-ffp-contract=off}.
25272 @item -mfsca
25273 @itemx -mno-fsca
25274 @opindex mfsca
25275 @opindex mno-fsca
25276 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
25277 and cosine approximations.  The option @option{-mfsca} must be used in
25278 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
25279 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
25280 approximations even if @option{-funsafe-math-optimizations} is in effect.
25282 @item -mfsrra
25283 @itemx -mno-fsrra
25284 @opindex mfsrra
25285 @opindex mno-fsrra
25286 Allow or disallow the compiler to emit the @code{fsrra} instruction for
25287 reciprocal square root approximations.  The option @option{-mfsrra} must be used
25288 in combination with @option{-funsafe-math-optimizations} and
25289 @option{-ffinite-math-only}.  It is enabled by default when generating code for
25290 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
25291 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
25292 in effect.
25294 @item -mpretend-cmove
25295 @opindex mpretend-cmove
25296 Prefer zero-displacement conditional branches for conditional move instruction
25297 patterns.  This can result in faster code on the SH4 processor.
25299 @item -mfdpic
25300 @opindex fdpic
25301 Generate code using the FDPIC ABI.
25303 @end table
25305 @node Solaris 2 Options
25306 @subsection Solaris 2 Options
25307 @cindex Solaris 2 options
25309 These @samp{-m} options are supported on Solaris 2:
25311 @table @gcctabopt
25312 @item -mclear-hwcap
25313 @opindex mclear-hwcap
25314 @option{-mclear-hwcap} tells the compiler to remove the hardware
25315 capabilities generated by the Solaris assembler.  This is only necessary
25316 when object files use ISA extensions not supported by the current
25317 machine, but check at runtime whether or not to use them.
25319 @item -mimpure-text
25320 @opindex mimpure-text
25321 @option{-mimpure-text}, used in addition to @option{-shared}, tells
25322 the compiler to not pass @option{-z text} to the linker when linking a
25323 shared object.  Using this option, you can link position-dependent
25324 code into a shared object.
25326 @option{-mimpure-text} suppresses the ``relocations remain against
25327 allocatable but non-writable sections'' linker error message.
25328 However, the necessary relocations trigger copy-on-write, and the
25329 shared object is not actually shared across processes.  Instead of
25330 using @option{-mimpure-text}, you should compile all source code with
25331 @option{-fpic} or @option{-fPIC}.
25333 @end table
25335 These switches are supported in addition to the above on Solaris 2:
25337 @table @gcctabopt
25338 @item -pthreads
25339 @opindex pthreads
25340 This is a synonym for @option{-pthread}.
25341 @end table
25343 @node SPARC Options
25344 @subsection SPARC Options
25345 @cindex SPARC options
25347 These @samp{-m} options are supported on the SPARC:
25349 @table @gcctabopt
25350 @item -mno-app-regs
25351 @itemx -mapp-regs
25352 @opindex mno-app-regs
25353 @opindex mapp-regs
25354 Specify @option{-mapp-regs} to generate output using the global registers
25355 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
25356 global register 1, each global register 2 through 4 is then treated as an
25357 allocable register that is clobbered by function calls.  This is the default.
25359 To be fully SVR4 ABI-compliant at the cost of some performance loss,
25360 specify @option{-mno-app-regs}.  You should compile libraries and system
25361 software with this option.
25363 @item -mflat
25364 @itemx -mno-flat
25365 @opindex mflat
25366 @opindex mno-flat
25367 With @option{-mflat}, the compiler does not generate save/restore instructions
25368 and uses a ``flat'' or single register window model.  This model is compatible
25369 with the regular register window model.  The local registers and the input
25370 registers (0--5) are still treated as ``call-saved'' registers and are
25371 saved on the stack as needed.
25373 With @option{-mno-flat} (the default), the compiler generates save/restore
25374 instructions (except for leaf functions).  This is the normal operating mode.
25376 @item -mfpu
25377 @itemx -mhard-float
25378 @opindex mfpu
25379 @opindex mhard-float
25380 Generate output containing floating-point instructions.  This is the
25381 default.
25383 @item -mno-fpu
25384 @itemx -msoft-float
25385 @opindex mno-fpu
25386 @opindex msoft-float
25387 Generate output containing library calls for floating point.
25388 @strong{Warning:} the requisite libraries are not available for all SPARC
25389 targets.  Normally the facilities of the machine's usual C compiler are
25390 used, but this cannot be done directly in cross-compilation.  You must make
25391 your own arrangements to provide suitable library functions for
25392 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
25393 @samp{sparclite-*-*} do provide software floating-point support.
25395 @option{-msoft-float} changes the calling convention in the output file;
25396 therefore, it is only useful if you compile @emph{all} of a program with
25397 this option.  In particular, you need to compile @file{libgcc.a}, the
25398 library that comes with GCC, with @option{-msoft-float} in order for
25399 this to work.
25401 @item -mhard-quad-float
25402 @opindex mhard-quad-float
25403 Generate output containing quad-word (long double) floating-point
25404 instructions.
25406 @item -msoft-quad-float
25407 @opindex msoft-quad-float
25408 Generate output containing library calls for quad-word (long double)
25409 floating-point instructions.  The functions called are those specified
25410 in the SPARC ABI@.  This is the default.
25412 As of this writing, there are no SPARC implementations that have hardware
25413 support for the quad-word floating-point instructions.  They all invoke
25414 a trap handler for one of these instructions, and then the trap handler
25415 emulates the effect of the instruction.  Because of the trap handler overhead,
25416 this is much slower than calling the ABI library routines.  Thus the
25417 @option{-msoft-quad-float} option is the default.
25419 @item -mno-unaligned-doubles
25420 @itemx -munaligned-doubles
25421 @opindex mno-unaligned-doubles
25422 @opindex munaligned-doubles
25423 Assume that doubles have 8-byte alignment.  This is the default.
25425 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
25426 alignment only if they are contained in another type, or if they have an
25427 absolute address.  Otherwise, it assumes they have 4-byte alignment.
25428 Specifying this option avoids some rare compatibility problems with code
25429 generated by other compilers.  It is not the default because it results
25430 in a performance loss, especially for floating-point code.
25432 @item -muser-mode
25433 @itemx -mno-user-mode
25434 @opindex muser-mode
25435 @opindex mno-user-mode
25436 Do not generate code that can only run in supervisor mode.  This is relevant
25437 only for the @code{casa} instruction emitted for the LEON3 processor.  This
25438 is the default.
25440 @item -mfaster-structs
25441 @itemx -mno-faster-structs
25442 @opindex mfaster-structs
25443 @opindex mno-faster-structs
25444 With @option{-mfaster-structs}, the compiler assumes that structures
25445 should have 8-byte alignment.  This enables the use of pairs of
25446 @code{ldd} and @code{std} instructions for copies in structure
25447 assignment, in place of twice as many @code{ld} and @code{st} pairs.
25448 However, the use of this changed alignment directly violates the SPARC
25449 ABI@.  Thus, it's intended only for use on targets where the developer
25450 acknowledges that their resulting code is not directly in line with
25451 the rules of the ABI@.
25453 @item -mstd-struct-return
25454 @itemx -mno-std-struct-return
25455 @opindex mstd-struct-return
25456 @opindex mno-std-struct-return
25457 With @option{-mstd-struct-return}, the compiler generates checking code
25458 in functions returning structures or unions to detect size mismatches
25459 between the two sides of function calls, as per the 32-bit ABI@.
25461 The default is @option{-mno-std-struct-return}.  This option has no effect
25462 in 64-bit mode.
25464 @item -mlra
25465 @itemx -mno-lra
25466 @opindex mlra
25467 @opindex mno-lra
25468 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
25469 so @option{-mno-lra} needs to be passed to get old Reload.
25471 @item -mcpu=@var{cpu_type}
25472 @opindex mcpu
25473 Set the instruction set, register set, and instruction scheduling parameters
25474 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25475 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
25476 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
25477 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
25478 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
25479 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
25481 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
25482 which selects the best architecture option for the host processor.
25483 @option{-mcpu=native} has no effect if GCC does not recognize
25484 the processor.
25486 Default instruction scheduling parameters are used for values that select
25487 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
25488 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
25490 Here is a list of each supported architecture and their supported
25491 implementations.
25493 @table @asis
25494 @item v7
25495 cypress, leon3v7
25497 @item v8
25498 supersparc, hypersparc, leon, leon3
25500 @item sparclite
25501 f930, f934, sparclite86x
25503 @item sparclet
25504 tsc701
25506 @item v9
25507 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
25508 niagara7, m8
25509 @end table
25511 By default (unless configured otherwise), GCC generates code for the V7
25512 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
25513 additionally optimizes it for the Cypress CY7C602 chip, as used in the
25514 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
25515 SPARCStation 1, 2, IPX etc.
25517 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
25518 architecture.  The only difference from V7 code is that the compiler emits
25519 the integer multiply and integer divide instructions which exist in SPARC-V8
25520 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
25521 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
25522 2000 series.
25524 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
25525 the SPARC architecture.  This adds the integer multiply, integer divide step
25526 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
25527 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
25528 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
25529 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
25530 MB86934 chip, which is the more recent SPARClite with FPU@.
25532 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
25533 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
25534 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
25535 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
25536 optimizes it for the TEMIC SPARClet chip.
25538 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
25539 architecture.  This adds 64-bit integer and floating-point move instructions,
25540 3 additional floating-point condition code registers and conditional move
25541 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
25542 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
25543 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
25544 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
25545 @option{-mcpu=niagara}, the compiler additionally optimizes it for
25546 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
25547 additionally optimizes it for Sun UltraSPARC T2 chips. With
25548 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
25549 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
25550 additionally optimizes it for Sun UltraSPARC T4 chips.  With
25551 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
25552 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
25553 additionally optimizes it for Oracle M8 chips.
25555 @item -mtune=@var{cpu_type}
25556 @opindex mtune
25557 Set the instruction scheduling parameters for machine type
25558 @var{cpu_type}, but do not set the instruction set or register set that the
25559 option @option{-mcpu=@var{cpu_type}} does.
25561 The same values for @option{-mcpu=@var{cpu_type}} can be used for
25562 @option{-mtune=@var{cpu_type}}, but the only useful values are those
25563 that select a particular CPU implementation.  Those are
25564 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
25565 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
25566 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
25567 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
25568 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
25569 and GNU/Linux toolchains, @samp{native} can also be used.
25571 @item -mv8plus
25572 @itemx -mno-v8plus
25573 @opindex mv8plus
25574 @opindex mno-v8plus
25575 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
25576 difference from the V8 ABI is that the global and out registers are
25577 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
25578 mode for all SPARC-V9 processors.
25580 @item -mvis
25581 @itemx -mno-vis
25582 @opindex mvis
25583 @opindex mno-vis
25584 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
25585 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
25587 @item -mvis2
25588 @itemx -mno-vis2
25589 @opindex mvis2
25590 @opindex mno-vis2
25591 With @option{-mvis2}, GCC generates code that takes advantage of
25592 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
25593 default is @option{-mvis2} when targeting a cpu that supports such
25594 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
25595 also sets @option{-mvis}.
25597 @item -mvis3
25598 @itemx -mno-vis3
25599 @opindex mvis3
25600 @opindex mno-vis3
25601 With @option{-mvis3}, GCC generates code that takes advantage of
25602 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
25603 default is @option{-mvis3} when targeting a cpu that supports such
25604 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
25605 also sets @option{-mvis2} and @option{-mvis}.
25607 @item -mvis4
25608 @itemx -mno-vis4
25609 @opindex mvis4
25610 @opindex mno-vis4
25611 With @option{-mvis4}, GCC generates code that takes advantage of
25612 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
25613 default is @option{-mvis4} when targeting a cpu that supports such
25614 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
25615 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
25617 @item -mvis4b
25618 @itemx -mno-vis4b
25619 @opindex mvis4b
25620 @opindex mno-vis4b
25621 With @option{-mvis4b}, GCC generates code that takes advantage of
25622 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
25623 the additional VIS instructions introduced in the Oracle SPARC
25624 Architecture 2017.  The default is @option{-mvis4b} when targeting a
25625 cpu that supports such instructions, such as m8 and later.  Setting
25626 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
25627 @option{-mvis2} and @option{-mvis}.
25629 @item -mcbcond
25630 @itemx -mno-cbcond
25631 @opindex mcbcond
25632 @opindex mno-cbcond
25633 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
25634 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
25635 when targeting a CPU that supports such instructions, such as Niagara-4 and
25636 later.
25638 @item -mfmaf
25639 @itemx -mno-fmaf
25640 @opindex mfmaf
25641 @opindex mno-fmaf
25642 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
25643 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
25644 when targeting a CPU that supports such instructions, such as Niagara-3 and
25645 later.
25647 @item -mfsmuld
25648 @itemx -mno-fsmuld
25649 @opindex mfsmuld
25650 @opindex mno-fsmuld
25651 With @option{-mfsmuld}, GCC generates code that takes advantage of the
25652 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
25653 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
25654 or V9 with FPU except @option{-mcpu=leon}.
25656 @item -mpopc
25657 @itemx -mno-popc
25658 @opindex mpopc
25659 @opindex mno-popc
25660 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
25661 Population Count instruction.  The default is @option{-mpopc}
25662 when targeting a CPU that supports such an instruction, such as Niagara-2 and
25663 later.
25665 @item -msubxc
25666 @itemx -mno-subxc
25667 @opindex msubxc
25668 @opindex mno-subxc
25669 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
25670 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
25671 when targeting a CPU that supports such an instruction, such as Niagara-7 and
25672 later.
25674 @item -mfix-at697f
25675 @opindex mfix-at697f
25676 Enable the documented workaround for the single erratum of the Atmel AT697F
25677 processor (which corresponds to erratum #13 of the AT697E processor).
25679 @item -mfix-ut699
25680 @opindex mfix-ut699
25681 Enable the documented workarounds for the floating-point errata and the data
25682 cache nullify errata of the UT699 processor.
25684 @item -mfix-ut700
25685 @opindex mfix-ut700
25686 Enable the documented workaround for the back-to-back store errata of
25687 the UT699E/UT700 processor.
25689 @item -mfix-gr712rc
25690 @opindex mfix-gr712rc
25691 Enable the documented workaround for the back-to-back store errata of
25692 the GR712RC processor.
25693 @end table
25695 These @samp{-m} options are supported in addition to the above
25696 on SPARC-V9 processors in 64-bit environments:
25698 @table @gcctabopt
25699 @item -m32
25700 @itemx -m64
25701 @opindex m32
25702 @opindex m64
25703 Generate code for a 32-bit or 64-bit environment.
25704 The 32-bit environment sets int, long and pointer to 32 bits.
25705 The 64-bit environment sets int to 32 bits and long and pointer
25706 to 64 bits.
25708 @item -mcmodel=@var{which}
25709 @opindex mcmodel
25710 Set the code model to one of
25712 @table @samp
25713 @item medlow
25714 The Medium/Low code model: 64-bit addresses, programs
25715 must be linked in the low 32 bits of memory.  Programs can be statically
25716 or dynamically linked.
25718 @item medmid
25719 The Medium/Middle code model: 64-bit addresses, programs
25720 must be linked in the low 44 bits of memory, the text and data segments must
25721 be less than 2GB in size and the data segment must be located within 2GB of
25722 the text segment.
25724 @item medany
25725 The Medium/Anywhere code model: 64-bit addresses, programs
25726 may be linked anywhere in memory, the text and data segments must be less
25727 than 2GB in size and the data segment must be located within 2GB of the
25728 text segment.
25730 @item embmedany
25731 The Medium/Anywhere code model for embedded systems:
25732 64-bit addresses, the text and data segments must be less than 2GB in
25733 size, both starting anywhere in memory (determined at link time).  The
25734 global register %g4 points to the base of the data segment.  Programs
25735 are statically linked and PIC is not supported.
25736 @end table
25738 @item -mmemory-model=@var{mem-model}
25739 @opindex mmemory-model
25740 Set the memory model in force on the processor to one of
25742 @table @samp
25743 @item default
25744 The default memory model for the processor and operating system.
25746 @item rmo
25747 Relaxed Memory Order
25749 @item pso
25750 Partial Store Order
25752 @item tso
25753 Total Store Order
25755 @item sc
25756 Sequential Consistency
25757 @end table
25759 These memory models are formally defined in Appendix D of the SPARC-V9
25760 architecture manual, as set in the processor's @code{PSTATE.MM} field.
25762 @item -mstack-bias
25763 @itemx -mno-stack-bias
25764 @opindex mstack-bias
25765 @opindex mno-stack-bias
25766 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
25767 frame pointer if present, are offset by @minus{}2047 which must be added back
25768 when making stack frame references.  This is the default in 64-bit mode.
25769 Otherwise, assume no such offset is present.
25770 @end table
25772 @node SPU Options
25773 @subsection SPU Options
25774 @cindex SPU options
25776 These @samp{-m} options are supported on the SPU:
25778 @table @gcctabopt
25779 @item -mwarn-reloc
25780 @itemx -merror-reloc
25781 @opindex mwarn-reloc
25782 @opindex merror-reloc
25784 The loader for SPU does not handle dynamic relocations.  By default, GCC
25785 gives an error when it generates code that requires a dynamic
25786 relocation.  @option{-mno-error-reloc} disables the error,
25787 @option{-mwarn-reloc} generates a warning instead.
25789 @item -msafe-dma
25790 @itemx -munsafe-dma
25791 @opindex msafe-dma
25792 @opindex munsafe-dma
25794 Instructions that initiate or test completion of DMA must not be
25795 reordered with respect to loads and stores of the memory that is being
25796 accessed.
25797 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
25798 memory accesses, but that can lead to inefficient code in places where the
25799 memory is known to not change.  Rather than mark the memory as volatile,
25800 you can use @option{-msafe-dma} to tell the compiler to treat
25801 the DMA instructions as potentially affecting all memory.  
25803 @item -mbranch-hints
25804 @opindex mbranch-hints
25806 By default, GCC generates a branch hint instruction to avoid
25807 pipeline stalls for always-taken or probably-taken branches.  A hint
25808 is not generated closer than 8 instructions away from its branch.
25809 There is little reason to disable them, except for debugging purposes,
25810 or to make an object a little bit smaller.
25812 @item -msmall-mem
25813 @itemx -mlarge-mem
25814 @opindex msmall-mem
25815 @opindex mlarge-mem
25817 By default, GCC generates code assuming that addresses are never larger
25818 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
25819 a full 32-bit address.
25821 @item -mstdmain
25822 @opindex mstdmain
25824 By default, GCC links against startup code that assumes the SPU-style
25825 main function interface (which has an unconventional parameter list).
25826 With @option{-mstdmain}, GCC links your program against startup
25827 code that assumes a C99-style interface to @code{main}, including a
25828 local copy of @code{argv} strings.
25830 @item -mfixed-range=@var{register-range}
25831 @opindex mfixed-range
25832 Generate code treating the given register range as fixed registers.
25833 A fixed register is one that the register allocator cannot use.  This is
25834 useful when compiling kernel code.  A register range is specified as
25835 two registers separated by a dash.  Multiple register ranges can be
25836 specified separated by a comma.
25838 @item -mea32
25839 @itemx -mea64
25840 @opindex mea32
25841 @opindex mea64
25842 Compile code assuming that pointers to the PPU address space accessed
25843 via the @code{__ea} named address space qualifier are either 32 or 64
25844 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
25845 all object code in an executable must be compiled with the same setting.
25847 @item -maddress-space-conversion
25848 @itemx -mno-address-space-conversion
25849 @opindex maddress-space-conversion
25850 @opindex mno-address-space-conversion
25851 Allow/disallow treating the @code{__ea} address space as superset
25852 of the generic address space.  This enables explicit type casts
25853 between @code{__ea} and generic pointer as well as implicit
25854 conversions of generic pointers to @code{__ea} pointers.  The
25855 default is to allow address space pointer conversions.
25857 @item -mcache-size=@var{cache-size}
25858 @opindex mcache-size
25859 This option controls the version of libgcc that the compiler links to an
25860 executable and selects a software-managed cache for accessing variables
25861 in the @code{__ea} address space with a particular cache size.  Possible
25862 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
25863 and @samp{128}.  The default cache size is 64KB.
25865 @item -matomic-updates
25866 @itemx -mno-atomic-updates
25867 @opindex matomic-updates
25868 @opindex mno-atomic-updates
25869 This option controls the version of libgcc that the compiler links to an
25870 executable and selects whether atomic updates to the software-managed
25871 cache of PPU-side variables are used.  If you use atomic updates, changes
25872 to a PPU variable from SPU code using the @code{__ea} named address space
25873 qualifier do not interfere with changes to other PPU variables residing
25874 in the same cache line from PPU code.  If you do not use atomic updates,
25875 such interference may occur; however, writing back cache lines is
25876 more efficient.  The default behavior is to use atomic updates.
25878 @item -mdual-nops
25879 @itemx -mdual-nops=@var{n}
25880 @opindex mdual-nops
25881 By default, GCC inserts NOPs to increase dual issue when it expects
25882 it to increase performance.  @var{n} can be a value from 0 to 10.  A
25883 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
25884 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
25886 @item -mhint-max-nops=@var{n}
25887 @opindex mhint-max-nops
25888 Maximum number of NOPs to insert for a branch hint.  A branch hint must
25889 be at least 8 instructions away from the branch it is affecting.  GCC
25890 inserts up to @var{n} NOPs to enforce this, otherwise it does not
25891 generate the branch hint.
25893 @item -mhint-max-distance=@var{n}
25894 @opindex mhint-max-distance
25895 The encoding of the branch hint instruction limits the hint to be within
25896 256 instructions of the branch it is affecting.  By default, GCC makes
25897 sure it is within 125.
25899 @item -msafe-hints
25900 @opindex msafe-hints
25901 Work around a hardware bug that causes the SPU to stall indefinitely.
25902 By default, GCC inserts the @code{hbrp} instruction to make sure
25903 this stall won't happen.
25905 @end table
25907 @node System V Options
25908 @subsection Options for System V
25910 These additional options are available on System V Release 4 for
25911 compatibility with other compilers on those systems:
25913 @table @gcctabopt
25914 @item -G
25915 @opindex G
25916 Create a shared object.
25917 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
25919 @item -Qy
25920 @opindex Qy
25921 Identify the versions of each tool used by the compiler, in a
25922 @code{.ident} assembler directive in the output.
25924 @item -Qn
25925 @opindex Qn
25926 Refrain from adding @code{.ident} directives to the output file (this is
25927 the default).
25929 @item -YP,@var{dirs}
25930 @opindex YP
25931 Search the directories @var{dirs}, and no others, for libraries
25932 specified with @option{-l}.
25934 @item -Ym,@var{dir}
25935 @opindex Ym
25936 Look in the directory @var{dir} to find the M4 preprocessor.
25937 The assembler uses this option.
25938 @c This is supposed to go with a -Yd for predefined M4 macro files, but
25939 @c the generic assembler that comes with Solaris takes just -Ym.
25940 @end table
25942 @node TILE-Gx Options
25943 @subsection TILE-Gx Options
25944 @cindex TILE-Gx options
25946 These @samp{-m} options are supported on the TILE-Gx:
25948 @table @gcctabopt
25949 @item -mcmodel=small
25950 @opindex mcmodel=small
25951 Generate code for the small model.  The distance for direct calls is
25952 limited to 500M in either direction.  PC-relative addresses are 32
25953 bits.  Absolute addresses support the full address range.
25955 @item -mcmodel=large
25956 @opindex mcmodel=large
25957 Generate code for the large model.  There is no limitation on call
25958 distance, pc-relative addresses, or absolute addresses.
25960 @item -mcpu=@var{name}
25961 @opindex mcpu
25962 Selects the type of CPU to be targeted.  Currently the only supported
25963 type is @samp{tilegx}.
25965 @item -m32
25966 @itemx -m64
25967 @opindex m32
25968 @opindex m64
25969 Generate code for a 32-bit or 64-bit environment.  The 32-bit
25970 environment sets int, long, and pointer to 32 bits.  The 64-bit
25971 environment sets int to 32 bits and long and pointer to 64 bits.
25973 @item -mbig-endian
25974 @itemx -mlittle-endian
25975 @opindex mbig-endian
25976 @opindex mlittle-endian
25977 Generate code in big/little endian mode, respectively.
25978 @end table
25980 @node TILEPro Options
25981 @subsection TILEPro Options
25982 @cindex TILEPro options
25984 These @samp{-m} options are supported on the TILEPro:
25986 @table @gcctabopt
25987 @item -mcpu=@var{name}
25988 @opindex mcpu
25989 Selects the type of CPU to be targeted.  Currently the only supported
25990 type is @samp{tilepro}.
25992 @item -m32
25993 @opindex m32
25994 Generate code for a 32-bit environment, which sets int, long, and
25995 pointer to 32 bits.  This is the only supported behavior so the flag
25996 is essentially ignored.
25997 @end table
25999 @node V850 Options
26000 @subsection V850 Options
26001 @cindex V850 Options
26003 These @samp{-m} options are defined for V850 implementations:
26005 @table @gcctabopt
26006 @item -mlong-calls
26007 @itemx -mno-long-calls
26008 @opindex mlong-calls
26009 @opindex mno-long-calls
26010 Treat all calls as being far away (near).  If calls are assumed to be
26011 far away, the compiler always loads the function's address into a
26012 register, and calls indirect through the pointer.
26014 @item -mno-ep
26015 @itemx -mep
26016 @opindex mno-ep
26017 @opindex mep
26018 Do not optimize (do optimize) basic blocks that use the same index
26019 pointer 4 or more times to copy pointer into the @code{ep} register, and
26020 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
26021 option is on by default if you optimize.
26023 @item -mno-prolog-function
26024 @itemx -mprolog-function
26025 @opindex mno-prolog-function
26026 @opindex mprolog-function
26027 Do not use (do use) external functions to save and restore registers
26028 at the prologue and epilogue of a function.  The external functions
26029 are slower, but use less code space if more than one function saves
26030 the same number of registers.  The @option{-mprolog-function} option
26031 is on by default if you optimize.
26033 @item -mspace
26034 @opindex mspace
26035 Try to make the code as small as possible.  At present, this just turns
26036 on the @option{-mep} and @option{-mprolog-function} options.
26038 @item -mtda=@var{n}
26039 @opindex mtda
26040 Put static or global variables whose size is @var{n} bytes or less into
26041 the tiny data area that register @code{ep} points to.  The tiny data
26042 area can hold up to 256 bytes in total (128 bytes for byte references).
26044 @item -msda=@var{n}
26045 @opindex msda
26046 Put static or global variables whose size is @var{n} bytes or less into
26047 the small data area that register @code{gp} points to.  The small data
26048 area can hold up to 64 kilobytes.
26050 @item -mzda=@var{n}
26051 @opindex mzda
26052 Put static or global variables whose size is @var{n} bytes or less into
26053 the first 32 kilobytes of memory.
26055 @item -mv850
26056 @opindex mv850
26057 Specify that the target processor is the V850.
26059 @item -mv850e3v5
26060 @opindex mv850e3v5
26061 Specify that the target processor is the V850E3V5.  The preprocessor
26062 constant @code{__v850e3v5__} is defined if this option is used.
26064 @item -mv850e2v4
26065 @opindex mv850e2v4
26066 Specify that the target processor is the V850E3V5.  This is an alias for
26067 the @option{-mv850e3v5} option.
26069 @item -mv850e2v3
26070 @opindex mv850e2v3
26071 Specify that the target processor is the V850E2V3.  The preprocessor
26072 constant @code{__v850e2v3__} is defined if this option is used.
26074 @item -mv850e2
26075 @opindex mv850e2
26076 Specify that the target processor is the V850E2.  The preprocessor
26077 constant @code{__v850e2__} is defined if this option is used.
26079 @item -mv850e1
26080 @opindex mv850e1
26081 Specify that the target processor is the V850E1.  The preprocessor
26082 constants @code{__v850e1__} and @code{__v850e__} are defined if
26083 this option is used.
26085 @item -mv850es
26086 @opindex mv850es
26087 Specify that the target processor is the V850ES.  This is an alias for
26088 the @option{-mv850e1} option.
26090 @item -mv850e
26091 @opindex mv850e
26092 Specify that the target processor is the V850E@.  The preprocessor
26093 constant @code{__v850e__} is defined if this option is used.
26095 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
26096 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
26097 are defined then a default target processor is chosen and the
26098 relevant @samp{__v850*__} preprocessor constant is defined.
26100 The preprocessor constants @code{__v850} and @code{__v851__} are always
26101 defined, regardless of which processor variant is the target.
26103 @item -mdisable-callt
26104 @itemx -mno-disable-callt
26105 @opindex mdisable-callt
26106 @opindex mno-disable-callt
26107 This option suppresses generation of the @code{CALLT} instruction for the
26108 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
26109 architecture.
26111 This option is enabled by default when the RH850 ABI is
26112 in use (see @option{-mrh850-abi}), and disabled by default when the
26113 GCC ABI is in use.  If @code{CALLT} instructions are being generated
26114 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
26116 @item -mrelax
26117 @itemx -mno-relax
26118 @opindex mrelax
26119 @opindex mno-relax
26120 Pass on (or do not pass on) the @option{-mrelax} command-line option
26121 to the assembler.
26123 @item -mlong-jumps
26124 @itemx -mno-long-jumps
26125 @opindex mlong-jumps
26126 @opindex mno-long-jumps
26127 Disable (or re-enable) the generation of PC-relative jump instructions.
26129 @item -msoft-float
26130 @itemx -mhard-float
26131 @opindex msoft-float
26132 @opindex mhard-float
26133 Disable (or re-enable) the generation of hardware floating point
26134 instructions.  This option is only significant when the target
26135 architecture is @samp{V850E2V3} or higher.  If hardware floating point
26136 instructions are being generated then the C preprocessor symbol
26137 @code{__FPU_OK__} is defined, otherwise the symbol
26138 @code{__NO_FPU__} is defined.
26140 @item -mloop
26141 @opindex mloop
26142 Enables the use of the e3v5 LOOP instruction.  The use of this
26143 instruction is not enabled by default when the e3v5 architecture is
26144 selected because its use is still experimental.
26146 @item -mrh850-abi
26147 @itemx -mghs
26148 @opindex mrh850-abi
26149 @opindex mghs
26150 Enables support for the RH850 version of the V850 ABI.  This is the
26151 default.  With this version of the ABI the following rules apply:
26153 @itemize
26154 @item
26155 Integer sized structures and unions are returned via a memory pointer
26156 rather than a register.
26158 @item
26159 Large structures and unions (more than 8 bytes in size) are passed by
26160 value.
26162 @item
26163 Functions are aligned to 16-bit boundaries.
26165 @item
26166 The @option{-m8byte-align} command-line option is supported.
26168 @item
26169 The @option{-mdisable-callt} command-line option is enabled by
26170 default.  The @option{-mno-disable-callt} command-line option is not
26171 supported.
26172 @end itemize
26174 When this version of the ABI is enabled the C preprocessor symbol
26175 @code{__V850_RH850_ABI__} is defined.
26177 @item -mgcc-abi
26178 @opindex mgcc-abi
26179 Enables support for the old GCC version of the V850 ABI.  With this
26180 version of the ABI the following rules apply:
26182 @itemize
26183 @item
26184 Integer sized structures and unions are returned in register @code{r10}.
26186 @item
26187 Large structures and unions (more than 8 bytes in size) are passed by
26188 reference.
26190 @item
26191 Functions are aligned to 32-bit boundaries, unless optimizing for
26192 size.
26194 @item
26195 The @option{-m8byte-align} command-line option is not supported.
26197 @item
26198 The @option{-mdisable-callt} command-line option is supported but not
26199 enabled by default.
26200 @end itemize
26202 When this version of the ABI is enabled the C preprocessor symbol
26203 @code{__V850_GCC_ABI__} is defined.
26205 @item -m8byte-align
26206 @itemx -mno-8byte-align
26207 @opindex m8byte-align
26208 @opindex mno-8byte-align
26209 Enables support for @code{double} and @code{long long} types to be
26210 aligned on 8-byte boundaries.  The default is to restrict the
26211 alignment of all objects to at most 4-bytes.  When
26212 @option{-m8byte-align} is in effect the C preprocessor symbol
26213 @code{__V850_8BYTE_ALIGN__} is defined.
26215 @item -mbig-switch
26216 @opindex mbig-switch
26217 Generate code suitable for big switch tables.  Use this option only if
26218 the assembler/linker complain about out of range branches within a switch
26219 table.
26221 @item -mapp-regs
26222 @opindex mapp-regs
26223 This option causes r2 and r5 to be used in the code generated by
26224 the compiler.  This setting is the default.
26226 @item -mno-app-regs
26227 @opindex mno-app-regs
26228 This option causes r2 and r5 to be treated as fixed registers.
26230 @end table
26232 @node VAX Options
26233 @subsection VAX Options
26234 @cindex VAX options
26236 These @samp{-m} options are defined for the VAX:
26238 @table @gcctabopt
26239 @item -munix
26240 @opindex munix
26241 Do not output certain jump instructions (@code{aobleq} and so on)
26242 that the Unix assembler for the VAX cannot handle across long
26243 ranges.
26245 @item -mgnu
26246 @opindex mgnu
26247 Do output those jump instructions, on the assumption that the
26248 GNU assembler is being used.
26250 @item -mg
26251 @opindex mg
26252 Output code for G-format floating-point numbers instead of D-format.
26253 @end table
26255 @node Visium Options
26256 @subsection Visium Options
26257 @cindex Visium options
26259 @table @gcctabopt
26261 @item -mdebug
26262 @opindex mdebug
26263 A program which performs file I/O and is destined to run on an MCM target
26264 should be linked with this option.  It causes the libraries libc.a and
26265 libdebug.a to be linked.  The program should be run on the target under
26266 the control of the GDB remote debugging stub.
26268 @item -msim
26269 @opindex msim
26270 A program which performs file I/O and is destined to run on the simulator
26271 should be linked with option.  This causes libraries libc.a and libsim.a to
26272 be linked.
26274 @item -mfpu
26275 @itemx -mhard-float
26276 @opindex mfpu
26277 @opindex mhard-float
26278 Generate code containing floating-point instructions.  This is the
26279 default.
26281 @item -mno-fpu
26282 @itemx -msoft-float
26283 @opindex mno-fpu
26284 @opindex msoft-float
26285 Generate code containing library calls for floating-point.
26287 @option{-msoft-float} changes the calling convention in the output file;
26288 therefore, it is only useful if you compile @emph{all} of a program with
26289 this option.  In particular, you need to compile @file{libgcc.a}, the
26290 library that comes with GCC, with @option{-msoft-float} in order for
26291 this to work.
26293 @item -mcpu=@var{cpu_type}
26294 @opindex mcpu
26295 Set the instruction set, register set, and instruction scheduling parameters
26296 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
26297 @samp{mcm}, @samp{gr5} and @samp{gr6}.
26299 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
26301 By default (unless configured otherwise), GCC generates code for the GR5
26302 variant of the Visium architecture.  
26304 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
26305 architecture.  The only difference from GR5 code is that the compiler will
26306 generate block move instructions.
26308 @item -mtune=@var{cpu_type}
26309 @opindex mtune
26310 Set the instruction scheduling parameters for machine type @var{cpu_type},
26311 but do not set the instruction set or register set that the option
26312 @option{-mcpu=@var{cpu_type}} would.
26314 @item -msv-mode
26315 @opindex msv-mode
26316 Generate code for the supervisor mode, where there are no restrictions on
26317 the access to general registers.  This is the default.
26319 @item -muser-mode
26320 @opindex muser-mode
26321 Generate code for the user mode, where the access to some general registers
26322 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
26323 mode; on the GR6, only registers r29 to r31 are affected.
26324 @end table
26326 @node VMS Options
26327 @subsection VMS Options
26329 These @samp{-m} options are defined for the VMS implementations:
26331 @table @gcctabopt
26332 @item -mvms-return-codes
26333 @opindex mvms-return-codes
26334 Return VMS condition codes from @code{main}. The default is to return POSIX-style
26335 condition (e.g.@ error) codes.
26337 @item -mdebug-main=@var{prefix}
26338 @opindex mdebug-main=@var{prefix}
26339 Flag the first routine whose name starts with @var{prefix} as the main
26340 routine for the debugger.
26342 @item -mmalloc64
26343 @opindex mmalloc64
26344 Default to 64-bit memory allocation routines.
26346 @item -mpointer-size=@var{size}
26347 @opindex mpointer-size=@var{size}
26348 Set the default size of pointers. Possible options for @var{size} are
26349 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
26350 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
26351 The later option disables @code{pragma pointer_size}.
26352 @end table
26354 @node VxWorks Options
26355 @subsection VxWorks Options
26356 @cindex VxWorks Options
26358 The options in this section are defined for all VxWorks targets.
26359 Options specific to the target hardware are listed with the other
26360 options for that target.
26362 @table @gcctabopt
26363 @item -mrtp
26364 @opindex mrtp
26365 GCC can generate code for both VxWorks kernels and real time processes
26366 (RTPs).  This option switches from the former to the latter.  It also
26367 defines the preprocessor macro @code{__RTP__}.
26369 @item -non-static
26370 @opindex non-static
26371 Link an RTP executable against shared libraries rather than static
26372 libraries.  The options @option{-static} and @option{-shared} can
26373 also be used for RTPs (@pxref{Link Options}); @option{-static}
26374 is the default.
26376 @item -Bstatic
26377 @itemx -Bdynamic
26378 @opindex Bstatic
26379 @opindex Bdynamic
26380 These options are passed down to the linker.  They are defined for
26381 compatibility with Diab.
26383 @item -Xbind-lazy
26384 @opindex Xbind-lazy
26385 Enable lazy binding of function calls.  This option is equivalent to
26386 @option{-Wl,-z,now} and is defined for compatibility with Diab.
26388 @item -Xbind-now
26389 @opindex Xbind-now
26390 Disable lazy binding of function calls.  This option is the default and
26391 is defined for compatibility with Diab.
26392 @end table
26394 @node x86 Options
26395 @subsection x86 Options
26396 @cindex x86 Options
26398 These @samp{-m} options are defined for the x86 family of computers.
26400 @table @gcctabopt
26402 @item -march=@var{cpu-type}
26403 @opindex march
26404 Generate instructions for the machine type @var{cpu-type}.  In contrast to
26405 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
26406 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
26407 to generate code that may not run at all on processors other than the one
26408 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
26409 @option{-mtune=@var{cpu-type}}.
26411 The choices for @var{cpu-type} are:
26413 @table @samp
26414 @item native
26415 This selects the CPU to generate code for at compilation time by determining
26416 the processor type of the compiling machine.  Using @option{-march=native}
26417 enables all instruction subsets supported by the local machine (hence
26418 the result might not run on different machines).  Using @option{-mtune=native}
26419 produces code optimized for the local machine under the constraints
26420 of the selected instruction set.  
26422 @item x86-64
26423 A generic CPU with 64-bit extensions.
26425 @item i386
26426 Original Intel i386 CPU@.
26428 @item i486
26429 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
26431 @item i586
26432 @itemx pentium
26433 Intel Pentium CPU with no MMX support.
26435 @item lakemont
26436 Intel Lakemont MCU, based on Intel Pentium CPU.
26438 @item pentium-mmx
26439 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
26441 @item pentiumpro
26442 Intel Pentium Pro CPU@.
26444 @item i686
26445 When used with @option{-march}, the Pentium Pro
26446 instruction set is used, so the code runs on all i686 family chips.
26447 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
26449 @item pentium2
26450 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
26451 support.
26453 @item pentium3
26454 @itemx pentium3m
26455 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
26456 set support.
26458 @item pentium-m
26459 Intel Pentium M; low-power version of Intel Pentium III CPU
26460 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
26462 @item pentium4
26463 @itemx pentium4m
26464 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
26466 @item prescott
26467 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
26468 set support.
26470 @item nocona
26471 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
26472 SSE2 and SSE3 instruction set support.
26474 @item core2
26475 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
26476 instruction set support.
26478 @item nehalem
26479 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26480 SSE4.1, SSE4.2 and POPCNT instruction set support.
26482 @item westmere
26483 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26484 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
26486 @item sandybridge
26487 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26488 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
26490 @item ivybridge
26491 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26492 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
26493 instruction set support.
26495 @item haswell
26496 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26497 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26498 BMI, BMI2 and F16C instruction set support.
26500 @item broadwell
26501 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26502 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26503 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
26505 @item skylake
26506 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26507 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26508 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
26509 XSAVES instruction set support.
26511 @item bonnell
26512 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
26513 instruction set support.
26515 @item silvermont
26516 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26517 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
26519 @item goldmont
26520 Intel Goldmont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26521 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT and FSGSBASE
26522 instruction set support.
26524 @item goldmont-plus
26525 Intel Goldmont Plus CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26526 SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE,
26527 PTWRITE, RDPID, SGX and UMIP instruction set support.
26529 @item knl
26530 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26531 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26532 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
26533 AVX512CD instruction set support.
26535 @item knm
26536 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26537 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26538 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26539 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
26541 @item skylake-avx512
26542 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26543 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26544 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
26545 CLWB, AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
26547 @item cannonlake
26548 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26549 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26550 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26551 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26552 AVX512IFMA, SHA and UMIP instruction set support.
26554 @item icelake-client
26555 Intel Icelake Client CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26556 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26557 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26558 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26559 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26560 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES instruction set support.
26562 @item icelake-server
26563 Intel Icelake 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, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26568 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES, PCONFIG and WBNOINVD instruction
26569 set support.
26571 @item k6
26572 AMD K6 CPU with MMX instruction set support.
26574 @item k6-2
26575 @itemx k6-3
26576 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
26578 @item athlon
26579 @itemx athlon-tbird
26580 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
26581 support.
26583 @item athlon-4
26584 @itemx athlon-xp
26585 @itemx athlon-mp
26586 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
26587 instruction set support.
26589 @item k8
26590 @itemx opteron
26591 @itemx athlon64
26592 @itemx athlon-fx
26593 Processors based on the AMD K8 core with x86-64 instruction set support,
26594 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
26595 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
26596 instruction set extensions.)
26598 @item k8-sse3
26599 @itemx opteron-sse3
26600 @itemx athlon64-sse3
26601 Improved versions of AMD K8 cores with SSE3 instruction set support.
26603 @item amdfam10
26604 @itemx barcelona
26605 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
26606 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
26607 instruction set extensions.)
26609 @item bdver1
26610 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
26611 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
26612 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
26613 @item bdver2
26614 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26615 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
26616 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
26617 extensions.)
26618 @item bdver3
26619 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26620 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
26621 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
26622 64-bit instruction set extensions.
26623 @item bdver4
26624 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26625 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
26626 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
26627 SSE4.2, ABM and 64-bit instruction set extensions.
26629 @item znver1
26630 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
26631 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
26632 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
26633 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
26634 instruction set extensions.
26636 @item btver1
26637 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
26638 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
26639 instruction set extensions.)
26641 @item btver2
26642 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
26643 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
26644 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
26646 @item winchip-c6
26647 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
26648 set support.
26650 @item winchip2
26651 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
26652 instruction set support.
26654 @item c3
26655 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
26656 (No scheduling is implemented for this chip.)
26658 @item c3-2
26659 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
26660 (No scheduling is implemented for this chip.)
26662 @item c7
26663 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26664 (No scheduling is implemented for this chip.)
26666 @item samuel-2
26667 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
26668 (No scheduling is implemented for this chip.)
26670 @item nehemiah
26671 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
26672 (No scheduling is implemented for this chip.)
26674 @item esther
26675 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26676 (No scheduling is implemented for this chip.)
26678 @item eden-x2
26679 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
26680 (No scheduling is implemented for this chip.)
26682 @item eden-x4
26683 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
26684 AVX and AVX2 instruction set support.
26685 (No scheduling is implemented for this chip.)
26687 @item nano
26688 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26689 instruction set support.
26690 (No scheduling is implemented for this chip.)
26692 @item nano-1000
26693 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26694 instruction set support.
26695 (No scheduling is implemented for this chip.)
26697 @item nano-2000
26698 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26699 instruction set support.
26700 (No scheduling is implemented for this chip.)
26702 @item nano-3000
26703 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26704 instruction set support.
26705 (No scheduling is implemented for this chip.)
26707 @item nano-x2
26708 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26709 instruction set support.
26710 (No scheduling is implemented for this chip.)
26712 @item nano-x4
26713 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26714 instruction set support.
26715 (No scheduling is implemented for this chip.)
26717 @item geode
26718 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
26719 @end table
26721 @item -mtune=@var{cpu-type}
26722 @opindex mtune
26723 Tune to @var{cpu-type} everything applicable about the generated code, except
26724 for the ABI and the set of available instructions.  
26725 While picking a specific @var{cpu-type} schedules things appropriately
26726 for that particular chip, the compiler does not generate any code that
26727 cannot run on the default machine type unless you use a
26728 @option{-march=@var{cpu-type}} option.
26729 For example, if GCC is configured for i686-pc-linux-gnu
26730 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
26731 but still runs on i686 machines.
26733 The choices for @var{cpu-type} are the same as for @option{-march}.
26734 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
26736 @table @samp
26737 @item generic
26738 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
26739 If you know the CPU on which your code will run, then you should use
26740 the corresponding @option{-mtune} or @option{-march} option instead of
26741 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
26742 of your application will have, then you should use this option.
26744 As new processors are deployed in the marketplace, the behavior of this
26745 option will change.  Therefore, if you upgrade to a newer version of
26746 GCC, code generation controlled by this option will change to reflect
26747 the processors
26748 that are most common at the time that version of GCC is released.
26750 There is no @option{-march=generic} option because @option{-march}
26751 indicates the instruction set the compiler can use, and there is no
26752 generic instruction set applicable to all processors.  In contrast,
26753 @option{-mtune} indicates the processor (or, in this case, collection of
26754 processors) for which the code is optimized.
26756 @item intel
26757 Produce code optimized for the most current Intel processors, which are
26758 Haswell and Silvermont for this version of GCC.  If you know the CPU
26759 on which your code will run, then you should use the corresponding
26760 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
26761 But, if you want your application performs better on both Haswell and
26762 Silvermont, then you should use this option.
26764 As new Intel processors are deployed in the marketplace, the behavior of
26765 this option will change.  Therefore, if you upgrade to a newer version of
26766 GCC, code generation controlled by this option will change to reflect
26767 the most current Intel processors at the time that version of GCC is
26768 released.
26770 There is no @option{-march=intel} option because @option{-march} indicates
26771 the instruction set the compiler can use, and there is no common
26772 instruction set applicable to all processors.  In contrast,
26773 @option{-mtune} indicates the processor (or, in this case, collection of
26774 processors) for which the code is optimized.
26775 @end table
26777 @item -mcpu=@var{cpu-type}
26778 @opindex mcpu
26779 A deprecated synonym for @option{-mtune}.
26781 @item -mfpmath=@var{unit}
26782 @opindex mfpmath
26783 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
26784 for @var{unit} are:
26786 @table @samp
26787 @item 387
26788 Use the standard 387 floating-point coprocessor present on the majority of chips and
26789 emulated otherwise.  Code compiled with this option runs almost everywhere.
26790 The temporary results are computed in 80-bit precision instead of the precision
26791 specified by the type, resulting in slightly different results compared to most
26792 of other chips.  See @option{-ffloat-store} for more detailed description.
26794 This is the default choice for non-Darwin x86-32 targets.
26796 @item sse
26797 Use scalar floating-point instructions present in the SSE instruction set.
26798 This instruction set is supported by Pentium III and newer chips,
26799 and in the AMD line
26800 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
26801 instruction set supports only single-precision arithmetic, thus the double and
26802 extended-precision arithmetic are still done using 387.  A later version, present
26803 only in Pentium 4 and AMD x86-64 chips, supports double-precision
26804 arithmetic too.
26806 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
26807 or @option{-msse2} switches to enable SSE extensions and make this option
26808 effective.  For the x86-64 compiler, these extensions are enabled by default.
26810 The resulting code should be considerably faster in the majority of cases and avoid
26811 the numerical instability problems of 387 code, but may break some existing
26812 code that expects temporaries to be 80 bits.
26814 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
26815 and the default choice for x86-32 targets with the SSE2 instruction set
26816 when @option{-ffast-math} is enabled.
26818 @item sse,387
26819 @itemx sse+387
26820 @itemx both
26821 Attempt to utilize both instruction sets at once.  This effectively doubles the
26822 amount of available registers, and on chips with separate execution units for
26823 387 and SSE the execution resources too.  Use this option with care, as it is
26824 still experimental, because the GCC register allocator does not model separate
26825 functional units well, resulting in unstable performance.
26826 @end table
26828 @item -masm=@var{dialect}
26829 @opindex masm=@var{dialect}
26830 Output assembly instructions using selected @var{dialect}.  Also affects
26831 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
26832 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
26833 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
26834 not support @samp{intel}.
26836 @item -mieee-fp
26837 @itemx -mno-ieee-fp
26838 @opindex mieee-fp
26839 @opindex mno-ieee-fp
26840 Control whether or not the compiler uses IEEE floating-point
26841 comparisons.  These correctly handle the case where the result of a
26842 comparison is unordered.
26844 @item -m80387
26845 @itemx -mhard-float
26846 @opindex 80387
26847 @opindex mhard-float
26848 Generate output containing 80387 instructions for floating point.
26850 @item -mno-80387
26851 @itemx -msoft-float
26852 @opindex no-80387
26853 @opindex msoft-float
26854 Generate output containing library calls for floating point.
26856 @strong{Warning:} the requisite libraries are not part of GCC@.
26857 Normally the facilities of the machine's usual C compiler are used, but
26858 this cannot be done directly in cross-compilation.  You must make your
26859 own arrangements to provide suitable library functions for
26860 cross-compilation.
26862 On machines where a function returns floating-point results in the 80387
26863 register stack, some floating-point opcodes may be emitted even if
26864 @option{-msoft-float} is used.
26866 @item -mno-fp-ret-in-387
26867 @opindex mno-fp-ret-in-387
26868 Do not use the FPU registers for return values of functions.
26870 The usual calling convention has functions return values of types
26871 @code{float} and @code{double} in an FPU register, even if there
26872 is no FPU@.  The idea is that the operating system should emulate
26873 an FPU@.
26875 The option @option{-mno-fp-ret-in-387} causes such values to be returned
26876 in ordinary CPU registers instead.
26878 @item -mno-fancy-math-387
26879 @opindex mno-fancy-math-387
26880 Some 387 emulators do not support the @code{sin}, @code{cos} and
26881 @code{sqrt} instructions for the 387.  Specify this option to avoid
26882 generating those instructions.  This option is the default on
26883 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
26884 indicates that the target CPU always has an FPU and so the
26885 instruction does not need emulation.  These
26886 instructions are not generated unless you also use the
26887 @option{-funsafe-math-optimizations} switch.
26889 @item -malign-double
26890 @itemx -mno-align-double
26891 @opindex malign-double
26892 @opindex mno-align-double
26893 Control whether GCC aligns @code{double}, @code{long double}, and
26894 @code{long long} variables on a two-word boundary or a one-word
26895 boundary.  Aligning @code{double} variables on a two-word boundary
26896 produces code that runs somewhat faster on a Pentium at the
26897 expense of more memory.
26899 On x86-64, @option{-malign-double} is enabled by default.
26901 @strong{Warning:} if you use the @option{-malign-double} switch,
26902 structures containing the above types are aligned differently than
26903 the published application binary interface specifications for the x86-32
26904 and are not binary compatible with structures in code compiled
26905 without that switch.
26907 @item -m96bit-long-double
26908 @itemx -m128bit-long-double
26909 @opindex m96bit-long-double
26910 @opindex m128bit-long-double
26911 These switches control the size of @code{long double} type.  The x86-32
26912 application binary interface specifies the size to be 96 bits,
26913 so @option{-m96bit-long-double} is the default in 32-bit mode.
26915 Modern architectures (Pentium and newer) prefer @code{long double}
26916 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
26917 conforming to the ABI, this is not possible.  So specifying
26918 @option{-m128bit-long-double} aligns @code{long double}
26919 to a 16-byte boundary by padding the @code{long double} with an additional
26920 32-bit zero.
26922 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
26923 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
26925 Notice that neither of these options enable any extra precision over the x87
26926 standard of 80 bits for a @code{long double}.
26928 @strong{Warning:} if you override the default value for your target ABI, this
26929 changes the size of 
26930 structures and arrays containing @code{long double} variables,
26931 as well as modifying the function calling convention for functions taking
26932 @code{long double}.  Hence they are not binary-compatible
26933 with code compiled without that switch.
26935 @item -mlong-double-64
26936 @itemx -mlong-double-80
26937 @itemx -mlong-double-128
26938 @opindex mlong-double-64
26939 @opindex mlong-double-80
26940 @opindex mlong-double-128
26941 These switches control the size of @code{long double} type. A size
26942 of 64 bits makes the @code{long double} type equivalent to the @code{double}
26943 type. This is the default for 32-bit Bionic C library.  A size
26944 of 128 bits makes the @code{long double} type equivalent to the
26945 @code{__float128} type. This is the default for 64-bit Bionic C library.
26947 @strong{Warning:} if you override the default value for your target ABI, this
26948 changes the size of
26949 structures and arrays containing @code{long double} variables,
26950 as well as modifying the function calling convention for functions taking
26951 @code{long double}.  Hence they are not binary-compatible
26952 with code compiled without that switch.
26954 @item -malign-data=@var{type}
26955 @opindex malign-data
26956 Control how GCC aligns variables.  Supported values for @var{type} are
26957 @samp{compat} uses increased alignment value compatible uses GCC 4.8
26958 and earlier, @samp{abi} uses alignment value as specified by the
26959 psABI, and @samp{cacheline} uses increased alignment value to match
26960 the cache line size.  @samp{compat} is the default.
26962 @item -mlarge-data-threshold=@var{threshold}
26963 @opindex mlarge-data-threshold
26964 When @option{-mcmodel=medium} is specified, data objects larger than
26965 @var{threshold} are placed in the large data section.  This value must be the
26966 same across all objects linked into the binary, and defaults to 65535.
26968 @item -mrtd
26969 @opindex mrtd
26970 Use a different function-calling convention, in which functions that
26971 take a fixed number of arguments return with the @code{ret @var{num}}
26972 instruction, which pops their arguments while returning.  This saves one
26973 instruction in the caller since there is no need to pop the arguments
26974 there.
26976 You can specify that an individual function is called with this calling
26977 sequence with the function attribute @code{stdcall}.  You can also
26978 override the @option{-mrtd} option by using the function attribute
26979 @code{cdecl}.  @xref{Function Attributes}.
26981 @strong{Warning:} this calling convention is incompatible with the one
26982 normally used on Unix, so you cannot use it if you need to call
26983 libraries compiled with the Unix compiler.
26985 Also, you must provide function prototypes for all functions that
26986 take variable numbers of arguments (including @code{printf});
26987 otherwise incorrect code is generated for calls to those
26988 functions.
26990 In addition, seriously incorrect code results if you call a
26991 function with too many arguments.  (Normally, extra arguments are
26992 harmlessly ignored.)
26994 @item -mregparm=@var{num}
26995 @opindex mregparm
26996 Control how many registers are used to pass integer arguments.  By
26997 default, no registers are used to pass arguments, and at most 3
26998 registers can be used.  You can control this behavior for a specific
26999 function by using the function attribute @code{regparm}.
27000 @xref{Function Attributes}.
27002 @strong{Warning:} if you use this switch, and
27003 @var{num} is nonzero, then you must build all modules with the same
27004 value, including any libraries.  This includes the system libraries and
27005 startup modules.
27007 @item -msseregparm
27008 @opindex msseregparm
27009 Use SSE register passing conventions for float and double arguments
27010 and return values.  You can control this behavior for a specific
27011 function by using the function attribute @code{sseregparm}.
27012 @xref{Function Attributes}.
27014 @strong{Warning:} if you use this switch then you must build all
27015 modules with the same value, including any libraries.  This includes
27016 the system libraries and startup modules.
27018 @item -mvect8-ret-in-mem
27019 @opindex mvect8-ret-in-mem
27020 Return 8-byte vectors in memory instead of MMX registers.  This is the
27021 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
27022 Studio compilers until version 12.  Later compiler versions (starting
27023 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
27024 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
27025 you need to remain compatible with existing code produced by those
27026 previous compiler versions or older versions of GCC@.
27028 @item -mpc32
27029 @itemx -mpc64
27030 @itemx -mpc80
27031 @opindex mpc32
27032 @opindex mpc64
27033 @opindex mpc80
27035 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
27036 is specified, the significands of results of floating-point operations are
27037 rounded to 24 bits (single precision); @option{-mpc64} rounds the
27038 significands of results of floating-point operations to 53 bits (double
27039 precision) and @option{-mpc80} rounds the significands of results of
27040 floating-point operations to 64 bits (extended double precision), which is
27041 the default.  When this option is used, floating-point operations in higher
27042 precisions are not available to the programmer without setting the FPU
27043 control word explicitly.
27045 Setting the rounding of floating-point operations to less than the default
27046 80 bits can speed some programs by 2% or more.  Note that some mathematical
27047 libraries assume that extended-precision (80-bit) floating-point operations
27048 are enabled by default; routines in such libraries could suffer significant
27049 loss of accuracy, typically through so-called ``catastrophic cancellation'',
27050 when this option is used to set the precision to less than extended precision.
27052 @item -mstackrealign
27053 @opindex mstackrealign
27054 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
27055 option generates an alternate prologue and epilogue that realigns the
27056 run-time stack if necessary.  This supports mixing legacy codes that keep
27057 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
27058 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
27059 applicable to individual functions.
27061 @item -mpreferred-stack-boundary=@var{num}
27062 @opindex mpreferred-stack-boundary
27063 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
27064 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
27065 the default is 4 (16 bytes or 128 bits).
27067 @strong{Warning:} When generating code for the x86-64 architecture with
27068 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
27069 used to keep the stack boundary aligned to 8 byte boundary.  Since
27070 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
27071 intended to be used in controlled environment where stack space is
27072 important limitation.  This option leads to wrong code when functions
27073 compiled with 16 byte stack alignment (such as functions from a standard
27074 library) are called with misaligned stack.  In this case, SSE
27075 instructions may lead to misaligned memory access traps.  In addition,
27076 variable arguments are handled incorrectly for 16 byte aligned
27077 objects (including x87 long double and __int128), leading to wrong
27078 results.  You must build all modules with
27079 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
27080 includes the system libraries and startup modules.
27082 @item -mincoming-stack-boundary=@var{num}
27083 @opindex mincoming-stack-boundary
27084 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
27085 boundary.  If @option{-mincoming-stack-boundary} is not specified,
27086 the one specified by @option{-mpreferred-stack-boundary} is used.
27088 On Pentium and Pentium Pro, @code{double} and @code{long double} values
27089 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
27090 suffer significant run time performance penalties.  On Pentium III, the
27091 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
27092 properly if it is not 16-byte aligned.
27094 To ensure proper alignment of this values on the stack, the stack boundary
27095 must be as aligned as that required by any value stored on the stack.
27096 Further, every function must be generated such that it keeps the stack
27097 aligned.  Thus calling a function compiled with a higher preferred
27098 stack boundary from a function compiled with a lower preferred stack
27099 boundary most likely misaligns the stack.  It is recommended that
27100 libraries that use callbacks always use the default setting.
27102 This extra alignment does consume extra stack space, and generally
27103 increases code size.  Code that is sensitive to stack space usage, such
27104 as embedded systems and operating system kernels, may want to reduce the
27105 preferred alignment to @option{-mpreferred-stack-boundary=2}.
27107 @need 200
27108 @item -mmmx
27109 @opindex mmmx
27110 @need 200
27111 @itemx -msse
27112 @opindex msse
27113 @need 200
27114 @itemx -msse2
27115 @opindex msse2
27116 @need 200
27117 @itemx -msse3
27118 @opindex msse3
27119 @need 200
27120 @itemx -mssse3
27121 @opindex mssse3
27122 @need 200
27123 @itemx -msse4
27124 @opindex msse4
27125 @need 200
27126 @itemx -msse4a
27127 @opindex msse4a
27128 @need 200
27129 @itemx -msse4.1
27130 @opindex msse4.1
27131 @need 200
27132 @itemx -msse4.2
27133 @opindex msse4.2
27134 @need 200
27135 @itemx -mavx
27136 @opindex mavx
27137 @need 200
27138 @itemx -mavx2
27139 @opindex mavx2
27140 @need 200
27141 @itemx -mavx512f
27142 @opindex mavx512f
27143 @need 200
27144 @itemx -mavx512pf
27145 @opindex mavx512pf
27146 @need 200
27147 @itemx -mavx512er
27148 @opindex mavx512er
27149 @need 200
27150 @itemx -mavx512cd
27151 @opindex mavx512cd
27152 @need 200
27153 @itemx -mavx512vl
27154 @opindex mavx512vl
27155 @need 200
27156 @itemx -mavx512bw
27157 @opindex mavx512bw
27158 @need 200
27159 @itemx -mavx512dq
27160 @opindex mavx512dq
27161 @need 200
27162 @itemx -mavx512ifma
27163 @opindex mavx512ifma
27164 @need 200
27165 @itemx -mavx512vbmi
27166 @opindex mavx512vbmi
27167 @need 200
27168 @itemx -msha
27169 @opindex msha
27170 @need 200
27171 @itemx -maes
27172 @opindex maes
27173 @need 200
27174 @itemx -mpclmul
27175 @opindex mpclmul
27176 @need 200
27177 @itemx -mclflushopt
27178 @opindex mclflushopt
27179 @need 200
27180 @itemx -mfsgsbase
27181 @opindex mfsgsbase
27182 @need 200
27183 @itemx -mrdrnd
27184 @opindex mrdrnd
27185 @need 200
27186 @itemx -mf16c
27187 @opindex mf16c
27188 @need 200
27189 @itemx -mfma
27190 @opindex mfma
27191 @need 200
27192 @itemx -mpconfig
27193 @opindex mpconfig
27194 @need 200
27195 @itemx -mwbnoinvd
27196 @opindex mwbnoinvd
27197 @need 200
27198 @itemx -mfma4
27199 @opindex mfma4
27200 @need 200
27201 @itemx -mprefetchwt1
27202 @opindex mprefetchwt1
27203 @need 200
27204 @itemx -mxop
27205 @opindex mxop
27206 @need 200
27207 @itemx -mlwp
27208 @opindex mlwp
27209 @need 200
27210 @itemx -m3dnow
27211 @opindex m3dnow
27212 @need 200
27213 @itemx -m3dnowa
27214 @opindex m3dnowa
27215 @need 200
27216 @itemx -mpopcnt
27217 @opindex mpopcnt
27218 @need 200
27219 @itemx -mabm
27220 @opindex mabm
27221 @need 200
27222 @itemx -mbmi
27223 @opindex mbmi
27224 @need 200
27225 @itemx -mbmi2
27226 @need 200
27227 @itemx -mlzcnt
27228 @opindex mlzcnt
27229 @need 200
27230 @itemx -mfxsr
27231 @opindex mfxsr
27232 @need 200
27233 @itemx -mxsave
27234 @opindex mxsave
27235 @need 200
27236 @itemx -mxsaveopt
27237 @opindex mxsaveopt
27238 @need 200
27239 @itemx -mxsavec
27240 @opindex mxsavec
27241 @need 200
27242 @itemx -mxsaves
27243 @opindex mxsaves
27244 @need 200
27245 @itemx -mrtm
27246 @opindex mrtm
27247 @need 200
27248 @itemx -mtbm
27249 @opindex mtbm
27250 @need 200
27251 @itemx -mmpx
27252 @opindex mmpx
27253 @need 200
27254 @itemx -mmwaitx
27255 @opindex mmwaitx
27256 @need 200
27257 @itemx -mclzero
27258 @opindex mclzero
27259 @need 200
27260 @itemx -mpku
27261 @opindex mpku
27262 @need 200
27263 @itemx -mavx512vbmi2
27264 @opindex mavx512vbmi2
27265 @need 200
27266 @itemx -mgfni
27267 @opindex mgfni
27268 @need 200
27269 @itemx -mvaes
27270 @opindex mvaes
27271 @need 200
27272 @itemx -mwaitpkg
27273 @opindex -mwaitpkg
27274 @need 200
27275 @itemx -mvpclmulqdq
27276 @opindex mvpclmulqdq
27277 @need 200
27278 @itemx -mavx512bitalg
27279 @opindex mavx512bitalg
27280 @need 200
27281 @itemx -mmovdiri
27282 @opindex mmovdiri
27283 @need 200
27284 @itemx -mmovdir64b
27285 @opindex mmovdir64b
27286 @need 200
27287 @itemx -mavx512vpopcntdq
27288 @opindex mavx512vpopcntdq
27289 @need 200
27290 @itemx -mcldemote
27291 @opindex mcldemote
27292 These switches enable the use of instructions in the MMX, SSE,
27293 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
27294 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
27295 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES, WAITPKG,
27296 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
27297 GFNI, VPCLMULQDQ, AVX512BITALG, MOVDIRI, MOVDIR64B,
27298 AVX512VPOPCNTDQ, CLDEMOTE, 3DNow!@: or enhanced 3DNow!@: extended instruction
27299 sets. Each has a corresponding @option{-mno-} option to disable use of these
27300 instructions.
27302 These extensions are also available as built-in functions: see
27303 @ref{x86 Built-in Functions}, for details of the functions enabled and
27304 disabled by these switches.
27306 To generate SSE/SSE2 instructions automatically from floating-point
27307 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
27309 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
27310 generates new AVX instructions or AVX equivalence for all SSEx instructions
27311 when needed.
27313 These options enable GCC to use these extended instructions in
27314 generated code, even without @option{-mfpmath=sse}.  Applications that
27315 perform run-time CPU detection must compile separate files for each
27316 supported architecture, using the appropriate flags.  In particular,
27317 the file containing the CPU detection code should be compiled without
27318 these options.
27320 @item -mdump-tune-features
27321 @opindex mdump-tune-features
27322 This option instructs GCC to dump the names of the x86 performance 
27323 tuning features and default settings. The names can be used in 
27324 @option{-mtune-ctrl=@var{feature-list}}.
27326 @item -mtune-ctrl=@var{feature-list}
27327 @opindex mtune-ctrl=@var{feature-list}
27328 This option is used to do fine grain control of x86 code generation features.
27329 @var{feature-list} is a comma separated list of @var{feature} names. See also
27330 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
27331 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
27332 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
27333 developers. Using it may lead to code paths not covered by testing and can
27334 potentially result in compiler ICEs or runtime errors.
27336 @item -mno-default
27337 @opindex mno-default
27338 This option instructs GCC to turn off all tunable features. See also 
27339 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
27341 @item -mcld
27342 @opindex mcld
27343 This option instructs GCC to emit a @code{cld} instruction in the prologue
27344 of functions that use string instructions.  String instructions depend on
27345 the DF flag to select between autoincrement or autodecrement mode.  While the
27346 ABI specifies the DF flag to be cleared on function entry, some operating
27347 systems violate this specification by not clearing the DF flag in their
27348 exception dispatchers.  The exception handler can be invoked with the DF flag
27349 set, which leads to wrong direction mode when string instructions are used.
27350 This option can be enabled by default on 32-bit x86 targets by configuring
27351 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
27352 instructions can be suppressed with the @option{-mno-cld} compiler option
27353 in this case.
27355 @item -mvzeroupper
27356 @opindex mvzeroupper
27357 This option instructs GCC to emit a @code{vzeroupper} instruction
27358 before a transfer of control flow out of the function to minimize
27359 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
27360 intrinsics.
27362 @item -mprefer-avx128
27363 @opindex mprefer-avx128
27364 This option instructs GCC to use 128-bit AVX instructions instead of
27365 256-bit AVX instructions in the auto-vectorizer.
27367 @item -mprefer-vector-width=@var{opt}
27368 @opindex mprefer-vector-width
27369 This option instructs GCC to use @var{opt}-bit vector width in instructions
27370 instead of default on the selected platform.
27372 @table @samp
27373 @item none
27374 No extra limitations applied to GCC other than defined by the selected platform.
27376 @item 128
27377 Prefer 128-bit vector width for instructions.
27379 @item 256
27380 Prefer 256-bit vector width for instructions.
27382 @item 512
27383 Prefer 512-bit vector width for instructions.
27384 @end table
27386 @item -mcx16
27387 @opindex mcx16
27388 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
27389 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
27390 objects.  This is useful for atomic updates of data structures exceeding one
27391 machine word in size.  The compiler uses this instruction to implement
27392 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
27393 128-bit integers, a library call is always used.
27395 @item -msahf
27396 @opindex msahf
27397 This option enables generation of @code{SAHF} instructions in 64-bit code.
27398 Early Intel Pentium 4 CPUs with Intel 64 support,
27399 prior to the introduction of Pentium 4 G1 step in December 2005,
27400 lacked the @code{LAHF} and @code{SAHF} instructions
27401 which are supported by AMD64.
27402 These are load and store instructions, respectively, for certain status flags.
27403 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
27404 @code{drem}, and @code{remainder} built-in functions;
27405 see @ref{Other Builtins} for details.
27407 @item -mmovbe
27408 @opindex mmovbe
27409 This option enables use of the @code{movbe} instruction to implement
27410 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
27412 @item -mshstk
27413 @opindex mshstk
27414 The @option{-mshstk} option enables shadow stack built-in functions
27415 from x86 Control-flow Enforcement Technology (CET).
27417 @item -mcrc32
27418 @opindex mcrc32
27419 This option enables built-in functions @code{__builtin_ia32_crc32qi},
27420 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
27421 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
27423 @item -mrecip
27424 @opindex mrecip
27425 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
27426 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
27427 with an additional Newton-Raphson step
27428 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
27429 (and their vectorized
27430 variants) for single-precision floating-point arguments.  These instructions
27431 are generated only when @option{-funsafe-math-optimizations} is enabled
27432 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
27433 Note that while the throughput of the sequence is higher than the throughput
27434 of the non-reciprocal instruction, the precision of the sequence can be
27435 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
27437 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
27438 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
27439 combination), and doesn't need @option{-mrecip}.
27441 Also note that GCC emits the above sequence with additional Newton-Raphson step
27442 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
27443 already with @option{-ffast-math} (or the above option combination), and
27444 doesn't need @option{-mrecip}.
27446 @item -mrecip=@var{opt}
27447 @opindex mrecip=opt
27448 This option controls which reciprocal estimate instructions
27449 may be used.  @var{opt} is a comma-separated list of options, which may
27450 be preceded by a @samp{!} to invert the option:
27452 @table @samp
27453 @item all
27454 Enable all estimate instructions.
27456 @item default
27457 Enable the default instructions, equivalent to @option{-mrecip}.
27459 @item none
27460 Disable all estimate instructions, equivalent to @option{-mno-recip}.
27462 @item div
27463 Enable the approximation for scalar division.
27465 @item vec-div
27466 Enable the approximation for vectorized division.
27468 @item sqrt
27469 Enable the approximation for scalar square root.
27471 @item vec-sqrt
27472 Enable the approximation for vectorized square root.
27473 @end table
27475 So, for example, @option{-mrecip=all,!sqrt} enables
27476 all of the reciprocal approximations, except for square root.
27478 @item -mveclibabi=@var{type}
27479 @opindex mveclibabi
27480 Specifies the ABI type to use for vectorizing intrinsics using an
27481 external library.  Supported values for @var{type} are @samp{svml} 
27482 for the Intel short
27483 vector math library and @samp{acml} for the AMD math core library.
27484 To use this option, both @option{-ftree-vectorize} and
27485 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
27486 ABI-compatible library must be specified at link time.
27488 GCC currently emits calls to @code{vmldExp2},
27489 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
27490 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
27491 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
27492 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
27493 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
27494 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
27495 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
27496 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
27497 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
27498 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
27499 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
27500 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
27501 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
27502 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
27503 when @option{-mveclibabi=acml} is used.  
27505 @item -mabi=@var{name}
27506 @opindex mabi
27507 Generate code for the specified calling convention.  Permissible values
27508 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
27509 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
27510 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
27511 You can control this behavior for specific functions by
27512 using the function attributes @code{ms_abi} and @code{sysv_abi}.
27513 @xref{Function Attributes}.
27515 @item -mforce-indirect-call
27516 @opindex mforce-indirect-call
27517 Force all calls to functions to be indirect. This is useful
27518 when using Intel Processor Trace where it generates more precise timing
27519 information for function calls.
27521 @item -mcall-ms2sysv-xlogues
27522 @opindex mcall-ms2sysv-xlogues
27523 @opindex mno-call-ms2sysv-xlogues
27524 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
27525 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
27526 default, the code for saving and restoring these registers is emitted inline,
27527 resulting in fairly lengthy prologues and epilogues.  Using
27528 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
27529 use stubs in the static portion of libgcc to perform these saves and restores,
27530 thus reducing function size at the cost of a few extra instructions.
27532 @item -mtls-dialect=@var{type}
27533 @opindex mtls-dialect
27534 Generate code to access thread-local storage using the @samp{gnu} or
27535 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
27536 @samp{gnu2} is more efficient, but it may add compile- and run-time
27537 requirements that cannot be satisfied on all systems.
27539 @item -mpush-args
27540 @itemx -mno-push-args
27541 @opindex mpush-args
27542 @opindex mno-push-args
27543 Use PUSH operations to store outgoing parameters.  This method is shorter
27544 and usually equally fast as method using SUB/MOV operations and is enabled
27545 by default.  In some cases disabling it may improve performance because of
27546 improved scheduling and reduced dependencies.
27548 @item -maccumulate-outgoing-args
27549 @opindex maccumulate-outgoing-args
27550 If enabled, the maximum amount of space required for outgoing arguments is
27551 computed in the function prologue.  This is faster on most modern CPUs
27552 because of reduced dependencies, improved scheduling and reduced stack usage
27553 when the preferred stack boundary is not equal to 2.  The drawback is a notable
27554 increase in code size.  This switch implies @option{-mno-push-args}.
27556 @item -mthreads
27557 @opindex mthreads
27558 Support thread-safe exception handling on MinGW.  Programs that rely
27559 on thread-safe exception handling must compile and link all code with the
27560 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
27561 @option{-D_MT}; when linking, it links in a special thread helper library
27562 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
27564 @item -mms-bitfields
27565 @itemx -mno-ms-bitfields
27566 @opindex mms-bitfields
27567 @opindex mno-ms-bitfields
27569 Enable/disable bit-field layout compatible with the native Microsoft
27570 Windows compiler.  
27572 If @code{packed} is used on a structure, or if bit-fields are used,
27573 it may be that the Microsoft ABI lays out the structure differently
27574 than the way GCC normally does.  Particularly when moving packed
27575 data between functions compiled with GCC and the native Microsoft compiler
27576 (either via function call or as data in a file), it may be necessary to access
27577 either format.
27579 This option is enabled by default for Microsoft Windows
27580 targets.  This behavior can also be controlled locally by use of variable
27581 or type attributes.  For more information, see @ref{x86 Variable Attributes}
27582 and @ref{x86 Type Attributes}.
27584 The Microsoft structure layout algorithm is fairly simple with the exception
27585 of the bit-field packing.  
27586 The padding and alignment of members of structures and whether a bit-field 
27587 can straddle a storage-unit boundary are determine by these rules:
27589 @enumerate
27590 @item Structure members are stored sequentially in the order in which they are
27591 declared: the first member has the lowest memory address and the last member
27592 the highest.
27594 @item Every data object has an alignment requirement.  The alignment requirement
27595 for all data except structures, unions, and arrays is either the size of the
27596 object or the current packing size (specified with either the
27597 @code{aligned} attribute or the @code{pack} pragma),
27598 whichever is less.  For structures, unions, and arrays,
27599 the alignment requirement is the largest alignment requirement of its members.
27600 Every object is allocated an offset so that:
27602 @smallexample
27603 offset % alignment_requirement == 0
27604 @end smallexample
27606 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
27607 unit if the integral types are the same size and if the next bit-field fits
27608 into the current allocation unit without crossing the boundary imposed by the
27609 common alignment requirements of the bit-fields.
27610 @end enumerate
27612 MSVC interprets zero-length bit-fields in the following ways:
27614 @enumerate
27615 @item If a zero-length bit-field is inserted between two bit-fields that
27616 are normally coalesced, the bit-fields are not coalesced.
27618 For example:
27620 @smallexample
27621 struct
27622  @{
27623    unsigned long bf_1 : 12;
27624    unsigned long : 0;
27625    unsigned long bf_2 : 12;
27626  @} t1;
27627 @end smallexample
27629 @noindent
27630 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
27631 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
27633 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
27634 alignment of the zero-length bit-field is greater than the member that follows it,
27635 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
27637 For example:
27639 @smallexample
27640 struct
27641  @{
27642    char foo : 4;
27643    short : 0;
27644    char bar;
27645  @} t2;
27647 struct
27648  @{
27649    char foo : 4;
27650    short : 0;
27651    double bar;
27652  @} t3;
27653 @end smallexample
27655 @noindent
27656 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
27657 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
27658 bit-field does not affect the alignment of @code{bar} or, as a result, the size
27659 of the structure.
27661 Taking this into account, it is important to note the following:
27663 @enumerate
27664 @item If a zero-length bit-field follows a normal bit-field, the type of the
27665 zero-length bit-field may affect the alignment of the structure as whole. For
27666 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
27667 normal bit-field, and is of type short.
27669 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
27670 still affect the alignment of the structure:
27672 @smallexample
27673 struct
27674  @{
27675    char foo : 6;
27676    long : 0;
27677  @} t4;
27678 @end smallexample
27680 @noindent
27681 Here, @code{t4} takes up 4 bytes.
27682 @end enumerate
27684 @item Zero-length bit-fields following non-bit-field members are ignored:
27686 @smallexample
27687 struct
27688  @{
27689    char foo;
27690    long : 0;
27691    char bar;
27692  @} t5;
27693 @end smallexample
27695 @noindent
27696 Here, @code{t5} takes up 2 bytes.
27697 @end enumerate
27700 @item -mno-align-stringops
27701 @opindex mno-align-stringops
27702 Do not align the destination of inlined string operations.  This switch reduces
27703 code size and improves performance in case the destination is already aligned,
27704 but GCC doesn't know about it.
27706 @item -minline-all-stringops
27707 @opindex minline-all-stringops
27708 By default GCC inlines string operations only when the destination is 
27709 known to be aligned to least a 4-byte boundary.  
27710 This enables more inlining and increases code
27711 size, but may improve performance of code that depends on fast
27712 @code{memcpy}, @code{strlen},
27713 and @code{memset} for short lengths.
27715 @item -minline-stringops-dynamically
27716 @opindex minline-stringops-dynamically
27717 For string operations of unknown size, use run-time checks with
27718 inline code for small blocks and a library call for large blocks.
27720 @item -mstringop-strategy=@var{alg}
27721 @opindex mstringop-strategy=@var{alg}
27722 Override the internal decision heuristic for the particular algorithm to use
27723 for inlining string operations.  The allowed values for @var{alg} are:
27725 @table @samp
27726 @item rep_byte
27727 @itemx rep_4byte
27728 @itemx rep_8byte
27729 Expand using i386 @code{rep} prefix of the specified size.
27731 @item byte_loop
27732 @itemx loop
27733 @itemx unrolled_loop
27734 Expand into an inline loop.
27736 @item libcall
27737 Always use a library call.
27738 @end table
27740 @item -mmemcpy-strategy=@var{strategy}
27741 @opindex mmemcpy-strategy=@var{strategy}
27742 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
27743 should be inlined and what inline algorithm to use when the expected size
27744 of the copy operation is known. @var{strategy} 
27745 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
27746 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
27747 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
27748 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
27749 in the list must be specified in increasing order.  The minimal byte size for 
27750 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
27751 preceding range.
27753 @item -mmemset-strategy=@var{strategy}
27754 @opindex mmemset-strategy=@var{strategy}
27755 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
27756 @code{__builtin_memset} expansion.
27758 @item -momit-leaf-frame-pointer
27759 @opindex momit-leaf-frame-pointer
27760 Don't keep the frame pointer in a register for leaf functions.  This
27761 avoids the instructions to save, set up, and restore frame pointers and
27762 makes an extra register available in leaf functions.  The option
27763 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
27764 which might make debugging harder.
27766 @item -mtls-direct-seg-refs
27767 @itemx -mno-tls-direct-seg-refs
27768 @opindex mtls-direct-seg-refs
27769 Controls whether TLS variables may be accessed with offsets from the
27770 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
27771 or whether the thread base pointer must be added.  Whether or not this
27772 is valid depends on the operating system, and whether it maps the
27773 segment to cover the entire TLS area.
27775 For systems that use the GNU C Library, the default is on.
27777 @item -msse2avx
27778 @itemx -mno-sse2avx
27779 @opindex msse2avx
27780 Specify that the assembler should encode SSE instructions with VEX
27781 prefix.  The option @option{-mavx} turns this on by default.
27783 @item -mfentry
27784 @itemx -mno-fentry
27785 @opindex mfentry
27786 If profiling is active (@option{-pg}), put the profiling
27787 counter call before the prologue.
27788 Note: On x86 architectures the attribute @code{ms_hook_prologue}
27789 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
27791 @item -mrecord-mcount
27792 @itemx -mno-record-mcount
27793 @opindex mrecord-mcount
27794 If profiling is active (@option{-pg}), generate a __mcount_loc section
27795 that contains pointers to each profiling call. This is useful for
27796 automatically patching and out calls.
27798 @item -mnop-mcount
27799 @itemx -mno-nop-mcount
27800 @opindex mnop-mcount
27801 If profiling is active (@option{-pg}), generate the calls to
27802 the profiling functions as NOPs. This is useful when they
27803 should be patched in later dynamically. This is likely only
27804 useful together with @option{-mrecord-mcount}.
27806 @item -mskip-rax-setup
27807 @itemx -mno-skip-rax-setup
27808 @opindex mskip-rax-setup
27809 When generating code for the x86-64 architecture with SSE extensions
27810 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
27811 register when there are no variable arguments passed in vector registers.
27813 @strong{Warning:} Since RAX register is used to avoid unnecessarily
27814 saving vector registers on stack when passing variable arguments, the
27815 impacts of this option are callees may waste some stack space,
27816 misbehave or jump to a random location.  GCC 4.4 or newer don't have
27817 those issues, regardless the RAX register value.
27819 @item -m8bit-idiv
27820 @itemx -mno-8bit-idiv
27821 @opindex m8bit-idiv
27822 On some processors, like Intel Atom, 8-bit unsigned integer divide is
27823 much faster than 32-bit/64-bit integer divide.  This option generates a
27824 run-time check.  If both dividend and divisor are within range of 0
27825 to 255, 8-bit unsigned integer divide is used instead of
27826 32-bit/64-bit integer divide.
27828 @item -mavx256-split-unaligned-load
27829 @itemx -mavx256-split-unaligned-store
27830 @opindex mavx256-split-unaligned-load
27831 @opindex mavx256-split-unaligned-store
27832 Split 32-byte AVX unaligned load and store.
27834 @item -mstack-protector-guard=@var{guard}
27835 @itemx -mstack-protector-guard-reg=@var{reg}
27836 @itemx -mstack-protector-guard-offset=@var{offset}
27837 @opindex mstack-protector-guard
27838 @opindex mstack-protector-guard-reg
27839 @opindex mstack-protector-guard-offset
27840 Generate stack protection code using canary at @var{guard}.  Supported
27841 locations are @samp{global} for global canary or @samp{tls} for per-thread
27842 canary in the TLS block (the default).  This option has effect only when
27843 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
27845 With the latter choice the options
27846 @option{-mstack-protector-guard-reg=@var{reg}} and
27847 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
27848 which segment register (@code{%fs} or @code{%gs}) to use as base register
27849 for reading the canary, and from what offset from that base register.
27850 The default for those is as specified in the relevant ABI.
27852 @item -mmitigate-rop
27853 @opindex mmitigate-rop
27854 Try to avoid generating code sequences that contain unintended return
27855 opcodes, to mitigate against certain forms of attack. At the moment,
27856 this option is limited in what it can do and should not be relied
27857 on to provide serious protection.
27859 @item -mgeneral-regs-only
27860 @opindex mgeneral-regs-only
27861 Generate code that uses only the general-purpose registers.  This
27862 prevents the compiler from using floating-point, vector, mask and bound
27863 registers.
27865 @item -mindirect-branch=@var{choice}
27866 @opindex -mindirect-branch
27867 Convert indirect call and jump with @var{choice}.  The default is
27868 @samp{keep}, which keeps indirect call and jump unmodified.
27869 @samp{thunk} converts indirect call and jump to call and return thunk.
27870 @samp{thunk-inline} converts indirect call and jump to inlined call
27871 and return thunk.  @samp{thunk-extern} converts indirect call and jump
27872 to external call and return thunk provided in a separate object file.
27873 You can control this behavior for a specific function by using the
27874 function attribute @code{indirect_branch}.  @xref{Function Attributes}.
27876 Note that @option{-mcmodel=large} is incompatible with
27877 @option{-mindirect-branch=thunk} and
27878 @option{-mindirect-branch=thunk-extern} since the thunk function may
27879 not be reachable in the large code model.
27881 Note that @option{-mindirect-branch=thunk-extern} is incompatible with
27882 @option{-fcf-protection=branch} and @option{-fcheck-pointer-bounds}
27883 since the external thunk can not be modified to disable control-flow
27884 check.
27886 @item -mfunction-return=@var{choice}
27887 @opindex -mfunction-return
27888 Convert function return with @var{choice}.  The default is @samp{keep},
27889 which keeps function return unmodified.  @samp{thunk} converts function
27890 return to call and return thunk.  @samp{thunk-inline} converts function
27891 return to inlined call and return thunk.  @samp{thunk-extern} converts
27892 function return to external call and return thunk provided in a separate
27893 object file.  You can control this behavior for a specific function by
27894 using the function attribute @code{function_return}.
27895 @xref{Function Attributes}.
27897 Note that @option{-mcmodel=large} is incompatible with
27898 @option{-mfunction-return=thunk} and
27899 @option{-mfunction-return=thunk-extern} since the thunk function may
27900 not be reachable in the large code model.
27903 @item -mindirect-branch-register
27904 @opindex -mindirect-branch-register
27905 Force indirect call and jump via register.
27907 @end table
27909 These @samp{-m} switches are supported in addition to the above
27910 on x86-64 processors in 64-bit environments.
27912 @table @gcctabopt
27913 @item -m32
27914 @itemx -m64
27915 @itemx -mx32
27916 @itemx -m16
27917 @itemx -miamcu
27918 @opindex m32
27919 @opindex m64
27920 @opindex mx32
27921 @opindex m16
27922 @opindex miamcu
27923 Generate code for a 16-bit, 32-bit or 64-bit environment.
27924 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
27925 to 32 bits, and
27926 generates code that runs on any i386 system.
27928 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
27929 types to 64 bits, and generates code for the x86-64 architecture.
27930 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
27931 and @option{-mdynamic-no-pic} options.
27933 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
27934 to 32 bits, and
27935 generates code for the x86-64 architecture.
27937 The @option{-m16} option is the same as @option{-m32}, except for that
27938 it outputs the @code{.code16gcc} assembly directive at the beginning of
27939 the assembly output so that the binary can run in 16-bit mode.
27941 The @option{-miamcu} option generates code which conforms to Intel MCU
27942 psABI.  It requires the @option{-m32} option to be turned on.
27944 @item -mno-red-zone
27945 @opindex mno-red-zone
27946 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
27947 by the x86-64 ABI; it is a 128-byte area beyond the location of the
27948 stack pointer that is not modified by signal or interrupt handlers
27949 and therefore can be used for temporary data without adjusting the stack
27950 pointer.  The flag @option{-mno-red-zone} disables this red zone.
27952 @item -mcmodel=small
27953 @opindex mcmodel=small
27954 Generate code for the small code model: the program and its symbols must
27955 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
27956 Programs can be statically or dynamically linked.  This is the default
27957 code model.
27959 @item -mcmodel=kernel
27960 @opindex mcmodel=kernel
27961 Generate code for the kernel code model.  The kernel runs in the
27962 negative 2 GB of the address space.
27963 This model has to be used for Linux kernel code.
27965 @item -mcmodel=medium
27966 @opindex mcmodel=medium
27967 Generate code for the medium model: the program is linked in the lower 2
27968 GB of the address space.  Small symbols are also placed there.  Symbols
27969 with sizes larger than @option{-mlarge-data-threshold} are put into
27970 large data or BSS sections and can be located above 2GB.  Programs can
27971 be statically or dynamically linked.
27973 @item -mcmodel=large
27974 @opindex mcmodel=large
27975 Generate code for the large model.  This model makes no assumptions
27976 about addresses and sizes of sections.
27978 @item -maddress-mode=long
27979 @opindex maddress-mode=long
27980 Generate code for long address mode.  This is only supported for 64-bit
27981 and x32 environments.  It is the default address mode for 64-bit
27982 environments.
27984 @item -maddress-mode=short
27985 @opindex maddress-mode=short
27986 Generate code for short address mode.  This is only supported for 32-bit
27987 and x32 environments.  It is the default address mode for 32-bit and
27988 x32 environments.
27989 @end table
27991 @node x86 Windows Options
27992 @subsection x86 Windows Options
27993 @cindex x86 Windows Options
27994 @cindex Windows Options for x86
27996 These additional options are available for Microsoft Windows targets:
27998 @table @gcctabopt
27999 @item -mconsole
28000 @opindex mconsole
28001 This option
28002 specifies that a console application is to be generated, by
28003 instructing the linker to set the PE header subsystem type
28004 required for console applications.
28005 This option is available for Cygwin and MinGW targets and is
28006 enabled by default on those targets.
28008 @item -mdll
28009 @opindex mdll
28010 This option is available for Cygwin and MinGW targets.  It
28011 specifies that a DLL---a dynamic link library---is to be
28012 generated, enabling the selection of the required runtime
28013 startup object and entry point.
28015 @item -mnop-fun-dllimport
28016 @opindex mnop-fun-dllimport
28017 This option is available for Cygwin and MinGW targets.  It
28018 specifies that the @code{dllimport} attribute should be ignored.
28020 @item -mthread
28021 @opindex mthread
28022 This option is available for MinGW targets. It specifies
28023 that MinGW-specific thread support is to be used.
28025 @item -municode
28026 @opindex municode
28027 This option is available for MinGW-w64 targets.  It causes
28028 the @code{UNICODE} preprocessor macro to be predefined, and
28029 chooses Unicode-capable runtime startup code.
28031 @item -mwin32
28032 @opindex mwin32
28033 This option is available for Cygwin and MinGW targets.  It
28034 specifies that the typical Microsoft Windows predefined macros are to
28035 be set in the pre-processor, but does not influence the choice
28036 of runtime library/startup code.
28038 @item -mwindows
28039 @opindex mwindows
28040 This option is available for Cygwin and MinGW targets.  It
28041 specifies that a GUI application is to be generated by
28042 instructing the linker to set the PE header subsystem type
28043 appropriately.
28045 @item -fno-set-stack-executable
28046 @opindex fno-set-stack-executable
28047 This option is available for MinGW targets. It specifies that
28048 the executable flag for the stack used by nested functions isn't
28049 set. This is necessary for binaries running in kernel mode of
28050 Microsoft Windows, as there the User32 API, which is used to set executable
28051 privileges, isn't available.
28053 @item -fwritable-relocated-rdata
28054 @opindex fno-writable-relocated-rdata
28055 This option is available for MinGW and Cygwin targets.  It specifies
28056 that relocated-data in read-only section is put into the @code{.data}
28057 section.  This is a necessary for older runtimes not supporting
28058 modification of @code{.rdata} sections for pseudo-relocation.
28060 @item -mpe-aligned-commons
28061 @opindex mpe-aligned-commons
28062 This option is available for Cygwin and MinGW targets.  It
28063 specifies that the GNU extension to the PE file format that
28064 permits the correct alignment of COMMON variables should be
28065 used when generating code.  It is enabled by default if
28066 GCC detects that the target assembler found during configuration
28067 supports the feature.
28068 @end table
28070 See also under @ref{x86 Options} for standard options.
28072 @node Xstormy16 Options
28073 @subsection Xstormy16 Options
28074 @cindex Xstormy16 Options
28076 These options are defined for Xstormy16:
28078 @table @gcctabopt
28079 @item -msim
28080 @opindex msim
28081 Choose startup files and linker script suitable for the simulator.
28082 @end table
28084 @node Xtensa Options
28085 @subsection Xtensa Options
28086 @cindex Xtensa Options
28088 These options are supported for Xtensa targets:
28090 @table @gcctabopt
28091 @item -mconst16
28092 @itemx -mno-const16
28093 @opindex mconst16
28094 @opindex mno-const16
28095 Enable or disable use of @code{CONST16} instructions for loading
28096 constant values.  The @code{CONST16} instruction is currently not a
28097 standard option from Tensilica.  When enabled, @code{CONST16}
28098 instructions are always used in place of the standard @code{L32R}
28099 instructions.  The use of @code{CONST16} is enabled by default only if
28100 the @code{L32R} instruction is not available.
28102 @item -mfused-madd
28103 @itemx -mno-fused-madd
28104 @opindex mfused-madd
28105 @opindex mno-fused-madd
28106 Enable or disable use of fused multiply/add and multiply/subtract
28107 instructions in the floating-point option.  This has no effect if the
28108 floating-point option is not also enabled.  Disabling fused multiply/add
28109 and multiply/subtract instructions forces the compiler to use separate
28110 instructions for the multiply and add/subtract operations.  This may be
28111 desirable in some cases where strict IEEE 754-compliant results are
28112 required: the fused multiply add/subtract instructions do not round the
28113 intermediate result, thereby producing results with @emph{more} bits of
28114 precision than specified by the IEEE standard.  Disabling fused multiply
28115 add/subtract instructions also ensures that the program output is not
28116 sensitive to the compiler's ability to combine multiply and add/subtract
28117 operations.
28119 @item -mserialize-volatile
28120 @itemx -mno-serialize-volatile
28121 @opindex mserialize-volatile
28122 @opindex mno-serialize-volatile
28123 When this option is enabled, GCC inserts @code{MEMW} instructions before
28124 @code{volatile} memory references to guarantee sequential consistency.
28125 The default is @option{-mserialize-volatile}.  Use
28126 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
28128 @item -mforce-no-pic
28129 @opindex mforce-no-pic
28130 For targets, like GNU/Linux, where all user-mode Xtensa code must be
28131 position-independent code (PIC), this option disables PIC for compiling
28132 kernel code.
28134 @item -mtext-section-literals
28135 @itemx -mno-text-section-literals
28136 @opindex mtext-section-literals
28137 @opindex mno-text-section-literals
28138 These options control the treatment of literal pools.  The default is
28139 @option{-mno-text-section-literals}, which places literals in a separate
28140 section in the output file.  This allows the literal pool to be placed
28141 in a data RAM/ROM, and it also allows the linker to combine literal
28142 pools from separate object files to remove redundant literals and
28143 improve code size.  With @option{-mtext-section-literals}, the literals
28144 are interspersed in the text section in order to keep them as close as
28145 possible to their references.  This may be necessary for large assembly
28146 files.  Literals for each function are placed right before that function.
28148 @item -mauto-litpools
28149 @itemx -mno-auto-litpools
28150 @opindex mauto-litpools
28151 @opindex mno-auto-litpools
28152 These options control the treatment of literal pools.  The default is
28153 @option{-mno-auto-litpools}, which places literals in a separate
28154 section in the output file unless @option{-mtext-section-literals} is
28155 used.  With @option{-mauto-litpools} the literals are interspersed in
28156 the text section by the assembler.  Compiler does not produce explicit
28157 @code{.literal} directives and loads literals into registers with
28158 @code{MOVI} instructions instead of @code{L32R} to let the assembler
28159 do relaxation and place literals as necessary.  This option allows
28160 assembler to create several literal pools per function and assemble
28161 very big functions, which may not be possible with
28162 @option{-mtext-section-literals}.
28164 @item -mtarget-align
28165 @itemx -mno-target-align
28166 @opindex mtarget-align
28167 @opindex mno-target-align
28168 When this option is enabled, GCC instructs the assembler to
28169 automatically align instructions to reduce branch penalties at the
28170 expense of some code density.  The assembler attempts to widen density
28171 instructions to align branch targets and the instructions following call
28172 instructions.  If there are not enough preceding safe density
28173 instructions to align a target, no widening is performed.  The
28174 default is @option{-mtarget-align}.  These options do not affect the
28175 treatment of auto-aligned instructions like @code{LOOP}, which the
28176 assembler always aligns, either by widening density instructions or
28177 by inserting NOP instructions.
28179 @item -mlongcalls
28180 @itemx -mno-longcalls
28181 @opindex mlongcalls
28182 @opindex mno-longcalls
28183 When this option is enabled, GCC instructs the assembler to translate
28184 direct calls to indirect calls unless it can determine that the target
28185 of a direct call is in the range allowed by the call instruction.  This
28186 translation typically occurs for calls to functions in other source
28187 files.  Specifically, the assembler translates a direct @code{CALL}
28188 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
28189 The default is @option{-mno-longcalls}.  This option should be used in
28190 programs where the call target can potentially be out of range.  This
28191 option is implemented in the assembler, not the compiler, so the
28192 assembly code generated by GCC still shows direct call
28193 instructions---look at the disassembled object code to see the actual
28194 instructions.  Note that the assembler uses an indirect call for
28195 every cross-file call, not just those that really are out of range.
28196 @end table
28198 @node zSeries Options
28199 @subsection zSeries Options
28200 @cindex zSeries options
28202 These are listed under @xref{S/390 and zSeries Options}.
28205 @c man end
28207 @node Spec Files
28208 @section Specifying Subprocesses and the Switches to Pass to Them
28209 @cindex Spec Files
28211 @command{gcc} is a driver program.  It performs its job by invoking a
28212 sequence of other programs to do the work of compiling, assembling and
28213 linking.  GCC interprets its command-line parameters and uses these to
28214 deduce which programs it should invoke, and which command-line options
28215 it ought to place on their command lines.  This behavior is controlled
28216 by @dfn{spec strings}.  In most cases there is one spec string for each
28217 program that GCC can invoke, but a few programs have multiple spec
28218 strings to control their behavior.  The spec strings built into GCC can
28219 be overridden by using the @option{-specs=} command-line switch to specify
28220 a spec file.
28222 @dfn{Spec files} are plain-text files that are used to construct spec
28223 strings.  They consist of a sequence of directives separated by blank
28224 lines.  The type of directive is determined by the first non-whitespace
28225 character on the line, which can be one of the following:
28227 @table @code
28228 @item %@var{command}
28229 Issues a @var{command} to the spec file processor.  The commands that can
28230 appear here are:
28232 @table @code
28233 @item %include <@var{file}>
28234 @cindex @code{%include}
28235 Search for @var{file} and insert its text at the current point in the
28236 specs file.
28238 @item %include_noerr <@var{file}>
28239 @cindex @code{%include_noerr}
28240 Just like @samp{%include}, but do not generate an error message if the include
28241 file cannot be found.
28243 @item %rename @var{old_name} @var{new_name}
28244 @cindex @code{%rename}
28245 Rename the spec string @var{old_name} to @var{new_name}.
28247 @end table
28249 @item *[@var{spec_name}]:
28250 This tells the compiler to create, override or delete the named spec
28251 string.  All lines after this directive up to the next directive or
28252 blank line are considered to be the text for the spec string.  If this
28253 results in an empty string then the spec is deleted.  (Or, if the
28254 spec did not exist, then nothing happens.)  Otherwise, if the spec
28255 does not currently exist a new spec is created.  If the spec does
28256 exist then its contents are overridden by the text of this
28257 directive, unless the first character of that text is the @samp{+}
28258 character, in which case the text is appended to the spec.
28260 @item [@var{suffix}]:
28261 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
28262 and up to the next directive or blank line are considered to make up the
28263 spec string for the indicated suffix.  When the compiler encounters an
28264 input file with the named suffix, it processes the spec string in
28265 order to work out how to compile that file.  For example:
28267 @smallexample
28268 .ZZ:
28269 z-compile -input %i
28270 @end smallexample
28272 This says that any input file whose name ends in @samp{.ZZ} should be
28273 passed to the program @samp{z-compile}, which should be invoked with the
28274 command-line switch @option{-input} and with the result of performing the
28275 @samp{%i} substitution.  (See below.)
28277 As an alternative to providing a spec string, the text following a
28278 suffix directive can be one of the following:
28280 @table @code
28281 @item @@@var{language}
28282 This says that the suffix is an alias for a known @var{language}.  This is
28283 similar to using the @option{-x} command-line switch to GCC to specify a
28284 language explicitly.  For example:
28286 @smallexample
28287 .ZZ:
28288 @@c++
28289 @end smallexample
28291 Says that .ZZ files are, in fact, C++ source files.
28293 @item #@var{name}
28294 This causes an error messages saying:
28296 @smallexample
28297 @var{name} compiler not installed on this system.
28298 @end smallexample
28299 @end table
28301 GCC already has an extensive list of suffixes built into it.
28302 This directive adds an entry to the end of the list of suffixes, but
28303 since the list is searched from the end backwards, it is effectively
28304 possible to override earlier entries using this technique.
28306 @end table
28308 GCC has the following spec strings built into it.  Spec files can
28309 override these strings or create their own.  Note that individual
28310 targets can also add their own spec strings to this list.
28312 @smallexample
28313 asm          Options to pass to the assembler
28314 asm_final    Options to pass to the assembler post-processor
28315 cpp          Options to pass to the C preprocessor
28316 cc1          Options to pass to the C compiler
28317 cc1plus      Options to pass to the C++ compiler
28318 endfile      Object files to include at the end of the link
28319 link         Options to pass to the linker
28320 lib          Libraries to include on the command line to the linker
28321 libgcc       Decides which GCC support library to pass to the linker
28322 linker       Sets the name of the linker
28323 predefines   Defines to be passed to the C preprocessor
28324 signed_char  Defines to pass to CPP to say whether @code{char} is signed
28325              by default
28326 startfile    Object files to include at the start of the link
28327 @end smallexample
28329 Here is a small example of a spec file:
28331 @smallexample
28332 %rename lib                 old_lib
28334 *lib:
28335 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
28336 @end smallexample
28338 This example renames the spec called @samp{lib} to @samp{old_lib} and
28339 then overrides the previous definition of @samp{lib} with a new one.
28340 The new definition adds in some extra command-line options before
28341 including the text of the old definition.
28343 @dfn{Spec strings} are a list of command-line options to be passed to their
28344 corresponding program.  In addition, the spec strings can contain
28345 @samp{%}-prefixed sequences to substitute variable text or to
28346 conditionally insert text into the command line.  Using these constructs
28347 it is possible to generate quite complex command lines.
28349 Here is a table of all defined @samp{%}-sequences for spec
28350 strings.  Note that spaces are not generated automatically around the
28351 results of expanding these sequences.  Therefore you can concatenate them
28352 together or combine them with constant text in a single argument.
28354 @table @code
28355 @item %%
28356 Substitute one @samp{%} into the program name or argument.
28358 @item %i
28359 Substitute the name of the input file being processed.
28361 @item %b
28362 Substitute the basename of the input file being processed.
28363 This is the substring up to (and not including) the last period
28364 and not including the directory.
28366 @item %B
28367 This is the same as @samp{%b}, but include the file suffix (text after
28368 the last period).
28370 @item %d
28371 Marks the argument containing or following the @samp{%d} as a
28372 temporary file name, so that that file is deleted if GCC exits
28373 successfully.  Unlike @samp{%g}, this contributes no text to the
28374 argument.
28376 @item %g@var{suffix}
28377 Substitute a file name that has suffix @var{suffix} and is chosen
28378 once per compilation, and mark the argument in the same way as
28379 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
28380 name is now chosen in a way that is hard to predict even when previously
28381 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
28382 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
28383 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
28384 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
28385 was simply substituted with a file name chosen once per compilation,
28386 without regard to any appended suffix (which was therefore treated
28387 just like ordinary text), making such attacks more likely to succeed.
28389 @item %u@var{suffix}
28390 Like @samp{%g}, but generates a new temporary file name
28391 each time it appears instead of once per compilation.
28393 @item %U@var{suffix}
28394 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
28395 new one if there is no such last file name.  In the absence of any
28396 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
28397 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
28398 involves the generation of two distinct file names, one
28399 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
28400 simply substituted with a file name chosen for the previous @samp{%u},
28401 without regard to any appended suffix.
28403 @item %j@var{suffix}
28404 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
28405 writable, and if @option{-save-temps} is not used; 
28406 otherwise, substitute the name
28407 of a temporary file, just like @samp{%u}.  This temporary file is not
28408 meant for communication between processes, but rather as a junk
28409 disposal mechanism.
28411 @item %|@var{suffix}
28412 @itemx %m@var{suffix}
28413 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
28414 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
28415 all.  These are the two most common ways to instruct a program that it
28416 should read from standard input or write to standard output.  If you
28417 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
28418 construct: see for example @file{f/lang-specs.h}.
28420 @item %.@var{SUFFIX}
28421 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
28422 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
28423 terminated by the next space or %.
28425 @item %w
28426 Marks the argument containing or following the @samp{%w} as the
28427 designated output file of this compilation.  This puts the argument
28428 into the sequence of arguments that @samp{%o} substitutes.
28430 @item %o
28431 Substitutes the names of all the output files, with spaces
28432 automatically placed around them.  You should write spaces
28433 around the @samp{%o} as well or the results are undefined.
28434 @samp{%o} is for use in the specs for running the linker.
28435 Input files whose names have no recognized suffix are not compiled
28436 at all, but they are included among the output files, so they are
28437 linked.
28439 @item %O
28440 Substitutes the suffix for object files.  Note that this is
28441 handled specially when it immediately follows @samp{%g, %u, or %U},
28442 because of the need for those to form complete file names.  The
28443 handling is such that @samp{%O} is treated exactly as if it had already
28444 been substituted, except that @samp{%g, %u, and %U} do not currently
28445 support additional @var{suffix} characters following @samp{%O} as they do
28446 following, for example, @samp{.o}.
28448 @item %p
28449 Substitutes the standard macro predefinitions for the
28450 current target machine.  Use this when running @command{cpp}.
28452 @item %P
28453 Like @samp{%p}, but puts @samp{__} before and after the name of each
28454 predefined macro, except for macros that start with @samp{__} or with
28455 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
28458 @item %I
28459 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
28460 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
28461 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
28462 and @option{-imultilib} as necessary.
28464 @item %s
28465 Current argument is the name of a library or startup file of some sort.
28466 Search for that file in a standard list of directories and substitute
28467 the full name found.  The current working directory is included in the
28468 list of directories scanned.
28470 @item %T
28471 Current argument is the name of a linker script.  Search for that file
28472 in the current list of directories to scan for libraries. If the file
28473 is located insert a @option{--script} option into the command line
28474 followed by the full path name found.  If the file is not found then
28475 generate an error message.  Note: the current working directory is not
28476 searched.
28478 @item %e@var{str}
28479 Print @var{str} as an error message.  @var{str} is terminated by a newline.
28480 Use this when inconsistent options are detected.
28482 @item %(@var{name})
28483 Substitute the contents of spec string @var{name} at this point.
28485 @item %x@{@var{option}@}
28486 Accumulate an option for @samp{%X}.
28488 @item %X
28489 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
28490 spec string.
28492 @item %Y
28493 Output the accumulated assembler options specified by @option{-Wa}.
28495 @item %Z
28496 Output the accumulated preprocessor options specified by @option{-Wp}.
28498 @item %a
28499 Process the @code{asm} spec.  This is used to compute the
28500 switches to be passed to the assembler.
28502 @item %A
28503 Process the @code{asm_final} spec.  This is a spec string for
28504 passing switches to an assembler post-processor, if such a program is
28505 needed.
28507 @item %l
28508 Process the @code{link} spec.  This is the spec for computing the
28509 command line passed to the linker.  Typically it makes use of the
28510 @samp{%L %G %S %D and %E} sequences.
28512 @item %D
28513 Dump out a @option{-L} option for each directory that GCC believes might
28514 contain startup files.  If the target supports multilibs then the
28515 current multilib directory is prepended to each of these paths.
28517 @item %L
28518 Process the @code{lib} spec.  This is a spec string for deciding which
28519 libraries are included on the command line to the linker.
28521 @item %G
28522 Process the @code{libgcc} spec.  This is a spec string for deciding
28523 which GCC support library is included on the command line to the linker.
28525 @item %S
28526 Process the @code{startfile} spec.  This is a spec for deciding which
28527 object files are the first ones passed to the linker.  Typically
28528 this might be a file named @file{crt0.o}.
28530 @item %E
28531 Process the @code{endfile} spec.  This is a spec string that specifies
28532 the last object files that are passed to the linker.
28534 @item %C
28535 Process the @code{cpp} spec.  This is used to construct the arguments
28536 to be passed to the C preprocessor.
28538 @item %1
28539 Process the @code{cc1} spec.  This is used to construct the options to be
28540 passed to the actual C compiler (@command{cc1}).
28542 @item %2
28543 Process the @code{cc1plus} spec.  This is used to construct the options to be
28544 passed to the actual C++ compiler (@command{cc1plus}).
28546 @item %*
28547 Substitute the variable part of a matched option.  See below.
28548 Note that each comma in the substituted string is replaced by
28549 a single space.
28551 @item %<S
28552 Remove all occurrences of @code{-S} from the command line.  Note---this
28553 command is position dependent.  @samp{%} commands in the spec string
28554 before this one see @code{-S}, @samp{%} commands in the spec string
28555 after this one do not.
28557 @item %:@var{function}(@var{args})
28558 Call the named function @var{function}, passing it @var{args}.
28559 @var{args} is first processed as a nested spec string, then split
28560 into an argument vector in the usual fashion.  The function returns
28561 a string which is processed as if it had appeared literally as part
28562 of the current spec.
28564 The following built-in spec functions are provided:
28566 @table @code
28567 @item @code{getenv}
28568 The @code{getenv} spec function takes two arguments: an environment
28569 variable name and a string.  If the environment variable is not
28570 defined, a fatal error is issued.  Otherwise, the return value is the
28571 value of the environment variable concatenated with the string.  For
28572 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
28574 @smallexample
28575 %:getenv(TOPDIR /include)
28576 @end smallexample
28578 expands to @file{/path/to/top/include}.
28580 @item @code{if-exists}
28581 The @code{if-exists} spec function takes one argument, an absolute
28582 pathname to a file.  If the file exists, @code{if-exists} returns the
28583 pathname.  Here is a small example of its usage:
28585 @smallexample
28586 *startfile:
28587 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
28588 @end smallexample
28590 @item @code{if-exists-else}
28591 The @code{if-exists-else} spec function is similar to the @code{if-exists}
28592 spec function, except that it takes two arguments.  The first argument is
28593 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
28594 returns the pathname.  If it does not exist, it returns the second argument.
28595 This way, @code{if-exists-else} can be used to select one file or another,
28596 based on the existence of the first.  Here is a small example of its usage:
28598 @smallexample
28599 *startfile:
28600 crt0%O%s %:if-exists(crti%O%s) \
28601 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
28602 @end smallexample
28604 @item @code{replace-outfile}
28605 The @code{replace-outfile} spec function takes two arguments.  It looks for the
28606 first argument in the outfiles array and replaces it with the second argument.  Here
28607 is a small example of its usage:
28609 @smallexample
28610 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
28611 @end smallexample
28613 @item @code{remove-outfile}
28614 The @code{remove-outfile} spec function takes one argument.  It looks for the
28615 first argument in the outfiles array and removes it.  Here is a small example
28616 its usage:
28618 @smallexample
28619 %:remove-outfile(-lm)
28620 @end smallexample
28622 @item @code{pass-through-libs}
28623 The @code{pass-through-libs} spec function takes any number of arguments.  It
28624 finds any @option{-l} options and any non-options ending in @file{.a} (which it
28625 assumes are the names of linker input library archive files) and returns a
28626 result containing all the found arguments each prepended by
28627 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
28628 intended to be passed to the LTO linker plugin.
28630 @smallexample
28631 %:pass-through-libs(%G %L %G)
28632 @end smallexample
28634 @item @code{print-asm-header}
28635 The @code{print-asm-header} function takes no arguments and simply
28636 prints a banner like:
28638 @smallexample
28639 Assembler options
28640 =================
28642 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
28643 @end smallexample
28645 It is used to separate compiler options from assembler options
28646 in the @option{--target-help} output.
28647 @end table
28649 @item %@{S@}
28650 Substitutes the @code{-S} switch, if that switch is given to GCC@.
28651 If that switch is not specified, this substitutes nothing.  Note that
28652 the leading dash is omitted when specifying this option, and it is
28653 automatically inserted if the substitution is performed.  Thus the spec
28654 string @samp{%@{foo@}} matches the command-line option @option{-foo}
28655 and outputs the command-line option @option{-foo}.
28657 @item %W@{S@}
28658 Like %@{@code{S}@} but mark last argument supplied within as a file to be
28659 deleted on failure.
28661 @item %@{S*@}
28662 Substitutes all the switches specified to GCC whose names start
28663 with @code{-S}, but which also take an argument.  This is used for
28664 switches like @option{-o}, @option{-D}, @option{-I}, etc.
28665 GCC considers @option{-o foo} as being
28666 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
28667 text, including the space.  Thus two arguments are generated.
28669 @item %@{S*&T*@}
28670 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
28671 (the order of @code{S} and @code{T} in the spec is not significant).
28672 There can be any number of ampersand-separated variables; for each the
28673 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
28675 @item %@{S:X@}
28676 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
28678 @item %@{!S:X@}
28679 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
28681 @item %@{S*:X@}
28682 Substitutes @code{X} if one or more switches whose names start with
28683 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
28684 once, no matter how many such switches appeared.  However, if @code{%*}
28685 appears somewhere in @code{X}, then @code{X} is substituted once
28686 for each matching switch, with the @code{%*} replaced by the part of
28687 that switch matching the @code{*}.
28689 If @code{%*} appears as the last part of a spec sequence then a space
28690 is added after the end of the last substitution.  If there is more
28691 text in the sequence, however, then a space is not generated.  This
28692 allows the @code{%*} substitution to be used as part of a larger
28693 string.  For example, a spec string like this:
28695 @smallexample
28696 %@{mcu=*:--script=%*/memory.ld@}
28697 @end smallexample
28699 @noindent
28700 when matching an option like @option{-mcu=newchip} produces:
28702 @smallexample
28703 --script=newchip/memory.ld
28704 @end smallexample
28706 @item %@{.S:X@}
28707 Substitutes @code{X}, if processing a file with suffix @code{S}.
28709 @item %@{!.S:X@}
28710 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
28712 @item %@{,S:X@}
28713 Substitutes @code{X}, if processing a file for language @code{S}.
28715 @item %@{!,S:X@}
28716 Substitutes @code{X}, if not processing a file for language @code{S}.
28718 @item %@{S|P:X@}
28719 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
28720 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
28721 @code{*} sequences as well, although they have a stronger binding than
28722 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
28723 alternatives must be starred, and only the first matching alternative
28724 is substituted.
28726 For example, a spec string like this:
28728 @smallexample
28729 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
28730 @end smallexample
28732 @noindent
28733 outputs the following command-line options from the following input
28734 command-line options:
28736 @smallexample
28737 fred.c        -foo -baz
28738 jim.d         -bar -boggle
28739 -d fred.c     -foo -baz -boggle
28740 -d jim.d      -bar -baz -boggle
28741 @end smallexample
28743 @item %@{S:X; T:Y; :D@}
28745 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
28746 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
28747 be as many clauses as you need.  This may be combined with @code{.},
28748 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
28751 @end table
28753 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
28754 or similar construct can use a backslash to ignore the special meaning
28755 of the character following it, thus allowing literal matching of a
28756 character that is otherwise specially treated.  For example,
28757 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
28758 @option{-std=iso9899:1999} option is given.
28760 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
28761 construct may contain other nested @samp{%} constructs or spaces, or
28762 even newlines.  They are processed as usual, as described above.
28763 Trailing white space in @code{X} is ignored.  White space may also
28764 appear anywhere on the left side of the colon in these constructs,
28765 except between @code{.} or @code{*} and the corresponding word.
28767 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
28768 handled specifically in these constructs.  If another value of
28769 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
28770 @option{-W} switch is found later in the command line, the earlier
28771 switch value is ignored, except with @{@code{S}*@} where @code{S} is
28772 just one letter, which passes all matching options.
28774 The character @samp{|} at the beginning of the predicate text is used to
28775 indicate that a command should be piped to the following command, but
28776 only if @option{-pipe} is specified.
28778 It is built into GCC which switches take arguments and which do not.
28779 (You might think it would be useful to generalize this to allow each
28780 compiler's spec to say which switches take arguments.  But this cannot
28781 be done in a consistent fashion.  GCC cannot even decide which input
28782 files have been specified without knowing which switches take arguments,
28783 and it must know which input files to compile in order to tell which
28784 compilers to run).
28786 GCC also knows implicitly that arguments starting in @option{-l} are to be
28787 treated as compiler output files, and passed to the linker in their
28788 proper position among the other output files.
28790 @node Environment Variables
28791 @section Environment Variables Affecting GCC
28792 @cindex environment variables
28794 @c man begin ENVIRONMENT
28795 This section describes several environment variables that affect how GCC
28796 operates.  Some of them work by specifying directories or prefixes to use
28797 when searching for various kinds of files.  Some are used to specify other
28798 aspects of the compilation environment.
28800 Note that you can also specify places to search using options such as
28801 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
28802 take precedence over places specified using environment variables, which
28803 in turn take precedence over those specified by the configuration of GCC@.
28804 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
28805 GNU Compiler Collection (GCC) Internals}.
28807 @table @env
28808 @item LANG
28809 @itemx LC_CTYPE
28810 @c @itemx LC_COLLATE
28811 @itemx LC_MESSAGES
28812 @c @itemx LC_MONETARY
28813 @c @itemx LC_NUMERIC
28814 @c @itemx LC_TIME
28815 @itemx LC_ALL
28816 @findex LANG
28817 @findex LC_CTYPE
28818 @c @findex LC_COLLATE
28819 @findex LC_MESSAGES
28820 @c @findex LC_MONETARY
28821 @c @findex LC_NUMERIC
28822 @c @findex LC_TIME
28823 @findex LC_ALL
28824 @cindex locale
28825 These environment variables control the way that GCC uses
28826 localization information which allows GCC to work with different
28827 national conventions.  GCC inspects the locale categories
28828 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
28829 so.  These locale categories can be set to any value supported by your
28830 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
28831 Kingdom encoded in UTF-8.
28833 The @env{LC_CTYPE} environment variable specifies character
28834 classification.  GCC uses it to determine the character boundaries in
28835 a string; this is needed for some multibyte encodings that contain quote
28836 and escape characters that are otherwise interpreted as a string
28837 end or escape.
28839 The @env{LC_MESSAGES} environment variable specifies the language to
28840 use in diagnostic messages.
28842 If the @env{LC_ALL} environment variable is set, it overrides the value
28843 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
28844 and @env{LC_MESSAGES} default to the value of the @env{LANG}
28845 environment variable.  If none of these variables are set, GCC
28846 defaults to traditional C English behavior.
28848 @item TMPDIR
28849 @findex TMPDIR
28850 If @env{TMPDIR} is set, it specifies the directory to use for temporary
28851 files.  GCC uses temporary files to hold the output of one stage of
28852 compilation which is to be used as input to the next stage: for example,
28853 the output of the preprocessor, which is the input to the compiler
28854 proper.
28856 @item GCC_COMPARE_DEBUG
28857 @findex GCC_COMPARE_DEBUG
28858 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
28859 @option{-fcompare-debug} to the compiler driver.  See the documentation
28860 of this option for more details.
28862 @item GCC_EXEC_PREFIX
28863 @findex GCC_EXEC_PREFIX
28864 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
28865 names of the subprograms executed by the compiler.  No slash is added
28866 when this prefix is combined with the name of a subprogram, but you can
28867 specify a prefix that ends with a slash if you wish.
28869 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
28870 an appropriate prefix to use based on the pathname it is invoked with.
28872 If GCC cannot find the subprogram using the specified prefix, it
28873 tries looking in the usual places for the subprogram.
28875 The default value of @env{GCC_EXEC_PREFIX} is
28876 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
28877 the installed compiler. In many cases @var{prefix} is the value
28878 of @code{prefix} when you ran the @file{configure} script.
28880 Other prefixes specified with @option{-B} take precedence over this prefix.
28882 This prefix is also used for finding files such as @file{crt0.o} that are
28883 used for linking.
28885 In addition, the prefix is used in an unusual way in finding the
28886 directories to search for header files.  For each of the standard
28887 directories whose name normally begins with @samp{/usr/local/lib/gcc}
28888 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
28889 replacing that beginning with the specified prefix to produce an
28890 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
28891 @file{foo/bar} just before it searches the standard directory 
28892 @file{/usr/local/lib/bar}.
28893 If a standard directory begins with the configured
28894 @var{prefix} then the value of @var{prefix} is replaced by
28895 @env{GCC_EXEC_PREFIX} when looking for header files.
28897 @item COMPILER_PATH
28898 @findex COMPILER_PATH
28899 The value of @env{COMPILER_PATH} is a colon-separated list of
28900 directories, much like @env{PATH}.  GCC tries the directories thus
28901 specified when searching for subprograms, if it cannot find the
28902 subprograms using @env{GCC_EXEC_PREFIX}.
28904 @item LIBRARY_PATH
28905 @findex LIBRARY_PATH
28906 The value of @env{LIBRARY_PATH} is a colon-separated list of
28907 directories, much like @env{PATH}.  When configured as a native compiler,
28908 GCC tries the directories thus specified when searching for special
28909 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
28910 using GCC also uses these directories when searching for ordinary
28911 libraries for the @option{-l} option (but directories specified with
28912 @option{-L} come first).
28914 @item LANG
28915 @findex LANG
28916 @cindex locale definition
28917 This variable is used to pass locale information to the compiler.  One way in
28918 which this information is used is to determine the character set to be used
28919 when character literals, string literals and comments are parsed in C and C++.
28920 When the compiler is configured to allow multibyte characters,
28921 the following values for @env{LANG} are recognized:
28923 @table @samp
28924 @item C-JIS
28925 Recognize JIS characters.
28926 @item C-SJIS
28927 Recognize SJIS characters.
28928 @item C-EUCJP
28929 Recognize EUCJP characters.
28930 @end table
28932 If @env{LANG} is not defined, or if it has some other value, then the
28933 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
28934 recognize and translate multibyte characters.
28935 @end table
28937 @noindent
28938 Some additional environment variables affect the behavior of the
28939 preprocessor.
28941 @include cppenv.texi
28943 @c man end
28945 @node Precompiled Headers
28946 @section Using Precompiled Headers
28947 @cindex precompiled headers
28948 @cindex speed of compilation
28950 Often large projects have many header files that are included in every
28951 source file.  The time the compiler takes to process these header files
28952 over and over again can account for nearly all of the time required to
28953 build the project.  To make builds faster, GCC allows you to
28954 @dfn{precompile} a header file.
28956 To create a precompiled header file, simply compile it as you would any
28957 other file, if necessary using the @option{-x} option to make the driver
28958 treat it as a C or C++ header file.  You may want to use a
28959 tool like @command{make} to keep the precompiled header up-to-date when
28960 the headers it contains change.
28962 A precompiled header file is searched for when @code{#include} is
28963 seen in the compilation.  As it searches for the included file
28964 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
28965 compiler looks for a precompiled header in each directory just before it
28966 looks for the include file in that directory.  The name searched for is
28967 the name specified in the @code{#include} with @samp{.gch} appended.  If
28968 the precompiled header file cannot be used, it is ignored.
28970 For instance, if you have @code{#include "all.h"}, and you have
28971 @file{all.h.gch} in the same directory as @file{all.h}, then the
28972 precompiled header file is used if possible, and the original
28973 header is used otherwise.
28975 Alternatively, you might decide to put the precompiled header file in a
28976 directory and use @option{-I} to ensure that directory is searched
28977 before (or instead of) the directory containing the original header.
28978 Then, if you want to check that the precompiled header file is always
28979 used, you can put a file of the same name as the original header in this
28980 directory containing an @code{#error} command.
28982 This also works with @option{-include}.  So yet another way to use
28983 precompiled headers, good for projects not designed with precompiled
28984 header files in mind, is to simply take most of the header files used by
28985 a project, include them from another header file, precompile that header
28986 file, and @option{-include} the precompiled header.  If the header files
28987 have guards against multiple inclusion, they are skipped because
28988 they've already been included (in the precompiled header).
28990 If you need to precompile the same header file for different
28991 languages, targets, or compiler options, you can instead make a
28992 @emph{directory} named like @file{all.h.gch}, and put each precompiled
28993 header in the directory, perhaps using @option{-o}.  It doesn't matter
28994 what you call the files in the directory; every precompiled header in
28995 the directory is considered.  The first precompiled header
28996 encountered in the directory that is valid for this compilation is
28997 used; they're searched in no particular order.
28999 There are many other possibilities, limited only by your imagination,
29000 good sense, and the constraints of your build system.
29002 A precompiled header file can be used only when these conditions apply:
29004 @itemize
29005 @item
29006 Only one precompiled header can be used in a particular compilation.
29008 @item
29009 A precompiled header cannot be used once the first C token is seen.  You
29010 can have preprocessor directives before a precompiled header; you cannot
29011 include a precompiled header from inside another header.
29013 @item
29014 The precompiled header file must be produced for the same language as
29015 the current compilation.  You cannot use a C precompiled header for a C++
29016 compilation.
29018 @item
29019 The precompiled header file must have been produced by the same compiler
29020 binary as the current compilation is using.
29022 @item
29023 Any macros defined before the precompiled header is included must
29024 either be defined in the same way as when the precompiled header was
29025 generated, or must not affect the precompiled header, which usually
29026 means that they don't appear in the precompiled header at all.
29028 The @option{-D} option is one way to define a macro before a
29029 precompiled header is included; using a @code{#define} can also do it.
29030 There are also some options that define macros implicitly, like
29031 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
29032 defined this way.
29034 @item If debugging information is output when using the precompiled
29035 header, using @option{-g} or similar, the same kind of debugging information
29036 must have been output when building the precompiled header.  However,
29037 a precompiled header built using @option{-g} can be used in a compilation
29038 when no debugging information is being output.
29040 @item The same @option{-m} options must generally be used when building
29041 and using the precompiled header.  @xref{Submodel Options},
29042 for any cases where this rule is relaxed.
29044 @item Each of the following options must be the same when building and using
29045 the precompiled header:
29047 @gccoptlist{-fexceptions}
29049 @item
29050 Some other command-line options starting with @option{-f},
29051 @option{-p}, or @option{-O} must be defined in the same way as when
29052 the precompiled header was generated.  At present, it's not clear
29053 which options are safe to change and which are not; the safest choice
29054 is to use exactly the same options when generating and using the
29055 precompiled header.  The following are known to be safe:
29057 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
29058 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
29059 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
29060 -pedantic-errors}
29062 @end itemize
29064 For all of these except the last, the compiler automatically
29065 ignores the precompiled header if the conditions aren't met.  If you
29066 find an option combination that doesn't work and doesn't cause the
29067 precompiled header to be ignored, please consider filing a bug report,
29068 see @ref{Bugs}.
29070 If you do use differing options when generating and using the
29071 precompiled header, the actual behavior is a mixture of the
29072 behavior for the options.  For instance, if you use @option{-g} to
29073 generate the precompiled header but not when using it, you may or may
29074 not get debugging information for routines in the precompiled header.