* doc/invoke.texi (ARM Options): Use @item instead of @itemx
[official-gcc.git] / gcc / doc / invoke.texi
blob4a459280dea100a275cbbe5c6af52c7136d72e10
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 -mno-strict-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 prefetch-dynamic-strides
10738 Whether the loop array prefetch pass should issue software prefetch hints
10739 for strides that are non-constant.  In some cases this may be
10740 beneficial, though the fact the stride is non-constant may make it
10741 hard to predict when there is clear benefit to issuing these hints.
10743 Set to 1, the default, if the prefetch hints should be issued for non-constant
10744 strides.  Set to 0 if prefetch hints should be issued only for strides that
10745 are known to be constant and below @option{prefetch-minimum-stride}.
10747 @item prefetch-minimum-stride
10748 Minimum constant stride, in bytes, to start using prefetch hints for.  If
10749 the stride is less than this threshold, prefetch hints will not be issued.
10751 This setting is useful for processors that have hardware prefetchers, in
10752 which case there may be conflicts between the hardware prefetchers and
10753 the software prefetchers.  If the hardware prefetchers have a maximum
10754 stride they can handle, it should be used here to improve the use of
10755 software prefetchers.
10757 A value of -1, the default, means we don't have a threshold and therefore
10758 prefetch hints can be issued for any constant stride.
10760 This setting is only useful for strides that are known and constant.
10762 @item loop-interchange-max-num-stmts
10763 The maximum number of stmts in a loop to be interchanged.
10765 @item loop-interchange-stride-ratio
10766 The minimum ratio between stride of two loops for interchange to be profitable.
10768 @item min-insn-to-prefetch-ratio
10769 The minimum ratio between the number of instructions and the
10770 number of prefetches to enable prefetching in a loop.
10772 @item prefetch-min-insn-to-mem-ratio
10773 The minimum ratio between the number of instructions and the
10774 number of memory references to enable prefetching in a loop.
10776 @item use-canonical-types
10777 Whether the compiler should use the ``canonical'' type system.  By
10778 default, this should always be 1, which uses a more efficient internal
10779 mechanism for comparing types in C++ and Objective-C++.  However, if
10780 bugs in the canonical type system are causing compilation failures,
10781 set this value to 0 to disable canonical types.
10783 @item switch-conversion-max-branch-ratio
10784 Switch initialization conversion refuses to create arrays that are
10785 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10786 branches in the switch.
10788 @item max-partial-antic-length
10789 Maximum length of the partial antic set computed during the tree
10790 partial redundancy elimination optimization (@option{-ftree-pre}) when
10791 optimizing at @option{-O3} and above.  For some sorts of source code
10792 the enhanced partial redundancy elimination optimization can run away,
10793 consuming all of the memory available on the host machine.  This
10794 parameter sets a limit on the length of the sets that are computed,
10795 which prevents the runaway behavior.  Setting a value of 0 for
10796 this parameter allows an unlimited set length.
10798 @item sccvn-max-scc-size
10799 Maximum size of a strongly connected component (SCC) during SCCVN
10800 processing.  If this limit is hit, SCCVN processing for the whole
10801 function is not done and optimizations depending on it are
10802 disabled.  The default maximum SCC size is 10000.
10804 @item sccvn-max-alias-queries-per-access
10805 Maximum number of alias-oracle queries we perform when looking for
10806 redundancies for loads and stores.  If this limit is hit the search
10807 is aborted and the load or store is not considered redundant.  The
10808 number of queries is algorithmically limited to the number of
10809 stores on all paths from the load to the function entry.
10810 The default maximum number of queries is 1000.
10812 @item ira-max-loops-num
10813 IRA uses regional register allocation by default.  If a function
10814 contains more loops than the number given by this parameter, only at most
10815 the given number of the most frequently-executed loops form regions
10816 for regional register allocation.  The default value of the
10817 parameter is 100.
10819 @item ira-max-conflict-table-size 
10820 Although IRA uses a sophisticated algorithm to compress the conflict
10821 table, the table can still require excessive amounts of memory for
10822 huge functions.  If the conflict table for a function could be more
10823 than the size in MB given by this parameter, the register allocator
10824 instead uses a faster, simpler, and lower-quality
10825 algorithm that does not require building a pseudo-register conflict table.  
10826 The default value of the parameter is 2000.
10828 @item ira-loop-reserved-regs
10829 IRA can be used to evaluate more accurate register pressure in loops
10830 for decisions to move loop invariants (see @option{-O3}).  The number
10831 of available registers reserved for some other purposes is given
10832 by this parameter.  The default value of the parameter is 2, which is
10833 the minimal number of registers needed by typical instructions.
10834 This value is the best found from numerous experiments.
10836 @item lra-inheritance-ebb-probability-cutoff
10837 LRA tries to reuse values reloaded in registers in subsequent insns.
10838 This optimization is called inheritance.  EBB is used as a region to
10839 do this optimization.  The parameter defines a minimal fall-through
10840 edge probability in percentage used to add BB to inheritance EBB in
10841 LRA.  The default value of the parameter is 40.  The value was chosen
10842 from numerous runs of SPEC2000 on x86-64.
10844 @item loop-invariant-max-bbs-in-loop
10845 Loop invariant motion can be very expensive, both in compilation time and
10846 in amount of needed compile-time memory, with very large loops.  Loops
10847 with more basic blocks than this parameter won't have loop invariant
10848 motion optimization performed on them.  The default value of the
10849 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10851 @item loop-max-datarefs-for-datadeps
10852 Building data dependencies is expensive for very large loops.  This
10853 parameter limits the number of data references in loops that are
10854 considered for data dependence analysis.  These large loops are no
10855 handled by the optimizations using loop data dependencies.
10856 The default value is 1000.
10858 @item max-vartrack-size
10859 Sets a maximum number of hash table slots to use during variable
10860 tracking dataflow analysis of any function.  If this limit is exceeded
10861 with variable tracking at assignments enabled, analysis for that
10862 function is retried without it, after removing all debug insns from
10863 the function.  If the limit is exceeded even without debug insns, var
10864 tracking analysis is completely disabled for the function.  Setting
10865 the parameter to zero makes it unlimited.
10867 @item max-vartrack-expr-depth
10868 Sets a maximum number of recursion levels when attempting to map
10869 variable names or debug temporaries to value expressions.  This trades
10870 compilation time for more complete debug information.  If this is set too
10871 low, value expressions that are available and could be represented in
10872 debug information may end up not being used; setting this higher may
10873 enable the compiler to find more complex debug expressions, but compile
10874 time and memory use may grow.  The default is 12.
10876 @item max-debug-marker-count
10877 Sets a threshold on the number of debug markers (e.g. begin stmt
10878 markers) to avoid complexity explosion at inlining or expanding to RTL.
10879 If a function has more such gimple stmts than the set limit, such stmts
10880 will be dropped from the inlined copy of a function, and from its RTL
10881 expansion.  The default is 100000.
10883 @item min-nondebug-insn-uid
10884 Use uids starting at this parameter for nondebug insns.  The range below
10885 the parameter is reserved exclusively for debug insns created by
10886 @option{-fvar-tracking-assignments}, but debug insns may get
10887 (non-overlapping) uids above it if the reserved range is exhausted.
10889 @item ipa-sra-ptr-growth-factor
10890 IPA-SRA replaces a pointer to an aggregate with one or more new
10891 parameters only when their cumulative size is less or equal to
10892 @option{ipa-sra-ptr-growth-factor} times the size of the original
10893 pointer parameter.
10895 @item sra-max-scalarization-size-Ospeed
10896 @itemx sra-max-scalarization-size-Osize
10897 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10898 replace scalar parts of aggregates with uses of independent scalar
10899 variables.  These parameters control the maximum size, in storage units,
10900 of aggregate which is considered for replacement when compiling for
10901 speed
10902 (@option{sra-max-scalarization-size-Ospeed}) or size
10903 (@option{sra-max-scalarization-size-Osize}) respectively.
10905 @item tm-max-aggregate-size
10906 When making copies of thread-local variables in a transaction, this
10907 parameter specifies the size in bytes after which variables are
10908 saved with the logging functions as opposed to save/restore code
10909 sequence pairs.  This option only applies when using
10910 @option{-fgnu-tm}.
10912 @item graphite-max-nb-scop-params
10913 To avoid exponential effects in the Graphite loop transforms, the
10914 number of parameters in a Static Control Part (SCoP) is bounded.  The
10915 default value is 10 parameters, a value of zero can be used to lift
10916 the bound.  A variable whose value is unknown at compilation time and
10917 defined outside a SCoP is a parameter of the SCoP.
10919 @item loop-block-tile-size
10920 Loop blocking or strip mining transforms, enabled with
10921 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10922 loop in the loop nest by a given number of iterations.  The strip
10923 length can be changed using the @option{loop-block-tile-size}
10924 parameter.  The default value is 51 iterations.
10926 @item loop-unroll-jam-size
10927 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10928 default value is 4.
10930 @item loop-unroll-jam-depth
10931 Specify the dimension to be unrolled (counting from the most inner loop)
10932 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10934 @item ipa-cp-value-list-size
10935 IPA-CP attempts to track all possible values and types passed to a function's
10936 parameter in order to propagate them and perform devirtualization.
10937 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10938 stores per one formal parameter of a function.
10940 @item ipa-cp-eval-threshold
10941 IPA-CP calculates its own score of cloning profitability heuristics
10942 and performs those cloning opportunities with scores that exceed
10943 @option{ipa-cp-eval-threshold}.
10945 @item ipa-cp-recursion-penalty
10946 Percentage penalty the recursive functions will receive when they
10947 are evaluated for cloning.
10949 @item ipa-cp-single-call-penalty
10950 Percentage penalty functions containing a single call to another
10951 function will receive when they are evaluated for cloning.
10954 @item ipa-max-agg-items
10955 IPA-CP is also capable to propagate a number of scalar values passed
10956 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10957 number of such values per one parameter.
10959 @item ipa-cp-loop-hint-bonus
10960 When IPA-CP determines that a cloning candidate would make the number
10961 of iterations of a loop known, it adds a bonus of
10962 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10963 the candidate.
10965 @item ipa-cp-array-index-hint-bonus
10966 When IPA-CP determines that a cloning candidate would make the index of
10967 an array access known, it adds a bonus of
10968 @option{ipa-cp-array-index-hint-bonus} to the profitability
10969 score of the candidate.
10971 @item ipa-max-aa-steps
10972 During its analysis of function bodies, IPA-CP employs alias analysis
10973 in order to track values pointed to by function parameters.  In order
10974 not spend too much time analyzing huge functions, it gives up and
10975 consider all memory clobbered after examining
10976 @option{ipa-max-aa-steps} statements modifying memory.
10978 @item lto-partitions
10979 Specify desired number of partitions produced during WHOPR compilation.
10980 The number of partitions should exceed the number of CPUs used for compilation.
10981 The default value is 32.
10983 @item lto-min-partition
10984 Size of minimal partition for WHOPR (in estimated instructions).
10985 This prevents expenses of splitting very small programs into too many
10986 partitions.
10988 @item lto-max-partition
10989 Size of max partition for WHOPR (in estimated instructions).
10990 to provide an upper bound for individual size of partition.
10991 Meant to be used only with balanced partitioning.
10993 @item cxx-max-namespaces-for-diagnostic-help
10994 The maximum number of namespaces to consult for suggestions when C++
10995 name lookup fails for an identifier.  The default is 1000.
10997 @item sink-frequency-threshold
10998 The maximum relative execution frequency (in percents) of the target block
10999 relative to a statement's original block to allow statement sinking of a
11000 statement.  Larger numbers result in more aggressive statement sinking.
11001 The default value is 75.  A small positive adjustment is applied for
11002 statements with memory operands as those are even more profitable so sink.
11004 @item max-stores-to-sink
11005 The maximum number of conditional store pairs that can be sunk.  Set to 0
11006 if either vectorization (@option{-ftree-vectorize}) or if-conversion
11007 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
11009 @item allow-store-data-races
11010 Allow optimizers to introduce new data races on stores.
11011 Set to 1 to allow, otherwise to 0.  This option is enabled by default
11012 at optimization level @option{-Ofast}.
11014 @item case-values-threshold
11015 The smallest number of different values for which it is best to use a
11016 jump-table instead of a tree of conditional branches.  If the value is
11017 0, use the default for the machine.  The default is 0.
11019 @item tree-reassoc-width
11020 Set the maximum number of instructions executed in parallel in
11021 reassociated tree. This parameter overrides target dependent
11022 heuristics used by default if has non zero value.
11024 @item sched-pressure-algorithm
11025 Choose between the two available implementations of
11026 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
11027 and is the more likely to prevent instructions from being reordered.
11028 Algorithm 2 was designed to be a compromise between the relatively
11029 conservative approach taken by algorithm 1 and the rather aggressive
11030 approach taken by the default scheduler.  It relies more heavily on
11031 having a regular register file and accurate register pressure classes.
11032 See @file{haifa-sched.c} in the GCC sources for more details.
11034 The default choice depends on the target.
11036 @item max-slsr-cand-scan
11037 Set the maximum number of existing candidates that are considered when
11038 seeking a basis for a new straight-line strength reduction candidate.
11040 @item asan-globals
11041 Enable buffer overflow detection for global objects.  This kind
11042 of protection is enabled by default if you are using
11043 @option{-fsanitize=address} option.
11044 To disable global objects protection use @option{--param asan-globals=0}.
11046 @item asan-stack
11047 Enable buffer overflow detection for stack objects.  This kind of
11048 protection is enabled by default when using @option{-fsanitize=address}.
11049 To disable stack protection use @option{--param asan-stack=0} option.
11051 @item asan-instrument-reads
11052 Enable buffer overflow detection for memory reads.  This kind of
11053 protection is enabled by default when using @option{-fsanitize=address}.
11054 To disable memory reads protection use
11055 @option{--param asan-instrument-reads=0}.
11057 @item asan-instrument-writes
11058 Enable buffer overflow detection for memory writes.  This kind of
11059 protection is enabled by default when using @option{-fsanitize=address}.
11060 To disable memory writes protection use
11061 @option{--param asan-instrument-writes=0} option.
11063 @item asan-memintrin
11064 Enable detection for built-in functions.  This kind of protection
11065 is enabled by default when using @option{-fsanitize=address}.
11066 To disable built-in functions protection use
11067 @option{--param asan-memintrin=0}.
11069 @item asan-use-after-return
11070 Enable detection of use-after-return.  This kind of protection
11071 is enabled by default when using the @option{-fsanitize=address} option.
11072 To disable it use @option{--param asan-use-after-return=0}.
11074 Note: By default the check is disabled at run time.  To enable it,
11075 add @code{detect_stack_use_after_return=1} to the environment variable
11076 @env{ASAN_OPTIONS}.
11078 @item asan-instrumentation-with-call-threshold
11079 If number of memory accesses in function being instrumented
11080 is greater or equal to this number, use callbacks instead of inline checks.
11081 E.g. to disable inline code use
11082 @option{--param asan-instrumentation-with-call-threshold=0}.
11084 @item use-after-scope-direct-emission-threshold
11085 If the size of a local variable in bytes is smaller or equal to this
11086 number, directly poison (or unpoison) shadow memory instead of using
11087 run-time callbacks.  The default value is 256.
11089 @item chkp-max-ctor-size
11090 Static constructors generated by Pointer Bounds Checker may become very
11091 large and significantly increase compile time at optimization level
11092 @option{-O1} and higher.  This parameter is a maximum number of statements
11093 in a single generated constructor.  Default value is 5000.
11095 @item max-fsm-thread-path-insns
11096 Maximum number of instructions to copy when duplicating blocks on a
11097 finite state automaton jump thread path.  The default is 100.
11099 @item max-fsm-thread-length
11100 Maximum number of basic blocks on a finite state automaton jump thread
11101 path.  The default is 10.
11103 @item max-fsm-thread-paths
11104 Maximum number of new jump thread paths to create for a finite state
11105 automaton.  The default is 50.
11107 @item parloops-chunk-size
11108 Chunk size of omp schedule for loops parallelized by parloops.  The default
11109 is 0.
11111 @item parloops-schedule
11112 Schedule type of omp schedule for loops parallelized by parloops (static,
11113 dynamic, guided, auto, runtime).  The default is static.
11115 @item parloops-min-per-thread
11116 The minimum number of iterations per thread of an innermost parallelized
11117 loop for which the parallelized variant is prefered over the single threaded
11118 one.  The default is 100.  Note that for a parallelized loop nest the
11119 minimum number of iterations of the outermost loop per thread is two.
11121 @item max-ssa-name-query-depth
11122 Maximum depth of recursion when querying properties of SSA names in things
11123 like fold routines.  One level of recursion corresponds to following a
11124 use-def chain.
11126 @item hsa-gen-debug-stores
11127 Enable emission of special debug stores within HSA kernels which are
11128 then read and reported by libgomp plugin.  Generation of these stores
11129 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
11130 enable it.
11132 @item max-speculative-devirt-maydefs
11133 The maximum number of may-defs we analyze when looking for a must-def
11134 specifying the dynamic type of an object that invokes a virtual call
11135 we may be able to devirtualize speculatively.
11137 @item max-vrp-switch-assertions
11138 The maximum number of assertions to add along the default edge of a switch
11139 statement during VRP.  The default is 10.
11141 @item unroll-jam-min-percent
11142 The minimum percentage of memory references that must be optimized
11143 away for the unroll-and-jam transformation to be considered profitable.
11145 @item unroll-jam-max-unroll
11146 The maximum number of times the outer loop should be unrolled by
11147 the unroll-and-jam transformation.
11148 @end table
11149 @end table
11151 @node Instrumentation Options
11152 @section Program Instrumentation Options
11153 @cindex instrumentation options
11154 @cindex program instrumentation options
11155 @cindex run-time error checking options
11156 @cindex profiling options
11157 @cindex options, program instrumentation
11158 @cindex options, run-time error checking
11159 @cindex options, profiling
11161 GCC supports a number of command-line options that control adding
11162 run-time instrumentation to the code it normally generates.  
11163 For example, one purpose of instrumentation is collect profiling
11164 statistics for use in finding program hot spots, code coverage
11165 analysis, or profile-guided optimizations.
11166 Another class of program instrumentation is adding run-time checking 
11167 to detect programming errors like invalid pointer
11168 dereferences or out-of-bounds array accesses, as well as deliberately
11169 hostile attacks such as stack smashing or C++ vtable hijacking.
11170 There is also a general hook which can be used to implement other
11171 forms of tracing or function-level instrumentation for debug or
11172 program analysis purposes.
11174 @table @gcctabopt
11175 @cindex @command{prof}
11176 @item -p
11177 @opindex p
11178 Generate extra code to write profile information suitable for the
11179 analysis program @command{prof}.  You must use this option when compiling
11180 the source files you want data about, and you must also use it when
11181 linking.
11183 @cindex @command{gprof}
11184 @item -pg
11185 @opindex pg
11186 Generate extra code to write profile information suitable for the
11187 analysis program @command{gprof}.  You must use this option when compiling
11188 the source files you want data about, and you must also use it when
11189 linking.
11191 @item -fprofile-arcs
11192 @opindex fprofile-arcs
11193 Add code so that program flow @dfn{arcs} are instrumented.  During
11194 execution the program records how many times each branch and call is
11195 executed and how many times it is taken or returns.  On targets that support
11196 constructors with priority support, profiling properly handles constructors,
11197 destructors and C++ constructors (and destructors) of classes which are used
11198 as a type of a global variable.
11200 When the compiled
11201 program exits it saves this data to a file called
11202 @file{@var{auxname}.gcda} for each source file.  The data may be used for
11203 profile-directed optimizations (@option{-fbranch-probabilities}), or for
11204 test coverage analysis (@option{-ftest-coverage}).  Each object file's
11205 @var{auxname} is generated from the name of the output file, if
11206 explicitly specified and it is not the final executable, otherwise it is
11207 the basename of the source file.  In both cases any suffix is removed
11208 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
11209 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
11210 @xref{Cross-profiling}.
11212 @cindex @command{gcov}
11213 @item --coverage
11214 @opindex coverage
11216 This option is used to compile and link code instrumented for coverage
11217 analysis.  The option is a synonym for @option{-fprofile-arcs}
11218 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11219 linking).  See the documentation for those options for more details.
11221 @itemize
11223 @item
11224 Compile the source files with @option{-fprofile-arcs} plus optimization
11225 and code generation options.  For test coverage analysis, use the
11226 additional @option{-ftest-coverage} option.  You do not need to profile
11227 every source file in a program.
11229 @item
11230 Compile the source files additionally with @option{-fprofile-abs-path}
11231 to create absolute path names in the @file{.gcno} files.  This allows
11232 @command{gcov} to find the correct sources in projects where compilations
11233 occur with different working directories.
11235 @item
11236 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11237 (the latter implies the former).
11239 @item
11240 Run the program on a representative workload to generate the arc profile
11241 information.  This may be repeated any number of times.  You can run
11242 concurrent instances of your program, and provided that the file system
11243 supports locking, the data files will be correctly updated.  Unless
11244 a strict ISO C dialect option is in effect, @code{fork} calls are
11245 detected and correctly handled without double counting.
11247 @item
11248 For profile-directed optimizations, compile the source files again with
11249 the same optimization and code generation options plus
11250 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11251 Control Optimization}).
11253 @item
11254 For test coverage analysis, use @command{gcov} to produce human readable
11255 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11256 @command{gcov} documentation for further information.
11258 @end itemize
11260 With @option{-fprofile-arcs}, for each function of your program GCC
11261 creates a program flow graph, then finds a spanning tree for the graph.
11262 Only arcs that are not on the spanning tree have to be instrumented: the
11263 compiler adds code to count the number of times that these arcs are
11264 executed.  When an arc is the only exit or only entrance to a block, the
11265 instrumentation code can be added to the block; otherwise, a new basic
11266 block must be created to hold the instrumentation code.
11268 @need 2000
11269 @item -ftest-coverage
11270 @opindex ftest-coverage
11271 Produce a notes file that the @command{gcov} code-coverage utility
11272 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11273 show program coverage.  Each source file's note file is called
11274 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11275 above for a description of @var{auxname} and instructions on how to
11276 generate test coverage data.  Coverage data matches the source files
11277 more closely if you do not optimize.
11279 @item -fprofile-abs-path
11280 @opindex fprofile-abs-path
11281 Automatically convert relative source file names to absolute path names
11282 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11283 sources in projects where compilations occur with different working
11284 directories.
11286 @item -fprofile-dir=@var{path}
11287 @opindex fprofile-dir
11289 Set the directory to search for the profile data files in to @var{path}.
11290 This option affects only the profile data generated by
11291 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11292 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11293 and its related options.  Both absolute and relative paths can be used.
11294 By default, GCC uses the current directory as @var{path}, thus the
11295 profile data file appears in the same directory as the object file.
11297 @item -fprofile-generate
11298 @itemx -fprofile-generate=@var{path}
11299 @opindex fprofile-generate
11301 Enable options usually used for instrumenting application to produce
11302 profile useful for later recompilation with profile feedback based
11303 optimization.  You must use @option{-fprofile-generate} both when
11304 compiling and when linking your program.
11306 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11308 If @var{path} is specified, GCC looks at the @var{path} to find
11309 the profile feedback data files. See @option{-fprofile-dir}.
11311 To optimize the program based on the collected profile information, use
11312 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11314 @item -fprofile-update=@var{method}
11315 @opindex fprofile-update
11317 Alter the update method for an application instrumented for profile
11318 feedback based optimization.  The @var{method} argument should be one of
11319 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11320 The first one is useful for single-threaded applications,
11321 while the second one prevents profile corruption by emitting thread-safe code.
11323 @strong{Warning:} When an application does not properly join all threads
11324 (or creates an detached thread), a profile file can be still corrupted.
11326 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11327 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11328 automatically selects @samp{prefer-atomic} when @option{-pthread}
11329 is present in the command line.
11331 @item -fsanitize=address
11332 @opindex fsanitize=address
11333 Enable AddressSanitizer, a fast memory error detector.
11334 Memory access instructions are instrumented to detect
11335 out-of-bounds and use-after-free bugs.
11336 The option enables @option{-fsanitize-address-use-after-scope}.
11337 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11338 more details.  The run-time behavior can be influenced using the
11339 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11340 the available options are shown at startup of the instrumented program.  See
11341 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11342 for a list of supported options.
11343 The option cannot be combined with @option{-fsanitize=thread}
11344 and/or @option{-fcheck-pointer-bounds}.
11346 @item -fsanitize=kernel-address
11347 @opindex fsanitize=kernel-address
11348 Enable AddressSanitizer for Linux kernel.
11349 See @uref{https://github.com/google/kasan/wiki} for more details.
11350 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11352 @item -fsanitize=pointer-compare
11353 @opindex fsanitize=pointer-compare
11354 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11355 The option must be combined with either @option{-fsanitize=kernel-address} or
11356 @option{-fsanitize=address}
11357 The option cannot be combined with @option{-fsanitize=thread}
11358 and/or @option{-fcheck-pointer-bounds}.
11359 Note: By default the check is disabled at run time.  To enable it,
11360 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11361 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11362 invalid operation only when both pointers are non-null.
11364 @item -fsanitize=pointer-subtract
11365 @opindex fsanitize=pointer-subtract
11366 Instrument subtraction with pointer operands.
11367 The option must be combined with either @option{-fsanitize=kernel-address} or
11368 @option{-fsanitize=address}
11369 The option cannot be combined with @option{-fsanitize=thread}
11370 and/or @option{-fcheck-pointer-bounds}.
11371 Note: By default the check is disabled at run time.  To enable it,
11372 add @code{detect_invalid_pointer_pairs=2} to the environment variable
11373 @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects
11374 invalid operation only when both pointers are non-null.
11376 @item -fsanitize=thread
11377 @opindex fsanitize=thread
11378 Enable ThreadSanitizer, a fast data race detector.
11379 Memory access instructions are instrumented to detect
11380 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11381 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11382 environment variable; see
11383 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11384 supported options.
11385 The option cannot be combined with @option{-fsanitize=address},
11386 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11388 Note that sanitized atomic builtins cannot throw exceptions when
11389 operating on invalid memory addresses with non-call exceptions
11390 (@option{-fnon-call-exceptions}).
11392 @item -fsanitize=leak
11393 @opindex fsanitize=leak
11394 Enable LeakSanitizer, a memory leak detector.
11395 This option only matters for linking of executables and
11396 the executable is linked against a library that overrides @code{malloc}
11397 and other allocator functions.  See
11398 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11399 details.  The run-time behavior can be influenced using the
11400 @env{LSAN_OPTIONS} environment variable.
11401 The option cannot be combined with @option{-fsanitize=thread}.
11403 @item -fsanitize=undefined
11404 @opindex fsanitize=undefined
11405 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11406 Various computations are instrumented to detect undefined behavior
11407 at runtime.  Current suboptions are:
11409 @table @gcctabopt
11411 @item -fsanitize=shift
11412 @opindex fsanitize=shift
11413 This option enables checking that the result of a shift operation is
11414 not undefined.  Note that what exactly is considered undefined differs
11415 slightly between C and C++, as well as between ISO C90 and C99, etc.
11416 This option has two suboptions, @option{-fsanitize=shift-base} and
11417 @option{-fsanitize=shift-exponent}.
11419 @item -fsanitize=shift-exponent
11420 @opindex fsanitize=shift-exponent
11421 This option enables checking that the second argument of a shift operation
11422 is not negative and is smaller than the precision of the promoted first
11423 argument.
11425 @item -fsanitize=shift-base
11426 @opindex fsanitize=shift-base
11427 If the second argument of a shift operation is within range, check that the
11428 result of a shift operation is not undefined.  Note that what exactly is
11429 considered undefined differs slightly between C and C++, as well as between
11430 ISO C90 and C99, etc.
11432 @item -fsanitize=integer-divide-by-zero
11433 @opindex fsanitize=integer-divide-by-zero
11434 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11436 @item -fsanitize=unreachable
11437 @opindex fsanitize=unreachable
11438 With this option, the compiler turns the @code{__builtin_unreachable}
11439 call into a diagnostics message call instead.  When reaching the
11440 @code{__builtin_unreachable} call, the behavior is undefined.
11442 @item -fsanitize=vla-bound
11443 @opindex fsanitize=vla-bound
11444 This option instructs the compiler to check that the size of a variable
11445 length array is positive.
11447 @item -fsanitize=null
11448 @opindex fsanitize=null
11449 This option enables pointer checking.  Particularly, the application
11450 built with this option turned on will issue an error message when it
11451 tries to dereference a NULL pointer, or if a reference (possibly an
11452 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11453 on an object pointed by a NULL pointer.
11455 @item -fsanitize=return
11456 @opindex fsanitize=return
11457 This option enables return statement checking.  Programs
11458 built with this option turned on will issue an error message
11459 when the end of a non-void function is reached without actually
11460 returning a value.  This option works in C++ only.
11462 @item -fsanitize=signed-integer-overflow
11463 @opindex fsanitize=signed-integer-overflow
11464 This option enables signed integer overflow checking.  We check that
11465 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11466 does not overflow in the signed arithmetics.  Note, integer promotion
11467 rules must be taken into account.  That is, the following is not an
11468 overflow:
11469 @smallexample
11470 signed char a = SCHAR_MAX;
11471 a++;
11472 @end smallexample
11474 @item -fsanitize=bounds
11475 @opindex fsanitize=bounds
11476 This option enables instrumentation of array bounds.  Various out of bounds
11477 accesses are detected.  Flexible array members, flexible array member-like
11478 arrays, and initializers of variables with static storage are not instrumented.
11479 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11481 @item -fsanitize=bounds-strict
11482 @opindex fsanitize=bounds-strict
11483 This option enables strict instrumentation of array bounds.  Most out of bounds
11484 accesses are detected, including flexible array members and flexible array
11485 member-like arrays.  Initializers of variables with static storage are not
11486 instrumented.  The option cannot be combined
11487 with @option{-fcheck-pointer-bounds}.
11489 @item -fsanitize=alignment
11490 @opindex fsanitize=alignment
11492 This option enables checking of alignment of pointers when they are
11493 dereferenced, or when a reference is bound to insufficiently aligned target,
11494 or when a method or constructor is invoked on insufficiently aligned object.
11496 @item -fsanitize=object-size
11497 @opindex fsanitize=object-size
11498 This option enables instrumentation of memory references using the
11499 @code{__builtin_object_size} function.  Various out of bounds pointer
11500 accesses are detected.
11502 @item -fsanitize=float-divide-by-zero
11503 @opindex fsanitize=float-divide-by-zero
11504 Detect floating-point division by zero.  Unlike other similar options,
11505 @option{-fsanitize=float-divide-by-zero} is not enabled by
11506 @option{-fsanitize=undefined}, since floating-point division by zero can
11507 be a legitimate way of obtaining infinities and NaNs.
11509 @item -fsanitize=float-cast-overflow
11510 @opindex fsanitize=float-cast-overflow
11511 This option enables floating-point type to integer conversion checking.
11512 We check that the result of the conversion does not overflow.
11513 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11514 not enabled by @option{-fsanitize=undefined}.
11515 This option does not work well with @code{FE_INVALID} exceptions enabled.
11517 @item -fsanitize=nonnull-attribute
11518 @opindex fsanitize=nonnull-attribute
11520 This option enables instrumentation of calls, checking whether null values
11521 are not passed to arguments marked as requiring a non-null value by the
11522 @code{nonnull} function attribute.
11524 @item -fsanitize=returns-nonnull-attribute
11525 @opindex fsanitize=returns-nonnull-attribute
11527 This option enables instrumentation of return statements in functions
11528 marked with @code{returns_nonnull} function attribute, to detect returning
11529 of null values from such functions.
11531 @item -fsanitize=bool
11532 @opindex fsanitize=bool
11534 This option enables instrumentation of loads from bool.  If a value other
11535 than 0/1 is loaded, a run-time error is issued.
11537 @item -fsanitize=enum
11538 @opindex fsanitize=enum
11540 This option enables instrumentation of loads from an enum type.  If
11541 a value outside the range of values for the enum type is loaded,
11542 a run-time error is issued.
11544 @item -fsanitize=vptr
11545 @opindex fsanitize=vptr
11547 This option enables instrumentation of C++ member function calls, member
11548 accesses and some conversions between pointers to base and derived classes,
11549 to verify the referenced object has the correct dynamic type.
11551 @item -fsanitize=pointer-overflow
11552 @opindex fsanitize=pointer-overflow
11554 This option enables instrumentation of pointer arithmetics.  If the pointer
11555 arithmetics overflows, a run-time error is issued.
11557 @item -fsanitize=builtin
11558 @opindex fsanitize=builtin
11560 This option enables instrumentation of arguments to selected builtin
11561 functions.  If an invalid value is passed to such arguments, a run-time
11562 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11563 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11564 by this option.
11566 @end table
11568 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11569 @option{-fsanitize=undefined} gives a diagnostic message.
11570 This currently works only for the C family of languages.
11572 @item -fno-sanitize=all
11573 @opindex fno-sanitize=all
11575 This option disables all previously enabled sanitizers.
11576 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11577 together.
11579 @item -fasan-shadow-offset=@var{number}
11580 @opindex fasan-shadow-offset
11581 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11582 It is useful for experimenting with different shadow memory layouts in
11583 Kernel AddressSanitizer.
11585 @item -fsanitize-sections=@var{s1},@var{s2},...
11586 @opindex fsanitize-sections
11587 Sanitize global variables in selected user-defined sections.  @var{si} may
11588 contain wildcards.
11590 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11591 @opindex fsanitize-recover
11592 @opindex fno-sanitize-recover
11593 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11594 mentioned in comma-separated list of @var{opts}.  Enabling this option
11595 for a sanitizer component causes it to attempt to continue
11596 running the program as if no error happened.  This means multiple
11597 runtime errors can be reported in a single program run, and the exit
11598 code of the program may indicate success even when errors
11599 have been reported.  The @option{-fno-sanitize-recover=} option
11600 can be used to alter
11601 this behavior: only the first detected error is reported
11602 and program then exits with a non-zero exit code.
11604 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11605 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11606 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11607 @option{-fsanitize=bounds-strict},
11608 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11609 For these sanitizers error recovery is turned on by default,
11610 except @option{-fsanitize=address}, for which this feature is experimental.
11611 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11612 accepted, the former enables recovery for all sanitizers that support it,
11613 the latter disables recovery for all sanitizers that support it.
11615 Even if a recovery mode is turned on the compiler side, it needs to be also
11616 enabled on the runtime library side, otherwise the failures are still fatal.
11617 The runtime library defaults to @code{halt_on_error=0} for
11618 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11619 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11620 setting the @code{halt_on_error} flag in the corresponding environment variable.
11622 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11623 equivalent to specifying an @var{opts} list of:
11625 @smallexample
11626 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11627 @end smallexample
11629 @item -fsanitize-address-use-after-scope
11630 @opindex fsanitize-address-use-after-scope
11631 Enable sanitization of local variables to detect use-after-scope bugs.
11632 The option sets @option{-fstack-reuse} to @samp{none}.
11634 @item -fsanitize-undefined-trap-on-error
11635 @opindex fsanitize-undefined-trap-on-error
11636 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11637 report undefined behavior using @code{__builtin_trap} rather than
11638 a @code{libubsan} library routine.  The advantage of this is that the
11639 @code{libubsan} library is not needed and is not linked in, so this
11640 is usable even in freestanding environments.
11642 @item -fsanitize-coverage=trace-pc
11643 @opindex fsanitize-coverage=trace-pc
11644 Enable coverage-guided fuzzing code instrumentation.
11645 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11647 @item -fsanitize-coverage=trace-cmp
11648 @opindex fsanitize-coverage=trace-cmp
11649 Enable dataflow guided fuzzing code instrumentation.
11650 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11651 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11652 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11653 variable or @code{__sanitizer_cov_trace_const_cmp1},
11654 @code{__sanitizer_cov_trace_const_cmp2},
11655 @code{__sanitizer_cov_trace_const_cmp4} or
11656 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11657 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11658 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11659 @code{__sanitizer_cov_trace_switch} for switch statements.
11661 @item -fbounds-check
11662 @opindex fbounds-check
11663 For front ends that support it, generate additional code to check that
11664 indices used to access arrays are within the declared range.  This is
11665 currently only supported by the Fortran front end, where this option
11666 defaults to false.
11668 @item -fcheck-pointer-bounds
11669 @opindex fcheck-pointer-bounds
11670 @opindex fno-check-pointer-bounds
11671 @cindex Pointer Bounds Checker options
11672 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11673 is instrumented with checks of the pointer used for memory access against
11674 bounds associated with that pointer.  
11676 Currently there
11677 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11678 and @option{-mmpx} are required to enable this feature.  
11679 MPX-based instrumentation requires
11680 a runtime library to enable MPX in hardware and handle bounds
11681 violation signals.  By default when @option{-fcheck-pointer-bounds}
11682 and @option{-mmpx} options are used to link a program, the GCC driver
11683 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11684 Bounds checking on calls to dynamic libraries requires a linker
11685 with @option{-z bndplt} support; if GCC was configured with a linker
11686 without support for this option (including the Gold linker and older
11687 versions of ld), a warning is given if you link with @option{-mmpx}
11688 without also specifying @option{-static}, since the overall effectiveness
11689 of the bounds checking protection is reduced.
11690 See also @option{-static-libmpxwrappers}.
11692 MPX-based instrumentation
11693 may be used for debugging and also may be included in production code
11694 to increase program security.  Depending on usage, you may
11695 have different requirements for the runtime library.  The current version
11696 of the MPX runtime library is more oriented for use as a debugging
11697 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11698 also @option{-static-libmpx}.  The runtime library  behavior can be
11699 influenced using various @env{CHKP_RT_*} environment variables.  See
11700 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11701 for more details.
11703 Generated instrumentation may be controlled by various
11704 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11705 structure field attribute (@pxref{Type Attributes}) and
11706 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11707 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11708 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11709 Bounds Checker builtins}, for more information.
11711 @item -fchkp-check-incomplete-type
11712 @opindex fchkp-check-incomplete-type
11713 @opindex fno-chkp-check-incomplete-type
11714 Generate pointer bounds checks for variables with incomplete type.
11715 Enabled by default.
11717 @item -fchkp-narrow-bounds
11718 @opindex fchkp-narrow-bounds
11719 @opindex fno-chkp-narrow-bounds
11720 Controls bounds used by Pointer Bounds Checker for pointers to object
11721 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11722 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11723 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11725 @item -fchkp-first-field-has-own-bounds
11726 @opindex fchkp-first-field-has-own-bounds
11727 @opindex fno-chkp-first-field-has-own-bounds
11728 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11729 first field in the structure.  By default a pointer to the first field has
11730 the same bounds as a pointer to the whole structure.
11732 @item -fchkp-flexible-struct-trailing-arrays
11733 @opindex fchkp-flexible-struct-trailing-arrays
11734 @opindex fno-chkp-flexible-struct-trailing-arrays
11735 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11736 possibly flexible.  By default only array fields with zero length or that are
11737 marked with attribute bnd_variable_size are treated as flexible.
11739 @item -fchkp-narrow-to-innermost-array
11740 @opindex fchkp-narrow-to-innermost-array
11741 @opindex fno-chkp-narrow-to-innermost-array
11742 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11743 case of nested static array access.  By default this option is disabled and
11744 bounds of the outermost array are used.
11746 @item -fchkp-optimize
11747 @opindex fchkp-optimize
11748 @opindex fno-chkp-optimize
11749 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11750 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11752 @item -fchkp-use-fast-string-functions
11753 @opindex fchkp-use-fast-string-functions
11754 @opindex fno-chkp-use-fast-string-functions
11755 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11756 by Pointer Bounds Checker.  Disabled by default.
11758 @item -fchkp-use-nochk-string-functions
11759 @opindex fchkp-use-nochk-string-functions
11760 @opindex fno-chkp-use-nochk-string-functions
11761 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11762 by Pointer Bounds Checker.  Disabled by default.
11764 @item -fchkp-use-static-bounds
11765 @opindex fchkp-use-static-bounds
11766 @opindex fno-chkp-use-static-bounds
11767 Allow Pointer Bounds Checker to generate static bounds holding
11768 bounds of static variables.  Enabled by default.
11770 @item -fchkp-use-static-const-bounds
11771 @opindex fchkp-use-static-const-bounds
11772 @opindex fno-chkp-use-static-const-bounds
11773 Use statically-initialized bounds for constant bounds instead of
11774 generating them each time they are required.  By default enabled when
11775 @option{-fchkp-use-static-bounds} is enabled.
11777 @item -fchkp-treat-zero-dynamic-size-as-infinite
11778 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11779 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11780 With this option, objects with incomplete type whose
11781 dynamically-obtained size is zero are treated as having infinite size
11782 instead by Pointer Bounds
11783 Checker.  This option may be helpful if a program is linked with a library
11784 missing size information for some symbols.  Disabled by default.
11786 @item -fchkp-check-read
11787 @opindex fchkp-check-read
11788 @opindex fno-chkp-check-read
11789 Instructs Pointer Bounds Checker to generate checks for all read
11790 accesses to memory.  Enabled by default.
11792 @item -fchkp-check-write
11793 @opindex fchkp-check-write
11794 @opindex fno-chkp-check-write
11795 Instructs Pointer Bounds Checker to generate checks for all write
11796 accesses to memory.  Enabled by default.
11798 @item -fchkp-store-bounds
11799 @opindex fchkp-store-bounds
11800 @opindex fno-chkp-store-bounds
11801 Instructs Pointer Bounds Checker to generate bounds stores for
11802 pointer writes.  Enabled by default.
11804 @item -fchkp-instrument-calls
11805 @opindex fchkp-instrument-calls
11806 @opindex fno-chkp-instrument-calls
11807 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11808 Enabled by default.
11810 @item -fchkp-instrument-marked-only
11811 @opindex fchkp-instrument-marked-only
11812 @opindex fno-chkp-instrument-marked-only
11813 Instructs Pointer Bounds Checker to instrument only functions
11814 marked with the @code{bnd_instrument} attribute
11815 (@pxref{Function Attributes}).  Disabled by default.
11817 @item -fchkp-use-wrappers
11818 @opindex fchkp-use-wrappers
11819 @opindex fno-chkp-use-wrappers
11820 Allows Pointer Bounds Checker to replace calls to built-in functions
11821 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11822 is used to link a program, the GCC driver automatically links
11823 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11824 Enabled by default.
11826 @item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11827 @opindex fcf-protection
11828 Enable code instrumentation of control-flow transfers to increase
11829 program security by checking that target addresses of control-flow
11830 transfer instructions (such as indirect function call, function return,
11831 indirect jump) are valid.  This prevents diverting the flow of control
11832 to an unexpected target.  This is intended to protect against such
11833 threats as Return-oriented Programming (ROP), and similarly
11834 call/jmp-oriented programming (COP/JOP).
11836 The value @code{branch} tells the compiler to implement checking of
11837 validity of control-flow transfer at the point of indirect branch
11838 instructions, i.e. call/jmp instructions.  The value @code{return}
11839 implements checking of validity at the point of returning from a
11840 function.  The value @code{full} is an alias for specifying both
11841 @code{branch} and @code{return}. The value @code{none} turns off
11842 instrumentation.
11844 The macro @code{__CET__} is defined when @option{-fcf-protection} is
11845 used.  The first bit of @code{__CET__} is set to 1 for the value
11846 @code{branch} and the second bit of @code{__CET__} is set to 1 for
11847 the @code{return}.
11849 You can also use the @code{nocf_check} attribute to identify
11850 which functions and calls should be skipped from instrumentation
11851 (@pxref{Function Attributes}).
11853 Currently the x86 GNU/Linux target provides an implementation based
11854 on Intel Control-flow Enforcement Technology (CET).
11856 @item -fstack-protector
11857 @opindex fstack-protector
11858 Emit extra code to check for buffer overflows, such as stack smashing
11859 attacks.  This is done by adding a guard variable to functions with
11860 vulnerable objects.  This includes functions that call @code{alloca}, and
11861 functions with buffers larger than 8 bytes.  The guards are initialized
11862 when a function is entered and then checked when the function exits.
11863 If a guard check fails, an error message is printed and the program exits.
11865 @item -fstack-protector-all
11866 @opindex fstack-protector-all
11867 Like @option{-fstack-protector} except that all functions are protected.
11869 @item -fstack-protector-strong
11870 @opindex fstack-protector-strong
11871 Like @option{-fstack-protector} but includes additional functions to
11872 be protected --- those that have local array definitions, or have
11873 references to local frame addresses.
11875 @item -fstack-protector-explicit
11876 @opindex fstack-protector-explicit
11877 Like @option{-fstack-protector} but only protects those functions which
11878 have the @code{stack_protect} attribute.
11880 @item -fstack-check
11881 @opindex fstack-check
11882 Generate code to verify that you do not go beyond the boundary of the
11883 stack.  You should specify this flag if you are running in an
11884 environment with multiple threads, but you only rarely need to specify it in
11885 a single-threaded environment since stack overflow is automatically
11886 detected on nearly all systems if there is only one stack.
11888 Note that this switch does not actually cause checking to be done; the
11889 operating system or the language runtime must do that.  The switch causes
11890 generation of code to ensure that they see the stack being extended.
11892 You can additionally specify a string parameter: @samp{no} means no
11893 checking, @samp{generic} means force the use of old-style checking,
11894 @samp{specific} means use the best checking method and is equivalent
11895 to bare @option{-fstack-check}.
11897 Old-style checking is a generic mechanism that requires no specific
11898 target support in the compiler but comes with the following drawbacks:
11900 @enumerate
11901 @item
11902 Modified allocation strategy for large objects: they are always
11903 allocated dynamically if their size exceeds a fixed threshold.  Note this
11904 may change the semantics of some code.
11906 @item
11907 Fixed limit on the size of the static frame of functions: when it is
11908 topped by a particular function, stack checking is not reliable and
11909 a warning is issued by the compiler.
11911 @item
11912 Inefficiency: because of both the modified allocation strategy and the
11913 generic implementation, code performance is hampered.
11914 @end enumerate
11916 Note that old-style stack checking is also the fallback method for
11917 @samp{specific} if no target support has been added in the compiler.
11919 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11920 and stack overflows.  @samp{specific} is an excellent choice when compiling
11921 Ada code.  It is not generally sufficient to protect against stack-clash
11922 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11924 @item -fstack-clash-protection
11925 @opindex fstack-clash-protection
11926 Generate code to prevent stack clash style attacks.  When this option is
11927 enabled, the compiler will only allocate one page of stack space at a time
11928 and each page is accessed immediately after allocation.  Thus, it prevents
11929 allocations from jumping over any stack guard page provided by the
11930 operating system.
11932 Most targets do not fully support stack clash protection.  However, on
11933 those targets @option{-fstack-clash-protection} will protect dynamic stack
11934 allocations.  @option{-fstack-clash-protection} may also provide limited
11935 protection for static stack allocations if the target supports
11936 @option{-fstack-check=specific}.
11938 @item -fstack-limit-register=@var{reg}
11939 @itemx -fstack-limit-symbol=@var{sym}
11940 @itemx -fno-stack-limit
11941 @opindex fstack-limit-register
11942 @opindex fstack-limit-symbol
11943 @opindex fno-stack-limit
11944 Generate code to ensure that the stack does not grow beyond a certain value,
11945 either the value of a register or the address of a symbol.  If a larger
11946 stack is required, a signal is raised at run time.  For most targets,
11947 the signal is raised before the stack overruns the boundary, so
11948 it is possible to catch the signal without taking special precautions.
11950 For instance, if the stack starts at absolute address @samp{0x80000000}
11951 and grows downwards, you can use the flags
11952 @option{-fstack-limit-symbol=__stack_limit} and
11953 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11954 of 128KB@.  Note that this may only work with the GNU linker.
11956 You can locally override stack limit checking by using the
11957 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11959 @item -fsplit-stack
11960 @opindex fsplit-stack
11961 Generate code to automatically split the stack before it overflows.
11962 The resulting program has a discontiguous stack which can only
11963 overflow if the program is unable to allocate any more memory.  This
11964 is most useful when running threaded programs, as it is no longer
11965 necessary to calculate a good stack size to use for each thread.  This
11966 is currently only implemented for the x86 targets running
11967 GNU/Linux.
11969 When code compiled with @option{-fsplit-stack} calls code compiled
11970 without @option{-fsplit-stack}, there may not be much stack space
11971 available for the latter code to run.  If compiling all code,
11972 including library code, with @option{-fsplit-stack} is not an option,
11973 then the linker can fix up these calls so that the code compiled
11974 without @option{-fsplit-stack} always has a large stack.  Support for
11975 this is implemented in the gold linker in GNU binutils release 2.21
11976 and later.
11978 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11979 @opindex fvtable-verify
11980 This option is only available when compiling C++ code.
11981 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11982 feature that verifies at run time, for every virtual call, that
11983 the vtable pointer through which the call is made is valid for the type of
11984 the object, and has not been corrupted or overwritten.  If an invalid vtable
11985 pointer is detected at run time, an error is reported and execution of the
11986 program is immediately halted.
11988 This option causes run-time data structures to be built at program startup,
11989 which are used for verifying the vtable pointers.  
11990 The options @samp{std} and @samp{preinit}
11991 control the timing of when these data structures are built.  In both cases the
11992 data structures are built before execution reaches @code{main}.  Using
11993 @option{-fvtable-verify=std} causes the data structures to be built after
11994 shared libraries have been loaded and initialized.
11995 @option{-fvtable-verify=preinit} causes them to be built before shared
11996 libraries have been loaded and initialized.
11998 If this option appears multiple times in the command line with different
11999 values specified, @samp{none} takes highest priority over both @samp{std} and
12000 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
12002 @item -fvtv-debug
12003 @opindex fvtv-debug
12004 When used in conjunction with @option{-fvtable-verify=std} or 
12005 @option{-fvtable-verify=preinit}, causes debug versions of the 
12006 runtime functions for the vtable verification feature to be called.  
12007 This flag also causes the compiler to log information about which 
12008 vtable pointers it finds for each class.
12009 This information is written to a file named @file{vtv_set_ptr_data.log} 
12010 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
12011 if that is defined or the current working directory otherwise.
12013 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
12014 file, be sure to delete any existing one.
12016 @item -fvtv-counts
12017 @opindex fvtv-counts
12018 This is a debugging flag.  When used in conjunction with
12019 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
12020 causes the compiler to keep track of the total number of virtual calls
12021 it encounters and the number of verifications it inserts.  It also
12022 counts the number of calls to certain run-time library functions
12023 that it inserts and logs this information for each compilation unit.
12024 The compiler writes this information to a file named
12025 @file{vtv_count_data.log} in the directory named by the environment
12026 variable @env{VTV_LOGS_DIR} if that is defined or the current working
12027 directory otherwise.  It also counts the size of the vtable pointer sets
12028 for each class, and writes this information to @file{vtv_class_set_sizes.log}
12029 in the same directory.
12031 Note:  This feature @emph{appends} data to the log files.  To get fresh log
12032 files, be sure to delete any existing ones.
12034 @item -finstrument-functions
12035 @opindex finstrument-functions
12036 Generate instrumentation calls for entry and exit to functions.  Just
12037 after function entry and just before function exit, the following
12038 profiling functions are called with the address of the current
12039 function and its call site.  (On some platforms,
12040 @code{__builtin_return_address} does not work beyond the current
12041 function, so the call site information may not be available to the
12042 profiling functions otherwise.)
12044 @smallexample
12045 void __cyg_profile_func_enter (void *this_fn,
12046                                void *call_site);
12047 void __cyg_profile_func_exit  (void *this_fn,
12048                                void *call_site);
12049 @end smallexample
12051 The first argument is the address of the start of the current function,
12052 which may be looked up exactly in the symbol table.
12054 This instrumentation is also done for functions expanded inline in other
12055 functions.  The profiling calls indicate where, conceptually, the
12056 inline function is entered and exited.  This means that addressable
12057 versions of such functions must be available.  If all your uses of a
12058 function are expanded inline, this may mean an additional expansion of
12059 code size.  If you use @code{extern inline} in your C code, an
12060 addressable version of such functions must be provided.  (This is
12061 normally the case anyway, but if you get lucky and the optimizer always
12062 expands the functions inline, you might have gotten away without
12063 providing static copies.)
12065 A function may be given the attribute @code{no_instrument_function}, in
12066 which case this instrumentation is not done.  This can be used, for
12067 example, for the profiling functions listed above, high-priority
12068 interrupt routines, and any functions from which the profiling functions
12069 cannot safely be called (perhaps signal handlers, if the profiling
12070 routines generate output or allocate memory).
12072 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
12073 @opindex finstrument-functions-exclude-file-list
12075 Set the list of functions that are excluded from instrumentation (see
12076 the description of @option{-finstrument-functions}).  If the file that
12077 contains a function definition matches with one of @var{file}, then
12078 that function is not instrumented.  The match is done on substrings:
12079 if the @var{file} parameter is a substring of the file name, it is
12080 considered to be a match.
12082 For example:
12084 @smallexample
12085 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
12086 @end smallexample
12088 @noindent
12089 excludes any inline function defined in files whose pathnames
12090 contain @file{/bits/stl} or @file{include/sys}.
12092 If, for some reason, you want to include letter @samp{,} in one of
12093 @var{sym}, write @samp{\,}. For example,
12094 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
12095 (note the single quote surrounding the option).
12097 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
12098 @opindex finstrument-functions-exclude-function-list
12100 This is similar to @option{-finstrument-functions-exclude-file-list},
12101 but this option sets the list of function names to be excluded from
12102 instrumentation.  The function name to be matched is its user-visible
12103 name, such as @code{vector<int> blah(const vector<int> &)}, not the
12104 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
12105 match is done on substrings: if the @var{sym} parameter is a substring
12106 of the function name, it is considered to be a match.  For C99 and C++
12107 extended identifiers, the function name must be given in UTF-8, not
12108 using universal character names.
12110 @item -fpatchable-function-entry=@var{N}[,@var{M}]
12111 @opindex fpatchable-function-entry
12112 Generate @var{N} NOPs right at the beginning
12113 of each function, with the function entry point before the @var{M}th NOP.
12114 If @var{M} is omitted, it defaults to @code{0} so the
12115 function entry points to the address just at the first NOP.
12116 The NOP instructions reserve extra space which can be used to patch in
12117 any desired instrumentation at run time, provided that the code segment
12118 is writable.  The amount of space is controllable indirectly via
12119 the number of NOPs; the NOP instruction used corresponds to the instruction
12120 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
12121 is target-specific and may also depend on the architecture variant and/or
12122 other compilation options.
12124 For run-time identification, the starting addresses of these areas,
12125 which correspond to their respective function entries minus @var{M},
12126 are additionally collected in the @code{__patchable_function_entries}
12127 section of the resulting binary.
12129 Note that the value of @code{__attribute__ ((patchable_function_entry
12130 (N,M)))} takes precedence over command-line option
12131 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
12132 the area size or to remove it completely on a single function.
12133 If @code{N=0}, no pad location is recorded.
12135 The NOP instructions are inserted at---and maybe before, depending on
12136 @var{M}---the function entry address, even before the prologue.
12138 @end table
12141 @node Preprocessor Options
12142 @section Options Controlling the Preprocessor
12143 @cindex preprocessor options
12144 @cindex options, preprocessor
12146 These options control the C preprocessor, which is run on each C source
12147 file before actual compilation.
12149 If you use the @option{-E} option, nothing is done except preprocessing.
12150 Some of these options make sense only together with @option{-E} because
12151 they cause the preprocessor output to be unsuitable for actual
12152 compilation.
12154 In addition to the options listed here, there are a number of options 
12155 to control search paths for include files documented in 
12156 @ref{Directory Options}.  
12157 Options to control preprocessor diagnostics are listed in 
12158 @ref{Warning Options}.
12160 @table @gcctabopt
12161 @include cppopts.texi
12163 @item -Wp,@var{option}
12164 @opindex Wp
12165 You can use @option{-Wp,@var{option}} to bypass the compiler driver
12166 and pass @var{option} directly through to the preprocessor.  If
12167 @var{option} contains commas, it is split into multiple options at the
12168 commas.  However, many options are modified, translated or interpreted
12169 by the compiler driver before being passed to the preprocessor, and
12170 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
12171 interface is undocumented and subject to change, so whenever possible
12172 you should avoid using @option{-Wp} and let the driver handle the
12173 options instead.
12175 @item -Xpreprocessor @var{option}
12176 @opindex Xpreprocessor
12177 Pass @var{option} as an option to the preprocessor.  You can use this to
12178 supply system-specific preprocessor options that GCC does not 
12179 recognize.
12181 If you want to pass an option that takes an argument, you must use
12182 @option{-Xpreprocessor} twice, once for the option and once for the argument.
12184 @item -no-integrated-cpp
12185 @opindex no-integrated-cpp
12186 Perform preprocessing as a separate pass before compilation.
12187 By default, GCC performs preprocessing as an integrated part of
12188 input tokenization and parsing.
12189 If this option is provided, the appropriate language front end
12190 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
12191 and Objective-C, respectively) is instead invoked twice,
12192 once for preprocessing only and once for actual compilation
12193 of the preprocessed input.
12194 This option may be useful in conjunction with the @option{-B} or
12195 @option{-wrapper} options to specify an alternate preprocessor or
12196 perform additional processing of the program source between
12197 normal preprocessing and compilation.
12199 @end table
12201 @node Assembler Options
12202 @section Passing Options to the Assembler
12204 @c prevent bad page break with this line
12205 You can pass options to the assembler.
12207 @table @gcctabopt
12208 @item -Wa,@var{option}
12209 @opindex Wa
12210 Pass @var{option} as an option to the assembler.  If @var{option}
12211 contains commas, it is split into multiple options at the commas.
12213 @item -Xassembler @var{option}
12214 @opindex Xassembler
12215 Pass @var{option} as an option to the assembler.  You can use this to
12216 supply system-specific assembler options that GCC does not
12217 recognize.
12219 If you want to pass an option that takes an argument, you must use
12220 @option{-Xassembler} twice, once for the option and once for the argument.
12222 @end table
12224 @node Link Options
12225 @section Options for Linking
12226 @cindex link options
12227 @cindex options, linking
12229 These options come into play when the compiler links object files into
12230 an executable output file.  They are meaningless if the compiler is
12231 not doing a link step.
12233 @table @gcctabopt
12234 @cindex file names
12235 @item @var{object-file-name}
12236 A file name that does not end in a special recognized suffix is
12237 considered to name an object file or library.  (Object files are
12238 distinguished from libraries by the linker according to the file
12239 contents.)  If linking is done, these object files are used as input
12240 to the linker.
12242 @item -c
12243 @itemx -S
12244 @itemx -E
12245 @opindex c
12246 @opindex S
12247 @opindex E
12248 If any of these options is used, then the linker is not run, and
12249 object file names should not be used as arguments.  @xref{Overall
12250 Options}.
12252 @item -fuse-ld=bfd
12253 @opindex fuse-ld=bfd
12254 Use the @command{bfd} linker instead of the default linker.
12256 @item -fuse-ld=gold
12257 @opindex fuse-ld=gold
12258 Use the @command{gold} linker instead of the default linker.
12260 @cindex Libraries
12261 @item -l@var{library}
12262 @itemx -l @var{library}
12263 @opindex l
12264 Search the library named @var{library} when linking.  (The second
12265 alternative with the library as a separate argument is only for
12266 POSIX compliance and is not recommended.)
12268 It makes a difference where in the command you write this option; the
12269 linker searches and processes libraries and object files in the order they
12270 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12271 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12272 to functions in @samp{z}, those functions may not be loaded.
12274 The linker searches a standard list of directories for the library,
12275 which is actually a file named @file{lib@var{library}.a}.  The linker
12276 then uses this file as if it had been specified precisely by name.
12278 The directories searched include several standard system directories
12279 plus any that you specify with @option{-L}.
12281 Normally the files found this way are library files---archive files
12282 whose members are object files.  The linker handles an archive file by
12283 scanning through it for members which define symbols that have so far
12284 been referenced but not defined.  But if the file that is found is an
12285 ordinary object file, it is linked in the usual fashion.  The only
12286 difference between using an @option{-l} option and specifying a file name
12287 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12288 and searches several directories.
12290 @item -lobjc
12291 @opindex lobjc
12292 You need this special case of the @option{-l} option in order to
12293 link an Objective-C or Objective-C++ program.
12295 @item -nostartfiles
12296 @opindex nostartfiles
12297 Do not use the standard system startup files when linking.
12298 The standard system libraries are used normally, unless @option{-nostdlib}
12299 or @option{-nodefaultlibs} is used.
12301 @item -nodefaultlibs
12302 @opindex nodefaultlibs
12303 Do not use the standard system libraries when linking.
12304 Only the libraries you specify are passed to the linker, and options
12305 specifying linkage of the system libraries, such as @option{-static-libgcc}
12306 or @option{-shared-libgcc}, are ignored.  
12307 The standard startup files are used normally, unless @option{-nostartfiles}
12308 is used.  
12310 The compiler may generate calls to @code{memcmp},
12311 @code{memset}, @code{memcpy} and @code{memmove}.
12312 These entries are usually resolved by entries in
12313 libc.  These entry points should be supplied through some other
12314 mechanism when this option is specified.
12316 @item -nostdlib
12317 @opindex nostdlib
12318 Do not use the standard system startup files or libraries when linking.
12319 No startup files and only the libraries you specify are passed to
12320 the linker, and options specifying linkage of the system libraries, such as
12321 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12323 The compiler may generate calls to @code{memcmp}, @code{memset},
12324 @code{memcpy} and @code{memmove}.
12325 These entries are usually resolved by entries in
12326 libc.  These entry points should be supplied through some other
12327 mechanism when this option is specified.
12329 @cindex @option{-lgcc}, use with @option{-nostdlib}
12330 @cindex @option{-nostdlib} and unresolved references
12331 @cindex unresolved references and @option{-nostdlib}
12332 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12333 @cindex @option{-nodefaultlibs} and unresolved references
12334 @cindex unresolved references and @option{-nodefaultlibs}
12335 One of the standard libraries bypassed by @option{-nostdlib} and
12336 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12337 which GCC uses to overcome shortcomings of particular machines, or special
12338 needs for some languages.
12339 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12340 Collection (GCC) Internals},
12341 for more discussion of @file{libgcc.a}.)
12342 In most cases, you need @file{libgcc.a} even when you want to avoid
12343 other standard libraries.  In other words, when you specify @option{-nostdlib}
12344 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12345 This ensures that you have no unresolved references to internal GCC
12346 library subroutines.
12347 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12348 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12349 GNU Compiler Collection (GCC) Internals}.)
12351 @item -pie
12352 @opindex pie
12353 Produce a dynamically linked position independent executable on targets
12354 that support it.  For predictable results, you must also specify the same
12355 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12356 or model suboptions) when you specify this linker option.
12358 @item -no-pie
12359 @opindex no-pie
12360 Don't produce a dynamically linked position independent executable.
12362 @item -static-pie
12363 @opindex static-pie
12364 Produce a static position independent executable on targets that support
12365 it.  A static position independent executable is similar to a static
12366 executable, but can be loaded at any address without a dynamic linker.
12367 For predictable results, you must also specify the same set of options
12368 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12369 suboptions) when you specify this linker option.
12371 @item -pthread
12372 @opindex pthread
12373 Link with the POSIX threads library.  This option is supported on 
12374 GNU/Linux targets, most other Unix derivatives, and also on 
12375 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12376 flags for the preprocessor, so it should be used consistently for both
12377 compilation and linking.
12379 @item -rdynamic
12380 @opindex rdynamic
12381 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12382 that support it. This instructs the linker to add all symbols, not
12383 only used ones, to the dynamic symbol table. This option is needed
12384 for some uses of @code{dlopen} or to allow obtaining backtraces
12385 from within a program.
12387 @item -s
12388 @opindex s
12389 Remove all symbol table and relocation information from the executable.
12391 @item -static
12392 @opindex static
12393 On systems that support dynamic linking, this overrides @option{-pie}
12394 and prevents linking with the shared libraries.  On other systems, this
12395 option has no effect.
12397 @item -shared
12398 @opindex shared
12399 Produce a shared object which can then be linked with other objects to
12400 form an executable.  Not all systems support this option.  For predictable
12401 results, you must also specify the same set of options used for compilation
12402 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12403 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12404 needs to build supplementary stub code for constructors to work.  On
12405 multi-libbed systems, @samp{gcc -shared} must select the correct support
12406 libraries to link against.  Failing to supply the correct flags may lead
12407 to subtle defects.  Supplying them in cases where they are not necessary
12408 is innocuous.}
12410 @item -shared-libgcc
12411 @itemx -static-libgcc
12412 @opindex shared-libgcc
12413 @opindex static-libgcc
12414 On systems that provide @file{libgcc} as a shared library, these options
12415 force the use of either the shared or static version, respectively.
12416 If no shared version of @file{libgcc} was built when the compiler was
12417 configured, these options have no effect.
12419 There are several situations in which an application should use the
12420 shared @file{libgcc} instead of the static version.  The most common
12421 of these is when the application wishes to throw and catch exceptions
12422 across different shared libraries.  In that case, each of the libraries
12423 as well as the application itself should use the shared @file{libgcc}.
12425 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12426  whenever you build a shared library or a main executable, because C++
12427  programs typically use exceptions, so this is the right thing to do.
12429 If, instead, you use the GCC driver to create shared libraries, you may
12430 find that they are not always linked with the shared @file{libgcc}.
12431 If GCC finds, at its configuration time, that you have a non-GNU linker
12432 or a GNU linker that does not support option @option{--eh-frame-hdr},
12433 it links the shared version of @file{libgcc} into shared libraries
12434 by default.  Otherwise, it takes advantage of the linker and optimizes
12435 away the linking with the shared version of @file{libgcc}, linking with
12436 the static version of libgcc by default.  This allows exceptions to
12437 propagate through such shared libraries, without incurring relocation
12438 costs at library load time.
12440 However, if a library or main executable is supposed to throw or catch
12441 exceptions, you must link it using the G++ driver, as appropriate
12442 for the languages used in the program, or using the option
12443 @option{-shared-libgcc}, such that it is linked with the shared
12444 @file{libgcc}.
12446 @item -static-libasan
12447 @opindex static-libasan
12448 When the @option{-fsanitize=address} option is used to link a program,
12449 the GCC driver automatically links against @option{libasan}.  If
12450 @file{libasan} is available as a shared library, and the @option{-static}
12451 option is not used, then this links against the shared version of
12452 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12453 driver to link @file{libasan} statically, without necessarily linking
12454 other libraries statically.
12456 @item -static-libtsan
12457 @opindex static-libtsan
12458 When the @option{-fsanitize=thread} option is used to link a program,
12459 the GCC driver automatically links against @option{libtsan}.  If
12460 @file{libtsan} is available as a shared library, and the @option{-static}
12461 option is not used, then this links against the shared version of
12462 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12463 driver to link @file{libtsan} statically, without necessarily linking
12464 other libraries statically.
12466 @item -static-liblsan
12467 @opindex static-liblsan
12468 When the @option{-fsanitize=leak} option is used to link a program,
12469 the GCC driver automatically links against @option{liblsan}.  If
12470 @file{liblsan} is available as a shared library, and the @option{-static}
12471 option is not used, then this links against the shared version of
12472 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12473 driver to link @file{liblsan} statically, without necessarily linking
12474 other libraries statically.
12476 @item -static-libubsan
12477 @opindex static-libubsan
12478 When the @option{-fsanitize=undefined} option is used to link a program,
12479 the GCC driver automatically links against @option{libubsan}.  If
12480 @file{libubsan} is available as a shared library, and the @option{-static}
12481 option is not used, then this links against the shared version of
12482 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12483 driver to link @file{libubsan} statically, without necessarily linking
12484 other libraries statically.
12486 @item -static-libmpx
12487 @opindex static-libmpx
12488 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12489 used to link a program, the GCC driver automatically links against
12490 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12491 and the @option{-static} option is not used, then this links against
12492 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12493 option directs the GCC driver to link @file{libmpx} statically,
12494 without necessarily linking other libraries statically.
12496 @item -static-libmpxwrappers
12497 @opindex static-libmpxwrappers
12498 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12499 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12500 GCC driver automatically links against @file{libmpxwrappers}.  If
12501 @file{libmpxwrappers} is available as a shared library, and the
12502 @option{-static} option is not used, then this links against the shared
12503 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12504 option directs the GCC driver to link @file{libmpxwrappers} statically,
12505 without necessarily linking other libraries statically.
12507 @item -static-libstdc++
12508 @opindex static-libstdc++
12509 When the @command{g++} program is used to link a C++ program, it
12510 normally automatically links against @option{libstdc++}.  If
12511 @file{libstdc++} is available as a shared library, and the
12512 @option{-static} option is not used, then this links against the
12513 shared version of @file{libstdc++}.  That is normally fine.  However, it
12514 is sometimes useful to freeze the version of @file{libstdc++} used by
12515 the program without going all the way to a fully static link.  The
12516 @option{-static-libstdc++} option directs the @command{g++} driver to
12517 link @file{libstdc++} statically, without necessarily linking other
12518 libraries statically.
12520 @item -symbolic
12521 @opindex symbolic
12522 Bind references to global symbols when building a shared object.  Warn
12523 about any unresolved references (unless overridden by the link editor
12524 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12525 this option.
12527 @item -T @var{script}
12528 @opindex T
12529 @cindex linker script
12530 Use @var{script} as the linker script.  This option is supported by most
12531 systems using the GNU linker.  On some targets, such as bare-board
12532 targets without an operating system, the @option{-T} option may be required
12533 when linking to avoid references to undefined symbols.
12535 @item -Xlinker @var{option}
12536 @opindex Xlinker
12537 Pass @var{option} as an option to the linker.  You can use this to
12538 supply system-specific linker options that GCC does not recognize.
12540 If you want to pass an option that takes a separate argument, you must use
12541 @option{-Xlinker} twice, once for the option and once for the argument.
12542 For example, to pass @option{-assert definitions}, you must write
12543 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12544 @option{-Xlinker "-assert definitions"}, because this passes the entire
12545 string as a single argument, which is not what the linker expects.
12547 When using the GNU linker, it is usually more convenient to pass
12548 arguments to linker options using the @option{@var{option}=@var{value}}
12549 syntax than as separate arguments.  For example, you can specify
12550 @option{-Xlinker -Map=output.map} rather than
12551 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12552 this syntax for command-line options.
12554 @item -Wl,@var{option}
12555 @opindex Wl
12556 Pass @var{option} as an option to the linker.  If @var{option} contains
12557 commas, it is split into multiple options at the commas.  You can use this
12558 syntax to pass an argument to the option.
12559 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12560 linker.  When using the GNU linker, you can also get the same effect with
12561 @option{-Wl,-Map=output.map}.
12563 @item -u @var{symbol}
12564 @opindex u
12565 Pretend the symbol @var{symbol} is undefined, to force linking of
12566 library modules to define it.  You can use @option{-u} multiple times with
12567 different symbols to force loading of additional library modules.
12569 @item -z @var{keyword}
12570 @opindex z
12571 @option{-z} is passed directly on to the linker along with the keyword
12572 @var{keyword}. See the section in the documentation of your linker for
12573 permitted values and their meanings.
12574 @end table
12576 @node Directory Options
12577 @section Options for Directory Search
12578 @cindex directory options
12579 @cindex options, directory search
12580 @cindex search path
12582 These options specify directories to search for header files, for
12583 libraries and for parts of the compiler:
12585 @table @gcctabopt
12586 @include cppdiropts.texi
12588 @item -iplugindir=@var{dir}
12589 @opindex iplugindir=
12590 Set the directory to search for plugins that are passed
12591 by @option{-fplugin=@var{name}} instead of
12592 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12593 to be used by the user, but only passed by the driver.
12595 @item -L@var{dir}
12596 @opindex L
12597 Add directory @var{dir} to the list of directories to be searched
12598 for @option{-l}.
12600 @item -B@var{prefix}
12601 @opindex B
12602 This option specifies where to find the executables, libraries,
12603 include files, and data files of the compiler itself.
12605 The compiler driver program runs one or more of the subprograms
12606 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12607 @var{prefix} as a prefix for each program it tries to run, both with and
12608 without @samp{@var{machine}/@var{version}/} for the corresponding target
12609 machine and compiler version.
12611 For each subprogram to be run, the compiler driver first tries the
12612 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12613 is not specified, the driver tries two standard prefixes, 
12614 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12615 those results in a file name that is found, the unmodified program
12616 name is searched for using the directories specified in your
12617 @env{PATH} environment variable.
12619 The compiler checks to see if the path provided by @option{-B}
12620 refers to a directory, and if necessary it adds a directory
12621 separator character at the end of the path.
12623 @option{-B} prefixes that effectively specify directory names also apply
12624 to libraries in the linker, because the compiler translates these
12625 options into @option{-L} options for the linker.  They also apply to
12626 include files in the preprocessor, because the compiler translates these
12627 options into @option{-isystem} options for the preprocessor.  In this case,
12628 the compiler appends @samp{include} to the prefix.
12630 The runtime support file @file{libgcc.a} can also be searched for using
12631 the @option{-B} prefix, if needed.  If it is not found there, the two
12632 standard prefixes above are tried, and that is all.  The file is left
12633 out of the link if it is not found by those means.
12635 Another way to specify a prefix much like the @option{-B} prefix is to use
12636 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12637 Variables}.
12639 As a special kludge, if the path provided by @option{-B} is
12640 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12641 9, then it is replaced by @file{[dir/]include}.  This is to help
12642 with boot-strapping the compiler.
12644 @item -no-canonical-prefixes
12645 @opindex no-canonical-prefixes
12646 Do not expand any symbolic links, resolve references to @samp{/../}
12647 or @samp{/./}, or make the path absolute when generating a relative
12648 prefix.
12650 @item --sysroot=@var{dir}
12651 @opindex sysroot
12652 Use @var{dir} as the logical root directory for headers and libraries.
12653 For example, if the compiler normally searches for headers in
12654 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12655 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12657 If you use both this option and the @option{-isysroot} option, then
12658 the @option{--sysroot} option applies to libraries, but the
12659 @option{-isysroot} option applies to header files.
12661 The GNU linker (beginning with version 2.16) has the necessary support
12662 for this option.  If your linker does not support this option, the
12663 header file aspect of @option{--sysroot} still works, but the
12664 library aspect does not.
12666 @item --no-sysroot-suffix
12667 @opindex no-sysroot-suffix
12668 For some targets, a suffix is added to the root directory specified
12669 with @option{--sysroot}, depending on the other options used, so that
12670 headers may for example be found in
12671 @file{@var{dir}/@var{suffix}/usr/include} instead of
12672 @file{@var{dir}/usr/include}.  This option disables the addition of
12673 such a suffix.
12675 @end table
12677 @node Code Gen Options
12678 @section Options for Code Generation Conventions
12679 @cindex code generation conventions
12680 @cindex options, code generation
12681 @cindex run-time options
12683 These machine-independent options control the interface conventions
12684 used in code generation.
12686 Most of them have both positive and negative forms; the negative form
12687 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12688 one of the forms is listed---the one that is not the default.  You
12689 can figure out the other form by either removing @samp{no-} or adding
12692 @table @gcctabopt
12693 @item -fstack-reuse=@var{reuse-level}
12694 @opindex fstack_reuse
12695 This option controls stack space reuse for user declared local/auto variables
12696 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12697 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12698 local variables and temporaries, @samp{named_vars} enables the reuse only for
12699 user defined local variables with names, and @samp{none} disables stack reuse
12700 completely. The default value is @samp{all}. The option is needed when the
12701 program extends the lifetime of a scoped local variable or a compiler generated
12702 temporary beyond the end point defined by the language.  When a lifetime of
12703 a variable ends, and if the variable lives in memory, the optimizing compiler
12704 has the freedom to reuse its stack space with other temporaries or scoped
12705 local variables whose live range does not overlap with it. Legacy code extending
12706 local lifetime is likely to break with the stack reuse optimization.
12708 For example,
12710 @smallexample
12711    int *p;
12712    @{
12713      int local1;
12715      p = &local1;
12716      local1 = 10;
12717      ....
12718    @}
12719    @{
12720       int local2;
12721       local2 = 20;
12722       ...
12723    @}
12725    if (*p == 10)  // out of scope use of local1
12726      @{
12728      @}
12729 @end smallexample
12731 Another example:
12732 @smallexample
12734    struct A
12735    @{
12736        A(int k) : i(k), j(k) @{ @}
12737        int i;
12738        int j;
12739    @};
12741    A *ap;
12743    void foo(const A& ar)
12744    @{
12745       ap = &ar;
12746    @}
12748    void bar()
12749    @{
12750       foo(A(10)); // temp object's lifetime ends when foo returns
12752       @{
12753         A a(20);
12754         ....
12755       @}
12756       ap->i+= 10;  // ap references out of scope temp whose space
12757                    // is reused with a. What is the value of ap->i?
12758    @}
12760 @end smallexample
12762 The lifetime of a compiler generated temporary is well defined by the C++
12763 standard. When a lifetime of a temporary ends, and if the temporary lives
12764 in memory, the optimizing compiler has the freedom to reuse its stack
12765 space with other temporaries or scoped local variables whose live range
12766 does not overlap with it. However some of the legacy code relies on
12767 the behavior of older compilers in which temporaries' stack space is
12768 not reused, the aggressive stack reuse can lead to runtime errors. This
12769 option is used to control the temporary stack reuse optimization.
12771 @item -ftrapv
12772 @opindex ftrapv
12773 This option generates traps for signed overflow on addition, subtraction,
12774 multiplication operations.
12775 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12776 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12777 @option{-fwrapv} being effective.  Note that only active options override, so
12778 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12779 results in @option{-ftrapv} being effective.
12781 @item -fwrapv
12782 @opindex fwrapv
12783 This option instructs the compiler to assume that signed arithmetic
12784 overflow of addition, subtraction and multiplication wraps around
12785 using twos-complement representation.  This flag enables some optimizations
12786 and disables others.
12787 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12788 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12789 @option{-fwrapv} being effective.  Note that only active options override, so
12790 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12791 results in @option{-ftrapv} being effective.
12793 @item -fwrapv-pointer
12794 @opindex fwrapv-pointer
12795 This option instructs the compiler to assume that pointer arithmetic
12796 overflow on addition and subtraction wraps around using twos-complement
12797 representation.  This flag disables some optimizations which assume
12798 pointer overflow is invalid.
12800 @item -fstrict-overflow
12801 @opindex fstrict-overflow
12802 This option implies @option{-fno-wrapv} @option{-fno-wrapv-pointer} and when
12803 negated implies @option{-fwrapv} @option{-fwrapv-pointer}.
12805 @item -fexceptions
12806 @opindex fexceptions
12807 Enable exception handling.  Generates extra code needed to propagate
12808 exceptions.  For some targets, this implies GCC generates frame
12809 unwind information for all functions, which can produce significant data
12810 size overhead, although it does not affect execution.  If you do not
12811 specify this option, GCC enables it by default for languages like
12812 C++ that normally require exception handling, and disables it for
12813 languages like C that do not normally require it.  However, you may need
12814 to enable this option when compiling C code that needs to interoperate
12815 properly with exception handlers written in C++.  You may also wish to
12816 disable this option if you are compiling older C++ programs that don't
12817 use exception handling.
12819 @item -fnon-call-exceptions
12820 @opindex fnon-call-exceptions
12821 Generate code that allows trapping instructions to throw exceptions.
12822 Note that this requires platform-specific runtime support that does
12823 not exist everywhere.  Moreover, it only allows @emph{trapping}
12824 instructions to throw exceptions, i.e.@: memory references or floating-point
12825 instructions.  It does not allow exceptions to be thrown from
12826 arbitrary signal handlers such as @code{SIGALRM}.
12828 @item -fdelete-dead-exceptions
12829 @opindex fdelete-dead-exceptions
12830 Consider that instructions that may throw exceptions but don't otherwise
12831 contribute to the execution of the program can be optimized away.
12832 This option is enabled by default for the Ada front end, as permitted by
12833 the Ada language specification.
12834 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12836 @item -funwind-tables
12837 @opindex funwind-tables
12838 Similar to @option{-fexceptions}, except that it just generates any needed
12839 static data, but does not affect the generated code in any other way.
12840 You normally do not need to enable this option; instead, a language processor
12841 that needs this handling enables it on your behalf.
12843 @item -fasynchronous-unwind-tables
12844 @opindex fasynchronous-unwind-tables
12845 Generate unwind table in DWARF format, if supported by target machine.  The
12846 table is exact at each instruction boundary, so it can be used for stack
12847 unwinding from asynchronous events (such as debugger or garbage collector).
12849 @item -fno-gnu-unique
12850 @opindex fno-gnu-unique
12851 On systems with recent GNU assembler and C library, the C++ compiler
12852 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12853 of template static data members and static local variables in inline
12854 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12855 is necessary to avoid problems with a library used by two different
12856 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12857 therefore disagreeing with the other one about the binding of the
12858 symbol.  But this causes @code{dlclose} to be ignored for affected
12859 DSOs; if your program relies on reinitialization of a DSO via
12860 @code{dlclose} and @code{dlopen}, you can use
12861 @option{-fno-gnu-unique}.
12863 @item -fpcc-struct-return
12864 @opindex fpcc-struct-return
12865 Return ``short'' @code{struct} and @code{union} values in memory like
12866 longer ones, rather than in registers.  This convention is less
12867 efficient, but it has the advantage of allowing intercallability between
12868 GCC-compiled files and files compiled with other compilers, particularly
12869 the Portable C Compiler (pcc).
12871 The precise convention for returning structures in memory depends
12872 on the target configuration macros.
12874 Short structures and unions are those whose size and alignment match
12875 that of some integer type.
12877 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12878 switch is not binary compatible with code compiled with the
12879 @option{-freg-struct-return} switch.
12880 Use it to conform to a non-default application binary interface.
12882 @item -freg-struct-return
12883 @opindex freg-struct-return
12884 Return @code{struct} and @code{union} values in registers when possible.
12885 This is more efficient for small structures than
12886 @option{-fpcc-struct-return}.
12888 If you specify neither @option{-fpcc-struct-return} nor
12889 @option{-freg-struct-return}, GCC defaults to whichever convention is
12890 standard for the target.  If there is no standard convention, GCC
12891 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12892 the principal compiler.  In those cases, we can choose the standard, and
12893 we chose the more efficient register return alternative.
12895 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12896 switch is not binary compatible with code compiled with the
12897 @option{-fpcc-struct-return} switch.
12898 Use it to conform to a non-default application binary interface.
12900 @item -fshort-enums
12901 @opindex fshort-enums
12902 Allocate to an @code{enum} type only as many bytes as it needs for the
12903 declared range of possible values.  Specifically, the @code{enum} type
12904 is equivalent to the smallest integer type that has enough room.
12906 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12907 code that is not binary compatible with code generated without that switch.
12908 Use it to conform to a non-default application binary interface.
12910 @item -fshort-wchar
12911 @opindex fshort-wchar
12912 Override the underlying type for @code{wchar_t} to be @code{short
12913 unsigned int} instead of the default for the target.  This option is
12914 useful for building programs to run under WINE@.
12916 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12917 code that is not binary compatible with code generated without that switch.
12918 Use it to conform to a non-default application binary interface.
12920 @item -fno-common
12921 @opindex fno-common
12922 @cindex tentative definitions
12923 In C code, this option controls the placement of global variables 
12924 defined without an initializer, known as @dfn{tentative definitions} 
12925 in the C standard.  Tentative definitions are distinct from declarations 
12926 of a variable with the @code{extern} keyword, which do not allocate storage.
12928 Unix C compilers have traditionally allocated storage for
12929 uninitialized global variables in a common block.  This allows the
12930 linker to resolve all tentative definitions of the same variable
12931 in different compilation units to the same object, or to a non-tentative
12932 definition.  
12933 This is the behavior specified by @option{-fcommon}, and is the default for 
12934 GCC on most targets.  
12935 On the other hand, this behavior is not required by ISO
12936 C, and on some targets may carry a speed or code size penalty on
12937 variable references.
12939 The @option{-fno-common} option specifies that the compiler should instead
12940 place uninitialized global variables in the data section of the object file.
12941 This inhibits the merging of tentative definitions by the linker so
12942 you get a multiple-definition error if the same 
12943 variable is defined in more than one compilation unit.
12944 Compiling with @option{-fno-common} is useful on targets for which
12945 it provides better performance, or if you wish to verify that the
12946 program will work on other systems that always treat uninitialized
12947 variable definitions this way.
12949 @item -fno-ident
12950 @opindex fno-ident
12951 Ignore the @code{#ident} directive.
12953 @item -finhibit-size-directive
12954 @opindex finhibit-size-directive
12955 Don't output a @code{.size} assembler directive, or anything else that
12956 would cause trouble if the function is split in the middle, and the
12957 two halves are placed at locations far apart in memory.  This option is
12958 used when compiling @file{crtstuff.c}; you should not need to use it
12959 for anything else.
12961 @item -fverbose-asm
12962 @opindex fverbose-asm
12963 Put extra commentary information in the generated assembly code to
12964 make it more readable.  This option is generally only of use to those
12965 who actually need to read the generated assembly code (perhaps while
12966 debugging the compiler itself).
12968 @option{-fno-verbose-asm}, the default, causes the
12969 extra information to be omitted and is useful when comparing two assembler
12970 files.
12972 The added comments include:
12974 @itemize @bullet
12976 @item
12977 information on the compiler version and command-line options,
12979 @item
12980 the source code lines associated with the assembly instructions,
12981 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12983 @item
12984 hints on which high-level expressions correspond to
12985 the various assembly instruction operands.
12987 @end itemize
12989 For example, given this C source file:
12991 @smallexample
12992 int test (int n)
12994   int i;
12995   int total = 0;
12997   for (i = 0; i < n; i++)
12998     total += i * i;
13000   return total;
13002 @end smallexample
13004 compiling to (x86_64) assembly via @option{-S} and emitting the result
13005 direct to stdout via @option{-o} @option{-}
13007 @smallexample
13008 gcc -S test.c -fverbose-asm -Os -o -
13009 @end smallexample
13011 gives output similar to this:
13013 @smallexample
13014         .file   "test.c"
13015 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
13016   [...snip...]
13017 # options passed:
13018   [...snip...]
13020         .text
13021         .globl  test
13022         .type   test, @@function
13023 test:
13024 .LFB0:
13025         .cfi_startproc
13026 # test.c:4:   int total = 0;
13027         xorl    %eax, %eax      # <retval>
13028 # test.c:6:   for (i = 0; i < n; i++)
13029         xorl    %edx, %edx      # i
13030 .L2:
13031 # test.c:6:   for (i = 0; i < n; i++)
13032         cmpl    %edi, %edx      # n, i
13033         jge     .L5     #,
13034 # test.c:7:     total += i * i;
13035         movl    %edx, %ecx      # i, tmp92
13036         imull   %edx, %ecx      # i, tmp92
13037 # test.c:6:   for (i = 0; i < n; i++)
13038         incl    %edx    # i
13039 # test.c:7:     total += i * i;
13040         addl    %ecx, %eax      # tmp92, <retval>
13041         jmp     .L2     #
13042 .L5:
13043 # test.c:10: @}
13044         ret
13045         .cfi_endproc
13046 .LFE0:
13047         .size   test, .-test
13048         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
13049         .section        .note.GNU-stack,"",@@progbits
13050 @end smallexample
13052 The comments are intended for humans rather than machines and hence the
13053 precise format of the comments is subject to change.
13055 @item -frecord-gcc-switches
13056 @opindex frecord-gcc-switches
13057 This switch causes the command line used to invoke the
13058 compiler to be recorded into the object file that is being created.
13059 This switch is only implemented on some targets and the exact format
13060 of the recording is target and binary file format dependent, but it
13061 usually takes the form of a section containing ASCII text.  This
13062 switch is related to the @option{-fverbose-asm} switch, but that
13063 switch only records information in the assembler output file as
13064 comments, so it never reaches the object file.
13065 See also @option{-grecord-gcc-switches} for another
13066 way of storing compiler options into the object file.
13068 @item -fpic
13069 @opindex fpic
13070 @cindex global offset table
13071 @cindex PIC
13072 Generate position-independent code (PIC) suitable for use in a shared
13073 library, if supported for the target machine.  Such code accesses all
13074 constant addresses through a global offset table (GOT)@.  The dynamic
13075 loader resolves the GOT entries when the program starts (the dynamic
13076 loader is not part of GCC; it is part of the operating system).  If
13077 the GOT size for the linked executable exceeds a machine-specific
13078 maximum size, you get an error message from the linker indicating that
13079 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13080 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
13081 on the m68k and RS/6000.  The x86 has no such limit.)
13083 Position-independent code requires special support, and therefore works
13084 only on certain machines.  For the x86, GCC supports PIC for System V
13085 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13086 position-independent.
13088 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13089 are defined to 1.
13091 @item -fPIC
13092 @opindex fPIC
13093 If supported for the target machine, emit position-independent code,
13094 suitable for dynamic linking and avoiding any limit on the size of the
13095 global offset table.  This option makes a difference on AArch64, m68k,
13096 PowerPC and SPARC@.
13098 Position-independent code requires special support, and therefore works
13099 only on certain machines.
13101 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13102 are defined to 2.
13104 @item -fpie
13105 @itemx -fPIE
13106 @opindex fpie
13107 @opindex fPIE
13108 These options are similar to @option{-fpic} and @option{-fPIC}, but the
13109 generated position-independent code can be only linked into executables.
13110 Usually these options are used to compile code that will be linked using
13111 the @option{-pie} GCC option.
13113 @option{-fpie} and @option{-fPIE} both define the macros
13114 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
13115 for @option{-fpie} and 2 for @option{-fPIE}.
13117 @item -fno-plt
13118 @opindex fno-plt
13119 Do not use the PLT for external function calls in position-independent code.
13120 Instead, load the callee address at call sites from the GOT and branch to it.
13121 This leads to more efficient code by eliminating PLT stubs and exposing
13122 GOT loads to optimizations.  On architectures such as 32-bit x86 where
13123 PLT stubs expect the GOT pointer in a specific register, this gives more
13124 register allocation freedom to the compiler.
13125 Lazy binding requires use of the PLT; 
13126 with @option{-fno-plt} all external symbols are resolved at load time.
13128 Alternatively, the function attribute @code{noplt} can be used to avoid calls
13129 through the PLT for specific external functions.
13131 In position-dependent code, a few targets also convert calls to
13132 functions that are marked to not use the PLT to use the GOT instead.
13134 @item -fno-jump-tables
13135 @opindex fno-jump-tables
13136 Do not use jump tables for switch statements even where it would be
13137 more efficient than other code generation strategies.  This option is
13138 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13139 building code that forms part of a dynamic linker and cannot
13140 reference the address of a jump table.  On some targets, jump tables
13141 do not require a GOT and this option is not needed.
13143 @item -ffixed-@var{reg}
13144 @opindex ffixed
13145 Treat the register named @var{reg} as a fixed register; generated code
13146 should never refer to it (except perhaps as a stack pointer, frame
13147 pointer or in some other fixed role).
13149 @var{reg} must be the name of a register.  The register names accepted
13150 are machine-specific and are defined in the @code{REGISTER_NAMES}
13151 macro in the machine description macro file.
13153 This flag does not have a negative form, because it specifies a
13154 three-way choice.
13156 @item -fcall-used-@var{reg}
13157 @opindex fcall-used
13158 Treat the register named @var{reg} as an allocable register that is
13159 clobbered by function calls.  It may be allocated for temporaries or
13160 variables that do not live across a call.  Functions compiled this way
13161 do not save and restore the register @var{reg}.
13163 It is an error to use this flag with the frame pointer or stack pointer.
13164 Use of this flag for other registers that have fixed pervasive roles in
13165 the machine's execution model produces disastrous results.
13167 This flag does not have a negative form, because it specifies a
13168 three-way choice.
13170 @item -fcall-saved-@var{reg}
13171 @opindex fcall-saved
13172 Treat the register named @var{reg} as an allocable register saved by
13173 functions.  It may be allocated even for temporaries or variables that
13174 live across a call.  Functions compiled this way save and restore
13175 the register @var{reg} if they use it.
13177 It is an error to use this flag with the frame pointer or stack pointer.
13178 Use of this flag for other registers that have fixed pervasive roles in
13179 the machine's execution model produces disastrous results.
13181 A different sort of disaster results from the use of this flag for
13182 a register in which function values may be returned.
13184 This flag does not have a negative form, because it specifies a
13185 three-way choice.
13187 @item -fpack-struct[=@var{n}]
13188 @opindex fpack-struct
13189 Without a value specified, pack all structure members together without
13190 holes.  When a value is specified (which must be a small power of two), pack
13191 structure members according to this value, representing the maximum
13192 alignment (that is, objects with default alignment requirements larger than
13193 this are output potentially unaligned at the next fitting location.
13195 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13196 code that is not binary compatible with code generated without that switch.
13197 Additionally, it makes the code suboptimal.
13198 Use it to conform to a non-default application binary interface.
13200 @item -fleading-underscore
13201 @opindex fleading-underscore
13202 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13203 change the way C symbols are represented in the object file.  One use
13204 is to help link with legacy assembly code.
13206 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13207 generate code that is not binary compatible with code generated without that
13208 switch.  Use it to conform to a non-default application binary interface.
13209 Not all targets provide complete support for this switch.
13211 @item -ftls-model=@var{model}
13212 @opindex ftls-model
13213 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13214 The @var{model} argument should be one of @samp{global-dynamic},
13215 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
13216 Note that the choice is subject to optimization: the compiler may use
13217 a more efficient model for symbols not visible outside of the translation
13218 unit, or if @option{-fpic} is not given on the command line.
13220 The default without @option{-fpic} is @samp{initial-exec}; with
13221 @option{-fpic} the default is @samp{global-dynamic}.
13223 @item -ftrampolines
13224 @opindex ftrampolines
13225 For targets that normally need trampolines for nested functions, always
13226 generate them instead of using descriptors.  Otherwise, for targets that
13227 do not need them, like for example HP-PA or IA-64, do nothing.
13229 A trampoline is a small piece of code that is created at run time on the
13230 stack when the address of a nested function is taken, and is used to call
13231 the nested function indirectly.  Therefore, it requires the stack to be
13232 made executable in order for the program to work properly.
13234 @option{-fno-trampolines} is enabled by default on a language by language
13235 basis to let the compiler avoid generating them, if it computes that this
13236 is safe, and replace them with descriptors.  Descriptors are made up of data
13237 only, but the generated code must be prepared to deal with them.  As of this
13238 writing, @option{-fno-trampolines} is enabled by default only for Ada.
13240 Moreover, code compiled with @option{-ftrampolines} and code compiled with
13241 @option{-fno-trampolines} are not binary compatible if nested functions are
13242 present.  This option must therefore be used on a program-wide basis and be
13243 manipulated with extreme care.
13245 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
13246 @opindex fvisibility
13247 Set the default ELF image symbol visibility to the specified option---all
13248 symbols are marked with this unless overridden within the code.
13249 Using this feature can very substantially improve linking and
13250 load times of shared object libraries, produce more optimized
13251 code, provide near-perfect API export and prevent symbol clashes.
13252 It is @strong{strongly} recommended that you use this in any shared objects
13253 you distribute.
13255 Despite the nomenclature, @samp{default} always means public; i.e.,
13256 available to be linked against from outside the shared object.
13257 @samp{protected} and @samp{internal} are pretty useless in real-world
13258 usage so the only other commonly used option is @samp{hidden}.
13259 The default if @option{-fvisibility} isn't specified is
13260 @samp{default}, i.e., make every symbol public.
13262 A good explanation of the benefits offered by ensuring ELF
13263 symbols have the correct visibility is given by ``How To Write
13264 Shared Libraries'' by Ulrich Drepper (which can be found at
13265 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13266 solution made possible by this option to marking things hidden when
13267 the default is public is to make the default hidden and mark things
13268 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13269 and @code{__attribute__ ((visibility("default")))} instead of
13270 @code{__declspec(dllexport)} you get almost identical semantics with
13271 identical syntax.  This is a great boon to those working with
13272 cross-platform projects.
13274 For those adding visibility support to existing code, you may find
13275 @code{#pragma GCC visibility} of use.  This works by you enclosing
13276 the declarations you wish to set visibility for with (for example)
13277 @code{#pragma GCC visibility push(hidden)} and
13278 @code{#pragma GCC visibility pop}.
13279 Bear in mind that symbol visibility should be viewed @strong{as
13280 part of the API interface contract} and thus all new code should
13281 always specify visibility when it is not the default; i.e., declarations
13282 only for use within the local DSO should @strong{always} be marked explicitly
13283 as hidden as so to avoid PLT indirection overheads---making this
13284 abundantly clear also aids readability and self-documentation of the code.
13285 Note that due to ISO C++ specification requirements, @code{operator new} and
13286 @code{operator delete} must always be of default visibility.
13288 Be aware that headers from outside your project, in particular system
13289 headers and headers from any other library you use, may not be
13290 expecting to be compiled with visibility other than the default.  You
13291 may need to explicitly say @code{#pragma GCC visibility push(default)}
13292 before including any such headers.
13294 @code{extern} declarations are not affected by @option{-fvisibility}, so
13295 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13296 no modifications.  However, this means that calls to @code{extern}
13297 functions with no explicit visibility use the PLT, so it is more
13298 effective to use @code{__attribute ((visibility))} and/or
13299 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13300 declarations should be treated as hidden.
13302 Note that @option{-fvisibility} does affect C++ vague linkage
13303 entities. This means that, for instance, an exception class that is
13304 be thrown between DSOs must be explicitly marked with default
13305 visibility so that the @samp{type_info} nodes are unified between
13306 the DSOs.
13308 An overview of these techniques, their benefits and how to use them
13309 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13311 @item -fstrict-volatile-bitfields
13312 @opindex fstrict-volatile-bitfields
13313 This option should be used if accesses to volatile bit-fields (or other
13314 structure fields, although the compiler usually honors those types
13315 anyway) should use a single access of the width of the
13316 field's type, aligned to a natural alignment if possible.  For
13317 example, targets with memory-mapped peripheral registers might require
13318 all such accesses to be 16 bits wide; with this flag you can
13319 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13320 is 16 bits on these targets) to force GCC to use 16-bit accesses
13321 instead of, perhaps, a more efficient 32-bit access.
13323 If this option is disabled, the compiler uses the most efficient
13324 instruction.  In the previous example, that might be a 32-bit load
13325 instruction, even though that accesses bytes that do not contain
13326 any portion of the bit-field, or memory-mapped registers unrelated to
13327 the one being updated.
13329 In some cases, such as when the @code{packed} attribute is applied to a 
13330 structure field, it may not be possible to access the field with a single
13331 read or write that is correctly aligned for the target machine.  In this
13332 case GCC falls back to generating multiple accesses rather than code that 
13333 will fault or truncate the result at run time.
13335 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13336 not allowed to touch non bit-field members.  It is therefore recommended
13337 to define all bits of the field's type as bit-field members.
13339 The default value of this option is determined by the application binary
13340 interface for the target processor.
13342 @item -fsync-libcalls
13343 @opindex fsync-libcalls
13344 This option controls whether any out-of-line instance of the @code{__sync}
13345 family of functions may be used to implement the C++11 @code{__atomic}
13346 family of functions.
13348 The default value of this option is enabled, thus the only useful form
13349 of the option is @option{-fno-sync-libcalls}.  This option is used in
13350 the implementation of the @file{libatomic} runtime library.
13352 @end table
13354 @node Developer Options
13355 @section GCC Developer Options
13356 @cindex developer options
13357 @cindex debugging GCC
13358 @cindex debug dump options
13359 @cindex dump options
13360 @cindex compilation statistics
13362 This section describes command-line options that are primarily of
13363 interest to GCC developers, including options to support compiler
13364 testing and investigation of compiler bugs and compile-time
13365 performance problems.  This includes options that produce debug dumps
13366 at various points in the compilation; that print statistics such as
13367 memory use and execution time; and that print information about GCC's
13368 configuration, such as where it searches for libraries.  You should
13369 rarely need to use any of these options for ordinary compilation and
13370 linking tasks.
13372 Many developer options that cause GCC to dump output to a file take an
13373 optional @samp{=@var{filename}} suffix. You can specify @samp{stdout}
13374 or @samp{-} to dump to standard output, and @samp{stderr} for standard
13375 error.
13377 If @samp{=@var{filename}} is omitted, a default dump file name is
13378 constructed by concatenating the base dump file name, a pass number,
13379 phase letter, and pass name.  The base dump file name is the name of
13380 output file produced by the compiler if explicitly specified and not
13381 an executable; otherwise it is the source file name.
13382 The pass number is determined by the order passes are registered with
13383 the compiler's pass manager. 
13384 This is generally the same as the order of execution, but passes
13385 registered by plugins, target-specific passes, or passes that are
13386 otherwise registered late are numbered higher than the pass named
13387 @samp{final}, even if they are executed earlier.  The phase letter is
13388 one of @samp{i} (inter-procedural analysis), @samp{l}
13389 (language-specific), @samp{r} (RTL), or @samp{t} (tree). 
13390 The files are created in the directory of the output file. 
13392 @table @gcctabopt
13394 @item -d@var{letters}
13395 @itemx -fdump-rtl-@var{pass}
13396 @itemx -fdump-rtl-@var{pass}=@var{filename}
13397 @opindex d
13398 @opindex fdump-rtl-@var{pass}
13399 Says to make debugging dumps during compilation at times specified by
13400 @var{letters}.  This is used for debugging the RTL-based passes of the
13401 compiler.
13403 Some @option{-d@var{letters}} switches have different meaning when
13404 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13405 for information about preprocessor-specific dump options.
13407 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13408 @option{-d} option @var{letters}.  Here are the possible
13409 letters for use in @var{pass} and @var{letters}, and their meanings:
13411 @table @gcctabopt
13413 @item -fdump-rtl-alignments
13414 @opindex fdump-rtl-alignments
13415 Dump after branch alignments have been computed.
13417 @item -fdump-rtl-asmcons
13418 @opindex fdump-rtl-asmcons
13419 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13421 @item -fdump-rtl-auto_inc_dec
13422 @opindex fdump-rtl-auto_inc_dec
13423 Dump after auto-inc-dec discovery.  This pass is only run on
13424 architectures that have auto inc or auto dec instructions.
13426 @item -fdump-rtl-barriers
13427 @opindex fdump-rtl-barriers
13428 Dump after cleaning up the barrier instructions.
13430 @item -fdump-rtl-bbpart
13431 @opindex fdump-rtl-bbpart
13432 Dump after partitioning hot and cold basic blocks.
13434 @item -fdump-rtl-bbro
13435 @opindex fdump-rtl-bbro
13436 Dump after block reordering.
13438 @item -fdump-rtl-btl1
13439 @itemx -fdump-rtl-btl2
13440 @opindex fdump-rtl-btl2
13441 @opindex fdump-rtl-btl2
13442 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13443 after the two branch
13444 target load optimization passes.
13446 @item -fdump-rtl-bypass
13447 @opindex fdump-rtl-bypass
13448 Dump after jump bypassing and control flow optimizations.
13450 @item -fdump-rtl-combine
13451 @opindex fdump-rtl-combine
13452 Dump after the RTL instruction combination pass.
13454 @item -fdump-rtl-compgotos
13455 @opindex fdump-rtl-compgotos
13456 Dump after duplicating the computed gotos.
13458 @item -fdump-rtl-ce1
13459 @itemx -fdump-rtl-ce2
13460 @itemx -fdump-rtl-ce3
13461 @opindex fdump-rtl-ce1
13462 @opindex fdump-rtl-ce2
13463 @opindex fdump-rtl-ce3
13464 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13465 @option{-fdump-rtl-ce3} enable dumping after the three
13466 if conversion passes.
13468 @item -fdump-rtl-cprop_hardreg
13469 @opindex fdump-rtl-cprop_hardreg
13470 Dump after hard register copy propagation.
13472 @item -fdump-rtl-csa
13473 @opindex fdump-rtl-csa
13474 Dump after combining stack adjustments.
13476 @item -fdump-rtl-cse1
13477 @itemx -fdump-rtl-cse2
13478 @opindex fdump-rtl-cse1
13479 @opindex fdump-rtl-cse2
13480 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13481 the two common subexpression elimination passes.
13483 @item -fdump-rtl-dce
13484 @opindex fdump-rtl-dce
13485 Dump after the standalone dead code elimination passes.
13487 @item -fdump-rtl-dbr
13488 @opindex fdump-rtl-dbr
13489 Dump after delayed branch scheduling.
13491 @item -fdump-rtl-dce1
13492 @itemx -fdump-rtl-dce2
13493 @opindex fdump-rtl-dce1
13494 @opindex fdump-rtl-dce2
13495 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13496 the two dead store elimination passes.
13498 @item -fdump-rtl-eh
13499 @opindex fdump-rtl-eh
13500 Dump after finalization of EH handling code.
13502 @item -fdump-rtl-eh_ranges
13503 @opindex fdump-rtl-eh_ranges
13504 Dump after conversion of EH handling range regions.
13506 @item -fdump-rtl-expand
13507 @opindex fdump-rtl-expand
13508 Dump after RTL generation.
13510 @item -fdump-rtl-fwprop1
13511 @itemx -fdump-rtl-fwprop2
13512 @opindex fdump-rtl-fwprop1
13513 @opindex fdump-rtl-fwprop2
13514 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13515 dumping after the two forward propagation passes.
13517 @item -fdump-rtl-gcse1
13518 @itemx -fdump-rtl-gcse2
13519 @opindex fdump-rtl-gcse1
13520 @opindex fdump-rtl-gcse2
13521 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13522 after global common subexpression elimination.
13524 @item -fdump-rtl-init-regs
13525 @opindex fdump-rtl-init-regs
13526 Dump after the initialization of the registers.
13528 @item -fdump-rtl-initvals
13529 @opindex fdump-rtl-initvals
13530 Dump after the computation of the initial value sets.
13532 @item -fdump-rtl-into_cfglayout
13533 @opindex fdump-rtl-into_cfglayout
13534 Dump after converting to cfglayout mode.
13536 @item -fdump-rtl-ira
13537 @opindex fdump-rtl-ira
13538 Dump after iterated register allocation.
13540 @item -fdump-rtl-jump
13541 @opindex fdump-rtl-jump
13542 Dump after the second jump optimization.
13544 @item -fdump-rtl-loop2
13545 @opindex fdump-rtl-loop2
13546 @option{-fdump-rtl-loop2} enables dumping after the rtl
13547 loop optimization passes.
13549 @item -fdump-rtl-mach
13550 @opindex fdump-rtl-mach
13551 Dump after performing the machine dependent reorganization pass, if that
13552 pass exists.
13554 @item -fdump-rtl-mode_sw
13555 @opindex fdump-rtl-mode_sw
13556 Dump after removing redundant mode switches.
13558 @item -fdump-rtl-rnreg
13559 @opindex fdump-rtl-rnreg
13560 Dump after register renumbering.
13562 @item -fdump-rtl-outof_cfglayout
13563 @opindex fdump-rtl-outof_cfglayout
13564 Dump after converting from cfglayout mode.
13566 @item -fdump-rtl-peephole2
13567 @opindex fdump-rtl-peephole2
13568 Dump after the peephole pass.
13570 @item -fdump-rtl-postreload
13571 @opindex fdump-rtl-postreload
13572 Dump after post-reload optimizations.
13574 @item -fdump-rtl-pro_and_epilogue
13575 @opindex fdump-rtl-pro_and_epilogue
13576 Dump after generating the function prologues and epilogues.
13578 @item -fdump-rtl-sched1
13579 @itemx -fdump-rtl-sched2
13580 @opindex fdump-rtl-sched1
13581 @opindex fdump-rtl-sched2
13582 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13583 after the basic block scheduling passes.
13585 @item -fdump-rtl-ree
13586 @opindex fdump-rtl-ree
13587 Dump after sign/zero extension elimination.
13589 @item -fdump-rtl-seqabstr
13590 @opindex fdump-rtl-seqabstr
13591 Dump after common sequence discovery.
13593 @item -fdump-rtl-shorten
13594 @opindex fdump-rtl-shorten
13595 Dump after shortening branches.
13597 @item -fdump-rtl-sibling
13598 @opindex fdump-rtl-sibling
13599 Dump after sibling call optimizations.
13601 @item -fdump-rtl-split1
13602 @itemx -fdump-rtl-split2
13603 @itemx -fdump-rtl-split3
13604 @itemx -fdump-rtl-split4
13605 @itemx -fdump-rtl-split5
13606 @opindex fdump-rtl-split1
13607 @opindex fdump-rtl-split2
13608 @opindex fdump-rtl-split3
13609 @opindex fdump-rtl-split4
13610 @opindex fdump-rtl-split5
13611 These options enable dumping after five rounds of
13612 instruction splitting.
13614 @item -fdump-rtl-sms
13615 @opindex fdump-rtl-sms
13616 Dump after modulo scheduling.  This pass is only run on some
13617 architectures.
13619 @item -fdump-rtl-stack
13620 @opindex fdump-rtl-stack
13621 Dump after conversion from GCC's ``flat register file'' registers to the
13622 x87's stack-like registers.  This pass is only run on x86 variants.
13624 @item -fdump-rtl-subreg1
13625 @itemx -fdump-rtl-subreg2
13626 @opindex fdump-rtl-subreg1
13627 @opindex fdump-rtl-subreg2
13628 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13629 the two subreg expansion passes.
13631 @item -fdump-rtl-unshare
13632 @opindex fdump-rtl-unshare
13633 Dump after all rtl has been unshared.
13635 @item -fdump-rtl-vartrack
13636 @opindex fdump-rtl-vartrack
13637 Dump after variable tracking.
13639 @item -fdump-rtl-vregs
13640 @opindex fdump-rtl-vregs
13641 Dump after converting virtual registers to hard registers.
13643 @item -fdump-rtl-web
13644 @opindex fdump-rtl-web
13645 Dump after live range splitting.
13647 @item -fdump-rtl-regclass
13648 @itemx -fdump-rtl-subregs_of_mode_init
13649 @itemx -fdump-rtl-subregs_of_mode_finish
13650 @itemx -fdump-rtl-dfinit
13651 @itemx -fdump-rtl-dfinish
13652 @opindex fdump-rtl-regclass
13653 @opindex fdump-rtl-subregs_of_mode_init
13654 @opindex fdump-rtl-subregs_of_mode_finish
13655 @opindex fdump-rtl-dfinit
13656 @opindex fdump-rtl-dfinish
13657 These dumps are defined but always produce empty files.
13659 @item -da
13660 @itemx -fdump-rtl-all
13661 @opindex da
13662 @opindex fdump-rtl-all
13663 Produce all the dumps listed above.
13665 @item -dA
13666 @opindex dA
13667 Annotate the assembler output with miscellaneous debugging information.
13669 @item -dD
13670 @opindex dD
13671 Dump all macro definitions, at the end of preprocessing, in addition to
13672 normal output.
13674 @item -dH
13675 @opindex dH
13676 Produce a core dump whenever an error occurs.
13678 @item -dp
13679 @opindex dp
13680 Annotate the assembler output with a comment indicating which
13681 pattern and alternative is used.  The length and cost of each instruction are
13682 also printed.
13684 @item -dP
13685 @opindex dP
13686 Dump the RTL in the assembler output as a comment before each instruction.
13687 Also turns on @option{-dp} annotation.
13689 @item -dx
13690 @opindex dx
13691 Just generate RTL for a function instead of compiling it.  Usually used
13692 with @option{-fdump-rtl-expand}.
13693 @end table
13695 @item -fdump-noaddr
13696 @opindex fdump-noaddr
13697 When doing debugging dumps, suppress address output.  This makes it more
13698 feasible to use diff on debugging dumps for compiler invocations with
13699 different compiler binaries and/or different
13700 text / bss / data / heap / stack / dso start locations.
13702 @item -freport-bug
13703 @opindex freport-bug
13704 Collect and dump debug information into a temporary file if an
13705 internal compiler error (ICE) occurs.
13707 @item -fdump-unnumbered
13708 @opindex fdump-unnumbered
13709 When doing debugging dumps, suppress instruction numbers and address output.
13710 This makes it more feasible to use diff on debugging dumps for compiler
13711 invocations with different options, in particular with and without
13712 @option{-g}.
13714 @item -fdump-unnumbered-links
13715 @opindex fdump-unnumbered-links
13716 When doing debugging dumps (see @option{-d} option above), suppress
13717 instruction numbers for the links to the previous and next instructions
13718 in a sequence.
13720 @item -fdump-ipa-@var{switch}
13721 @opindex fdump-ipa
13722 Control the dumping at various stages of inter-procedural analysis
13723 language tree to a file.  The file name is generated by appending a
13724 switch specific suffix to the source file name, and the file is created
13725 in the same directory as the output file.  The following dumps are
13726 possible:
13728 @table @samp
13729 @item all
13730 Enables all inter-procedural analysis dumps.
13732 @item cgraph
13733 Dumps information about call-graph optimization, unused function removal,
13734 and inlining decisions.
13736 @item inline
13737 Dump after function inlining.
13739 @end table
13741 @item -fdump-lang-all
13742 @itemx -fdump-lang-@var{switch}
13743 @itemx -fdump-lang-@var{switch}-@var{options}
13744 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13745 @opindex fdump-lang-all
13746 @opindex fdump-lang
13747 Control the dumping of language-specific information.  The @var{options}
13748 and @var{filename} portions behave as described in the
13749 @option{-fdump-tree} option.  The following @var{switch} values are
13750 accepted:
13752 @table @samp
13753 @item all
13755 Enable all language-specific dumps.
13757 @item class
13758 Dump class hierarchy information.  Virtual table information is emitted
13759 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13761 @item raw
13762 Dump the raw internal tree data.  This option is applicable to C++ only.
13764 @end table
13766 @item -fdump-passes
13767 @opindex fdump-passes
13768 Print on @file{stderr} the list of optimization passes that are turned
13769 on and off by the current command-line options.
13771 @item -fdump-statistics-@var{option}
13772 @opindex fdump-statistics
13773 Enable and control dumping of pass statistics in a separate file.  The
13774 file name is generated by appending a suffix ending in
13775 @samp{.statistics} to the source file name, and the file is created in
13776 the same directory as the output file.  If the @samp{-@var{option}}
13777 form is used, @samp{-stats} causes counters to be summed over the
13778 whole compilation unit while @samp{-details} dumps every event as
13779 the passes generate them.  The default with no option is to sum
13780 counters for each function compiled.
13782 @item -fdump-tree-all
13783 @itemx -fdump-tree-@var{switch}
13784 @itemx -fdump-tree-@var{switch}-@var{options}
13785 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13786 @opindex fdump-tree-all
13787 @opindex fdump-tree
13788 Control the dumping at various stages of processing the intermediate
13789 language tree to a file.  If the @samp{-@var{options}}
13790 form is used, @var{options} is a list of @samp{-} separated options
13791 which control the details of the dump.  Not all options are applicable
13792 to all dumps; those that are not meaningful are ignored.  The
13793 following options are available
13795 @table @samp
13796 @item address
13797 Print the address of each node.  Usually this is not meaningful as it
13798 changes according to the environment and source file.  Its primary use
13799 is for tying up a dump file with a debug environment.
13800 @item asmname
13801 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13802 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13803 use working backward from mangled names in the assembly file.
13804 @item slim
13805 When dumping front-end intermediate representations, inhibit dumping
13806 of members of a scope or body of a function merely because that scope
13807 has been reached.  Only dump such items when they are directly reachable
13808 by some other path.
13810 When dumping pretty-printed trees, this option inhibits dumping the
13811 bodies of control structures.
13813 When dumping RTL, print the RTL in slim (condensed) form instead of
13814 the default LISP-like representation.
13815 @item raw
13816 Print a raw representation of the tree.  By default, trees are
13817 pretty-printed into a C-like representation.
13818 @item details
13819 Enable more detailed dumps (not honored by every dump option). Also
13820 include information from the optimization passes.
13821 @item stats
13822 Enable dumping various statistics about the pass (not honored by every dump
13823 option).
13824 @item blocks
13825 Enable showing basic block boundaries (disabled in raw dumps).
13826 @item graph
13827 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13828 dump a representation of the control flow graph suitable for viewing with
13829 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13830 the file is pretty-printed as a subgraph, so that GraphViz can render them
13831 all in a single plot.
13833 This option currently only works for RTL dumps, and the RTL is always
13834 dumped in slim form.
13835 @item vops
13836 Enable showing virtual operands for every statement.
13837 @item lineno
13838 Enable showing line numbers for statements.
13839 @item uid
13840 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13841 @item verbose
13842 Enable showing the tree dump for each statement.
13843 @item eh
13844 Enable showing the EH region number holding each statement.
13845 @item scev
13846 Enable showing scalar evolution analysis details.
13847 @item optimized
13848 Enable showing optimization information (only available in certain
13849 passes).
13850 @item missed
13851 Enable showing missed optimization information (only available in certain
13852 passes).
13853 @item note
13854 Enable other detailed optimization information (only available in
13855 certain passes).
13856 @item all
13857 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13858 and @option{lineno}.
13859 @item optall
13860 Turn on all optimization options, i.e., @option{optimized},
13861 @option{missed}, and @option{note}.
13862 @end table
13864 To determine what tree dumps are available or find the dump for a pass
13865 of interest follow the steps below.
13867 @enumerate
13868 @item
13869 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13870 look for a code that corresponds to the pass you are interested in.
13871 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13872 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13873 The number at the end distinguishes distinct invocations of the same pass.
13874 @item
13875 To enable the creation of the dump file, append the pass code to
13876 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13877 to enable the dump from the Early Value Range Propagation pass, invoke
13878 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13879 specify the name of the dump file.  If you don't specify one, GCC
13880 creates as described below.
13881 @item
13882 Find the pass dump in a file whose name is composed of three components
13883 separated by a period: the name of the source file GCC was invoked to
13884 compile, a numeric suffix indicating the pass number followed by the
13885 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13886 and finally the pass code.  For example, the Early VRP pass dump might
13887 be in a file named @file{myfile.c.038t.evrp} in the current working
13888 directory.  Note that the numeric codes are not stable and may change
13889 from one version of GCC to another.
13890 @end enumerate
13892 @item -fopt-info
13893 @itemx -fopt-info-@var{options}
13894 @itemx -fopt-info-@var{options}=@var{filename}
13895 @opindex fopt-info
13896 Controls optimization dumps from various optimization passes. If the
13897 @samp{-@var{options}} form is used, @var{options} is a list of
13898 @samp{-} separated option keywords to select the dump details and
13899 optimizations.  
13901 The @var{options} can be divided into two groups: options describing the
13902 verbosity of the dump, and options describing which optimizations
13903 should be included. The options from both the groups can be freely
13904 mixed as they are non-overlapping. However, in case of any conflicts,
13905 the later options override the earlier options on the command
13906 line. 
13908 The following options control the dump verbosity:
13910 @table @samp
13911 @item optimized
13912 Print information when an optimization is successfully applied. It is
13913 up to a pass to decide which information is relevant. For example, the
13914 vectorizer passes print the source location of loops which are
13915 successfully vectorized.
13916 @item missed
13917 Print information about missed optimizations. Individual passes
13918 control which information to include in the output. 
13919 @item note
13920 Print verbose information about optimizations, such as certain
13921 transformations, more detailed messages about decisions etc.
13922 @item all
13923 Print detailed optimization information. This includes
13924 @samp{optimized}, @samp{missed}, and @samp{note}.
13925 @end table
13927 One or more of the following option keywords can be used to describe a
13928 group of optimizations:
13930 @table @samp
13931 @item ipa
13932 Enable dumps from all interprocedural optimizations.
13933 @item loop
13934 Enable dumps from all loop optimizations.
13935 @item inline
13936 Enable dumps from all inlining optimizations.
13937 @item omp
13938 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13939 @item vec
13940 Enable dumps from all vectorization optimizations.
13941 @item optall
13942 Enable dumps from all optimizations. This is a superset of
13943 the optimization groups listed above.
13944 @end table
13946 If @var{options} is
13947 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13948 info about successful optimizations from all the passes.  
13950 If the @var{filename} is provided, then the dumps from all the
13951 applicable optimizations are concatenated into the @var{filename}.
13952 Otherwise the dump is output onto @file{stderr}. Though multiple
13953 @option{-fopt-info} options are accepted, only one of them can include
13954 a @var{filename}. If other filenames are provided then all but the
13955 first such option are ignored.
13957 Note that the output @var{filename} is overwritten
13958 in case of multiple translation units. If a combined output from
13959 multiple translation units is desired, @file{stderr} should be used
13960 instead.
13962 In the following example, the optimization info is output to
13963 @file{stderr}:
13965 @smallexample
13966 gcc -O3 -fopt-info
13967 @end smallexample
13969 This example:
13970 @smallexample
13971 gcc -O3 -fopt-info-missed=missed.all
13972 @end smallexample
13974 @noindent
13975 outputs missed optimization report from all the passes into
13976 @file{missed.all}, and this one:
13978 @smallexample
13979 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13980 @end smallexample
13982 @noindent
13983 prints information about missed optimization opportunities from
13984 vectorization passes on @file{stderr}.  
13985 Note that @option{-fopt-info-vec-missed} is equivalent to 
13986 @option{-fopt-info-missed-vec}.  The order of the optimization group
13987 names and message types listed after @option{-fopt-info} does not matter.
13989 As another example,
13990 @smallexample
13991 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13992 @end smallexample
13994 @noindent
13995 outputs information about missed optimizations as well as
13996 optimized locations from all the inlining passes into
13997 @file{inline.txt}.
13999 Finally, consider:
14001 @smallexample
14002 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
14003 @end smallexample
14005 @noindent
14006 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
14007 in conflict since only one output file is allowed. In this case, only
14008 the first option takes effect and the subsequent options are
14009 ignored. Thus only @file{vec.miss} is produced which contains
14010 dumps from the vectorizer about missed opportunities.
14012 @item -fsched-verbose=@var{n}
14013 @opindex fsched-verbose
14014 On targets that use instruction scheduling, this option controls the
14015 amount of debugging output the scheduler prints to the dump files.
14017 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
14018 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
14019 For @var{n} greater than one, it also output basic block probabilities,
14020 detailed ready list information and unit/insn info.  For @var{n} greater
14021 than two, it includes RTL at abort point, control-flow and regions info.
14022 And for @var{n} over four, @option{-fsched-verbose} also includes
14023 dependence info.
14027 @item -fenable-@var{kind}-@var{pass}
14028 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
14029 @opindex fdisable-
14030 @opindex fenable-
14032 This is a set of options that are used to explicitly disable/enable
14033 optimization passes.  These options are intended for use for debugging GCC.
14034 Compiler users should use regular options for enabling/disabling
14035 passes instead.
14037 @table @gcctabopt
14039 @item -fdisable-ipa-@var{pass}
14040 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
14041 statically invoked in the compiler multiple times, the pass name should be
14042 appended with a sequential number starting from 1.
14044 @item -fdisable-rtl-@var{pass}
14045 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
14046 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14047 statically invoked in the compiler multiple times, the pass name should be
14048 appended with a sequential number starting from 1.  @var{range-list} is a 
14049 comma-separated list of function ranges or assembler names.  Each range is a number
14050 pair separated by a colon.  The range is inclusive in both ends.  If the range
14051 is trivial, the number pair can be simplified as a single number.  If the
14052 function's call graph node's @var{uid} falls within one of the specified ranges,
14053 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
14054 function header of a dump file, and the pass names can be dumped by using
14055 option @option{-fdump-passes}.
14057 @item -fdisable-tree-@var{pass}
14058 @itemx -fdisable-tree-@var{pass}=@var{range-list}
14059 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
14060 option arguments.
14062 @item -fenable-ipa-@var{pass}
14063 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
14064 statically invoked in the compiler multiple times, the pass name should be
14065 appended with a sequential number starting from 1.
14067 @item -fenable-rtl-@var{pass}
14068 @itemx -fenable-rtl-@var{pass}=@var{range-list}
14069 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
14070 description and examples.
14072 @item -fenable-tree-@var{pass}
14073 @itemx -fenable-tree-@var{pass}=@var{range-list}
14074 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
14075 of option arguments.
14077 @end table
14079 Here are some examples showing uses of these options.
14081 @smallexample
14083 # disable ccp1 for all functions
14084    -fdisable-tree-ccp1
14085 # disable complete unroll for function whose cgraph node uid is 1
14086    -fenable-tree-cunroll=1
14087 # disable gcse2 for functions at the following ranges [1,1],
14088 # [300,400], and [400,1000]
14089 # disable gcse2 for functions foo and foo2
14090    -fdisable-rtl-gcse2=foo,foo2
14091 # disable early inlining
14092    -fdisable-tree-einline
14093 # disable ipa inlining
14094    -fdisable-ipa-inline
14095 # enable tree full unroll
14096    -fenable-tree-unroll
14098 @end smallexample
14100 @item -fchecking
14101 @itemx -fchecking=@var{n}
14102 @opindex fchecking
14103 @opindex fno-checking
14104 Enable internal consistency checking.  The default depends on
14105 the compiler configuration.  @option{-fchecking=2} enables further
14106 internal consistency checking that might affect code generation.
14108 @item -frandom-seed=@var{string}
14109 @opindex frandom-seed
14110 This option provides a seed that GCC uses in place of
14111 random numbers in generating certain symbol names
14112 that have to be different in every compiled file.  It is also used to
14113 place unique stamps in coverage data files and the object files that
14114 produce them.  You can use the @option{-frandom-seed} option to produce
14115 reproducibly identical object files.
14117 The @var{string} can either be a number (decimal, octal or hex) or an
14118 arbitrary string (in which case it's converted to a number by
14119 computing CRC32).
14121 The @var{string} should be different for every file you compile.
14123 @item -save-temps
14124 @itemx -save-temps=cwd
14125 @opindex save-temps
14126 Store the usual ``temporary'' intermediate files permanently; place them
14127 in the current directory and name them based on the source file.  Thus,
14128 compiling @file{foo.c} with @option{-c -save-temps} produces files
14129 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
14130 preprocessed @file{foo.i} output file even though the compiler now
14131 normally uses an integrated preprocessor.
14133 When used in combination with the @option{-x} command-line option,
14134 @option{-save-temps} is sensible enough to avoid over writing an
14135 input source file with the same extension as an intermediate file.
14136 The corresponding intermediate file may be obtained by renaming the
14137 source file before using @option{-save-temps}.
14139 If you invoke GCC in parallel, compiling several different source
14140 files that share a common base name in different subdirectories or the
14141 same source file compiled for multiple output destinations, it is
14142 likely that the different parallel compilers will interfere with each
14143 other, and overwrite the temporary files.  For instance:
14145 @smallexample
14146 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
14147 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
14148 @end smallexample
14150 may result in @file{foo.i} and @file{foo.o} being written to
14151 simultaneously by both compilers.
14153 @item -save-temps=obj
14154 @opindex save-temps=obj
14155 Store the usual ``temporary'' intermediate files permanently.  If the
14156 @option{-o} option is used, the temporary files are based on the
14157 object file.  If the @option{-o} option is not used, the
14158 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
14160 For example:
14162 @smallexample
14163 gcc -save-temps=obj -c foo.c
14164 gcc -save-temps=obj -c bar.c -o dir/xbar.o
14165 gcc -save-temps=obj foobar.c -o dir2/yfoobar
14166 @end smallexample
14168 @noindent
14169 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
14170 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
14171 @file{dir2/yfoobar.o}.
14173 @item -time@r{[}=@var{file}@r{]}
14174 @opindex time
14175 Report the CPU time taken by each subprocess in the compilation
14176 sequence.  For C source files, this is the compiler proper and assembler
14177 (plus the linker if linking is done).
14179 Without the specification of an output file, the output looks like this:
14181 @smallexample
14182 # cc1 0.12 0.01
14183 # as 0.00 0.01
14184 @end smallexample
14186 The first number on each line is the ``user time'', that is time spent
14187 executing the program itself.  The second number is ``system time'',
14188 time spent executing operating system routines on behalf of the program.
14189 Both numbers are in seconds.
14191 With the specification of an output file, the output is appended to the
14192 named file, and it looks like this:
14194 @smallexample
14195 0.12 0.01 cc1 @var{options}
14196 0.00 0.01 as @var{options}
14197 @end smallexample
14199 The ``user time'' and the ``system time'' are moved before the program
14200 name, and the options passed to the program are displayed, so that one
14201 can later tell what file was being compiled, and with which options.
14203 @item -fdump-final-insns@r{[}=@var{file}@r{]}
14204 @opindex fdump-final-insns
14205 Dump the final internal representation (RTL) to @var{file}.  If the
14206 optional argument is omitted (or if @var{file} is @code{.}), the name
14207 of the dump file is determined by appending @code{.gkd} to the
14208 compilation output file name.
14210 @item -fcompare-debug@r{[}=@var{opts}@r{]}
14211 @opindex fcompare-debug
14212 @opindex fno-compare-debug
14213 If no error occurs during compilation, run the compiler a second time,
14214 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14215 passed to the second compilation.  Dump the final internal
14216 representation in both compilations, and print an error if they differ.
14218 If the equal sign is omitted, the default @option{-gtoggle} is used.
14220 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14221 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14222 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14223 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14224 is used.
14226 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14227 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14228 of the final representation and the second compilation, preventing even
14229 @env{GCC_COMPARE_DEBUG} from taking effect.
14231 To verify full coverage during @option{-fcompare-debug} testing, set
14232 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14233 which GCC rejects as an invalid option in any actual compilation
14234 (rather than preprocessing, assembly or linking).  To get just a
14235 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14236 not overridden} will do.
14238 @item -fcompare-debug-second
14239 @opindex fcompare-debug-second
14240 This option is implicitly passed to the compiler for the second
14241 compilation requested by @option{-fcompare-debug}, along with options to
14242 silence warnings, and omitting other options that would cause the compiler
14243 to produce output to files or to standard output as a side effect.  Dump
14244 files and preserved temporary files are renamed so as to contain the
14245 @code{.gk} additional extension during the second compilation, to avoid
14246 overwriting those generated by the first.
14248 When this option is passed to the compiler driver, it causes the
14249 @emph{first} compilation to be skipped, which makes it useful for little
14250 other than debugging the compiler proper.
14252 @item -gtoggle
14253 @opindex gtoggle
14254 Turn off generation of debug info, if leaving out this option
14255 generates it, or turn it on at level 2 otherwise.  The position of this
14256 argument in the command line does not matter; it takes effect after all
14257 other options are processed, and it does so only once, no matter how
14258 many times it is given.  This is mainly intended to be used with
14259 @option{-fcompare-debug}.
14261 @item -fvar-tracking-assignments-toggle
14262 @opindex fvar-tracking-assignments-toggle
14263 @opindex fno-var-tracking-assignments-toggle
14264 Toggle @option{-fvar-tracking-assignments}, in the same way that
14265 @option{-gtoggle} toggles @option{-g}.
14267 @item -Q
14268 @opindex Q
14269 Makes the compiler print out each function name as it is compiled, and
14270 print some statistics about each pass when it finishes.
14272 @item -ftime-report
14273 @opindex ftime-report
14274 Makes the compiler print some statistics about the time consumed by each
14275 pass when it finishes.
14277 @item -ftime-report-details
14278 @opindex ftime-report-details
14279 Record the time consumed by infrastructure parts separately for each pass.
14281 @item -fira-verbose=@var{n}
14282 @opindex fira-verbose
14283 Control the verbosity of the dump file for the integrated register allocator.
14284 The default value is 5.  If the value @var{n} is greater or equal to 10,
14285 the dump output is sent to stderr using the same format as @var{n} minus 10.
14287 @item -flto-report
14288 @opindex flto-report
14289 Prints a report with internal details on the workings of the link-time
14290 optimizer.  The contents of this report vary from version to version.
14291 It is meant to be useful to GCC developers when processing object
14292 files in LTO mode (via @option{-flto}).
14294 Disabled by default.
14296 @item -flto-report-wpa
14297 @opindex flto-report-wpa
14298 Like @option{-flto-report}, but only print for the WPA phase of Link
14299 Time Optimization.
14301 @item -fmem-report
14302 @opindex fmem-report
14303 Makes the compiler print some statistics about permanent memory
14304 allocation when it finishes.
14306 @item -fmem-report-wpa
14307 @opindex fmem-report-wpa
14308 Makes the compiler print some statistics about permanent memory
14309 allocation for the WPA phase only.
14311 @item -fpre-ipa-mem-report
14312 @opindex fpre-ipa-mem-report
14313 @item -fpost-ipa-mem-report
14314 @opindex fpost-ipa-mem-report
14315 Makes the compiler print some statistics about permanent memory
14316 allocation before or after interprocedural optimization.
14318 @item -fprofile-report
14319 @opindex fprofile-report
14320 Makes the compiler print some statistics about consistency of the
14321 (estimated) profile and effect of individual passes.
14323 @item -fstack-usage
14324 @opindex fstack-usage
14325 Makes the compiler output stack usage information for the program, on a
14326 per-function basis.  The filename for the dump is made by appending
14327 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14328 the output file, if explicitly specified and it is not an executable,
14329 otherwise it is the basename of the source file.  An entry is made up
14330 of three fields:
14332 @itemize
14333 @item
14334 The name of the function.
14335 @item
14336 A number of bytes.
14337 @item
14338 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14339 @end itemize
14341 The qualifier @code{static} means that the function manipulates the stack
14342 statically: a fixed number of bytes are allocated for the frame on function
14343 entry and released on function exit; no stack adjustments are otherwise made
14344 in the function.  The second field is this fixed number of bytes.
14346 The qualifier @code{dynamic} means that the function manipulates the stack
14347 dynamically: in addition to the static allocation described above, stack
14348 adjustments are made in the body of the function, for example to push/pop
14349 arguments around function calls.  If the qualifier @code{bounded} is also
14350 present, the amount of these adjustments is bounded at compile time and
14351 the second field is an upper bound of the total amount of stack used by
14352 the function.  If it is not present, the amount of these adjustments is
14353 not bounded at compile time and the second field only represents the
14354 bounded part.
14356 @item -fstats
14357 @opindex fstats
14358 Emit statistics about front-end processing at the end of the compilation.
14359 This option is supported only by the C++ front end, and
14360 the information is generally only useful to the G++ development team.
14362 @item -fdbg-cnt-list
14363 @opindex fdbg-cnt-list
14364 Print the name and the counter upper bound for all debug counters.
14367 @item -fdbg-cnt=@var{counter-value-list}
14368 @opindex fdbg-cnt
14369 Set the internal debug counter lower and upper bound.  @var{counter-value-list}
14370 is a comma-separated list of @var{name}:@var{lower_bound}:@var{upper_bound}
14371 tuples which sets the lower and the upper bound of each debug
14372 counter @var{name}.  The @var{lower_bound} is optional and is zero
14373 initialized if not set.
14374 All debug counters have the initial upper bound of @code{UINT_MAX};
14375 thus @code{dbg_cnt} returns true always unless the upper bound
14376 is set by this option.
14377 For example, with @option{-fdbg-cnt=dce:2:4,tail_call:10},
14378 @code{dbg_cnt(dce)} returns true only for third and fourth invocation.
14379 For @code{dbg_cnt(tail_call)} true is returned for first 10 invocations.
14381 @item -print-file-name=@var{library}
14382 @opindex print-file-name
14383 Print the full absolute name of the library file @var{library} that
14384 would be used when linking---and don't do anything else.  With this
14385 option, GCC does not compile or link anything; it just prints the
14386 file name.
14388 @item -print-multi-directory
14389 @opindex print-multi-directory
14390 Print the directory name corresponding to the multilib selected by any
14391 other switches present in the command line.  This directory is supposed
14392 to exist in @env{GCC_EXEC_PREFIX}.
14394 @item -print-multi-lib
14395 @opindex print-multi-lib
14396 Print the mapping from multilib directory names to compiler switches
14397 that enable them.  The directory name is separated from the switches by
14398 @samp{;}, and each switch starts with an @samp{@@} instead of the
14399 @samp{-}, without spaces between multiple switches.  This is supposed to
14400 ease shell processing.
14402 @item -print-multi-os-directory
14403 @opindex print-multi-os-directory
14404 Print the path to OS libraries for the selected
14405 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14406 present in the @file{lib} subdirectory and no multilibs are used, this is
14407 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14408 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14409 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14410 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14412 @item -print-multiarch
14413 @opindex print-multiarch
14414 Print the path to OS libraries for the selected multiarch,
14415 relative to some @file{lib} subdirectory.
14417 @item -print-prog-name=@var{program}
14418 @opindex print-prog-name
14419 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14421 @item -print-libgcc-file-name
14422 @opindex print-libgcc-file-name
14423 Same as @option{-print-file-name=libgcc.a}.
14425 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14426 but you do want to link with @file{libgcc.a}.  You can do:
14428 @smallexample
14429 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14430 @end smallexample
14432 @item -print-search-dirs
14433 @opindex print-search-dirs
14434 Print the name of the configured installation directory and a list of
14435 program and library directories @command{gcc} searches---and don't do anything else.
14437 This is useful when @command{gcc} prints the error message
14438 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14439 To resolve this you either need to put @file{cpp0} and the other compiler
14440 components where @command{gcc} expects to find them, or you can set the environment
14441 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14442 Don't forget the trailing @samp{/}.
14443 @xref{Environment Variables}.
14445 @item -print-sysroot
14446 @opindex print-sysroot
14447 Print the target sysroot directory that is used during
14448 compilation.  This is the target sysroot specified either at configure
14449 time or using the @option{--sysroot} option, possibly with an extra
14450 suffix that depends on compilation options.  If no target sysroot is
14451 specified, the option prints nothing.
14453 @item -print-sysroot-headers-suffix
14454 @opindex print-sysroot-headers-suffix
14455 Print the suffix added to the target sysroot when searching for
14456 headers, or give an error if the compiler is not configured with such
14457 a suffix---and don't do anything else.
14459 @item -dumpmachine
14460 @opindex dumpmachine
14461 Print the compiler's target machine (for example,
14462 @samp{i686-pc-linux-gnu})---and don't do anything else.
14464 @item -dumpversion
14465 @opindex dumpversion
14466 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14467 anything else.  This is the compiler version used in filesystem paths,
14468 specs, can be depending on how the compiler has been configured just
14469 a single number (major version), two numbers separated by dot (major and
14470 minor version) or three numbers separated by dots (major, minor and patchlevel
14471 version).
14473 @item -dumpfullversion
14474 @opindex dumpfullversion
14475 Print the full compiler version, always 3 numbers separated by dots,
14476 major, minor and patchlevel version.
14478 @item -dumpspecs
14479 @opindex dumpspecs
14480 Print the compiler's built-in specs---and don't do anything else.  (This
14481 is used when GCC itself is being built.)  @xref{Spec Files}.
14482 @end table
14484 @node Submodel Options
14485 @section Machine-Dependent Options
14486 @cindex submodel options
14487 @cindex specifying hardware config
14488 @cindex hardware models and configurations, specifying
14489 @cindex target-dependent options
14490 @cindex machine-dependent options
14492 Each target machine supported by GCC can have its own options---for
14493 example, to allow you to compile for a particular processor variant or
14494 ABI, or to control optimizations specific to that machine.  By
14495 convention, the names of machine-specific options start with
14496 @samp{-m}.
14498 Some configurations of the compiler also support additional target-specific
14499 options, usually for compatibility with other compilers on the same
14500 platform.
14502 @c This list is ordered alphanumerically by subsection name.
14503 @c It should be the same order and spelling as these options are listed
14504 @c in Machine Dependent Options
14506 @menu
14507 * AArch64 Options::
14508 * Adapteva Epiphany Options::
14509 * ARC Options::
14510 * ARM Options::
14511 * AVR Options::
14512 * Blackfin Options::
14513 * C6X Options::
14514 * CRIS Options::
14515 * CR16 Options::
14516 * Darwin Options::
14517 * DEC Alpha Options::
14518 * FR30 Options::
14519 * FT32 Options::
14520 * FRV Options::
14521 * GNU/Linux Options::
14522 * H8/300 Options::
14523 * HPPA Options::
14524 * IA-64 Options::
14525 * LM32 Options::
14526 * M32C Options::
14527 * M32R/D Options::
14528 * M680x0 Options::
14529 * MCore Options::
14530 * MeP Options::
14531 * MicroBlaze Options::
14532 * MIPS Options::
14533 * MMIX Options::
14534 * MN10300 Options::
14535 * Moxie Options::
14536 * MSP430 Options::
14537 * NDS32 Options::
14538 * Nios II Options::
14539 * Nvidia PTX Options::
14540 * PDP-11 Options::
14541 * picoChip Options::
14542 * PowerPC Options::
14543 * PowerPC SPE Options::
14544 * RISC-V Options::
14545 * RL78 Options::
14546 * RS/6000 and PowerPC Options::
14547 * RX Options::
14548 * S/390 and zSeries Options::
14549 * Score Options::
14550 * SH Options::
14551 * Solaris 2 Options::
14552 * SPARC Options::
14553 * SPU Options::
14554 * System V Options::
14555 * TILE-Gx Options::
14556 * TILEPro Options::
14557 * V850 Options::
14558 * VAX Options::
14559 * Visium Options::
14560 * VMS Options::
14561 * VxWorks Options::
14562 * x86 Options::
14563 * x86 Windows Options::
14564 * Xstormy16 Options::
14565 * Xtensa Options::
14566 * zSeries Options::
14567 @end menu
14569 @node AArch64 Options
14570 @subsection AArch64 Options
14571 @cindex AArch64 Options
14573 These options are defined for AArch64 implementations:
14575 @table @gcctabopt
14577 @item -mabi=@var{name}
14578 @opindex mabi
14579 Generate code for the specified data model.  Permissible values
14580 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14581 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14582 but long int and pointers are 64 bits.
14584 The default depends on the specific target configuration.  Note that
14585 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14586 entire program with the same ABI, and link with a compatible set of libraries.
14588 @item -mbig-endian
14589 @opindex mbig-endian
14590 Generate big-endian code.  This is the default when GCC is configured for an
14591 @samp{aarch64_be-*-*} target.
14593 @item -mgeneral-regs-only
14594 @opindex mgeneral-regs-only
14595 Generate code which uses only the general-purpose registers.  This will prevent
14596 the compiler from using floating-point and Advanced SIMD registers but will not
14597 impose any restrictions on the assembler.
14599 @item -mlittle-endian
14600 @opindex mlittle-endian
14601 Generate little-endian code.  This is the default when GCC is configured for an
14602 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14604 @item -mcmodel=tiny
14605 @opindex mcmodel=tiny
14606 Generate code for the tiny code model.  The program and its statically defined
14607 symbols must be within 1MB of each other.  Programs can be statically or
14608 dynamically linked.
14610 @item -mcmodel=small
14611 @opindex mcmodel=small
14612 Generate code for the small code model.  The program and its statically defined
14613 symbols must be within 4GB of each other.  Programs can be statically or
14614 dynamically linked.  This is the default code model.
14616 @item -mcmodel=large
14617 @opindex mcmodel=large
14618 Generate code for the large code model.  This makes no assumptions about
14619 addresses and sizes of sections.  Programs can be statically linked only.
14621 @item -mstrict-align
14622 @itemx -mno-strict-align
14623 @opindex mstrict-align
14624 @opindex mno-strict-align
14625 Avoid or allow generating memory accesses that may not be aligned on a natural
14626 object boundary as described in the architecture specification.
14628 @item -momit-leaf-frame-pointer
14629 @itemx -mno-omit-leaf-frame-pointer
14630 @opindex momit-leaf-frame-pointer
14631 @opindex mno-omit-leaf-frame-pointer
14632 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14633 default.
14635 @item -mtls-dialect=desc
14636 @opindex mtls-dialect=desc
14637 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14638 of TLS variables.  This is the default.
14640 @item -mtls-dialect=traditional
14641 @opindex mtls-dialect=traditional
14642 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14643 of TLS variables.
14645 @item -mtls-size=@var{size}
14646 @opindex mtls-size
14647 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14648 This option requires binutils 2.26 or newer.
14650 @item -mfix-cortex-a53-835769
14651 @itemx -mno-fix-cortex-a53-835769
14652 @opindex mfix-cortex-a53-835769
14653 @opindex mno-fix-cortex-a53-835769
14654 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14655 This involves inserting a NOP instruction between memory instructions and
14656 64-bit integer multiply-accumulate instructions.
14658 @item -mfix-cortex-a53-843419
14659 @itemx -mno-fix-cortex-a53-843419
14660 @opindex mfix-cortex-a53-843419
14661 @opindex mno-fix-cortex-a53-843419
14662 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14663 This erratum workaround is made at link time and this will only pass the
14664 corresponding flag to the linker.
14666 @item -mlow-precision-recip-sqrt
14667 @itemx -mno-low-precision-recip-sqrt
14668 @opindex mlow-precision-recip-sqrt
14669 @opindex mno-low-precision-recip-sqrt
14670 Enable or disable the reciprocal square root approximation.
14671 This option only has an effect if @option{-ffast-math} or
14672 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14673 precision of reciprocal square root results to about 16 bits for
14674 single precision and to 32 bits for double precision.
14676 @item -mlow-precision-sqrt
14677 @itemx -mno-low-precision-sqrt
14678 @opindex -mlow-precision-sqrt
14679 @opindex -mno-low-precision-sqrt
14680 Enable or disable the square root approximation.
14681 This option only has an effect if @option{-ffast-math} or
14682 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14683 precision of square root results to about 16 bits for
14684 single precision and to 32 bits for double precision.
14685 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14687 @item -mlow-precision-div
14688 @itemx -mno-low-precision-div
14689 @opindex -mlow-precision-div
14690 @opindex -mno-low-precision-div
14691 Enable or disable the division approximation.
14692 This option only has an effect if @option{-ffast-math} or
14693 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14694 precision of division results to about 16 bits for
14695 single precision and to 32 bits for double precision.
14697 @item -march=@var{name}
14698 @opindex march
14699 Specify the name of the target architecture and, optionally, one or
14700 more feature modifiers.  This option has the form
14701 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14703 The permissible values for @var{arch} are @samp{armv8-a},
14704 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @samp{armv8.4-a}
14705 or @var{native}.
14707 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
14708 support for the ARMv8.4-A architecture extensions.
14710 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14711 support for the ARMv8.3-A architecture extensions.
14713 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14714 support for the ARMv8.2-A architecture extensions.
14716 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14717 support for the ARMv8.1-A architecture extension.  In particular, it
14718 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14720 The value @samp{native} is available on native AArch64 GNU/Linux and
14721 causes the compiler to pick the architecture of the host system.  This
14722 option has no effect if the compiler is unable to recognize the
14723 architecture of the host system,
14725 The permissible values for @var{feature} are listed in the sub-section
14726 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14727 Feature Modifiers}.  Where conflicting feature modifiers are
14728 specified, the right-most feature is used.
14730 GCC uses @var{name} to determine what kind of instructions it can emit
14731 when generating assembly code.  If @option{-march} is specified
14732 without either of @option{-mtune} or @option{-mcpu} also being
14733 specified, the code is tuned to perform well across a range of target
14734 processors implementing the target architecture.
14736 @item -mtune=@var{name}
14737 @opindex mtune
14738 Specify the name of the target processor for which GCC should tune the
14739 performance of the code.  Permissible values for this option are:
14740 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14741 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14742 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14743 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14744 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14745 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14746 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14747 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14748 @samp{native}.
14750 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14751 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14752 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14753 big.LITTLE system.
14755 Additionally on native AArch64 GNU/Linux systems the value
14756 @samp{native} tunes performance to the host system.  This option has no effect
14757 if the compiler is unable to recognize the processor of the host system.
14759 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14760 are specified, the code is tuned to perform well across a range
14761 of target processors.
14763 This option cannot be suffixed by feature modifiers.
14765 @item -mcpu=@var{name}
14766 @opindex mcpu
14767 Specify the name of the target processor, optionally suffixed by one
14768 or more feature modifiers.  This option has the form
14769 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14770 the permissible values for @var{cpu} are the same as those available
14771 for @option{-mtune}.  The permissible values for @var{feature} are
14772 documented in the sub-section on
14773 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14774 Feature Modifiers}.  Where conflicting feature modifiers are
14775 specified, the right-most feature is used.
14777 GCC uses @var{name} to determine what kind of instructions it can emit when
14778 generating assembly code (as if by @option{-march}) and to determine
14779 the target processor for which to tune for performance (as if
14780 by @option{-mtune}).  Where this option is used in conjunction
14781 with @option{-march} or @option{-mtune}, those options take precedence
14782 over the appropriate part of this option.
14784 @item -moverride=@var{string}
14785 @opindex moverride
14786 Override tuning decisions made by the back-end in response to a
14787 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14788 for @var{string} in this option are not guaranteed to be consistent
14789 across releases.
14791 This option is only intended to be useful when developing GCC.
14793 @item -mverbose-cost-dump
14794 @opindex mverbose-cost-dump
14795 Enable verbose cost model dumping in the debug dump files.  This option is
14796 provided for use in debugging the compiler.
14798 @item -mpc-relative-literal-loads
14799 @itemx -mno-pc-relative-literal-loads
14800 @opindex mpc-relative-literal-loads
14801 @opindex mno-pc-relative-literal-loads
14802 Enable or disable PC-relative literal loads.  With this option literal pools are
14803 accessed using a single instruction and emitted after each function.  This
14804 limits the maximum size of functions to 1MB.  This is enabled by default for
14805 @option{-mcmodel=tiny}.
14807 @item -msign-return-address=@var{scope}
14808 @opindex msign-return-address
14809 Select the function scope on which return address signing will be applied.
14810 Permissible values are @samp{none}, which disables return address signing,
14811 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14812 functions, and @samp{all}, which enables pointer signing for all functions.  The
14813 default value is @samp{none}.
14815 @item -msve-vector-bits=@var{bits}
14816 @opindex msve-vector-bits
14817 Specify the number of bits in an SVE vector register.  This option only has
14818 an effect when SVE is enabled.
14820 GCC supports two forms of SVE code generation: ``vector-length
14821 agnostic'' output that works with any size of vector register and
14822 ``vector-length specific'' output that only works when the vector
14823 registers are a particular size.  Replacing @var{bits} with
14824 @samp{scalable} selects vector-length agnostic output while
14825 replacing it with a number selects vector-length specific output.
14826 The possible lengths in the latter case are: 128, 256, 512, 1024
14827 and 2048.  @samp{scalable} is the default.
14829 At present, @samp{-msve-vector-bits=128} produces the same output
14830 as @samp{-msve-vector-bits=scalable}.
14832 @end table
14834 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14835 @anchor{aarch64-feature-modifiers}
14836 @cindex @option{-march} feature modifiers
14837 @cindex @option{-mcpu} feature modifiers
14838 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14839 the following and their inverses @option{no@var{feature}}:
14841 @table @samp
14842 @item crc
14843 Enable CRC extension.  This is on by default for
14844 @option{-march=armv8.1-a}.
14845 @item crypto
14846 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14847 instructions.
14848 @item fp
14849 Enable floating-point instructions.  This is on by default for all possible
14850 values for options @option{-march} and @option{-mcpu}.
14851 @item simd
14852 Enable Advanced SIMD instructions.  This also enables floating-point
14853 instructions.  This is on by default for all possible values for options
14854 @option{-march} and @option{-mcpu}.
14855 @item sve
14856 Enable Scalable Vector Extension instructions.  This also enables Advanced
14857 SIMD and floating-point instructions.
14858 @item lse
14859 Enable Large System Extension instructions.  This is on by default for
14860 @option{-march=armv8.1-a}.
14861 @item rdma
14862 Enable Round Double Multiply Accumulate instructions.  This is on by default
14863 for @option{-march=armv8.1-a}.
14864 @item fp16
14865 Enable FP16 extension.  This also enables floating-point instructions.
14866 @item fp16fml
14867 Enable FP16 fmla extension.  This also enables FP16 extensions and
14868 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.
14870 @item rcpc
14871 Enable the RcPc extension.  This does not change code generation from GCC,
14872 but is passed on to the assembler, enabling inline asm statements to use
14873 instructions from the RcPc extension.
14874 @item dotprod
14875 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14876 @item aes
14877 Enable the Armv8-a aes and pmull crypto extension.  This also enables Advanced
14878 SIMD instructions.
14879 @item sha2
14880 Enable the Armv8-a sha2 crypto extension.  This also enables Advanced SIMD instructions.
14881 @item sha3
14882 Enable the sha512 and sha3 crypto extension.  This also enables Advanced SIMD
14883 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
14884 @item sm4
14885 Enable the sm3 and sm4 crypto extension.  This also enables Advanced SIMD instructions.
14886 Use of this option with architectures prior to Armv8.2-A is not supported.
14888 @end table
14890 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
14891 which implies @option{fp}.
14892 Conversely, @option{nofp} implies @option{nosimd}, which implies
14893 @option{nocrypto}, @option{noaes} and @option{nosha2}.
14895 @node Adapteva Epiphany Options
14896 @subsection Adapteva Epiphany Options
14898 These @samp{-m} options are defined for Adapteva Epiphany:
14900 @table @gcctabopt
14901 @item -mhalf-reg-file
14902 @opindex mhalf-reg-file
14903 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14904 That allows code to run on hardware variants that lack these registers.
14906 @item -mprefer-short-insn-regs
14907 @opindex mprefer-short-insn-regs
14908 Preferentially allocate registers that allow short instruction generation.
14909 This can result in increased instruction count, so this may either reduce or
14910 increase overall code size.
14912 @item -mbranch-cost=@var{num}
14913 @opindex mbranch-cost
14914 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14915 This cost is only a heuristic and is not guaranteed to produce
14916 consistent results across releases.
14918 @item -mcmove
14919 @opindex mcmove
14920 Enable the generation of conditional moves.
14922 @item -mnops=@var{num}
14923 @opindex mnops
14924 Emit @var{num} NOPs before every other generated instruction.
14926 @item -mno-soft-cmpsf
14927 @opindex mno-soft-cmpsf
14928 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14929 and test the flags.  This is faster than a software comparison, but can
14930 get incorrect results in the presence of NaNs, or when two different small
14931 numbers are compared such that their difference is calculated as zero.
14932 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14933 software comparisons.
14935 @item -mstack-offset=@var{num}
14936 @opindex mstack-offset
14937 Set the offset between the top of the stack and the stack pointer.
14938 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14939 can be used by leaf functions without stack allocation.
14940 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14941 Note also that this option changes the ABI; compiling a program with a
14942 different stack offset than the libraries have been compiled with
14943 generally does not work.
14944 This option can be useful if you want to evaluate if a different stack
14945 offset would give you better code, but to actually use a different stack
14946 offset to build working programs, it is recommended to configure the
14947 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14949 @item -mno-round-nearest
14950 @opindex mno-round-nearest
14951 Make the scheduler assume that the rounding mode has been set to
14952 truncating.  The default is @option{-mround-nearest}.
14954 @item -mlong-calls
14955 @opindex mlong-calls
14956 If not otherwise specified by an attribute, assume all calls might be beyond
14957 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14958 function address into a register before performing a (otherwise direct) call.
14959 This is the default.
14961 @item -mshort-calls
14962 @opindex short-calls
14963 If not otherwise specified by an attribute, assume all direct calls are
14964 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14965 for direct calls.  The default is @option{-mlong-calls}.
14967 @item -msmall16
14968 @opindex msmall16
14969 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14970 apply to function addresses for which @option{-mlong-calls} semantics
14971 are in effect.
14973 @item -mfp-mode=@var{mode}
14974 @opindex mfp-mode
14975 Set the prevailing mode of the floating-point unit.
14976 This determines the floating-point mode that is provided and expected
14977 at function call and return time.  Making this mode match the mode you
14978 predominantly need at function start can make your programs smaller and
14979 faster by avoiding unnecessary mode switches.
14981 @var{mode} can be set to one the following values:
14983 @table @samp
14984 @item caller
14985 Any mode at function entry is valid, and retained or restored when
14986 the function returns, and when it calls other functions.
14987 This mode is useful for compiling libraries or other compilation units
14988 you might want to incorporate into different programs with different
14989 prevailing FPU modes, and the convenience of being able to use a single
14990 object file outweighs the size and speed overhead for any extra
14991 mode switching that might be needed, compared with what would be needed
14992 with a more specific choice of prevailing FPU mode.
14994 @item truncate
14995 This is the mode used for floating-point calculations with
14996 truncating (i.e.@: round towards zero) rounding mode.  That includes
14997 conversion from floating point to integer.
14999 @item round-nearest
15000 This is the mode used for floating-point calculations with
15001 round-to-nearest-or-even rounding mode.
15003 @item int
15004 This is the mode used to perform integer calculations in the FPU, e.g.@:
15005 integer multiply, or integer multiply-and-accumulate.
15006 @end table
15008 The default is @option{-mfp-mode=caller}
15010 @item -mnosplit-lohi
15011 @itemx -mno-postinc
15012 @itemx -mno-postmodify
15013 @opindex mnosplit-lohi
15014 @opindex mno-postinc
15015 @opindex mno-postmodify
15016 Code generation tweaks that disable, respectively, splitting of 32-bit
15017 loads, generation of post-increment addresses, and generation of
15018 post-modify addresses.  The defaults are @option{msplit-lohi},
15019 @option{-mpost-inc}, and @option{-mpost-modify}.
15021 @item -mnovect-double
15022 @opindex mno-vect-double
15023 Change the preferred SIMD mode to SImode.  The default is
15024 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
15026 @item -max-vect-align=@var{num}
15027 @opindex max-vect-align
15028 The maximum alignment for SIMD vector mode types.
15029 @var{num} may be 4 or 8.  The default is 8.
15030 Note that this is an ABI change, even though many library function
15031 interfaces are unaffected if they don't use SIMD vector modes
15032 in places that affect size and/or alignment of relevant types.
15034 @item -msplit-vecmove-early
15035 @opindex msplit-vecmove-early
15036 Split vector moves into single word moves before reload.  In theory this
15037 can give better register allocation, but so far the reverse seems to be
15038 generally the case.
15040 @item -m1reg-@var{reg}
15041 @opindex m1reg-
15042 Specify a register to hold the constant @minus{}1, which makes loading small negative
15043 constants and certain bitmasks faster.
15044 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
15045 which specify use of that register as a fixed register,
15046 and @samp{none}, which means that no register is used for this
15047 purpose.  The default is @option{-m1reg-none}.
15049 @end table
15051 @node ARC Options
15052 @subsection ARC Options
15053 @cindex ARC options
15055 The following options control the architecture variant for which code
15056 is being compiled:
15058 @c architecture variants
15059 @table @gcctabopt
15061 @item -mbarrel-shifter
15062 @opindex mbarrel-shifter
15063 Generate instructions supported by barrel shifter.  This is the default
15064 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
15066 @item -mjli-always
15067 @opindex mjli-alawys
15068 Force to call a function using jli_s instruction.  This option is
15069 valid only for ARCv2 architecture.
15071 @item -mcpu=@var{cpu}
15072 @opindex mcpu
15073 Set architecture type, register usage, and instruction scheduling
15074 parameters for @var{cpu}.  There are also shortcut alias options
15075 available for backward compatibility and convenience.  Supported
15076 values for @var{cpu} are
15078 @table @samp
15079 @opindex mA6
15080 @opindex mARC600
15081 @item arc600
15082 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
15084 @item arc601
15085 @opindex mARC601
15086 Compile for ARC601.  Alias: @option{-mARC601}.
15088 @item arc700
15089 @opindex mA7
15090 @opindex mARC700
15091 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
15092 This is the default when configured with @option{--with-cpu=arc700}@.
15094 @item arcem
15095 Compile for ARC EM.
15097 @item archs
15098 Compile for ARC HS.
15100 @item em
15101 Compile for ARC EM CPU with no hardware extensions.
15103 @item em4
15104 Compile for ARC EM4 CPU.
15106 @item em4_dmips
15107 Compile for ARC EM4 DMIPS CPU.
15109 @item em4_fpus
15110 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
15111 extension.
15113 @item em4_fpuda
15114 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
15115 double assist instructions.
15117 @item hs
15118 Compile for ARC HS CPU with no hardware extensions except the atomic
15119 instructions.
15121 @item hs34
15122 Compile for ARC HS34 CPU.
15124 @item hs38
15125 Compile for ARC HS38 CPU.
15127 @item hs38_linux
15128 Compile for ARC HS38 CPU with all hardware extensions on.
15130 @item arc600_norm
15131 Compile for ARC 600 CPU with @code{norm} instructions enabled.
15133 @item arc600_mul32x16
15134 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
15135 instructions enabled.
15137 @item arc600_mul64
15138 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
15139 instructions enabled.
15141 @item arc601_norm
15142 Compile for ARC 601 CPU with @code{norm} instructions enabled.
15144 @item arc601_mul32x16
15145 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
15146 instructions enabled.
15148 @item arc601_mul64
15149 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
15150 instructions enabled.
15152 @item nps400
15153 Compile for ARC 700 on NPS400 chip.
15155 @item em_mini
15156 Compile for ARC EM minimalist configuration featuring reduced register
15157 set.
15159 @end table
15161 @item -mdpfp
15162 @opindex mdpfp
15163 @itemx -mdpfp-compact
15164 @opindex mdpfp-compact
15165 Generate double-precision FPX instructions, tuned for the compact
15166 implementation.
15168 @item -mdpfp-fast
15169 @opindex mdpfp-fast
15170 Generate double-precision FPX instructions, tuned for the fast
15171 implementation.
15173 @item -mno-dpfp-lrsr
15174 @opindex mno-dpfp-lrsr
15175 Disable @code{lr} and @code{sr} instructions from using FPX extension
15176 aux registers.
15178 @item -mea
15179 @opindex mea
15180 Generate extended arithmetic instructions.  Currently only
15181 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
15182 supported.  This is always enabled for @option{-mcpu=ARC700}.
15184 @item -mno-mpy
15185 @opindex mno-mpy
15186 Do not generate @code{mpy}-family instructions for ARC700.  This option is
15187 deprecated.
15189 @item -mmul32x16
15190 @opindex mmul32x16
15191 Generate 32x16-bit multiply and multiply-accumulate instructions.
15193 @item -mmul64
15194 @opindex mmul64
15195 Generate @code{mul64} and @code{mulu64} instructions.  
15196 Only valid for @option{-mcpu=ARC600}.
15198 @item -mnorm
15199 @opindex mnorm
15200 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
15201 is in effect.
15203 @item -mspfp
15204 @opindex mspfp
15205 @itemx -mspfp-compact
15206 @opindex mspfp-compact
15207 Generate single-precision FPX instructions, tuned for the compact
15208 implementation.
15210 @item -mspfp-fast
15211 @opindex mspfp-fast
15212 Generate single-precision FPX instructions, tuned for the fast
15213 implementation.
15215 @item -msimd
15216 @opindex msimd
15217 Enable generation of ARC SIMD instructions via target-specific
15218 builtins.  Only valid for @option{-mcpu=ARC700}.
15220 @item -msoft-float
15221 @opindex msoft-float
15222 This option ignored; it is provided for compatibility purposes only.
15223 Software floating-point code is emitted by default, and this default
15224 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
15225 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
15226 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
15228 @item -mswap
15229 @opindex mswap
15230 Generate @code{swap} instructions.
15232 @item -matomic
15233 @opindex matomic
15234 This enables use of the locked load/store conditional extension to implement
15235 atomic memory built-in functions.  Not available for ARC 6xx or ARC
15236 EM cores.
15238 @item -mdiv-rem
15239 @opindex mdiv-rem
15240 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
15242 @item -mcode-density
15243 @opindex mcode-density
15244 Enable code density instructions for ARC EM.  
15245 This option is on by default for ARC HS.
15247 @item -mll64
15248 @opindex mll64
15249 Enable double load/store operations for ARC HS cores.
15251 @item -mtp-regno=@var{regno}
15252 @opindex mtp-regno
15253 Specify thread pointer register number.
15255 @item -mmpy-option=@var{multo}
15256 @opindex mmpy-option
15257 Compile ARCv2 code with a multiplier design option.  You can specify 
15258 the option using either a string or numeric value for @var{multo}.  
15259 @samp{wlh1} is the default value.  The recognized values are:
15261 @table @samp
15262 @item 0
15263 @itemx none
15264 No multiplier available.
15266 @item 1
15267 @itemx w
15268 16x16 multiplier, fully pipelined.
15269 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15271 @item 2
15272 @itemx wlh1
15273 32x32 multiplier, fully
15274 pipelined (1 stage).  The following instructions are additionally
15275 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15277 @item 3
15278 @itemx wlh2
15279 32x32 multiplier, fully pipelined
15280 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15281 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15283 @item 4
15284 @itemx wlh3
15285 Two 16x16 multipliers, blocking,
15286 sequential.  The following instructions are additionally enabled: @code{mpy},
15287 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15289 @item 5
15290 @itemx wlh4
15291 One 16x16 multiplier, blocking,
15292 sequential.  The following instructions are additionally enabled: @code{mpy},
15293 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15295 @item 6
15296 @itemx wlh5
15297 One 32x4 multiplier, blocking,
15298 sequential.  The following instructions are additionally enabled: @code{mpy},
15299 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15301 @item 7
15302 @itemx plus_dmpy
15303 ARC HS SIMD support.
15305 @item 8
15306 @itemx plus_macd
15307 ARC HS SIMD support.
15309 @item 9
15310 @itemx plus_qmacw
15311 ARC HS SIMD support.
15313 @end table
15315 This option is only available for ARCv2 cores@.
15317 @item -mfpu=@var{fpu}
15318 @opindex mfpu
15319 Enables support for specific floating-point hardware extensions for ARCv2
15320 cores.  Supported values for @var{fpu} are:
15322 @table @samp
15324 @item fpus
15325 Enables support for single-precision floating-point hardware
15326 extensions@.
15328 @item fpud
15329 Enables support for double-precision floating-point hardware
15330 extensions.  The single-precision floating-point extension is also
15331 enabled.  Not available for ARC EM@.
15333 @item fpuda
15334 Enables support for double-precision floating-point hardware
15335 extensions using double-precision assist instructions.  The single-precision
15336 floating-point extension is also enabled.  This option is
15337 only available for ARC EM@.
15339 @item fpuda_div
15340 Enables support for double-precision floating-point hardware
15341 extensions using double-precision assist instructions.
15342 The single-precision floating-point, square-root, and divide 
15343 extensions are also enabled.  This option is
15344 only available for ARC EM@.
15346 @item fpuda_fma
15347 Enables support for double-precision floating-point hardware
15348 extensions using double-precision assist instructions.
15349 The single-precision floating-point and fused multiply and add 
15350 hardware extensions are also enabled.  This option is
15351 only available for ARC EM@.
15353 @item fpuda_all
15354 Enables support for double-precision floating-point hardware
15355 extensions using double-precision assist instructions.
15356 All single-precision floating-point hardware extensions are also
15357 enabled.  This option is only available for ARC EM@.
15359 @item fpus_div
15360 Enables support for single-precision floating-point, square-root and divide 
15361 hardware extensions@.
15363 @item fpud_div
15364 Enables support for double-precision floating-point, square-root and divide 
15365 hardware extensions.  This option
15366 includes option @samp{fpus_div}. Not available for ARC EM@.
15368 @item fpus_fma
15369 Enables support for single-precision floating-point and 
15370 fused multiply and add hardware extensions@.
15372 @item fpud_fma
15373 Enables support for double-precision floating-point and 
15374 fused multiply and add hardware extensions.  This option
15375 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15377 @item fpus_all
15378 Enables support for all single-precision floating-point hardware
15379 extensions@.
15381 @item fpud_all
15382 Enables support for all single- and double-precision floating-point
15383 hardware extensions.  Not available for ARC EM@.
15385 @end table
15387 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15388 @opindex mirq-ctrl-saved
15389 Specifies general-purposes registers that the processor automatically
15390 saves/restores on interrupt entry and exit.  @var{register-range} is
15391 specified as two registers separated by a dash.  The register range
15392 always starts with @code{r0}, the upper limit is @code{fp} register.
15393 @var{blink} and @var{lp_count} are optional.  This option is only
15394 valid for ARC EM and ARC HS cores.
15396 @item -mrgf-banked-regs=@var{number}
15397 @opindex mrgf-banked-regs
15398 Specifies the number of registers replicated in second register bank
15399 on entry to fast interrupt.  Fast interrupts are interrupts with the
15400 highest priority level P0.  These interrupts save only PC and STATUS32
15401 registers to avoid memory transactions during interrupt entry and exit
15402 sequences.  Use this option when you are using fast interrupts in an
15403 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15405 @item -mlpc-width=@var{width}
15406 @opindex mlpc-width
15407 Specify the width of the @code{lp_count} register.  Valid values for
15408 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15409 fixed to 32 bits.  If the width is less than 32, the compiler does not
15410 attempt to transform loops in your program to use the zero-delay loop
15411 mechanism unless it is known that the @code{lp_count} register can
15412 hold the required loop-counter value.  Depending on the width
15413 specified, the compiler and run-time library might continue to use the
15414 loop mechanism for various needs.  This option defines macro
15415 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15417 @item -mrf16
15418 @opindex mrf16
15419 This option instructs the compiler to generate code for a 16-entry
15420 register file.  This option defines the @code{__ARC_RF16__}
15421 preprocessor macro.
15423 @end table
15425 The following options are passed through to the assembler, and also
15426 define preprocessor macro symbols.
15428 @c Flags used by the assembler, but for which we define preprocessor
15429 @c macro symbols as well.
15430 @table @gcctabopt
15431 @item -mdsp-packa
15432 @opindex mdsp-packa
15433 Passed down to the assembler to enable the DSP Pack A extensions.
15434 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15435 deprecated.
15437 @item -mdvbf
15438 @opindex mdvbf
15439 Passed down to the assembler to enable the dual Viterbi butterfly
15440 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15441 option is deprecated.
15443 @c ARC700 4.10 extension instruction
15444 @item -mlock
15445 @opindex mlock
15446 Passed down to the assembler to enable the locked load/store
15447 conditional extension.  Also sets the preprocessor symbol
15448 @code{__Xlock}.
15450 @item -mmac-d16
15451 @opindex mmac-d16
15452 Passed down to the assembler.  Also sets the preprocessor symbol
15453 @code{__Xxmac_d16}.  This option is deprecated.
15455 @item -mmac-24
15456 @opindex mmac-24
15457 Passed down to the assembler.  Also sets the preprocessor symbol
15458 @code{__Xxmac_24}.  This option is deprecated.
15460 @c ARC700 4.10 extension instruction
15461 @item -mrtsc
15462 @opindex mrtsc
15463 Passed down to the assembler to enable the 64-bit time-stamp counter
15464 extension instruction.  Also sets the preprocessor symbol
15465 @code{__Xrtsc}.  This option is deprecated.
15467 @c ARC700 4.10 extension instruction
15468 @item -mswape
15469 @opindex mswape
15470 Passed down to the assembler to enable the swap byte ordering
15471 extension instruction.  Also sets the preprocessor symbol
15472 @code{__Xswape}.
15474 @item -mtelephony
15475 @opindex mtelephony
15476 Passed down to the assembler to enable dual- and single-operand
15477 instructions for telephony.  Also sets the preprocessor symbol
15478 @code{__Xtelephony}.  This option is deprecated.
15480 @item -mxy
15481 @opindex mxy
15482 Passed down to the assembler to enable the XY memory extension.  Also
15483 sets the preprocessor symbol @code{__Xxy}.
15485 @end table
15487 The following options control how the assembly code is annotated:
15489 @c Assembly annotation options
15490 @table @gcctabopt
15491 @item -misize
15492 @opindex misize
15493 Annotate assembler instructions with estimated addresses.
15495 @item -mannotate-align
15496 @opindex mannotate-align
15497 Explain what alignment considerations lead to the decision to make an
15498 instruction short or long.
15500 @end table
15502 The following options are passed through to the linker:
15504 @c options passed through to the linker
15505 @table @gcctabopt
15506 @item -marclinux
15507 @opindex marclinux
15508 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15509 This option is enabled by default in tool chains built for
15510 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15511 when profiling is not requested.
15513 @item -marclinux_prof
15514 @opindex marclinux_prof
15515 Passed through to the linker, to specify use of the
15516 @code{arclinux_prof} emulation.  This option is enabled by default in
15517 tool chains built for @w{@code{arc-linux-uclibc}} and
15518 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15520 @end table
15522 The following options control the semantics of generated code:
15524 @c semantically relevant code generation options
15525 @table @gcctabopt
15526 @item -mlong-calls
15527 @opindex mlong-calls
15528 Generate calls as register indirect calls, thus providing access
15529 to the full 32-bit address range.
15531 @item -mmedium-calls
15532 @opindex mmedium-calls
15533 Don't use less than 25-bit addressing range for calls, which is the
15534 offset available for an unconditional branch-and-link
15535 instruction.  Conditional execution of function calls is suppressed, to
15536 allow use of the 25-bit range, rather than the 21-bit range with
15537 conditional branch-and-link.  This is the default for tool chains built
15538 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15540 @item -G @var{num}
15541 @opindex G
15542 Put definitions of externally-visible data in a small data section if
15543 that data is no bigger than @var{num} bytes.  The default value of
15544 @var{num} is 4 for any ARC configuration, or 8 when we have double
15545 load/store operations.
15547 @item -mno-sdata
15548 @opindex mno-sdata
15549 Do not generate sdata references.  This is the default for tool chains
15550 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15551 targets.
15553 @item -mvolatile-cache
15554 @opindex mvolatile-cache
15555 Use ordinarily cached memory accesses for volatile references.  This is the
15556 default.
15558 @item -mno-volatile-cache
15559 @opindex mno-volatile-cache
15560 Enable cache bypass for volatile references.
15562 @end table
15564 The following options fine tune code generation:
15565 @c code generation tuning options
15566 @table @gcctabopt
15567 @item -malign-call
15568 @opindex malign-call
15569 Do alignment optimizations for call instructions.
15571 @item -mauto-modify-reg
15572 @opindex mauto-modify-reg
15573 Enable the use of pre/post modify with register displacement.
15575 @item -mbbit-peephole
15576 @opindex mbbit-peephole
15577 Enable bbit peephole2.
15579 @item -mno-brcc
15580 @opindex mno-brcc
15581 This option disables a target-specific pass in @file{arc_reorg} to
15582 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15583 It has no effect on
15584 generation of these instructions driven by the combiner pass.
15586 @item -mcase-vector-pcrel
15587 @opindex mcase-vector-pcrel
15588 Use PC-relative switch case tables to enable case table shortening.
15589 This is the default for @option{-Os}.
15591 @item -mcompact-casesi
15592 @opindex mcompact-casesi
15593 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15594 and only available for ARCv1 cores.
15596 @item -mno-cond-exec
15597 @opindex mno-cond-exec
15598 Disable the ARCompact-specific pass to generate conditional 
15599 execution instructions.
15601 Due to delay slot scheduling and interactions between operand numbers,
15602 literal sizes, instruction lengths, and the support for conditional execution,
15603 the target-independent pass to generate conditional execution is often lacking,
15604 so the ARC port has kept a special pass around that tries to find more
15605 conditional execution generation opportunities after register allocation,
15606 branch shortening, and delay slot scheduling have been done.  This pass
15607 generally, but not always, improves performance and code size, at the cost of
15608 extra compilation time, which is why there is an option to switch it off.
15609 If you have a problem with call instructions exceeding their allowable
15610 offset range because they are conditionalized, you should consider using
15611 @option{-mmedium-calls} instead.
15613 @item -mearly-cbranchsi
15614 @opindex mearly-cbranchsi
15615 Enable pre-reload use of the @code{cbranchsi} pattern.
15617 @item -mexpand-adddi
15618 @opindex mexpand-adddi
15619 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15620 @code{add.f}, @code{adc} etc.  This option is deprecated.
15622 @item -mindexed-loads
15623 @opindex mindexed-loads
15624 Enable the use of indexed loads.  This can be problematic because some
15625 optimizers then assume that indexed stores exist, which is not
15626 the case.
15628 @item -mlra
15629 @opindex mlra
15630 Enable Local Register Allocation.  This is still experimental for ARC,
15631 so by default the compiler uses standard reload
15632 (i.e. @option{-mno-lra}).
15634 @item -mlra-priority-none
15635 @opindex mlra-priority-none
15636 Don't indicate any priority for target registers.
15638 @item -mlra-priority-compact
15639 @opindex mlra-priority-compact
15640 Indicate target register priority for r0..r3 / r12..r15.
15642 @item -mlra-priority-noncompact
15643 @opindex mlra-priority-noncompact
15644 Reduce target register priority for r0..r3 / r12..r15.
15646 @item -mno-millicode
15647 @opindex mno-millicode
15648 When optimizing for size (using @option{-Os}), prologues and epilogues
15649 that have to save or restore a large number of registers are often
15650 shortened by using call to a special function in libgcc; this is
15651 referred to as a @emph{millicode} call.  As these calls can pose
15652 performance issues, and/or cause linking issues when linking in a
15653 nonstandard way, this option is provided to turn off millicode call
15654 generation.
15656 @item -mmixed-code
15657 @opindex mmixed-code
15658 Tweak register allocation to help 16-bit instruction generation.
15659 This generally has the effect of decreasing the average instruction size
15660 while increasing the instruction count.
15662 @item -mq-class
15663 @opindex mq-class
15664 Enable @samp{q} instruction alternatives.
15665 This is the default for @option{-Os}.
15667 @item -mRcq
15668 @opindex mRcq
15669 Enable @samp{Rcq} constraint handling.  
15670 Most short code generation depends on this.
15671 This is the default.
15673 @item -mRcw
15674 @opindex mRcw
15675 Enable @samp{Rcw} constraint handling.  
15676 Most ccfsm condexec mostly depends on this.
15677 This is the default.
15679 @item -msize-level=@var{level}
15680 @opindex msize-level
15681 Fine-tune size optimization with regards to instruction lengths and alignment.
15682 The recognized values for @var{level} are:
15683 @table @samp
15684 @item 0
15685 No size optimization.  This level is deprecated and treated like @samp{1}.
15687 @item 1
15688 Short instructions are used opportunistically.
15690 @item 2
15691 In addition, alignment of loops and of code after barriers are dropped.
15693 @item 3
15694 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15696 @end table
15698 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15699 the behavior when this is not set is equivalent to level @samp{1}.
15701 @item -mtune=@var{cpu}
15702 @opindex mtune
15703 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15704 by @option{-mcpu=}.
15706 Supported values for @var{cpu} are
15708 @table @samp
15709 @item ARC600
15710 Tune for ARC600 CPU.
15712 @item ARC601
15713 Tune for ARC601 CPU.
15715 @item ARC700
15716 Tune for ARC700 CPU with standard multiplier block.
15718 @item ARC700-xmac
15719 Tune for ARC700 CPU with XMAC block.
15721 @item ARC725D
15722 Tune for ARC725D CPU.
15724 @item ARC750D
15725 Tune for ARC750D CPU.
15727 @end table
15729 @item -mmultcost=@var{num}
15730 @opindex mmultcost
15731 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15732 normal instruction.
15734 @item -munalign-prob-threshold=@var{probability}
15735 @opindex munalign-prob-threshold
15736 Set probability threshold for unaligning branches.
15737 When tuning for @samp{ARC700} and optimizing for speed, branches without
15738 filled delay slot are preferably emitted unaligned and long, unless
15739 profiling indicates that the probability for the branch to be taken
15740 is below @var{probability}.  @xref{Cross-profiling}.
15741 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15743 @end table
15745 The following options are maintained for backward compatibility, but
15746 are now deprecated and will be removed in a future release:
15748 @c Deprecated options
15749 @table @gcctabopt
15751 @item -margonaut
15752 @opindex margonaut
15753 Obsolete FPX.
15755 @item -mbig-endian
15756 @opindex mbig-endian
15757 @itemx -EB
15758 @opindex EB
15759 Compile code for big-endian targets.  Use of these options is now
15760 deprecated.  Big-endian code is supported by configuring GCC to build
15761 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15762 for which big endian is the default.
15764 @item -mlittle-endian
15765 @opindex mlittle-endian
15766 @itemx -EL
15767 @opindex EL
15768 Compile code for little-endian targets.  Use of these options is now
15769 deprecated.  Little-endian code is supported by configuring GCC to build 
15770 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15771 for which little endian is the default.
15773 @item -mbarrel_shifter
15774 @opindex mbarrel_shifter
15775 Replaced by @option{-mbarrel-shifter}.
15777 @item -mdpfp_compact
15778 @opindex mdpfp_compact
15779 Replaced by @option{-mdpfp-compact}.
15781 @item -mdpfp_fast
15782 @opindex mdpfp_fast
15783 Replaced by @option{-mdpfp-fast}.
15785 @item -mdsp_packa
15786 @opindex mdsp_packa
15787 Replaced by @option{-mdsp-packa}.
15789 @item -mEA
15790 @opindex mEA
15791 Replaced by @option{-mea}.
15793 @item -mmac_24
15794 @opindex mmac_24
15795 Replaced by @option{-mmac-24}.
15797 @item -mmac_d16
15798 @opindex mmac_d16
15799 Replaced by @option{-mmac-d16}.
15801 @item -mspfp_compact
15802 @opindex mspfp_compact
15803 Replaced by @option{-mspfp-compact}.
15805 @item -mspfp_fast
15806 @opindex mspfp_fast
15807 Replaced by @option{-mspfp-fast}.
15809 @item -mtune=@var{cpu}
15810 @opindex mtune
15811 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15812 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15813 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15815 @item -multcost=@var{num}
15816 @opindex multcost
15817 Replaced by @option{-mmultcost}.
15819 @end table
15821 @node ARM Options
15822 @subsection ARM Options
15823 @cindex ARM options
15825 These @samp{-m} options are defined for the ARM port:
15827 @table @gcctabopt
15828 @item -mabi=@var{name}
15829 @opindex mabi
15830 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15831 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15833 @item -mapcs-frame
15834 @opindex mapcs-frame
15835 Generate a stack frame that is compliant with the ARM Procedure Call
15836 Standard for all functions, even if this is not strictly necessary for
15837 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15838 with this option causes the stack frames not to be generated for
15839 leaf functions.  The default is @option{-mno-apcs-frame}.
15840 This option is deprecated.
15842 @item -mapcs
15843 @opindex mapcs
15844 This is a synonym for @option{-mapcs-frame} and is deprecated.
15846 @ignore
15847 @c not currently implemented
15848 @item -mapcs-stack-check
15849 @opindex mapcs-stack-check
15850 Generate code to check the amount of stack space available upon entry to
15851 every function (that actually uses some stack space).  If there is
15852 insufficient space available then either the function
15853 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15854 called, depending upon the amount of stack space required.  The runtime
15855 system is required to provide these functions.  The default is
15856 @option{-mno-apcs-stack-check}, since this produces smaller code.
15858 @c not currently implemented
15859 @item -mapcs-reentrant
15860 @opindex mapcs-reentrant
15861 Generate reentrant, position-independent code.  The default is
15862 @option{-mno-apcs-reentrant}.
15863 @end ignore
15865 @item -mthumb-interwork
15866 @opindex mthumb-interwork
15867 Generate code that supports calling between the ARM and Thumb
15868 instruction sets.  Without this option, on pre-v5 architectures, the
15869 two instruction sets cannot be reliably used inside one program.  The
15870 default is @option{-mno-thumb-interwork}, since slightly larger code
15871 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15872 configurations this option is meaningless.
15874 @item -mno-sched-prolog
15875 @opindex mno-sched-prolog
15876 Prevent the reordering of instructions in the function prologue, or the
15877 merging of those instruction with the instructions in the function's
15878 body.  This means that all functions start with a recognizable set
15879 of instructions (or in fact one of a choice from a small set of
15880 different function prologues), and this information can be used to
15881 locate the start of functions inside an executable piece of code.  The
15882 default is @option{-msched-prolog}.
15884 @item -mfloat-abi=@var{name}
15885 @opindex mfloat-abi
15886 Specifies which floating-point ABI to use.  Permissible values
15887 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15889 Specifying @samp{soft} causes GCC to generate output containing
15890 library calls for floating-point operations.
15891 @samp{softfp} allows the generation of code using hardware floating-point
15892 instructions, but still uses the soft-float calling conventions.
15893 @samp{hard} allows generation of floating-point instructions
15894 and uses FPU-specific calling conventions.
15896 The default depends on the specific target configuration.  Note that
15897 the hard-float and soft-float ABIs are not link-compatible; you must
15898 compile your entire program with the same ABI, and link with a
15899 compatible set of libraries.
15901 @item -mlittle-endian
15902 @opindex mlittle-endian
15903 Generate code for a processor running in little-endian mode.  This is
15904 the default for all standard configurations.
15906 @item -mbig-endian
15907 @opindex mbig-endian
15908 Generate code for a processor running in big-endian mode; the default is
15909 to compile code for a little-endian processor.
15911 @item -mbe8
15912 @itemx -mbe32
15913 @opindex mbe8
15914 When linking a big-endian image select between BE8 and BE32 formats.
15915 The option has no effect for little-endian images and is ignored.  The
15916 default is dependent on the selected target architecture.  For ARMv6
15917 and later architectures the default is BE8, for older architectures
15918 the default is BE32.  BE32 format has been deprecated by ARM.
15920 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15921 @opindex march
15922 This specifies the name of the target ARM architecture.  GCC uses this
15923 name to determine what kind of instructions it can emit when generating
15924 assembly code.  This option can be used in conjunction with or instead
15925 of the @option{-mcpu=} option.
15927 Permissible names are:
15928 @samp{armv4t},
15929 @samp{armv5t}, @samp{armv5te},
15930 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15931 @samp{armv6z}, @samp{armv6zk},
15932 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15933 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15934 @samp{armv8.4-a},
15935 @samp{armv7-r},
15936 @samp{armv8-r},
15937 @samp{armv6-m}, @samp{armv6s-m},
15938 @samp{armv7-m}, @samp{armv7e-m},
15939 @samp{armv8-m.base}, @samp{armv8-m.main},
15940 @samp{iwmmxt} and @samp{iwmmxt2}.
15942 Additionally, the following architectures, which lack support for the
15943 Thumb execution state, are recognized but support is deprecated: @samp{armv4}.
15945 Many of the architectures support extensions.  These can be added by
15946 appending @samp{+@var{extension}} to the architecture name.  Extension
15947 options are processed in order and capabilities accumulate.  An extension
15948 will also enable any necessary base extensions
15949 upon which it depends.  For example, the @samp{+crypto} extension
15950 will always enable the @samp{+simd} extension.  The exception to the
15951 additive construction is for extensions that are prefixed with
15952 @samp{+no@dots{}}: these extensions disable the specified option and
15953 any other extensions that may depend on the presence of that
15954 extension.
15956 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15957 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15958 entirely disabled by the @samp{+nofp} option that follows it.
15960 Most extension names are generically named, but have an effect that is
15961 dependent upon the architecture to which it is applied.  For example,
15962 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15963 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15964 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15965 variant for @samp{armv8-a}.
15967 The table below lists the supported extensions for each architecture.
15968 Architectures not mentioned do not support any extensions.
15970 @table @samp
15971 @item armv5te
15972 @itemx armv6
15973 @itemx armv6j
15974 @itemx armv6k
15975 @itemx armv6kz
15976 @itemx armv6t2
15977 @itemx armv6z
15978 @itemx armv6zk
15979 @table @samp
15980 @item +fp
15981 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15982 used as an alias for this extension.
15984 @item +nofp
15985 Disable the floating-point instructions.
15986 @end table
15988 @item armv7
15989 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15990 @table @samp
15991 @item +fp
15992 The VFPv3 floating-point instructions, with 16 double-precision
15993 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15994 for this extension.  Note that floating-point is not supported by the
15995 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15996 ARMv7-R architectures.
15998 @item +nofp
15999 Disable the floating-point instructions.
16000 @end table
16002 @item armv7-a
16003 @table @samp
16004 @item +fp
16005 The VFPv3 floating-point instructions, with 16 double-precision
16006 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
16007 for this extension.
16009 @item +simd
16010 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16011 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
16012 for this extension.
16014 @item +vfpv3
16015 The VFPv3 floating-point instructions, with 32 double-precision
16016 registers.
16018 @item +vfpv3-d16-fp16
16019 The VFPv3 floating-point instructions, with 16 double-precision
16020 registers and the half-precision floating-point conversion operations.
16022 @item +vfpv3-fp16
16023 The VFPv3 floating-point instructions, with 32 double-precision
16024 registers and the half-precision floating-point conversion operations.
16026 @item +vfpv4-d16
16027 The VFPv4 floating-point instructions, with 16 double-precision
16028 registers.
16030 @item +vfpv4
16031 The VFPv4 floating-point instructions, with 32 double-precision
16032 registers.
16034 @item +neon-fp16
16035 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16036 the half-precision floating-point conversion operations.
16038 @item +neon-vfpv4
16039 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
16041 @item +nosimd
16042 Disable the Advanced SIMD instructions (does not disable floating point).
16044 @item +nofp
16045 Disable the floating-point and Advanced SIMD instructions.
16046 @end table
16048 @item armv7ve
16049 The extended version of the ARMv7-A architecture with support for
16050 virtualization.
16051 @table @samp
16052 @item +fp
16053 The VFPv4 floating-point instructions, with 16 double-precision registers.
16054 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
16056 @item +simd
16057 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
16058 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
16060 @item +vfpv3-d16
16061 The VFPv3 floating-point instructions, with 16 double-precision
16062 registers.
16064 @item +vfpv3
16065 The VFPv3 floating-point instructions, with 32 double-precision
16066 registers.
16068 @item +vfpv3-d16-fp16
16069 The VFPv3 floating-point instructions, with 16 double-precision
16070 registers and the half-precision floating-point conversion operations.
16072 @item +vfpv3-fp16
16073 The VFPv3 floating-point instructions, with 32 double-precision
16074 registers and the half-precision floating-point conversion operations.
16076 @item +vfpv4-d16
16077 The VFPv4 floating-point instructions, with 16 double-precision
16078 registers.
16080 @item +vfpv4
16081 The VFPv4 floating-point instructions, with 32 double-precision
16082 registers.
16084 @item +neon
16085 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
16086 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
16088 @item +neon-fp16
16089 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
16090 the half-precision floating-point conversion operations.
16092 @item +nosimd
16093 Disable the Advanced SIMD instructions (does not disable floating point).
16095 @item +nofp
16096 Disable the floating-point and Advanced SIMD instructions.
16097 @end table
16099 @item armv8-a
16100 @table @samp
16101 @item +crc
16102 The Cyclic Redundancy Check (CRC) instructions.
16103 @item +simd
16104 The ARMv8-A Advanced SIMD and floating-point instructions.
16105 @item +crypto
16106 The cryptographic instructions.
16107 @item +nocrypto
16108 Disable the cryptographic instructions.
16109 @item +nofp
16110 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16111 @end table
16113 @item armv8.1-a
16114 @table @samp
16115 @item +simd
16116 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16118 @item +crypto
16119 The cryptographic instructions.  This also enables the Advanced SIMD and
16120 floating-point instructions.
16122 @item +nocrypto
16123 Disable the cryptographic instructions.
16125 @item +nofp
16126 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16127 @end table
16129 @item armv8.2-a
16130 @itemx armv8.3-a
16131 @table @samp
16132 @item +fp16
16133 The half-precision floating-point data processing instructions.
16134 This also enables the Advanced SIMD and floating-point instructions.
16136 @item +fp16fml
16137 The half-precision floating-point fmla extension.  This also enables
16138 the half-precision floating-point extension and Advanced SIMD and
16139 floating-point instructions.
16141 @item +simd
16142 The ARMv8.1-A Advanced SIMD and floating-point instructions.
16144 @item +crypto
16145 The cryptographic instructions.  This also enables the Advanced SIMD and
16146 floating-point instructions.
16148 @item +dotprod
16149 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
16151 @item +nocrypto
16152 Disable the cryptographic extension.
16154 @item +nofp
16155 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16156 @end table
16158 @item armv8.4-a
16159 @table @samp
16160 @item +fp16
16161 The half-precision floating-point data processing instructions.
16162 This also enables the Advanced SIMD and floating-point instructions as well
16163 as the Dot Product extension and the half-precision floating-point fmla
16164 extension.
16166 @item +simd
16167 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
16168 Dot Product extension.
16170 @item +crypto
16171 The cryptographic instructions.  This also enables the Advanced SIMD and
16172 floating-point instructions as well as the Dot Product extension.
16174 @item +nocrypto
16175 Disable the cryptographic extension.
16177 @item +nofp
16178 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16179 @end table
16181 @item armv7-r
16182 @table @samp
16183 @item +fp.sp
16184 The single-precision VFPv3 floating-point instructions.  The extension
16185 @samp{+vfpv3xd} can be used as an alias for this extension.
16187 @item +fp
16188 The VFPv3 floating-point instructions with 16 double-precision registers.
16189 The extension +vfpv3-d16 can be used as an alias for this extension.
16191 @item +nofp
16192 Disable the floating-point extension.
16194 @item +idiv
16195 The ARM-state integer division instructions.
16197 @item +noidiv
16198 Disable the ARM-state integer division extension.
16199 @end table
16201 @item armv7e-m
16202 @table @samp
16203 @item +fp
16204 The single-precision VFPv4 floating-point instructions.
16206 @item +fpv5
16207 The single-precision FPv5 floating-point instructions.
16209 @item +fp.dp
16210 The single- and double-precision FPv5 floating-point instructions.
16212 @item +nofp
16213 Disable the floating-point extensions.
16214 @end table
16216 @item  armv8-m.main
16217 @table @samp
16218 @item +dsp
16219 The DSP instructions.
16221 @item +nodsp
16222 Disable the DSP extension.
16224 @item +fp
16225 The single-precision floating-point instructions.
16227 @item +fp.dp
16228 The single- and double-precision floating-point instructions.
16230 @item +nofp
16231 Disable the floating-point extension.
16232 @end table
16234 @item armv8-r
16235 @table @samp
16236 @item +crc
16237 The Cyclic Redundancy Check (CRC) instructions.
16238 @item +fp.sp
16239 The single-precision FPv5 floating-point instructions.
16240 @item +simd
16241 The ARMv8-A Advanced SIMD and floating-point instructions.
16242 @item +crypto
16243 The cryptographic instructions.
16244 @item +nocrypto
16245 Disable the cryptographic instructions.
16246 @item +nofp
16247 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16248 @end table
16250 @end table
16252 @option{-march=native} causes the compiler to auto-detect the architecture
16253 of the build computer.  At present, this feature is only supported on
16254 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16255 is unsuccessful the option has no effect.
16257 @item -mtune=@var{name}
16258 @opindex mtune
16259 This option specifies the name of the target ARM processor for
16260 which GCC should tune the performance of the code.
16261 For some ARM implementations better performance can be obtained by using
16262 this option.
16263 Permissible names are: @samp{arm2}, @samp{arm250},
16264 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
16265 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
16266 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
16267 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
16268 @samp{arm720},
16269 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
16270 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
16271 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
16272 @samp{strongarm1110},
16273 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
16274 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
16275 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
16276 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
16277 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
16278 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
16279 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
16280 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
16281 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
16282 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
16283 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
16284 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
16285 @samp{cortex-r8}, @samp{cortex-r52},
16286 @samp{cortex-m33},
16287 @samp{cortex-m23},
16288 @samp{cortex-m7},
16289 @samp{cortex-m4},
16290 @samp{cortex-m3},
16291 @samp{cortex-m1},
16292 @samp{cortex-m0},
16293 @samp{cortex-m0plus},
16294 @samp{cortex-m1.small-multiply},
16295 @samp{cortex-m0.small-multiply},
16296 @samp{cortex-m0plus.small-multiply},
16297 @samp{exynos-m1},
16298 @samp{marvell-pj4},
16299 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
16300 @samp{fa526}, @samp{fa626},
16301 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16302 @samp{xgene1}.
16304 Additionally, this option can specify that GCC should tune the performance
16305 of the code for a big.LITTLE system.  Permissible names are:
16306 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16307 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16308 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16309 @samp{cortex-a75.cortex-a55}.
16311 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16312 performance for a blend of processors within architecture @var{arch}.
16313 The aim is to generate code that run well on the current most popular
16314 processors, balancing between optimizations that benefit some CPUs in the
16315 range, and avoiding performance pitfalls of other CPUs.  The effects of
16316 this option may change in future GCC versions as CPU models come and go.
16318 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16319 the extension options do not affect the tuning of the generated code.
16321 @option{-mtune=native} causes the compiler to auto-detect the CPU
16322 of the build computer.  At present, this feature is only supported on
16323 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16324 unsuccessful the option has no effect.
16326 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16327 @opindex mcpu
16328 This specifies the name of the target ARM processor.  GCC uses this name
16329 to derive the name of the target ARM architecture (as if specified
16330 by @option{-march}) and the ARM processor type for which to tune for
16331 performance (as if specified by @option{-mtune}).  Where this option
16332 is used in conjunction with @option{-march} or @option{-mtune},
16333 those options take precedence over the appropriate part of this option.
16335 Many of the supported CPUs implement optional architectural
16336 extensions.  Where this is so the architectural extensions are
16337 normally enabled by default.  If implementations that lack the
16338 extension exist, then the extension syntax can be used to disable
16339 those extensions that have been omitted.  For floating-point and
16340 Advanced SIMD (Neon) instructions, the settings of the options
16341 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16342 floating-point and Advanced SIMD instructions will only be used if
16343 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16344 @option{-mfpu} other than @samp{auto} will override the available
16345 floating-point and SIMD extension instructions.
16347 For example, @samp{cortex-a9} can be found in three major
16348 configurations: integer only, with just a floating-point unit or with
16349 floating-point and Advanced SIMD.  The default is to enable all the
16350 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16351 be used to disable just the SIMD or both the SIMD and floating-point
16352 instructions respectively.
16354 Permissible names for this option are the same as those for
16355 @option{-mtune}.
16357 The following extension options are common to the listed CPUs:
16359 @table @samp
16360 @item +nodsp
16361 Disable the DSP instructions on @samp{cortex-m33}.
16363 @item  +nofp
16364 Disables the floating-point instructions on @samp{arm9e},
16365 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16366 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16367 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16368 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16369 Disables the floating-point and SIMD instructions on
16370 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16371 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16372 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16373 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16374 @samp{cortex-a53} and @samp{cortex-a55}.
16376 @item +nofp.dp
16377 Disables the double-precision component of the floating-point instructions
16378 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16380 @item +nosimd
16381 Disables the SIMD (but not floating-point) instructions on
16382 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16383 and @samp{cortex-a9}.
16385 @item +crypto
16386 Enables the cryptographic instructions on @samp{cortex-a32},
16387 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16388 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16389 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16390 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16391 @samp{cortex-a75.cortex-a55}.
16392 @end table
16394 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16395 VFPv3 with 16 double-precision registers.  It supports the following
16396 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16397 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16398 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16399 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16400 @option{-march=armv7-a}.
16402 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16403 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16404 See @option{-mtune} for more information.
16406 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16407 of the build computer.  At present, this feature is only supported on
16408 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16409 is unsuccessful the option has no effect.
16411 @item -mfpu=@var{name}
16412 @opindex mfpu
16413 This specifies what floating-point hardware (or hardware emulation) is
16414 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16415 @samp{vfpv3},
16416 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16417 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16418 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16419 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16420 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16421 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16422 is an alias for @samp{vfpv2}.
16424 The setting @samp{auto} is the default and is special.  It causes the
16425 compiler to select the floating-point and Advanced SIMD instructions
16426 based on the settings of @option{-mcpu} and @option{-march}.
16428 If the selected floating-point hardware includes the NEON extension
16429 (e.g. @option{-mfpu=neon}), note that floating-point
16430 operations are not generated by GCC's auto-vectorization pass unless
16431 @option{-funsafe-math-optimizations} is also specified.  This is
16432 because NEON hardware does not fully implement the IEEE 754 standard for
16433 floating-point arithmetic (in particular denormal values are treated as
16434 zero), so the use of NEON instructions may lead to a loss of precision.
16436 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}).
16438 @item -mfp16-format=@var{name}
16439 @opindex mfp16-format
16440 Specify the format of the @code{__fp16} half-precision floating-point type.
16441 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16442 the default is @samp{none}, in which case the @code{__fp16} type is not
16443 defined.  @xref{Half-Precision}, for more information.
16445 @item -mstructure-size-boundary=@var{n}
16446 @opindex mstructure-size-boundary
16447 The sizes of all structures and unions are rounded up to a multiple
16448 of the number of bits set by this option.  Permissible values are 8, 32
16449 and 64.  The default value varies for different toolchains.  For the COFF
16450 targeted toolchain the default value is 8.  A value of 64 is only allowed
16451 if the underlying ABI supports it.
16453 Specifying a larger number can produce faster, more efficient code, but
16454 can also increase the size of the program.  Different values are potentially
16455 incompatible.  Code compiled with one value cannot necessarily expect to
16456 work with code or libraries compiled with another value, if they exchange
16457 information using structures or unions.
16459 This option is deprecated.
16461 @item -mabort-on-noreturn
16462 @opindex mabort-on-noreturn
16463 Generate a call to the function @code{abort} at the end of a
16464 @code{noreturn} function.  It is executed if the function tries to
16465 return.
16467 @item -mlong-calls
16468 @itemx -mno-long-calls
16469 @opindex mlong-calls
16470 @opindex mno-long-calls
16471 Tells the compiler to perform function calls by first loading the
16472 address of the function into a register and then performing a subroutine
16473 call on this register.  This switch is needed if the target function
16474 lies outside of the 64-megabyte addressing range of the offset-based
16475 version of subroutine call instruction.
16477 Even if this switch is enabled, not all function calls are turned
16478 into long calls.  The heuristic is that static functions, functions
16479 that have the @code{short_call} attribute, functions that are inside
16480 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16481 definitions have already been compiled within the current compilation
16482 unit are not turned into long calls.  The exceptions to this rule are
16483 that weak function definitions, functions with the @code{long_call}
16484 attribute or the @code{section} attribute, and functions that are within
16485 the scope of a @code{#pragma long_calls} directive are always
16486 turned into long calls.
16488 This feature is not enabled by default.  Specifying
16489 @option{-mno-long-calls} restores the default behavior, as does
16490 placing the function calls within the scope of a @code{#pragma
16491 long_calls_off} directive.  Note these switches have no effect on how
16492 the compiler generates code to handle function calls via function
16493 pointers.
16495 @item -msingle-pic-base
16496 @opindex msingle-pic-base
16497 Treat the register used for PIC addressing as read-only, rather than
16498 loading it in the prologue for each function.  The runtime system is
16499 responsible for initializing this register with an appropriate value
16500 before execution begins.
16502 @item -mpic-register=@var{reg}
16503 @opindex mpic-register
16504 Specify the register to be used for PIC addressing.
16505 For standard PIC base case, the default is any suitable register
16506 determined by compiler.  For single PIC base case, the default is
16507 @samp{R9} if target is EABI based or stack-checking is enabled,
16508 otherwise the default is @samp{R10}.
16510 @item -mpic-data-is-text-relative
16511 @opindex mpic-data-is-text-relative
16512 Assume that the displacement between the text and data segments is fixed
16513 at static link time.  This permits using PC-relative addressing
16514 operations to access data known to be in the data segment.  For
16515 non-VxWorks RTP targets, this option is enabled by default.  When
16516 disabled on such targets, it will enable @option{-msingle-pic-base} by
16517 default.
16519 @item -mpoke-function-name
16520 @opindex mpoke-function-name
16521 Write the name of each function into the text section, directly
16522 preceding the function prologue.  The generated code is similar to this:
16524 @smallexample
16525      t0
16526          .ascii "arm_poke_function_name", 0
16527          .align
16528      t1
16529          .word 0xff000000 + (t1 - t0)
16530      arm_poke_function_name
16531          mov     ip, sp
16532          stmfd   sp!, @{fp, ip, lr, pc@}
16533          sub     fp, ip, #4
16534 @end smallexample
16536 When performing a stack backtrace, code can inspect the value of
16537 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16538 location @code{pc - 12} and the top 8 bits are set, then we know that
16539 there is a function name embedded immediately preceding this location
16540 and has length @code{((pc[-3]) & 0xff000000)}.
16542 @item -mthumb
16543 @itemx -marm
16544 @opindex marm
16545 @opindex mthumb
16547 Select between generating code that executes in ARM and Thumb
16548 states.  The default for most configurations is to generate code
16549 that executes in ARM state, but the default can be changed by
16550 configuring GCC with the @option{--with-mode=}@var{state}
16551 configure option.
16553 You can also override the ARM and Thumb mode for each function
16554 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16555 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16557 @item -mflip-thumb 
16558 @opindex mflip-thumb
16559 Switch ARM/Thumb modes on alternating functions.
16560 This option is provided for regression testing of mixed Thumb/ARM code
16561 generation, and is not intended for ordinary use in compiling code.
16563 @item -mtpcs-frame
16564 @opindex mtpcs-frame
16565 Generate a stack frame that is compliant with the Thumb Procedure Call
16566 Standard for all non-leaf functions.  (A leaf function is one that does
16567 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16569 @item -mtpcs-leaf-frame
16570 @opindex mtpcs-leaf-frame
16571 Generate a stack frame that is compliant with the Thumb Procedure Call
16572 Standard for all leaf functions.  (A leaf function is one that does
16573 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16575 @item -mcallee-super-interworking
16576 @opindex mcallee-super-interworking
16577 Gives all externally visible functions in the file being compiled an ARM
16578 instruction set header which switches to Thumb mode before executing the
16579 rest of the function.  This allows these functions to be called from
16580 non-interworking code.  This option is not valid in AAPCS configurations
16581 because interworking is enabled by default.
16583 @item -mcaller-super-interworking
16584 @opindex mcaller-super-interworking
16585 Allows calls via function pointers (including virtual functions) to
16586 execute correctly regardless of whether the target code has been
16587 compiled for interworking or not.  There is a small overhead in the cost
16588 of executing a function pointer if this option is enabled.  This option
16589 is not valid in AAPCS configurations because interworking is enabled
16590 by default.
16592 @item -mtp=@var{name}
16593 @opindex mtp
16594 Specify the access model for the thread local storage pointer.  The valid
16595 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16596 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16597 (supported in the arm6k architecture), and @samp{auto}, which uses the
16598 best available method for the selected processor.  The default setting is
16599 @samp{auto}.
16601 @item -mtls-dialect=@var{dialect}
16602 @opindex mtls-dialect
16603 Specify the dialect to use for accessing thread local storage.  Two
16604 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16605 @samp{gnu} dialect selects the original GNU scheme for supporting
16606 local and global dynamic TLS models.  The @samp{gnu2} dialect
16607 selects the GNU descriptor scheme, which provides better performance
16608 for shared libraries.  The GNU descriptor scheme is compatible with
16609 the original scheme, but does require new assembler, linker and
16610 library support.  Initial and local exec TLS models are unaffected by
16611 this option and always use the original scheme.
16613 @item -mword-relocations
16614 @opindex mword-relocations
16615 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16616 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16617 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16618 is specified.
16620 @item -mfix-cortex-m3-ldrd
16621 @opindex mfix-cortex-m3-ldrd
16622 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16623 with overlapping destination and base registers are used.  This option avoids
16624 generating these instructions.  This option is enabled by default when
16625 @option{-mcpu=cortex-m3} is specified.
16627 @item -munaligned-access
16628 @itemx -mno-unaligned-access
16629 @opindex munaligned-access
16630 @opindex mno-unaligned-access
16631 Enables (or disables) reading and writing of 16- and 32- bit values
16632 from addresses that are not 16- or 32- bit aligned.  By default
16633 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16634 ARMv8-M Baseline architectures, and enabled for all other
16635 architectures.  If unaligned access is not enabled then words in packed
16636 data structures are accessed a byte at a time.
16638 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16639 generated object file to either true or false, depending upon the
16640 setting of this option.  If unaligned access is enabled then the
16641 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16642 defined.
16644 @item -mneon-for-64bits
16645 @opindex mneon-for-64bits
16646 Enables using Neon to handle scalar 64-bits operations. This is
16647 disabled by default since the cost of moving data from core registers
16648 to Neon is high.
16650 @item -mslow-flash-data
16651 @opindex mslow-flash-data
16652 Assume loading data from flash is slower than fetching instruction.
16653 Therefore literal load is minimized for better performance.
16654 This option is only supported when compiling for ARMv7 M-profile and
16655 off by default.
16657 @item -masm-syntax-unified
16658 @opindex masm-syntax-unified
16659 Assume inline assembler is using unified asm syntax.  The default is
16660 currently off which implies divided syntax.  This option has no impact
16661 on Thumb2. However, this may change in future releases of GCC.
16662 Divided syntax should be considered deprecated.
16664 @item -mrestrict-it
16665 @opindex mrestrict-it
16666 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16667 IT blocks can only contain a single 16-bit instruction from a select
16668 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16670 @item -mprint-tune-info
16671 @opindex mprint-tune-info
16672 Print CPU tuning information as comment in assembler file.  This is
16673 an option used only for regression testing of the compiler and not
16674 intended for ordinary use in compiling code.  This option is disabled
16675 by default.
16677 @item -mverbose-cost-dump
16678 @opindex mverbose-cost-dump
16679 Enable verbose cost model dumping in the debug dump files.  This option is
16680 provided for use in debugging the compiler.
16682 @item -mpure-code
16683 @opindex mpure-code
16684 Do not allow constant data to be placed in code sections.
16685 Additionally, when compiling for ELF object format give all text sections the
16686 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16687 is only available when generating non-pic code for M-profile targets with the
16688 MOVT instruction.
16690 @item -mcmse
16691 @opindex mcmse
16692 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16693 Development Tools Engineering Specification", which can be found on
16694 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16695 @end table
16697 @node AVR Options
16698 @subsection AVR Options
16699 @cindex AVR Options
16701 These options are defined for AVR implementations:
16703 @table @gcctabopt
16704 @item -mmcu=@var{mcu}
16705 @opindex mmcu
16706 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16708 The default for this option is@tie{}@samp{avr2}.
16710 GCC supports the following AVR devices and ISAs:
16712 @include avr-mmcu.texi
16714 @item -mabsdata
16715 @opindex mabsdata
16717 Assume that all data in static storage can be accessed by LDS / STS
16718 instructions.  This option has only an effect on reduced Tiny devices like
16719 ATtiny40.  See also the @code{absdata}
16720 @ref{AVR Variable Attributes,variable attribute}.
16722 @item -maccumulate-args
16723 @opindex maccumulate-args
16724 Accumulate outgoing function arguments and acquire/release the needed
16725 stack space for outgoing function arguments once in function
16726 prologue/epilogue.  Without this option, outgoing arguments are pushed
16727 before calling a function and popped afterwards.
16729 Popping the arguments after the function call can be expensive on
16730 AVR so that accumulating the stack space might lead to smaller
16731 executables because arguments need not be removed from the
16732 stack after such a function call.
16734 This option can lead to reduced code size for functions that perform
16735 several calls to functions that get their arguments on the stack like
16736 calls to printf-like functions.
16738 @item -mbranch-cost=@var{cost}
16739 @opindex mbranch-cost
16740 Set the branch costs for conditional branch instructions to
16741 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16742 integers. The default branch cost is 0.
16744 @item -mcall-prologues
16745 @opindex mcall-prologues
16746 Functions prologues/epilogues are expanded as calls to appropriate
16747 subroutines.  Code size is smaller.
16749 @item -mgas-isr-prologues
16750 @opindex mgas-isr-prologues
16751 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16752 instruction supported by GNU Binutils.
16753 If this option is on, the feature can still be disabled for individual
16754 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16755 function attribute.  This feature is activated per default
16756 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16757 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16759 @item -mint8
16760 @opindex mint8
16761 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16762 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16763 and @code{long long} is 4 bytes.  Please note that this option does not
16764 conform to the C standards, but it results in smaller code
16765 size.
16767 @item -mmain-is-OS_task
16768 @opindex mmain-is-OS_task
16769 Do not save registers in @code{main}.  The effect is the same like
16770 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
16771 to @code{main}. It is activated per default if optimization is on.
16773 @item -mn-flash=@var{num}
16774 @opindex mn-flash
16775 Assume that the flash memory has a size of 
16776 @var{num} times 64@tie{}KiB.
16778 @item -mno-interrupts
16779 @opindex mno-interrupts
16780 Generated code is not compatible with hardware interrupts.
16781 Code size is smaller.
16783 @item -mrelax
16784 @opindex mrelax
16785 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16786 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16787 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16788 the assembler's command line and the @option{--relax} option to the
16789 linker's command line.
16791 Jump relaxing is performed by the linker because jump offsets are not
16792 known before code is located. Therefore, the assembler code generated by the
16793 compiler is the same, but the instructions in the executable may
16794 differ from instructions in the assembler code.
16796 Relaxing must be turned on if linker stubs are needed, see the
16797 section on @code{EIND} and linker stubs below.
16799 @item -mrmw
16800 @opindex mrmw
16801 Assume that the device supports the Read-Modify-Write
16802 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16804 @item -mshort-calls
16805 @opindex mshort-calls
16807 Assume that @code{RJMP} and @code{RCALL} can target the whole
16808 program memory.
16810 This option is used internally for multilib selection.  It is
16811 not an optimization option, and you don't need to set it by hand.
16813 @item -msp8
16814 @opindex msp8
16815 Treat the stack pointer register as an 8-bit register,
16816 i.e.@: assume the high byte of the stack pointer is zero.
16817 In general, you don't need to set this option by hand.
16819 This option is used internally by the compiler to select and
16820 build multilibs for architectures @code{avr2} and @code{avr25}.
16821 These architectures mix devices with and without @code{SPH}.
16822 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16823 the compiler driver adds or removes this option from the compiler
16824 proper's command line, because the compiler then knows if the device
16825 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16826 register or not.
16828 @item -mstrict-X
16829 @opindex mstrict-X
16830 Use address register @code{X} in a way proposed by the hardware.  This means
16831 that @code{X} is only used in indirect, post-increment or
16832 pre-decrement addressing.
16834 Without this option, the @code{X} register may be used in the same way
16835 as @code{Y} or @code{Z} which then is emulated by additional
16836 instructions.  
16837 For example, loading a value with @code{X+const} addressing with a
16838 small non-negative @code{const < 64} to a register @var{Rn} is
16839 performed as
16841 @example
16842 adiw r26, const   ; X += const
16843 ld   @var{Rn}, X        ; @var{Rn} = *X
16844 sbiw r26, const   ; X -= const
16845 @end example
16847 @item -mtiny-stack
16848 @opindex mtiny-stack
16849 Only change the lower 8@tie{}bits of the stack pointer.
16851 @item -mfract-convert-truncate
16852 @opindex mfract-convert-truncate
16853 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16855 @item -nodevicelib
16856 @opindex nodevicelib
16857 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16859 @item -Waddr-space-convert
16860 @opindex Waddr-space-convert
16861 Warn about conversions between address spaces in the case where the
16862 resulting address space is not contained in the incoming address space.
16864 @item -Wmisspelled-isr
16865 @opindex Wmisspelled-isr
16866 Warn if the ISR is misspelled, i.e. without __vector prefix.
16867 Enabled by default.
16868 @end table
16870 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16871 @cindex @code{EIND}
16872 Pointers in the implementation are 16@tie{}bits wide.
16873 The address of a function or label is represented as word address so
16874 that indirect jumps and calls can target any code address in the
16875 range of 64@tie{}Ki words.
16877 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16878 bytes of program memory space, there is a special function register called
16879 @code{EIND} that serves as most significant part of the target address
16880 when @code{EICALL} or @code{EIJMP} instructions are used.
16882 Indirect jumps and calls on these devices are handled as follows by
16883 the compiler and are subject to some limitations:
16885 @itemize @bullet
16887 @item
16888 The compiler never sets @code{EIND}.
16890 @item
16891 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16892 instructions or might read @code{EIND} directly in order to emulate an
16893 indirect call/jump by means of a @code{RET} instruction.
16895 @item
16896 The compiler assumes that @code{EIND} never changes during the startup
16897 code or during the application. In particular, @code{EIND} is not
16898 saved/restored in function or interrupt service routine
16899 prologue/epilogue.
16901 @item
16902 For indirect calls to functions and computed goto, the linker
16903 generates @emph{stubs}. Stubs are jump pads sometimes also called
16904 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16905 The stub contains a direct jump to the desired address.
16907 @item
16908 Linker relaxation must be turned on so that the linker generates
16909 the stubs correctly in all situations. See the compiler option
16910 @option{-mrelax} and the linker option @option{--relax}.
16911 There are corner cases where the linker is supposed to generate stubs
16912 but aborts without relaxation and without a helpful error message.
16914 @item
16915 The default linker script is arranged for code with @code{EIND = 0}.
16916 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16917 linker script has to be used in order to place the sections whose
16918 name start with @code{.trampolines} into the segment where @code{EIND}
16919 points to.
16921 @item
16922 The startup code from libgcc never sets @code{EIND}.
16923 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16924 For the impact of AVR-LibC on @code{EIND}, see the
16925 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16927 @item
16928 It is legitimate for user-specific startup code to set up @code{EIND}
16929 early, for example by means of initialization code located in
16930 section @code{.init3}. Such code runs prior to general startup code
16931 that initializes RAM and calls constructors, but after the bit
16932 of startup code from AVR-LibC that sets @code{EIND} to the segment
16933 where the vector table is located.
16934 @example
16935 #include <avr/io.h>
16937 static void
16938 __attribute__((section(".init3"),naked,used,no_instrument_function))
16939 init3_set_eind (void)
16941   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16942                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16944 @end example
16946 @noindent
16947 The @code{__trampolines_start} symbol is defined in the linker script.
16949 @item
16950 Stubs are generated automatically by the linker if
16951 the following two conditions are met:
16952 @itemize @minus
16954 @item The address of a label is taken by means of the @code{gs} modifier
16955 (short for @emph{generate stubs}) like so:
16956 @example
16957 LDI r24, lo8(gs(@var{func}))
16958 LDI r25, hi8(gs(@var{func}))
16959 @end example
16960 @item The final location of that label is in a code segment
16961 @emph{outside} the segment where the stubs are located.
16962 @end itemize
16964 @item
16965 The compiler emits such @code{gs} modifiers for code labels in the
16966 following situations:
16967 @itemize @minus
16968 @item Taking address of a function or code label.
16969 @item Computed goto.
16970 @item If prologue-save function is used, see @option{-mcall-prologues}
16971 command-line option.
16972 @item Switch/case dispatch tables. If you do not want such dispatch
16973 tables you can specify the @option{-fno-jump-tables} command-line option.
16974 @item C and C++ constructors/destructors called during startup/shutdown.
16975 @item If the tools hit a @code{gs()} modifier explained above.
16976 @end itemize
16978 @item
16979 Jumping to non-symbolic addresses like so is @emph{not} supported:
16981 @example
16982 int main (void)
16984     /* Call function at word address 0x2 */
16985     return ((int(*)(void)) 0x2)();
16987 @end example
16989 Instead, a stub has to be set up, i.e.@: the function has to be called
16990 through a symbol (@code{func_4} in the example):
16992 @example
16993 int main (void)
16995     extern int func_4 (void);
16997     /* Call function at byte address 0x4 */
16998     return func_4();
17000 @end example
17002 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
17003 Alternatively, @code{func_4} can be defined in the linker script.
17004 @end itemize
17006 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
17007 @cindex @code{RAMPD}
17008 @cindex @code{RAMPX}
17009 @cindex @code{RAMPY}
17010 @cindex @code{RAMPZ}
17011 Some AVR devices support memories larger than the 64@tie{}KiB range
17012 that can be accessed with 16-bit pointers.  To access memory locations
17013 outside this 64@tie{}KiB range, the content of a @code{RAMP}
17014 register is used as high part of the address:
17015 The @code{X}, @code{Y}, @code{Z} address register is concatenated
17016 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
17017 register, respectively, to get a wide address. Similarly,
17018 @code{RAMPD} is used together with direct addressing.
17020 @itemize
17021 @item
17022 The startup code initializes the @code{RAMP} special function
17023 registers with zero.
17025 @item
17026 If a @ref{AVR Named Address Spaces,named address space} other than
17027 generic or @code{__flash} is used, then @code{RAMPZ} is set
17028 as needed before the operation.
17030 @item
17031 If the device supports RAM larger than 64@tie{}KiB and the compiler
17032 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
17033 is reset to zero after the operation.
17035 @item
17036 If the device comes with a specific @code{RAMP} register, the ISR
17037 prologue/epilogue saves/restores that SFR and initializes it with
17038 zero in case the ISR code might (implicitly) use it.
17040 @item
17041 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
17042 If you use inline assembler to read from locations outside the
17043 16-bit address range and change one of the @code{RAMP} registers,
17044 you must reset it to zero after the access.
17046 @end itemize
17048 @subsubsection AVR Built-in Macros
17050 GCC defines several built-in macros so that the user code can test
17051 for the presence or absence of features.  Almost any of the following
17052 built-in macros are deduced from device capabilities and thus
17053 triggered by the @option{-mmcu=} command-line option.
17055 For even more AVR-specific built-in macros see
17056 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
17058 @table @code
17060 @item __AVR_ARCH__
17061 Build-in macro that resolves to a decimal number that identifies the
17062 architecture and depends on the @option{-mmcu=@var{mcu}} option.
17063 Possible values are:
17065 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
17066 @code{4}, @code{5}, @code{51}, @code{6}
17068 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
17069 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
17071 respectively and
17073 @code{100},
17074 @code{102}, @code{103}, @code{104},
17075 @code{105}, @code{106}, @code{107}
17077 for @var{mcu}=@code{avrtiny},
17078 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
17079 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
17080 If @var{mcu} specifies a device, this built-in macro is set
17081 accordingly. For example, with @option{-mmcu=atmega8} the macro is
17082 defined to @code{4}.
17084 @item __AVR_@var{Device}__
17085 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
17086 the device's name. For example, @option{-mmcu=atmega8} defines the
17087 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
17088 @code{__AVR_ATtiny261A__}, etc.
17090 The built-in macros' names follow
17091 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
17092 the device name as from the AVR user manual. The difference between
17093 @var{Device} in the built-in macro and @var{device} in
17094 @option{-mmcu=@var{device}} is that the latter is always lowercase.
17096 If @var{device} is not a device but only a core architecture like
17097 @samp{avr51}, this macro is not defined.
17099 @item __AVR_DEVICE_NAME__
17100 Setting @option{-mmcu=@var{device}} defines this built-in macro to
17101 the device's name. For example, with @option{-mmcu=atmega8} the macro
17102 is defined to @code{atmega8}.
17104 If @var{device} is not a device but only a core architecture like
17105 @samp{avr51}, this macro is not defined.
17107 @item __AVR_XMEGA__
17108 The device / architecture belongs to the XMEGA family of devices.
17110 @item __AVR_HAVE_ELPM__
17111 The device has the @code{ELPM} instruction.
17113 @item __AVR_HAVE_ELPMX__
17114 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
17115 R@var{n},Z+} instructions.
17117 @item __AVR_HAVE_MOVW__
17118 The device has the @code{MOVW} instruction to perform 16-bit
17119 register-register moves.
17121 @item __AVR_HAVE_LPMX__
17122 The device has the @code{LPM R@var{n},Z} and
17123 @code{LPM R@var{n},Z+} instructions.
17125 @item __AVR_HAVE_MUL__
17126 The device has a hardware multiplier. 
17128 @item __AVR_HAVE_JMP_CALL__
17129 The device has the @code{JMP} and @code{CALL} instructions.
17130 This is the case for devices with more than 8@tie{}KiB of program
17131 memory.
17133 @item __AVR_HAVE_EIJMP_EICALL__
17134 @itemx __AVR_3_BYTE_PC__
17135 The device has the @code{EIJMP} and @code{EICALL} instructions.
17136 This is the case for devices with more than 128@tie{}KiB of program memory.
17137 This also means that the program counter
17138 (PC) is 3@tie{}bytes wide.
17140 @item __AVR_2_BYTE_PC__
17141 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
17142 with up to 128@tie{}KiB of program memory.
17144 @item __AVR_HAVE_8BIT_SP__
17145 @itemx __AVR_HAVE_16BIT_SP__
17146 The stack pointer (SP) register is treated as 8-bit respectively
17147 16-bit register by the compiler.
17148 The definition of these macros is affected by @option{-mtiny-stack}.
17150 @item __AVR_HAVE_SPH__
17151 @itemx __AVR_SP8__
17152 The device has the SPH (high part of stack pointer) special function
17153 register or has an 8-bit stack pointer, respectively.
17154 The definition of these macros is affected by @option{-mmcu=} and
17155 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
17156 by @option{-msp8}.
17158 @item __AVR_HAVE_RAMPD__
17159 @itemx __AVR_HAVE_RAMPX__
17160 @itemx __AVR_HAVE_RAMPY__
17161 @itemx __AVR_HAVE_RAMPZ__
17162 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
17163 @code{RAMPZ} special function register, respectively.
17165 @item __NO_INTERRUPTS__
17166 This macro reflects the @option{-mno-interrupts} command-line option.
17168 @item __AVR_ERRATA_SKIP__
17169 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
17170 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
17171 instructions because of a hardware erratum.  Skip instructions are
17172 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
17173 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
17174 set.
17176 @item __AVR_ISA_RMW__
17177 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
17179 @item __AVR_SFR_OFFSET__=@var{offset}
17180 Instructions that can address I/O special function registers directly
17181 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
17182 address as if addressed by an instruction to access RAM like @code{LD}
17183 or @code{STS}. This offset depends on the device architecture and has
17184 to be subtracted from the RAM address in order to get the
17185 respective I/O@tie{}address.
17187 @item __AVR_SHORT_CALLS__
17188 The @option{-mshort-calls} command line option is set.
17190 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
17191 Some devices support reading from flash memory by means of @code{LD*}
17192 instructions.  The flash memory is seen in the data address space
17193 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
17194 is not defined, this feature is not available.  If defined,
17195 the address space is linear and there is no need to put
17196 @code{.rodata} into RAM.  This is handled by the default linker
17197 description file, and is currently available for
17198 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
17199 there is no need to use address spaces like @code{__flash} or
17200 features like attribute @code{progmem} and @code{pgm_read_*}.
17202 @item __WITH_AVRLIBC__
17203 The compiler is configured to be used together with AVR-Libc.
17204 See the @option{--with-avrlibc} configure option.
17206 @end table
17208 @node Blackfin Options
17209 @subsection Blackfin Options
17210 @cindex Blackfin Options
17212 @table @gcctabopt
17213 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
17214 @opindex mcpu=
17215 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
17216 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
17217 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
17218 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
17219 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
17220 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
17221 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
17222 @samp{bf561}, @samp{bf592}.
17224 The optional @var{sirevision} specifies the silicon revision of the target
17225 Blackfin processor.  Any workarounds available for the targeted silicon revision
17226 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
17227 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
17228 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
17229 hexadecimal digits representing the major and minor numbers in the silicon
17230 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
17231 is not defined.  If @var{sirevision} is @samp{any}, the
17232 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
17233 If this optional @var{sirevision} is not used, GCC assumes the latest known
17234 silicon revision of the targeted Blackfin processor.
17236 GCC defines a preprocessor macro for the specified @var{cpu}.
17237 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
17238 provided by libgloss to be linked in if @option{-msim} is not given.
17240 Without this option, @samp{bf532} is used as the processor by default.
17242 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
17243 only the preprocessor macro is defined.
17245 @item -msim
17246 @opindex msim
17247 Specifies that the program will be run on the simulator.  This causes
17248 the simulator BSP provided by libgloss to be linked in.  This option
17249 has effect only for @samp{bfin-elf} toolchain.
17250 Certain other options, such as @option{-mid-shared-library} and
17251 @option{-mfdpic}, imply @option{-msim}.
17253 @item -momit-leaf-frame-pointer
17254 @opindex momit-leaf-frame-pointer
17255 Don't keep the frame pointer in a register for leaf functions.  This
17256 avoids the instructions to save, set up and restore frame pointers and
17257 makes an extra register available in leaf functions.
17259 @item -mspecld-anomaly
17260 @opindex mspecld-anomaly
17261 When enabled, the compiler ensures that the generated code does not
17262 contain speculative loads after jump instructions. If this option is used,
17263 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
17265 @item -mno-specld-anomaly
17266 @opindex mno-specld-anomaly
17267 Don't generate extra code to prevent speculative loads from occurring.
17269 @item -mcsync-anomaly
17270 @opindex mcsync-anomaly
17271 When enabled, the compiler ensures that the generated code does not
17272 contain CSYNC or SSYNC instructions too soon after conditional branches.
17273 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
17275 @item -mno-csync-anomaly
17276 @opindex mno-csync-anomaly
17277 Don't generate extra code to prevent CSYNC or SSYNC instructions from
17278 occurring too soon after a conditional branch.
17280 @item -mlow-64k
17281 @opindex mlow-64k
17282 When enabled, the compiler is free to take advantage of the knowledge that
17283 the entire program fits into the low 64k of memory.
17285 @item -mno-low-64k
17286 @opindex mno-low-64k
17287 Assume that the program is arbitrarily large.  This is the default.
17289 @item -mstack-check-l1
17290 @opindex mstack-check-l1
17291 Do stack checking using information placed into L1 scratchpad memory by the
17292 uClinux kernel.
17294 @item -mid-shared-library
17295 @opindex mid-shared-library
17296 Generate code that supports shared libraries via the library ID method.
17297 This allows for execute in place and shared libraries in an environment
17298 without virtual memory management.  This option implies @option{-fPIC}.
17299 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17301 @item -mno-id-shared-library
17302 @opindex mno-id-shared-library
17303 Generate code that doesn't assume ID-based shared libraries are being used.
17304 This is the default.
17306 @item -mleaf-id-shared-library
17307 @opindex mleaf-id-shared-library
17308 Generate code that supports shared libraries via the library ID method,
17309 but assumes that this library or executable won't link against any other
17310 ID shared libraries.  That allows the compiler to use faster code for jumps
17311 and calls.
17313 @item -mno-leaf-id-shared-library
17314 @opindex mno-leaf-id-shared-library
17315 Do not assume that the code being compiled won't link against any ID shared
17316 libraries.  Slower code is generated for jump and call insns.
17318 @item -mshared-library-id=n
17319 @opindex mshared-library-id
17320 Specifies the identification number of the ID-based shared library being
17321 compiled.  Specifying a value of 0 generates more compact code; specifying
17322 other values forces the allocation of that number to the current
17323 library but is no more space- or time-efficient than omitting this option.
17325 @item -msep-data
17326 @opindex msep-data
17327 Generate code that allows the data segment to be located in a different
17328 area of memory from the text segment.  This allows for execute in place in
17329 an environment without virtual memory management by eliminating relocations
17330 against the text section.
17332 @item -mno-sep-data
17333 @opindex mno-sep-data
17334 Generate code that assumes that the data segment follows the text segment.
17335 This is the default.
17337 @item -mlong-calls
17338 @itemx -mno-long-calls
17339 @opindex mlong-calls
17340 @opindex mno-long-calls
17341 Tells the compiler to perform function calls by first loading the
17342 address of the function into a register and then performing a subroutine
17343 call on this register.  This switch is needed if the target function
17344 lies outside of the 24-bit addressing range of the offset-based
17345 version of subroutine call instruction.
17347 This feature is not enabled by default.  Specifying
17348 @option{-mno-long-calls} restores the default behavior.  Note these
17349 switches have no effect on how the compiler generates code to handle
17350 function calls via function pointers.
17352 @item -mfast-fp
17353 @opindex mfast-fp
17354 Link with the fast floating-point library. This library relaxes some of
17355 the IEEE floating-point standard's rules for checking inputs against
17356 Not-a-Number (NAN), in the interest of performance.
17358 @item -minline-plt
17359 @opindex minline-plt
17360 Enable inlining of PLT entries in function calls to functions that are
17361 not known to bind locally.  It has no effect without @option{-mfdpic}.
17363 @item -mmulticore
17364 @opindex mmulticore
17365 Build a standalone application for multicore Blackfin processors. 
17366 This option causes proper start files and link scripts supporting 
17367 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17368 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17370 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17371 selects the one-application-per-core programming model.  Without
17372 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17373 programming model is used. In this model, the main function of Core B
17374 should be named as @code{coreb_main}.
17376 If this option is not used, the single-core application programming
17377 model is used.
17379 @item -mcorea
17380 @opindex mcorea
17381 Build a standalone application for Core A of BF561 when using
17382 the one-application-per-core programming model. Proper start files
17383 and link scripts are used to support Core A, and the macro
17384 @code{__BFIN_COREA} is defined.
17385 This option can only be used in conjunction with @option{-mmulticore}.
17387 @item -mcoreb
17388 @opindex mcoreb
17389 Build a standalone application for Core B of BF561 when using
17390 the one-application-per-core programming model. Proper start files
17391 and link scripts are used to support Core B, and the macro
17392 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17393 should be used instead of @code{main}. 
17394 This option can only be used in conjunction with @option{-mmulticore}.
17396 @item -msdram
17397 @opindex msdram
17398 Build a standalone application for SDRAM. Proper start files and
17399 link scripts are used to put the application into SDRAM, and the macro
17400 @code{__BFIN_SDRAM} is defined.
17401 The loader should initialize SDRAM before loading the application.
17403 @item -micplb
17404 @opindex micplb
17405 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17406 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17407 are enabled; for standalone applications the default is off.
17408 @end table
17410 @node C6X Options
17411 @subsection C6X Options
17412 @cindex C6X Options
17414 @table @gcctabopt
17415 @item -march=@var{name}
17416 @opindex march
17417 This specifies the name of the target architecture.  GCC uses this
17418 name to determine what kind of instructions it can emit when generating
17419 assembly code.  Permissible names are: @samp{c62x},
17420 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17422 @item -mbig-endian
17423 @opindex mbig-endian
17424 Generate code for a big-endian target.
17426 @item -mlittle-endian
17427 @opindex mlittle-endian
17428 Generate code for a little-endian target.  This is the default.
17430 @item -msim
17431 @opindex msim
17432 Choose startup files and linker script suitable for the simulator.
17434 @item -msdata=default
17435 @opindex msdata=default
17436 Put small global and static data in the @code{.neardata} section,
17437 which is pointed to by register @code{B14}.  Put small uninitialized
17438 global and static data in the @code{.bss} section, which is adjacent
17439 to the @code{.neardata} section.  Put small read-only data into the
17440 @code{.rodata} section.  The corresponding sections used for large
17441 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17443 @item -msdata=all
17444 @opindex msdata=all
17445 Put all data, not just small objects, into the sections reserved for
17446 small data, and use addressing relative to the @code{B14} register to
17447 access them.
17449 @item -msdata=none
17450 @opindex msdata=none
17451 Make no use of the sections reserved for small data, and use absolute
17452 addresses to access all data.  Put all initialized global and static
17453 data in the @code{.fardata} section, and all uninitialized data in the
17454 @code{.far} section.  Put all constant data into the @code{.const}
17455 section.
17456 @end table
17458 @node CRIS Options
17459 @subsection CRIS Options
17460 @cindex CRIS Options
17462 These options are defined specifically for the CRIS ports.
17464 @table @gcctabopt
17465 @item -march=@var{architecture-type}
17466 @itemx -mcpu=@var{architecture-type}
17467 @opindex march
17468 @opindex mcpu
17469 Generate code for the specified architecture.  The choices for
17470 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17471 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17472 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17473 @samp{v10}.
17475 @item -mtune=@var{architecture-type}
17476 @opindex mtune
17477 Tune to @var{architecture-type} everything applicable about the generated
17478 code, except for the ABI and the set of available instructions.  The
17479 choices for @var{architecture-type} are the same as for
17480 @option{-march=@var{architecture-type}}.
17482 @item -mmax-stack-frame=@var{n}
17483 @opindex mmax-stack-frame
17484 Warn when the stack frame of a function exceeds @var{n} bytes.
17486 @item -metrax4
17487 @itemx -metrax100
17488 @opindex metrax4
17489 @opindex metrax100
17490 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17491 @option{-march=v3} and @option{-march=v8} respectively.
17493 @item -mmul-bug-workaround
17494 @itemx -mno-mul-bug-workaround
17495 @opindex mmul-bug-workaround
17496 @opindex mno-mul-bug-workaround
17497 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17498 models where it applies.  This option is active by default.
17500 @item -mpdebug
17501 @opindex mpdebug
17502 Enable CRIS-specific verbose debug-related information in the assembly
17503 code.  This option also has the effect of turning off the @samp{#NO_APP}
17504 formatted-code indicator to the assembler at the beginning of the
17505 assembly file.
17507 @item -mcc-init
17508 @opindex mcc-init
17509 Do not use condition-code results from previous instruction; always emit
17510 compare and test instructions before use of condition codes.
17512 @item -mno-side-effects
17513 @opindex mno-side-effects
17514 Do not emit instructions with side effects in addressing modes other than
17515 post-increment.
17517 @item -mstack-align
17518 @itemx -mno-stack-align
17519 @itemx -mdata-align
17520 @itemx -mno-data-align
17521 @itemx -mconst-align
17522 @itemx -mno-const-align
17523 @opindex mstack-align
17524 @opindex mno-stack-align
17525 @opindex mdata-align
17526 @opindex mno-data-align
17527 @opindex mconst-align
17528 @opindex mno-const-align
17529 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17530 stack frame, individual data and constants to be aligned for the maximum
17531 single data access size for the chosen CPU model.  The default is to
17532 arrange for 32-bit alignment.  ABI details such as structure layout are
17533 not affected by these options.
17535 @item -m32-bit
17536 @itemx -m16-bit
17537 @itemx -m8-bit
17538 @opindex m32-bit
17539 @opindex m16-bit
17540 @opindex m8-bit
17541 Similar to the stack- data- and const-align options above, these options
17542 arrange for stack frame, writable data and constants to all be 32-bit,
17543 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17545 @item -mno-prologue-epilogue
17546 @itemx -mprologue-epilogue
17547 @opindex mno-prologue-epilogue
17548 @opindex mprologue-epilogue
17549 With @option{-mno-prologue-epilogue}, the normal function prologue and
17550 epilogue which set up the stack frame are omitted and no return
17551 instructions or return sequences are generated in the code.  Use this
17552 option only together with visual inspection of the compiled code: no
17553 warnings or errors are generated when call-saved registers must be saved,
17554 or storage for local variables needs to be allocated.
17556 @item -mno-gotplt
17557 @itemx -mgotplt
17558 @opindex mno-gotplt
17559 @opindex mgotplt
17560 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17561 instruction sequences that load addresses for functions from the PLT part
17562 of the GOT rather than (traditional on other architectures) calls to the
17563 PLT@.  The default is @option{-mgotplt}.
17565 @item -melf
17566 @opindex melf
17567 Legacy no-op option only recognized with the cris-axis-elf and
17568 cris-axis-linux-gnu targets.
17570 @item -mlinux
17571 @opindex mlinux
17572 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17574 @item -sim
17575 @opindex sim
17576 This option, recognized for the cris-axis-elf, arranges
17577 to link with input-output functions from a simulator library.  Code,
17578 initialized data and zero-initialized data are allocated consecutively.
17580 @item -sim2
17581 @opindex sim2
17582 Like @option{-sim}, but pass linker options to locate initialized data at
17583 0x40000000 and zero-initialized data at 0x80000000.
17584 @end table
17586 @node CR16 Options
17587 @subsection CR16 Options
17588 @cindex CR16 Options
17590 These options are defined specifically for the CR16 ports.
17592 @table @gcctabopt
17594 @item -mmac
17595 @opindex mmac
17596 Enable the use of multiply-accumulate instructions. Disabled by default.
17598 @item -mcr16cplus
17599 @itemx -mcr16c
17600 @opindex mcr16cplus
17601 @opindex mcr16c
17602 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17603 is default.
17605 @item -msim
17606 @opindex msim
17607 Links the library libsim.a which is in compatible with simulator. Applicable
17608 to ELF compiler only.
17610 @item -mint32
17611 @opindex mint32
17612 Choose integer type as 32-bit wide.
17614 @item -mbit-ops
17615 @opindex mbit-ops
17616 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17618 @item -mdata-model=@var{model}
17619 @opindex mdata-model
17620 Choose a data model. The choices for @var{model} are @samp{near},
17621 @samp{far} or @samp{medium}. @samp{medium} is default.
17622 However, @samp{far} is not valid with @option{-mcr16c}, as the
17623 CR16C architecture does not support the far data model.
17624 @end table
17626 @node Darwin Options
17627 @subsection Darwin Options
17628 @cindex Darwin options
17630 These options are defined for all architectures running the Darwin operating
17631 system.
17633 FSF GCC on Darwin does not create ``fat'' object files; it creates
17634 an object file for the single architecture that GCC was built to
17635 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17636 @option{-arch} options are used; it does so by running the compiler or
17637 linker multiple times and joining the results together with
17638 @file{lipo}.
17640 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17641 @samp{i686}) is determined by the flags that specify the ISA
17642 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17643 @option{-force_cpusubtype_ALL} option can be used to override this.
17645 The Darwin tools vary in their behavior when presented with an ISA
17646 mismatch.  The assembler, @file{as}, only permits instructions to
17647 be used that are valid for the subtype of the file it is generating,
17648 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17649 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17650 and prints an error if asked to create a shared library with a less
17651 restrictive subtype than its input files (for instance, trying to put
17652 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17653 for executables, @command{ld}, quietly gives the executable the most
17654 restrictive subtype of any of its input files.
17656 @table @gcctabopt
17657 @item -F@var{dir}
17658 @opindex F
17659 Add the framework directory @var{dir} to the head of the list of
17660 directories to be searched for header files.  These directories are
17661 interleaved with those specified by @option{-I} options and are
17662 scanned in a left-to-right order.
17664 A framework directory is a directory with frameworks in it.  A
17665 framework is a directory with a @file{Headers} and/or
17666 @file{PrivateHeaders} directory contained directly in it that ends
17667 in @file{.framework}.  The name of a framework is the name of this
17668 directory excluding the @file{.framework}.  Headers associated with
17669 the framework are found in one of those two directories, with
17670 @file{Headers} being searched first.  A subframework is a framework
17671 directory that is in a framework's @file{Frameworks} directory.
17672 Includes of subframework headers can only appear in a header of a
17673 framework that contains the subframework, or in a sibling subframework
17674 header.  Two subframeworks are siblings if they occur in the same
17675 framework.  A subframework should not have the same name as a
17676 framework; a warning is issued if this is violated.  Currently a
17677 subframework cannot have subframeworks; in the future, the mechanism
17678 may be extended to support this.  The standard frameworks can be found
17679 in @file{/System/Library/Frameworks} and
17680 @file{/Library/Frameworks}.  An example include looks like
17681 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17682 the name of the framework and @file{header.h} is found in the
17683 @file{PrivateHeaders} or @file{Headers} directory.
17685 @item -iframework@var{dir}
17686 @opindex iframework
17687 Like @option{-F} except the directory is a treated as a system
17688 directory.  The main difference between this @option{-iframework} and
17689 @option{-F} is that with @option{-iframework} the compiler does not
17690 warn about constructs contained within header files found via
17691 @var{dir}.  This option is valid only for the C family of languages.
17693 @item -gused
17694 @opindex gused
17695 Emit debugging information for symbols that are used.  For stabs
17696 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17697 This is by default ON@.
17699 @item -gfull
17700 @opindex gfull
17701 Emit debugging information for all symbols and types.
17703 @item -mmacosx-version-min=@var{version}
17704 The earliest version of MacOS X that this executable will run on
17705 is @var{version}.  Typical values of @var{version} include @code{10.1},
17706 @code{10.2}, and @code{10.3.9}.
17708 If the compiler was built to use the system's headers by default,
17709 then the default for this option is the system version on which the
17710 compiler is running, otherwise the default is to make choices that
17711 are compatible with as many systems and code bases as possible.
17713 @item -mkernel
17714 @opindex mkernel
17715 Enable kernel development mode.  The @option{-mkernel} option sets
17716 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17717 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17718 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17719 applicable.  This mode also sets @option{-mno-altivec},
17720 @option{-msoft-float}, @option{-fno-builtin} and
17721 @option{-mlong-branch} for PowerPC targets.
17723 @item -mone-byte-bool
17724 @opindex mone-byte-bool
17725 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17726 By default @code{sizeof(bool)} is @code{4} when compiling for
17727 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17728 option has no effect on x86.
17730 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17731 to generate code that is not binary compatible with code generated
17732 without that switch.  Using this switch may require recompiling all
17733 other modules in a program, including system libraries.  Use this
17734 switch to conform to a non-default data model.
17736 @item -mfix-and-continue
17737 @itemx -ffix-and-continue
17738 @itemx -findirect-data
17739 @opindex mfix-and-continue
17740 @opindex ffix-and-continue
17741 @opindex findirect-data
17742 Generate code suitable for fast turnaround development, such as to
17743 allow GDB to dynamically load @file{.o} files into already-running
17744 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17745 are provided for backwards compatibility.
17747 @item -all_load
17748 @opindex all_load
17749 Loads all members of static archive libraries.
17750 See man ld(1) for more information.
17752 @item -arch_errors_fatal
17753 @opindex arch_errors_fatal
17754 Cause the errors having to do with files that have the wrong architecture
17755 to be fatal.
17757 @item -bind_at_load
17758 @opindex bind_at_load
17759 Causes the output file to be marked such that the dynamic linker will
17760 bind all undefined references when the file is loaded or launched.
17762 @item -bundle
17763 @opindex bundle
17764 Produce a Mach-o bundle format file.
17765 See man ld(1) for more information.
17767 @item -bundle_loader @var{executable}
17768 @opindex bundle_loader
17769 This option specifies the @var{executable} that will load the build
17770 output file being linked.  See man ld(1) for more information.
17772 @item -dynamiclib
17773 @opindex dynamiclib
17774 When passed this option, GCC produces a dynamic library instead of
17775 an executable when linking, using the Darwin @file{libtool} command.
17777 @item -force_cpusubtype_ALL
17778 @opindex force_cpusubtype_ALL
17779 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17780 one controlled by the @option{-mcpu} or @option{-march} option.
17782 @item -allowable_client  @var{client_name}
17783 @itemx -client_name
17784 @itemx -compatibility_version
17785 @itemx -current_version
17786 @itemx -dead_strip
17787 @itemx -dependency-file
17788 @itemx -dylib_file
17789 @itemx -dylinker_install_name
17790 @itemx -dynamic
17791 @itemx -exported_symbols_list
17792 @itemx -filelist
17793 @need 800
17794 @itemx -flat_namespace
17795 @itemx -force_flat_namespace
17796 @itemx -headerpad_max_install_names
17797 @itemx -image_base
17798 @itemx -init
17799 @itemx -install_name
17800 @itemx -keep_private_externs
17801 @itemx -multi_module
17802 @itemx -multiply_defined
17803 @itemx -multiply_defined_unused
17804 @need 800
17805 @itemx -noall_load
17806 @itemx -no_dead_strip_inits_and_terms
17807 @itemx -nofixprebinding
17808 @itemx -nomultidefs
17809 @itemx -noprebind
17810 @itemx -noseglinkedit
17811 @itemx -pagezero_size
17812 @itemx -prebind
17813 @itemx -prebind_all_twolevel_modules
17814 @itemx -private_bundle
17815 @need 800
17816 @itemx -read_only_relocs
17817 @itemx -sectalign
17818 @itemx -sectobjectsymbols
17819 @itemx -whyload
17820 @itemx -seg1addr
17821 @itemx -sectcreate
17822 @itemx -sectobjectsymbols
17823 @itemx -sectorder
17824 @itemx -segaddr
17825 @itemx -segs_read_only_addr
17826 @need 800
17827 @itemx -segs_read_write_addr
17828 @itemx -seg_addr_table
17829 @itemx -seg_addr_table_filename
17830 @itemx -seglinkedit
17831 @itemx -segprot
17832 @itemx -segs_read_only_addr
17833 @itemx -segs_read_write_addr
17834 @itemx -single_module
17835 @itemx -static
17836 @itemx -sub_library
17837 @need 800
17838 @itemx -sub_umbrella
17839 @itemx -twolevel_namespace
17840 @itemx -umbrella
17841 @itemx -undefined
17842 @itemx -unexported_symbols_list
17843 @itemx -weak_reference_mismatches
17844 @itemx -whatsloaded
17845 @opindex allowable_client
17846 @opindex client_name
17847 @opindex compatibility_version
17848 @opindex current_version
17849 @opindex dead_strip
17850 @opindex dependency-file
17851 @opindex dylib_file
17852 @opindex dylinker_install_name
17853 @opindex dynamic
17854 @opindex exported_symbols_list
17855 @opindex filelist
17856 @opindex flat_namespace
17857 @opindex force_flat_namespace
17858 @opindex headerpad_max_install_names
17859 @opindex image_base
17860 @opindex init
17861 @opindex install_name
17862 @opindex keep_private_externs
17863 @opindex multi_module
17864 @opindex multiply_defined
17865 @opindex multiply_defined_unused
17866 @opindex noall_load
17867 @opindex no_dead_strip_inits_and_terms
17868 @opindex nofixprebinding
17869 @opindex nomultidefs
17870 @opindex noprebind
17871 @opindex noseglinkedit
17872 @opindex pagezero_size
17873 @opindex prebind
17874 @opindex prebind_all_twolevel_modules
17875 @opindex private_bundle
17876 @opindex read_only_relocs
17877 @opindex sectalign
17878 @opindex sectobjectsymbols
17879 @opindex whyload
17880 @opindex seg1addr
17881 @opindex sectcreate
17882 @opindex sectobjectsymbols
17883 @opindex sectorder
17884 @opindex segaddr
17885 @opindex segs_read_only_addr
17886 @opindex segs_read_write_addr
17887 @opindex seg_addr_table
17888 @opindex seg_addr_table_filename
17889 @opindex seglinkedit
17890 @opindex segprot
17891 @opindex segs_read_only_addr
17892 @opindex segs_read_write_addr
17893 @opindex single_module
17894 @opindex static
17895 @opindex sub_library
17896 @opindex sub_umbrella
17897 @opindex twolevel_namespace
17898 @opindex umbrella
17899 @opindex undefined
17900 @opindex unexported_symbols_list
17901 @opindex weak_reference_mismatches
17902 @opindex whatsloaded
17903 These options are passed to the Darwin linker.  The Darwin linker man page
17904 describes them in detail.
17905 @end table
17907 @node DEC Alpha Options
17908 @subsection DEC Alpha Options
17910 These @samp{-m} options are defined for the DEC Alpha implementations:
17912 @table @gcctabopt
17913 @item -mno-soft-float
17914 @itemx -msoft-float
17915 @opindex mno-soft-float
17916 @opindex msoft-float
17917 Use (do not use) the hardware floating-point instructions for
17918 floating-point operations.  When @option{-msoft-float} is specified,
17919 functions in @file{libgcc.a} are used to perform floating-point
17920 operations.  Unless they are replaced by routines that emulate the
17921 floating-point operations, or compiled in such a way as to call such
17922 emulations routines, these routines issue floating-point
17923 operations.   If you are compiling for an Alpha without floating-point
17924 operations, you must ensure that the library is built so as not to call
17925 them.
17927 Note that Alpha implementations without floating-point operations are
17928 required to have floating-point registers.
17930 @item -mfp-reg
17931 @itemx -mno-fp-regs
17932 @opindex mfp-reg
17933 @opindex mno-fp-regs
17934 Generate code that uses (does not use) the floating-point register set.
17935 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17936 register set is not used, floating-point operands are passed in integer
17937 registers as if they were integers and floating-point results are passed
17938 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17939 so any function with a floating-point argument or return value called by code
17940 compiled with @option{-mno-fp-regs} must also be compiled with that
17941 option.
17943 A typical use of this option is building a kernel that does not use,
17944 and hence need not save and restore, any floating-point registers.
17946 @item -mieee
17947 @opindex mieee
17948 The Alpha architecture implements floating-point hardware optimized for
17949 maximum performance.  It is mostly compliant with the IEEE floating-point
17950 standard.  However, for full compliance, software assistance is
17951 required.  This option generates code fully IEEE-compliant code
17952 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17953 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17954 defined during compilation.  The resulting code is less efficient but is
17955 able to correctly support denormalized numbers and exceptional IEEE
17956 values such as not-a-number and plus/minus infinity.  Other Alpha
17957 compilers call this option @option{-ieee_with_no_inexact}.
17959 @item -mieee-with-inexact
17960 @opindex mieee-with-inexact
17961 This is like @option{-mieee} except the generated code also maintains
17962 the IEEE @var{inexact-flag}.  Turning on this option causes the
17963 generated code to implement fully-compliant IEEE math.  In addition to
17964 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17965 macro.  On some Alpha implementations the resulting code may execute
17966 significantly slower than the code generated by default.  Since there is
17967 very little code that depends on the @var{inexact-flag}, you should
17968 normally not specify this option.  Other Alpha compilers call this
17969 option @option{-ieee_with_inexact}.
17971 @item -mfp-trap-mode=@var{trap-mode}
17972 @opindex mfp-trap-mode
17973 This option controls what floating-point related traps are enabled.
17974 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17975 The trap mode can be set to one of four values:
17977 @table @samp
17978 @item n
17979 This is the default (normal) setting.  The only traps that are enabled
17980 are the ones that cannot be disabled in software (e.g., division by zero
17981 trap).
17983 @item u
17984 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17985 as well.
17987 @item su
17988 Like @samp{u}, but the instructions are marked to be safe for software
17989 completion (see Alpha architecture manual for details).
17991 @item sui
17992 Like @samp{su}, but inexact traps are enabled as well.
17993 @end table
17995 @item -mfp-rounding-mode=@var{rounding-mode}
17996 @opindex mfp-rounding-mode
17997 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17998 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
18001 @table @samp
18002 @item n
18003 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
18004 the nearest machine number or towards the even machine number in case
18005 of a tie.
18007 @item m
18008 Round towards minus infinity.
18010 @item c
18011 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
18013 @item d
18014 Dynamic rounding mode.  A field in the floating-point control register
18015 (@var{fpcr}, see Alpha architecture reference manual) controls the
18016 rounding mode in effect.  The C library initializes this register for
18017 rounding towards plus infinity.  Thus, unless your program modifies the
18018 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
18019 @end table
18021 @item -mtrap-precision=@var{trap-precision}
18022 @opindex mtrap-precision
18023 In the Alpha architecture, floating-point traps are imprecise.  This
18024 means without software assistance it is impossible to recover from a
18025 floating trap and program execution normally needs to be terminated.
18026 GCC can generate code that can assist operating system trap handlers
18027 in determining the exact location that caused a floating-point trap.
18028 Depending on the requirements of an application, different levels of
18029 precisions can be selected:
18031 @table @samp
18032 @item p
18033 Program precision.  This option is the default and means a trap handler
18034 can only identify which program caused a floating-point exception.
18036 @item f
18037 Function precision.  The trap handler can determine the function that
18038 caused a floating-point exception.
18040 @item i
18041 Instruction precision.  The trap handler can determine the exact
18042 instruction that caused a floating-point exception.
18043 @end table
18045 Other Alpha compilers provide the equivalent options called
18046 @option{-scope_safe} and @option{-resumption_safe}.
18048 @item -mieee-conformant
18049 @opindex mieee-conformant
18050 This option marks the generated code as IEEE conformant.  You must not
18051 use this option unless you also specify @option{-mtrap-precision=i} and either
18052 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
18053 is to emit the line @samp{.eflag 48} in the function prologue of the
18054 generated assembly file.
18056 @item -mbuild-constants
18057 @opindex mbuild-constants
18058 Normally GCC examines a 32- or 64-bit integer constant to
18059 see if it can construct it from smaller constants in two or three
18060 instructions.  If it cannot, it outputs the constant as a literal and
18061 generates code to load it from the data segment at run time.
18063 Use this option to require GCC to construct @emph{all} integer constants
18064 using code, even if it takes more instructions (the maximum is six).
18066 You typically use this option to build a shared library dynamic
18067 loader.  Itself a shared library, it must relocate itself in memory
18068 before it can find the variables and constants in its own data segment.
18070 @item -mbwx
18071 @itemx -mno-bwx
18072 @itemx -mcix
18073 @itemx -mno-cix
18074 @itemx -mfix
18075 @itemx -mno-fix
18076 @itemx -mmax
18077 @itemx -mno-max
18078 @opindex mbwx
18079 @opindex mno-bwx
18080 @opindex mcix
18081 @opindex mno-cix
18082 @opindex mfix
18083 @opindex mno-fix
18084 @opindex mmax
18085 @opindex mno-max
18086 Indicate whether GCC should generate code to use the optional BWX,
18087 CIX, FIX and MAX instruction sets.  The default is to use the instruction
18088 sets supported by the CPU type specified via @option{-mcpu=} option or that
18089 of the CPU on which GCC was built if none is specified.
18091 @item -mfloat-vax
18092 @itemx -mfloat-ieee
18093 @opindex mfloat-vax
18094 @opindex mfloat-ieee
18095 Generate code that uses (does not use) VAX F and G floating-point
18096 arithmetic instead of IEEE single and double precision.
18098 @item -mexplicit-relocs
18099 @itemx -mno-explicit-relocs
18100 @opindex mexplicit-relocs
18101 @opindex mno-explicit-relocs
18102 Older Alpha assemblers provided no way to generate symbol relocations
18103 except via assembler macros.  Use of these macros does not allow
18104 optimal instruction scheduling.  GNU binutils as of version 2.12
18105 supports a new syntax that allows the compiler to explicitly mark
18106 which relocations should apply to which instructions.  This option
18107 is mostly useful for debugging, as GCC detects the capabilities of
18108 the assembler when it is built and sets the default accordingly.
18110 @item -msmall-data
18111 @itemx -mlarge-data
18112 @opindex msmall-data
18113 @opindex mlarge-data
18114 When @option{-mexplicit-relocs} is in effect, static data is
18115 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
18116 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
18117 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
18118 16-bit relocations off of the @code{$gp} register.  This limits the
18119 size of the small data area to 64KB, but allows the variables to be
18120 directly accessed via a single instruction.
18122 The default is @option{-mlarge-data}.  With this option the data area
18123 is limited to just below 2GB@.  Programs that require more than 2GB of
18124 data must use @code{malloc} or @code{mmap} to allocate the data in the
18125 heap instead of in the program's data segment.
18127 When generating code for shared libraries, @option{-fpic} implies
18128 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
18130 @item -msmall-text
18131 @itemx -mlarge-text
18132 @opindex msmall-text
18133 @opindex mlarge-text
18134 When @option{-msmall-text} is used, the compiler assumes that the
18135 code of the entire program (or shared library) fits in 4MB, and is
18136 thus reachable with a branch instruction.  When @option{-msmall-data}
18137 is used, the compiler can assume that all local symbols share the
18138 same @code{$gp} value, and thus reduce the number of instructions
18139 required for a function call from 4 to 1.
18141 The default is @option{-mlarge-text}.
18143 @item -mcpu=@var{cpu_type}
18144 @opindex mcpu
18145 Set the instruction set and instruction scheduling parameters for
18146 machine type @var{cpu_type}.  You can specify either the @samp{EV}
18147 style name or the corresponding chip number.  GCC supports scheduling
18148 parameters for the EV4, EV5 and EV6 family of processors and
18149 chooses the default values for the instruction set from the processor
18150 you specify.  If you do not specify a processor type, GCC defaults
18151 to the processor on which the compiler was built.
18153 Supported values for @var{cpu_type} are
18155 @table @samp
18156 @item ev4
18157 @itemx ev45
18158 @itemx 21064
18159 Schedules as an EV4 and has no instruction set extensions.
18161 @item ev5
18162 @itemx 21164
18163 Schedules as an EV5 and has no instruction set extensions.
18165 @item ev56
18166 @itemx 21164a
18167 Schedules as an EV5 and supports the BWX extension.
18169 @item pca56
18170 @itemx 21164pc
18171 @itemx 21164PC
18172 Schedules as an EV5 and supports the BWX and MAX extensions.
18174 @item ev6
18175 @itemx 21264
18176 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
18178 @item ev67
18179 @itemx 21264a
18180 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
18181 @end table
18183 Native toolchains also support the value @samp{native},
18184 which selects the best architecture option for the host processor.
18185 @option{-mcpu=native} has no effect if GCC does not recognize
18186 the processor.
18188 @item -mtune=@var{cpu_type}
18189 @opindex mtune
18190 Set only the instruction scheduling parameters for machine type
18191 @var{cpu_type}.  The instruction set is not changed.
18193 Native toolchains also support the value @samp{native},
18194 which selects the best architecture option for the host processor.
18195 @option{-mtune=native} has no effect if GCC does not recognize
18196 the processor.
18198 @item -mmemory-latency=@var{time}
18199 @opindex mmemory-latency
18200 Sets the latency the scheduler should assume for typical memory
18201 references as seen by the application.  This number is highly
18202 dependent on the memory access patterns used by the application
18203 and the size of the external cache on the machine.
18205 Valid options for @var{time} are
18207 @table @samp
18208 @item @var{number}
18209 A decimal number representing clock cycles.
18211 @item L1
18212 @itemx L2
18213 @itemx L3
18214 @itemx main
18215 The compiler contains estimates of the number of clock cycles for
18216 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
18217 (also called Dcache, Scache, and Bcache), as well as to main memory.
18218 Note that L3 is only valid for EV5.
18220 @end table
18221 @end table
18223 @node FR30 Options
18224 @subsection FR30 Options
18225 @cindex FR30 Options
18227 These options are defined specifically for the FR30 port.
18229 @table @gcctabopt
18231 @item -msmall-model
18232 @opindex msmall-model
18233 Use the small address space model.  This can produce smaller code, but
18234 it does assume that all symbolic values and addresses fit into a
18235 20-bit range.
18237 @item -mno-lsim
18238 @opindex mno-lsim
18239 Assume that runtime support has been provided and so there is no need
18240 to include the simulator library (@file{libsim.a}) on the linker
18241 command line.
18243 @end table
18245 @node FT32 Options
18246 @subsection FT32 Options
18247 @cindex FT32 Options
18249 These options are defined specifically for the FT32 port.
18251 @table @gcctabopt
18253 @item -msim
18254 @opindex msim
18255 Specifies that the program will be run on the simulator.  This causes
18256 an alternate runtime startup and library to be linked.
18257 You must not use this option when generating programs that will run on
18258 real hardware; you must provide your own runtime library for whatever
18259 I/O functions are needed.
18261 @item -mlra
18262 @opindex mlra
18263 Enable Local Register Allocation.  This is still experimental for FT32,
18264 so by default the compiler uses standard reload.
18266 @item -mnodiv
18267 @opindex mnodiv
18268 Do not use div and mod instructions.
18270 @item -mft32b
18271 @opindex mft32b
18272 Enable use of the extended instructions of the FT32B processor.
18274 @item -mcompress
18275 @opindex mcompress
18276 Compress all code using the Ft32B code compression scheme.
18278 @item -mnopm
18279 @opindex  mnopm
18280 Do not generate code that reads program memory.
18282 @end table
18284 @node FRV Options
18285 @subsection FRV Options
18286 @cindex FRV Options
18288 @table @gcctabopt
18289 @item -mgpr-32
18290 @opindex mgpr-32
18292 Only use the first 32 general-purpose registers.
18294 @item -mgpr-64
18295 @opindex mgpr-64
18297 Use all 64 general-purpose registers.
18299 @item -mfpr-32
18300 @opindex mfpr-32
18302 Use only the first 32 floating-point registers.
18304 @item -mfpr-64
18305 @opindex mfpr-64
18307 Use all 64 floating-point registers.
18309 @item -mhard-float
18310 @opindex mhard-float
18312 Use hardware instructions for floating-point operations.
18314 @item -msoft-float
18315 @opindex msoft-float
18317 Use library routines for floating-point operations.
18319 @item -malloc-cc
18320 @opindex malloc-cc
18322 Dynamically allocate condition code registers.
18324 @item -mfixed-cc
18325 @opindex mfixed-cc
18327 Do not try to dynamically allocate condition code registers, only
18328 use @code{icc0} and @code{fcc0}.
18330 @item -mdword
18331 @opindex mdword
18333 Change ABI to use double word insns.
18335 @item -mno-dword
18336 @opindex mno-dword
18338 Do not use double word instructions.
18340 @item -mdouble
18341 @opindex mdouble
18343 Use floating-point double instructions.
18345 @item -mno-double
18346 @opindex mno-double
18348 Do not use floating-point double instructions.
18350 @item -mmedia
18351 @opindex mmedia
18353 Use media instructions.
18355 @item -mno-media
18356 @opindex mno-media
18358 Do not use media instructions.
18360 @item -mmuladd
18361 @opindex mmuladd
18363 Use multiply and add/subtract instructions.
18365 @item -mno-muladd
18366 @opindex mno-muladd
18368 Do not use multiply and add/subtract instructions.
18370 @item -mfdpic
18371 @opindex mfdpic
18373 Select the FDPIC ABI, which uses function descriptors to represent
18374 pointers to functions.  Without any PIC/PIE-related options, it
18375 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18376 assumes GOT entries and small data are within a 12-bit range from the
18377 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18378 are computed with 32 bits.
18379 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18381 @item -minline-plt
18382 @opindex minline-plt
18384 Enable inlining of PLT entries in function calls to functions that are
18385 not known to bind locally.  It has no effect without @option{-mfdpic}.
18386 It's enabled by default if optimizing for speed and compiling for
18387 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18388 optimization option such as @option{-O3} or above is present in the
18389 command line.
18391 @item -mTLS
18392 @opindex mTLS
18394 Assume a large TLS segment when generating thread-local code.
18396 @item -mtls
18397 @opindex mtls
18399 Do not assume a large TLS segment when generating thread-local code.
18401 @item -mgprel-ro
18402 @opindex mgprel-ro
18404 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18405 that is known to be in read-only sections.  It's enabled by default,
18406 except for @option{-fpic} or @option{-fpie}: even though it may help
18407 make the global offset table smaller, it trades 1 instruction for 4.
18408 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18409 one of which may be shared by multiple symbols, and it avoids the need
18410 for a GOT entry for the referenced symbol, so it's more likely to be a
18411 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18413 @item -multilib-library-pic
18414 @opindex multilib-library-pic
18416 Link with the (library, not FD) pic libraries.  It's implied by
18417 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18418 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18419 it explicitly.
18421 @item -mlinked-fp
18422 @opindex mlinked-fp
18424 Follow the EABI requirement of always creating a frame pointer whenever
18425 a stack frame is allocated.  This option is enabled by default and can
18426 be disabled with @option{-mno-linked-fp}.
18428 @item -mlong-calls
18429 @opindex mlong-calls
18431 Use indirect addressing to call functions outside the current
18432 compilation unit.  This allows the functions to be placed anywhere
18433 within the 32-bit address space.
18435 @item -malign-labels
18436 @opindex malign-labels
18438 Try to align labels to an 8-byte boundary by inserting NOPs into the
18439 previous packet.  This option only has an effect when VLIW packing
18440 is enabled.  It doesn't create new packets; it merely adds NOPs to
18441 existing ones.
18443 @item -mlibrary-pic
18444 @opindex mlibrary-pic
18446 Generate position-independent EABI code.
18448 @item -macc-4
18449 @opindex macc-4
18451 Use only the first four media accumulator registers.
18453 @item -macc-8
18454 @opindex macc-8
18456 Use all eight media accumulator registers.
18458 @item -mpack
18459 @opindex mpack
18461 Pack VLIW instructions.
18463 @item -mno-pack
18464 @opindex mno-pack
18466 Do not pack VLIW instructions.
18468 @item -mno-eflags
18469 @opindex mno-eflags
18471 Do not mark ABI switches in e_flags.
18473 @item -mcond-move
18474 @opindex mcond-move
18476 Enable the use of conditional-move instructions (default).
18478 This switch is mainly for debugging the compiler and will likely be removed
18479 in a future version.
18481 @item -mno-cond-move
18482 @opindex mno-cond-move
18484 Disable the use of conditional-move instructions.
18486 This switch is mainly for debugging the compiler and will likely be removed
18487 in a future version.
18489 @item -mscc
18490 @opindex mscc
18492 Enable the use of conditional set instructions (default).
18494 This switch is mainly for debugging the compiler and will likely be removed
18495 in a future version.
18497 @item -mno-scc
18498 @opindex mno-scc
18500 Disable the use of conditional set instructions.
18502 This switch is mainly for debugging the compiler and will likely be removed
18503 in a future version.
18505 @item -mcond-exec
18506 @opindex mcond-exec
18508 Enable the use of conditional execution (default).
18510 This switch is mainly for debugging the compiler and will likely be removed
18511 in a future version.
18513 @item -mno-cond-exec
18514 @opindex mno-cond-exec
18516 Disable the use of conditional execution.
18518 This switch is mainly for debugging the compiler and will likely be removed
18519 in a future version.
18521 @item -mvliw-branch
18522 @opindex mvliw-branch
18524 Run a pass to pack branches into VLIW instructions (default).
18526 This switch is mainly for debugging the compiler and will likely be removed
18527 in a future version.
18529 @item -mno-vliw-branch
18530 @opindex mno-vliw-branch
18532 Do not run a pass to pack branches into VLIW instructions.
18534 This switch is mainly for debugging the compiler and will likely be removed
18535 in a future version.
18537 @item -mmulti-cond-exec
18538 @opindex mmulti-cond-exec
18540 Enable optimization of @code{&&} and @code{||} in conditional execution
18541 (default).
18543 This switch is mainly for debugging the compiler and will likely be removed
18544 in a future version.
18546 @item -mno-multi-cond-exec
18547 @opindex mno-multi-cond-exec
18549 Disable optimization of @code{&&} and @code{||} in conditional execution.
18551 This switch is mainly for debugging the compiler and will likely be removed
18552 in a future version.
18554 @item -mnested-cond-exec
18555 @opindex mnested-cond-exec
18557 Enable nested conditional execution optimizations (default).
18559 This switch is mainly for debugging the compiler and will likely be removed
18560 in a future version.
18562 @item -mno-nested-cond-exec
18563 @opindex mno-nested-cond-exec
18565 Disable nested conditional execution optimizations.
18567 This switch is mainly for debugging the compiler and will likely be removed
18568 in a future version.
18570 @item -moptimize-membar
18571 @opindex moptimize-membar
18573 This switch removes redundant @code{membar} instructions from the
18574 compiler-generated code.  It is enabled by default.
18576 @item -mno-optimize-membar
18577 @opindex mno-optimize-membar
18579 This switch disables the automatic removal of redundant @code{membar}
18580 instructions from the generated code.
18582 @item -mtomcat-stats
18583 @opindex mtomcat-stats
18585 Cause gas to print out tomcat statistics.
18587 @item -mcpu=@var{cpu}
18588 @opindex mcpu
18590 Select the processor type for which to generate code.  Possible values are
18591 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18592 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18594 @end table
18596 @node GNU/Linux Options
18597 @subsection GNU/Linux Options
18599 These @samp{-m} options are defined for GNU/Linux targets:
18601 @table @gcctabopt
18602 @item -mglibc
18603 @opindex mglibc
18604 Use the GNU C library.  This is the default except
18605 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18606 @samp{*-*-linux-*android*} targets.
18608 @item -muclibc
18609 @opindex muclibc
18610 Use uClibc C library.  This is the default on
18611 @samp{*-*-linux-*uclibc*} targets.
18613 @item -mmusl
18614 @opindex mmusl
18615 Use the musl C library.  This is the default on
18616 @samp{*-*-linux-*musl*} targets.
18618 @item -mbionic
18619 @opindex mbionic
18620 Use Bionic C library.  This is the default on
18621 @samp{*-*-linux-*android*} targets.
18623 @item -mandroid
18624 @opindex mandroid
18625 Compile code compatible with Android platform.  This is the default on
18626 @samp{*-*-linux-*android*} targets.
18628 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18629 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18630 this option makes the GCC driver pass Android-specific options to the linker.
18631 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18632 to be defined.
18634 @item -tno-android-cc
18635 @opindex tno-android-cc
18636 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18637 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18638 @option{-fno-rtti} by default.
18640 @item -tno-android-ld
18641 @opindex tno-android-ld
18642 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18643 linking options to the linker.
18645 @end table
18647 @node H8/300 Options
18648 @subsection H8/300 Options
18650 These @samp{-m} options are defined for the H8/300 implementations:
18652 @table @gcctabopt
18653 @item -mrelax
18654 @opindex mrelax
18655 Shorten some address references at link time, when possible; uses the
18656 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18657 ld, Using ld}, for a fuller description.
18659 @item -mh
18660 @opindex mh
18661 Generate code for the H8/300H@.
18663 @item -ms
18664 @opindex ms
18665 Generate code for the H8S@.
18667 @item -mn
18668 @opindex mn
18669 Generate code for the H8S and H8/300H in the normal mode.  This switch
18670 must be used either with @option{-mh} or @option{-ms}.
18672 @item -ms2600
18673 @opindex ms2600
18674 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18676 @item -mexr
18677 @opindex mexr
18678 Extended registers are stored on stack before execution of function
18679 with monitor attribute. Default option is @option{-mexr}.
18680 This option is valid only for H8S targets.
18682 @item -mno-exr
18683 @opindex mno-exr
18684 Extended registers are not stored on stack before execution of function 
18685 with monitor attribute. Default option is @option{-mno-exr}. 
18686 This option is valid only for H8S targets.
18688 @item -mint32
18689 @opindex mint32
18690 Make @code{int} data 32 bits by default.
18692 @item -malign-300
18693 @opindex malign-300
18694 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18695 The default for the H8/300H and H8S is to align longs and floats on
18696 4-byte boundaries.
18697 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18698 This option has no effect on the H8/300.
18699 @end table
18701 @node HPPA Options
18702 @subsection HPPA Options
18703 @cindex HPPA Options
18705 These @samp{-m} options are defined for the HPPA family of computers:
18707 @table @gcctabopt
18708 @item -march=@var{architecture-type}
18709 @opindex march
18710 Generate code for the specified architecture.  The choices for
18711 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18712 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18713 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18714 architecture option for your machine.  Code compiled for lower numbered
18715 architectures runs on higher numbered architectures, but not the
18716 other way around.
18718 @item -mpa-risc-1-0
18719 @itemx -mpa-risc-1-1
18720 @itemx -mpa-risc-2-0
18721 @opindex mpa-risc-1-0
18722 @opindex mpa-risc-1-1
18723 @opindex mpa-risc-2-0
18724 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18726 @item -mcaller-copies
18727 @opindex mcaller-copies
18728 The caller copies function arguments passed by hidden reference.  This
18729 option should be used with care as it is not compatible with the default
18730 32-bit runtime.  However, only aggregates larger than eight bytes are
18731 passed by hidden reference and the option provides better compatibility
18732 with OpenMP.
18734 @item -mjump-in-delay
18735 @opindex mjump-in-delay
18736 This option is ignored and provided for compatibility purposes only.
18738 @item -mdisable-fpregs
18739 @opindex mdisable-fpregs
18740 Prevent floating-point registers from being used in any manner.  This is
18741 necessary for compiling kernels that perform lazy context switching of
18742 floating-point registers.  If you use this option and attempt to perform
18743 floating-point operations, the compiler aborts.
18745 @item -mdisable-indexing
18746 @opindex mdisable-indexing
18747 Prevent the compiler from using indexing address modes.  This avoids some
18748 rather obscure problems when compiling MIG generated code under MACH@.
18750 @item -mno-space-regs
18751 @opindex mno-space-regs
18752 Generate code that assumes the target has no space registers.  This allows
18753 GCC to generate faster indirect calls and use unscaled index address modes.
18755 Such code is suitable for level 0 PA systems and kernels.
18757 @item -mfast-indirect-calls
18758 @opindex mfast-indirect-calls
18759 Generate code that assumes calls never cross space boundaries.  This
18760 allows GCC to emit code that performs faster indirect calls.
18762 This option does not work in the presence of shared libraries or nested
18763 functions.
18765 @item -mfixed-range=@var{register-range}
18766 @opindex mfixed-range
18767 Generate code treating the given register range as fixed registers.
18768 A fixed register is one that the register allocator cannot use.  This is
18769 useful when compiling kernel code.  A register range is specified as
18770 two registers separated by a dash.  Multiple register ranges can be
18771 specified separated by a comma.
18773 @item -mlong-load-store
18774 @opindex mlong-load-store
18775 Generate 3-instruction load and store sequences as sometimes required by
18776 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18777 the HP compilers.
18779 @item -mportable-runtime
18780 @opindex mportable-runtime
18781 Use the portable calling conventions proposed by HP for ELF systems.
18783 @item -mgas
18784 @opindex mgas
18785 Enable the use of assembler directives only GAS understands.
18787 @item -mschedule=@var{cpu-type}
18788 @opindex mschedule
18789 Schedule code according to the constraints for the machine type
18790 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18791 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18792 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18793 proper scheduling option for your machine.  The default scheduling is
18794 @samp{8000}.
18796 @item -mlinker-opt
18797 @opindex mlinker-opt
18798 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18799 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18800 linkers in which they give bogus error messages when linking some programs.
18802 @item -msoft-float
18803 @opindex msoft-float
18804 Generate output containing library calls for floating point.
18805 @strong{Warning:} the requisite libraries are not available for all HPPA
18806 targets.  Normally the facilities of the machine's usual C compiler are
18807 used, but this cannot be done directly in cross-compilation.  You must make
18808 your own arrangements to provide suitable library functions for
18809 cross-compilation.
18811 @option{-msoft-float} changes the calling convention in the output file;
18812 therefore, it is only useful if you compile @emph{all} of a program with
18813 this option.  In particular, you need to compile @file{libgcc.a}, the
18814 library that comes with GCC, with @option{-msoft-float} in order for
18815 this to work.
18817 @item -msio
18818 @opindex msio
18819 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18820 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18821 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18822 options are available under HP-UX and HI-UX@.
18824 @item -mgnu-ld
18825 @opindex mgnu-ld
18826 Use options specific to GNU @command{ld}.
18827 This passes @option{-shared} to @command{ld} when
18828 building a shared library.  It is the default when GCC is configured,
18829 explicitly or implicitly, with the GNU linker.  This option does not
18830 affect which @command{ld} is called; it only changes what parameters
18831 are passed to that @command{ld}.
18832 The @command{ld} that is called is determined by the
18833 @option{--with-ld} configure option, GCC's program search path, and
18834 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18835 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18836 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18838 @item -mhp-ld
18839 @opindex mhp-ld
18840 Use options specific to HP @command{ld}.
18841 This passes @option{-b} to @command{ld} when building
18842 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18843 links.  It is the default when GCC is configured, explicitly or
18844 implicitly, with the HP linker.  This option does not affect
18845 which @command{ld} is called; it only changes what parameters are passed to that
18846 @command{ld}.
18847 The @command{ld} that is called is determined by the @option{--with-ld}
18848 configure option, GCC's program search path, and finally by the user's
18849 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18850 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18851 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18853 @item -mlong-calls
18854 @opindex mno-long-calls
18855 Generate code that uses long call sequences.  This ensures that a call
18856 is always able to reach linker generated stubs.  The default is to generate
18857 long calls only when the distance from the call site to the beginning
18858 of the function or translation unit, as the case may be, exceeds a
18859 predefined limit set by the branch type being used.  The limits for
18860 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18861 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18862 240,000 bytes.
18864 Distances are measured from the beginning of functions when using the
18865 @option{-ffunction-sections} option, or when using the @option{-mgas}
18866 and @option{-mno-portable-runtime} options together under HP-UX with
18867 the SOM linker.
18869 It is normally not desirable to use this option as it degrades
18870 performance.  However, it may be useful in large applications,
18871 particularly when partial linking is used to build the application.
18873 The types of long calls used depends on the capabilities of the
18874 assembler and linker, and the type of code being generated.  The
18875 impact on systems that support long absolute calls, and long pic
18876 symbol-difference or pc-relative calls should be relatively small.
18877 However, an indirect call is used on 32-bit ELF systems in pic code
18878 and it is quite long.
18880 @item -munix=@var{unix-std}
18881 @opindex march
18882 Generate compiler predefines and select a startfile for the specified
18883 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18884 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18885 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18886 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18887 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18888 and later.
18890 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18891 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18892 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18893 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18894 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18895 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18897 It is @emph{important} to note that this option changes the interfaces
18898 for various library routines.  It also affects the operational behavior
18899 of the C library.  Thus, @emph{extreme} care is needed in using this
18900 option.
18902 Library code that is intended to operate with more than one UNIX
18903 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18904 as appropriate.  Most GNU software doesn't provide this capability.
18906 @item -nolibdld
18907 @opindex nolibdld
18908 Suppress the generation of link options to search libdld.sl when the
18909 @option{-static} option is specified on HP-UX 10 and later.
18911 @item -static
18912 @opindex static
18913 The HP-UX implementation of setlocale in libc has a dependency on
18914 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18915 when the @option{-static} option is specified, special link options
18916 are needed to resolve this dependency.
18918 On HP-UX 10 and later, the GCC driver adds the necessary options to
18919 link with libdld.sl when the @option{-static} option is specified.
18920 This causes the resulting binary to be dynamic.  On the 64-bit port,
18921 the linkers generate dynamic binaries by default in any case.  The
18922 @option{-nolibdld} option can be used to prevent the GCC driver from
18923 adding these link options.
18925 @item -threads
18926 @opindex threads
18927 Add support for multithreading with the @dfn{dce thread} library
18928 under HP-UX@.  This option sets flags for both the preprocessor and
18929 linker.
18930 @end table
18932 @node IA-64 Options
18933 @subsection IA-64 Options
18934 @cindex IA-64 Options
18936 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18938 @table @gcctabopt
18939 @item -mbig-endian
18940 @opindex mbig-endian
18941 Generate code for a big-endian target.  This is the default for HP-UX@.
18943 @item -mlittle-endian
18944 @opindex mlittle-endian
18945 Generate code for a little-endian target.  This is the default for AIX5
18946 and GNU/Linux.
18948 @item -mgnu-as
18949 @itemx -mno-gnu-as
18950 @opindex mgnu-as
18951 @opindex mno-gnu-as
18952 Generate (or don't) code for the GNU assembler.  This is the default.
18953 @c Also, this is the default if the configure option @option{--with-gnu-as}
18954 @c is used.
18956 @item -mgnu-ld
18957 @itemx -mno-gnu-ld
18958 @opindex mgnu-ld
18959 @opindex mno-gnu-ld
18960 Generate (or don't) code for the GNU linker.  This is the default.
18961 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18962 @c is used.
18964 @item -mno-pic
18965 @opindex mno-pic
18966 Generate code that does not use a global pointer register.  The result
18967 is not position independent code, and violates the IA-64 ABI@.
18969 @item -mvolatile-asm-stop
18970 @itemx -mno-volatile-asm-stop
18971 @opindex mvolatile-asm-stop
18972 @opindex mno-volatile-asm-stop
18973 Generate (or don't) a stop bit immediately before and after volatile asm
18974 statements.
18976 @item -mregister-names
18977 @itemx -mno-register-names
18978 @opindex mregister-names
18979 @opindex mno-register-names
18980 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18981 the stacked registers.  This may make assembler output more readable.
18983 @item -mno-sdata
18984 @itemx -msdata
18985 @opindex mno-sdata
18986 @opindex msdata
18987 Disable (or enable) optimizations that use the small data section.  This may
18988 be useful for working around optimizer bugs.
18990 @item -mconstant-gp
18991 @opindex mconstant-gp
18992 Generate code that uses a single constant global pointer value.  This is
18993 useful when compiling kernel code.
18995 @item -mauto-pic
18996 @opindex mauto-pic
18997 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18998 This is useful when compiling firmware code.
19000 @item -minline-float-divide-min-latency
19001 @opindex minline-float-divide-min-latency
19002 Generate code for inline divides of floating-point values
19003 using the minimum latency algorithm.
19005 @item -minline-float-divide-max-throughput
19006 @opindex minline-float-divide-max-throughput
19007 Generate code for inline divides of floating-point values
19008 using the maximum throughput algorithm.
19010 @item -mno-inline-float-divide
19011 @opindex mno-inline-float-divide
19012 Do not generate inline code for divides of floating-point values.
19014 @item -minline-int-divide-min-latency
19015 @opindex minline-int-divide-min-latency
19016 Generate code for inline divides of integer values
19017 using the minimum latency algorithm.
19019 @item -minline-int-divide-max-throughput
19020 @opindex minline-int-divide-max-throughput
19021 Generate code for inline divides of integer values
19022 using the maximum throughput algorithm.
19024 @item -mno-inline-int-divide
19025 @opindex mno-inline-int-divide
19026 Do not generate inline code for divides of integer values.
19028 @item -minline-sqrt-min-latency
19029 @opindex minline-sqrt-min-latency
19030 Generate code for inline square roots
19031 using the minimum latency algorithm.
19033 @item -minline-sqrt-max-throughput
19034 @opindex minline-sqrt-max-throughput
19035 Generate code for inline square roots
19036 using the maximum throughput algorithm.
19038 @item -mno-inline-sqrt
19039 @opindex mno-inline-sqrt
19040 Do not generate inline code for @code{sqrt}.
19042 @item -mfused-madd
19043 @itemx -mno-fused-madd
19044 @opindex mfused-madd
19045 @opindex mno-fused-madd
19046 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
19047 instructions.  The default is to use these instructions.
19049 @item -mno-dwarf2-asm
19050 @itemx -mdwarf2-asm
19051 @opindex mno-dwarf2-asm
19052 @opindex mdwarf2-asm
19053 Don't (or do) generate assembler code for the DWARF line number debugging
19054 info.  This may be useful when not using the GNU assembler.
19056 @item -mearly-stop-bits
19057 @itemx -mno-early-stop-bits
19058 @opindex mearly-stop-bits
19059 @opindex mno-early-stop-bits
19060 Allow stop bits to be placed earlier than immediately preceding the
19061 instruction that triggered the stop bit.  This can improve instruction
19062 scheduling, but does not always do so.
19064 @item -mfixed-range=@var{register-range}
19065 @opindex mfixed-range
19066 Generate code treating the given register range as fixed registers.
19067 A fixed register is one that the register allocator cannot use.  This is
19068 useful when compiling kernel code.  A register range is specified as
19069 two registers separated by a dash.  Multiple register ranges can be
19070 specified separated by a comma.
19072 @item -mtls-size=@var{tls-size}
19073 @opindex mtls-size
19074 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
19077 @item -mtune=@var{cpu-type}
19078 @opindex mtune
19079 Tune the instruction scheduling for a particular CPU, Valid values are
19080 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
19081 and @samp{mckinley}.
19083 @item -milp32
19084 @itemx -mlp64
19085 @opindex milp32
19086 @opindex mlp64
19087 Generate code for a 32-bit or 64-bit environment.
19088 The 32-bit environment sets int, long and pointer to 32 bits.
19089 The 64-bit environment sets int to 32 bits and long and pointer
19090 to 64 bits.  These are HP-UX specific flags.
19092 @item -mno-sched-br-data-spec
19093 @itemx -msched-br-data-spec
19094 @opindex mno-sched-br-data-spec
19095 @opindex msched-br-data-spec
19096 (Dis/En)able data speculative scheduling before reload.
19097 This results in generation of @code{ld.a} instructions and
19098 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19099 The default setting is disabled.
19101 @item -msched-ar-data-spec
19102 @itemx -mno-sched-ar-data-spec
19103 @opindex msched-ar-data-spec
19104 @opindex mno-sched-ar-data-spec
19105 (En/Dis)able data speculative scheduling after reload.
19106 This results in generation of @code{ld.a} instructions and
19107 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
19108 The default setting is enabled.
19110 @item -mno-sched-control-spec
19111 @itemx -msched-control-spec
19112 @opindex mno-sched-control-spec
19113 @opindex msched-control-spec
19114 (Dis/En)able control speculative scheduling.  This feature is
19115 available only during region scheduling (i.e.@: before reload).
19116 This results in generation of the @code{ld.s} instructions and
19117 the corresponding check instructions @code{chk.s}.
19118 The default setting is disabled.
19120 @item -msched-br-in-data-spec
19121 @itemx -mno-sched-br-in-data-spec
19122 @opindex msched-br-in-data-spec
19123 @opindex mno-sched-br-in-data-spec
19124 (En/Dis)able speculative scheduling of the instructions that
19125 are dependent on the data speculative loads before reload.
19126 This is effective only with @option{-msched-br-data-spec} enabled.
19127 The default setting is enabled.
19129 @item -msched-ar-in-data-spec
19130 @itemx -mno-sched-ar-in-data-spec
19131 @opindex msched-ar-in-data-spec
19132 @opindex mno-sched-ar-in-data-spec
19133 (En/Dis)able speculative scheduling of the instructions that
19134 are dependent on the data speculative loads after reload.
19135 This is effective only with @option{-msched-ar-data-spec} enabled.
19136 The default setting is enabled.
19138 @item -msched-in-control-spec
19139 @itemx -mno-sched-in-control-spec
19140 @opindex msched-in-control-spec
19141 @opindex mno-sched-in-control-spec
19142 (En/Dis)able speculative scheduling of the instructions that
19143 are dependent on the control speculative loads.
19144 This is effective only with @option{-msched-control-spec} enabled.
19145 The default setting is enabled.
19147 @item -mno-sched-prefer-non-data-spec-insns
19148 @itemx -msched-prefer-non-data-spec-insns
19149 @opindex mno-sched-prefer-non-data-spec-insns
19150 @opindex msched-prefer-non-data-spec-insns
19151 If enabled, data-speculative instructions are chosen for schedule
19152 only if there are no other choices at the moment.  This makes
19153 the use of the data speculation much more conservative.
19154 The default setting is disabled.
19156 @item -mno-sched-prefer-non-control-spec-insns
19157 @itemx -msched-prefer-non-control-spec-insns
19158 @opindex mno-sched-prefer-non-control-spec-insns
19159 @opindex msched-prefer-non-control-spec-insns
19160 If enabled, control-speculative instructions are chosen for schedule
19161 only if there are no other choices at the moment.  This makes
19162 the use of the control speculation much more conservative.
19163 The default setting is disabled.
19165 @item -mno-sched-count-spec-in-critical-path
19166 @itemx -msched-count-spec-in-critical-path
19167 @opindex mno-sched-count-spec-in-critical-path
19168 @opindex msched-count-spec-in-critical-path
19169 If enabled, speculative dependencies are considered during
19170 computation of the instructions priorities.  This makes the use of the
19171 speculation a bit more conservative.
19172 The default setting is disabled.
19174 @item -msched-spec-ldc
19175 @opindex msched-spec-ldc
19176 Use a simple data speculation check.  This option is on by default.
19178 @item -msched-control-spec-ldc
19179 @opindex msched-spec-ldc
19180 Use a simple check for control speculation.  This option is on by default.
19182 @item -msched-stop-bits-after-every-cycle
19183 @opindex msched-stop-bits-after-every-cycle
19184 Place a stop bit after every cycle when scheduling.  This option is on
19185 by default.
19187 @item -msched-fp-mem-deps-zero-cost
19188 @opindex msched-fp-mem-deps-zero-cost
19189 Assume that floating-point stores and loads are not likely to cause a conflict
19190 when placed into the same instruction group.  This option is disabled by
19191 default.
19193 @item -msel-sched-dont-check-control-spec
19194 @opindex msel-sched-dont-check-control-spec
19195 Generate checks for control speculation in selective scheduling.
19196 This flag is disabled by default.
19198 @item -msched-max-memory-insns=@var{max-insns}
19199 @opindex msched-max-memory-insns
19200 Limit on the number of memory insns per instruction group, giving lower
19201 priority to subsequent memory insns attempting to schedule in the same
19202 instruction group. Frequently useful to prevent cache bank conflicts.
19203 The default value is 1.
19205 @item -msched-max-memory-insns-hard-limit
19206 @opindex msched-max-memory-insns-hard-limit
19207 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
19208 disallowing more than that number in an instruction group.
19209 Otherwise, the limit is ``soft'', meaning that non-memory operations
19210 are preferred when the limit is reached, but memory operations may still
19211 be scheduled.
19213 @end table
19215 @node LM32 Options
19216 @subsection LM32 Options
19217 @cindex LM32 options
19219 These @option{-m} options are defined for the LatticeMico32 architecture:
19221 @table @gcctabopt
19222 @item -mbarrel-shift-enabled
19223 @opindex mbarrel-shift-enabled
19224 Enable barrel-shift instructions.
19226 @item -mdivide-enabled
19227 @opindex mdivide-enabled
19228 Enable divide and modulus instructions.
19230 @item -mmultiply-enabled
19231 @opindex multiply-enabled
19232 Enable multiply instructions.
19234 @item -msign-extend-enabled
19235 @opindex msign-extend-enabled
19236 Enable sign extend instructions.
19238 @item -muser-enabled
19239 @opindex muser-enabled
19240 Enable user-defined instructions.
19242 @end table
19244 @node M32C Options
19245 @subsection M32C Options
19246 @cindex M32C options
19248 @table @gcctabopt
19249 @item -mcpu=@var{name}
19250 @opindex mcpu=
19251 Select the CPU for which code is generated.  @var{name} may be one of
19252 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
19253 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
19254 the M32C/80 series.
19256 @item -msim
19257 @opindex msim
19258 Specifies that the program will be run on the simulator.  This causes
19259 an alternate runtime library to be linked in which supports, for
19260 example, file I/O@.  You must not use this option when generating
19261 programs that will run on real hardware; you must provide your own
19262 runtime library for whatever I/O functions are needed.
19264 @item -memregs=@var{number}
19265 @opindex memregs=
19266 Specifies the number of memory-based pseudo-registers GCC uses
19267 during code generation.  These pseudo-registers are used like real
19268 registers, so there is a tradeoff between GCC's ability to fit the
19269 code into available registers, and the performance penalty of using
19270 memory instead of registers.  Note that all modules in a program must
19271 be compiled with the same value for this option.  Because of that, you
19272 must not use this option with GCC's default runtime libraries.
19274 @end table
19276 @node M32R/D Options
19277 @subsection M32R/D Options
19278 @cindex M32R/D options
19280 These @option{-m} options are defined for Renesas M32R/D architectures:
19282 @table @gcctabopt
19283 @item -m32r2
19284 @opindex m32r2
19285 Generate code for the M32R/2@.
19287 @item -m32rx
19288 @opindex m32rx
19289 Generate code for the M32R/X@.
19291 @item -m32r
19292 @opindex m32r
19293 Generate code for the M32R@.  This is the default.
19295 @item -mmodel=small
19296 @opindex mmodel=small
19297 Assume all objects live in the lower 16MB of memory (so that their addresses
19298 can be loaded with the @code{ld24} instruction), and assume all subroutines
19299 are reachable with the @code{bl} instruction.
19300 This is the default.
19302 The addressability of a particular object can be set with the
19303 @code{model} attribute.
19305 @item -mmodel=medium
19306 @opindex mmodel=medium
19307 Assume objects may be anywhere in the 32-bit address space (the compiler
19308 generates @code{seth/add3} instructions to load their addresses), and
19309 assume all subroutines are reachable with the @code{bl} instruction.
19311 @item -mmodel=large
19312 @opindex mmodel=large
19313 Assume objects may be anywhere in the 32-bit address space (the compiler
19314 generates @code{seth/add3} instructions to load their addresses), and
19315 assume subroutines may not be reachable with the @code{bl} instruction
19316 (the compiler generates the much slower @code{seth/add3/jl}
19317 instruction sequence).
19319 @item -msdata=none
19320 @opindex msdata=none
19321 Disable use of the small data area.  Variables are put into
19322 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19323 @code{section} attribute has been specified).
19324 This is the default.
19326 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19327 Objects may be explicitly put in the small data area with the
19328 @code{section} attribute using one of these sections.
19330 @item -msdata=sdata
19331 @opindex msdata=sdata
19332 Put small global and static data in the small data area, but do not
19333 generate special code to reference them.
19335 @item -msdata=use
19336 @opindex msdata=use
19337 Put small global and static data in the small data area, and generate
19338 special instructions to reference them.
19340 @item -G @var{num}
19341 @opindex G
19342 @cindex smaller data references
19343 Put global and static objects less than or equal to @var{num} bytes
19344 into the small data or BSS sections instead of the normal data or BSS
19345 sections.  The default value of @var{num} is 8.
19346 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
19347 for this option to have any effect.
19349 All modules should be compiled with the same @option{-G @var{num}} value.
19350 Compiling with different values of @var{num} may or may not work; if it
19351 doesn't the linker gives an error message---incorrect code is not
19352 generated.
19354 @item -mdebug
19355 @opindex mdebug
19356 Makes the M32R-specific code in the compiler display some statistics
19357 that might help in debugging programs.
19359 @item -malign-loops
19360 @opindex malign-loops
19361 Align all loops to a 32-byte boundary.
19363 @item -mno-align-loops
19364 @opindex mno-align-loops
19365 Do not enforce a 32-byte alignment for loops.  This is the default.
19367 @item -missue-rate=@var{number}
19368 @opindex missue-rate=@var{number}
19369 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19370 or 2.
19372 @item -mbranch-cost=@var{number}
19373 @opindex mbranch-cost=@var{number}
19374 @var{number} can only be 1 or 2.  If it is 1 then branches are
19375 preferred over conditional code, if it is 2, then the opposite applies.
19377 @item -mflush-trap=@var{number}
19378 @opindex mflush-trap=@var{number}
19379 Specifies the trap number to use to flush the cache.  The default is
19380 12.  Valid numbers are between 0 and 15 inclusive.
19382 @item -mno-flush-trap
19383 @opindex mno-flush-trap
19384 Specifies that the cache cannot be flushed by using a trap.
19386 @item -mflush-func=@var{name}
19387 @opindex mflush-func=@var{name}
19388 Specifies the name of the operating system function to call to flush
19389 the cache.  The default is @samp{_flush_cache}, but a function call
19390 is only used if a trap is not available.
19392 @item -mno-flush-func
19393 @opindex mno-flush-func
19394 Indicates that there is no OS function for flushing the cache.
19396 @end table
19398 @node M680x0 Options
19399 @subsection M680x0 Options
19400 @cindex M680x0 options
19402 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19403 The default settings depend on which architecture was selected when
19404 the compiler was configured; the defaults for the most common choices
19405 are given below.
19407 @table @gcctabopt
19408 @item -march=@var{arch}
19409 @opindex march
19410 Generate code for a specific M680x0 or ColdFire instruction set
19411 architecture.  Permissible values of @var{arch} for M680x0
19412 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19413 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19414 architectures are selected according to Freescale's ISA classification
19415 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19416 @samp{isab} and @samp{isac}.
19418 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19419 code for a ColdFire target.  The @var{arch} in this macro is one of the
19420 @option{-march} arguments given above.
19422 When used together, @option{-march} and @option{-mtune} select code
19423 that runs on a family of similar processors but that is optimized
19424 for a particular microarchitecture.
19426 @item -mcpu=@var{cpu}
19427 @opindex mcpu
19428 Generate code for a specific M680x0 or ColdFire processor.
19429 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19430 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19431 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19432 below, which also classifies the CPUs into families:
19434 @multitable @columnfractions 0.20 0.80
19435 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19436 @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}
19437 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19438 @item @samp{5206e} @tab @samp{5206e}
19439 @item @samp{5208} @tab @samp{5207} @samp{5208}
19440 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19441 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19442 @item @samp{5216} @tab @samp{5214} @samp{5216}
19443 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19444 @item @samp{5225} @tab @samp{5224} @samp{5225}
19445 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19446 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19447 @item @samp{5249} @tab @samp{5249}
19448 @item @samp{5250} @tab @samp{5250}
19449 @item @samp{5271} @tab @samp{5270} @samp{5271}
19450 @item @samp{5272} @tab @samp{5272}
19451 @item @samp{5275} @tab @samp{5274} @samp{5275}
19452 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19453 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19454 @item @samp{5307} @tab @samp{5307}
19455 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19456 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19457 @item @samp{5407} @tab @samp{5407}
19458 @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}
19459 @end multitable
19461 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19462 @var{arch} is compatible with @var{cpu}.  Other combinations of
19463 @option{-mcpu} and @option{-march} are rejected.
19465 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19466 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19467 where the value of @var{family} is given by the table above.
19469 @item -mtune=@var{tune}
19470 @opindex mtune
19471 Tune the code for a particular microarchitecture within the
19472 constraints set by @option{-march} and @option{-mcpu}.
19473 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19474 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19475 and @samp{cpu32}.  The ColdFire microarchitectures
19476 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19478 You can also use @option{-mtune=68020-40} for code that needs
19479 to run relatively well on 68020, 68030 and 68040 targets.
19480 @option{-mtune=68020-60} is similar but includes 68060 targets
19481 as well.  These two options select the same tuning decisions as
19482 @option{-m68020-40} and @option{-m68020-60} respectively.
19484 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19485 when tuning for 680x0 architecture @var{arch}.  It also defines
19486 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19487 option is used.  If GCC is tuning for a range of architectures,
19488 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19489 it defines the macros for every architecture in the range.
19491 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19492 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19493 of the arguments given above.
19495 @item -m68000
19496 @itemx -mc68000
19497 @opindex m68000
19498 @opindex mc68000
19499 Generate output for a 68000.  This is the default
19500 when the compiler is configured for 68000-based systems.
19501 It is equivalent to @option{-march=68000}.
19503 Use this option for microcontrollers with a 68000 or EC000 core,
19504 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19506 @item -m68010
19507 @opindex m68010
19508 Generate output for a 68010.  This is the default
19509 when the compiler is configured for 68010-based systems.
19510 It is equivalent to @option{-march=68010}.
19512 @item -m68020
19513 @itemx -mc68020
19514 @opindex m68020
19515 @opindex mc68020
19516 Generate output for a 68020.  This is the default
19517 when the compiler is configured for 68020-based systems.
19518 It is equivalent to @option{-march=68020}.
19520 @item -m68030
19521 @opindex m68030
19522 Generate output for a 68030.  This is the default when the compiler is
19523 configured for 68030-based systems.  It is equivalent to
19524 @option{-march=68030}.
19526 @item -m68040
19527 @opindex m68040
19528 Generate output for a 68040.  This is the default when the compiler is
19529 configured for 68040-based systems.  It is equivalent to
19530 @option{-march=68040}.
19532 This option inhibits the use of 68881/68882 instructions that have to be
19533 emulated by software on the 68040.  Use this option if your 68040 does not
19534 have code to emulate those instructions.
19536 @item -m68060
19537 @opindex m68060
19538 Generate output for a 68060.  This is the default when the compiler is
19539 configured for 68060-based systems.  It is equivalent to
19540 @option{-march=68060}.
19542 This option inhibits the use of 68020 and 68881/68882 instructions that
19543 have to be emulated by software on the 68060.  Use this option if your 68060
19544 does not have code to emulate those instructions.
19546 @item -mcpu32
19547 @opindex mcpu32
19548 Generate output for a CPU32.  This is the default
19549 when the compiler is configured for CPU32-based systems.
19550 It is equivalent to @option{-march=cpu32}.
19552 Use this option for microcontrollers with a
19553 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19554 68336, 68340, 68341, 68349 and 68360.
19556 @item -m5200
19557 @opindex m5200
19558 Generate output for a 520X ColdFire CPU@.  This is the default
19559 when the compiler is configured for 520X-based systems.
19560 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19561 in favor of that option.
19563 Use this option for microcontroller with a 5200 core, including
19564 the MCF5202, MCF5203, MCF5204 and MCF5206.
19566 @item -m5206e
19567 @opindex m5206e
19568 Generate output for a 5206e ColdFire CPU@.  The option is now
19569 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19571 @item -m528x
19572 @opindex m528x
19573 Generate output for a member of the ColdFire 528X family.
19574 The option is now deprecated in favor of the equivalent
19575 @option{-mcpu=528x}.
19577 @item -m5307
19578 @opindex m5307
19579 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19580 in favor of the equivalent @option{-mcpu=5307}.
19582 @item -m5407
19583 @opindex m5407
19584 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19585 in favor of the equivalent @option{-mcpu=5407}.
19587 @item -mcfv4e
19588 @opindex mcfv4e
19589 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19590 This includes use of hardware floating-point instructions.
19591 The option is equivalent to @option{-mcpu=547x}, and is now
19592 deprecated in favor of that option.
19594 @item -m68020-40
19595 @opindex m68020-40
19596 Generate output for a 68040, without using any of the new instructions.
19597 This results in code that can run relatively efficiently on either a
19598 68020/68881 or a 68030 or a 68040.  The generated code does use the
19599 68881 instructions that are emulated on the 68040.
19601 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19603 @item -m68020-60
19604 @opindex m68020-60
19605 Generate output for a 68060, without using any of the new instructions.
19606 This results in code that can run relatively efficiently on either a
19607 68020/68881 or a 68030 or a 68040.  The generated code does use the
19608 68881 instructions that are emulated on the 68060.
19610 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19612 @item -mhard-float
19613 @itemx -m68881
19614 @opindex mhard-float
19615 @opindex m68881
19616 Generate floating-point instructions.  This is the default for 68020
19617 and above, and for ColdFire devices that have an FPU@.  It defines the
19618 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19619 on ColdFire targets.
19621 @item -msoft-float
19622 @opindex msoft-float
19623 Do not generate floating-point instructions; use library calls instead.
19624 This is the default for 68000, 68010, and 68832 targets.  It is also
19625 the default for ColdFire devices that have no FPU.
19627 @item -mdiv
19628 @itemx -mno-div
19629 @opindex mdiv
19630 @opindex mno-div
19631 Generate (do not generate) ColdFire hardware divide and remainder
19632 instructions.  If @option{-march} is used without @option{-mcpu},
19633 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19634 architectures.  Otherwise, the default is taken from the target CPU
19635 (either the default CPU, or the one specified by @option{-mcpu}).  For
19636 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19637 @option{-mcpu=5206e}.
19639 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19641 @item -mshort
19642 @opindex mshort
19643 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19644 Additionally, parameters passed on the stack are also aligned to a
19645 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19647 @item -mno-short
19648 @opindex mno-short
19649 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19651 @item -mnobitfield
19652 @itemx -mno-bitfield
19653 @opindex mnobitfield
19654 @opindex mno-bitfield
19655 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19656 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19658 @item -mbitfield
19659 @opindex mbitfield
19660 Do use the bit-field instructions.  The @option{-m68020} option implies
19661 @option{-mbitfield}.  This is the default if you use a configuration
19662 designed for a 68020.
19664 @item -mrtd
19665 @opindex mrtd
19666 Use a different function-calling convention, in which functions
19667 that take a fixed number of arguments return with the @code{rtd}
19668 instruction, which pops their arguments while returning.  This
19669 saves one instruction in the caller since there is no need to pop
19670 the arguments there.
19672 This calling convention is incompatible with the one normally
19673 used on Unix, so you cannot use it if you need to call libraries
19674 compiled with the Unix compiler.
19676 Also, you must provide function prototypes for all functions that
19677 take variable numbers of arguments (including @code{printf});
19678 otherwise incorrect code is generated for calls to those
19679 functions.
19681 In addition, seriously incorrect code results if you call a
19682 function with too many arguments.  (Normally, extra arguments are
19683 harmlessly ignored.)
19685 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19686 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19688 @item -mno-rtd
19689 @opindex mno-rtd
19690 Do not use the calling conventions selected by @option{-mrtd}.
19691 This is the default.
19693 @item -malign-int
19694 @itemx -mno-align-int
19695 @opindex malign-int
19696 @opindex mno-align-int
19697 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19698 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19699 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19700 Aligning variables on 32-bit boundaries produces code that runs somewhat
19701 faster on processors with 32-bit busses at the expense of more memory.
19703 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19704 aligns structures containing the above types differently than
19705 most published application binary interface specifications for the m68k.
19707 @item -mpcrel
19708 @opindex mpcrel
19709 Use the pc-relative addressing mode of the 68000 directly, instead of
19710 using a global offset table.  At present, this option implies @option{-fpic},
19711 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19712 not presently supported with @option{-mpcrel}, though this could be supported for
19713 68020 and higher processors.
19715 @item -mno-strict-align
19716 @itemx -mstrict-align
19717 @opindex mno-strict-align
19718 @opindex mstrict-align
19719 Do not (do) assume that unaligned memory references are handled by
19720 the system.
19722 @item -msep-data
19723 Generate code that allows the data segment to be located in a different
19724 area of memory from the text segment.  This allows for execute-in-place in
19725 an environment without virtual memory management.  This option implies
19726 @option{-fPIC}.
19728 @item -mno-sep-data
19729 Generate code that assumes that the data segment follows the text segment.
19730 This is the default.
19732 @item -mid-shared-library
19733 Generate code that supports shared libraries via the library ID method.
19734 This allows for execute-in-place and shared libraries in an environment
19735 without virtual memory management.  This option implies @option{-fPIC}.
19737 @item -mno-id-shared-library
19738 Generate code that doesn't assume ID-based shared libraries are being used.
19739 This is the default.
19741 @item -mshared-library-id=n
19742 Specifies the identification number of the ID-based shared library being
19743 compiled.  Specifying a value of 0 generates more compact code; specifying
19744 other values forces the allocation of that number to the current
19745 library, but is no more space- or time-efficient than omitting this option.
19747 @item -mxgot
19748 @itemx -mno-xgot
19749 @opindex mxgot
19750 @opindex mno-xgot
19751 When generating position-independent code for ColdFire, generate code
19752 that works if the GOT has more than 8192 entries.  This code is
19753 larger and slower than code generated without this option.  On M680x0
19754 processors, this option is not needed; @option{-fPIC} suffices.
19756 GCC normally uses a single instruction to load values from the GOT@.
19757 While this is relatively efficient, it only works if the GOT
19758 is smaller than about 64k.  Anything larger causes the linker
19759 to report an error such as:
19761 @cindex relocation truncated to fit (ColdFire)
19762 @smallexample
19763 relocation truncated to fit: R_68K_GOT16O foobar
19764 @end smallexample
19766 If this happens, you should recompile your code with @option{-mxgot}.
19767 It should then work with very large GOTs.  However, code generated with
19768 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19769 the value of a global symbol.
19771 Note that some linkers, including newer versions of the GNU linker,
19772 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19773 you should only need to use @option{-mxgot} when compiling a single
19774 object file that accesses more than 8192 GOT entries.  Very few do.
19776 These options have no effect unless GCC is generating
19777 position-independent code.
19779 @item -mlong-jump-table-offsets
19780 @opindex mlong-jump-table-offsets
19781 Use 32-bit offsets in @code{switch} tables.  The default is to use
19782 16-bit offsets.
19784 @end table
19786 @node MCore Options
19787 @subsection MCore Options
19788 @cindex MCore options
19790 These are the @samp{-m} options defined for the Motorola M*Core
19791 processors.
19793 @table @gcctabopt
19795 @item -mhardlit
19796 @itemx -mno-hardlit
19797 @opindex mhardlit
19798 @opindex mno-hardlit
19799 Inline constants into the code stream if it can be done in two
19800 instructions or less.
19802 @item -mdiv
19803 @itemx -mno-div
19804 @opindex mdiv
19805 @opindex mno-div
19806 Use the divide instruction.  (Enabled by default).
19808 @item -mrelax-immediate
19809 @itemx -mno-relax-immediate
19810 @opindex mrelax-immediate
19811 @opindex mno-relax-immediate
19812 Allow arbitrary-sized immediates in bit operations.
19814 @item -mwide-bitfields
19815 @itemx -mno-wide-bitfields
19816 @opindex mwide-bitfields
19817 @opindex mno-wide-bitfields
19818 Always treat bit-fields as @code{int}-sized.
19820 @item -m4byte-functions
19821 @itemx -mno-4byte-functions
19822 @opindex m4byte-functions
19823 @opindex mno-4byte-functions
19824 Force all functions to be aligned to a 4-byte boundary.
19826 @item -mcallgraph-data
19827 @itemx -mno-callgraph-data
19828 @opindex mcallgraph-data
19829 @opindex mno-callgraph-data
19830 Emit callgraph information.
19832 @item -mslow-bytes
19833 @itemx -mno-slow-bytes
19834 @opindex mslow-bytes
19835 @opindex mno-slow-bytes
19836 Prefer word access when reading byte quantities.
19838 @item -mlittle-endian
19839 @itemx -mbig-endian
19840 @opindex mlittle-endian
19841 @opindex mbig-endian
19842 Generate code for a little-endian target.
19844 @item -m210
19845 @itemx -m340
19846 @opindex m210
19847 @opindex m340
19848 Generate code for the 210 processor.
19850 @item -mno-lsim
19851 @opindex mno-lsim
19852 Assume that runtime support has been provided and so omit the
19853 simulator library (@file{libsim.a)} from the linker command line.
19855 @item -mstack-increment=@var{size}
19856 @opindex mstack-increment
19857 Set the maximum amount for a single stack increment operation.  Large
19858 values can increase the speed of programs that contain functions
19859 that need a large amount of stack space, but they can also trigger a
19860 segmentation fault if the stack is extended too much.  The default
19861 value is 0x1000.
19863 @end table
19865 @node MeP Options
19866 @subsection MeP Options
19867 @cindex MeP options
19869 @table @gcctabopt
19871 @item -mabsdiff
19872 @opindex mabsdiff
19873 Enables the @code{abs} instruction, which is the absolute difference
19874 between two registers.
19876 @item -mall-opts
19877 @opindex mall-opts
19878 Enables all the optional instructions---average, multiply, divide, bit
19879 operations, leading zero, absolute difference, min/max, clip, and
19880 saturation.
19883 @item -maverage
19884 @opindex maverage
19885 Enables the @code{ave} instruction, which computes the average of two
19886 registers.
19888 @item -mbased=@var{n}
19889 @opindex mbased=
19890 Variables of size @var{n} bytes or smaller are placed in the
19891 @code{.based} section by default.  Based variables use the @code{$tp}
19892 register as a base register, and there is a 128-byte limit to the
19893 @code{.based} section.
19895 @item -mbitops
19896 @opindex mbitops
19897 Enables the bit operation instructions---bit test (@code{btstm}), set
19898 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19899 test-and-set (@code{tas}).
19901 @item -mc=@var{name}
19902 @opindex mc=
19903 Selects which section constant data is placed in.  @var{name} may
19904 be @samp{tiny}, @samp{near}, or @samp{far}.
19906 @item -mclip
19907 @opindex mclip
19908 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19909 useful unless you also provide @option{-mminmax}.
19911 @item -mconfig=@var{name}
19912 @opindex mconfig=
19913 Selects one of the built-in core configurations.  Each MeP chip has
19914 one or more modules in it; each module has a core CPU and a variety of
19915 coprocessors, optional instructions, and peripherals.  The
19916 @code{MeP-Integrator} tool, not part of GCC, provides these
19917 configurations through this option; using this option is the same as
19918 using all the corresponding command-line options.  The default
19919 configuration is @samp{default}.
19921 @item -mcop
19922 @opindex mcop
19923 Enables the coprocessor instructions.  By default, this is a 32-bit
19924 coprocessor.  Note that the coprocessor is normally enabled via the
19925 @option{-mconfig=} option.
19927 @item -mcop32
19928 @opindex mcop32
19929 Enables the 32-bit coprocessor's instructions.
19931 @item -mcop64
19932 @opindex mcop64
19933 Enables the 64-bit coprocessor's instructions.
19935 @item -mivc2
19936 @opindex mivc2
19937 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19939 @item -mdc
19940 @opindex mdc
19941 Causes constant variables to be placed in the @code{.near} section.
19943 @item -mdiv
19944 @opindex mdiv
19945 Enables the @code{div} and @code{divu} instructions.
19947 @item -meb
19948 @opindex meb
19949 Generate big-endian code.
19951 @item -mel
19952 @opindex mel
19953 Generate little-endian code.
19955 @item -mio-volatile
19956 @opindex mio-volatile
19957 Tells the compiler that any variable marked with the @code{io}
19958 attribute is to be considered volatile.
19960 @item -ml
19961 @opindex ml
19962 Causes variables to be assigned to the @code{.far} section by default.
19964 @item -mleadz
19965 @opindex mleadz
19966 Enables the @code{leadz} (leading zero) instruction.
19968 @item -mm
19969 @opindex mm
19970 Causes variables to be assigned to the @code{.near} section by default.
19972 @item -mminmax
19973 @opindex mminmax
19974 Enables the @code{min} and @code{max} instructions.
19976 @item -mmult
19977 @opindex mmult
19978 Enables the multiplication and multiply-accumulate instructions.
19980 @item -mno-opts
19981 @opindex mno-opts
19982 Disables all the optional instructions enabled by @option{-mall-opts}.
19984 @item -mrepeat
19985 @opindex mrepeat
19986 Enables the @code{repeat} and @code{erepeat} instructions, used for
19987 low-overhead looping.
19989 @item -ms
19990 @opindex ms
19991 Causes all variables to default to the @code{.tiny} section.  Note
19992 that there is a 65536-byte limit to this section.  Accesses to these
19993 variables use the @code{%gp} base register.
19995 @item -msatur
19996 @opindex msatur
19997 Enables the saturation instructions.  Note that the compiler does not
19998 currently generate these itself, but this option is included for
19999 compatibility with other tools, like @code{as}.
20001 @item -msdram
20002 @opindex msdram
20003 Link the SDRAM-based runtime instead of the default ROM-based runtime.
20005 @item -msim
20006 @opindex msim
20007 Link the simulator run-time libraries.
20009 @item -msimnovec
20010 @opindex msimnovec
20011 Link the simulator runtime libraries, excluding built-in support
20012 for reset and exception vectors and tables.
20014 @item -mtf
20015 @opindex mtf
20016 Causes all functions to default to the @code{.far} section.  Without
20017 this option, functions default to the @code{.near} section.
20019 @item -mtiny=@var{n}
20020 @opindex mtiny=
20021 Variables that are @var{n} bytes or smaller are allocated to the
20022 @code{.tiny} section.  These variables use the @code{$gp} base
20023 register.  The default for this option is 4, but note that there's a
20024 65536-byte limit to the @code{.tiny} section.
20026 @end table
20028 @node MicroBlaze Options
20029 @subsection MicroBlaze Options
20030 @cindex MicroBlaze Options
20032 @table @gcctabopt
20034 @item -msoft-float
20035 @opindex msoft-float
20036 Use software emulation for floating point (default).
20038 @item -mhard-float
20039 @opindex mhard-float
20040 Use hardware floating-point instructions.
20042 @item -mmemcpy
20043 @opindex mmemcpy
20044 Do not optimize block moves, use @code{memcpy}.
20046 @item -mno-clearbss
20047 @opindex mno-clearbss
20048 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
20050 @item -mcpu=@var{cpu-type}
20051 @opindex mcpu=
20052 Use features of, and schedule code for, the given CPU.
20053 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
20054 where @var{X} is a major version, @var{YY} is the minor version, and
20055 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
20056 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
20058 @item -mxl-soft-mul
20059 @opindex mxl-soft-mul
20060 Use software multiply emulation (default).
20062 @item -mxl-soft-div
20063 @opindex mxl-soft-div
20064 Use software emulation for divides (default).
20066 @item -mxl-barrel-shift
20067 @opindex mxl-barrel-shift
20068 Use the hardware barrel shifter.
20070 @item -mxl-pattern-compare
20071 @opindex mxl-pattern-compare
20072 Use pattern compare instructions.
20074 @item -msmall-divides
20075 @opindex msmall-divides
20076 Use table lookup optimization for small signed integer divisions.
20078 @item -mxl-stack-check
20079 @opindex mxl-stack-check
20080 This option is deprecated.  Use @option{-fstack-check} instead.
20082 @item -mxl-gp-opt
20083 @opindex mxl-gp-opt
20084 Use GP-relative @code{.sdata}/@code{.sbss} sections.
20086 @item -mxl-multiply-high
20087 @opindex mxl-multiply-high
20088 Use multiply high instructions for high part of 32x32 multiply.
20090 @item -mxl-float-convert
20091 @opindex mxl-float-convert
20092 Use hardware floating-point conversion instructions.
20094 @item -mxl-float-sqrt
20095 @opindex mxl-float-sqrt
20096 Use hardware floating-point square root instruction.
20098 @item -mbig-endian
20099 @opindex mbig-endian
20100 Generate code for a big-endian target.
20102 @item -mlittle-endian
20103 @opindex mlittle-endian
20104 Generate code for a little-endian target.
20106 @item -mxl-reorder
20107 @opindex mxl-reorder
20108 Use reorder instructions (swap and byte reversed load/store).
20110 @item -mxl-mode-@var{app-model}
20111 Select application model @var{app-model}.  Valid models are
20112 @table @samp
20113 @item executable
20114 normal executable (default), uses startup code @file{crt0.o}.
20116 @item -mpic-data-is-text-relative
20117 @opindex mpic-data-is-text-relative
20118 Assume that the displacement between the text and data segments is fixed
20119 at static link time.  This allows data to be referenced by offset from start of
20120 text address instead of GOT since PC-relative addressing is not supported.
20122 @item xmdstub
20123 for use with Xilinx Microprocessor Debugger (XMD) based
20124 software intrusive debug agent called xmdstub. This uses startup file
20125 @file{crt1.o} and sets the start address of the program to 0x800.
20127 @item bootstrap
20128 for applications that are loaded using a bootloader.
20129 This model uses startup file @file{crt2.o} which does not contain a processor
20130 reset vector handler. This is suitable for transferring control on a
20131 processor reset to the bootloader rather than the application.
20133 @item novectors
20134 for applications that do not require any of the
20135 MicroBlaze vectors. This option may be useful for applications running
20136 within a monitoring application. This model uses @file{crt3.o} as a startup file.
20137 @end table
20139 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
20140 @option{-mxl-mode-@var{app-model}}.
20142 @end table
20144 @node MIPS Options
20145 @subsection MIPS Options
20146 @cindex MIPS options
20148 @table @gcctabopt
20150 @item -EB
20151 @opindex EB
20152 Generate big-endian code.
20154 @item -EL
20155 @opindex EL
20156 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
20157 configurations.
20159 @item -march=@var{arch}
20160 @opindex march
20161 Generate code that runs on @var{arch}, which can be the name of a
20162 generic MIPS ISA, or the name of a particular processor.
20163 The ISA names are:
20164 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
20165 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
20166 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
20167 @samp{mips64r5} and @samp{mips64r6}.
20168 The processor names are:
20169 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
20170 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
20171 @samp{5kc}, @samp{5kf},
20172 @samp{20kc},
20173 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
20174 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
20175 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
20176 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
20177 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
20178 @samp{i6400},
20179 @samp{interaptiv},
20180 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
20181 @samp{m4k},
20182 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
20183 @samp{m5100}, @samp{m5101},
20184 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
20185 @samp{orion},
20186 @samp{p5600},
20187 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
20188 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
20189 @samp{rm7000}, @samp{rm9000},
20190 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
20191 @samp{sb1},
20192 @samp{sr71000},
20193 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
20194 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
20195 @samp{xlr} and @samp{xlp}.
20196 The special value @samp{from-abi} selects the
20197 most compatible architecture for the selected ABI (that is,
20198 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
20200 The native Linux/GNU toolchain also supports the value @samp{native},
20201 which selects the best architecture option for the host processor.
20202 @option{-march=native} has no effect if GCC does not recognize
20203 the processor.
20205 In processor names, a final @samp{000} can be abbreviated as @samp{k}
20206 (for example, @option{-march=r2k}).  Prefixes are optional, and
20207 @samp{vr} may be written @samp{r}.
20209 Names of the form @samp{@var{n}f2_1} refer to processors with
20210 FPUs clocked at half the rate of the core, names of the form
20211 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
20212 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
20213 processors with FPUs clocked a ratio of 3:2 with respect to the core.
20214 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
20215 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
20216 accepted as synonyms for @samp{@var{n}f1_1}.
20218 GCC defines two macros based on the value of this option.  The first
20219 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
20220 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
20221 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
20222 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
20223 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
20225 Note that the @code{_MIPS_ARCH} macro uses the processor names given
20226 above.  In other words, it has the full prefix and does not
20227 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
20228 the macro names the resolved architecture (either @code{"mips1"} or
20229 @code{"mips3"}).  It names the default architecture when no
20230 @option{-march} option is given.
20232 @item -mtune=@var{arch}
20233 @opindex mtune
20234 Optimize for @var{arch}.  Among other things, this option controls
20235 the way instructions are scheduled, and the perceived cost of arithmetic
20236 operations.  The list of @var{arch} values is the same as for
20237 @option{-march}.
20239 When this option is not used, GCC optimizes for the processor
20240 specified by @option{-march}.  By using @option{-march} and
20241 @option{-mtune} together, it is possible to generate code that
20242 runs on a family of processors, but optimize the code for one
20243 particular member of that family.
20245 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
20246 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
20247 @option{-march} ones described above.
20249 @item -mips1
20250 @opindex mips1
20251 Equivalent to @option{-march=mips1}.
20253 @item -mips2
20254 @opindex mips2
20255 Equivalent to @option{-march=mips2}.
20257 @item -mips3
20258 @opindex mips3
20259 Equivalent to @option{-march=mips3}.
20261 @item -mips4
20262 @opindex mips4
20263 Equivalent to @option{-march=mips4}.
20265 @item -mips32
20266 @opindex mips32
20267 Equivalent to @option{-march=mips32}.
20269 @item -mips32r3
20270 @opindex mips32r3
20271 Equivalent to @option{-march=mips32r3}.
20273 @item -mips32r5
20274 @opindex mips32r5
20275 Equivalent to @option{-march=mips32r5}.
20277 @item -mips32r6
20278 @opindex mips32r6
20279 Equivalent to @option{-march=mips32r6}.
20281 @item -mips64
20282 @opindex mips64
20283 Equivalent to @option{-march=mips64}.
20285 @item -mips64r2
20286 @opindex mips64r2
20287 Equivalent to @option{-march=mips64r2}.
20289 @item -mips64r3
20290 @opindex mips64r3
20291 Equivalent to @option{-march=mips64r3}.
20293 @item -mips64r5
20294 @opindex mips64r5
20295 Equivalent to @option{-march=mips64r5}.
20297 @item -mips64r6
20298 @opindex mips64r6
20299 Equivalent to @option{-march=mips64r6}.
20301 @item -mips16
20302 @itemx -mno-mips16
20303 @opindex mips16
20304 @opindex mno-mips16
20305 Generate (do not generate) MIPS16 code.  If GCC is targeting a
20306 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
20308 MIPS16 code generation can also be controlled on a per-function basis
20309 by means of @code{mips16} and @code{nomips16} attributes.
20310 @xref{Function Attributes}, for more information.
20312 @item -mflip-mips16
20313 @opindex mflip-mips16
20314 Generate MIPS16 code on alternating functions.  This option is provided
20315 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20316 not intended for ordinary use in compiling user code.
20318 @item -minterlink-compressed
20319 @itemx -mno-interlink-compressed
20320 @opindex minterlink-compressed
20321 @opindex mno-interlink-compressed
20322 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20323 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20325 For example, code using the standard ISA encoding cannot jump directly
20326 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20327 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20328 knows that the target of the jump is not compressed.
20330 @item -minterlink-mips16
20331 @itemx -mno-interlink-mips16
20332 @opindex minterlink-mips16
20333 @opindex mno-interlink-mips16
20334 Aliases of @option{-minterlink-compressed} and
20335 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
20336 and are retained for backwards compatibility.
20338 @item -mabi=32
20339 @itemx -mabi=o64
20340 @itemx -mabi=n32
20341 @itemx -mabi=64
20342 @itemx -mabi=eabi
20343 @opindex mabi=32
20344 @opindex mabi=o64
20345 @opindex mabi=n32
20346 @opindex mabi=64
20347 @opindex mabi=eabi
20348 Generate code for the given ABI@.
20350 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
20351 generates 64-bit code when you select a 64-bit architecture, but you
20352 can use @option{-mgp32} to get 32-bit code instead.
20354 For information about the O64 ABI, see
20355 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20357 GCC supports a variant of the o32 ABI in which floating-point registers
20358 are 64 rather than 32 bits wide.  You can select this combination with
20359 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20360 and @code{mfhc1} instructions and is therefore only supported for
20361 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20363 The register assignments for arguments and return values remain the
20364 same, but each scalar value is passed in a single 64-bit register
20365 rather than a pair of 32-bit registers.  For example, scalar
20366 floating-point values are returned in @samp{$f0} only, not a
20367 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20368 remains the same in that the even-numbered double-precision registers
20369 are saved.
20371 Two additional variants of the o32 ABI are supported to enable
20372 a transition from 32-bit to 64-bit registers.  These are FPXX
20373 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20374 The FPXX extension mandates that all code must execute correctly
20375 when run using 32-bit or 64-bit registers.  The code can be interlinked
20376 with either FP32 or FP64, but not both.
20377 The FP64A extension is similar to the FP64 extension but forbids the
20378 use of odd-numbered single-precision registers.  This can be used
20379 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20380 processors and allows both FP32 and FP64A code to interlink and
20381 run in the same process without changing FPU modes.
20383 @item -mabicalls
20384 @itemx -mno-abicalls
20385 @opindex mabicalls
20386 @opindex mno-abicalls
20387 Generate (do not generate) code that is suitable for SVR4-style
20388 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20389 systems.
20391 @item -mshared
20392 @itemx -mno-shared
20393 Generate (do not generate) code that is fully position-independent,
20394 and that can therefore be linked into shared libraries.  This option
20395 only affects @option{-mabicalls}.
20397 All @option{-mabicalls} code has traditionally been position-independent,
20398 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20399 as an extension, the GNU toolchain allows executables to use absolute
20400 accesses for locally-binding symbols.  It can also use shorter GP
20401 initialization sequences and generate direct calls to locally-defined
20402 functions.  This mode is selected by @option{-mno-shared}.
20404 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20405 objects that can only be linked by the GNU linker.  However, the option
20406 does not affect the ABI of the final executable; it only affects the ABI
20407 of relocatable objects.  Using @option{-mno-shared} generally makes
20408 executables both smaller and quicker.
20410 @option{-mshared} is the default.
20412 @item -mplt
20413 @itemx -mno-plt
20414 @opindex mplt
20415 @opindex mno-plt
20416 Assume (do not assume) that the static and dynamic linkers
20417 support PLTs and copy relocations.  This option only affects
20418 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20419 has no effect without @option{-msym32}.
20421 You can make @option{-mplt} the default by configuring
20422 GCC with @option{--with-mips-plt}.  The default is
20423 @option{-mno-plt} otherwise.
20425 @item -mxgot
20426 @itemx -mno-xgot
20427 @opindex mxgot
20428 @opindex mno-xgot
20429 Lift (do not lift) the usual restrictions on the size of the global
20430 offset table.
20432 GCC normally uses a single instruction to load values from the GOT@.
20433 While this is relatively efficient, it only works if the GOT
20434 is smaller than about 64k.  Anything larger causes the linker
20435 to report an error such as:
20437 @cindex relocation truncated to fit (MIPS)
20438 @smallexample
20439 relocation truncated to fit: R_MIPS_GOT16 foobar
20440 @end smallexample
20442 If this happens, you should recompile your code with @option{-mxgot}.
20443 This works with very large GOTs, although the code is also
20444 less efficient, since it takes three instructions to fetch the
20445 value of a global symbol.
20447 Note that some linkers can create multiple GOTs.  If you have such a
20448 linker, you should only need to use @option{-mxgot} when a single object
20449 file accesses more than 64k's worth of GOT entries.  Very few do.
20451 These options have no effect unless GCC is generating position
20452 independent code.
20454 @item -mgp32
20455 @opindex mgp32
20456 Assume that general-purpose registers are 32 bits wide.
20458 @item -mgp64
20459 @opindex mgp64
20460 Assume that general-purpose registers are 64 bits wide.
20462 @item -mfp32
20463 @opindex mfp32
20464 Assume that floating-point registers are 32 bits wide.
20466 @item -mfp64
20467 @opindex mfp64
20468 Assume that floating-point registers are 64 bits wide.
20470 @item -mfpxx
20471 @opindex mfpxx
20472 Do not assume the width of floating-point registers.
20474 @item -mhard-float
20475 @opindex mhard-float
20476 Use floating-point coprocessor instructions.
20478 @item -msoft-float
20479 @opindex msoft-float
20480 Do not use floating-point coprocessor instructions.  Implement
20481 floating-point calculations using library calls instead.
20483 @item -mno-float
20484 @opindex mno-float
20485 Equivalent to @option{-msoft-float}, but additionally asserts that the
20486 program being compiled does not perform any floating-point operations.
20487 This option is presently supported only by some bare-metal MIPS
20488 configurations, where it may select a special set of libraries
20489 that lack all floating-point support (including, for example, the
20490 floating-point @code{printf} formats).  
20491 If code compiled with @option{-mno-float} accidentally contains
20492 floating-point operations, it is likely to suffer a link-time
20493 or run-time failure.
20495 @item -msingle-float
20496 @opindex msingle-float
20497 Assume that the floating-point coprocessor only supports single-precision
20498 operations.
20500 @item -mdouble-float
20501 @opindex mdouble-float
20502 Assume that the floating-point coprocessor supports double-precision
20503 operations.  This is the default.
20505 @item -modd-spreg
20506 @itemx -mno-odd-spreg
20507 @opindex modd-spreg
20508 @opindex mno-odd-spreg
20509 Enable the use of odd-numbered single-precision floating-point registers
20510 for the o32 ABI.  This is the default for processors that are known to
20511 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20512 is set by default.
20514 @item -mabs=2008
20515 @itemx -mabs=legacy
20516 @opindex mabs=2008
20517 @opindex mabs=legacy
20518 These options control the treatment of the special not-a-number (NaN)
20519 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20520 @code{neg.@i{fmt}} machine instructions.
20522 By default or when @option{-mabs=legacy} is used the legacy
20523 treatment is selected.  In this case these instructions are considered
20524 arithmetic and avoided where correct operation is required and the
20525 input operand might be a NaN.  A longer sequence of instructions that
20526 manipulate the sign bit of floating-point datum manually is used
20527 instead unless the @option{-ffinite-math-only} option has also been
20528 specified.
20530 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20531 this case these instructions are considered non-arithmetic and therefore
20532 operating correctly in all cases, including in particular where the
20533 input operand is a NaN.  These instructions are therefore always used
20534 for the respective operations.
20536 @item -mnan=2008
20537 @itemx -mnan=legacy
20538 @opindex mnan=2008
20539 @opindex mnan=legacy
20540 These options control the encoding of the special not-a-number (NaN)
20541 IEEE 754 floating-point data.
20543 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20544 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20545 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20546 by the first bit of their trailing significand field being 1.
20548 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20549 this case qNaNs are denoted by the first bit of their trailing
20550 significand field being 1, whereas sNaNs are denoted by the first bit of
20551 their trailing significand field being 0.
20553 The default is @option{-mnan=legacy} unless GCC has been configured with
20554 @option{--with-nan=2008}.
20556 @item -mllsc
20557 @itemx -mno-llsc
20558 @opindex mllsc
20559 @opindex mno-llsc
20560 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20561 implement atomic memory built-in functions.  When neither option is
20562 specified, GCC uses the instructions if the target architecture
20563 supports them.
20565 @option{-mllsc} is useful if the runtime environment can emulate the
20566 instructions and @option{-mno-llsc} can be useful when compiling for
20567 nonstandard ISAs.  You can make either option the default by
20568 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20569 respectively.  @option{--with-llsc} is the default for some
20570 configurations; see the installation documentation for details.
20572 @item -mdsp
20573 @itemx -mno-dsp
20574 @opindex mdsp
20575 @opindex mno-dsp
20576 Use (do not use) revision 1 of the MIPS DSP ASE@.
20577 @xref{MIPS DSP Built-in Functions}.  This option defines the
20578 preprocessor macro @code{__mips_dsp}.  It also defines
20579 @code{__mips_dsp_rev} to 1.
20581 @item -mdspr2
20582 @itemx -mno-dspr2
20583 @opindex mdspr2
20584 @opindex mno-dspr2
20585 Use (do not use) revision 2 of the MIPS DSP ASE@.
20586 @xref{MIPS DSP Built-in Functions}.  This option defines the
20587 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20588 It also defines @code{__mips_dsp_rev} to 2.
20590 @item -msmartmips
20591 @itemx -mno-smartmips
20592 @opindex msmartmips
20593 @opindex mno-smartmips
20594 Use (do not use) the MIPS SmartMIPS ASE.
20596 @item -mpaired-single
20597 @itemx -mno-paired-single
20598 @opindex mpaired-single
20599 @opindex mno-paired-single
20600 Use (do not use) paired-single floating-point instructions.
20601 @xref{MIPS Paired-Single Support}.  This option requires
20602 hardware floating-point support to be enabled.
20604 @item -mdmx
20605 @itemx -mno-mdmx
20606 @opindex mdmx
20607 @opindex mno-mdmx
20608 Use (do not use) MIPS Digital Media Extension instructions.
20609 This option can only be used when generating 64-bit code and requires
20610 hardware floating-point support to be enabled.
20612 @item -mips3d
20613 @itemx -mno-mips3d
20614 @opindex mips3d
20615 @opindex mno-mips3d
20616 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20617 The option @option{-mips3d} implies @option{-mpaired-single}.
20619 @item -mmicromips
20620 @itemx -mno-micromips
20621 @opindex mmicromips
20622 @opindex mno-mmicromips
20623 Generate (do not generate) microMIPS code.
20625 MicroMIPS code generation can also be controlled on a per-function basis
20626 by means of @code{micromips} and @code{nomicromips} attributes.
20627 @xref{Function Attributes}, for more information.
20629 @item -mmt
20630 @itemx -mno-mt
20631 @opindex mmt
20632 @opindex mno-mt
20633 Use (do not use) MT Multithreading instructions.
20635 @item -mmcu
20636 @itemx -mno-mcu
20637 @opindex mmcu
20638 @opindex mno-mcu
20639 Use (do not use) the MIPS MCU ASE instructions.
20641 @item -meva
20642 @itemx -mno-eva
20643 @opindex meva
20644 @opindex mno-eva
20645 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20647 @item -mvirt
20648 @itemx -mno-virt
20649 @opindex mvirt
20650 @opindex mno-virt
20651 Use (do not use) the MIPS Virtualization (VZ) instructions.
20653 @item -mxpa
20654 @itemx -mno-xpa
20655 @opindex mxpa
20656 @opindex mno-xpa
20657 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20659 @item -mlong64
20660 @opindex mlong64
20661 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20662 an explanation of the default and the way that the pointer size is
20663 determined.
20665 @item -mlong32
20666 @opindex mlong32
20667 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20669 The default size of @code{int}s, @code{long}s and pointers depends on
20670 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20671 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20672 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20673 or the same size as integer registers, whichever is smaller.
20675 @item -msym32
20676 @itemx -mno-sym32
20677 @opindex msym32
20678 @opindex mno-sym32
20679 Assume (do not assume) that all symbols have 32-bit values, regardless
20680 of the selected ABI@.  This option is useful in combination with
20681 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20682 to generate shorter and faster references to symbolic addresses.
20684 @item -G @var{num}
20685 @opindex G
20686 Put definitions of externally-visible data in a small data section
20687 if that data is no bigger than @var{num} bytes.  GCC can then generate
20688 more efficient accesses to the data; see @option{-mgpopt} for details.
20690 The default @option{-G} option depends on the configuration.
20692 @item -mlocal-sdata
20693 @itemx -mno-local-sdata
20694 @opindex mlocal-sdata
20695 @opindex mno-local-sdata
20696 Extend (do not extend) the @option{-G} behavior to local data too,
20697 such as to static variables in C@.  @option{-mlocal-sdata} is the
20698 default for all configurations.
20700 If the linker complains that an application is using too much small data,
20701 you might want to try rebuilding the less performance-critical parts with
20702 @option{-mno-local-sdata}.  You might also want to build large
20703 libraries with @option{-mno-local-sdata}, so that the libraries leave
20704 more room for the main program.
20706 @item -mextern-sdata
20707 @itemx -mno-extern-sdata
20708 @opindex mextern-sdata
20709 @opindex mno-extern-sdata
20710 Assume (do not assume) that externally-defined data is in
20711 a small data section if the size of that data is within the @option{-G} limit.
20712 @option{-mextern-sdata} is the default for all configurations.
20714 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20715 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20716 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20717 is placed in a small data section.  If @var{Var} is defined by another
20718 module, you must either compile that module with a high-enough
20719 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20720 definition.  If @var{Var} is common, you must link the application
20721 with a high-enough @option{-G} setting.
20723 The easiest way of satisfying these restrictions is to compile
20724 and link every module with the same @option{-G} option.  However,
20725 you may wish to build a library that supports several different
20726 small data limits.  You can do this by compiling the library with
20727 the highest supported @option{-G} setting and additionally using
20728 @option{-mno-extern-sdata} to stop the library from making assumptions
20729 about externally-defined data.
20731 @item -mgpopt
20732 @itemx -mno-gpopt
20733 @opindex mgpopt
20734 @opindex mno-gpopt
20735 Use (do not use) GP-relative accesses for symbols that are known to be
20736 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20737 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20738 configurations.
20740 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20741 might not hold the value of @code{_gp}.  For example, if the code is
20742 part of a library that might be used in a boot monitor, programs that
20743 call boot monitor routines pass an unknown value in @code{$gp}.
20744 (In such situations, the boot monitor itself is usually compiled
20745 with @option{-G0}.)
20747 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20748 @option{-mno-extern-sdata}.
20750 @item -membedded-data
20751 @itemx -mno-embedded-data
20752 @opindex membedded-data
20753 @opindex mno-embedded-data
20754 Allocate variables to the read-only data section first if possible, then
20755 next in the small data section if possible, otherwise in data.  This gives
20756 slightly slower code than the default, but reduces the amount of RAM required
20757 when executing, and thus may be preferred for some embedded systems.
20759 @item -muninit-const-in-rodata
20760 @itemx -mno-uninit-const-in-rodata
20761 @opindex muninit-const-in-rodata
20762 @opindex mno-uninit-const-in-rodata
20763 Put uninitialized @code{const} variables in the read-only data section.
20764 This option is only meaningful in conjunction with @option{-membedded-data}.
20766 @item -mcode-readable=@var{setting}
20767 @opindex mcode-readable
20768 Specify whether GCC may generate code that reads from executable sections.
20769 There are three possible settings:
20771 @table @gcctabopt
20772 @item -mcode-readable=yes
20773 Instructions may freely access executable sections.  This is the
20774 default setting.
20776 @item -mcode-readable=pcrel
20777 MIPS16 PC-relative load instructions can access executable sections,
20778 but other instructions must not do so.  This option is useful on 4KSc
20779 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20780 It is also useful on processors that can be configured to have a dual
20781 instruction/data SRAM interface and that, like the M4K, automatically
20782 redirect PC-relative loads to the instruction RAM.
20784 @item -mcode-readable=no
20785 Instructions must not access executable sections.  This option can be
20786 useful on targets that are configured to have a dual instruction/data
20787 SRAM interface but that (unlike the M4K) do not automatically redirect
20788 PC-relative loads to the instruction RAM.
20789 @end table
20791 @item -msplit-addresses
20792 @itemx -mno-split-addresses
20793 @opindex msplit-addresses
20794 @opindex mno-split-addresses
20795 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20796 relocation operators.  This option has been superseded by
20797 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20799 @item -mexplicit-relocs
20800 @itemx -mno-explicit-relocs
20801 @opindex mexplicit-relocs
20802 @opindex mno-explicit-relocs
20803 Use (do not use) assembler relocation operators when dealing with symbolic
20804 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20805 is to use assembler macros instead.
20807 @option{-mexplicit-relocs} is the default if GCC was configured
20808 to use an assembler that supports relocation operators.
20810 @item -mcheck-zero-division
20811 @itemx -mno-check-zero-division
20812 @opindex mcheck-zero-division
20813 @opindex mno-check-zero-division
20814 Trap (do not trap) on integer division by zero.
20816 The default is @option{-mcheck-zero-division}.
20818 @item -mdivide-traps
20819 @itemx -mdivide-breaks
20820 @opindex mdivide-traps
20821 @opindex mdivide-breaks
20822 MIPS systems check for division by zero by generating either a
20823 conditional trap or a break instruction.  Using traps results in
20824 smaller code, but is only supported on MIPS II and later.  Also, some
20825 versions of the Linux kernel have a bug that prevents trap from
20826 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20827 allow conditional traps on architectures that support them and
20828 @option{-mdivide-breaks} to force the use of breaks.
20830 The default is usually @option{-mdivide-traps}, but this can be
20831 overridden at configure time using @option{--with-divide=breaks}.
20832 Divide-by-zero checks can be completely disabled using
20833 @option{-mno-check-zero-division}.
20835 @item -mload-store-pairs
20836 @itemx -mno-load-store-pairs
20837 @opindex mload-store-pairs
20838 @opindex mno-load-store-pairs
20839 Enable (disable) an optimization that pairs consecutive load or store
20840 instructions to enable load/store bonding.  This option is enabled by
20841 default but only takes effect when the selected architecture is known
20842 to support bonding.
20844 @item -mmemcpy
20845 @itemx -mno-memcpy
20846 @opindex mmemcpy
20847 @opindex mno-memcpy
20848 Force (do not force) the use of @code{memcpy} for non-trivial block
20849 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20850 most constant-sized copies.
20852 @item -mlong-calls
20853 @itemx -mno-long-calls
20854 @opindex mlong-calls
20855 @opindex mno-long-calls
20856 Disable (do not disable) use of the @code{jal} instruction.  Calling
20857 functions using @code{jal} is more efficient but requires the caller
20858 and callee to be in the same 256 megabyte segment.
20860 This option has no effect on abicalls code.  The default is
20861 @option{-mno-long-calls}.
20863 @item -mmad
20864 @itemx -mno-mad
20865 @opindex mmad
20866 @opindex mno-mad
20867 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20868 instructions, as provided by the R4650 ISA@.
20870 @item -mimadd
20871 @itemx -mno-imadd
20872 @opindex mimadd
20873 @opindex mno-imadd
20874 Enable (disable) use of the @code{madd} and @code{msub} integer
20875 instructions.  The default is @option{-mimadd} on architectures
20876 that support @code{madd} and @code{msub} except for the 74k 
20877 architecture where it was found to generate slower code.
20879 @item -mfused-madd
20880 @itemx -mno-fused-madd
20881 @opindex mfused-madd
20882 @opindex mno-fused-madd
20883 Enable (disable) use of the floating-point multiply-accumulate
20884 instructions, when they are available.  The default is
20885 @option{-mfused-madd}.
20887 On the R8000 CPU when multiply-accumulate instructions are used,
20888 the intermediate product is calculated to infinite precision
20889 and is not subject to the FCSR Flush to Zero bit.  This may be
20890 undesirable in some circumstances.  On other processors the result
20891 is numerically identical to the equivalent computation using
20892 separate multiply, add, subtract and negate instructions.
20894 @item -nocpp
20895 @opindex nocpp
20896 Tell the MIPS assembler to not run its preprocessor over user
20897 assembler files (with a @samp{.s} suffix) when assembling them.
20899 @item -mfix-24k
20900 @itemx -mno-fix-24k
20901 @opindex mfix-24k
20902 @opindex mno-fix-24k
20903 Work around the 24K E48 (lost data on stores during refill) errata.
20904 The workarounds are implemented by the assembler rather than by GCC@.
20906 @item -mfix-r4000
20907 @itemx -mno-fix-r4000
20908 @opindex mfix-r4000
20909 @opindex mno-fix-r4000
20910 Work around certain R4000 CPU errata:
20911 @itemize @minus
20912 @item
20913 A double-word or a variable shift may give an incorrect result if executed
20914 immediately after starting an integer division.
20915 @item
20916 A double-word or a variable shift may give an incorrect result if executed
20917 while an integer multiplication is in progress.
20918 @item
20919 An integer division may give an incorrect result if started in a delay slot
20920 of a taken branch or a jump.
20921 @end itemize
20923 @item -mfix-r4400
20924 @itemx -mno-fix-r4400
20925 @opindex mfix-r4400
20926 @opindex mno-fix-r4400
20927 Work around certain R4400 CPU errata:
20928 @itemize @minus
20929 @item
20930 A double-word or a variable shift may give an incorrect result if executed
20931 immediately after starting an integer division.
20932 @end itemize
20934 @item -mfix-r10000
20935 @itemx -mno-fix-r10000
20936 @opindex mfix-r10000
20937 @opindex mno-fix-r10000
20938 Work around certain R10000 errata:
20939 @itemize @minus
20940 @item
20941 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20942 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20943 @end itemize
20945 This option can only be used if the target architecture supports
20946 branch-likely instructions.  @option{-mfix-r10000} is the default when
20947 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20948 otherwise.
20950 @item -mfix-rm7000
20951 @itemx -mno-fix-rm7000
20952 @opindex mfix-rm7000
20953 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20954 workarounds are implemented by the assembler rather than by GCC@.
20956 @item -mfix-vr4120
20957 @itemx -mno-fix-vr4120
20958 @opindex mfix-vr4120
20959 Work around certain VR4120 errata:
20960 @itemize @minus
20961 @item
20962 @code{dmultu} does not always produce the correct result.
20963 @item
20964 @code{div} and @code{ddiv} do not always produce the correct result if one
20965 of the operands is negative.
20966 @end itemize
20967 The workarounds for the division errata rely on special functions in
20968 @file{libgcc.a}.  At present, these functions are only provided by
20969 the @code{mips64vr*-elf} configurations.
20971 Other VR4120 errata require a NOP to be inserted between certain pairs of
20972 instructions.  These errata are handled by the assembler, not by GCC itself.
20974 @item -mfix-vr4130
20975 @opindex mfix-vr4130
20976 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20977 workarounds are implemented by the assembler rather than by GCC,
20978 although GCC avoids using @code{mflo} and @code{mfhi} if the
20979 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20980 instructions are available instead.
20982 @item -mfix-sb1
20983 @itemx -mno-fix-sb1
20984 @opindex mfix-sb1
20985 Work around certain SB-1 CPU core errata.
20986 (This flag currently works around the SB-1 revision 2
20987 ``F1'' and ``F2'' floating-point errata.)
20989 @item -mr10k-cache-barrier=@var{setting}
20990 @opindex mr10k-cache-barrier
20991 Specify whether GCC should insert cache barriers to avoid the
20992 side effects of speculation on R10K processors.
20994 In common with many processors, the R10K tries to predict the outcome
20995 of a conditional branch and speculatively executes instructions from
20996 the ``taken'' branch.  It later aborts these instructions if the
20997 predicted outcome is wrong.  However, on the R10K, even aborted
20998 instructions can have side effects.
21000 This problem only affects kernel stores and, depending on the system,
21001 kernel loads.  As an example, a speculatively-executed store may load
21002 the target memory into cache and mark the cache line as dirty, even if
21003 the store itself is later aborted.  If a DMA operation writes to the
21004 same area of memory before the ``dirty'' line is flushed, the cached
21005 data overwrites the DMA-ed data.  See the R10K processor manual
21006 for a full description, including other potential problems.
21008 One workaround is to insert cache barrier instructions before every memory
21009 access that might be speculatively executed and that might have side
21010 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
21011 controls GCC's implementation of this workaround.  It assumes that
21012 aborted accesses to any byte in the following regions does not have
21013 side effects:
21015 @enumerate
21016 @item
21017 the memory occupied by the current function's stack frame;
21019 @item
21020 the memory occupied by an incoming stack argument;
21022 @item
21023 the memory occupied by an object with a link-time-constant address.
21024 @end enumerate
21026 It is the kernel's responsibility to ensure that speculative
21027 accesses to these regions are indeed safe.
21029 If the input program contains a function declaration such as:
21031 @smallexample
21032 void foo (void);
21033 @end smallexample
21035 then the implementation of @code{foo} must allow @code{j foo} and
21036 @code{jal foo} to be executed speculatively.  GCC honors this
21037 restriction for functions it compiles itself.  It expects non-GCC
21038 functions (such as hand-written assembly code) to do the same.
21040 The option has three forms:
21042 @table @gcctabopt
21043 @item -mr10k-cache-barrier=load-store
21044 Insert a cache barrier before a load or store that might be
21045 speculatively executed and that might have side effects even
21046 if aborted.
21048 @item -mr10k-cache-barrier=store
21049 Insert a cache barrier before a store that might be speculatively
21050 executed and that might have side effects even if aborted.
21052 @item -mr10k-cache-barrier=none
21053 Disable the insertion of cache barriers.  This is the default setting.
21054 @end table
21056 @item -mflush-func=@var{func}
21057 @itemx -mno-flush-func
21058 @opindex mflush-func
21059 Specifies the function to call to flush the I and D caches, or to not
21060 call any such function.  If called, the function must take the same
21061 arguments as the common @code{_flush_func}, that is, the address of the
21062 memory range for which the cache is being flushed, the size of the
21063 memory range, and the number 3 (to flush both caches).  The default
21064 depends on the target GCC was configured for, but commonly is either
21065 @code{_flush_func} or @code{__cpu_flush}.
21067 @item mbranch-cost=@var{num}
21068 @opindex mbranch-cost
21069 Set the cost of branches to roughly @var{num} ``simple'' instructions.
21070 This cost is only a heuristic and is not guaranteed to produce
21071 consistent results across releases.  A zero cost redundantly selects
21072 the default, which is based on the @option{-mtune} setting.
21074 @item -mbranch-likely
21075 @itemx -mno-branch-likely
21076 @opindex mbranch-likely
21077 @opindex mno-branch-likely
21078 Enable or disable use of Branch Likely instructions, regardless of the
21079 default for the selected architecture.  By default, Branch Likely
21080 instructions may be generated if they are supported by the selected
21081 architecture.  An exception is for the MIPS32 and MIPS64 architectures
21082 and processors that implement those architectures; for those, Branch
21083 Likely instructions are not be generated by default because the MIPS32
21084 and MIPS64 architectures specifically deprecate their use.
21086 @item -mcompact-branches=never
21087 @itemx -mcompact-branches=optimal
21088 @itemx -mcompact-branches=always
21089 @opindex mcompact-branches=never
21090 @opindex mcompact-branches=optimal
21091 @opindex mcompact-branches=always
21092 These options control which form of branches will be generated.  The
21093 default is @option{-mcompact-branches=optimal}.
21095 The @option{-mcompact-branches=never} option ensures that compact branch
21096 instructions will never be generated.
21098 The @option{-mcompact-branches=always} option ensures that a compact
21099 branch instruction will be generated if available.  If a compact branch
21100 instruction is not available, a delay slot form of the branch will be
21101 used instead.
21103 This option is supported from MIPS Release 6 onwards.
21105 The @option{-mcompact-branches=optimal} option will cause a delay slot
21106 branch to be used if one is available in the current ISA and the delay
21107 slot is successfully filled.  If the delay slot is not filled, a compact
21108 branch will be chosen if one is available.
21110 @item -mfp-exceptions
21111 @itemx -mno-fp-exceptions
21112 @opindex mfp-exceptions
21113 Specifies whether FP exceptions are enabled.  This affects how
21114 FP instructions are scheduled for some processors.
21115 The default is that FP exceptions are
21116 enabled.
21118 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
21119 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
21120 FP pipe.
21122 @item -mvr4130-align
21123 @itemx -mno-vr4130-align
21124 @opindex mvr4130-align
21125 The VR4130 pipeline is two-way superscalar, but can only issue two
21126 instructions together if the first one is 8-byte aligned.  When this
21127 option is enabled, GCC aligns pairs of instructions that it
21128 thinks should execute in parallel.
21130 This option only has an effect when optimizing for the VR4130.
21131 It normally makes code faster, but at the expense of making it bigger.
21132 It is enabled by default at optimization level @option{-O3}.
21134 @item -msynci
21135 @itemx -mno-synci
21136 @opindex msynci
21137 Enable (disable) generation of @code{synci} instructions on
21138 architectures that support it.  The @code{synci} instructions (if
21139 enabled) are generated when @code{__builtin___clear_cache} is
21140 compiled.
21142 This option defaults to @option{-mno-synci}, but the default can be
21143 overridden by configuring GCC with @option{--with-synci}.
21145 When compiling code for single processor systems, it is generally safe
21146 to use @code{synci}.  However, on many multi-core (SMP) systems, it
21147 does not invalidate the instruction caches on all cores and may lead
21148 to undefined behavior.
21150 @item -mrelax-pic-calls
21151 @itemx -mno-relax-pic-calls
21152 @opindex mrelax-pic-calls
21153 Try to turn PIC calls that are normally dispatched via register
21154 @code{$25} into direct calls.  This is only possible if the linker can
21155 resolve the destination at link time and if the destination is within
21156 range for a direct call.
21158 @option{-mrelax-pic-calls} is the default if GCC was configured to use
21159 an assembler and a linker that support the @code{.reloc} assembly
21160 directive and @option{-mexplicit-relocs} is in effect.  With
21161 @option{-mno-explicit-relocs}, this optimization can be performed by the
21162 assembler and the linker alone without help from the compiler.
21164 @item -mmcount-ra-address
21165 @itemx -mno-mcount-ra-address
21166 @opindex mmcount-ra-address
21167 @opindex mno-mcount-ra-address
21168 Emit (do not emit) code that allows @code{_mcount} to modify the
21169 calling function's return address.  When enabled, this option extends
21170 the usual @code{_mcount} interface with a new @var{ra-address}
21171 parameter, which has type @code{intptr_t *} and is passed in register
21172 @code{$12}.  @code{_mcount} can then modify the return address by
21173 doing both of the following:
21174 @itemize
21175 @item
21176 Returning the new address in register @code{$31}.
21177 @item
21178 Storing the new address in @code{*@var{ra-address}},
21179 if @var{ra-address} is nonnull.
21180 @end itemize
21182 The default is @option{-mno-mcount-ra-address}.
21184 @item -mframe-header-opt
21185 @itemx -mno-frame-header-opt
21186 @opindex mframe-header-opt
21187 Enable (disable) frame header optimization in the o32 ABI.  When using the
21188 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
21189 function to write out register arguments.  When enabled, this optimization
21190 will suppress the allocation of the frame header if it can be determined that
21191 it is unused.
21193 This optimization is off by default at all optimization levels.
21195 @item -mlxc1-sxc1
21196 @itemx -mno-lxc1-sxc1
21197 @opindex mlxc1-sxc1
21198 When applicable, enable (disable) the generation of @code{lwxc1},
21199 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
21201 @item -mmadd4
21202 @itemx -mno-madd4
21203 @opindex mmadd4
21204 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
21205 @code{madd.d} and related instructions.  Enabled by default.
21207 @end table
21209 @node MMIX Options
21210 @subsection MMIX Options
21211 @cindex MMIX Options
21213 These options are defined for the MMIX:
21215 @table @gcctabopt
21216 @item -mlibfuncs
21217 @itemx -mno-libfuncs
21218 @opindex mlibfuncs
21219 @opindex mno-libfuncs
21220 Specify that intrinsic library functions are being compiled, passing all
21221 values in registers, no matter the size.
21223 @item -mepsilon
21224 @itemx -mno-epsilon
21225 @opindex mepsilon
21226 @opindex mno-epsilon
21227 Generate floating-point comparison instructions that compare with respect
21228 to the @code{rE} epsilon register.
21230 @item -mabi=mmixware
21231 @itemx -mabi=gnu
21232 @opindex mabi=mmixware
21233 @opindex mabi=gnu
21234 Generate code that passes function parameters and return values that (in
21235 the called function) are seen as registers @code{$0} and up, as opposed to
21236 the GNU ABI which uses global registers @code{$231} and up.
21238 @item -mzero-extend
21239 @itemx -mno-zero-extend
21240 @opindex mzero-extend
21241 @opindex mno-zero-extend
21242 When reading data from memory in sizes shorter than 64 bits, use (do not
21243 use) zero-extending load instructions by default, rather than
21244 sign-extending ones.
21246 @item -mknuthdiv
21247 @itemx -mno-knuthdiv
21248 @opindex mknuthdiv
21249 @opindex mno-knuthdiv
21250 Make the result of a division yielding a remainder have the same sign as
21251 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
21252 remainder follows the sign of the dividend.  Both methods are
21253 arithmetically valid, the latter being almost exclusively used.
21255 @item -mtoplevel-symbols
21256 @itemx -mno-toplevel-symbols
21257 @opindex mtoplevel-symbols
21258 @opindex mno-toplevel-symbols
21259 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
21260 code can be used with the @code{PREFIX} assembly directive.
21262 @item -melf
21263 @opindex melf
21264 Generate an executable in the ELF format, rather than the default
21265 @samp{mmo} format used by the @command{mmix} simulator.
21267 @item -mbranch-predict
21268 @itemx -mno-branch-predict
21269 @opindex mbranch-predict
21270 @opindex mno-branch-predict
21271 Use (do not use) the probable-branch instructions, when static branch
21272 prediction indicates a probable branch.
21274 @item -mbase-addresses
21275 @itemx -mno-base-addresses
21276 @opindex mbase-addresses
21277 @opindex mno-base-addresses
21278 Generate (do not generate) code that uses @emph{base addresses}.  Using a
21279 base address automatically generates a request (handled by the assembler
21280 and the linker) for a constant to be set up in a global register.  The
21281 register is used for one or more base address requests within the range 0
21282 to 255 from the value held in the register.  The generally leads to short
21283 and fast code, but the number of different data items that can be
21284 addressed is limited.  This means that a program that uses lots of static
21285 data may require @option{-mno-base-addresses}.
21287 @item -msingle-exit
21288 @itemx -mno-single-exit
21289 @opindex msingle-exit
21290 @opindex mno-single-exit
21291 Force (do not force) generated code to have a single exit point in each
21292 function.
21293 @end table
21295 @node MN10300 Options
21296 @subsection MN10300 Options
21297 @cindex MN10300 options
21299 These @option{-m} options are defined for Matsushita MN10300 architectures:
21301 @table @gcctabopt
21302 @item -mmult-bug
21303 @opindex mmult-bug
21304 Generate code to avoid bugs in the multiply instructions for the MN10300
21305 processors.  This is the default.
21307 @item -mno-mult-bug
21308 @opindex mno-mult-bug
21309 Do not generate code to avoid bugs in the multiply instructions for the
21310 MN10300 processors.
21312 @item -mam33
21313 @opindex mam33
21314 Generate code using features specific to the AM33 processor.
21316 @item -mno-am33
21317 @opindex mno-am33
21318 Do not generate code using features specific to the AM33 processor.  This
21319 is the default.
21321 @item -mam33-2
21322 @opindex mam33-2
21323 Generate code using features specific to the AM33/2.0 processor.
21325 @item -mam34
21326 @opindex mam34
21327 Generate code using features specific to the AM34 processor.
21329 @item -mtune=@var{cpu-type}
21330 @opindex mtune
21331 Use the timing characteristics of the indicated CPU type when
21332 scheduling instructions.  This does not change the targeted processor
21333 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
21334 @samp{am33-2} or @samp{am34}.
21336 @item -mreturn-pointer-on-d0
21337 @opindex mreturn-pointer-on-d0
21338 When generating a function that returns a pointer, return the pointer
21339 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
21340 only in @code{a0}, and attempts to call such functions without a prototype
21341 result in errors.  Note that this option is on by default; use
21342 @option{-mno-return-pointer-on-d0} to disable it.
21344 @item -mno-crt0
21345 @opindex mno-crt0
21346 Do not link in the C run-time initialization object file.
21348 @item -mrelax
21349 @opindex mrelax
21350 Indicate to the linker that it should perform a relaxation optimization pass
21351 to shorten branches, calls and absolute memory addresses.  This option only
21352 has an effect when used on the command line for the final link step.
21354 This option makes symbolic debugging impossible.
21356 @item -mliw
21357 @opindex mliw
21358 Allow the compiler to generate @emph{Long Instruction Word}
21359 instructions if the target is the @samp{AM33} or later.  This is the
21360 default.  This option defines the preprocessor macro @code{__LIW__}.
21362 @item -mnoliw
21363 @opindex mnoliw
21364 Do not allow the compiler to generate @emph{Long Instruction Word}
21365 instructions.  This option defines the preprocessor macro
21366 @code{__NO_LIW__}.
21368 @item -msetlb
21369 @opindex msetlb
21370 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21371 instructions if the target is the @samp{AM33} or later.  This is the
21372 default.  This option defines the preprocessor macro @code{__SETLB__}.
21374 @item -mnosetlb
21375 @opindex mnosetlb
21376 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21377 instructions.  This option defines the preprocessor macro
21378 @code{__NO_SETLB__}.
21380 @end table
21382 @node Moxie Options
21383 @subsection Moxie Options
21384 @cindex Moxie Options
21386 @table @gcctabopt
21388 @item -meb
21389 @opindex meb
21390 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21391 configurations.
21393 @item -mel
21394 @opindex mel
21395 Generate little-endian code.
21397 @item -mmul.x
21398 @opindex mmul.x
21399 Generate mul.x and umul.x instructions.  This is the default for
21400 @samp{moxiebox-*-*} configurations.
21402 @item -mno-crt0
21403 @opindex mno-crt0
21404 Do not link in the C run-time initialization object file.
21406 @end table
21408 @node MSP430 Options
21409 @subsection MSP430 Options
21410 @cindex MSP430 Options
21412 These options are defined for the MSP430:
21414 @table @gcctabopt
21416 @item -masm-hex
21417 @opindex masm-hex
21418 Force assembly output to always use hex constants.  Normally such
21419 constants are signed decimals, but this option is available for
21420 testsuite and/or aesthetic purposes.
21422 @item -mmcu=
21423 @opindex mmcu=
21424 Select the MCU to target.  This is used to create a C preprocessor
21425 symbol based upon the MCU name, converted to upper case and pre- and
21426 post-fixed with @samp{__}.  This in turn is used by the
21427 @file{msp430.h} header file to select an MCU-specific supplementary
21428 header file.
21430 The option also sets the ISA to use.  If the MCU name is one that is
21431 known to only support the 430 ISA then that is selected, otherwise the
21432 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21433 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21434 name selects the 430X ISA.
21436 In addition an MCU-specific linker script is added to the linker
21437 command line.  The script's name is the name of the MCU with
21438 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21439 command line defines the C preprocessor symbol @code{__XXX__} and
21440 cause the linker to search for a script called @file{xxx.ld}.
21442 This option is also passed on to the assembler.
21444 @item -mwarn-mcu
21445 @itemx -mno-warn-mcu
21446 @opindex mwarn-mcu
21447 @opindex mno-warn-mcu
21448 This option enables or disables warnings about conflicts between the
21449 MCU name specified by the @option{-mmcu} option and the ISA set by the
21450 @option{-mcpu} option and/or the hardware multiply support set by the
21451 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21452 MCU names.  This option is on by default.
21454 @item -mcpu=
21455 @opindex mcpu=
21456 Specifies the ISA to use.  Accepted values are @samp{msp430},
21457 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21458 @option{-mmcu=} option should be used to select the ISA.
21460 @item -msim
21461 @opindex msim
21462 Link to the simulator runtime libraries and linker script.  Overrides
21463 any scripts that would be selected by the @option{-mmcu=} option.
21465 @item -mlarge
21466 @opindex mlarge
21467 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21469 @item -msmall
21470 @opindex msmall
21471 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21473 @item -mrelax
21474 @opindex mrelax
21475 This option is passed to the assembler and linker, and allows the
21476 linker to perform certain optimizations that cannot be done until
21477 the final link.
21479 @item mhwmult=
21480 @opindex mhwmult=
21481 Describes the type of hardware multiply supported by the target.
21482 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21483 for the original 16-bit-only multiply supported by early MCUs.
21484 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21485 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21486 A value of @samp{auto} can also be given.  This tells GCC to deduce
21487 the hardware multiply support based upon the MCU name provided by the
21488 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21489 the MCU name is not recognized then no hardware multiply support is
21490 assumed.  @code{auto} is the default setting.
21492 Hardware multiplies are normally performed by calling a library
21493 routine.  This saves space in the generated code.  When compiling at
21494 @option{-O3} or higher however the hardware multiplier is invoked
21495 inline.  This makes for bigger, but faster code.
21497 The hardware multiply routines disable interrupts whilst running and
21498 restore the previous interrupt state when they finish.  This makes
21499 them safe to use inside interrupt handlers as well as in normal code.
21501 @item -minrt
21502 @opindex minrt
21503 Enable the use of a minimum runtime environment - no static
21504 initializers or constructors.  This is intended for memory-constrained
21505 devices.  The compiler includes special symbols in some objects
21506 that tell the linker and runtime which code fragments are required.
21508 @item -mcode-region=
21509 @itemx -mdata-region=
21510 @opindex mcode-region
21511 @opindex mdata-region
21512 These options tell the compiler where to place functions and data that
21513 do not have one of the @code{lower}, @code{upper}, @code{either} or
21514 @code{section} attributes.  Possible values are @code{lower},
21515 @code{upper}, @code{either} or @code{any}.  The first three behave
21516 like the corresponding attribute.  The fourth possible value -
21517 @code{any} - is the default.  It leaves placement entirely up to the
21518 linker script and how it assigns the standard sections
21519 (@code{.text}, @code{.data}, etc) to the memory regions.
21521 @item -msilicon-errata=
21522 @opindex msilicon-errata
21523 This option passes on a request to assembler to enable the fixes for
21524 the named silicon errata.
21526 @item -msilicon-errata-warn=
21527 @opindex msilicon-errata-warn
21528 This option passes on a request to the assembler to enable warning
21529 messages when a silicon errata might need to be applied.
21531 @end table
21533 @node NDS32 Options
21534 @subsection NDS32 Options
21535 @cindex NDS32 Options
21537 These options are defined for NDS32 implementations:
21539 @table @gcctabopt
21541 @item -mbig-endian
21542 @opindex mbig-endian
21543 Generate code in big-endian mode.
21545 @item -mlittle-endian
21546 @opindex mlittle-endian
21547 Generate code in little-endian mode.
21549 @item -mreduced-regs
21550 @opindex mreduced-regs
21551 Use reduced-set registers for register allocation.
21553 @item -mfull-regs
21554 @opindex mfull-regs
21555 Use full-set registers for register allocation.
21557 @item -mcmov
21558 @opindex mcmov
21559 Generate conditional move instructions.
21561 @item -mno-cmov
21562 @opindex mno-cmov
21563 Do not generate conditional move instructions.
21565 @item -mext-perf
21566 @opindex mperf-ext
21567 Generate performance extension instructions.
21569 @item -mno-ext-perf
21570 @opindex mno-perf-ext
21571 Do not generate performance extension instructions.
21573 @item -mext-perf2
21574 @opindex mperf-ext
21575 Generate performance extension 2 instructions.
21577 @item -mno-ext-perf2
21578 @opindex mno-perf-ext
21579 Do not generate performance extension 2 instructions.
21581 @item -mext-string
21582 @opindex mperf-ext
21583 Generate string extension instructions.
21585 @item -mno-ext-string
21586 @opindex mno-perf-ext
21587 Do not generate string extension instructions.
21589 @item -mv3push
21590 @opindex mv3push
21591 Generate v3 push25/pop25 instructions.
21593 @item -mno-v3push
21594 @opindex mno-v3push
21595 Do not generate v3 push25/pop25 instructions.
21597 @item -m16-bit
21598 @opindex m16-bit
21599 Generate 16-bit instructions.
21601 @item -mno-16-bit
21602 @opindex mno-16-bit
21603 Do not generate 16-bit instructions.
21605 @item -misr-vector-size=@var{num}
21606 @opindex misr-vector-size
21607 Specify the size of each interrupt vector, which must be 4 or 16.
21609 @item -mcache-block-size=@var{num}
21610 @opindex mcache-block-size
21611 Specify the size of each cache block,
21612 which must be a power of 2 between 4 and 512.
21614 @item -march=@var{arch}
21615 @opindex march
21616 Specify the name of the target architecture.
21618 @item -mcmodel=@var{code-model}
21619 @opindex mcmodel
21620 Set the code model to one of
21621 @table @asis
21622 @item @samp{small}
21623 All the data and read-only data segments must be within 512KB addressing space.
21624 The text segment must be within 16MB addressing space.
21625 @item @samp{medium}
21626 The data segment must be within 512KB while the read-only data segment can be
21627 within 4GB addressing space.  The text segment should be still within 16MB
21628 addressing space.
21629 @item @samp{large}
21630 All the text and data segments can be within 4GB addressing space.
21631 @end table
21633 @item -mctor-dtor
21634 @opindex mctor-dtor
21635 Enable constructor/destructor feature.
21637 @item -mrelax
21638 @opindex mrelax
21639 Guide linker to relax instructions.
21641 @end table
21643 @node Nios II Options
21644 @subsection Nios II Options
21645 @cindex Nios II options
21646 @cindex Altera Nios II options
21648 These are the options defined for the Altera Nios II processor.
21650 @table @gcctabopt
21652 @item -G @var{num}
21653 @opindex G
21654 @cindex smaller data references
21655 Put global and static objects less than or equal to @var{num} bytes
21656 into the small data or BSS sections instead of the normal data or BSS
21657 sections.  The default value of @var{num} is 8.
21659 @item -mgpopt=@var{option}
21660 @itemx -mgpopt
21661 @itemx -mno-gpopt
21662 @opindex mgpopt
21663 @opindex mno-gpopt
21664 Generate (do not generate) GP-relative accesses.  The following 
21665 @var{option} names are recognized:
21667 @table @samp
21669 @item none
21670 Do not generate GP-relative accesses.
21672 @item local
21673 Generate GP-relative accesses for small data objects that are not 
21674 external, weak, or uninitialized common symbols.  
21675 Also use GP-relative addressing for objects that
21676 have been explicitly placed in a small data section via a @code{section}
21677 attribute.
21679 @item global
21680 As for @samp{local}, but also generate GP-relative accesses for
21681 small data objects that are external, weak, or common.  If you use this option,
21682 you must ensure that all parts of your program (including libraries) are
21683 compiled with the same @option{-G} setting.
21685 @item data
21686 Generate GP-relative accesses for all data objects in the program.  If you
21687 use this option, the entire data and BSS segments
21688 of your program must fit in 64K of memory and you must use an appropriate
21689 linker script to allocate them within the addressable range of the
21690 global pointer.
21692 @item all
21693 Generate GP-relative addresses for function pointers as well as data
21694 pointers.  If you use this option, the entire text, data, and BSS segments
21695 of your program must fit in 64K of memory and you must use an appropriate
21696 linker script to allocate them within the addressable range of the
21697 global pointer.
21699 @end table
21701 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21702 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21704 The default is @option{-mgpopt} except when @option{-fpic} or
21705 @option{-fPIC} is specified to generate position-independent code.
21706 Note that the Nios II ABI does not permit GP-relative accesses from
21707 shared libraries.
21709 You may need to specify @option{-mno-gpopt} explicitly when building
21710 programs that include large amounts of small data, including large
21711 GOT data sections.  In this case, the 16-bit offset for GP-relative
21712 addressing may not be large enough to allow access to the entire 
21713 small data section.
21715 @item -mgprel-sec=@var{regexp}
21716 @opindex mgprel-sec
21717 This option specifies additional section names that can be accessed via
21718 GP-relative addressing.  It is most useful in conjunction with 
21719 @code{section} attributes on variable declarations 
21720 (@pxref{Common Variable Attributes}) and a custom linker script.  
21721 The @var{regexp} is a POSIX Extended Regular Expression.
21723 This option does not affect the behavior of the @option{-G} option, and 
21724 and the specified sections are in addition to the standard @code{.sdata} 
21725 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21727 @item -mr0rel-sec=@var{regexp}
21728 @opindex mr0rel-sec
21729 This option specifies names of sections that can be accessed via a 
21730 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21731 of the 32-bit address space.  It is most useful in conjunction with 
21732 @code{section} attributes on variable declarations 
21733 (@pxref{Common Variable Attributes}) and a custom linker script.  
21734 The @var{regexp} is a POSIX Extended Regular Expression.
21736 In contrast to the use of GP-relative addressing for small data, 
21737 zero-based addressing is never generated by default and there are no 
21738 conventional section names used in standard linker scripts for sections
21739 in the low or high areas of memory.
21741 @item -mel
21742 @itemx -meb
21743 @opindex mel
21744 @opindex meb
21745 Generate little-endian (default) or big-endian (experimental) code,
21746 respectively.
21748 @item -march=@var{arch}
21749 @opindex march
21750 This specifies the name of the target Nios II architecture.  GCC uses this
21751 name to determine what kind of instructions it can emit when generating
21752 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21754 The preprocessor macro @code{__nios2_arch__} is available to programs,
21755 with value 1 or 2, indicating the targeted ISA level.
21757 @item -mbypass-cache
21758 @itemx -mno-bypass-cache
21759 @opindex mno-bypass-cache
21760 @opindex mbypass-cache
21761 Force all load and store instructions to always bypass cache by 
21762 using I/O variants of the instructions. The default is not to
21763 bypass the cache.
21765 @item -mno-cache-volatile 
21766 @itemx -mcache-volatile       
21767 @opindex mcache-volatile 
21768 @opindex mno-cache-volatile
21769 Volatile memory access bypass the cache using the I/O variants of 
21770 the load and store instructions. The default is not to bypass the cache.
21772 @item -mno-fast-sw-div
21773 @itemx -mfast-sw-div
21774 @opindex mno-fast-sw-div
21775 @opindex mfast-sw-div
21776 Do not use table-based fast divide for small numbers. The default 
21777 is to use the fast divide at @option{-O3} and above.
21779 @item -mno-hw-mul
21780 @itemx -mhw-mul
21781 @itemx -mno-hw-mulx
21782 @itemx -mhw-mulx
21783 @itemx -mno-hw-div
21784 @itemx -mhw-div
21785 @opindex mno-hw-mul
21786 @opindex mhw-mul
21787 @opindex mno-hw-mulx
21788 @opindex mhw-mulx
21789 @opindex mno-hw-div
21790 @opindex mhw-div
21791 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21792 instructions by the compiler. The default is to emit @code{mul}
21793 and not emit @code{div} and @code{mulx}.
21795 @item -mbmx
21796 @itemx -mno-bmx
21797 @itemx -mcdx
21798 @itemx -mno-cdx
21799 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21800 CDX (code density) instructions.  Enabling these instructions also
21801 requires @option{-march=r2}.  Since these instructions are optional
21802 extensions to the R2 architecture, the default is not to emit them.
21804 @item -mcustom-@var{insn}=@var{N}
21805 @itemx -mno-custom-@var{insn}
21806 @opindex mcustom-@var{insn}
21807 @opindex mno-custom-@var{insn}
21808 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21809 custom instruction with encoding @var{N} when generating code that uses 
21810 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21811 instruction 253 for single-precision floating-point add operations instead
21812 of the default behavior of using a library call.
21814 The following values of @var{insn} are supported.  Except as otherwise
21815 noted, floating-point operations are expected to be implemented with
21816 normal IEEE 754 semantics and correspond directly to the C operators or the
21817 equivalent GCC built-in functions (@pxref{Other Builtins}).
21819 Single-precision floating point:
21820 @table @asis
21822 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21823 Binary arithmetic operations.
21825 @item @samp{fnegs}
21826 Unary negation.
21828 @item @samp{fabss}
21829 Unary absolute value.
21831 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21832 Comparison operations.
21834 @item @samp{fmins}, @samp{fmaxs}
21835 Floating-point minimum and maximum.  These instructions are only
21836 generated if @option{-ffinite-math-only} is specified.
21838 @item @samp{fsqrts}
21839 Unary square root operation.
21841 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21842 Floating-point trigonometric and exponential functions.  These instructions
21843 are only generated if @option{-funsafe-math-optimizations} is also specified.
21845 @end table
21847 Double-precision floating point:
21848 @table @asis
21850 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21851 Binary arithmetic operations.
21853 @item @samp{fnegd}
21854 Unary negation.
21856 @item @samp{fabsd}
21857 Unary absolute value.
21859 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21860 Comparison operations.
21862 @item @samp{fmind}, @samp{fmaxd}
21863 Double-precision minimum and maximum.  These instructions are only
21864 generated if @option{-ffinite-math-only} is specified.
21866 @item @samp{fsqrtd}
21867 Unary square root operation.
21869 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21870 Double-precision trigonometric and exponential functions.  These instructions
21871 are only generated if @option{-funsafe-math-optimizations} is also specified.
21873 @end table
21875 Conversions:
21876 @table @asis
21877 @item @samp{fextsd}
21878 Conversion from single precision to double precision.
21880 @item @samp{ftruncds}
21881 Conversion from double precision to single precision.
21883 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21884 Conversion from floating point to signed or unsigned integer types, with
21885 truncation towards zero.
21887 @item @samp{round}
21888 Conversion from single-precision floating point to signed integer,
21889 rounding to the nearest integer and ties away from zero.
21890 This corresponds to the @code{__builtin_lroundf} function when
21891 @option{-fno-math-errno} is used.
21893 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21894 Conversion from signed or unsigned integer types to floating-point types.
21896 @end table
21898 In addition, all of the following transfer instructions for internal
21899 registers X and Y must be provided to use any of the double-precision
21900 floating-point instructions.  Custom instructions taking two
21901 double-precision source operands expect the first operand in the
21902 64-bit register X.  The other operand (or only operand of a unary
21903 operation) is given to the custom arithmetic instruction with the
21904 least significant half in source register @var{src1} and the most
21905 significant half in @var{src2}.  A custom instruction that returns a
21906 double-precision result returns the most significant 32 bits in the
21907 destination register and the other half in 32-bit register Y.  
21908 GCC automatically generates the necessary code sequences to write
21909 register X and/or read register Y when double-precision floating-point
21910 instructions are used.
21912 @table @asis
21914 @item @samp{fwrx}
21915 Write @var{src1} into the least significant half of X and @var{src2} into
21916 the most significant half of X.
21918 @item @samp{fwry}
21919 Write @var{src1} into Y.
21921 @item @samp{frdxhi}, @samp{frdxlo}
21922 Read the most or least (respectively) significant half of X and store it in
21923 @var{dest}.
21925 @item @samp{frdy}
21926 Read the value of Y and store it into @var{dest}.
21927 @end table
21929 Note that you can gain more local control over generation of Nios II custom
21930 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21931 and @code{target("no-custom-@var{insn}")} function attributes
21932 (@pxref{Function Attributes})
21933 or pragmas (@pxref{Function Specific Option Pragmas}).
21935 @item -mcustom-fpu-cfg=@var{name}
21936 @opindex mcustom-fpu-cfg
21938 This option enables a predefined, named set of custom instruction encodings
21939 (see @option{-mcustom-@var{insn}} above).  
21940 Currently, the following sets are defined:
21942 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21943 @gccoptlist{-mcustom-fmuls=252 @gol
21944 -mcustom-fadds=253 @gol
21945 -mcustom-fsubs=254 @gol
21946 -fsingle-precision-constant}
21948 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21949 @gccoptlist{-mcustom-fmuls=252 @gol
21950 -mcustom-fadds=253 @gol
21951 -mcustom-fsubs=254 @gol
21952 -mcustom-fdivs=255 @gol
21953 -fsingle-precision-constant}
21955 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21956 @gccoptlist{-mcustom-floatus=243 @gol
21957 -mcustom-fixsi=244 @gol
21958 -mcustom-floatis=245 @gol
21959 -mcustom-fcmpgts=246 @gol
21960 -mcustom-fcmples=249 @gol
21961 -mcustom-fcmpeqs=250 @gol
21962 -mcustom-fcmpnes=251 @gol
21963 -mcustom-fmuls=252 @gol
21964 -mcustom-fadds=253 @gol
21965 -mcustom-fsubs=254 @gol
21966 -mcustom-fdivs=255 @gol
21967 -fsingle-precision-constant}
21969 Custom instruction assignments given by individual
21970 @option{-mcustom-@var{insn}=} options override those given by
21971 @option{-mcustom-fpu-cfg=}, regardless of the
21972 order of the options on the command line.
21974 Note that you can gain more local control over selection of a FPU
21975 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21976 function attribute (@pxref{Function Attributes})
21977 or pragma (@pxref{Function Specific Option Pragmas}).
21979 @end table
21981 These additional @samp{-m} options are available for the Altera Nios II
21982 ELF (bare-metal) target:
21984 @table @gcctabopt
21986 @item -mhal
21987 @opindex mhal
21988 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21989 startup and termination code, and is typically used in conjunction with
21990 @option{-msys-crt0=} to specify the location of the alternate startup code
21991 provided by the HAL BSP.
21993 @item -msmallc
21994 @opindex msmallc
21995 Link with a limited version of the C library, @option{-lsmallc}, rather than
21996 Newlib.
21998 @item -msys-crt0=@var{startfile}
21999 @opindex msys-crt0
22000 @var{startfile} is the file name of the startfile (crt0) to use 
22001 when linking.  This option is only useful in conjunction with @option{-mhal}.
22003 @item -msys-lib=@var{systemlib}
22004 @opindex msys-lib
22005 @var{systemlib} is the library name of the library that provides
22006 low-level system calls required by the C library,
22007 e.g. @code{read} and @code{write}.
22008 This option is typically used to link with a library provided by a HAL BSP.
22010 @end table
22012 @node Nvidia PTX Options
22013 @subsection Nvidia PTX Options
22014 @cindex Nvidia PTX options
22015 @cindex nvptx options
22017 These options are defined for Nvidia PTX:
22019 @table @gcctabopt
22021 @item -m32
22022 @itemx -m64
22023 @opindex m32
22024 @opindex m64
22025 Generate code for 32-bit or 64-bit ABI.
22027 @item -mmainkernel
22028 @opindex mmainkernel
22029 Link in code for a __main kernel.  This is for stand-alone instead of
22030 offloading execution.
22032 @item -moptimize
22033 @opindex moptimize
22034 Apply partitioned execution optimizations.  This is the default when any
22035 level of optimization is selected.
22037 @item -msoft-stack
22038 @opindex msoft-stack
22039 Generate code that does not use @code{.local} memory
22040 directly for stack storage. Instead, a per-warp stack pointer is
22041 maintained explicitly. This enables variable-length stack allocation (with
22042 variable-length arrays or @code{alloca}), and when global memory is used for
22043 underlying storage, makes it possible to access automatic variables from other
22044 threads, or with atomic instructions. This code generation variant is used
22045 for OpenMP offloading, but the option is exposed on its own for the purpose
22046 of testing the compiler; to generate code suitable for linking into programs
22047 using OpenMP offloading, use option @option{-mgomp}.
22049 @item -muniform-simt
22050 @opindex muniform-simt
22051 Switch to code generation variant that allows to execute all threads in each
22052 warp, while maintaining memory state and side effects as if only one thread
22053 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
22054 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
22055 current lane index equals the master lane index), and the register being
22056 assigned is copied via a shuffle instruction from the master lane.  Outside of
22057 SIMD regions lane 0 is the master; inside, each thread sees itself as the
22058 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
22059 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
22060 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
22061 with current lane index to compute the master lane index.
22063 @item -mgomp
22064 @opindex mgomp
22065 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
22066 @option{-muniform-simt} options, and selects corresponding multilib variant.
22068 @end table
22070 @node PDP-11 Options
22071 @subsection PDP-11 Options
22072 @cindex PDP-11 Options
22074 These options are defined for the PDP-11:
22076 @table @gcctabopt
22077 @item -mfpu
22078 @opindex mfpu
22079 Use hardware FPP floating point.  This is the default.  (FIS floating
22080 point on the PDP-11/40 is not supported.)
22082 @item -msoft-float
22083 @opindex msoft-float
22084 Do not use hardware floating point.
22086 @item -mac0
22087 @opindex mac0
22088 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
22090 @item -mno-ac0
22091 @opindex mno-ac0
22092 Return floating-point results in memory.  This is the default.
22094 @item -m40
22095 @opindex m40
22096 Generate code for a PDP-11/40.
22098 @item -m45
22099 @opindex m45
22100 Generate code for a PDP-11/45.  This is the default.
22102 @item -m10
22103 @opindex m10
22104 Generate code for a PDP-11/10.
22106 @item -mbcopy-builtin
22107 @opindex mbcopy-builtin
22108 Use inline @code{movmemhi} patterns for copying memory.  This is the
22109 default.
22111 @item -mbcopy
22112 @opindex mbcopy
22113 Do not use inline @code{movmemhi} patterns for copying memory.
22115 @item -mint16
22116 @itemx -mno-int32
22117 @opindex mint16
22118 @opindex mno-int32
22119 Use 16-bit @code{int}.  This is the default.
22121 @item -mint32
22122 @itemx -mno-int16
22123 @opindex mint32
22124 @opindex mno-int16
22125 Use 32-bit @code{int}.
22127 @item -mfloat64
22128 @itemx -mno-float32
22129 @opindex mfloat64
22130 @opindex mno-float32
22131 Use 64-bit @code{float}.  This is the default.
22133 @item -mfloat32
22134 @itemx -mno-float64
22135 @opindex mfloat32
22136 @opindex mno-float64
22137 Use 32-bit @code{float}.
22139 @item -mabshi
22140 @opindex mabshi
22141 Use @code{abshi2} pattern.  This is the default.
22143 @item -mno-abshi
22144 @opindex mno-abshi
22145 Do not use @code{abshi2} pattern.
22147 @item -mbranch-expensive
22148 @opindex mbranch-expensive
22149 Pretend that branches are expensive.  This is for experimenting with
22150 code generation only.
22152 @item -mbranch-cheap
22153 @opindex mbranch-cheap
22154 Do not pretend that branches are expensive.  This is the default.
22156 @item -munix-asm
22157 @opindex munix-asm
22158 Use Unix assembler syntax.  This is the default when configured for
22159 @samp{pdp11-*-bsd}.
22161 @item -mdec-asm
22162 @opindex mdec-asm
22163 Use DEC assembler syntax.  This is the default when configured for any
22164 PDP-11 target other than @samp{pdp11-*-bsd}.
22165 @end table
22167 @node picoChip Options
22168 @subsection picoChip Options
22169 @cindex picoChip options
22171 These @samp{-m} options are defined for picoChip implementations:
22173 @table @gcctabopt
22175 @item -mae=@var{ae_type}
22176 @opindex mcpu
22177 Set the instruction set, register set, and instruction scheduling
22178 parameters for array element type @var{ae_type}.  Supported values
22179 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
22181 @option{-mae=ANY} selects a completely generic AE type.  Code
22182 generated with this option runs on any of the other AE types.  The
22183 code is not as efficient as it would be if compiled for a specific
22184 AE type, and some types of operation (e.g., multiplication) do not
22185 work properly on all types of AE.
22187 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
22188 for compiled code, and is the default.
22190 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
22191 option may suffer from poor performance of byte (char) manipulation,
22192 since the DSP AE does not provide hardware support for byte load/stores.
22194 @item -msymbol-as-address
22195 Enable the compiler to directly use a symbol name as an address in a
22196 load/store instruction, without first loading it into a
22197 register.  Typically, the use of this option generates larger
22198 programs, which run faster than when the option isn't used.  However, the
22199 results vary from program to program, so it is left as a user option,
22200 rather than being permanently enabled.
22202 @item -mno-inefficient-warnings
22203 Disables warnings about the generation of inefficient code.  These
22204 warnings can be generated, for example, when compiling code that
22205 performs byte-level memory operations on the MAC AE type.  The MAC AE has
22206 no hardware support for byte-level memory operations, so all byte
22207 load/stores must be synthesized from word load/store operations.  This is
22208 inefficient and a warning is generated to indicate
22209 that you should rewrite the code to avoid byte operations, or to target
22210 an AE type that has the necessary hardware support.  This option disables
22211 these warnings.
22213 @end table
22215 @node PowerPC Options
22216 @subsection PowerPC Options
22217 @cindex PowerPC options
22219 These are listed under @xref{RS/6000 and PowerPC Options}.
22221 @node PowerPC SPE Options
22222 @subsection PowerPC SPE Options
22223 @cindex PowerPC SPE options
22225 These @samp{-m} options are defined for PowerPC SPE:
22226 @table @gcctabopt
22227 @item -mmfcrf
22228 @itemx -mno-mfcrf
22229 @itemx -mpopcntb
22230 @itemx -mno-popcntb
22231 @opindex mmfcrf
22232 @opindex mno-mfcrf
22233 @opindex mpopcntb
22234 @opindex mno-popcntb
22235 You use these options to specify which instructions are available on the
22236 processor you are using.  The default value of these options is
22237 determined when configuring GCC@.  Specifying the
22238 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22239 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22240 rather than the options listed above.
22242 The @option{-mmfcrf} option allows GCC to generate the move from
22243 condition register field instruction implemented on the POWER4
22244 processor and other processors that support the PowerPC V2.01
22245 architecture.
22246 The @option{-mpopcntb} option allows GCC to generate the popcount and
22247 double-precision FP reciprocal estimate instruction implemented on the
22248 POWER5 processor and other processors that support the PowerPC V2.02
22249 architecture.
22251 @item -mcpu=@var{cpu_type}
22252 @opindex mcpu
22253 Set architecture type, register usage, and
22254 instruction scheduling parameters for machine type @var{cpu_type}.
22255 Supported values for @var{cpu_type} are @samp{8540}, @samp{8548},
22256 and @samp{native}.
22258 @option{-mcpu=powerpc} specifies pure 32-bit PowerPC (either
22259 endian), with an appropriate, generic processor model assumed for
22260 scheduling purposes.
22262 Specifying @samp{native} as cpu type detects and selects the
22263 architecture option that corresponds to the host processor of the
22264 system performing the compilation.
22265 @option{-mcpu=native} has no effect if GCC does not recognize the
22266 processor.
22268 The other options specify a specific processor.  Code generated under
22269 those options runs best on that processor, and may not run at all on
22270 others.
22272 The @option{-mcpu} options automatically enable or disable the
22273 following options:
22275 @gccoptlist{-mhard-float  -mmfcrf  -mmultiple @gol
22276 -mpopcntb -mpopcntd @gol
22277 -msingle-float -mdouble-float @gol
22278 -mfloat128}
22280 The particular options set for any particular CPU varies between
22281 compiler versions, depending on what setting seems to produce optimal
22282 code for that CPU; it doesn't necessarily reflect the actual hardware's
22283 capabilities.  If you wish to set an individual option to a particular
22284 value, you may specify it after the @option{-mcpu} option, like
22285 @option{-mcpu=8548}.
22287 @item -mtune=@var{cpu_type}
22288 @opindex mtune
22289 Set the instruction scheduling parameters for machine type
22290 @var{cpu_type}, but do not set the architecture type or register usage,
22291 as @option{-mcpu=@var{cpu_type}} does.  The same
22292 values for @var{cpu_type} are used for @option{-mtune} as for
22293 @option{-mcpu}.  If both are specified, the code generated uses the
22294 architecture and registers set by @option{-mcpu}, but the
22295 scheduling parameters set by @option{-mtune}.
22297 @item -msecure-plt
22298 @opindex msecure-plt
22299 Generate code that allows @command{ld} and @command{ld.so}
22300 to build executables and shared
22301 libraries with non-executable @code{.plt} and @code{.got} sections.
22302 This is a PowerPC
22303 32-bit SYSV ABI option.
22305 @item -mbss-plt
22306 @opindex mbss-plt
22307 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22308 fills in, and
22309 requires @code{.plt} and @code{.got}
22310 sections that are both writable and executable.
22311 This is a PowerPC 32-bit SYSV ABI option.
22313 @item -misel
22314 @itemx -mno-isel
22315 @opindex misel
22316 @opindex mno-isel
22317 This switch enables or disables the generation of ISEL instructions.
22319 @item -misel=@var{yes/no}
22320 This switch has been deprecated.  Use @option{-misel} and
22321 @option{-mno-isel} instead.
22323 @item -mspe
22324 @itemx -mno-spe
22325 @opindex mspe
22326 @opindex mno-spe
22327 This switch enables or disables the generation of SPE simd
22328 instructions.
22330 @item -mspe=@var{yes/no}
22331 This option has been deprecated.  Use @option{-mspe} and
22332 @option{-mno-spe} instead.
22334 @item -mfloat128
22335 @itemx -mno-float128
22336 @opindex mfloat128
22337 @opindex mno-float128
22338 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22339 and use either software emulation for IEEE 128-bit floating point or
22340 hardware instructions.
22342 @item -mfloat-gprs=@var{yes/single/double/no}
22343 @itemx -mfloat-gprs
22344 @opindex mfloat-gprs
22345 This switch enables or disables the generation of floating-point
22346 operations on the general-purpose registers for architectures that
22347 support it.
22349 The argument @samp{yes} or @samp{single} enables the use of
22350 single-precision floating-point operations.
22352 The argument @samp{double} enables the use of single and
22353 double-precision floating-point operations.
22355 The argument @samp{no} disables floating-point operations on the
22356 general-purpose registers.
22358 This option is currently only available on the MPC854x.
22360 @item -mfull-toc
22361 @itemx -mno-fp-in-toc
22362 @itemx -mno-sum-in-toc
22363 @itemx -mminimal-toc
22364 @opindex mfull-toc
22365 @opindex mno-fp-in-toc
22366 @opindex mno-sum-in-toc
22367 @opindex mminimal-toc
22368 Modify generation of the TOC (Table Of Contents), which is created for
22369 every executable file.  The @option{-mfull-toc} option is selected by
22370 default.  In that case, GCC allocates at least one TOC entry for
22371 each unique non-automatic variable reference in your program.  GCC
22372 also places floating-point constants in the TOC@.  However, only
22373 16,384 entries are available in the TOC@.
22375 If you receive a linker error message that saying you have overflowed
22376 the available TOC space, you can reduce the amount of TOC space used
22377 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22378 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22379 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22380 generate code to calculate the sum of an address and a constant at
22381 run time instead of putting that sum into the TOC@.  You may specify one
22382 or both of these options.  Each causes GCC to produce very slightly
22383 slower and larger code at the expense of conserving TOC space.
22385 If you still run out of space in the TOC even when you specify both of
22386 these options, specify @option{-mminimal-toc} instead.  This option causes
22387 GCC to make only one TOC entry for every file.  When you specify this
22388 option, GCC produces code that is slower and larger but which
22389 uses extremely little TOC space.  You may wish to use this option
22390 only on files that contain less frequently-executed code.
22392 @item -maix32
22393 @opindex maix32
22394 Disables the 64-bit ABI.  GCC defaults to @option{-maix32}.
22396 @item -mxl-compat
22397 @itemx -mno-xl-compat
22398 @opindex mxl-compat
22399 @opindex mno-xl-compat
22400 Produce code that conforms more closely to IBM XL compiler semantics
22401 when using AIX-compatible ABI@.  Pass floating-point arguments to
22402 prototyped functions beyond the register save area (RSA) on the stack
22403 in addition to argument FPRs.  Do not assume that most significant
22404 double in 128-bit long double value is properly rounded when comparing
22405 values and converting to double.  Use XL symbol names for long double
22406 support routines.
22408 The AIX calling convention was extended but not initially documented to
22409 handle an obscure K&R C case of calling a function that takes the
22410 address of its arguments with fewer arguments than declared.  IBM XL
22411 compilers access floating-point arguments that do not fit in the
22412 RSA from the stack when a subroutine is compiled without
22413 optimization.  Because always storing floating-point arguments on the
22414 stack is inefficient and rarely needed, this option is not enabled by
22415 default and only is necessary when calling subroutines compiled by IBM
22416 XL compilers without optimization.
22418 @item -malign-natural
22419 @itemx -malign-power
22420 @opindex malign-natural
22421 @opindex malign-power
22422 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22423 @option{-malign-natural} overrides the ABI-defined alignment of larger
22424 types, such as floating-point doubles, on their natural size-based boundary.
22425 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22426 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22428 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22429 is not supported.
22431 @item -msoft-float
22432 @itemx -mhard-float
22433 @opindex msoft-float
22434 @opindex mhard-float
22435 Generate code that does not use (uses) the floating-point register set.
22436 Software floating-point emulation is provided if you use the
22437 @option{-msoft-float} option, and pass the option to GCC when linking.
22439 @item -msingle-float
22440 @itemx -mdouble-float
22441 @opindex msingle-float
22442 @opindex mdouble-float
22443 Generate code for single- or double-precision floating-point operations.
22444 @option{-mdouble-float} implies @option{-msingle-float}.
22446 @item -mmultiple
22447 @itemx -mno-multiple
22448 @opindex mmultiple
22449 @opindex mno-multiple
22450 Generate code that uses (does not use) the load multiple word
22451 instructions and the store multiple word instructions.  These
22452 instructions are generated by default on POWER systems, and not
22453 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22454 PowerPC systems, since those instructions do not work when the
22455 processor is in little-endian mode.  The exceptions are PPC740 and
22456 PPC750 which permit these instructions in little-endian mode.
22458 @item -mupdate
22459 @itemx -mno-update
22460 @opindex mupdate
22461 @opindex mno-update
22462 Generate code that uses (does not use) the load or store instructions
22463 that update the base register to the address of the calculated memory
22464 location.  These instructions are generated by default.  If you use
22465 @option{-mno-update}, there is a small window between the time that the
22466 stack pointer is updated and the address of the previous frame is
22467 stored, which means code that walks the stack frame across interrupts or
22468 signals may get corrupted data.
22470 @item -mavoid-indexed-addresses
22471 @itemx -mno-avoid-indexed-addresses
22472 @opindex mavoid-indexed-addresses
22473 @opindex mno-avoid-indexed-addresses
22474 Generate code that tries to avoid (not avoid) the use of indexed load
22475 or store instructions. These instructions can incur a performance
22476 penalty on Power6 processors in certain situations, such as when
22477 stepping through large arrays that cross a 16M boundary.  This option
22478 is enabled by default when targeting Power6 and disabled otherwise.
22480 @item -mfused-madd
22481 @itemx -mno-fused-madd
22482 @opindex mfused-madd
22483 @opindex mno-fused-madd
22484 Generate code that uses (does not use) the floating-point multiply and
22485 accumulate instructions.  These instructions are generated by default
22486 if hardware floating point is used.  The machine-dependent
22487 @option{-mfused-madd} option is now mapped to the machine-independent
22488 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22489 mapped to @option{-ffp-contract=off}.
22491 @item -mno-strict-align
22492 @itemx -mstrict-align
22493 @opindex mno-strict-align
22494 @opindex mstrict-align
22495 On System V.4 and embedded PowerPC systems do not (do) assume that
22496 unaligned memory references are handled by the system.
22498 @item -mrelocatable
22499 @itemx -mno-relocatable
22500 @opindex mrelocatable
22501 @opindex mno-relocatable
22502 Generate code that allows (does not allow) a static executable to be
22503 relocated to a different address at run time.  A simple embedded
22504 PowerPC system loader should relocate the entire contents of
22505 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22506 a table of 32-bit addresses generated by this option.  For this to
22507 work, all objects linked together must be compiled with
22508 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22509 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22511 @item -mrelocatable-lib
22512 @itemx -mno-relocatable-lib
22513 @opindex mrelocatable-lib
22514 @opindex mno-relocatable-lib
22515 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22516 @code{.fixup} section to allow static executables to be relocated at
22517 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22518 alignment of @option{-mrelocatable}.  Objects compiled with
22519 @option{-mrelocatable-lib} may be linked with objects compiled with
22520 any combination of the @option{-mrelocatable} options.
22522 @item -mno-toc
22523 @itemx -mtoc
22524 @opindex mno-toc
22525 @opindex mtoc
22526 On System V.4 and embedded PowerPC systems do not (do) assume that
22527 register 2 contains a pointer to a global area pointing to the addresses
22528 used in the program.
22530 @item -mlittle
22531 @itemx -mlittle-endian
22532 @opindex mlittle
22533 @opindex mlittle-endian
22534 On System V.4 and embedded PowerPC systems compile code for the
22535 processor in little-endian mode.  The @option{-mlittle-endian} option is
22536 the same as @option{-mlittle}.
22538 @item -mbig
22539 @itemx -mbig-endian
22540 @opindex mbig
22541 @opindex mbig-endian
22542 On System V.4 and embedded PowerPC systems compile code for the
22543 processor in big-endian mode.  The @option{-mbig-endian} option is
22544 the same as @option{-mbig}.
22546 @item -mdynamic-no-pic
22547 @opindex mdynamic-no-pic
22548 On Darwin and Mac OS X systems, compile code so that it is not
22549 relocatable, but that its external references are relocatable.  The
22550 resulting code is suitable for applications, but not shared
22551 libraries.
22553 @item -msingle-pic-base
22554 @opindex msingle-pic-base
22555 Treat the register used for PIC addressing as read-only, rather than
22556 loading it in the prologue for each function.  The runtime system is
22557 responsible for initializing this register with an appropriate value
22558 before execution begins.
22560 @item -mprioritize-restricted-insns=@var{priority}
22561 @opindex mprioritize-restricted-insns
22562 This option controls the priority that is assigned to
22563 dispatch-slot restricted instructions during the second scheduling
22564 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22565 or @samp{2} to assign no, highest, or second-highest (respectively)
22566 priority to dispatch-slot restricted
22567 instructions.
22569 @item -msched-costly-dep=@var{dependence_type}
22570 @opindex msched-costly-dep
22571 This option controls which dependences are considered costly
22572 by the target during instruction scheduling.  The argument
22573 @var{dependence_type} takes one of the following values:
22575 @table @asis
22576 @item @samp{no}
22577 No dependence is costly.
22579 @item @samp{all}
22580 All dependences are costly.
22582 @item @samp{true_store_to_load}
22583 A true dependence from store to load is costly.
22585 @item @samp{store_to_load}
22586 Any dependence from store to load is costly.
22588 @item @var{number}
22589 Any dependence for which the latency is greater than or equal to
22590 @var{number} is costly.
22591 @end table
22593 @item -minsert-sched-nops=@var{scheme}
22594 @opindex minsert-sched-nops
22595 This option controls which NOP insertion scheme is used during
22596 the second scheduling pass.  The argument @var{scheme} takes one of the
22597 following values:
22599 @table @asis
22600 @item @samp{no}
22601 Don't insert NOPs.
22603 @item @samp{pad}
22604 Pad with NOPs any dispatch group that has vacant issue slots,
22605 according to the scheduler's grouping.
22607 @item @samp{regroup_exact}
22608 Insert NOPs to force costly dependent insns into
22609 separate groups.  Insert exactly as many NOPs as needed to force an insn
22610 to a new group, according to the estimated processor grouping.
22612 @item @var{number}
22613 Insert NOPs to force costly dependent insns into
22614 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22615 @end table
22617 @item -mcall-sysv
22618 @opindex mcall-sysv
22619 On System V.4 and embedded PowerPC systems compile code using calling
22620 conventions that adhere to the March 1995 draft of the System V
22621 Application Binary Interface, PowerPC processor supplement.  This is the
22622 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22624 @item -mcall-sysv-eabi
22625 @itemx -mcall-eabi
22626 @opindex mcall-sysv-eabi
22627 @opindex mcall-eabi
22628 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22630 @item -mcall-sysv-noeabi
22631 @opindex mcall-sysv-noeabi
22632 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22634 @item -mcall-aixdesc
22635 @opindex m
22636 On System V.4 and embedded PowerPC systems compile code for the AIX
22637 operating system.
22639 @item -mcall-linux
22640 @opindex mcall-linux
22641 On System V.4 and embedded PowerPC systems compile code for the
22642 Linux-based GNU system.
22644 @item -mcall-freebsd
22645 @opindex mcall-freebsd
22646 On System V.4 and embedded PowerPC systems compile code for the
22647 FreeBSD operating system.
22649 @item -mcall-netbsd
22650 @opindex mcall-netbsd
22651 On System V.4 and embedded PowerPC systems compile code for the
22652 NetBSD operating system.
22654 @item -mcall-openbsd
22655 @opindex mcall-netbsd
22656 On System V.4 and embedded PowerPC systems compile code for the
22657 OpenBSD operating system.
22659 @item -maix-struct-return
22660 @opindex maix-struct-return
22661 Return all structures in memory (as specified by the AIX ABI)@.
22663 @item -msvr4-struct-return
22664 @opindex msvr4-struct-return
22665 Return structures smaller than 8 bytes in registers (as specified by the
22666 SVR4 ABI)@.
22668 @item -mabi=@var{abi-type}
22669 @opindex mabi
22670 Extend the current ABI with a particular extension, or remove such extension.
22671 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22672 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22673 @samp{elfv1}, @samp{elfv2}@.
22675 @item -mabi=spe
22676 @opindex mabi=spe
22677 Extend the current ABI with SPE ABI extensions.  This does not change
22678 the default ABI, instead it adds the SPE ABI extensions to the current
22679 ABI@.
22681 @item -mabi=no-spe
22682 @opindex mabi=no-spe
22683 Disable Book-E SPE ABI extensions for the current ABI@.
22685 @item -mabi=ibmlongdouble
22686 @opindex mabi=ibmlongdouble
22687 Change the current ABI to use IBM extended-precision long double.
22688 This is not likely to work if your system defaults to using IEEE
22689 extended-precision long double.  If you change the long double type
22690 from IEEE extended-precision, the compiler will issue a warning unless
22691 you use the @option{-Wno-psabi} option.
22693 @item -mabi=ieeelongdouble
22694 @opindex mabi=ieeelongdouble
22695 Change the current ABI to use IEEE extended-precision long double.
22696 This is not likely to work if your system defaults to using IBM
22697 extended-precision long double.  If you change the long double type
22698 from IBM extended-precision, the compiler will issue a warning unless
22699 you use the @option{-Wno-psabi} option.
22701 @item -mabi=elfv1
22702 @opindex mabi=elfv1
22703 Change the current ABI to use the ELFv1 ABI.
22704 This is the default ABI for big-endian PowerPC 64-bit Linux.
22705 Overriding the default ABI requires special system support and is
22706 likely to fail in spectacular ways.
22708 @item -mabi=elfv2
22709 @opindex mabi=elfv2
22710 Change the current ABI to use the ELFv2 ABI.
22711 This is the default ABI for little-endian PowerPC 64-bit Linux.
22712 Overriding the default ABI requires special system support and is
22713 likely to fail in spectacular ways.
22715 @item -mgnu-attribute
22716 @itemx -mno-gnu-attribute
22717 @opindex mgnu-attribute
22718 @opindex mno-gnu-attribute
22719 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22720 .gnu.attributes section that specify ABI variations in function
22721 parameters or return values.
22723 @item -mprototype
22724 @itemx -mno-prototype
22725 @opindex mprototype
22726 @opindex mno-prototype
22727 On System V.4 and embedded PowerPC systems assume that all calls to
22728 variable argument functions are properly prototyped.  Otherwise, the
22729 compiler must insert an instruction before every non-prototyped call to
22730 set or clear bit 6 of the condition code register (@code{CR}) to
22731 indicate whether floating-point values are passed in the floating-point
22732 registers in case the function takes variable arguments.  With
22733 @option{-mprototype}, only calls to prototyped variable argument functions
22734 set or clear the bit.
22736 @item -msim
22737 @opindex msim
22738 On embedded PowerPC systems, assume that the startup module is called
22739 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22740 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22741 configurations.
22743 @item -mmvme
22744 @opindex mmvme
22745 On embedded PowerPC systems, assume that the startup module is called
22746 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22747 @file{libc.a}.
22749 @item -mads
22750 @opindex mads
22751 On embedded PowerPC systems, assume that the startup module is called
22752 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22753 @file{libc.a}.
22755 @item -myellowknife
22756 @opindex myellowknife
22757 On embedded PowerPC systems, assume that the startup module is called
22758 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22759 @file{libc.a}.
22761 @item -mvxworks
22762 @opindex mvxworks
22763 On System V.4 and embedded PowerPC systems, specify that you are
22764 compiling for a VxWorks system.
22766 @item -memb
22767 @opindex memb
22768 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22769 header to indicate that @samp{eabi} extended relocations are used.
22771 @item -meabi
22772 @itemx -mno-eabi
22773 @opindex meabi
22774 @opindex mno-eabi
22775 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22776 Embedded Applications Binary Interface (EABI), which is a set of
22777 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22778 means that the stack is aligned to an 8-byte boundary, a function
22779 @code{__eabi} is called from @code{main} to set up the EABI
22780 environment, and the @option{-msdata} option can use both @code{r2} and
22781 @code{r13} to point to two separate small data areas.  Selecting
22782 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22783 no EABI initialization function is called from @code{main}, and the
22784 @option{-msdata} option only uses @code{r13} to point to a single
22785 small data area.  The @option{-meabi} option is on by default if you
22786 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22788 @item -msdata=eabi
22789 @opindex msdata=eabi
22790 On System V.4 and embedded PowerPC systems, put small initialized
22791 @code{const} global and static data in the @code{.sdata2} section, which
22792 is pointed to by register @code{r2}.  Put small initialized
22793 non-@code{const} global and static data in the @code{.sdata} section,
22794 which is pointed to by register @code{r13}.  Put small uninitialized
22795 global and static data in the @code{.sbss} section, which is adjacent to
22796 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22797 incompatible with the @option{-mrelocatable} option.  The
22798 @option{-msdata=eabi} option also sets the @option{-memb} option.
22800 @item -msdata=sysv
22801 @opindex msdata=sysv
22802 On System V.4 and embedded PowerPC systems, put small global and static
22803 data in the @code{.sdata} section, which is pointed to by register
22804 @code{r13}.  Put small uninitialized global and static data in the
22805 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22806 The @option{-msdata=sysv} option is incompatible with the
22807 @option{-mrelocatable} option.
22809 @item -msdata=default
22810 @itemx -msdata
22811 @opindex msdata=default
22812 @opindex msdata
22813 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22814 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22815 same as @option{-msdata=sysv}.
22817 @item -msdata=data
22818 @opindex msdata=data
22819 On System V.4 and embedded PowerPC systems, put small global
22820 data in the @code{.sdata} section.  Put small uninitialized global
22821 data in the @code{.sbss} section.  Do not use register @code{r13}
22822 to address small data however.  This is the default behavior unless
22823 other @option{-msdata} options are used.
22825 @item -msdata=none
22826 @itemx -mno-sdata
22827 @opindex msdata=none
22828 @opindex mno-sdata
22829 On embedded PowerPC systems, put all initialized global and static data
22830 in the @code{.data} section, and all uninitialized data in the
22831 @code{.bss} section.
22833 @item -mblock-move-inline-limit=@var{num}
22834 @opindex mblock-move-inline-limit
22835 Inline all block moves (such as calls to @code{memcpy} or structure
22836 copies) less than or equal to @var{num} bytes.  The minimum value for
22837 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22838 targets.  The default value is target-specific.
22840 @item -G @var{num}
22841 @opindex G
22842 @cindex smaller data references (PowerPC)
22843 @cindex .sdata/.sdata2 references (PowerPC)
22844 On embedded PowerPC systems, put global and static items less than or
22845 equal to @var{num} bytes into the small data or BSS sections instead of
22846 the normal data or BSS section.  By default, @var{num} is 8.  The
22847 @option{-G @var{num}} switch is also passed to the linker.
22848 All modules should be compiled with the same @option{-G @var{num}} value.
22850 @item -mregnames
22851 @itemx -mno-regnames
22852 @opindex mregnames
22853 @opindex mno-regnames
22854 On System V.4 and embedded PowerPC systems do (do not) emit register
22855 names in the assembly language output using symbolic forms.
22857 @item -mlongcall
22858 @itemx -mno-longcall
22859 @opindex mlongcall
22860 @opindex mno-longcall
22861 By default assume that all calls are far away so that a longer and more
22862 expensive calling sequence is required.  This is required for calls
22863 farther than 32 megabytes (33,554,432 bytes) from the current location.
22864 A short call is generated if the compiler knows
22865 the call cannot be that far away.  This setting can be overridden by
22866 the @code{shortcall} function attribute, or by @code{#pragma
22867 longcall(0)}.
22869 Some linkers are capable of detecting out-of-range calls and generating
22870 glue code on the fly.  On these systems, long calls are unnecessary and
22871 generate slower code.  As of this writing, the AIX linker can do this,
22872 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22873 to the GNU linker for 32-bit PowerPC systems as well.
22875 In the future, GCC may ignore all longcall specifications
22876 when the linker is known to generate glue.
22878 @item -mtls-markers
22879 @itemx -mno-tls-markers
22880 @opindex mtls-markers
22881 @opindex mno-tls-markers
22882 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22883 specifying the function argument.  The relocation allows the linker to
22884 reliably associate function call with argument setup instructions for
22885 TLS optimization, which in turn allows GCC to better schedule the
22886 sequence.
22888 @item -mrecip
22889 @itemx -mno-recip
22890 @opindex mrecip
22891 This option enables use of the reciprocal estimate and
22892 reciprocal square root estimate instructions with additional
22893 Newton-Raphson steps to increase precision instead of doing a divide or
22894 square root and divide for floating-point arguments.  You should use
22895 the @option{-ffast-math} option when using @option{-mrecip} (or at
22896 least @option{-funsafe-math-optimizations},
22897 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22898 @option{-fno-trapping-math}).  Note that while the throughput of the
22899 sequence is generally higher than the throughput of the non-reciprocal
22900 instruction, the precision of the sequence can be decreased by up to 2
22901 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22902 roots.
22904 @item -mrecip=@var{opt}
22905 @opindex mrecip=opt
22906 This option controls which reciprocal estimate instructions
22907 may be used.  @var{opt} is a comma-separated list of options, which may
22908 be preceded by a @code{!} to invert the option:
22910 @table @samp
22912 @item all
22913 Enable all estimate instructions.
22915 @item default
22916 Enable the default instructions, equivalent to @option{-mrecip}.
22918 @item none
22919 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22921 @item div
22922 Enable the reciprocal approximation instructions for both
22923 single and double precision.
22925 @item divf
22926 Enable the single-precision reciprocal approximation instructions.
22928 @item divd
22929 Enable the double-precision reciprocal approximation instructions.
22931 @item rsqrt
22932 Enable the reciprocal square root approximation instructions for both
22933 single and double precision.
22935 @item rsqrtf
22936 Enable the single-precision reciprocal square root approximation instructions.
22938 @item rsqrtd
22939 Enable the double-precision reciprocal square root approximation instructions.
22941 @end table
22943 So, for example, @option{-mrecip=all,!rsqrtd} enables
22944 all of the reciprocal estimate instructions, except for the
22945 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22946 which handle the double-precision reciprocal square root calculations.
22948 @item -mrecip-precision
22949 @itemx -mno-recip-precision
22950 @opindex mrecip-precision
22951 Assume (do not assume) that the reciprocal estimate instructions
22952 provide higher-precision estimates than is mandated by the PowerPC
22953 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22954 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22955 The double-precision square root estimate instructions are not generated by
22956 default on low-precision machines, since they do not provide an
22957 estimate that converges after three steps.
22959 @item -mpointers-to-nested-functions
22960 @itemx -mno-pointers-to-nested-functions
22961 @opindex mpointers-to-nested-functions
22962 Generate (do not generate) code to load up the static chain register
22963 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22964 systems where a function pointer points to a 3-word descriptor giving
22965 the function address, TOC value to be loaded in register @code{r2}, and
22966 static chain value to be loaded in register @code{r11}.  The
22967 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22968 call through pointers to nested functions or pointers
22969 to functions compiled in other languages that use the static chain if
22970 you use @option{-mno-pointers-to-nested-functions}.
22972 @item -msave-toc-indirect
22973 @itemx -mno-save-toc-indirect
22974 @opindex msave-toc-indirect
22975 Generate (do not generate) code to save the TOC value in the reserved
22976 stack location in the function prologue if the function calls through
22977 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22978 saved in the prologue, it is saved just before the call through the
22979 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22981 @item -mcompat-align-parm
22982 @itemx -mno-compat-align-parm
22983 @opindex mcompat-align-parm
22984 Generate (do not generate) code to pass structure parameters with a
22985 maximum alignment of 64 bits, for compatibility with older versions
22986 of GCC.
22988 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22989 structure parameter on a 128-bit boundary when that structure contained
22990 a member requiring 128-bit alignment.  This is corrected in more
22991 recent versions of GCC.  This option may be used to generate code
22992 that is compatible with functions compiled with older versions of
22993 GCC.
22995 The @option{-mno-compat-align-parm} option is the default.
22997 @item -mstack-protector-guard=@var{guard}
22998 @itemx -mstack-protector-guard-reg=@var{reg}
22999 @itemx -mstack-protector-guard-offset=@var{offset}
23000 @itemx -mstack-protector-guard-symbol=@var{symbol}
23001 @opindex mstack-protector-guard
23002 @opindex mstack-protector-guard-reg
23003 @opindex mstack-protector-guard-offset
23004 @opindex mstack-protector-guard-symbol
23005 Generate stack protection code using canary at @var{guard}.  Supported
23006 locations are @samp{global} for global canary or @samp{tls} for per-thread
23007 canary in the TLS block (the default with GNU libc version 2.4 or later).
23009 With the latter choice the options
23010 @option{-mstack-protector-guard-reg=@var{reg}} and
23011 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
23012 which register to use as base register for reading the canary, and from what
23013 offset from that base register. The default for those is as specified in the
23014 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
23015 the offset with a symbol reference to a canary in the TLS block.
23016 @end table
23019 @node RISC-V Options
23020 @subsection RISC-V Options
23021 @cindex RISC-V Options
23023 These command-line options are defined for RISC-V targets:
23025 @table @gcctabopt
23026 @item -mbranch-cost=@var{n}
23027 @opindex mbranch-cost
23028 Set the cost of branches to roughly @var{n} instructions.
23030 @item -mplt
23031 @itemx -mno-plt
23032 @opindex plt
23033 When generating PIC code, do or don't allow the use of PLTs. Ignored for
23034 non-PIC.  The default is @option{-mplt}.
23036 @item -mabi=@var{ABI-string}
23037 @opindex mabi
23038 Specify integer and floating-point calling convention.  @var{ABI-string}
23039 contains two parts: the size of integer types and the registers used for
23040 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
23041 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
23042 32-bit), and that floating-point values up to 64 bits wide are passed in F
23043 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
23044 allows the compiler to generate code that uses the F and D extensions but only
23045 allows floating-point values up to 32 bits long to be passed in registers; or
23046 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
23047 passed in registers.
23049 The default for this argument is system dependent, users who want a specific
23050 calling convention should specify one explicitly.  The valid calling
23051 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
23052 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
23053 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
23054 invalid because the ABI requires 64-bit values be passed in F registers, but F
23055 registers are only 32 bits wide.  There is also the @samp{ilp32e} ABI that can
23056 only be used with the @samp{rv32e} architecture.  This ABI is not well
23057 specified at present, and is subject to change.
23059 @item -mfdiv
23060 @itemx -mno-fdiv
23061 @opindex mfdiv
23062 Do or don't use hardware floating-point divide and square root instructions.
23063 This requires the F or D extensions for floating-point registers.  The default
23064 is to use them if the specified architecture has these instructions.
23066 @item -mdiv
23067 @itemx -mno-div
23068 @opindex mdiv
23069 Do or don't use hardware instructions for integer division.  This requires the
23070 M extension.  The default is to use them if the specified architecture has
23071 these instructions.
23073 @item -march=@var{ISA-string}
23074 @opindex march
23075 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
23076 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, @samp{rv32e}, and
23077 @samp{rv32imaf}.
23079 @item -mtune=@var{processor-string}
23080 @opindex mtune
23081 Optimize the output for the given processor, specified by microarchitecture
23082 name.
23084 @item -mpreferred-stack-boundary=@var{num}
23085 @opindex mpreferred-stack-boundary
23086 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
23087 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
23088 the default is 4 (16 bytes or 128-bits).
23090 @strong{Warning:} If you use this switch, then you must build all modules with
23091 the same value, including any libraries.  This includes the system libraries
23092 and startup modules.
23094 @item -msmall-data-limit=@var{n}
23095 @opindex msmall-data-limit
23096 Put global and static data smaller than @var{n} bytes into a special section
23097 (on some targets).
23099 @item -msave-restore
23100 @itemx -mno-save-restore
23101 @opindex msave-restore
23102 Do or don't use smaller but slower prologue and epilogue code that uses
23103 library function calls.  The default is to use fast inline prologues and
23104 epilogues.
23106 @item -mstrict-align
23107 @itemx -mno-strict-align
23108 @opindex mstrict-align
23109 Do not or do generate unaligned memory accesses.  The default is set depending
23110 on whether the processor we are optimizing for supports fast unaligned access
23111 or not.
23113 @item -mcmodel=medlow
23114 @opindex mcmodel=medlow
23115 Generate code for the medium-low code model. The program and its statically
23116 defined symbols must lie within a single 2 GiB address range and must lie
23117 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
23118 statically or dynamically linked. This is the default code model.
23120 @item -mcmodel=medany
23121 @opindex mcmodel=medany
23122 Generate code for the medium-any code model. The program and its statically
23123 defined symbols must be within any single 2 GiB address range. Programs can be
23124 statically or dynamically linked.
23126 @item -mexplicit-relocs
23127 @itemx -mno-exlicit-relocs
23128 Use or do not use assembler relocation operators when dealing with symbolic
23129 addresses.  The alternative is to use assembler macros instead, which may
23130 limit optimization.
23132 @item -mrelax
23133 @itemx -mno-relax
23134 Take advantage of linker relaxations to reduce the number of instructions
23135 required to materialize symbol addresses. The default is to take advantage of
23136 linker relaxations.
23138 @end table
23140 @node RL78 Options
23141 @subsection RL78 Options
23142 @cindex RL78 Options
23144 @table @gcctabopt
23146 @item -msim
23147 @opindex msim
23148 Links in additional target libraries to support operation within a
23149 simulator.
23151 @item -mmul=none
23152 @itemx -mmul=g10
23153 @itemx -mmul=g13
23154 @itemx -mmul=g14
23155 @itemx -mmul=rl78
23156 @opindex mmul
23157 Specifies the type of hardware multiplication and division support to
23158 be used.  The simplest is @code{none}, which uses software for both
23159 multiplication and division.  This is the default.  The @code{g13}
23160 value is for the hardware multiply/divide peripheral found on the
23161 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
23162 the multiplication and division instructions supported by the RL78/G14
23163 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
23164 the value @code{mg10} is an alias for @code{none}.
23166 In addition a C preprocessor macro is defined, based upon the setting
23167 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
23168 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
23170 @item -mcpu=g10
23171 @itemx -mcpu=g13
23172 @itemx -mcpu=g14
23173 @itemx -mcpu=rl78
23174 @opindex mcpu
23175 Specifies the RL78 core to target.  The default is the G14 core, also
23176 known as an S3 core or just RL78.  The G13 or S2 core does not have
23177 multiply or divide instructions, instead it uses a hardware peripheral
23178 for these operations.  The G10 or S1 core does not have register
23179 banks, so it uses a different calling convention.
23181 If this option is set it also selects the type of hardware multiply
23182 support to use, unless this is overridden by an explicit
23183 @option{-mmul=none} option on the command line.  Thus specifying
23184 @option{-mcpu=g13} enables the use of the G13 hardware multiply
23185 peripheral and specifying @option{-mcpu=g10} disables the use of
23186 hardware multiplications altogether.
23188 Note, although the RL78/G14 core is the default target, specifying
23189 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
23190 change the behavior of the toolchain since it also enables G14
23191 hardware multiply support.  If these options are not specified on the
23192 command line then software multiplication routines will be used even
23193 though the code targets the RL78 core.  This is for backwards
23194 compatibility with older toolchains which did not have hardware
23195 multiply and divide support.
23197 In addition a C preprocessor macro is defined, based upon the setting
23198 of this option.  Possible values are: @code{__RL78_G10__},
23199 @code{__RL78_G13__} or @code{__RL78_G14__}.
23201 @item -mg10
23202 @itemx -mg13
23203 @itemx -mg14
23204 @itemx -mrl78
23205 @opindex mg10
23206 @opindex mg13
23207 @opindex mg14
23208 @opindex mrl78
23209 These are aliases for the corresponding @option{-mcpu=} option.  They
23210 are provided for backwards compatibility.
23212 @item -mallregs
23213 @opindex mallregs
23214 Allow the compiler to use all of the available registers.  By default
23215 registers @code{r24..r31} are reserved for use in interrupt handlers.
23216 With this option enabled these registers can be used in ordinary
23217 functions as well.
23219 @item -m64bit-doubles
23220 @itemx -m32bit-doubles
23221 @opindex m64bit-doubles
23222 @opindex m32bit-doubles
23223 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23224 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23225 @option{-m32bit-doubles}.
23227 @item -msave-mduc-in-interrupts
23228 @itemx -mno-save-mduc-in-interrupts
23229 @opindex msave-mduc-in-interrupts
23230 @opindex mno-save-mduc-in-interrupts
23231 Specifies that interrupt handler functions should preserve the
23232 MDUC registers.  This is only necessary if normal code might use
23233 the MDUC registers, for example because it performs multiplication
23234 and division operations.  The default is to ignore the MDUC registers
23235 as this makes the interrupt handlers faster.  The target option -mg13
23236 needs to be passed for this to work as this feature is only available
23237 on the G13 target (S2 core).  The MDUC registers will only be saved
23238 if the interrupt handler performs a multiplication or division
23239 operation or it calls another function.
23241 @end table
23243 @node RS/6000 and PowerPC Options
23244 @subsection IBM RS/6000 and PowerPC Options
23245 @cindex RS/6000 and PowerPC Options
23246 @cindex IBM RS/6000 and PowerPC Options
23248 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
23249 @table @gcctabopt
23250 @item -mpowerpc-gpopt
23251 @itemx -mno-powerpc-gpopt
23252 @itemx -mpowerpc-gfxopt
23253 @itemx -mno-powerpc-gfxopt
23254 @need 800
23255 @itemx -mpowerpc64
23256 @itemx -mno-powerpc64
23257 @itemx -mmfcrf
23258 @itemx -mno-mfcrf
23259 @itemx -mpopcntb
23260 @itemx -mno-popcntb
23261 @itemx -mpopcntd
23262 @itemx -mno-popcntd
23263 @itemx -mfprnd
23264 @itemx -mno-fprnd
23265 @need 800
23266 @itemx -mcmpb
23267 @itemx -mno-cmpb
23268 @itemx -mmfpgpr
23269 @itemx -mno-mfpgpr
23270 @itemx -mhard-dfp
23271 @itemx -mno-hard-dfp
23272 @opindex mpowerpc-gpopt
23273 @opindex mno-powerpc-gpopt
23274 @opindex mpowerpc-gfxopt
23275 @opindex mno-powerpc-gfxopt
23276 @opindex mpowerpc64
23277 @opindex mno-powerpc64
23278 @opindex mmfcrf
23279 @opindex mno-mfcrf
23280 @opindex mpopcntb
23281 @opindex mno-popcntb
23282 @opindex mpopcntd
23283 @opindex mno-popcntd
23284 @opindex mfprnd
23285 @opindex mno-fprnd
23286 @opindex mcmpb
23287 @opindex mno-cmpb
23288 @opindex mmfpgpr
23289 @opindex mno-mfpgpr
23290 @opindex mhard-dfp
23291 @opindex mno-hard-dfp
23292 You use these options to specify which instructions are available on the
23293 processor you are using.  The default value of these options is
23294 determined when configuring GCC@.  Specifying the
23295 @option{-mcpu=@var{cpu_type}} overrides the specification of these
23296 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
23297 rather than the options listed above.
23299 Specifying @option{-mpowerpc-gpopt} allows
23300 GCC to use the optional PowerPC architecture instructions in the
23301 General Purpose group, including floating-point square root.  Specifying
23302 @option{-mpowerpc-gfxopt} allows GCC to
23303 use the optional PowerPC architecture instructions in the Graphics
23304 group, including floating-point select.
23306 The @option{-mmfcrf} option allows GCC to generate the move from
23307 condition register field instruction implemented on the POWER4
23308 processor and other processors that support the PowerPC V2.01
23309 architecture.
23310 The @option{-mpopcntb} option allows GCC to generate the popcount and
23311 double-precision FP reciprocal estimate instruction implemented on the
23312 POWER5 processor and other processors that support the PowerPC V2.02
23313 architecture.
23314 The @option{-mpopcntd} option allows GCC to generate the popcount
23315 instruction implemented on the POWER7 processor and other processors
23316 that support the PowerPC V2.06 architecture.
23317 The @option{-mfprnd} option allows GCC to generate the FP round to
23318 integer instructions implemented on the POWER5+ processor and other
23319 processors that support the PowerPC V2.03 architecture.
23320 The @option{-mcmpb} option allows GCC to generate the compare bytes
23321 instruction implemented on the POWER6 processor and other processors
23322 that support the PowerPC V2.05 architecture.
23323 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
23324 general-purpose register instructions implemented on the POWER6X
23325 processor and other processors that support the extended PowerPC V2.05
23326 architecture.
23327 The @option{-mhard-dfp} option allows GCC to generate the decimal
23328 floating-point instructions implemented on some POWER processors.
23330 The @option{-mpowerpc64} option allows GCC to generate the additional
23331 64-bit instructions that are found in the full PowerPC64 architecture
23332 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
23333 @option{-mno-powerpc64}.
23335 @item -mcpu=@var{cpu_type}
23336 @opindex mcpu
23337 Set architecture type, register usage, and
23338 instruction scheduling parameters for machine type @var{cpu_type}.
23339 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
23340 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
23341 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
23342 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
23343 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
23344 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
23345 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
23346 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
23347 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
23348 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
23349 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
23350 @samp{rs64}, and @samp{native}.
23352 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
23353 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
23354 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
23355 architecture machine types, with an appropriate, generic processor
23356 model assumed for scheduling purposes.
23358 Specifying @samp{native} as cpu type detects and selects the
23359 architecture option that corresponds to the host processor of the
23360 system performing the compilation.
23361 @option{-mcpu=native} has no effect if GCC does not recognize the
23362 processor.
23364 The other options specify a specific processor.  Code generated under
23365 those options runs best on that processor, and may not run at all on
23366 others.
23368 The @option{-mcpu} options automatically enable or disable the
23369 following options:
23371 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
23372 -mpopcntb -mpopcntd  -mpowerpc64 @gol
23373 -mpowerpc-gpopt  -mpowerpc-gfxopt @gol
23374 -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
23375 -mcrypto -mhtm -mpower8-fusion -mpower8-vector @gol
23376 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
23378 The particular options set for any particular CPU varies between
23379 compiler versions, depending on what setting seems to produce optimal
23380 code for that CPU; it doesn't necessarily reflect the actual hardware's
23381 capabilities.  If you wish to set an individual option to a particular
23382 value, you may specify it after the @option{-mcpu} option, like
23383 @option{-mcpu=970 -mno-altivec}.
23385 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
23386 not enabled or disabled by the @option{-mcpu} option at present because
23387 AIX does not have full support for these options.  You may still
23388 enable or disable them individually if you're sure it'll work in your
23389 environment.
23391 @item -mtune=@var{cpu_type}
23392 @opindex mtune
23393 Set the instruction scheduling parameters for machine type
23394 @var{cpu_type}, but do not set the architecture type or register usage,
23395 as @option{-mcpu=@var{cpu_type}} does.  The same
23396 values for @var{cpu_type} are used for @option{-mtune} as for
23397 @option{-mcpu}.  If both are specified, the code generated uses the
23398 architecture and registers set by @option{-mcpu}, but the
23399 scheduling parameters set by @option{-mtune}.
23401 @item -mcmodel=small
23402 @opindex mcmodel=small
23403 Generate PowerPC64 code for the small model: The TOC is limited to
23404 64k.
23406 @item -mcmodel=medium
23407 @opindex mcmodel=medium
23408 Generate PowerPC64 code for the medium model: The TOC and other static
23409 data may be up to a total of 4G in size.  This is the default for 64-bit
23410 Linux.
23412 @item -mcmodel=large
23413 @opindex mcmodel=large
23414 Generate PowerPC64 code for the large model: The TOC may be up to 4G
23415 in size.  Other data and code is only limited by the 64-bit address
23416 space.
23418 @item -maltivec
23419 @itemx -mno-altivec
23420 @opindex maltivec
23421 @opindex mno-altivec
23422 Generate code that uses (does not use) AltiVec instructions, and also
23423 enable the use of built-in functions that allow more direct access to
23424 the AltiVec instruction set.  You may also need to set
23425 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
23426 enhancements.
23428 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
23429 @option{-maltivec=be}, the element order for AltiVec intrinsics such
23430 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
23431 match array element order corresponding to the endianness of the
23432 target.  That is, element zero identifies the leftmost element in a
23433 vector register when targeting a big-endian platform, and identifies
23434 the rightmost element in a vector register when targeting a
23435 little-endian platform.
23437 @item -maltivec=be
23438 @opindex maltivec=be
23439 Generate AltiVec instructions using big-endian element order,
23440 regardless of whether the target is big- or little-endian.  This is
23441 the default when targeting a big-endian platform.  Using this option
23442 is currently deprecated.  Support for this feature will be removed in
23443 GCC 9.
23445 The element order is used to interpret element numbers in AltiVec
23446 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23447 @code{vec_insert}.  By default, these match array element order
23448 corresponding to the endianness for the target.
23450 @item -maltivec=le
23451 @opindex maltivec=le
23452 Generate AltiVec instructions using little-endian element order,
23453 regardless of whether the target is big- or little-endian.  This is
23454 the default when targeting a little-endian platform.  This option is
23455 currently ignored when targeting a big-endian platform.
23457 The element order is used to interpret element numbers in AltiVec
23458 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
23459 @code{vec_insert}.  By default, these match array element order
23460 corresponding to the endianness for the target.
23462 @item -mvrsave
23463 @itemx -mno-vrsave
23464 @opindex mvrsave
23465 @opindex mno-vrsave
23466 Generate VRSAVE instructions when generating AltiVec code.
23468 @item -msecure-plt
23469 @opindex msecure-plt
23470 Generate code that allows @command{ld} and @command{ld.so}
23471 to build executables and shared
23472 libraries with non-executable @code{.plt} and @code{.got} sections.
23473 This is a PowerPC
23474 32-bit SYSV ABI option.
23476 @item -mbss-plt
23477 @opindex mbss-plt
23478 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
23479 fills in, and
23480 requires @code{.plt} and @code{.got}
23481 sections that are both writable and executable.
23482 This is a PowerPC 32-bit SYSV ABI option.
23484 @item -misel
23485 @itemx -mno-isel
23486 @opindex misel
23487 @opindex mno-isel
23488 This switch enables or disables the generation of ISEL instructions.
23490 @item -misel=@var{yes/no}
23491 This switch has been deprecated.  Use @option{-misel} and
23492 @option{-mno-isel} instead.
23494 @item -mvsx
23495 @itemx -mno-vsx
23496 @opindex mvsx
23497 @opindex mno-vsx
23498 Generate code that uses (does not use) vector/scalar (VSX)
23499 instructions, and also enable the use of built-in functions that allow
23500 more direct access to the VSX instruction set.
23502 @item -mcrypto
23503 @itemx -mno-crypto
23504 @opindex mcrypto
23505 @opindex mno-crypto
23506 Enable the use (disable) of the built-in functions that allow direct
23507 access to the cryptographic instructions that were added in version
23508 2.07 of the PowerPC ISA.
23510 @item -mhtm
23511 @itemx -mno-htm
23512 @opindex mhtm
23513 @opindex mno-htm
23514 Enable (disable) the use of the built-in functions that allow direct
23515 access to the Hardware Transactional Memory (HTM) instructions that
23516 were added in version 2.07 of the PowerPC ISA.
23518 @item -mpower8-fusion
23519 @itemx -mno-power8-fusion
23520 @opindex mpower8-fusion
23521 @opindex mno-power8-fusion
23522 Generate code that keeps (does not keeps) some integer operations
23523 adjacent so that the instructions can be fused together on power8 and
23524 later processors.
23526 @item -mpower8-vector
23527 @itemx -mno-power8-vector
23528 @opindex mpower8-vector
23529 @opindex mno-power8-vector
23530 Generate code that uses (does not use) the vector and scalar
23531 instructions that were added in version 2.07 of the PowerPC ISA.  Also
23532 enable the use of built-in functions that allow more direct access to
23533 the vector instructions.
23535 @item -mquad-memory
23536 @itemx -mno-quad-memory
23537 @opindex mquad-memory
23538 @opindex mno-quad-memory
23539 Generate code that uses (does not use) the non-atomic quad word memory
23540 instructions.  The @option{-mquad-memory} option requires use of
23541 64-bit mode.
23543 @item -mquad-memory-atomic
23544 @itemx -mno-quad-memory-atomic
23545 @opindex mquad-memory-atomic
23546 @opindex mno-quad-memory-atomic
23547 Generate code that uses (does not use) the atomic quad word memory
23548 instructions.  The @option{-mquad-memory-atomic} option requires use of
23549 64-bit mode.
23551 @item -mfloat128
23552 @itemx -mno-float128
23553 @opindex mfloat128
23554 @opindex mno-float128
23555 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
23556 and use either software emulation for IEEE 128-bit floating point or
23557 hardware instructions.
23559 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
23560 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
23561 use the IEEE 128-bit floating point support.  The IEEE 128-bit
23562 floating point support only works on PowerPC Linux systems.
23564 The default for @option{-mfloat128} is enabled on PowerPC Linux
23565 systems using the VSX instruction set, and disabled on other systems.
23567 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
23568 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
23569 point support will also enable the generation of ISA 3.0 IEEE 128-bit
23570 floating point instructions.  Otherwise, if you do not specify to
23571 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
23572 system, IEEE 128-bit floating point will be done with software
23573 emulation.
23575 @item -mfloat128-hardware
23576 @itemx -mno-float128-hardware
23577 @opindex mfloat128-hardware
23578 @opindex mno-float128-hardware
23579 Enable/disable using ISA 3.0 hardware instructions to support the
23580 @var{__float128} data type.
23582 The default for @option{-mfloat128-hardware} is enabled on PowerPC
23583 Linux systems using the ISA 3.0 instruction set, and disabled on other
23584 systems.
23586 @item -m32
23587 @itemx -m64
23588 @opindex m32
23589 @opindex m64
23590 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
23591 targets (including GNU/Linux).  The 32-bit environment sets int, long
23592 and pointer to 32 bits and generates code that runs on any PowerPC
23593 variant.  The 64-bit environment sets int to 32 bits and long and
23594 pointer to 64 bits, and generates code for PowerPC64, as for
23595 @option{-mpowerpc64}.
23597 @item -mfull-toc
23598 @itemx -mno-fp-in-toc
23599 @itemx -mno-sum-in-toc
23600 @itemx -mminimal-toc
23601 @opindex mfull-toc
23602 @opindex mno-fp-in-toc
23603 @opindex mno-sum-in-toc
23604 @opindex mminimal-toc
23605 Modify generation of the TOC (Table Of Contents), which is created for
23606 every executable file.  The @option{-mfull-toc} option is selected by
23607 default.  In that case, GCC allocates at least one TOC entry for
23608 each unique non-automatic variable reference in your program.  GCC
23609 also places floating-point constants in the TOC@.  However, only
23610 16,384 entries are available in the TOC@.
23612 If you receive a linker error message that saying you have overflowed
23613 the available TOC space, you can reduce the amount of TOC space used
23614 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
23615 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
23616 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
23617 generate code to calculate the sum of an address and a constant at
23618 run time instead of putting that sum into the TOC@.  You may specify one
23619 or both of these options.  Each causes GCC to produce very slightly
23620 slower and larger code at the expense of conserving TOC space.
23622 If you still run out of space in the TOC even when you specify both of
23623 these options, specify @option{-mminimal-toc} instead.  This option causes
23624 GCC to make only one TOC entry for every file.  When you specify this
23625 option, GCC produces code that is slower and larger but which
23626 uses extremely little TOC space.  You may wish to use this option
23627 only on files that contain less frequently-executed code.
23629 @item -maix64
23630 @itemx -maix32
23631 @opindex maix64
23632 @opindex maix32
23633 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
23634 @code{long} type, and the infrastructure needed to support them.
23635 Specifying @option{-maix64} implies @option{-mpowerpc64},
23636 while @option{-maix32} disables the 64-bit ABI and
23637 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
23639 @item -mxl-compat
23640 @itemx -mno-xl-compat
23641 @opindex mxl-compat
23642 @opindex mno-xl-compat
23643 Produce code that conforms more closely to IBM XL compiler semantics
23644 when using AIX-compatible ABI@.  Pass floating-point arguments to
23645 prototyped functions beyond the register save area (RSA) on the stack
23646 in addition to argument FPRs.  Do not assume that most significant
23647 double in 128-bit long double value is properly rounded when comparing
23648 values and converting to double.  Use XL symbol names for long double
23649 support routines.
23651 The AIX calling convention was extended but not initially documented to
23652 handle an obscure K&R C case of calling a function that takes the
23653 address of its arguments with fewer arguments than declared.  IBM XL
23654 compilers access floating-point arguments that do not fit in the
23655 RSA from the stack when a subroutine is compiled without
23656 optimization.  Because always storing floating-point arguments on the
23657 stack is inefficient and rarely needed, this option is not enabled by
23658 default and only is necessary when calling subroutines compiled by IBM
23659 XL compilers without optimization.
23661 @item -mpe
23662 @opindex mpe
23663 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
23664 application written to use message passing with special startup code to
23665 enable the application to run.  The system must have PE installed in the
23666 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
23667 must be overridden with the @option{-specs=} option to specify the
23668 appropriate directory location.  The Parallel Environment does not
23669 support threads, so the @option{-mpe} option and the @option{-pthread}
23670 option are incompatible.
23672 @item -malign-natural
23673 @itemx -malign-power
23674 @opindex malign-natural
23675 @opindex malign-power
23676 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
23677 @option{-malign-natural} overrides the ABI-defined alignment of larger
23678 types, such as floating-point doubles, on their natural size-based boundary.
23679 The option @option{-malign-power} instructs GCC to follow the ABI-specified
23680 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
23682 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
23683 is not supported.
23685 @item -msoft-float
23686 @itemx -mhard-float
23687 @opindex msoft-float
23688 @opindex mhard-float
23689 Generate code that does not use (uses) the floating-point register set.
23690 Software floating-point emulation is provided if you use the
23691 @option{-msoft-float} option, and pass the option to GCC when linking.
23693 @item -mmultiple
23694 @itemx -mno-multiple
23695 @opindex mmultiple
23696 @opindex mno-multiple
23697 Generate code that uses (does not use) the load multiple word
23698 instructions and the store multiple word instructions.  These
23699 instructions are generated by default on POWER systems, and not
23700 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
23701 PowerPC systems, since those instructions do not work when the
23702 processor is in little-endian mode.  The exceptions are PPC740 and
23703 PPC750 which permit these instructions in little-endian mode.
23705 @item -mupdate
23706 @itemx -mno-update
23707 @opindex mupdate
23708 @opindex mno-update
23709 Generate code that uses (does not use) the load or store instructions
23710 that update the base register to the address of the calculated memory
23711 location.  These instructions are generated by default.  If you use
23712 @option{-mno-update}, there is a small window between the time that the
23713 stack pointer is updated and the address of the previous frame is
23714 stored, which means code that walks the stack frame across interrupts or
23715 signals may get corrupted data.
23717 @item -mavoid-indexed-addresses
23718 @itemx -mno-avoid-indexed-addresses
23719 @opindex mavoid-indexed-addresses
23720 @opindex mno-avoid-indexed-addresses
23721 Generate code that tries to avoid (not avoid) the use of indexed load
23722 or store instructions. These instructions can incur a performance
23723 penalty on Power6 processors in certain situations, such as when
23724 stepping through large arrays that cross a 16M boundary.  This option
23725 is enabled by default when targeting Power6 and disabled otherwise.
23727 @item -mfused-madd
23728 @itemx -mno-fused-madd
23729 @opindex mfused-madd
23730 @opindex mno-fused-madd
23731 Generate code that uses (does not use) the floating-point multiply and
23732 accumulate instructions.  These instructions are generated by default
23733 if hardware floating point is used.  The machine-dependent
23734 @option{-mfused-madd} option is now mapped to the machine-independent
23735 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23736 mapped to @option{-ffp-contract=off}.
23738 @item -mmulhw
23739 @itemx -mno-mulhw
23740 @opindex mmulhw
23741 @opindex mno-mulhw
23742 Generate code that uses (does not use) the half-word multiply and
23743 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
23744 These instructions are generated by default when targeting those
23745 processors.
23747 @item -mdlmzb
23748 @itemx -mno-dlmzb
23749 @opindex mdlmzb
23750 @opindex mno-dlmzb
23751 Generate code that uses (does not use) the string-search @samp{dlmzb}
23752 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
23753 generated by default when targeting those processors.
23755 @item -mno-bit-align
23756 @itemx -mbit-align
23757 @opindex mno-bit-align
23758 @opindex mbit-align
23759 On System V.4 and embedded PowerPC systems do not (do) force structures
23760 and unions that contain bit-fields to be aligned to the base type of the
23761 bit-field.
23763 For example, by default a structure containing nothing but 8
23764 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
23765 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
23766 the structure is aligned to a 1-byte boundary and is 1 byte in
23767 size.
23769 @item -mno-strict-align
23770 @itemx -mstrict-align
23771 @opindex mno-strict-align
23772 @opindex mstrict-align
23773 On System V.4 and embedded PowerPC systems do not (do) assume that
23774 unaligned memory references are handled by the system.
23776 @item -mrelocatable
23777 @itemx -mno-relocatable
23778 @opindex mrelocatable
23779 @opindex mno-relocatable
23780 Generate code that allows (does not allow) a static executable to be
23781 relocated to a different address at run time.  A simple embedded
23782 PowerPC system loader should relocate the entire contents of
23783 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
23784 a table of 32-bit addresses generated by this option.  For this to
23785 work, all objects linked together must be compiled with
23786 @option{-mrelocatable} or @option{-mrelocatable-lib}.
23787 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
23789 @item -mrelocatable-lib
23790 @itemx -mno-relocatable-lib
23791 @opindex mrelocatable-lib
23792 @opindex mno-relocatable-lib
23793 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
23794 @code{.fixup} section to allow static executables to be relocated at
23795 run time, but @option{-mrelocatable-lib} does not use the smaller stack
23796 alignment of @option{-mrelocatable}.  Objects compiled with
23797 @option{-mrelocatable-lib} may be linked with objects compiled with
23798 any combination of the @option{-mrelocatable} options.
23800 @item -mno-toc
23801 @itemx -mtoc
23802 @opindex mno-toc
23803 @opindex mtoc
23804 On System V.4 and embedded PowerPC systems do not (do) assume that
23805 register 2 contains a pointer to a global area pointing to the addresses
23806 used in the program.
23808 @item -mlittle
23809 @itemx -mlittle-endian
23810 @opindex mlittle
23811 @opindex mlittle-endian
23812 On System V.4 and embedded PowerPC systems compile code for the
23813 processor in little-endian mode.  The @option{-mlittle-endian} option is
23814 the same as @option{-mlittle}.
23816 @item -mbig
23817 @itemx -mbig-endian
23818 @opindex mbig
23819 @opindex mbig-endian
23820 On System V.4 and embedded PowerPC systems compile code for the
23821 processor in big-endian mode.  The @option{-mbig-endian} option is
23822 the same as @option{-mbig}.
23824 @item -mdynamic-no-pic
23825 @opindex mdynamic-no-pic
23826 On Darwin and Mac OS X systems, compile code so that it is not
23827 relocatable, but that its external references are relocatable.  The
23828 resulting code is suitable for applications, but not shared
23829 libraries.
23831 @item -msingle-pic-base
23832 @opindex msingle-pic-base
23833 Treat the register used for PIC addressing as read-only, rather than
23834 loading it in the prologue for each function.  The runtime system is
23835 responsible for initializing this register with an appropriate value
23836 before execution begins.
23838 @item -mprioritize-restricted-insns=@var{priority}
23839 @opindex mprioritize-restricted-insns
23840 This option controls the priority that is assigned to
23841 dispatch-slot restricted instructions during the second scheduling
23842 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
23843 or @samp{2} to assign no, highest, or second-highest (respectively) 
23844 priority to dispatch-slot restricted
23845 instructions.
23847 @item -msched-costly-dep=@var{dependence_type}
23848 @opindex msched-costly-dep
23849 This option controls which dependences are considered costly
23850 by the target during instruction scheduling.  The argument
23851 @var{dependence_type} takes one of the following values:
23853 @table @asis
23854 @item @samp{no}
23855 No dependence is costly.
23857 @item @samp{all}
23858 All dependences are costly.
23860 @item @samp{true_store_to_load}
23861 A true dependence from store to load is costly.
23863 @item @samp{store_to_load}
23864 Any dependence from store to load is costly.
23866 @item @var{number}
23867 Any dependence for which the latency is greater than or equal to 
23868 @var{number} is costly.
23869 @end table
23871 @item -minsert-sched-nops=@var{scheme}
23872 @opindex minsert-sched-nops
23873 This option controls which NOP insertion scheme is used during
23874 the second scheduling pass.  The argument @var{scheme} takes one of the
23875 following values:
23877 @table @asis
23878 @item @samp{no}
23879 Don't insert NOPs.
23881 @item @samp{pad}
23882 Pad with NOPs any dispatch group that has vacant issue slots,
23883 according to the scheduler's grouping.
23885 @item @samp{regroup_exact}
23886 Insert NOPs to force costly dependent insns into
23887 separate groups.  Insert exactly as many NOPs as needed to force an insn
23888 to a new group, according to the estimated processor grouping.
23890 @item @var{number}
23891 Insert NOPs to force costly dependent insns into
23892 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
23893 @end table
23895 @item -mcall-sysv
23896 @opindex mcall-sysv
23897 On System V.4 and embedded PowerPC systems compile code using calling
23898 conventions that adhere to the March 1995 draft of the System V
23899 Application Binary Interface, PowerPC processor supplement.  This is the
23900 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
23902 @item -mcall-sysv-eabi
23903 @itemx -mcall-eabi
23904 @opindex mcall-sysv-eabi
23905 @opindex mcall-eabi
23906 Specify both @option{-mcall-sysv} and @option{-meabi} options.
23908 @item -mcall-sysv-noeabi
23909 @opindex mcall-sysv-noeabi
23910 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
23912 @item -mcall-aixdesc
23913 @opindex m
23914 On System V.4 and embedded PowerPC systems compile code for the AIX
23915 operating system.
23917 @item -mcall-linux
23918 @opindex mcall-linux
23919 On System V.4 and embedded PowerPC systems compile code for the
23920 Linux-based GNU system.
23922 @item -mcall-freebsd
23923 @opindex mcall-freebsd
23924 On System V.4 and embedded PowerPC systems compile code for the
23925 FreeBSD operating system.
23927 @item -mcall-netbsd
23928 @opindex mcall-netbsd
23929 On System V.4 and embedded PowerPC systems compile code for the
23930 NetBSD operating system.
23932 @item -mcall-openbsd
23933 @opindex mcall-netbsd
23934 On System V.4 and embedded PowerPC systems compile code for the
23935 OpenBSD operating system.
23937 @item -mtraceback=@var{traceback_type}
23938 @opindex mtraceback
23939 Select the type of traceback table. Valid values for @var{traceback_type}
23940 are @samp{full}, @samp{part}, and @samp{no}.
23942 @item -maix-struct-return
23943 @opindex maix-struct-return
23944 Return all structures in memory (as specified by the AIX ABI)@.
23946 @item -msvr4-struct-return
23947 @opindex msvr4-struct-return
23948 Return structures smaller than 8 bytes in registers (as specified by the
23949 SVR4 ABI)@.
23951 @item -mabi=@var{abi-type}
23952 @opindex mabi
23953 Extend the current ABI with a particular extension, or remove such extension.
23954 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
23955 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
23956 @samp{elfv1}, @samp{elfv2}@.
23958 @item -mabi=ibmlongdouble
23959 @opindex mabi=ibmlongdouble
23960 Change the current ABI to use IBM extended-precision long double.
23961 This is not likely to work if your system defaults to using IEEE
23962 extended-precision long double.  If you change the long double type
23963 from IEEE extended-precision, the compiler will issue a warning unless
23964 you use the @option{-Wno-psabi} option.
23966 @item -mabi=ieeelongdouble
23967 @opindex mabi=ieeelongdouble
23968 Change the current ABI to use IEEE extended-precision long double.
23969 This is not likely to work if your system defaults to using IBM
23970 extended-precision long double.  If you change the long double type
23971 from IBM extended-precision, the compiler will issue a warning unless
23972 you use the @option{-Wno-psabi} option.
23974 @item -mabi=elfv1
23975 @opindex mabi=elfv1
23976 Change the current ABI to use the ELFv1 ABI.
23977 This is the default ABI for big-endian PowerPC 64-bit Linux.
23978 Overriding the default ABI requires special system support and is
23979 likely to fail in spectacular ways.
23981 @item -mabi=elfv2
23982 @opindex mabi=elfv2
23983 Change the current ABI to use the ELFv2 ABI.
23984 This is the default ABI for little-endian PowerPC 64-bit Linux.
23985 Overriding the default ABI requires special system support and is
23986 likely to fail in spectacular ways.
23988 @item -mgnu-attribute
23989 @itemx -mno-gnu-attribute
23990 @opindex mgnu-attribute
23991 @opindex mno-gnu-attribute
23992 Emit .gnu_attribute assembly directives to set tag/value pairs in a
23993 .gnu.attributes section that specify ABI variations in function
23994 parameters or return values.
23996 @item -mprototype
23997 @itemx -mno-prototype
23998 @opindex mprototype
23999 @opindex mno-prototype
24000 On System V.4 and embedded PowerPC systems assume that all calls to
24001 variable argument functions are properly prototyped.  Otherwise, the
24002 compiler must insert an instruction before every non-prototyped call to
24003 set or clear bit 6 of the condition code register (@code{CR}) to
24004 indicate whether floating-point values are passed in the floating-point
24005 registers in case the function takes variable arguments.  With
24006 @option{-mprototype}, only calls to prototyped variable argument functions
24007 set or clear the bit.
24009 @item -msim
24010 @opindex msim
24011 On embedded PowerPC systems, assume that the startup module is called
24012 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
24013 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
24014 configurations.
24016 @item -mmvme
24017 @opindex mmvme
24018 On embedded PowerPC systems, assume that the startup module is called
24019 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
24020 @file{libc.a}.
24022 @item -mads
24023 @opindex mads
24024 On embedded PowerPC systems, assume that the startup module is called
24025 @file{crt0.o} and the standard C libraries are @file{libads.a} and
24026 @file{libc.a}.
24028 @item -myellowknife
24029 @opindex myellowknife
24030 On embedded PowerPC systems, assume that the startup module is called
24031 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
24032 @file{libc.a}.
24034 @item -mvxworks
24035 @opindex mvxworks
24036 On System V.4 and embedded PowerPC systems, specify that you are
24037 compiling for a VxWorks system.
24039 @item -memb
24040 @opindex memb
24041 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
24042 header to indicate that @samp{eabi} extended relocations are used.
24044 @item -meabi
24045 @itemx -mno-eabi
24046 @opindex meabi
24047 @opindex mno-eabi
24048 On System V.4 and embedded PowerPC systems do (do not) adhere to the
24049 Embedded Applications Binary Interface (EABI), which is a set of
24050 modifications to the System V.4 specifications.  Selecting @option{-meabi}
24051 means that the stack is aligned to an 8-byte boundary, a function
24052 @code{__eabi} is called from @code{main} to set up the EABI
24053 environment, and the @option{-msdata} option can use both @code{r2} and
24054 @code{r13} to point to two separate small data areas.  Selecting
24055 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
24056 no EABI initialization function is called from @code{main}, and the
24057 @option{-msdata} option only uses @code{r13} to point to a single
24058 small data area.  The @option{-meabi} option is on by default if you
24059 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
24061 @item -msdata=eabi
24062 @opindex msdata=eabi
24063 On System V.4 and embedded PowerPC systems, put small initialized
24064 @code{const} global and static data in the @code{.sdata2} section, which
24065 is pointed to by register @code{r2}.  Put small initialized
24066 non-@code{const} global and static data in the @code{.sdata} section,
24067 which is pointed to by register @code{r13}.  Put small uninitialized
24068 global and static data in the @code{.sbss} section, which is adjacent to
24069 the @code{.sdata} section.  The @option{-msdata=eabi} option is
24070 incompatible with the @option{-mrelocatable} option.  The
24071 @option{-msdata=eabi} option also sets the @option{-memb} option.
24073 @item -msdata=sysv
24074 @opindex msdata=sysv
24075 On System V.4 and embedded PowerPC systems, put small global and static
24076 data in the @code{.sdata} section, which is pointed to by register
24077 @code{r13}.  Put small uninitialized global and static data in the
24078 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
24079 The @option{-msdata=sysv} option is incompatible with the
24080 @option{-mrelocatable} option.
24082 @item -msdata=default
24083 @itemx -msdata
24084 @opindex msdata=default
24085 @opindex msdata
24086 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
24087 compile code the same as @option{-msdata=eabi}, otherwise compile code the
24088 same as @option{-msdata=sysv}.
24090 @item -msdata=data
24091 @opindex msdata=data
24092 On System V.4 and embedded PowerPC systems, put small global
24093 data in the @code{.sdata} section.  Put small uninitialized global
24094 data in the @code{.sbss} section.  Do not use register @code{r13}
24095 to address small data however.  This is the default behavior unless
24096 other @option{-msdata} options are used.
24098 @item -msdata=none
24099 @itemx -mno-sdata
24100 @opindex msdata=none
24101 @opindex mno-sdata
24102 On embedded PowerPC systems, put all initialized global and static data
24103 in the @code{.data} section, and all uninitialized data in the
24104 @code{.bss} section.
24106 @item -mreadonly-in-sdata
24107 @opindex mreadonly-in-sdata
24108 @opindex mno-readonly-in-sdata
24109 Put read-only objects in the @code{.sdata} section as well.  This is the
24110 default.
24112 @item -mblock-move-inline-limit=@var{num}
24113 @opindex mblock-move-inline-limit
24114 Inline all block moves (such as calls to @code{memcpy} or structure
24115 copies) less than or equal to @var{num} bytes.  The minimum value for
24116 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
24117 targets.  The default value is target-specific.
24119 @item -mblock-compare-inline-limit=@var{num}
24120 @opindex mblock-compare-inline-limit
24121 Generate non-looping inline code for all block compares (such as calls
24122 to @code{memcmp} or structure compares) less than or equal to @var{num}
24123 bytes. If @var{num} is 0, all inline expansion (non-loop and loop) of
24124 block compare is disabled. The default value is target-specific.
24126 @item -mblock-compare-inline-loop-limit=@var{num}
24127 @opindex mblock-compare-inline-loop-limit
24128 Generate an inline expansion using loop code for all block compares that
24129 are less than or equal to @var{num} bytes, but greater than the limit
24130 for non-loop inline block compare expansion. If the block length is not
24131 constant, at most @var{num} bytes will be compared before @code{memcmp}
24132 is called to compare the remainder of the block. The default value is
24133 target-specific.
24135 @item -mstring-compare-inline-limit=@var{num}
24136 @opindex mstring-compare-inline-limit
24137 Generate at most @var{num} pairs of load instructions to compare the
24138 string inline. If the difference or end of string is not found at the
24139 end of the inline compare a call to @code{strcmp} or @code{strncmp} will
24140 take care of the rest of the comparison. The default is 8 pairs of
24141 loads, which will compare 64 bytes on a 64-bit target and 32 bytes on a
24142 32-bit target.
24144 @item -G @var{num}
24145 @opindex G
24146 @cindex smaller data references (PowerPC)
24147 @cindex .sdata/.sdata2 references (PowerPC)
24148 On embedded PowerPC systems, put global and static items less than or
24149 equal to @var{num} bytes into the small data or BSS sections instead of
24150 the normal data or BSS section.  By default, @var{num} is 8.  The
24151 @option{-G @var{num}} switch is also passed to the linker.
24152 All modules should be compiled with the same @option{-G @var{num}} value.
24154 @item -mregnames
24155 @itemx -mno-regnames
24156 @opindex mregnames
24157 @opindex mno-regnames
24158 On System V.4 and embedded PowerPC systems do (do not) emit register
24159 names in the assembly language output using symbolic forms.
24161 @item -mlongcall
24162 @itemx -mno-longcall
24163 @opindex mlongcall
24164 @opindex mno-longcall
24165 By default assume that all calls are far away so that a longer and more
24166 expensive calling sequence is required.  This is required for calls
24167 farther than 32 megabytes (33,554,432 bytes) from the current location.
24168 A short call is generated if the compiler knows
24169 the call cannot be that far away.  This setting can be overridden by
24170 the @code{shortcall} function attribute, or by @code{#pragma
24171 longcall(0)}.
24173 Some linkers are capable of detecting out-of-range calls and generating
24174 glue code on the fly.  On these systems, long calls are unnecessary and
24175 generate slower code.  As of this writing, the AIX linker can do this,
24176 as can the GNU linker for PowerPC/64.  It is planned to add this feature
24177 to the GNU linker for 32-bit PowerPC systems as well.
24179 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
24180 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
24181 addresses represent the callee and the branch island.  The
24182 Darwin/PPC linker prefers the first address and generates a @code{bl
24183 callee} if the PPC @code{bl} instruction reaches the callee directly;
24184 otherwise, the linker generates @code{bl L42} to call the branch
24185 island.  The branch island is appended to the body of the
24186 calling function; it computes the full 32-bit address of the callee
24187 and jumps to it.
24189 On Mach-O (Darwin) systems, this option directs the compiler emit to
24190 the glue for every direct call, and the Darwin linker decides whether
24191 to use or discard it.
24193 In the future, GCC may ignore all longcall specifications
24194 when the linker is known to generate glue.
24196 @item -mtls-markers
24197 @itemx -mno-tls-markers
24198 @opindex mtls-markers
24199 @opindex mno-tls-markers
24200 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
24201 specifying the function argument.  The relocation allows the linker to
24202 reliably associate function call with argument setup instructions for
24203 TLS optimization, which in turn allows GCC to better schedule the
24204 sequence.
24206 @item -mrecip
24207 @itemx -mno-recip
24208 @opindex mrecip
24209 This option enables use of the reciprocal estimate and
24210 reciprocal square root estimate instructions with additional
24211 Newton-Raphson steps to increase precision instead of doing a divide or
24212 square root and divide for floating-point arguments.  You should use
24213 the @option{-ffast-math} option when using @option{-mrecip} (or at
24214 least @option{-funsafe-math-optimizations},
24215 @option{-ffinite-math-only}, @option{-freciprocal-math} and
24216 @option{-fno-trapping-math}).  Note that while the throughput of the
24217 sequence is generally higher than the throughput of the non-reciprocal
24218 instruction, the precision of the sequence can be decreased by up to 2
24219 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
24220 roots.
24222 @item -mrecip=@var{opt}
24223 @opindex mrecip=opt
24224 This option controls which reciprocal estimate instructions
24225 may be used.  @var{opt} is a comma-separated list of options, which may
24226 be preceded by a @code{!} to invert the option:
24228 @table @samp
24230 @item all
24231 Enable all estimate instructions.
24233 @item default 
24234 Enable the default instructions, equivalent to @option{-mrecip}.
24236 @item none 
24237 Disable all estimate instructions, equivalent to @option{-mno-recip}.
24239 @item div 
24240 Enable the reciprocal approximation instructions for both 
24241 single and double precision.
24243 @item divf 
24244 Enable the single-precision reciprocal approximation instructions.
24246 @item divd 
24247 Enable the double-precision reciprocal approximation instructions.
24249 @item rsqrt 
24250 Enable the reciprocal square root approximation instructions for both
24251 single and double precision.
24253 @item rsqrtf 
24254 Enable the single-precision reciprocal square root approximation instructions.
24256 @item rsqrtd 
24257 Enable the double-precision reciprocal square root approximation instructions.
24259 @end table
24261 So, for example, @option{-mrecip=all,!rsqrtd} enables
24262 all of the reciprocal estimate instructions, except for the
24263 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
24264 which handle the double-precision reciprocal square root calculations.
24266 @item -mrecip-precision
24267 @itemx -mno-recip-precision
24268 @opindex mrecip-precision
24269 Assume (do not assume) that the reciprocal estimate instructions
24270 provide higher-precision estimates than is mandated by the PowerPC
24271 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
24272 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
24273 The double-precision square root estimate instructions are not generated by
24274 default on low-precision machines, since they do not provide an
24275 estimate that converges after three steps.
24277 @item -mveclibabi=@var{type}
24278 @opindex mveclibabi
24279 Specifies the ABI type to use for vectorizing intrinsics using an
24280 external library.  The only type supported at present is @samp{mass},
24281 which specifies to use IBM's Mathematical Acceleration Subsystem
24282 (MASS) libraries for vectorizing intrinsics using external libraries.
24283 GCC currently emits calls to @code{acosd2}, @code{acosf4},
24284 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
24285 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
24286 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
24287 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
24288 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
24289 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
24290 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
24291 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
24292 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
24293 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
24294 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
24295 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
24296 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
24297 for power7.  Both @option{-ftree-vectorize} and
24298 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
24299 libraries must be specified at link time.
24301 @item -mfriz
24302 @itemx -mno-friz
24303 @opindex mfriz
24304 Generate (do not generate) the @code{friz} instruction when the
24305 @option{-funsafe-math-optimizations} option is used to optimize
24306 rounding of floating-point values to 64-bit integer and back to floating
24307 point.  The @code{friz} instruction does not return the same value if
24308 the floating-point number is too large to fit in an integer.
24310 @item -mpointers-to-nested-functions
24311 @itemx -mno-pointers-to-nested-functions
24312 @opindex mpointers-to-nested-functions
24313 Generate (do not generate) code to load up the static chain register
24314 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
24315 systems where a function pointer points to a 3-word descriptor giving
24316 the function address, TOC value to be loaded in register @code{r2}, and
24317 static chain value to be loaded in register @code{r11}.  The
24318 @option{-mpointers-to-nested-functions} is on by default.  You cannot
24319 call through pointers to nested functions or pointers
24320 to functions compiled in other languages that use the static chain if
24321 you use @option{-mno-pointers-to-nested-functions}.
24323 @item -msave-toc-indirect
24324 @itemx -mno-save-toc-indirect
24325 @opindex msave-toc-indirect
24326 Generate (do not generate) code to save the TOC value in the reserved
24327 stack location in the function prologue if the function calls through
24328 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
24329 saved in the prologue, it is saved just before the call through the
24330 pointer.  The @option{-mno-save-toc-indirect} option is the default.
24332 @item -mcompat-align-parm
24333 @itemx -mno-compat-align-parm
24334 @opindex mcompat-align-parm
24335 Generate (do not generate) code to pass structure parameters with a
24336 maximum alignment of 64 bits, for compatibility with older versions
24337 of GCC.
24339 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
24340 structure parameter on a 128-bit boundary when that structure contained
24341 a member requiring 128-bit alignment.  This is corrected in more
24342 recent versions of GCC.  This option may be used to generate code
24343 that is compatible with functions compiled with older versions of
24344 GCC.
24346 The @option{-mno-compat-align-parm} option is the default.
24348 @item -mstack-protector-guard=@var{guard}
24349 @itemx -mstack-protector-guard-reg=@var{reg}
24350 @itemx -mstack-protector-guard-offset=@var{offset}
24351 @itemx -mstack-protector-guard-symbol=@var{symbol}
24352 @opindex mstack-protector-guard
24353 @opindex mstack-protector-guard-reg
24354 @opindex mstack-protector-guard-offset
24355 @opindex mstack-protector-guard-symbol
24356 Generate stack protection code using canary at @var{guard}.  Supported
24357 locations are @samp{global} for global canary or @samp{tls} for per-thread
24358 canary in the TLS block (the default with GNU libc version 2.4 or later).
24360 With the latter choice the options
24361 @option{-mstack-protector-guard-reg=@var{reg}} and
24362 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
24363 which register to use as base register for reading the canary, and from what
24364 offset from that base register. The default for those is as specified in the
24365 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
24366 the offset with a symbol reference to a canary in the TLS block.
24367 @end table
24369 @node RX Options
24370 @subsection RX Options
24371 @cindex RX Options
24373 These command-line options are defined for RX targets:
24375 @table @gcctabopt
24376 @item -m64bit-doubles
24377 @itemx -m32bit-doubles
24378 @opindex m64bit-doubles
24379 @opindex m32bit-doubles
24380 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
24381 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
24382 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
24383 works on 32-bit values, which is why the default is
24384 @option{-m32bit-doubles}.
24386 @item -fpu
24387 @itemx -nofpu
24388 @opindex fpu
24389 @opindex nofpu
24390 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
24391 floating-point hardware.  The default is enabled for the RX600
24392 series and disabled for the RX200 series.
24394 Floating-point instructions are only generated for 32-bit floating-point 
24395 values, however, so the FPU hardware is not used for doubles if the
24396 @option{-m64bit-doubles} option is used.
24398 @emph{Note} If the @option{-fpu} option is enabled then
24399 @option{-funsafe-math-optimizations} is also enabled automatically.
24400 This is because the RX FPU instructions are themselves unsafe.
24402 @item -mcpu=@var{name}
24403 @opindex mcpu
24404 Selects the type of RX CPU to be targeted.  Currently three types are
24405 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
24406 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
24408 The only difference between @samp{RX600} and @samp{RX610} is that the
24409 @samp{RX610} does not support the @code{MVTIPL} instruction.
24411 The @samp{RX200} series does not have a hardware floating-point unit
24412 and so @option{-nofpu} is enabled by default when this type is
24413 selected.
24415 @item -mbig-endian-data
24416 @itemx -mlittle-endian-data
24417 @opindex mbig-endian-data
24418 @opindex mlittle-endian-data
24419 Store data (but not code) in the big-endian format.  The default is
24420 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
24421 format.
24423 @item -msmall-data-limit=@var{N}
24424 @opindex msmall-data-limit
24425 Specifies the maximum size in bytes of global and static variables
24426 which can be placed into the small data area.  Using the small data
24427 area can lead to smaller and faster code, but the size of area is
24428 limited and it is up to the programmer to ensure that the area does
24429 not overflow.  Also when the small data area is used one of the RX's
24430 registers (usually @code{r13}) is reserved for use pointing to this
24431 area, so it is no longer available for use by the compiler.  This
24432 could result in slower and/or larger code if variables are pushed onto
24433 the stack instead of being held in this register.
24435 Note, common variables (variables that have not been initialized) and
24436 constants are not placed into the small data area as they are assigned
24437 to other sections in the output executable.
24439 The default value is zero, which disables this feature.  Note, this
24440 feature is not enabled by default with higher optimization levels
24441 (@option{-O2} etc) because of the potentially detrimental effects of
24442 reserving a register.  It is up to the programmer to experiment and
24443 discover whether this feature is of benefit to their program.  See the
24444 description of the @option{-mpid} option for a description of how the
24445 actual register to hold the small data area pointer is chosen.
24447 @item -msim
24448 @itemx -mno-sim
24449 @opindex msim
24450 @opindex mno-sim
24451 Use the simulator runtime.  The default is to use the libgloss
24452 board-specific runtime.
24454 @item -mas100-syntax
24455 @itemx -mno-as100-syntax
24456 @opindex mas100-syntax
24457 @opindex mno-as100-syntax
24458 When generating assembler output use a syntax that is compatible with
24459 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
24460 assembler, but it has some restrictions so it is not generated by default.
24462 @item -mmax-constant-size=@var{N}
24463 @opindex mmax-constant-size
24464 Specifies the maximum size, in bytes, of a constant that can be used as
24465 an operand in a RX instruction.  Although the RX instruction set does
24466 allow constants of up to 4 bytes in length to be used in instructions,
24467 a longer value equates to a longer instruction.  Thus in some
24468 circumstances it can be beneficial to restrict the size of constants
24469 that are used in instructions.  Constants that are too big are instead
24470 placed into a constant pool and referenced via register indirection.
24472 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
24473 or 4 means that constants of any size are allowed.
24475 @item -mrelax
24476 @opindex mrelax
24477 Enable linker relaxation.  Linker relaxation is a process whereby the
24478 linker attempts to reduce the size of a program by finding shorter
24479 versions of various instructions.  Disabled by default.
24481 @item -mint-register=@var{N}
24482 @opindex mint-register
24483 Specify the number of registers to reserve for fast interrupt handler
24484 functions.  The value @var{N} can be between 0 and 4.  A value of 1
24485 means that register @code{r13} is reserved for the exclusive use
24486 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
24487 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
24488 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
24489 A value of 0, the default, does not reserve any registers.
24491 @item -msave-acc-in-interrupts
24492 @opindex msave-acc-in-interrupts
24493 Specifies that interrupt handler functions should preserve the
24494 accumulator register.  This is only necessary if normal code might use
24495 the accumulator register, for example because it performs 64-bit
24496 multiplications.  The default is to ignore the accumulator as this
24497 makes the interrupt handlers faster.
24499 @item -mpid
24500 @itemx -mno-pid
24501 @opindex mpid
24502 @opindex mno-pid
24503 Enables the generation of position independent data.  When enabled any
24504 access to constant data is done via an offset from a base address
24505 held in a register.  This allows the location of constant data to be
24506 determined at run time without requiring the executable to be
24507 relocated, which is a benefit to embedded applications with tight
24508 memory constraints.  Data that can be modified is not affected by this
24509 option.
24511 Note, using this feature reserves a register, usually @code{r13}, for
24512 the constant data base address.  This can result in slower and/or
24513 larger code, especially in complicated functions.
24515 The actual register chosen to hold the constant data base address
24516 depends upon whether the @option{-msmall-data-limit} and/or the
24517 @option{-mint-register} command-line options are enabled.  Starting
24518 with register @code{r13} and proceeding downwards, registers are
24519 allocated first to satisfy the requirements of @option{-mint-register},
24520 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
24521 is possible for the small data area register to be @code{r8} if both
24522 @option{-mint-register=4} and @option{-mpid} are specified on the
24523 command line.
24525 By default this feature is not enabled.  The default can be restored
24526 via the @option{-mno-pid} command-line option.
24528 @item -mno-warn-multiple-fast-interrupts
24529 @itemx -mwarn-multiple-fast-interrupts
24530 @opindex mno-warn-multiple-fast-interrupts
24531 @opindex mwarn-multiple-fast-interrupts
24532 Prevents GCC from issuing a warning message if it finds more than one
24533 fast interrupt handler when it is compiling a file.  The default is to
24534 issue a warning for each extra fast interrupt handler found, as the RX
24535 only supports one such interrupt.
24537 @item -mallow-string-insns
24538 @itemx -mno-allow-string-insns
24539 @opindex mallow-string-insns
24540 @opindex mno-allow-string-insns
24541 Enables or disables the use of the string manipulation instructions
24542 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
24543 @code{SWHILE} and also the @code{RMPA} instruction.  These
24544 instructions may prefetch data, which is not safe to do if accessing
24545 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
24546 for more information).
24548 The default is to allow these instructions, but it is not possible for
24549 GCC to reliably detect all circumstances where a string instruction
24550 might be used to access an I/O register, so their use cannot be
24551 disabled automatically.  Instead it is reliant upon the programmer to
24552 use the @option{-mno-allow-string-insns} option if their program
24553 accesses I/O space.
24555 When the instructions are enabled GCC defines the C preprocessor
24556 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
24557 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
24559 @item -mjsr
24560 @itemx -mno-jsr
24561 @opindex mjsr
24562 @opindex mno-jsr
24563 Use only (or not only) @code{JSR} instructions to access functions.
24564 This option can be used when code size exceeds the range of @code{BSR}
24565 instructions.  Note that @option{-mno-jsr} does not mean to not use
24566 @code{JSR} but instead means that any type of branch may be used.
24567 @end table
24569 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
24570 has special significance to the RX port when used with the
24571 @code{interrupt} function attribute.  This attribute indicates a
24572 function intended to process fast interrupts.  GCC ensures
24573 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
24574 and/or @code{r13} and only provided that the normal use of the
24575 corresponding registers have been restricted via the
24576 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
24577 options.
24579 @node S/390 and zSeries Options
24580 @subsection S/390 and zSeries Options
24581 @cindex S/390 and zSeries Options
24583 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
24585 @table @gcctabopt
24586 @item -mhard-float
24587 @itemx -msoft-float
24588 @opindex mhard-float
24589 @opindex msoft-float
24590 Use (do not use) the hardware floating-point instructions and registers
24591 for floating-point operations.  When @option{-msoft-float} is specified,
24592 functions in @file{libgcc.a} are used to perform floating-point
24593 operations.  When @option{-mhard-float} is specified, the compiler
24594 generates IEEE floating-point instructions.  This is the default.
24596 @item -mhard-dfp
24597 @itemx -mno-hard-dfp
24598 @opindex mhard-dfp
24599 @opindex mno-hard-dfp
24600 Use (do not use) the hardware decimal-floating-point instructions for
24601 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
24602 specified, functions in @file{libgcc.a} are used to perform
24603 decimal-floating-point operations.  When @option{-mhard-dfp} is
24604 specified, the compiler generates decimal-floating-point hardware
24605 instructions.  This is the default for @option{-march=z9-ec} or higher.
24607 @item -mlong-double-64
24608 @itemx -mlong-double-128
24609 @opindex mlong-double-64
24610 @opindex mlong-double-128
24611 These switches control the size of @code{long double} type. A size
24612 of 64 bits makes the @code{long double} type equivalent to the @code{double}
24613 type. This is the default.
24615 @item -mbackchain
24616 @itemx -mno-backchain
24617 @opindex mbackchain
24618 @opindex mno-backchain
24619 Store (do not store) the address of the caller's frame as backchain pointer
24620 into the callee's stack frame.
24621 A backchain may be needed to allow debugging using tools that do not understand
24622 DWARF call frame information.
24623 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
24624 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
24625 the backchain is placed into the topmost word of the 96/160 byte register
24626 save area.
24628 In general, code compiled with @option{-mbackchain} is call-compatible with
24629 code compiled with @option{-mmo-backchain}; however, use of the backchain
24630 for debugging purposes usually requires that the whole binary is built with
24631 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
24632 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24633 to build a linux kernel use @option{-msoft-float}.
24635 The default is to not maintain the backchain.
24637 @item -mpacked-stack
24638 @itemx -mno-packed-stack
24639 @opindex mpacked-stack
24640 @opindex mno-packed-stack
24641 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
24642 specified, the compiler uses the all fields of the 96/160 byte register save
24643 area only for their default purpose; unused fields still take up stack space.
24644 When @option{-mpacked-stack} is specified, register save slots are densely
24645 packed at the top of the register save area; unused space is reused for other
24646 purposes, allowing for more efficient use of the available stack space.
24647 However, when @option{-mbackchain} is also in effect, the topmost word of
24648 the save area is always used to store the backchain, and the return address
24649 register is always saved two words below the backchain.
24651 As long as the stack frame backchain is not used, code generated with
24652 @option{-mpacked-stack} is call-compatible with code generated with
24653 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
24654 S/390 or zSeries generated code that uses the stack frame backchain at run
24655 time, not just for debugging purposes.  Such code is not call-compatible
24656 with code compiled with @option{-mpacked-stack}.  Also, note that the
24657 combination of @option{-mbackchain},
24658 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
24659 to build a linux kernel use @option{-msoft-float}.
24661 The default is to not use the packed stack layout.
24663 @item -msmall-exec
24664 @itemx -mno-small-exec
24665 @opindex msmall-exec
24666 @opindex mno-small-exec
24667 Generate (or do not generate) code using the @code{bras} instruction
24668 to do subroutine calls.
24669 This only works reliably if the total executable size does not
24670 exceed 64k.  The default is to use the @code{basr} instruction instead,
24671 which does not have this limitation.
24673 @item -m64
24674 @itemx -m31
24675 @opindex m64
24676 @opindex m31
24677 When @option{-m31} is specified, generate code compliant to the
24678 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
24679 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
24680 particular to generate 64-bit instructions.  For the @samp{s390}
24681 targets, the default is @option{-m31}, while the @samp{s390x}
24682 targets default to @option{-m64}.
24684 @item -mzarch
24685 @itemx -mesa
24686 @opindex mzarch
24687 @opindex mesa
24688 When @option{-mzarch} is specified, generate code using the
24689 instructions available on z/Architecture.
24690 When @option{-mesa} is specified, generate code using the
24691 instructions available on ESA/390.  Note that @option{-mesa} is
24692 not possible with @option{-m64}.
24693 When generating code compliant to the GNU/Linux for S/390 ABI,
24694 the default is @option{-mesa}.  When generating code compliant
24695 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
24697 @item -mhtm
24698 @itemx -mno-htm
24699 @opindex mhtm
24700 @opindex mno-htm
24701 The @option{-mhtm} option enables a set of builtins making use of
24702 instructions available with the transactional execution facility
24703 introduced with the IBM zEnterprise EC12 machine generation
24704 @ref{S/390 System z Built-in Functions}.
24705 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
24707 @item -mvx
24708 @itemx -mno-vx
24709 @opindex mvx
24710 @opindex mno-vx
24711 When @option{-mvx} is specified, generate code using the instructions
24712 available with the vector extension facility introduced with the IBM
24713 z13 machine generation.
24714 This option changes the ABI for some vector type values with regard to
24715 alignment and calling conventions.  In case vector type values are
24716 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
24717 command will be added to mark the resulting binary with the ABI used.
24718 @option{-mvx} is enabled by default when using @option{-march=z13}.
24720 @item -mzvector
24721 @itemx -mno-zvector
24722 @opindex mzvector
24723 @opindex mno-zvector
24724 The @option{-mzvector} option enables vector language extensions and
24725 builtins using instructions available with the vector extension
24726 facility introduced with the IBM z13 machine generation.
24727 This option adds support for @samp{vector} to be used as a keyword to
24728 define vector type variables and arguments.  @samp{vector} is only
24729 available when GNU extensions are enabled.  It will not be expanded
24730 when requesting strict standard compliance e.g. with @option{-std=c99}.
24731 In addition to the GCC low-level builtins @option{-mzvector} enables
24732 a set of builtins added for compatibility with AltiVec-style
24733 implementations like Power and Cell.  In order to make use of these
24734 builtins the header file @file{vecintrin.h} needs to be included.
24735 @option{-mzvector} is disabled by default.
24737 @item -mmvcle
24738 @itemx -mno-mvcle
24739 @opindex mmvcle
24740 @opindex mno-mvcle
24741 Generate (or do not generate) code using the @code{mvcle} instruction
24742 to perform block moves.  When @option{-mno-mvcle} is specified,
24743 use a @code{mvc} loop instead.  This is the default unless optimizing for
24744 size.
24746 @item -mdebug
24747 @itemx -mno-debug
24748 @opindex mdebug
24749 @opindex mno-debug
24750 Print (or do not print) additional debug information when compiling.
24751 The default is to not print debug information.
24753 @item -march=@var{cpu-type}
24754 @opindex march
24755 Generate code that runs on @var{cpu-type}, which is the name of a
24756 system representing a certain processor type.  Possible values for
24757 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
24758 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
24759 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
24760 @samp{native}.
24762 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
24763 @samp{g6} are deprecated and will be removed with future releases.
24765 Specifying @samp{native} as cpu type can be used to select the best
24766 architecture option for the host processor.
24767 @option{-march=native} has no effect if GCC does not recognize the
24768 processor.
24770 @item -mtune=@var{cpu-type}
24771 @opindex mtune
24772 Tune to @var{cpu-type} everything applicable about the generated code,
24773 except for the ABI and the set of available instructions.
24774 The list of @var{cpu-type} values is the same as for @option{-march}.
24775 The default is the value used for @option{-march}.
24777 @item -mtpf-trace
24778 @itemx -mno-tpf-trace
24779 @opindex mtpf-trace
24780 @opindex mno-tpf-trace
24781 Generate code that adds (does not add) in TPF OS specific branches to trace
24782 routines in the operating system.  This option is off by default, even
24783 when compiling for the TPF OS@.
24785 @item -mfused-madd
24786 @itemx -mno-fused-madd
24787 @opindex mfused-madd
24788 @opindex mno-fused-madd
24789 Generate code that uses (does not use) the floating-point multiply and
24790 accumulate instructions.  These instructions are generated by default if
24791 hardware floating point is used.
24793 @item -mwarn-framesize=@var{framesize}
24794 @opindex mwarn-framesize
24795 Emit a warning if the current function exceeds the given frame size.  Because
24796 this is a compile-time check it doesn't need to be a real problem when the program
24797 runs.  It is intended to identify functions that most probably cause
24798 a stack overflow.  It is useful to be used in an environment with limited stack
24799 size e.g.@: the linux kernel.
24801 @item -mwarn-dynamicstack
24802 @opindex mwarn-dynamicstack
24803 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
24804 arrays.  This is generally a bad idea with a limited stack size.
24806 @item -mstack-guard=@var{stack-guard}
24807 @itemx -mstack-size=@var{stack-size}
24808 @opindex mstack-guard
24809 @opindex mstack-size
24810 If these options are provided the S/390 back end emits additional instructions in
24811 the function prologue that trigger a trap if the stack size is @var{stack-guard}
24812 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
24813 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
24814 the frame size of the compiled function is chosen.
24815 These options are intended to be used to help debugging stack overflow problems.
24816 The additionally emitted code causes only little overhead and hence can also be
24817 used in production-like systems without greater performance degradation.  The given
24818 values have to be exact powers of 2 and @var{stack-size} has to be greater than
24819 @var{stack-guard} without exceeding 64k.
24820 In order to be efficient the extra code makes the assumption that the stack starts
24821 at an address aligned to the value given by @var{stack-size}.
24822 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
24824 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
24825 @opindex mhotpatch
24826 If the hotpatch option is enabled, a ``hot-patching'' function
24827 prologue is generated for all functions in the compilation unit.
24828 The funtion label is prepended with the given number of two-byte
24829 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
24830 the label, 2 * @var{post-halfwords} bytes are appended, using the
24831 largest NOP like instructions the architecture allows (maximum
24832 1000000).
24834 If both arguments are zero, hotpatching is disabled.
24836 This option can be overridden for individual functions with the
24837 @code{hotpatch} attribute.
24838 @end table
24840 @node Score Options
24841 @subsection Score Options
24842 @cindex Score Options
24844 These options are defined for Score implementations:
24846 @table @gcctabopt
24847 @item -meb
24848 @opindex meb
24849 Compile code for big-endian mode.  This is the default.
24851 @item -mel
24852 @opindex mel
24853 Compile code for little-endian mode.
24855 @item -mnhwloop
24856 @opindex mnhwloop
24857 Disable generation of @code{bcnz} instructions.
24859 @item -muls
24860 @opindex muls
24861 Enable generation of unaligned load and store instructions.
24863 @item -mmac
24864 @opindex mmac
24865 Enable the use of multiply-accumulate instructions. Disabled by default.
24867 @item -mscore5
24868 @opindex mscore5
24869 Specify the SCORE5 as the target architecture.
24871 @item -mscore5u
24872 @opindex mscore5u
24873 Specify the SCORE5U of the target architecture.
24875 @item -mscore7
24876 @opindex mscore7
24877 Specify the SCORE7 as the target architecture. This is the default.
24879 @item -mscore7d
24880 @opindex mscore7d
24881 Specify the SCORE7D as the target architecture.
24882 @end table
24884 @node SH Options
24885 @subsection SH Options
24887 These @samp{-m} options are defined for the SH implementations:
24889 @table @gcctabopt
24890 @item -m1
24891 @opindex m1
24892 Generate code for the SH1.
24894 @item -m2
24895 @opindex m2
24896 Generate code for the SH2.
24898 @item -m2e
24899 Generate code for the SH2e.
24901 @item -m2a-nofpu
24902 @opindex m2a-nofpu
24903 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
24904 that the floating-point unit is not used.
24906 @item -m2a-single-only
24907 @opindex m2a-single-only
24908 Generate code for the SH2a-FPU, in such a way that no double-precision
24909 floating-point operations are used.
24911 @item -m2a-single
24912 @opindex m2a-single
24913 Generate code for the SH2a-FPU assuming the floating-point unit is in
24914 single-precision mode by default.
24916 @item -m2a
24917 @opindex m2a
24918 Generate code for the SH2a-FPU assuming the floating-point unit is in
24919 double-precision mode by default.
24921 @item -m3
24922 @opindex m3
24923 Generate code for the SH3.
24925 @item -m3e
24926 @opindex m3e
24927 Generate code for the SH3e.
24929 @item -m4-nofpu
24930 @opindex m4-nofpu
24931 Generate code for the SH4 without a floating-point unit.
24933 @item -m4-single-only
24934 @opindex m4-single-only
24935 Generate code for the SH4 with a floating-point unit that only
24936 supports single-precision arithmetic.
24938 @item -m4-single
24939 @opindex m4-single
24940 Generate code for the SH4 assuming the floating-point unit is in
24941 single-precision mode by default.
24943 @item -m4
24944 @opindex m4
24945 Generate code for the SH4.
24947 @item -m4-100
24948 @opindex m4-100
24949 Generate code for SH4-100.
24951 @item -m4-100-nofpu
24952 @opindex m4-100-nofpu
24953 Generate code for SH4-100 in such a way that the
24954 floating-point unit is not used.
24956 @item -m4-100-single
24957 @opindex m4-100-single
24958 Generate code for SH4-100 assuming the floating-point unit is in
24959 single-precision mode by default.
24961 @item -m4-100-single-only
24962 @opindex m4-100-single-only
24963 Generate code for SH4-100 in such a way that no double-precision
24964 floating-point operations are used.
24966 @item -m4-200
24967 @opindex m4-200
24968 Generate code for SH4-200.
24970 @item -m4-200-nofpu
24971 @opindex m4-200-nofpu
24972 Generate code for SH4-200 without in such a way that the
24973 floating-point unit is not used.
24975 @item -m4-200-single
24976 @opindex m4-200-single
24977 Generate code for SH4-200 assuming the floating-point unit is in
24978 single-precision mode by default.
24980 @item -m4-200-single-only
24981 @opindex m4-200-single-only
24982 Generate code for SH4-200 in such a way that no double-precision
24983 floating-point operations are used.
24985 @item -m4-300
24986 @opindex m4-300
24987 Generate code for SH4-300.
24989 @item -m4-300-nofpu
24990 @opindex m4-300-nofpu
24991 Generate code for SH4-300 without in such a way that the
24992 floating-point unit is not used.
24994 @item -m4-300-single
24995 @opindex m4-300-single
24996 Generate code for SH4-300 in such a way that no double-precision
24997 floating-point operations are used.
24999 @item -m4-300-single-only
25000 @opindex m4-300-single-only
25001 Generate code for SH4-300 in such a way that no double-precision
25002 floating-point operations are used.
25004 @item -m4-340
25005 @opindex m4-340
25006 Generate code for SH4-340 (no MMU, no FPU).
25008 @item -m4-500
25009 @opindex m4-500
25010 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
25011 assembler.
25013 @item -m4a-nofpu
25014 @opindex m4a-nofpu
25015 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
25016 floating-point unit is not used.
25018 @item -m4a-single-only
25019 @opindex m4a-single-only
25020 Generate code for the SH4a, in such a way that no double-precision
25021 floating-point operations are used.
25023 @item -m4a-single
25024 @opindex m4a-single
25025 Generate code for the SH4a assuming the floating-point unit is in
25026 single-precision mode by default.
25028 @item -m4a
25029 @opindex m4a
25030 Generate code for the SH4a.
25032 @item -m4al
25033 @opindex m4al
25034 Same as @option{-m4a-nofpu}, except that it implicitly passes
25035 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
25036 instructions at the moment.
25038 @item -mb
25039 @opindex mb
25040 Compile code for the processor in big-endian mode.
25042 @item -ml
25043 @opindex ml
25044 Compile code for the processor in little-endian mode.
25046 @item -mdalign
25047 @opindex mdalign
25048 Align doubles at 64-bit boundaries.  Note that this changes the calling
25049 conventions, and thus some functions from the standard C library do
25050 not work unless you recompile it first with @option{-mdalign}.
25052 @item -mrelax
25053 @opindex mrelax
25054 Shorten some address references at link time, when possible; uses the
25055 linker option @option{-relax}.
25057 @item -mbigtable
25058 @opindex mbigtable
25059 Use 32-bit offsets in @code{switch} tables.  The default is to use
25060 16-bit offsets.
25062 @item -mbitops
25063 @opindex mbitops
25064 Enable the use of bit manipulation instructions on SH2A.
25066 @item -mfmovd
25067 @opindex mfmovd
25068 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
25069 alignment constraints.
25071 @item -mrenesas
25072 @opindex mrenesas
25073 Comply with the calling conventions defined by Renesas.
25075 @item -mno-renesas
25076 @opindex mno-renesas
25077 Comply with the calling conventions defined for GCC before the Renesas
25078 conventions were available.  This option is the default for all
25079 targets of the SH toolchain.
25081 @item -mnomacsave
25082 @opindex mnomacsave
25083 Mark the @code{MAC} register as call-clobbered, even if
25084 @option{-mrenesas} is given.
25086 @item -mieee
25087 @itemx -mno-ieee
25088 @opindex mieee
25089 @opindex mno-ieee
25090 Control the IEEE compliance of floating-point comparisons, which affects the
25091 handling of cases where the result of a comparison is unordered.  By default
25092 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
25093 enabled @option{-mno-ieee} is implicitly set, which results in faster
25094 floating-point greater-equal and less-equal comparisons.  The implicit settings
25095 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
25097 @item -minline-ic_invalidate
25098 @opindex minline-ic_invalidate
25099 Inline code to invalidate instruction cache entries after setting up
25100 nested function trampolines.
25101 This option has no effect if @option{-musermode} is in effect and the selected
25102 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
25103 instruction.
25104 If the selected code generation option does not allow the use of the @code{icbi}
25105 instruction, and @option{-musermode} is not in effect, the inlined code
25106 manipulates the instruction cache address array directly with an associative
25107 write.  This not only requires privileged mode at run time, but it also
25108 fails if the cache line had been mapped via the TLB and has become unmapped.
25110 @item -misize
25111 @opindex misize
25112 Dump instruction size and location in the assembly code.
25114 @item -mpadstruct
25115 @opindex mpadstruct
25116 This option is deprecated.  It pads structures to multiple of 4 bytes,
25117 which is incompatible with the SH ABI@.
25119 @item -matomic-model=@var{model}
25120 @opindex matomic-model=@var{model}
25121 Sets the model of atomic operations and additional parameters as a comma
25122 separated list.  For details on the atomic built-in functions see
25123 @ref{__atomic Builtins}.  The following models and parameters are supported:
25125 @table @samp
25127 @item none
25128 Disable compiler generated atomic sequences and emit library calls for atomic
25129 operations.  This is the default if the target is not @code{sh*-*-linux*}.
25131 @item soft-gusa
25132 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
25133 built-in functions.  The generated atomic sequences require additional support
25134 from the interrupt/exception handling code of the system and are only suitable
25135 for SH3* and SH4* single-core systems.  This option is enabled by default when
25136 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
25137 this option also partially utilizes the hardware atomic instructions
25138 @code{movli.l} and @code{movco.l} to create more efficient code, unless
25139 @samp{strict} is specified.  
25141 @item soft-tcb
25142 Generate software atomic sequences that use a variable in the thread control
25143 block.  This is a variation of the gUSA sequences which can also be used on
25144 SH1* and SH2* targets.  The generated atomic sequences require additional
25145 support from the interrupt/exception handling code of the system and are only
25146 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
25147 parameter has to be specified as well.
25149 @item soft-imask
25150 Generate software atomic sequences that temporarily disable interrupts by
25151 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
25152 in privileged mode and is only suitable for single-core systems.  Additional
25153 support from the interrupt/exception handling code of the system is not
25154 required.  This model is enabled by default when the target is
25155 @code{sh*-*-linux*} and SH1* or SH2*.
25157 @item hard-llcs
25158 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
25159 instructions only.  This is only available on SH4A and is suitable for
25160 multi-core systems.  Since the hardware instructions support only 32 bit atomic
25161 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
25162 Code compiled with this option is also compatible with other software
25163 atomic model interrupt/exception handling systems if executed on an SH4A
25164 system.  Additional support from the interrupt/exception handling code of the
25165 system is not required for this model.
25167 @item gbr-offset=
25168 This parameter specifies the offset in bytes of the variable in the thread
25169 control block structure that should be used by the generated atomic sequences
25170 when the @samp{soft-tcb} model has been selected.  For other models this
25171 parameter is ignored.  The specified value must be an integer multiple of four
25172 and in the range 0-1020.
25174 @item strict
25175 This parameter prevents mixed usage of multiple atomic models, even if they
25176 are compatible, and makes the compiler generate atomic sequences of the
25177 specified model only.
25179 @end table
25181 @item -mtas
25182 @opindex mtas
25183 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
25184 Notice that depending on the particular hardware and software configuration
25185 this can degrade overall performance due to the operand cache line flushes
25186 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
25187 processors the @code{tas.b} instruction must be used with caution since it
25188 can result in data corruption for certain cache configurations.
25190 @item -mprefergot
25191 @opindex mprefergot
25192 When generating position-independent code, emit function calls using
25193 the Global Offset Table instead of the Procedure Linkage Table.
25195 @item -musermode
25196 @itemx -mno-usermode
25197 @opindex musermode
25198 @opindex mno-usermode
25199 Don't allow (allow) the compiler generating privileged mode code.  Specifying
25200 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
25201 inlined code would not work in user mode.  @option{-musermode} is the default
25202 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
25203 @option{-musermode} has no effect, since there is no user mode.
25205 @item -multcost=@var{number}
25206 @opindex multcost=@var{number}
25207 Set the cost to assume for a multiply insn.
25209 @item -mdiv=@var{strategy}
25210 @opindex mdiv=@var{strategy}
25211 Set the division strategy to be used for integer division operations.
25212 @var{strategy} can be one of: 
25214 @table @samp
25216 @item call-div1
25217 Calls a library function that uses the single-step division instruction
25218 @code{div1} to perform the operation.  Division by zero calculates an
25219 unspecified result and does not trap.  This is the default except for SH4,
25220 SH2A and SHcompact.
25222 @item call-fp
25223 Calls a library function that performs the operation in double precision
25224 floating point.  Division by zero causes a floating-point exception.  This is
25225 the default for SHcompact with FPU.  Specifying this for targets that do not
25226 have a double precision FPU defaults to @code{call-div1}.
25228 @item call-table
25229 Calls a library function that uses a lookup table for small divisors and
25230 the @code{div1} instruction with case distinction for larger divisors.  Division
25231 by zero calculates an unspecified result and does not trap.  This is the default
25232 for SH4.  Specifying this for targets that do not have dynamic shift
25233 instructions defaults to @code{call-div1}.
25235 @end table
25237 When a division strategy has not been specified the default strategy is
25238 selected based on the current target.  For SH2A the default strategy is to
25239 use the @code{divs} and @code{divu} instructions instead of library function
25240 calls.
25242 @item -maccumulate-outgoing-args
25243 @opindex maccumulate-outgoing-args
25244 Reserve space once for outgoing arguments in the function prologue rather
25245 than around each call.  Generally beneficial for performance and size.  Also
25246 needed for unwinding to avoid changing the stack frame around conditional code.
25248 @item -mdivsi3_libfunc=@var{name}
25249 @opindex mdivsi3_libfunc=@var{name}
25250 Set the name of the library function used for 32-bit signed division to
25251 @var{name}.
25252 This only affects the name used in the @samp{call} division strategies, and
25253 the compiler still expects the same sets of input/output/clobbered registers as
25254 if this option were not present.
25256 @item -mfixed-range=@var{register-range}
25257 @opindex mfixed-range
25258 Generate code treating the given register range as fixed registers.
25259 A fixed register is one that the register allocator can not use.  This is
25260 useful when compiling kernel code.  A register range is specified as
25261 two registers separated by a dash.  Multiple register ranges can be
25262 specified separated by a comma.
25264 @item -mbranch-cost=@var{num}
25265 @opindex mbranch-cost=@var{num}
25266 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
25267 make the compiler try to generate more branch-free code if possible.  
25268 If not specified the value is selected depending on the processor type that
25269 is being compiled for.
25271 @item -mzdcbranch
25272 @itemx -mno-zdcbranch
25273 @opindex mzdcbranch
25274 @opindex mno-zdcbranch
25275 Assume (do not assume) that zero displacement conditional branch instructions
25276 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
25277 compiler prefers zero displacement branch code sequences.  This is
25278 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
25279 disabled by specifying @option{-mno-zdcbranch}.
25281 @item -mcbranch-force-delay-slot
25282 @opindex mcbranch-force-delay-slot
25283 Force the usage of delay slots for conditional branches, which stuffs the delay
25284 slot with a @code{nop} if a suitable instruction cannot be found.  By default
25285 this option is disabled.  It can be enabled to work around hardware bugs as
25286 found in the original SH7055.
25288 @item -mfused-madd
25289 @itemx -mno-fused-madd
25290 @opindex mfused-madd
25291 @opindex mno-fused-madd
25292 Generate code that uses (does not use) the floating-point multiply and
25293 accumulate instructions.  These instructions are generated by default
25294 if hardware floating point is used.  The machine-dependent
25295 @option{-mfused-madd} option is now mapped to the machine-independent
25296 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
25297 mapped to @option{-ffp-contract=off}.
25299 @item -mfsca
25300 @itemx -mno-fsca
25301 @opindex mfsca
25302 @opindex mno-fsca
25303 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
25304 and cosine approximations.  The option @option{-mfsca} must be used in
25305 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
25306 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
25307 approximations even if @option{-funsafe-math-optimizations} is in effect.
25309 @item -mfsrra
25310 @itemx -mno-fsrra
25311 @opindex mfsrra
25312 @opindex mno-fsrra
25313 Allow or disallow the compiler to emit the @code{fsrra} instruction for
25314 reciprocal square root approximations.  The option @option{-mfsrra} must be used
25315 in combination with @option{-funsafe-math-optimizations} and
25316 @option{-ffinite-math-only}.  It is enabled by default when generating code for
25317 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
25318 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
25319 in effect.
25321 @item -mpretend-cmove
25322 @opindex mpretend-cmove
25323 Prefer zero-displacement conditional branches for conditional move instruction
25324 patterns.  This can result in faster code on the SH4 processor.
25326 @item -mfdpic
25327 @opindex fdpic
25328 Generate code using the FDPIC ABI.
25330 @end table
25332 @node Solaris 2 Options
25333 @subsection Solaris 2 Options
25334 @cindex Solaris 2 options
25336 These @samp{-m} options are supported on Solaris 2:
25338 @table @gcctabopt
25339 @item -mclear-hwcap
25340 @opindex mclear-hwcap
25341 @option{-mclear-hwcap} tells the compiler to remove the hardware
25342 capabilities generated by the Solaris assembler.  This is only necessary
25343 when object files use ISA extensions not supported by the current
25344 machine, but check at runtime whether or not to use them.
25346 @item -mimpure-text
25347 @opindex mimpure-text
25348 @option{-mimpure-text}, used in addition to @option{-shared}, tells
25349 the compiler to not pass @option{-z text} to the linker when linking a
25350 shared object.  Using this option, you can link position-dependent
25351 code into a shared object.
25353 @option{-mimpure-text} suppresses the ``relocations remain against
25354 allocatable but non-writable sections'' linker error message.
25355 However, the necessary relocations trigger copy-on-write, and the
25356 shared object is not actually shared across processes.  Instead of
25357 using @option{-mimpure-text}, you should compile all source code with
25358 @option{-fpic} or @option{-fPIC}.
25360 @end table
25362 These switches are supported in addition to the above on Solaris 2:
25364 @table @gcctabopt
25365 @item -pthreads
25366 @opindex pthreads
25367 This is a synonym for @option{-pthread}.
25368 @end table
25370 @node SPARC Options
25371 @subsection SPARC Options
25372 @cindex SPARC options
25374 These @samp{-m} options are supported on the SPARC:
25376 @table @gcctabopt
25377 @item -mno-app-regs
25378 @itemx -mapp-regs
25379 @opindex mno-app-regs
25380 @opindex mapp-regs
25381 Specify @option{-mapp-regs} to generate output using the global registers
25382 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
25383 global register 1, each global register 2 through 4 is then treated as an
25384 allocable register that is clobbered by function calls.  This is the default.
25386 To be fully SVR4 ABI-compliant at the cost of some performance loss,
25387 specify @option{-mno-app-regs}.  You should compile libraries and system
25388 software with this option.
25390 @item -mflat
25391 @itemx -mno-flat
25392 @opindex mflat
25393 @opindex mno-flat
25394 With @option{-mflat}, the compiler does not generate save/restore instructions
25395 and uses a ``flat'' or single register window model.  This model is compatible
25396 with the regular register window model.  The local registers and the input
25397 registers (0--5) are still treated as ``call-saved'' registers and are
25398 saved on the stack as needed.
25400 With @option{-mno-flat} (the default), the compiler generates save/restore
25401 instructions (except for leaf functions).  This is the normal operating mode.
25403 @item -mfpu
25404 @itemx -mhard-float
25405 @opindex mfpu
25406 @opindex mhard-float
25407 Generate output containing floating-point instructions.  This is the
25408 default.
25410 @item -mno-fpu
25411 @itemx -msoft-float
25412 @opindex mno-fpu
25413 @opindex msoft-float
25414 Generate output containing library calls for floating point.
25415 @strong{Warning:} the requisite libraries are not available for all SPARC
25416 targets.  Normally the facilities of the machine's usual C compiler are
25417 used, but this cannot be done directly in cross-compilation.  You must make
25418 your own arrangements to provide suitable library functions for
25419 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
25420 @samp{sparclite-*-*} do provide software floating-point support.
25422 @option{-msoft-float} changes the calling convention in the output file;
25423 therefore, it is only useful if you compile @emph{all} of a program with
25424 this option.  In particular, you need to compile @file{libgcc.a}, the
25425 library that comes with GCC, with @option{-msoft-float} in order for
25426 this to work.
25428 @item -mhard-quad-float
25429 @opindex mhard-quad-float
25430 Generate output containing quad-word (long double) floating-point
25431 instructions.
25433 @item -msoft-quad-float
25434 @opindex msoft-quad-float
25435 Generate output containing library calls for quad-word (long double)
25436 floating-point instructions.  The functions called are those specified
25437 in the SPARC ABI@.  This is the default.
25439 As of this writing, there are no SPARC implementations that have hardware
25440 support for the quad-word floating-point instructions.  They all invoke
25441 a trap handler for one of these instructions, and then the trap handler
25442 emulates the effect of the instruction.  Because of the trap handler overhead,
25443 this is much slower than calling the ABI library routines.  Thus the
25444 @option{-msoft-quad-float} option is the default.
25446 @item -mno-unaligned-doubles
25447 @itemx -munaligned-doubles
25448 @opindex mno-unaligned-doubles
25449 @opindex munaligned-doubles
25450 Assume that doubles have 8-byte alignment.  This is the default.
25452 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
25453 alignment only if they are contained in another type, or if they have an
25454 absolute address.  Otherwise, it assumes they have 4-byte alignment.
25455 Specifying this option avoids some rare compatibility problems with code
25456 generated by other compilers.  It is not the default because it results
25457 in a performance loss, especially for floating-point code.
25459 @item -muser-mode
25460 @itemx -mno-user-mode
25461 @opindex muser-mode
25462 @opindex mno-user-mode
25463 Do not generate code that can only run in supervisor mode.  This is relevant
25464 only for the @code{casa} instruction emitted for the LEON3 processor.  This
25465 is the default.
25467 @item -mfaster-structs
25468 @itemx -mno-faster-structs
25469 @opindex mfaster-structs
25470 @opindex mno-faster-structs
25471 With @option{-mfaster-structs}, the compiler assumes that structures
25472 should have 8-byte alignment.  This enables the use of pairs of
25473 @code{ldd} and @code{std} instructions for copies in structure
25474 assignment, in place of twice as many @code{ld} and @code{st} pairs.
25475 However, the use of this changed alignment directly violates the SPARC
25476 ABI@.  Thus, it's intended only for use on targets where the developer
25477 acknowledges that their resulting code is not directly in line with
25478 the rules of the ABI@.
25480 @item -mstd-struct-return
25481 @itemx -mno-std-struct-return
25482 @opindex mstd-struct-return
25483 @opindex mno-std-struct-return
25484 With @option{-mstd-struct-return}, the compiler generates checking code
25485 in functions returning structures or unions to detect size mismatches
25486 between the two sides of function calls, as per the 32-bit ABI@.
25488 The default is @option{-mno-std-struct-return}.  This option has no effect
25489 in 64-bit mode.
25491 @item -mlra
25492 @itemx -mno-lra
25493 @opindex mlra
25494 @opindex mno-lra
25495 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
25496 so @option{-mno-lra} needs to be passed to get old Reload.
25498 @item -mcpu=@var{cpu_type}
25499 @opindex mcpu
25500 Set the instruction set, register set, and instruction scheduling parameters
25501 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25502 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
25503 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
25504 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
25505 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
25506 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
25508 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
25509 which selects the best architecture option for the host processor.
25510 @option{-mcpu=native} has no effect if GCC does not recognize
25511 the processor.
25513 Default instruction scheduling parameters are used for values that select
25514 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
25515 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
25517 Here is a list of each supported architecture and their supported
25518 implementations.
25520 @table @asis
25521 @item v7
25522 cypress, leon3v7
25524 @item v8
25525 supersparc, hypersparc, leon, leon3
25527 @item sparclite
25528 f930, f934, sparclite86x
25530 @item sparclet
25531 tsc701
25533 @item v9
25534 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
25535 niagara7, m8
25536 @end table
25538 By default (unless configured otherwise), GCC generates code for the V7
25539 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
25540 additionally optimizes it for the Cypress CY7C602 chip, as used in the
25541 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
25542 SPARCStation 1, 2, IPX etc.
25544 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
25545 architecture.  The only difference from V7 code is that the compiler emits
25546 the integer multiply and integer divide instructions which exist in SPARC-V8
25547 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
25548 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
25549 2000 series.
25551 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
25552 the SPARC architecture.  This adds the integer multiply, integer divide step
25553 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
25554 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
25555 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
25556 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
25557 MB86934 chip, which is the more recent SPARClite with FPU@.
25559 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
25560 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
25561 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
25562 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
25563 optimizes it for the TEMIC SPARClet chip.
25565 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
25566 architecture.  This adds 64-bit integer and floating-point move instructions,
25567 3 additional floating-point condition code registers and conditional move
25568 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
25569 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
25570 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
25571 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
25572 @option{-mcpu=niagara}, the compiler additionally optimizes it for
25573 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
25574 additionally optimizes it for Sun UltraSPARC T2 chips. With
25575 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
25576 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
25577 additionally optimizes it for Sun UltraSPARC T4 chips.  With
25578 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
25579 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
25580 additionally optimizes it for Oracle M8 chips.
25582 @item -mtune=@var{cpu_type}
25583 @opindex mtune
25584 Set the instruction scheduling parameters for machine type
25585 @var{cpu_type}, but do not set the instruction set or register set that the
25586 option @option{-mcpu=@var{cpu_type}} does.
25588 The same values for @option{-mcpu=@var{cpu_type}} can be used for
25589 @option{-mtune=@var{cpu_type}}, but the only useful values are those
25590 that select a particular CPU implementation.  Those are
25591 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
25592 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
25593 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
25594 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
25595 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
25596 and GNU/Linux toolchains, @samp{native} can also be used.
25598 @item -mv8plus
25599 @itemx -mno-v8plus
25600 @opindex mv8plus
25601 @opindex mno-v8plus
25602 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
25603 difference from the V8 ABI is that the global and out registers are
25604 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
25605 mode for all SPARC-V9 processors.
25607 @item -mvis
25608 @itemx -mno-vis
25609 @opindex mvis
25610 @opindex mno-vis
25611 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
25612 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
25614 @item -mvis2
25615 @itemx -mno-vis2
25616 @opindex mvis2
25617 @opindex mno-vis2
25618 With @option{-mvis2}, GCC generates code that takes advantage of
25619 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
25620 default is @option{-mvis2} when targeting a cpu that supports such
25621 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
25622 also sets @option{-mvis}.
25624 @item -mvis3
25625 @itemx -mno-vis3
25626 @opindex mvis3
25627 @opindex mno-vis3
25628 With @option{-mvis3}, GCC generates code that takes advantage of
25629 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
25630 default is @option{-mvis3} when targeting a cpu that supports such
25631 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
25632 also sets @option{-mvis2} and @option{-mvis}.
25634 @item -mvis4
25635 @itemx -mno-vis4
25636 @opindex mvis4
25637 @opindex mno-vis4
25638 With @option{-mvis4}, GCC generates code that takes advantage of
25639 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
25640 default is @option{-mvis4} when targeting a cpu that supports such
25641 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
25642 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
25644 @item -mvis4b
25645 @itemx -mno-vis4b
25646 @opindex mvis4b
25647 @opindex mno-vis4b
25648 With @option{-mvis4b}, GCC generates code that takes advantage of
25649 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
25650 the additional VIS instructions introduced in the Oracle SPARC
25651 Architecture 2017.  The default is @option{-mvis4b} when targeting a
25652 cpu that supports such instructions, such as m8 and later.  Setting
25653 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
25654 @option{-mvis2} and @option{-mvis}.
25656 @item -mcbcond
25657 @itemx -mno-cbcond
25658 @opindex mcbcond
25659 @opindex mno-cbcond
25660 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
25661 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
25662 when targeting a CPU that supports such instructions, such as Niagara-4 and
25663 later.
25665 @item -mfmaf
25666 @itemx -mno-fmaf
25667 @opindex mfmaf
25668 @opindex mno-fmaf
25669 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
25670 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
25671 when targeting a CPU that supports such instructions, such as Niagara-3 and
25672 later.
25674 @item -mfsmuld
25675 @itemx -mno-fsmuld
25676 @opindex mfsmuld
25677 @opindex mno-fsmuld
25678 With @option{-mfsmuld}, GCC generates code that takes advantage of the
25679 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
25680 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
25681 or V9 with FPU except @option{-mcpu=leon}.
25683 @item -mpopc
25684 @itemx -mno-popc
25685 @opindex mpopc
25686 @opindex mno-popc
25687 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
25688 Population Count instruction.  The default is @option{-mpopc}
25689 when targeting a CPU that supports such an instruction, such as Niagara-2 and
25690 later.
25692 @item -msubxc
25693 @itemx -mno-subxc
25694 @opindex msubxc
25695 @opindex mno-subxc
25696 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
25697 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
25698 when targeting a CPU that supports such an instruction, such as Niagara-7 and
25699 later.
25701 @item -mfix-at697f
25702 @opindex mfix-at697f
25703 Enable the documented workaround for the single erratum of the Atmel AT697F
25704 processor (which corresponds to erratum #13 of the AT697E processor).
25706 @item -mfix-ut699
25707 @opindex mfix-ut699
25708 Enable the documented workarounds for the floating-point errata and the data
25709 cache nullify errata of the UT699 processor.
25711 @item -mfix-ut700
25712 @opindex mfix-ut700
25713 Enable the documented workaround for the back-to-back store errata of
25714 the UT699E/UT700 processor.
25716 @item -mfix-gr712rc
25717 @opindex mfix-gr712rc
25718 Enable the documented workaround for the back-to-back store errata of
25719 the GR712RC processor.
25720 @end table
25722 These @samp{-m} options are supported in addition to the above
25723 on SPARC-V9 processors in 64-bit environments:
25725 @table @gcctabopt
25726 @item -m32
25727 @itemx -m64
25728 @opindex m32
25729 @opindex m64
25730 Generate code for a 32-bit or 64-bit environment.
25731 The 32-bit environment sets int, long and pointer to 32 bits.
25732 The 64-bit environment sets int to 32 bits and long and pointer
25733 to 64 bits.
25735 @item -mcmodel=@var{which}
25736 @opindex mcmodel
25737 Set the code model to one of
25739 @table @samp
25740 @item medlow
25741 The Medium/Low code model: 64-bit addresses, programs
25742 must be linked in the low 32 bits of memory.  Programs can be statically
25743 or dynamically linked.
25745 @item medmid
25746 The Medium/Middle code model: 64-bit addresses, programs
25747 must be linked in the low 44 bits of memory, the text and data segments must
25748 be less than 2GB in size and the data segment must be located within 2GB of
25749 the text segment.
25751 @item medany
25752 The Medium/Anywhere code model: 64-bit addresses, programs
25753 may be linked anywhere in memory, the text and data segments must be less
25754 than 2GB in size and the data segment must be located within 2GB of the
25755 text segment.
25757 @item embmedany
25758 The Medium/Anywhere code model for embedded systems:
25759 64-bit addresses, the text and data segments must be less than 2GB in
25760 size, both starting anywhere in memory (determined at link time).  The
25761 global register %g4 points to the base of the data segment.  Programs
25762 are statically linked and PIC is not supported.
25763 @end table
25765 @item -mmemory-model=@var{mem-model}
25766 @opindex mmemory-model
25767 Set the memory model in force on the processor to one of
25769 @table @samp
25770 @item default
25771 The default memory model for the processor and operating system.
25773 @item rmo
25774 Relaxed Memory Order
25776 @item pso
25777 Partial Store Order
25779 @item tso
25780 Total Store Order
25782 @item sc
25783 Sequential Consistency
25784 @end table
25786 These memory models are formally defined in Appendix D of the SPARC-V9
25787 architecture manual, as set in the processor's @code{PSTATE.MM} field.
25789 @item -mstack-bias
25790 @itemx -mno-stack-bias
25791 @opindex mstack-bias
25792 @opindex mno-stack-bias
25793 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
25794 frame pointer if present, are offset by @minus{}2047 which must be added back
25795 when making stack frame references.  This is the default in 64-bit mode.
25796 Otherwise, assume no such offset is present.
25797 @end table
25799 @node SPU Options
25800 @subsection SPU Options
25801 @cindex SPU options
25803 These @samp{-m} options are supported on the SPU:
25805 @table @gcctabopt
25806 @item -mwarn-reloc
25807 @itemx -merror-reloc
25808 @opindex mwarn-reloc
25809 @opindex merror-reloc
25811 The loader for SPU does not handle dynamic relocations.  By default, GCC
25812 gives an error when it generates code that requires a dynamic
25813 relocation.  @option{-mno-error-reloc} disables the error,
25814 @option{-mwarn-reloc} generates a warning instead.
25816 @item -msafe-dma
25817 @itemx -munsafe-dma
25818 @opindex msafe-dma
25819 @opindex munsafe-dma
25821 Instructions that initiate or test completion of DMA must not be
25822 reordered with respect to loads and stores of the memory that is being
25823 accessed.
25824 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
25825 memory accesses, but that can lead to inefficient code in places where the
25826 memory is known to not change.  Rather than mark the memory as volatile,
25827 you can use @option{-msafe-dma} to tell the compiler to treat
25828 the DMA instructions as potentially affecting all memory.  
25830 @item -mbranch-hints
25831 @opindex mbranch-hints
25833 By default, GCC generates a branch hint instruction to avoid
25834 pipeline stalls for always-taken or probably-taken branches.  A hint
25835 is not generated closer than 8 instructions away from its branch.
25836 There is little reason to disable them, except for debugging purposes,
25837 or to make an object a little bit smaller.
25839 @item -msmall-mem
25840 @itemx -mlarge-mem
25841 @opindex msmall-mem
25842 @opindex mlarge-mem
25844 By default, GCC generates code assuming that addresses are never larger
25845 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
25846 a full 32-bit address.
25848 @item -mstdmain
25849 @opindex mstdmain
25851 By default, GCC links against startup code that assumes the SPU-style
25852 main function interface (which has an unconventional parameter list).
25853 With @option{-mstdmain}, GCC links your program against startup
25854 code that assumes a C99-style interface to @code{main}, including a
25855 local copy of @code{argv} strings.
25857 @item -mfixed-range=@var{register-range}
25858 @opindex mfixed-range
25859 Generate code treating the given register range as fixed registers.
25860 A fixed register is one that the register allocator cannot use.  This is
25861 useful when compiling kernel code.  A register range is specified as
25862 two registers separated by a dash.  Multiple register ranges can be
25863 specified separated by a comma.
25865 @item -mea32
25866 @itemx -mea64
25867 @opindex mea32
25868 @opindex mea64
25869 Compile code assuming that pointers to the PPU address space accessed
25870 via the @code{__ea} named address space qualifier are either 32 or 64
25871 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
25872 all object code in an executable must be compiled with the same setting.
25874 @item -maddress-space-conversion
25875 @itemx -mno-address-space-conversion
25876 @opindex maddress-space-conversion
25877 @opindex mno-address-space-conversion
25878 Allow/disallow treating the @code{__ea} address space as superset
25879 of the generic address space.  This enables explicit type casts
25880 between @code{__ea} and generic pointer as well as implicit
25881 conversions of generic pointers to @code{__ea} pointers.  The
25882 default is to allow address space pointer conversions.
25884 @item -mcache-size=@var{cache-size}
25885 @opindex mcache-size
25886 This option controls the version of libgcc that the compiler links to an
25887 executable and selects a software-managed cache for accessing variables
25888 in the @code{__ea} address space with a particular cache size.  Possible
25889 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
25890 and @samp{128}.  The default cache size is 64KB.
25892 @item -matomic-updates
25893 @itemx -mno-atomic-updates
25894 @opindex matomic-updates
25895 @opindex mno-atomic-updates
25896 This option controls the version of libgcc that the compiler links to an
25897 executable and selects whether atomic updates to the software-managed
25898 cache of PPU-side variables are used.  If you use atomic updates, changes
25899 to a PPU variable from SPU code using the @code{__ea} named address space
25900 qualifier do not interfere with changes to other PPU variables residing
25901 in the same cache line from PPU code.  If you do not use atomic updates,
25902 such interference may occur; however, writing back cache lines is
25903 more efficient.  The default behavior is to use atomic updates.
25905 @item -mdual-nops
25906 @itemx -mdual-nops=@var{n}
25907 @opindex mdual-nops
25908 By default, GCC inserts NOPs to increase dual issue when it expects
25909 it to increase performance.  @var{n} can be a value from 0 to 10.  A
25910 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
25911 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
25913 @item -mhint-max-nops=@var{n}
25914 @opindex mhint-max-nops
25915 Maximum number of NOPs to insert for a branch hint.  A branch hint must
25916 be at least 8 instructions away from the branch it is affecting.  GCC
25917 inserts up to @var{n} NOPs to enforce this, otherwise it does not
25918 generate the branch hint.
25920 @item -mhint-max-distance=@var{n}
25921 @opindex mhint-max-distance
25922 The encoding of the branch hint instruction limits the hint to be within
25923 256 instructions of the branch it is affecting.  By default, GCC makes
25924 sure it is within 125.
25926 @item -msafe-hints
25927 @opindex msafe-hints
25928 Work around a hardware bug that causes the SPU to stall indefinitely.
25929 By default, GCC inserts the @code{hbrp} instruction to make sure
25930 this stall won't happen.
25932 @end table
25934 @node System V Options
25935 @subsection Options for System V
25937 These additional options are available on System V Release 4 for
25938 compatibility with other compilers on those systems:
25940 @table @gcctabopt
25941 @item -G
25942 @opindex G
25943 Create a shared object.
25944 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
25946 @item -Qy
25947 @opindex Qy
25948 Identify the versions of each tool used by the compiler, in a
25949 @code{.ident} assembler directive in the output.
25951 @item -Qn
25952 @opindex Qn
25953 Refrain from adding @code{.ident} directives to the output file (this is
25954 the default).
25956 @item -YP,@var{dirs}
25957 @opindex YP
25958 Search the directories @var{dirs}, and no others, for libraries
25959 specified with @option{-l}.
25961 @item -Ym,@var{dir}
25962 @opindex Ym
25963 Look in the directory @var{dir} to find the M4 preprocessor.
25964 The assembler uses this option.
25965 @c This is supposed to go with a -Yd for predefined M4 macro files, but
25966 @c the generic assembler that comes with Solaris takes just -Ym.
25967 @end table
25969 @node TILE-Gx Options
25970 @subsection TILE-Gx Options
25971 @cindex TILE-Gx options
25973 These @samp{-m} options are supported on the TILE-Gx:
25975 @table @gcctabopt
25976 @item -mcmodel=small
25977 @opindex mcmodel=small
25978 Generate code for the small model.  The distance for direct calls is
25979 limited to 500M in either direction.  PC-relative addresses are 32
25980 bits.  Absolute addresses support the full address range.
25982 @item -mcmodel=large
25983 @opindex mcmodel=large
25984 Generate code for the large model.  There is no limitation on call
25985 distance, pc-relative addresses, or absolute addresses.
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{tilegx}.
25992 @item -m32
25993 @itemx -m64
25994 @opindex m32
25995 @opindex m64
25996 Generate code for a 32-bit or 64-bit environment.  The 32-bit
25997 environment sets int, long, and pointer to 32 bits.  The 64-bit
25998 environment sets int to 32 bits and long and pointer to 64 bits.
26000 @item -mbig-endian
26001 @itemx -mlittle-endian
26002 @opindex mbig-endian
26003 @opindex mlittle-endian
26004 Generate code in big/little endian mode, respectively.
26005 @end table
26007 @node TILEPro Options
26008 @subsection TILEPro Options
26009 @cindex TILEPro options
26011 These @samp{-m} options are supported on the TILEPro:
26013 @table @gcctabopt
26014 @item -mcpu=@var{name}
26015 @opindex mcpu
26016 Selects the type of CPU to be targeted.  Currently the only supported
26017 type is @samp{tilepro}.
26019 @item -m32
26020 @opindex m32
26021 Generate code for a 32-bit environment, which sets int, long, and
26022 pointer to 32 bits.  This is the only supported behavior so the flag
26023 is essentially ignored.
26024 @end table
26026 @node V850 Options
26027 @subsection V850 Options
26028 @cindex V850 Options
26030 These @samp{-m} options are defined for V850 implementations:
26032 @table @gcctabopt
26033 @item -mlong-calls
26034 @itemx -mno-long-calls
26035 @opindex mlong-calls
26036 @opindex mno-long-calls
26037 Treat all calls as being far away (near).  If calls are assumed to be
26038 far away, the compiler always loads the function's address into a
26039 register, and calls indirect through the pointer.
26041 @item -mno-ep
26042 @itemx -mep
26043 @opindex mno-ep
26044 @opindex mep
26045 Do not optimize (do optimize) basic blocks that use the same index
26046 pointer 4 or more times to copy pointer into the @code{ep} register, and
26047 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
26048 option is on by default if you optimize.
26050 @item -mno-prolog-function
26051 @itemx -mprolog-function
26052 @opindex mno-prolog-function
26053 @opindex mprolog-function
26054 Do not use (do use) external functions to save and restore registers
26055 at the prologue and epilogue of a function.  The external functions
26056 are slower, but use less code space if more than one function saves
26057 the same number of registers.  The @option{-mprolog-function} option
26058 is on by default if you optimize.
26060 @item -mspace
26061 @opindex mspace
26062 Try to make the code as small as possible.  At present, this just turns
26063 on the @option{-mep} and @option{-mprolog-function} options.
26065 @item -mtda=@var{n}
26066 @opindex mtda
26067 Put static or global variables whose size is @var{n} bytes or less into
26068 the tiny data area that register @code{ep} points to.  The tiny data
26069 area can hold up to 256 bytes in total (128 bytes for byte references).
26071 @item -msda=@var{n}
26072 @opindex msda
26073 Put static or global variables whose size is @var{n} bytes or less into
26074 the small data area that register @code{gp} points to.  The small data
26075 area can hold up to 64 kilobytes.
26077 @item -mzda=@var{n}
26078 @opindex mzda
26079 Put static or global variables whose size is @var{n} bytes or less into
26080 the first 32 kilobytes of memory.
26082 @item -mv850
26083 @opindex mv850
26084 Specify that the target processor is the V850.
26086 @item -mv850e3v5
26087 @opindex mv850e3v5
26088 Specify that the target processor is the V850E3V5.  The preprocessor
26089 constant @code{__v850e3v5__} is defined if this option is used.
26091 @item -mv850e2v4
26092 @opindex mv850e2v4
26093 Specify that the target processor is the V850E3V5.  This is an alias for
26094 the @option{-mv850e3v5} option.
26096 @item -mv850e2v3
26097 @opindex mv850e2v3
26098 Specify that the target processor is the V850E2V3.  The preprocessor
26099 constant @code{__v850e2v3__} is defined if this option is used.
26101 @item -mv850e2
26102 @opindex mv850e2
26103 Specify that the target processor is the V850E2.  The preprocessor
26104 constant @code{__v850e2__} is defined if this option is used.
26106 @item -mv850e1
26107 @opindex mv850e1
26108 Specify that the target processor is the V850E1.  The preprocessor
26109 constants @code{__v850e1__} and @code{__v850e__} are defined if
26110 this option is used.
26112 @item -mv850es
26113 @opindex mv850es
26114 Specify that the target processor is the V850ES.  This is an alias for
26115 the @option{-mv850e1} option.
26117 @item -mv850e
26118 @opindex mv850e
26119 Specify that the target processor is the V850E@.  The preprocessor
26120 constant @code{__v850e__} is defined if this option is used.
26122 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
26123 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
26124 are defined then a default target processor is chosen and the
26125 relevant @samp{__v850*__} preprocessor constant is defined.
26127 The preprocessor constants @code{__v850} and @code{__v851__} are always
26128 defined, regardless of which processor variant is the target.
26130 @item -mdisable-callt
26131 @itemx -mno-disable-callt
26132 @opindex mdisable-callt
26133 @opindex mno-disable-callt
26134 This option suppresses generation of the @code{CALLT} instruction for the
26135 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
26136 architecture.
26138 This option is enabled by default when the RH850 ABI is
26139 in use (see @option{-mrh850-abi}), and disabled by default when the
26140 GCC ABI is in use.  If @code{CALLT} instructions are being generated
26141 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
26143 @item -mrelax
26144 @itemx -mno-relax
26145 @opindex mrelax
26146 @opindex mno-relax
26147 Pass on (or do not pass on) the @option{-mrelax} command-line option
26148 to the assembler.
26150 @item -mlong-jumps
26151 @itemx -mno-long-jumps
26152 @opindex mlong-jumps
26153 @opindex mno-long-jumps
26154 Disable (or re-enable) the generation of PC-relative jump instructions.
26156 @item -msoft-float
26157 @itemx -mhard-float
26158 @opindex msoft-float
26159 @opindex mhard-float
26160 Disable (or re-enable) the generation of hardware floating point
26161 instructions.  This option is only significant when the target
26162 architecture is @samp{V850E2V3} or higher.  If hardware floating point
26163 instructions are being generated then the C preprocessor symbol
26164 @code{__FPU_OK__} is defined, otherwise the symbol
26165 @code{__NO_FPU__} is defined.
26167 @item -mloop
26168 @opindex mloop
26169 Enables the use of the e3v5 LOOP instruction.  The use of this
26170 instruction is not enabled by default when the e3v5 architecture is
26171 selected because its use is still experimental.
26173 @item -mrh850-abi
26174 @itemx -mghs
26175 @opindex mrh850-abi
26176 @opindex mghs
26177 Enables support for the RH850 version of the V850 ABI.  This is the
26178 default.  With this version of the ABI the following rules apply:
26180 @itemize
26181 @item
26182 Integer sized structures and unions are returned via a memory pointer
26183 rather than a register.
26185 @item
26186 Large structures and unions (more than 8 bytes in size) are passed by
26187 value.
26189 @item
26190 Functions are aligned to 16-bit boundaries.
26192 @item
26193 The @option{-m8byte-align} command-line option is supported.
26195 @item
26196 The @option{-mdisable-callt} command-line option is enabled by
26197 default.  The @option{-mno-disable-callt} command-line option is not
26198 supported.
26199 @end itemize
26201 When this version of the ABI is enabled the C preprocessor symbol
26202 @code{__V850_RH850_ABI__} is defined.
26204 @item -mgcc-abi
26205 @opindex mgcc-abi
26206 Enables support for the old GCC version of the V850 ABI.  With this
26207 version of the ABI the following rules apply:
26209 @itemize
26210 @item
26211 Integer sized structures and unions are returned in register @code{r10}.
26213 @item
26214 Large structures and unions (more than 8 bytes in size) are passed by
26215 reference.
26217 @item
26218 Functions are aligned to 32-bit boundaries, unless optimizing for
26219 size.
26221 @item
26222 The @option{-m8byte-align} command-line option is not supported.
26224 @item
26225 The @option{-mdisable-callt} command-line option is supported but not
26226 enabled by default.
26227 @end itemize
26229 When this version of the ABI is enabled the C preprocessor symbol
26230 @code{__V850_GCC_ABI__} is defined.
26232 @item -m8byte-align
26233 @itemx -mno-8byte-align
26234 @opindex m8byte-align
26235 @opindex mno-8byte-align
26236 Enables support for @code{double} and @code{long long} types to be
26237 aligned on 8-byte boundaries.  The default is to restrict the
26238 alignment of all objects to at most 4-bytes.  When
26239 @option{-m8byte-align} is in effect the C preprocessor symbol
26240 @code{__V850_8BYTE_ALIGN__} is defined.
26242 @item -mbig-switch
26243 @opindex mbig-switch
26244 Generate code suitable for big switch tables.  Use this option only if
26245 the assembler/linker complain about out of range branches within a switch
26246 table.
26248 @item -mapp-regs
26249 @opindex mapp-regs
26250 This option causes r2 and r5 to be used in the code generated by
26251 the compiler.  This setting is the default.
26253 @item -mno-app-regs
26254 @opindex mno-app-regs
26255 This option causes r2 and r5 to be treated as fixed registers.
26257 @end table
26259 @node VAX Options
26260 @subsection VAX Options
26261 @cindex VAX options
26263 These @samp{-m} options are defined for the VAX:
26265 @table @gcctabopt
26266 @item -munix
26267 @opindex munix
26268 Do not output certain jump instructions (@code{aobleq} and so on)
26269 that the Unix assembler for the VAX cannot handle across long
26270 ranges.
26272 @item -mgnu
26273 @opindex mgnu
26274 Do output those jump instructions, on the assumption that the
26275 GNU assembler is being used.
26277 @item -mg
26278 @opindex mg
26279 Output code for G-format floating-point numbers instead of D-format.
26280 @end table
26282 @node Visium Options
26283 @subsection Visium Options
26284 @cindex Visium options
26286 @table @gcctabopt
26288 @item -mdebug
26289 @opindex mdebug
26290 A program which performs file I/O and is destined to run on an MCM target
26291 should be linked with this option.  It causes the libraries libc.a and
26292 libdebug.a to be linked.  The program should be run on the target under
26293 the control of the GDB remote debugging stub.
26295 @item -msim
26296 @opindex msim
26297 A program which performs file I/O and is destined to run on the simulator
26298 should be linked with option.  This causes libraries libc.a and libsim.a to
26299 be linked.
26301 @item -mfpu
26302 @itemx -mhard-float
26303 @opindex mfpu
26304 @opindex mhard-float
26305 Generate code containing floating-point instructions.  This is the
26306 default.
26308 @item -mno-fpu
26309 @itemx -msoft-float
26310 @opindex mno-fpu
26311 @opindex msoft-float
26312 Generate code containing library calls for floating-point.
26314 @option{-msoft-float} changes the calling convention in the output file;
26315 therefore, it is only useful if you compile @emph{all} of a program with
26316 this option.  In particular, you need to compile @file{libgcc.a}, the
26317 library that comes with GCC, with @option{-msoft-float} in order for
26318 this to work.
26320 @item -mcpu=@var{cpu_type}
26321 @opindex mcpu
26322 Set the instruction set, register set, and instruction scheduling parameters
26323 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
26324 @samp{mcm}, @samp{gr5} and @samp{gr6}.
26326 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
26328 By default (unless configured otherwise), GCC generates code for the GR5
26329 variant of the Visium architecture.  
26331 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
26332 architecture.  The only difference from GR5 code is that the compiler will
26333 generate block move instructions.
26335 @item -mtune=@var{cpu_type}
26336 @opindex mtune
26337 Set the instruction scheduling parameters for machine type @var{cpu_type},
26338 but do not set the instruction set or register set that the option
26339 @option{-mcpu=@var{cpu_type}} would.
26341 @item -msv-mode
26342 @opindex msv-mode
26343 Generate code for the supervisor mode, where there are no restrictions on
26344 the access to general registers.  This is the default.
26346 @item -muser-mode
26347 @opindex muser-mode
26348 Generate code for the user mode, where the access to some general registers
26349 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
26350 mode; on the GR6, only registers r29 to r31 are affected.
26351 @end table
26353 @node VMS Options
26354 @subsection VMS Options
26356 These @samp{-m} options are defined for the VMS implementations:
26358 @table @gcctabopt
26359 @item -mvms-return-codes
26360 @opindex mvms-return-codes
26361 Return VMS condition codes from @code{main}. The default is to return POSIX-style
26362 condition (e.g.@ error) codes.
26364 @item -mdebug-main=@var{prefix}
26365 @opindex mdebug-main=@var{prefix}
26366 Flag the first routine whose name starts with @var{prefix} as the main
26367 routine for the debugger.
26369 @item -mmalloc64
26370 @opindex mmalloc64
26371 Default to 64-bit memory allocation routines.
26373 @item -mpointer-size=@var{size}
26374 @opindex mpointer-size=@var{size}
26375 Set the default size of pointers. Possible options for @var{size} are
26376 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
26377 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
26378 The later option disables @code{pragma pointer_size}.
26379 @end table
26381 @node VxWorks Options
26382 @subsection VxWorks Options
26383 @cindex VxWorks Options
26385 The options in this section are defined for all VxWorks targets.
26386 Options specific to the target hardware are listed with the other
26387 options for that target.
26389 @table @gcctabopt
26390 @item -mrtp
26391 @opindex mrtp
26392 GCC can generate code for both VxWorks kernels and real time processes
26393 (RTPs).  This option switches from the former to the latter.  It also
26394 defines the preprocessor macro @code{__RTP__}.
26396 @item -non-static
26397 @opindex non-static
26398 Link an RTP executable against shared libraries rather than static
26399 libraries.  The options @option{-static} and @option{-shared} can
26400 also be used for RTPs (@pxref{Link Options}); @option{-static}
26401 is the default.
26403 @item -Bstatic
26404 @itemx -Bdynamic
26405 @opindex Bstatic
26406 @opindex Bdynamic
26407 These options are passed down to the linker.  They are defined for
26408 compatibility with Diab.
26410 @item -Xbind-lazy
26411 @opindex Xbind-lazy
26412 Enable lazy binding of function calls.  This option is equivalent to
26413 @option{-Wl,-z,now} and is defined for compatibility with Diab.
26415 @item -Xbind-now
26416 @opindex Xbind-now
26417 Disable lazy binding of function calls.  This option is the default and
26418 is defined for compatibility with Diab.
26419 @end table
26421 @node x86 Options
26422 @subsection x86 Options
26423 @cindex x86 Options
26425 These @samp{-m} options are defined for the x86 family of computers.
26427 @table @gcctabopt
26429 @item -march=@var{cpu-type}
26430 @opindex march
26431 Generate instructions for the machine type @var{cpu-type}.  In contrast to
26432 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
26433 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
26434 to generate code that may not run at all on processors other than the one
26435 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
26436 @option{-mtune=@var{cpu-type}}.
26438 The choices for @var{cpu-type} are:
26440 @table @samp
26441 @item native
26442 This selects the CPU to generate code for at compilation time by determining
26443 the processor type of the compiling machine.  Using @option{-march=native}
26444 enables all instruction subsets supported by the local machine (hence
26445 the result might not run on different machines).  Using @option{-mtune=native}
26446 produces code optimized for the local machine under the constraints
26447 of the selected instruction set.  
26449 @item x86-64
26450 A generic CPU with 64-bit extensions.
26452 @item i386
26453 Original Intel i386 CPU@.
26455 @item i486
26456 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
26458 @item i586
26459 @itemx pentium
26460 Intel Pentium CPU with no MMX support.
26462 @item lakemont
26463 Intel Lakemont MCU, based on Intel Pentium CPU.
26465 @item pentium-mmx
26466 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
26468 @item pentiumpro
26469 Intel Pentium Pro CPU@.
26471 @item i686
26472 When used with @option{-march}, the Pentium Pro
26473 instruction set is used, so the code runs on all i686 family chips.
26474 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
26476 @item pentium2
26477 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
26478 support.
26480 @item pentium3
26481 @itemx pentium3m
26482 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
26483 set support.
26485 @item pentium-m
26486 Intel Pentium M; low-power version of Intel Pentium III CPU
26487 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
26489 @item pentium4
26490 @itemx pentium4m
26491 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
26493 @item prescott
26494 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
26495 set support.
26497 @item nocona
26498 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
26499 SSE2 and SSE3 instruction set support.
26501 @item core2
26502 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
26503 instruction set support.
26505 @item nehalem
26506 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26507 SSE4.1, SSE4.2 and POPCNT instruction set support.
26509 @item westmere
26510 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26511 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
26513 @item sandybridge
26514 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26515 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
26517 @item ivybridge
26518 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
26519 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
26520 instruction set support.
26522 @item haswell
26523 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26524 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26525 BMI, BMI2 and F16C instruction set support.
26527 @item broadwell
26528 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26529 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26530 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
26532 @item skylake
26533 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26534 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26535 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
26536 XSAVES instruction set support.
26538 @item bonnell
26539 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
26540 instruction set support.
26542 @item silvermont
26543 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26544 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
26546 @item goldmont
26547 Intel Goldmont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
26548 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT and FSGSBASE
26549 instruction set support.
26551 @item goldmont-plus
26552 Intel Goldmont Plus CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26553 SSSE3, SSE4.1, SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE,
26554 PTWRITE, RDPID, SGX and UMIP instruction set support.
26556 @item knl
26557 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26558 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26559 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
26560 AVX512CD instruction set support.
26562 @item knm
26563 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26564 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26565 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26566 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
26568 @item skylake-avx512
26569 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
26570 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
26571 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
26572 CLWB, AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
26574 @item cannonlake
26575 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26576 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26577 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26578 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26579 AVX512IFMA, SHA and UMIP instruction set support.
26581 @item icelake-client
26582 Intel Icelake Client CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26583 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26584 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26585 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26586 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26587 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES instruction set support.
26589 @item icelake-server
26590 Intel Icelake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
26591 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
26592 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
26593 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
26594 AVX512IFMA, SHA, CLWB, UMIP, RDPID, GFNI, AVX512VBMI2, AVX512VPOPCNTDQ,
26595 AVX512BITALG, AVX512VNNI, VPCLMULQDQ, VAES, PCONFIG and WBNOINVD instruction
26596 set support.
26598 @item k6
26599 AMD K6 CPU with MMX instruction set support.
26601 @item k6-2
26602 @itemx k6-3
26603 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
26605 @item athlon
26606 @itemx athlon-tbird
26607 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
26608 support.
26610 @item athlon-4
26611 @itemx athlon-xp
26612 @itemx athlon-mp
26613 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
26614 instruction set support.
26616 @item k8
26617 @itemx opteron
26618 @itemx athlon64
26619 @itemx athlon-fx
26620 Processors based on the AMD K8 core with x86-64 instruction set support,
26621 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
26622 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
26623 instruction set extensions.)
26625 @item k8-sse3
26626 @itemx opteron-sse3
26627 @itemx athlon64-sse3
26628 Improved versions of AMD K8 cores with SSE3 instruction set support.
26630 @item amdfam10
26631 @itemx barcelona
26632 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
26633 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
26634 instruction set extensions.)
26636 @item bdver1
26637 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
26638 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
26639 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
26640 @item bdver2
26641 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26642 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
26643 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
26644 extensions.)
26645 @item bdver3
26646 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26647 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
26648 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
26649 64-bit instruction set extensions.
26650 @item bdver4
26651 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
26652 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
26653 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
26654 SSE4.2, ABM and 64-bit instruction set extensions.
26656 @item znver1
26657 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
26658 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
26659 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
26660 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
26661 instruction set extensions.
26663 @item btver1
26664 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
26665 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
26666 instruction set extensions.)
26668 @item btver2
26669 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
26670 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
26671 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
26673 @item winchip-c6
26674 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
26675 set support.
26677 @item winchip2
26678 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
26679 instruction set support.
26681 @item c3
26682 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
26683 (No scheduling is implemented for this chip.)
26685 @item c3-2
26686 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
26687 (No scheduling is implemented for this chip.)
26689 @item c7
26690 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26691 (No scheduling is implemented for this chip.)
26693 @item samuel-2
26694 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
26695 (No scheduling is implemented for this chip.)
26697 @item nehemiah
26698 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
26699 (No scheduling is implemented for this chip.)
26701 @item esther
26702 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
26703 (No scheduling is implemented for this chip.)
26705 @item eden-x2
26706 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
26707 (No scheduling is implemented for this chip.)
26709 @item eden-x4
26710 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
26711 AVX and AVX2 instruction set support.
26712 (No scheduling is implemented for this chip.)
26714 @item nano
26715 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26716 instruction set support.
26717 (No scheduling is implemented for this chip.)
26719 @item nano-1000
26720 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26721 instruction set support.
26722 (No scheduling is implemented for this chip.)
26724 @item nano-2000
26725 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
26726 instruction set support.
26727 (No scheduling is implemented for this chip.)
26729 @item nano-3000
26730 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26731 instruction set support.
26732 (No scheduling is implemented for this chip.)
26734 @item nano-x2
26735 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26736 instruction set support.
26737 (No scheduling is implemented for this chip.)
26739 @item nano-x4
26740 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
26741 instruction set support.
26742 (No scheduling is implemented for this chip.)
26744 @item geode
26745 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
26746 @end table
26748 @item -mtune=@var{cpu-type}
26749 @opindex mtune
26750 Tune to @var{cpu-type} everything applicable about the generated code, except
26751 for the ABI and the set of available instructions.  
26752 While picking a specific @var{cpu-type} schedules things appropriately
26753 for that particular chip, the compiler does not generate any code that
26754 cannot run on the default machine type unless you use a
26755 @option{-march=@var{cpu-type}} option.
26756 For example, if GCC is configured for i686-pc-linux-gnu
26757 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
26758 but still runs on i686 machines.
26760 The choices for @var{cpu-type} are the same as for @option{-march}.
26761 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
26763 @table @samp
26764 @item generic
26765 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
26766 If you know the CPU on which your code will run, then you should use
26767 the corresponding @option{-mtune} or @option{-march} option instead of
26768 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
26769 of your application will have, then you should use this option.
26771 As new processors are deployed in the marketplace, the behavior of this
26772 option will change.  Therefore, if you upgrade to a newer version of
26773 GCC, code generation controlled by this option will change to reflect
26774 the processors
26775 that are most common at the time that version of GCC is released.
26777 There is no @option{-march=generic} option because @option{-march}
26778 indicates the instruction set the compiler can use, and there is no
26779 generic instruction set applicable to all processors.  In contrast,
26780 @option{-mtune} indicates the processor (or, in this case, collection of
26781 processors) for which the code is optimized.
26783 @item intel
26784 Produce code optimized for the most current Intel processors, which are
26785 Haswell and Silvermont for this version of GCC.  If you know the CPU
26786 on which your code will run, then you should use the corresponding
26787 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
26788 But, if you want your application performs better on both Haswell and
26789 Silvermont, then you should use this option.
26791 As new Intel processors are deployed in the marketplace, the behavior of
26792 this option will change.  Therefore, if you upgrade to a newer version of
26793 GCC, code generation controlled by this option will change to reflect
26794 the most current Intel processors at the time that version of GCC is
26795 released.
26797 There is no @option{-march=intel} option because @option{-march} indicates
26798 the instruction set the compiler can use, and there is no common
26799 instruction set applicable to all processors.  In contrast,
26800 @option{-mtune} indicates the processor (or, in this case, collection of
26801 processors) for which the code is optimized.
26802 @end table
26804 @item -mcpu=@var{cpu-type}
26805 @opindex mcpu
26806 A deprecated synonym for @option{-mtune}.
26808 @item -mfpmath=@var{unit}
26809 @opindex mfpmath
26810 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
26811 for @var{unit} are:
26813 @table @samp
26814 @item 387
26815 Use the standard 387 floating-point coprocessor present on the majority of chips and
26816 emulated otherwise.  Code compiled with this option runs almost everywhere.
26817 The temporary results are computed in 80-bit precision instead of the precision
26818 specified by the type, resulting in slightly different results compared to most
26819 of other chips.  See @option{-ffloat-store} for more detailed description.
26821 This is the default choice for non-Darwin x86-32 targets.
26823 @item sse
26824 Use scalar floating-point instructions present in the SSE instruction set.
26825 This instruction set is supported by Pentium III and newer chips,
26826 and in the AMD line
26827 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
26828 instruction set supports only single-precision arithmetic, thus the double and
26829 extended-precision arithmetic are still done using 387.  A later version, present
26830 only in Pentium 4 and AMD x86-64 chips, supports double-precision
26831 arithmetic too.
26833 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
26834 or @option{-msse2} switches to enable SSE extensions and make this option
26835 effective.  For the x86-64 compiler, these extensions are enabled by default.
26837 The resulting code should be considerably faster in the majority of cases and avoid
26838 the numerical instability problems of 387 code, but may break some existing
26839 code that expects temporaries to be 80 bits.
26841 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
26842 and the default choice for x86-32 targets with the SSE2 instruction set
26843 when @option{-ffast-math} is enabled.
26845 @item sse,387
26846 @itemx sse+387
26847 @itemx both
26848 Attempt to utilize both instruction sets at once.  This effectively doubles the
26849 amount of available registers, and on chips with separate execution units for
26850 387 and SSE the execution resources too.  Use this option with care, as it is
26851 still experimental, because the GCC register allocator does not model separate
26852 functional units well, resulting in unstable performance.
26853 @end table
26855 @item -masm=@var{dialect}
26856 @opindex masm=@var{dialect}
26857 Output assembly instructions using selected @var{dialect}.  Also affects
26858 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
26859 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
26860 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
26861 not support @samp{intel}.
26863 @item -mieee-fp
26864 @itemx -mno-ieee-fp
26865 @opindex mieee-fp
26866 @opindex mno-ieee-fp
26867 Control whether or not the compiler uses IEEE floating-point
26868 comparisons.  These correctly handle the case where the result of a
26869 comparison is unordered.
26871 @item -m80387
26872 @itemx -mhard-float
26873 @opindex 80387
26874 @opindex mhard-float
26875 Generate output containing 80387 instructions for floating point.
26877 @item -mno-80387
26878 @itemx -msoft-float
26879 @opindex no-80387
26880 @opindex msoft-float
26881 Generate output containing library calls for floating point.
26883 @strong{Warning:} the requisite libraries are not part of GCC@.
26884 Normally the facilities of the machine's usual C compiler are used, but
26885 this cannot be done directly in cross-compilation.  You must make your
26886 own arrangements to provide suitable library functions for
26887 cross-compilation.
26889 On machines where a function returns floating-point results in the 80387
26890 register stack, some floating-point opcodes may be emitted even if
26891 @option{-msoft-float} is used.
26893 @item -mno-fp-ret-in-387
26894 @opindex mno-fp-ret-in-387
26895 Do not use the FPU registers for return values of functions.
26897 The usual calling convention has functions return values of types
26898 @code{float} and @code{double} in an FPU register, even if there
26899 is no FPU@.  The idea is that the operating system should emulate
26900 an FPU@.
26902 The option @option{-mno-fp-ret-in-387} causes such values to be returned
26903 in ordinary CPU registers instead.
26905 @item -mno-fancy-math-387
26906 @opindex mno-fancy-math-387
26907 Some 387 emulators do not support the @code{sin}, @code{cos} and
26908 @code{sqrt} instructions for the 387.  Specify this option to avoid
26909 generating those instructions.  This option is the default on
26910 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
26911 indicates that the target CPU always has an FPU and so the
26912 instruction does not need emulation.  These
26913 instructions are not generated unless you also use the
26914 @option{-funsafe-math-optimizations} switch.
26916 @item -malign-double
26917 @itemx -mno-align-double
26918 @opindex malign-double
26919 @opindex mno-align-double
26920 Control whether GCC aligns @code{double}, @code{long double}, and
26921 @code{long long} variables on a two-word boundary or a one-word
26922 boundary.  Aligning @code{double} variables on a two-word boundary
26923 produces code that runs somewhat faster on a Pentium at the
26924 expense of more memory.
26926 On x86-64, @option{-malign-double} is enabled by default.
26928 @strong{Warning:} if you use the @option{-malign-double} switch,
26929 structures containing the above types are aligned differently than
26930 the published application binary interface specifications for the x86-32
26931 and are not binary compatible with structures in code compiled
26932 without that switch.
26934 @item -m96bit-long-double
26935 @itemx -m128bit-long-double
26936 @opindex m96bit-long-double
26937 @opindex m128bit-long-double
26938 These switches control the size of @code{long double} type.  The x86-32
26939 application binary interface specifies the size to be 96 bits,
26940 so @option{-m96bit-long-double} is the default in 32-bit mode.
26942 Modern architectures (Pentium and newer) prefer @code{long double}
26943 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
26944 conforming to the ABI, this is not possible.  So specifying
26945 @option{-m128bit-long-double} aligns @code{long double}
26946 to a 16-byte boundary by padding the @code{long double} with an additional
26947 32-bit zero.
26949 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
26950 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
26952 Notice that neither of these options enable any extra precision over the x87
26953 standard of 80 bits for a @code{long double}.
26955 @strong{Warning:} if you override the default value for your target ABI, this
26956 changes the size of 
26957 structures and arrays containing @code{long double} variables,
26958 as well as modifying the function calling convention for functions taking
26959 @code{long double}.  Hence they are not binary-compatible
26960 with code compiled without that switch.
26962 @item -mlong-double-64
26963 @itemx -mlong-double-80
26964 @itemx -mlong-double-128
26965 @opindex mlong-double-64
26966 @opindex mlong-double-80
26967 @opindex mlong-double-128
26968 These switches control the size of @code{long double} type. A size
26969 of 64 bits makes the @code{long double} type equivalent to the @code{double}
26970 type. This is the default for 32-bit Bionic C library.  A size
26971 of 128 bits makes the @code{long double} type equivalent to the
26972 @code{__float128} type. This is the default for 64-bit Bionic C library.
26974 @strong{Warning:} if you override the default value for your target ABI, this
26975 changes the size of
26976 structures and arrays containing @code{long double} variables,
26977 as well as modifying the function calling convention for functions taking
26978 @code{long double}.  Hence they are not binary-compatible
26979 with code compiled without that switch.
26981 @item -malign-data=@var{type}
26982 @opindex malign-data
26983 Control how GCC aligns variables.  Supported values for @var{type} are
26984 @samp{compat} uses increased alignment value compatible uses GCC 4.8
26985 and earlier, @samp{abi} uses alignment value as specified by the
26986 psABI, and @samp{cacheline} uses increased alignment value to match
26987 the cache line size.  @samp{compat} is the default.
26989 @item -mlarge-data-threshold=@var{threshold}
26990 @opindex mlarge-data-threshold
26991 When @option{-mcmodel=medium} is specified, data objects larger than
26992 @var{threshold} are placed in the large data section.  This value must be the
26993 same across all objects linked into the binary, and defaults to 65535.
26995 @item -mrtd
26996 @opindex mrtd
26997 Use a different function-calling convention, in which functions that
26998 take a fixed number of arguments return with the @code{ret @var{num}}
26999 instruction, which pops their arguments while returning.  This saves one
27000 instruction in the caller since there is no need to pop the arguments
27001 there.
27003 You can specify that an individual function is called with this calling
27004 sequence with the function attribute @code{stdcall}.  You can also
27005 override the @option{-mrtd} option by using the function attribute
27006 @code{cdecl}.  @xref{Function Attributes}.
27008 @strong{Warning:} this calling convention is incompatible with the one
27009 normally used on Unix, so you cannot use it if you need to call
27010 libraries compiled with the Unix compiler.
27012 Also, you must provide function prototypes for all functions that
27013 take variable numbers of arguments (including @code{printf});
27014 otherwise incorrect code is generated for calls to those
27015 functions.
27017 In addition, seriously incorrect code results if you call a
27018 function with too many arguments.  (Normally, extra arguments are
27019 harmlessly ignored.)
27021 @item -mregparm=@var{num}
27022 @opindex mregparm
27023 Control how many registers are used to pass integer arguments.  By
27024 default, no registers are used to pass arguments, and at most 3
27025 registers can be used.  You can control this behavior for a specific
27026 function by using the function attribute @code{regparm}.
27027 @xref{Function Attributes}.
27029 @strong{Warning:} if you use this switch, and
27030 @var{num} is nonzero, then you must build all modules with the same
27031 value, including any libraries.  This includes the system libraries and
27032 startup modules.
27034 @item -msseregparm
27035 @opindex msseregparm
27036 Use SSE register passing conventions for float and double arguments
27037 and return values.  You can control this behavior for a specific
27038 function by using the function attribute @code{sseregparm}.
27039 @xref{Function Attributes}.
27041 @strong{Warning:} if you use this switch then you must build all
27042 modules with the same value, including any libraries.  This includes
27043 the system libraries and startup modules.
27045 @item -mvect8-ret-in-mem
27046 @opindex mvect8-ret-in-mem
27047 Return 8-byte vectors in memory instead of MMX registers.  This is the
27048 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
27049 Studio compilers until version 12.  Later compiler versions (starting
27050 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
27051 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
27052 you need to remain compatible with existing code produced by those
27053 previous compiler versions or older versions of GCC@.
27055 @item -mpc32
27056 @itemx -mpc64
27057 @itemx -mpc80
27058 @opindex mpc32
27059 @opindex mpc64
27060 @opindex mpc80
27062 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
27063 is specified, the significands of results of floating-point operations are
27064 rounded to 24 bits (single precision); @option{-mpc64} rounds the
27065 significands of results of floating-point operations to 53 bits (double
27066 precision) and @option{-mpc80} rounds the significands of results of
27067 floating-point operations to 64 bits (extended double precision), which is
27068 the default.  When this option is used, floating-point operations in higher
27069 precisions are not available to the programmer without setting the FPU
27070 control word explicitly.
27072 Setting the rounding of floating-point operations to less than the default
27073 80 bits can speed some programs by 2% or more.  Note that some mathematical
27074 libraries assume that extended-precision (80-bit) floating-point operations
27075 are enabled by default; routines in such libraries could suffer significant
27076 loss of accuracy, typically through so-called ``catastrophic cancellation'',
27077 when this option is used to set the precision to less than extended precision.
27079 @item -mstackrealign
27080 @opindex mstackrealign
27081 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
27082 option generates an alternate prologue and epilogue that realigns the
27083 run-time stack if necessary.  This supports mixing legacy codes that keep
27084 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
27085 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
27086 applicable to individual functions.
27088 @item -mpreferred-stack-boundary=@var{num}
27089 @opindex mpreferred-stack-boundary
27090 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
27091 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
27092 the default is 4 (16 bytes or 128 bits).
27094 @strong{Warning:} When generating code for the x86-64 architecture with
27095 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
27096 used to keep the stack boundary aligned to 8 byte boundary.  Since
27097 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
27098 intended to be used in controlled environment where stack space is
27099 important limitation.  This option leads to wrong code when functions
27100 compiled with 16 byte stack alignment (such as functions from a standard
27101 library) are called with misaligned stack.  In this case, SSE
27102 instructions may lead to misaligned memory access traps.  In addition,
27103 variable arguments are handled incorrectly for 16 byte aligned
27104 objects (including x87 long double and __int128), leading to wrong
27105 results.  You must build all modules with
27106 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
27107 includes the system libraries and startup modules.
27109 @item -mincoming-stack-boundary=@var{num}
27110 @opindex mincoming-stack-boundary
27111 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
27112 boundary.  If @option{-mincoming-stack-boundary} is not specified,
27113 the one specified by @option{-mpreferred-stack-boundary} is used.
27115 On Pentium and Pentium Pro, @code{double} and @code{long double} values
27116 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
27117 suffer significant run time performance penalties.  On Pentium III, the
27118 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
27119 properly if it is not 16-byte aligned.
27121 To ensure proper alignment of this values on the stack, the stack boundary
27122 must be as aligned as that required by any value stored on the stack.
27123 Further, every function must be generated such that it keeps the stack
27124 aligned.  Thus calling a function compiled with a higher preferred
27125 stack boundary from a function compiled with a lower preferred stack
27126 boundary most likely misaligns the stack.  It is recommended that
27127 libraries that use callbacks always use the default setting.
27129 This extra alignment does consume extra stack space, and generally
27130 increases code size.  Code that is sensitive to stack space usage, such
27131 as embedded systems and operating system kernels, may want to reduce the
27132 preferred alignment to @option{-mpreferred-stack-boundary=2}.
27134 @need 200
27135 @item -mmmx
27136 @opindex mmmx
27137 @need 200
27138 @itemx -msse
27139 @opindex msse
27140 @need 200
27141 @itemx -msse2
27142 @opindex msse2
27143 @need 200
27144 @itemx -msse3
27145 @opindex msse3
27146 @need 200
27147 @itemx -mssse3
27148 @opindex mssse3
27149 @need 200
27150 @itemx -msse4
27151 @opindex msse4
27152 @need 200
27153 @itemx -msse4a
27154 @opindex msse4a
27155 @need 200
27156 @itemx -msse4.1
27157 @opindex msse4.1
27158 @need 200
27159 @itemx -msse4.2
27160 @opindex msse4.2
27161 @need 200
27162 @itemx -mavx
27163 @opindex mavx
27164 @need 200
27165 @itemx -mavx2
27166 @opindex mavx2
27167 @need 200
27168 @itemx -mavx512f
27169 @opindex mavx512f
27170 @need 200
27171 @itemx -mavx512pf
27172 @opindex mavx512pf
27173 @need 200
27174 @itemx -mavx512er
27175 @opindex mavx512er
27176 @need 200
27177 @itemx -mavx512cd
27178 @opindex mavx512cd
27179 @need 200
27180 @itemx -mavx512vl
27181 @opindex mavx512vl
27182 @need 200
27183 @itemx -mavx512bw
27184 @opindex mavx512bw
27185 @need 200
27186 @itemx -mavx512dq
27187 @opindex mavx512dq
27188 @need 200
27189 @itemx -mavx512ifma
27190 @opindex mavx512ifma
27191 @need 200
27192 @itemx -mavx512vbmi
27193 @opindex mavx512vbmi
27194 @need 200
27195 @itemx -msha
27196 @opindex msha
27197 @need 200
27198 @itemx -maes
27199 @opindex maes
27200 @need 200
27201 @itemx -mpclmul
27202 @opindex mpclmul
27203 @need 200
27204 @itemx -mclflushopt
27205 @opindex mclflushopt
27206 @need 200
27207 @itemx -mfsgsbase
27208 @opindex mfsgsbase
27209 @need 200
27210 @itemx -mrdrnd
27211 @opindex mrdrnd
27212 @need 200
27213 @itemx -mf16c
27214 @opindex mf16c
27215 @need 200
27216 @itemx -mfma
27217 @opindex mfma
27218 @need 200
27219 @itemx -mpconfig
27220 @opindex mpconfig
27221 @need 200
27222 @itemx -mwbnoinvd
27223 @opindex mwbnoinvd
27224 @need 200
27225 @itemx -mfma4
27226 @opindex mfma4
27227 @need 200
27228 @itemx -mprefetchwt1
27229 @opindex mprefetchwt1
27230 @need 200
27231 @itemx -mxop
27232 @opindex mxop
27233 @need 200
27234 @itemx -mlwp
27235 @opindex mlwp
27236 @need 200
27237 @itemx -m3dnow
27238 @opindex m3dnow
27239 @need 200
27240 @itemx -m3dnowa
27241 @opindex m3dnowa
27242 @need 200
27243 @itemx -mpopcnt
27244 @opindex mpopcnt
27245 @need 200
27246 @itemx -mabm
27247 @opindex mabm
27248 @need 200
27249 @itemx -mbmi
27250 @opindex mbmi
27251 @need 200
27252 @itemx -mbmi2
27253 @need 200
27254 @itemx -mlzcnt
27255 @opindex mlzcnt
27256 @need 200
27257 @itemx -mfxsr
27258 @opindex mfxsr
27259 @need 200
27260 @itemx -mxsave
27261 @opindex mxsave
27262 @need 200
27263 @itemx -mxsaveopt
27264 @opindex mxsaveopt
27265 @need 200
27266 @itemx -mxsavec
27267 @opindex mxsavec
27268 @need 200
27269 @itemx -mxsaves
27270 @opindex mxsaves
27271 @need 200
27272 @itemx -mrtm
27273 @opindex mrtm
27274 @need 200
27275 @itemx -mtbm
27276 @opindex mtbm
27277 @need 200
27278 @itemx -mmpx
27279 @opindex mmpx
27280 @need 200
27281 @itemx -mmwaitx
27282 @opindex mmwaitx
27283 @need 200
27284 @itemx -mclzero
27285 @opindex mclzero
27286 @need 200
27287 @itemx -mpku
27288 @opindex mpku
27289 @need 200
27290 @itemx -mavx512vbmi2
27291 @opindex mavx512vbmi2
27292 @need 200
27293 @itemx -mgfni
27294 @opindex mgfni
27295 @need 200
27296 @itemx -mvaes
27297 @opindex mvaes
27298 @need 200
27299 @itemx -mwaitpkg
27300 @opindex -mwaitpkg
27301 @need 200
27302 @itemx -mvpclmulqdq
27303 @opindex mvpclmulqdq
27304 @need 200
27305 @itemx -mavx512bitalg
27306 @opindex mavx512bitalg
27307 @need 200
27308 @itemx -mmovdiri
27309 @opindex mmovdiri
27310 @need 200
27311 @itemx -mmovdir64b
27312 @opindex mmovdir64b
27313 @need 200
27314 @itemx -mavx512vpopcntdq
27315 @opindex mavx512vpopcntdq
27316 @need 200
27317 @itemx -mcldemote
27318 @opindex mcldemote
27319 These switches enable the use of instructions in the MMX, SSE,
27320 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
27321 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
27322 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES, WAITPKG,
27323 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
27324 GFNI, VPCLMULQDQ, AVX512BITALG, MOVDIRI, MOVDIR64B,
27325 AVX512VPOPCNTDQ, CLDEMOTE, 3DNow!@: or enhanced 3DNow!@: extended instruction
27326 sets. Each has a corresponding @option{-mno-} option to disable use of these
27327 instructions.
27329 These extensions are also available as built-in functions: see
27330 @ref{x86 Built-in Functions}, for details of the functions enabled and
27331 disabled by these switches.
27333 To generate SSE/SSE2 instructions automatically from floating-point
27334 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
27336 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
27337 generates new AVX instructions or AVX equivalence for all SSEx instructions
27338 when needed.
27340 These options enable GCC to use these extended instructions in
27341 generated code, even without @option{-mfpmath=sse}.  Applications that
27342 perform run-time CPU detection must compile separate files for each
27343 supported architecture, using the appropriate flags.  In particular,
27344 the file containing the CPU detection code should be compiled without
27345 these options.
27347 @item -mdump-tune-features
27348 @opindex mdump-tune-features
27349 This option instructs GCC to dump the names of the x86 performance 
27350 tuning features and default settings. The names can be used in 
27351 @option{-mtune-ctrl=@var{feature-list}}.
27353 @item -mtune-ctrl=@var{feature-list}
27354 @opindex mtune-ctrl=@var{feature-list}
27355 This option is used to do fine grain control of x86 code generation features.
27356 @var{feature-list} is a comma separated list of @var{feature} names. See also
27357 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
27358 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
27359 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
27360 developers. Using it may lead to code paths not covered by testing and can
27361 potentially result in compiler ICEs or runtime errors.
27363 @item -mno-default
27364 @opindex mno-default
27365 This option instructs GCC to turn off all tunable features. See also 
27366 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
27368 @item -mcld
27369 @opindex mcld
27370 This option instructs GCC to emit a @code{cld} instruction in the prologue
27371 of functions that use string instructions.  String instructions depend on
27372 the DF flag to select between autoincrement or autodecrement mode.  While the
27373 ABI specifies the DF flag to be cleared on function entry, some operating
27374 systems violate this specification by not clearing the DF flag in their
27375 exception dispatchers.  The exception handler can be invoked with the DF flag
27376 set, which leads to wrong direction mode when string instructions are used.
27377 This option can be enabled by default on 32-bit x86 targets by configuring
27378 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
27379 instructions can be suppressed with the @option{-mno-cld} compiler option
27380 in this case.
27382 @item -mvzeroupper
27383 @opindex mvzeroupper
27384 This option instructs GCC to emit a @code{vzeroupper} instruction
27385 before a transfer of control flow out of the function to minimize
27386 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
27387 intrinsics.
27389 @item -mprefer-avx128
27390 @opindex mprefer-avx128
27391 This option instructs GCC to use 128-bit AVX instructions instead of
27392 256-bit AVX instructions in the auto-vectorizer.
27394 @item -mprefer-vector-width=@var{opt}
27395 @opindex mprefer-vector-width
27396 This option instructs GCC to use @var{opt}-bit vector width in instructions
27397 instead of default on the selected platform.
27399 @table @samp
27400 @item none
27401 No extra limitations applied to GCC other than defined by the selected platform.
27403 @item 128
27404 Prefer 128-bit vector width for instructions.
27406 @item 256
27407 Prefer 256-bit vector width for instructions.
27409 @item 512
27410 Prefer 512-bit vector width for instructions.
27411 @end table
27413 @item -mcx16
27414 @opindex mcx16
27415 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
27416 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
27417 objects.  This is useful for atomic updates of data structures exceeding one
27418 machine word in size.  The compiler uses this instruction to implement
27419 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
27420 128-bit integers, a library call is always used.
27422 @item -msahf
27423 @opindex msahf
27424 This option enables generation of @code{SAHF} instructions in 64-bit code.
27425 Early Intel Pentium 4 CPUs with Intel 64 support,
27426 prior to the introduction of Pentium 4 G1 step in December 2005,
27427 lacked the @code{LAHF} and @code{SAHF} instructions
27428 which are supported by AMD64.
27429 These are load and store instructions, respectively, for certain status flags.
27430 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
27431 @code{drem}, and @code{remainder} built-in functions;
27432 see @ref{Other Builtins} for details.
27434 @item -mmovbe
27435 @opindex mmovbe
27436 This option enables use of the @code{movbe} instruction to implement
27437 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
27439 @item -mshstk
27440 @opindex mshstk
27441 The @option{-mshstk} option enables shadow stack built-in functions
27442 from x86 Control-flow Enforcement Technology (CET).
27444 @item -mcrc32
27445 @opindex mcrc32
27446 This option enables built-in functions @code{__builtin_ia32_crc32qi},
27447 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
27448 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
27450 @item -mrecip
27451 @opindex mrecip
27452 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
27453 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
27454 with an additional Newton-Raphson step
27455 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
27456 (and their vectorized
27457 variants) for single-precision floating-point arguments.  These instructions
27458 are generated only when @option{-funsafe-math-optimizations} is enabled
27459 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
27460 Note that while the throughput of the sequence is higher than the throughput
27461 of the non-reciprocal instruction, the precision of the sequence can be
27462 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
27464 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
27465 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
27466 combination), and doesn't need @option{-mrecip}.
27468 Also note that GCC emits the above sequence with additional Newton-Raphson step
27469 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
27470 already with @option{-ffast-math} (or the above option combination), and
27471 doesn't need @option{-mrecip}.
27473 @item -mrecip=@var{opt}
27474 @opindex mrecip=opt
27475 This option controls which reciprocal estimate instructions
27476 may be used.  @var{opt} is a comma-separated list of options, which may
27477 be preceded by a @samp{!} to invert the option:
27479 @table @samp
27480 @item all
27481 Enable all estimate instructions.
27483 @item default
27484 Enable the default instructions, equivalent to @option{-mrecip}.
27486 @item none
27487 Disable all estimate instructions, equivalent to @option{-mno-recip}.
27489 @item div
27490 Enable the approximation for scalar division.
27492 @item vec-div
27493 Enable the approximation for vectorized division.
27495 @item sqrt
27496 Enable the approximation for scalar square root.
27498 @item vec-sqrt
27499 Enable the approximation for vectorized square root.
27500 @end table
27502 So, for example, @option{-mrecip=all,!sqrt} enables
27503 all of the reciprocal approximations, except for square root.
27505 @item -mveclibabi=@var{type}
27506 @opindex mveclibabi
27507 Specifies the ABI type to use for vectorizing intrinsics using an
27508 external library.  Supported values for @var{type} are @samp{svml} 
27509 for the Intel short
27510 vector math library and @samp{acml} for the AMD math core library.
27511 To use this option, both @option{-ftree-vectorize} and
27512 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
27513 ABI-compatible library must be specified at link time.
27515 GCC currently emits calls to @code{vmldExp2},
27516 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
27517 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
27518 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
27519 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
27520 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
27521 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
27522 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
27523 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
27524 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
27525 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
27526 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
27527 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
27528 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
27529 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
27530 when @option{-mveclibabi=acml} is used.  
27532 @item -mabi=@var{name}
27533 @opindex mabi
27534 Generate code for the specified calling convention.  Permissible values
27535 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
27536 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
27537 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
27538 You can control this behavior for specific functions by
27539 using the function attributes @code{ms_abi} and @code{sysv_abi}.
27540 @xref{Function Attributes}.
27542 @item -mforce-indirect-call
27543 @opindex mforce-indirect-call
27544 Force all calls to functions to be indirect. This is useful
27545 when using Intel Processor Trace where it generates more precise timing
27546 information for function calls.
27548 @item -mcall-ms2sysv-xlogues
27549 @opindex mcall-ms2sysv-xlogues
27550 @opindex mno-call-ms2sysv-xlogues
27551 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
27552 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
27553 default, the code for saving and restoring these registers is emitted inline,
27554 resulting in fairly lengthy prologues and epilogues.  Using
27555 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
27556 use stubs in the static portion of libgcc to perform these saves and restores,
27557 thus reducing function size at the cost of a few extra instructions.
27559 @item -mtls-dialect=@var{type}
27560 @opindex mtls-dialect
27561 Generate code to access thread-local storage using the @samp{gnu} or
27562 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
27563 @samp{gnu2} is more efficient, but it may add compile- and run-time
27564 requirements that cannot be satisfied on all systems.
27566 @item -mpush-args
27567 @itemx -mno-push-args
27568 @opindex mpush-args
27569 @opindex mno-push-args
27570 Use PUSH operations to store outgoing parameters.  This method is shorter
27571 and usually equally fast as method using SUB/MOV operations and is enabled
27572 by default.  In some cases disabling it may improve performance because of
27573 improved scheduling and reduced dependencies.
27575 @item -maccumulate-outgoing-args
27576 @opindex maccumulate-outgoing-args
27577 If enabled, the maximum amount of space required for outgoing arguments is
27578 computed in the function prologue.  This is faster on most modern CPUs
27579 because of reduced dependencies, improved scheduling and reduced stack usage
27580 when the preferred stack boundary is not equal to 2.  The drawback is a notable
27581 increase in code size.  This switch implies @option{-mno-push-args}.
27583 @item -mthreads
27584 @opindex mthreads
27585 Support thread-safe exception handling on MinGW.  Programs that rely
27586 on thread-safe exception handling must compile and link all code with the
27587 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
27588 @option{-D_MT}; when linking, it links in a special thread helper library
27589 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
27591 @item -mms-bitfields
27592 @itemx -mno-ms-bitfields
27593 @opindex mms-bitfields
27594 @opindex mno-ms-bitfields
27596 Enable/disable bit-field layout compatible with the native Microsoft
27597 Windows compiler.  
27599 If @code{packed} is used on a structure, or if bit-fields are used,
27600 it may be that the Microsoft ABI lays out the structure differently
27601 than the way GCC normally does.  Particularly when moving packed
27602 data between functions compiled with GCC and the native Microsoft compiler
27603 (either via function call or as data in a file), it may be necessary to access
27604 either format.
27606 This option is enabled by default for Microsoft Windows
27607 targets.  This behavior can also be controlled locally by use of variable
27608 or type attributes.  For more information, see @ref{x86 Variable Attributes}
27609 and @ref{x86 Type Attributes}.
27611 The Microsoft structure layout algorithm is fairly simple with the exception
27612 of the bit-field packing.  
27613 The padding and alignment of members of structures and whether a bit-field 
27614 can straddle a storage-unit boundary are determine by these rules:
27616 @enumerate
27617 @item Structure members are stored sequentially in the order in which they are
27618 declared: the first member has the lowest memory address and the last member
27619 the highest.
27621 @item Every data object has an alignment requirement.  The alignment requirement
27622 for all data except structures, unions, and arrays is either the size of the
27623 object or the current packing size (specified with either the
27624 @code{aligned} attribute or the @code{pack} pragma),
27625 whichever is less.  For structures, unions, and arrays,
27626 the alignment requirement is the largest alignment requirement of its members.
27627 Every object is allocated an offset so that:
27629 @smallexample
27630 offset % alignment_requirement == 0
27631 @end smallexample
27633 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
27634 unit if the integral types are the same size and if the next bit-field fits
27635 into the current allocation unit without crossing the boundary imposed by the
27636 common alignment requirements of the bit-fields.
27637 @end enumerate
27639 MSVC interprets zero-length bit-fields in the following ways:
27641 @enumerate
27642 @item If a zero-length bit-field is inserted between two bit-fields that
27643 are normally coalesced, the bit-fields are not coalesced.
27645 For example:
27647 @smallexample
27648 struct
27649  @{
27650    unsigned long bf_1 : 12;
27651    unsigned long : 0;
27652    unsigned long bf_2 : 12;
27653  @} t1;
27654 @end smallexample
27656 @noindent
27657 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
27658 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
27660 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
27661 alignment of the zero-length bit-field is greater than the member that follows it,
27662 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
27664 For example:
27666 @smallexample
27667 struct
27668  @{
27669    char foo : 4;
27670    short : 0;
27671    char bar;
27672  @} t2;
27674 struct
27675  @{
27676    char foo : 4;
27677    short : 0;
27678    double bar;
27679  @} t3;
27680 @end smallexample
27682 @noindent
27683 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
27684 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
27685 bit-field does not affect the alignment of @code{bar} or, as a result, the size
27686 of the structure.
27688 Taking this into account, it is important to note the following:
27690 @enumerate
27691 @item If a zero-length bit-field follows a normal bit-field, the type of the
27692 zero-length bit-field may affect the alignment of the structure as whole. For
27693 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
27694 normal bit-field, and is of type short.
27696 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
27697 still affect the alignment of the structure:
27699 @smallexample
27700 struct
27701  @{
27702    char foo : 6;
27703    long : 0;
27704  @} t4;
27705 @end smallexample
27707 @noindent
27708 Here, @code{t4} takes up 4 bytes.
27709 @end enumerate
27711 @item Zero-length bit-fields following non-bit-field members are ignored:
27713 @smallexample
27714 struct
27715  @{
27716    char foo;
27717    long : 0;
27718    char bar;
27719  @} t5;
27720 @end smallexample
27722 @noindent
27723 Here, @code{t5} takes up 2 bytes.
27724 @end enumerate
27727 @item -mno-align-stringops
27728 @opindex mno-align-stringops
27729 Do not align the destination of inlined string operations.  This switch reduces
27730 code size and improves performance in case the destination is already aligned,
27731 but GCC doesn't know about it.
27733 @item -minline-all-stringops
27734 @opindex minline-all-stringops
27735 By default GCC inlines string operations only when the destination is 
27736 known to be aligned to least a 4-byte boundary.  
27737 This enables more inlining and increases code
27738 size, but may improve performance of code that depends on fast
27739 @code{memcpy}, @code{strlen},
27740 and @code{memset} for short lengths.
27742 @item -minline-stringops-dynamically
27743 @opindex minline-stringops-dynamically
27744 For string operations of unknown size, use run-time checks with
27745 inline code for small blocks and a library call for large blocks.
27747 @item -mstringop-strategy=@var{alg}
27748 @opindex mstringop-strategy=@var{alg}
27749 Override the internal decision heuristic for the particular algorithm to use
27750 for inlining string operations.  The allowed values for @var{alg} are:
27752 @table @samp
27753 @item rep_byte
27754 @itemx rep_4byte
27755 @itemx rep_8byte
27756 Expand using i386 @code{rep} prefix of the specified size.
27758 @item byte_loop
27759 @itemx loop
27760 @itemx unrolled_loop
27761 Expand into an inline loop.
27763 @item libcall
27764 Always use a library call.
27765 @end table
27767 @item -mmemcpy-strategy=@var{strategy}
27768 @opindex mmemcpy-strategy=@var{strategy}
27769 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
27770 should be inlined and what inline algorithm to use when the expected size
27771 of the copy operation is known. @var{strategy} 
27772 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
27773 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
27774 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
27775 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
27776 in the list must be specified in increasing order.  The minimal byte size for 
27777 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
27778 preceding range.
27780 @item -mmemset-strategy=@var{strategy}
27781 @opindex mmemset-strategy=@var{strategy}
27782 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
27783 @code{__builtin_memset} expansion.
27785 @item -momit-leaf-frame-pointer
27786 @opindex momit-leaf-frame-pointer
27787 Don't keep the frame pointer in a register for leaf functions.  This
27788 avoids the instructions to save, set up, and restore frame pointers and
27789 makes an extra register available in leaf functions.  The option
27790 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
27791 which might make debugging harder.
27793 @item -mtls-direct-seg-refs
27794 @itemx -mno-tls-direct-seg-refs
27795 @opindex mtls-direct-seg-refs
27796 Controls whether TLS variables may be accessed with offsets from the
27797 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
27798 or whether the thread base pointer must be added.  Whether or not this
27799 is valid depends on the operating system, and whether it maps the
27800 segment to cover the entire TLS area.
27802 For systems that use the GNU C Library, the default is on.
27804 @item -msse2avx
27805 @itemx -mno-sse2avx
27806 @opindex msse2avx
27807 Specify that the assembler should encode SSE instructions with VEX
27808 prefix.  The option @option{-mavx} turns this on by default.
27810 @item -mfentry
27811 @itemx -mno-fentry
27812 @opindex mfentry
27813 If profiling is active (@option{-pg}), put the profiling
27814 counter call before the prologue.
27815 Note: On x86 architectures the attribute @code{ms_hook_prologue}
27816 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
27818 @item -mrecord-mcount
27819 @itemx -mno-record-mcount
27820 @opindex mrecord-mcount
27821 If profiling is active (@option{-pg}), generate a __mcount_loc section
27822 that contains pointers to each profiling call. This is useful for
27823 automatically patching and out calls.
27825 @item -mnop-mcount
27826 @itemx -mno-nop-mcount
27827 @opindex mnop-mcount
27828 If profiling is active (@option{-pg}), generate the calls to
27829 the profiling functions as NOPs. This is useful when they
27830 should be patched in later dynamically. This is likely only
27831 useful together with @option{-mrecord-mcount}.
27833 @item -mskip-rax-setup
27834 @itemx -mno-skip-rax-setup
27835 @opindex mskip-rax-setup
27836 When generating code for the x86-64 architecture with SSE extensions
27837 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
27838 register when there are no variable arguments passed in vector registers.
27840 @strong{Warning:} Since RAX register is used to avoid unnecessarily
27841 saving vector registers on stack when passing variable arguments, the
27842 impacts of this option are callees may waste some stack space,
27843 misbehave or jump to a random location.  GCC 4.4 or newer don't have
27844 those issues, regardless the RAX register value.
27846 @item -m8bit-idiv
27847 @itemx -mno-8bit-idiv
27848 @opindex m8bit-idiv
27849 On some processors, like Intel Atom, 8-bit unsigned integer divide is
27850 much faster than 32-bit/64-bit integer divide.  This option generates a
27851 run-time check.  If both dividend and divisor are within range of 0
27852 to 255, 8-bit unsigned integer divide is used instead of
27853 32-bit/64-bit integer divide.
27855 @item -mavx256-split-unaligned-load
27856 @itemx -mavx256-split-unaligned-store
27857 @opindex mavx256-split-unaligned-load
27858 @opindex mavx256-split-unaligned-store
27859 Split 32-byte AVX unaligned load and store.
27861 @item -mstack-protector-guard=@var{guard}
27862 @itemx -mstack-protector-guard-reg=@var{reg}
27863 @itemx -mstack-protector-guard-offset=@var{offset}
27864 @opindex mstack-protector-guard
27865 @opindex mstack-protector-guard-reg
27866 @opindex mstack-protector-guard-offset
27867 Generate stack protection code using canary at @var{guard}.  Supported
27868 locations are @samp{global} for global canary or @samp{tls} for per-thread
27869 canary in the TLS block (the default).  This option has effect only when
27870 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
27872 With the latter choice the options
27873 @option{-mstack-protector-guard-reg=@var{reg}} and
27874 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
27875 which segment register (@code{%fs} or @code{%gs}) to use as base register
27876 for reading the canary, and from what offset from that base register.
27877 The default for those is as specified in the relevant ABI.
27879 @item -mmitigate-rop
27880 @opindex mmitigate-rop
27881 Try to avoid generating code sequences that contain unintended return
27882 opcodes, to mitigate against certain forms of attack. At the moment,
27883 this option is limited in what it can do and should not be relied
27884 on to provide serious protection.
27886 @item -mgeneral-regs-only
27887 @opindex mgeneral-regs-only
27888 Generate code that uses only the general-purpose registers.  This
27889 prevents the compiler from using floating-point, vector, mask and bound
27890 registers.
27892 @item -mindirect-branch=@var{choice}
27893 @opindex -mindirect-branch
27894 Convert indirect call and jump with @var{choice}.  The default is
27895 @samp{keep}, which keeps indirect call and jump unmodified.
27896 @samp{thunk} converts indirect call and jump to call and return thunk.
27897 @samp{thunk-inline} converts indirect call and jump to inlined call
27898 and return thunk.  @samp{thunk-extern} converts indirect call and jump
27899 to external call and return thunk provided in a separate object file.
27900 You can control this behavior for a specific function by using the
27901 function attribute @code{indirect_branch}.  @xref{Function Attributes}.
27903 Note that @option{-mcmodel=large} is incompatible with
27904 @option{-mindirect-branch=thunk} and
27905 @option{-mindirect-branch=thunk-extern} since the thunk function may
27906 not be reachable in the large code model.
27908 Note that @option{-mindirect-branch=thunk-extern} is incompatible with
27909 @option{-fcf-protection=branch} and @option{-fcheck-pointer-bounds}
27910 since the external thunk can not be modified to disable control-flow
27911 check.
27913 @item -mfunction-return=@var{choice}
27914 @opindex -mfunction-return
27915 Convert function return with @var{choice}.  The default is @samp{keep},
27916 which keeps function return unmodified.  @samp{thunk} converts function
27917 return to call and return thunk.  @samp{thunk-inline} converts function
27918 return to inlined call and return thunk.  @samp{thunk-extern} converts
27919 function return to external call and return thunk provided in a separate
27920 object file.  You can control this behavior for a specific function by
27921 using the function attribute @code{function_return}.
27922 @xref{Function Attributes}.
27924 Note that @option{-mcmodel=large} is incompatible with
27925 @option{-mfunction-return=thunk} and
27926 @option{-mfunction-return=thunk-extern} since the thunk function may
27927 not be reachable in the large code model.
27930 @item -mindirect-branch-register
27931 @opindex -mindirect-branch-register
27932 Force indirect call and jump via register.
27934 @end table
27936 These @samp{-m} switches are supported in addition to the above
27937 on x86-64 processors in 64-bit environments.
27939 @table @gcctabopt
27940 @item -m32
27941 @itemx -m64
27942 @itemx -mx32
27943 @itemx -m16
27944 @itemx -miamcu
27945 @opindex m32
27946 @opindex m64
27947 @opindex mx32
27948 @opindex m16
27949 @opindex miamcu
27950 Generate code for a 16-bit, 32-bit or 64-bit environment.
27951 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
27952 to 32 bits, and
27953 generates code that runs on any i386 system.
27955 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
27956 types to 64 bits, and generates code for the x86-64 architecture.
27957 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
27958 and @option{-mdynamic-no-pic} options.
27960 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
27961 to 32 bits, and
27962 generates code for the x86-64 architecture.
27964 The @option{-m16} option is the same as @option{-m32}, except for that
27965 it outputs the @code{.code16gcc} assembly directive at the beginning of
27966 the assembly output so that the binary can run in 16-bit mode.
27968 The @option{-miamcu} option generates code which conforms to Intel MCU
27969 psABI.  It requires the @option{-m32} option to be turned on.
27971 @item -mno-red-zone
27972 @opindex mno-red-zone
27973 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
27974 by the x86-64 ABI; it is a 128-byte area beyond the location of the
27975 stack pointer that is not modified by signal or interrupt handlers
27976 and therefore can be used for temporary data without adjusting the stack
27977 pointer.  The flag @option{-mno-red-zone} disables this red zone.
27979 @item -mcmodel=small
27980 @opindex mcmodel=small
27981 Generate code for the small code model: the program and its symbols must
27982 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
27983 Programs can be statically or dynamically linked.  This is the default
27984 code model.
27986 @item -mcmodel=kernel
27987 @opindex mcmodel=kernel
27988 Generate code for the kernel code model.  The kernel runs in the
27989 negative 2 GB of the address space.
27990 This model has to be used for Linux kernel code.
27992 @item -mcmodel=medium
27993 @opindex mcmodel=medium
27994 Generate code for the medium model: the program is linked in the lower 2
27995 GB of the address space.  Small symbols are also placed there.  Symbols
27996 with sizes larger than @option{-mlarge-data-threshold} are put into
27997 large data or BSS sections and can be located above 2GB.  Programs can
27998 be statically or dynamically linked.
28000 @item -mcmodel=large
28001 @opindex mcmodel=large
28002 Generate code for the large model.  This model makes no assumptions
28003 about addresses and sizes of sections.
28005 @item -maddress-mode=long
28006 @opindex maddress-mode=long
28007 Generate code for long address mode.  This is only supported for 64-bit
28008 and x32 environments.  It is the default address mode for 64-bit
28009 environments.
28011 @item -maddress-mode=short
28012 @opindex maddress-mode=short
28013 Generate code for short address mode.  This is only supported for 32-bit
28014 and x32 environments.  It is the default address mode for 32-bit and
28015 x32 environments.
28016 @end table
28018 @node x86 Windows Options
28019 @subsection x86 Windows Options
28020 @cindex x86 Windows Options
28021 @cindex Windows Options for x86
28023 These additional options are available for Microsoft Windows targets:
28025 @table @gcctabopt
28026 @item -mconsole
28027 @opindex mconsole
28028 This option
28029 specifies that a console application is to be generated, by
28030 instructing the linker to set the PE header subsystem type
28031 required for console applications.
28032 This option is available for Cygwin and MinGW targets and is
28033 enabled by default on those targets.
28035 @item -mdll
28036 @opindex mdll
28037 This option is available for Cygwin and MinGW targets.  It
28038 specifies that a DLL---a dynamic link library---is to be
28039 generated, enabling the selection of the required runtime
28040 startup object and entry point.
28042 @item -mnop-fun-dllimport
28043 @opindex mnop-fun-dllimport
28044 This option is available for Cygwin and MinGW targets.  It
28045 specifies that the @code{dllimport} attribute should be ignored.
28047 @item -mthread
28048 @opindex mthread
28049 This option is available for MinGW targets. It specifies
28050 that MinGW-specific thread support is to be used.
28052 @item -municode
28053 @opindex municode
28054 This option is available for MinGW-w64 targets.  It causes
28055 the @code{UNICODE} preprocessor macro to be predefined, and
28056 chooses Unicode-capable runtime startup code.
28058 @item -mwin32
28059 @opindex mwin32
28060 This option is available for Cygwin and MinGW targets.  It
28061 specifies that the typical Microsoft Windows predefined macros are to
28062 be set in the pre-processor, but does not influence the choice
28063 of runtime library/startup code.
28065 @item -mwindows
28066 @opindex mwindows
28067 This option is available for Cygwin and MinGW targets.  It
28068 specifies that a GUI application is to be generated by
28069 instructing the linker to set the PE header subsystem type
28070 appropriately.
28072 @item -fno-set-stack-executable
28073 @opindex fno-set-stack-executable
28074 This option is available for MinGW targets. It specifies that
28075 the executable flag for the stack used by nested functions isn't
28076 set. This is necessary for binaries running in kernel mode of
28077 Microsoft Windows, as there the User32 API, which is used to set executable
28078 privileges, isn't available.
28080 @item -fwritable-relocated-rdata
28081 @opindex fno-writable-relocated-rdata
28082 This option is available for MinGW and Cygwin targets.  It specifies
28083 that relocated-data in read-only section is put into the @code{.data}
28084 section.  This is a necessary for older runtimes not supporting
28085 modification of @code{.rdata} sections for pseudo-relocation.
28087 @item -mpe-aligned-commons
28088 @opindex mpe-aligned-commons
28089 This option is available for Cygwin and MinGW targets.  It
28090 specifies that the GNU extension to the PE file format that
28091 permits the correct alignment of COMMON variables should be
28092 used when generating code.  It is enabled by default if
28093 GCC detects that the target assembler found during configuration
28094 supports the feature.
28095 @end table
28097 See also under @ref{x86 Options} for standard options.
28099 @node Xstormy16 Options
28100 @subsection Xstormy16 Options
28101 @cindex Xstormy16 Options
28103 These options are defined for Xstormy16:
28105 @table @gcctabopt
28106 @item -msim
28107 @opindex msim
28108 Choose startup files and linker script suitable for the simulator.
28109 @end table
28111 @node Xtensa Options
28112 @subsection Xtensa Options
28113 @cindex Xtensa Options
28115 These options are supported for Xtensa targets:
28117 @table @gcctabopt
28118 @item -mconst16
28119 @itemx -mno-const16
28120 @opindex mconst16
28121 @opindex mno-const16
28122 Enable or disable use of @code{CONST16} instructions for loading
28123 constant values.  The @code{CONST16} instruction is currently not a
28124 standard option from Tensilica.  When enabled, @code{CONST16}
28125 instructions are always used in place of the standard @code{L32R}
28126 instructions.  The use of @code{CONST16} is enabled by default only if
28127 the @code{L32R} instruction is not available.
28129 @item -mfused-madd
28130 @itemx -mno-fused-madd
28131 @opindex mfused-madd
28132 @opindex mno-fused-madd
28133 Enable or disable use of fused multiply/add and multiply/subtract
28134 instructions in the floating-point option.  This has no effect if the
28135 floating-point option is not also enabled.  Disabling fused multiply/add
28136 and multiply/subtract instructions forces the compiler to use separate
28137 instructions for the multiply and add/subtract operations.  This may be
28138 desirable in some cases where strict IEEE 754-compliant results are
28139 required: the fused multiply add/subtract instructions do not round the
28140 intermediate result, thereby producing results with @emph{more} bits of
28141 precision than specified by the IEEE standard.  Disabling fused multiply
28142 add/subtract instructions also ensures that the program output is not
28143 sensitive to the compiler's ability to combine multiply and add/subtract
28144 operations.
28146 @item -mserialize-volatile
28147 @itemx -mno-serialize-volatile
28148 @opindex mserialize-volatile
28149 @opindex mno-serialize-volatile
28150 When this option is enabled, GCC inserts @code{MEMW} instructions before
28151 @code{volatile} memory references to guarantee sequential consistency.
28152 The default is @option{-mserialize-volatile}.  Use
28153 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
28155 @item -mforce-no-pic
28156 @opindex mforce-no-pic
28157 For targets, like GNU/Linux, where all user-mode Xtensa code must be
28158 position-independent code (PIC), this option disables PIC for compiling
28159 kernel code.
28161 @item -mtext-section-literals
28162 @itemx -mno-text-section-literals
28163 @opindex mtext-section-literals
28164 @opindex mno-text-section-literals
28165 These options control the treatment of literal pools.  The default is
28166 @option{-mno-text-section-literals}, which places literals in a separate
28167 section in the output file.  This allows the literal pool to be placed
28168 in a data RAM/ROM, and it also allows the linker to combine literal
28169 pools from separate object files to remove redundant literals and
28170 improve code size.  With @option{-mtext-section-literals}, the literals
28171 are interspersed in the text section in order to keep them as close as
28172 possible to their references.  This may be necessary for large assembly
28173 files.  Literals for each function are placed right before that function.
28175 @item -mauto-litpools
28176 @itemx -mno-auto-litpools
28177 @opindex mauto-litpools
28178 @opindex mno-auto-litpools
28179 These options control the treatment of literal pools.  The default is
28180 @option{-mno-auto-litpools}, which places literals in a separate
28181 section in the output file unless @option{-mtext-section-literals} is
28182 used.  With @option{-mauto-litpools} the literals are interspersed in
28183 the text section by the assembler.  Compiler does not produce explicit
28184 @code{.literal} directives and loads literals into registers with
28185 @code{MOVI} instructions instead of @code{L32R} to let the assembler
28186 do relaxation and place literals as necessary.  This option allows
28187 assembler to create several literal pools per function and assemble
28188 very big functions, which may not be possible with
28189 @option{-mtext-section-literals}.
28191 @item -mtarget-align
28192 @itemx -mno-target-align
28193 @opindex mtarget-align
28194 @opindex mno-target-align
28195 When this option is enabled, GCC instructs the assembler to
28196 automatically align instructions to reduce branch penalties at the
28197 expense of some code density.  The assembler attempts to widen density
28198 instructions to align branch targets and the instructions following call
28199 instructions.  If there are not enough preceding safe density
28200 instructions to align a target, no widening is performed.  The
28201 default is @option{-mtarget-align}.  These options do not affect the
28202 treatment of auto-aligned instructions like @code{LOOP}, which the
28203 assembler always aligns, either by widening density instructions or
28204 by inserting NOP instructions.
28206 @item -mlongcalls
28207 @itemx -mno-longcalls
28208 @opindex mlongcalls
28209 @opindex mno-longcalls
28210 When this option is enabled, GCC instructs the assembler to translate
28211 direct calls to indirect calls unless it can determine that the target
28212 of a direct call is in the range allowed by the call instruction.  This
28213 translation typically occurs for calls to functions in other source
28214 files.  Specifically, the assembler translates a direct @code{CALL}
28215 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
28216 The default is @option{-mno-longcalls}.  This option should be used in
28217 programs where the call target can potentially be out of range.  This
28218 option is implemented in the assembler, not the compiler, so the
28219 assembly code generated by GCC still shows direct call
28220 instructions---look at the disassembled object code to see the actual
28221 instructions.  Note that the assembler uses an indirect call for
28222 every cross-file call, not just those that really are out of range.
28223 @end table
28225 @node zSeries Options
28226 @subsection zSeries Options
28227 @cindex zSeries options
28229 These are listed under @xref{S/390 and zSeries Options}.
28232 @c man end
28234 @node Spec Files
28235 @section Specifying Subprocesses and the Switches to Pass to Them
28236 @cindex Spec Files
28238 @command{gcc} is a driver program.  It performs its job by invoking a
28239 sequence of other programs to do the work of compiling, assembling and
28240 linking.  GCC interprets its command-line parameters and uses these to
28241 deduce which programs it should invoke, and which command-line options
28242 it ought to place on their command lines.  This behavior is controlled
28243 by @dfn{spec strings}.  In most cases there is one spec string for each
28244 program that GCC can invoke, but a few programs have multiple spec
28245 strings to control their behavior.  The spec strings built into GCC can
28246 be overridden by using the @option{-specs=} command-line switch to specify
28247 a spec file.
28249 @dfn{Spec files} are plain-text files that are used to construct spec
28250 strings.  They consist of a sequence of directives separated by blank
28251 lines.  The type of directive is determined by the first non-whitespace
28252 character on the line, which can be one of the following:
28254 @table @code
28255 @item %@var{command}
28256 Issues a @var{command} to the spec file processor.  The commands that can
28257 appear here are:
28259 @table @code
28260 @item %include <@var{file}>
28261 @cindex @code{%include}
28262 Search for @var{file} and insert its text at the current point in the
28263 specs file.
28265 @item %include_noerr <@var{file}>
28266 @cindex @code{%include_noerr}
28267 Just like @samp{%include}, but do not generate an error message if the include
28268 file cannot be found.
28270 @item %rename @var{old_name} @var{new_name}
28271 @cindex @code{%rename}
28272 Rename the spec string @var{old_name} to @var{new_name}.
28274 @end table
28276 @item *[@var{spec_name}]:
28277 This tells the compiler to create, override or delete the named spec
28278 string.  All lines after this directive up to the next directive or
28279 blank line are considered to be the text for the spec string.  If this
28280 results in an empty string then the spec is deleted.  (Or, if the
28281 spec did not exist, then nothing happens.)  Otherwise, if the spec
28282 does not currently exist a new spec is created.  If the spec does
28283 exist then its contents are overridden by the text of this
28284 directive, unless the first character of that text is the @samp{+}
28285 character, in which case the text is appended to the spec.
28287 @item [@var{suffix}]:
28288 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
28289 and up to the next directive or blank line are considered to make up the
28290 spec string for the indicated suffix.  When the compiler encounters an
28291 input file with the named suffix, it processes the spec string in
28292 order to work out how to compile that file.  For example:
28294 @smallexample
28295 .ZZ:
28296 z-compile -input %i
28297 @end smallexample
28299 This says that any input file whose name ends in @samp{.ZZ} should be
28300 passed to the program @samp{z-compile}, which should be invoked with the
28301 command-line switch @option{-input} and with the result of performing the
28302 @samp{%i} substitution.  (See below.)
28304 As an alternative to providing a spec string, the text following a
28305 suffix directive can be one of the following:
28307 @table @code
28308 @item @@@var{language}
28309 This says that the suffix is an alias for a known @var{language}.  This is
28310 similar to using the @option{-x} command-line switch to GCC to specify a
28311 language explicitly.  For example:
28313 @smallexample
28314 .ZZ:
28315 @@c++
28316 @end smallexample
28318 Says that .ZZ files are, in fact, C++ source files.
28320 @item #@var{name}
28321 This causes an error messages saying:
28323 @smallexample
28324 @var{name} compiler not installed on this system.
28325 @end smallexample
28326 @end table
28328 GCC already has an extensive list of suffixes built into it.
28329 This directive adds an entry to the end of the list of suffixes, but
28330 since the list is searched from the end backwards, it is effectively
28331 possible to override earlier entries using this technique.
28333 @end table
28335 GCC has the following spec strings built into it.  Spec files can
28336 override these strings or create their own.  Note that individual
28337 targets can also add their own spec strings to this list.
28339 @smallexample
28340 asm          Options to pass to the assembler
28341 asm_final    Options to pass to the assembler post-processor
28342 cpp          Options to pass to the C preprocessor
28343 cc1          Options to pass to the C compiler
28344 cc1plus      Options to pass to the C++ compiler
28345 endfile      Object files to include at the end of the link
28346 link         Options to pass to the linker
28347 lib          Libraries to include on the command line to the linker
28348 libgcc       Decides which GCC support library to pass to the linker
28349 linker       Sets the name of the linker
28350 predefines   Defines to be passed to the C preprocessor
28351 signed_char  Defines to pass to CPP to say whether @code{char} is signed
28352              by default
28353 startfile    Object files to include at the start of the link
28354 @end smallexample
28356 Here is a small example of a spec file:
28358 @smallexample
28359 %rename lib                 old_lib
28361 *lib:
28362 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
28363 @end smallexample
28365 This example renames the spec called @samp{lib} to @samp{old_lib} and
28366 then overrides the previous definition of @samp{lib} with a new one.
28367 The new definition adds in some extra command-line options before
28368 including the text of the old definition.
28370 @dfn{Spec strings} are a list of command-line options to be passed to their
28371 corresponding program.  In addition, the spec strings can contain
28372 @samp{%}-prefixed sequences to substitute variable text or to
28373 conditionally insert text into the command line.  Using these constructs
28374 it is possible to generate quite complex command lines.
28376 Here is a table of all defined @samp{%}-sequences for spec
28377 strings.  Note that spaces are not generated automatically around the
28378 results of expanding these sequences.  Therefore you can concatenate them
28379 together or combine them with constant text in a single argument.
28381 @table @code
28382 @item %%
28383 Substitute one @samp{%} into the program name or argument.
28385 @item %i
28386 Substitute the name of the input file being processed.
28388 @item %b
28389 Substitute the basename of the input file being processed.
28390 This is the substring up to (and not including) the last period
28391 and not including the directory.
28393 @item %B
28394 This is the same as @samp{%b}, but include the file suffix (text after
28395 the last period).
28397 @item %d
28398 Marks the argument containing or following the @samp{%d} as a
28399 temporary file name, so that that file is deleted if GCC exits
28400 successfully.  Unlike @samp{%g}, this contributes no text to the
28401 argument.
28403 @item %g@var{suffix}
28404 Substitute a file name that has suffix @var{suffix} and is chosen
28405 once per compilation, and mark the argument in the same way as
28406 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
28407 name is now chosen in a way that is hard to predict even when previously
28408 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
28409 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
28410 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
28411 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
28412 was simply substituted with a file name chosen once per compilation,
28413 without regard to any appended suffix (which was therefore treated
28414 just like ordinary text), making such attacks more likely to succeed.
28416 @item %u@var{suffix}
28417 Like @samp{%g}, but generates a new temporary file name
28418 each time it appears instead of once per compilation.
28420 @item %U@var{suffix}
28421 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
28422 new one if there is no such last file name.  In the absence of any
28423 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
28424 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
28425 involves the generation of two distinct file names, one
28426 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
28427 simply substituted with a file name chosen for the previous @samp{%u},
28428 without regard to any appended suffix.
28430 @item %j@var{suffix}
28431 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
28432 writable, and if @option{-save-temps} is not used; 
28433 otherwise, substitute the name
28434 of a temporary file, just like @samp{%u}.  This temporary file is not
28435 meant for communication between processes, but rather as a junk
28436 disposal mechanism.
28438 @item %|@var{suffix}
28439 @itemx %m@var{suffix}
28440 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
28441 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
28442 all.  These are the two most common ways to instruct a program that it
28443 should read from standard input or write to standard output.  If you
28444 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
28445 construct: see for example @file{f/lang-specs.h}.
28447 @item %.@var{SUFFIX}
28448 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
28449 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
28450 terminated by the next space or %.
28452 @item %w
28453 Marks the argument containing or following the @samp{%w} as the
28454 designated output file of this compilation.  This puts the argument
28455 into the sequence of arguments that @samp{%o} substitutes.
28457 @item %o
28458 Substitutes the names of all the output files, with spaces
28459 automatically placed around them.  You should write spaces
28460 around the @samp{%o} as well or the results are undefined.
28461 @samp{%o} is for use in the specs for running the linker.
28462 Input files whose names have no recognized suffix are not compiled
28463 at all, but they are included among the output files, so they are
28464 linked.
28466 @item %O
28467 Substitutes the suffix for object files.  Note that this is
28468 handled specially when it immediately follows @samp{%g, %u, or %U},
28469 because of the need for those to form complete file names.  The
28470 handling is such that @samp{%O} is treated exactly as if it had already
28471 been substituted, except that @samp{%g, %u, and %U} do not currently
28472 support additional @var{suffix} characters following @samp{%O} as they do
28473 following, for example, @samp{.o}.
28475 @item %p
28476 Substitutes the standard macro predefinitions for the
28477 current target machine.  Use this when running @command{cpp}.
28479 @item %P
28480 Like @samp{%p}, but puts @samp{__} before and after the name of each
28481 predefined macro, except for macros that start with @samp{__} or with
28482 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
28485 @item %I
28486 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
28487 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
28488 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
28489 and @option{-imultilib} as necessary.
28491 @item %s
28492 Current argument is the name of a library or startup file of some sort.
28493 Search for that file in a standard list of directories and substitute
28494 the full name found.  The current working directory is included in the
28495 list of directories scanned.
28497 @item %T
28498 Current argument is the name of a linker script.  Search for that file
28499 in the current list of directories to scan for libraries. If the file
28500 is located insert a @option{--script} option into the command line
28501 followed by the full path name found.  If the file is not found then
28502 generate an error message.  Note: the current working directory is not
28503 searched.
28505 @item %e@var{str}
28506 Print @var{str} as an error message.  @var{str} is terminated by a newline.
28507 Use this when inconsistent options are detected.
28509 @item %(@var{name})
28510 Substitute the contents of spec string @var{name} at this point.
28512 @item %x@{@var{option}@}
28513 Accumulate an option for @samp{%X}.
28515 @item %X
28516 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
28517 spec string.
28519 @item %Y
28520 Output the accumulated assembler options specified by @option{-Wa}.
28522 @item %Z
28523 Output the accumulated preprocessor options specified by @option{-Wp}.
28525 @item %a
28526 Process the @code{asm} spec.  This is used to compute the
28527 switches to be passed to the assembler.
28529 @item %A
28530 Process the @code{asm_final} spec.  This is a spec string for
28531 passing switches to an assembler post-processor, if such a program is
28532 needed.
28534 @item %l
28535 Process the @code{link} spec.  This is the spec for computing the
28536 command line passed to the linker.  Typically it makes use of the
28537 @samp{%L %G %S %D and %E} sequences.
28539 @item %D
28540 Dump out a @option{-L} option for each directory that GCC believes might
28541 contain startup files.  If the target supports multilibs then the
28542 current multilib directory is prepended to each of these paths.
28544 @item %L
28545 Process the @code{lib} spec.  This is a spec string for deciding which
28546 libraries are included on the command line to the linker.
28548 @item %G
28549 Process the @code{libgcc} spec.  This is a spec string for deciding
28550 which GCC support library is included on the command line to the linker.
28552 @item %S
28553 Process the @code{startfile} spec.  This is a spec for deciding which
28554 object files are the first ones passed to the linker.  Typically
28555 this might be a file named @file{crt0.o}.
28557 @item %E
28558 Process the @code{endfile} spec.  This is a spec string that specifies
28559 the last object files that are passed to the linker.
28561 @item %C
28562 Process the @code{cpp} spec.  This is used to construct the arguments
28563 to be passed to the C preprocessor.
28565 @item %1
28566 Process the @code{cc1} spec.  This is used to construct the options to be
28567 passed to the actual C compiler (@command{cc1}).
28569 @item %2
28570 Process the @code{cc1plus} spec.  This is used to construct the options to be
28571 passed to the actual C++ compiler (@command{cc1plus}).
28573 @item %*
28574 Substitute the variable part of a matched option.  See below.
28575 Note that each comma in the substituted string is replaced by
28576 a single space.
28578 @item %<S
28579 Remove all occurrences of @code{-S} from the command line.  Note---this
28580 command is position dependent.  @samp{%} commands in the spec string
28581 before this one see @code{-S}, @samp{%} commands in the spec string
28582 after this one do not.
28584 @item %:@var{function}(@var{args})
28585 Call the named function @var{function}, passing it @var{args}.
28586 @var{args} is first processed as a nested spec string, then split
28587 into an argument vector in the usual fashion.  The function returns
28588 a string which is processed as if it had appeared literally as part
28589 of the current spec.
28591 The following built-in spec functions are provided:
28593 @table @code
28594 @item @code{getenv}
28595 The @code{getenv} spec function takes two arguments: an environment
28596 variable name and a string.  If the environment variable is not
28597 defined, a fatal error is issued.  Otherwise, the return value is the
28598 value of the environment variable concatenated with the string.  For
28599 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
28601 @smallexample
28602 %:getenv(TOPDIR /include)
28603 @end smallexample
28605 expands to @file{/path/to/top/include}.
28607 @item @code{if-exists}
28608 The @code{if-exists} spec function takes one argument, an absolute
28609 pathname to a file.  If the file exists, @code{if-exists} returns the
28610 pathname.  Here is a small example of its usage:
28612 @smallexample
28613 *startfile:
28614 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
28615 @end smallexample
28617 @item @code{if-exists-else}
28618 The @code{if-exists-else} spec function is similar to the @code{if-exists}
28619 spec function, except that it takes two arguments.  The first argument is
28620 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
28621 returns the pathname.  If it does not exist, it returns the second argument.
28622 This way, @code{if-exists-else} can be used to select one file or another,
28623 based on the existence of the first.  Here is a small example of its usage:
28625 @smallexample
28626 *startfile:
28627 crt0%O%s %:if-exists(crti%O%s) \
28628 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
28629 @end smallexample
28631 @item @code{replace-outfile}
28632 The @code{replace-outfile} spec function takes two arguments.  It looks for the
28633 first argument in the outfiles array and replaces it with the second argument.  Here
28634 is a small example of its usage:
28636 @smallexample
28637 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
28638 @end smallexample
28640 @item @code{remove-outfile}
28641 The @code{remove-outfile} spec function takes one argument.  It looks for the
28642 first argument in the outfiles array and removes it.  Here is a small example
28643 its usage:
28645 @smallexample
28646 %:remove-outfile(-lm)
28647 @end smallexample
28649 @item @code{pass-through-libs}
28650 The @code{pass-through-libs} spec function takes any number of arguments.  It
28651 finds any @option{-l} options and any non-options ending in @file{.a} (which it
28652 assumes are the names of linker input library archive files) and returns a
28653 result containing all the found arguments each prepended by
28654 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
28655 intended to be passed to the LTO linker plugin.
28657 @smallexample
28658 %:pass-through-libs(%G %L %G)
28659 @end smallexample
28661 @item @code{print-asm-header}
28662 The @code{print-asm-header} function takes no arguments and simply
28663 prints a banner like:
28665 @smallexample
28666 Assembler options
28667 =================
28669 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
28670 @end smallexample
28672 It is used to separate compiler options from assembler options
28673 in the @option{--target-help} output.
28674 @end table
28676 @item %@{S@}
28677 Substitutes the @code{-S} switch, if that switch is given to GCC@.
28678 If that switch is not specified, this substitutes nothing.  Note that
28679 the leading dash is omitted when specifying this option, and it is
28680 automatically inserted if the substitution is performed.  Thus the spec
28681 string @samp{%@{foo@}} matches the command-line option @option{-foo}
28682 and outputs the command-line option @option{-foo}.
28684 @item %W@{S@}
28685 Like %@{@code{S}@} but mark last argument supplied within as a file to be
28686 deleted on failure.
28688 @item %@{S*@}
28689 Substitutes all the switches specified to GCC whose names start
28690 with @code{-S}, but which also take an argument.  This is used for
28691 switches like @option{-o}, @option{-D}, @option{-I}, etc.
28692 GCC considers @option{-o foo} as being
28693 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
28694 text, including the space.  Thus two arguments are generated.
28696 @item %@{S*&T*@}
28697 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
28698 (the order of @code{S} and @code{T} in the spec is not significant).
28699 There can be any number of ampersand-separated variables; for each the
28700 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
28702 @item %@{S:X@}
28703 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
28705 @item %@{!S:X@}
28706 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
28708 @item %@{S*:X@}
28709 Substitutes @code{X} if one or more switches whose names start with
28710 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
28711 once, no matter how many such switches appeared.  However, if @code{%*}
28712 appears somewhere in @code{X}, then @code{X} is substituted once
28713 for each matching switch, with the @code{%*} replaced by the part of
28714 that switch matching the @code{*}.
28716 If @code{%*} appears as the last part of a spec sequence then a space
28717 is added after the end of the last substitution.  If there is more
28718 text in the sequence, however, then a space is not generated.  This
28719 allows the @code{%*} substitution to be used as part of a larger
28720 string.  For example, a spec string like this:
28722 @smallexample
28723 %@{mcu=*:--script=%*/memory.ld@}
28724 @end smallexample
28726 @noindent
28727 when matching an option like @option{-mcu=newchip} produces:
28729 @smallexample
28730 --script=newchip/memory.ld
28731 @end smallexample
28733 @item %@{.S:X@}
28734 Substitutes @code{X}, if processing a file with suffix @code{S}.
28736 @item %@{!.S:X@}
28737 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
28739 @item %@{,S:X@}
28740 Substitutes @code{X}, if processing a file for language @code{S}.
28742 @item %@{!,S:X@}
28743 Substitutes @code{X}, if not processing a file for language @code{S}.
28745 @item %@{S|P:X@}
28746 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
28747 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
28748 @code{*} sequences as well, although they have a stronger binding than
28749 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
28750 alternatives must be starred, and only the first matching alternative
28751 is substituted.
28753 For example, a spec string like this:
28755 @smallexample
28756 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
28757 @end smallexample
28759 @noindent
28760 outputs the following command-line options from the following input
28761 command-line options:
28763 @smallexample
28764 fred.c        -foo -baz
28765 jim.d         -bar -boggle
28766 -d fred.c     -foo -baz -boggle
28767 -d jim.d      -bar -baz -boggle
28768 @end smallexample
28770 @item %@{S:X; T:Y; :D@}
28772 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
28773 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
28774 be as many clauses as you need.  This may be combined with @code{.},
28775 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
28778 @end table
28780 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
28781 or similar construct can use a backslash to ignore the special meaning
28782 of the character following it, thus allowing literal matching of a
28783 character that is otherwise specially treated.  For example,
28784 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
28785 @option{-std=iso9899:1999} option is given.
28787 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
28788 construct may contain other nested @samp{%} constructs or spaces, or
28789 even newlines.  They are processed as usual, as described above.
28790 Trailing white space in @code{X} is ignored.  White space may also
28791 appear anywhere on the left side of the colon in these constructs,
28792 except between @code{.} or @code{*} and the corresponding word.
28794 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
28795 handled specifically in these constructs.  If another value of
28796 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
28797 @option{-W} switch is found later in the command line, the earlier
28798 switch value is ignored, except with @{@code{S}*@} where @code{S} is
28799 just one letter, which passes all matching options.
28801 The character @samp{|} at the beginning of the predicate text is used to
28802 indicate that a command should be piped to the following command, but
28803 only if @option{-pipe} is specified.
28805 It is built into GCC which switches take arguments and which do not.
28806 (You might think it would be useful to generalize this to allow each
28807 compiler's spec to say which switches take arguments.  But this cannot
28808 be done in a consistent fashion.  GCC cannot even decide which input
28809 files have been specified without knowing which switches take arguments,
28810 and it must know which input files to compile in order to tell which
28811 compilers to run).
28813 GCC also knows implicitly that arguments starting in @option{-l} are to be
28814 treated as compiler output files, and passed to the linker in their
28815 proper position among the other output files.
28817 @node Environment Variables
28818 @section Environment Variables Affecting GCC
28819 @cindex environment variables
28821 @c man begin ENVIRONMENT
28822 This section describes several environment variables that affect how GCC
28823 operates.  Some of them work by specifying directories or prefixes to use
28824 when searching for various kinds of files.  Some are used to specify other
28825 aspects of the compilation environment.
28827 Note that you can also specify places to search using options such as
28828 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
28829 take precedence over places specified using environment variables, which
28830 in turn take precedence over those specified by the configuration of GCC@.
28831 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
28832 GNU Compiler Collection (GCC) Internals}.
28834 @table @env
28835 @item LANG
28836 @itemx LC_CTYPE
28837 @c @itemx LC_COLLATE
28838 @itemx LC_MESSAGES
28839 @c @itemx LC_MONETARY
28840 @c @itemx LC_NUMERIC
28841 @c @itemx LC_TIME
28842 @itemx LC_ALL
28843 @findex LANG
28844 @findex LC_CTYPE
28845 @c @findex LC_COLLATE
28846 @findex LC_MESSAGES
28847 @c @findex LC_MONETARY
28848 @c @findex LC_NUMERIC
28849 @c @findex LC_TIME
28850 @findex LC_ALL
28851 @cindex locale
28852 These environment variables control the way that GCC uses
28853 localization information which allows GCC to work with different
28854 national conventions.  GCC inspects the locale categories
28855 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
28856 so.  These locale categories can be set to any value supported by your
28857 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
28858 Kingdom encoded in UTF-8.
28860 The @env{LC_CTYPE} environment variable specifies character
28861 classification.  GCC uses it to determine the character boundaries in
28862 a string; this is needed for some multibyte encodings that contain quote
28863 and escape characters that are otherwise interpreted as a string
28864 end or escape.
28866 The @env{LC_MESSAGES} environment variable specifies the language to
28867 use in diagnostic messages.
28869 If the @env{LC_ALL} environment variable is set, it overrides the value
28870 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
28871 and @env{LC_MESSAGES} default to the value of the @env{LANG}
28872 environment variable.  If none of these variables are set, GCC
28873 defaults to traditional C English behavior.
28875 @item TMPDIR
28876 @findex TMPDIR
28877 If @env{TMPDIR} is set, it specifies the directory to use for temporary
28878 files.  GCC uses temporary files to hold the output of one stage of
28879 compilation which is to be used as input to the next stage: for example,
28880 the output of the preprocessor, which is the input to the compiler
28881 proper.
28883 @item GCC_COMPARE_DEBUG
28884 @findex GCC_COMPARE_DEBUG
28885 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
28886 @option{-fcompare-debug} to the compiler driver.  See the documentation
28887 of this option for more details.
28889 @item GCC_EXEC_PREFIX
28890 @findex GCC_EXEC_PREFIX
28891 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
28892 names of the subprograms executed by the compiler.  No slash is added
28893 when this prefix is combined with the name of a subprogram, but you can
28894 specify a prefix that ends with a slash if you wish.
28896 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
28897 an appropriate prefix to use based on the pathname it is invoked with.
28899 If GCC cannot find the subprogram using the specified prefix, it
28900 tries looking in the usual places for the subprogram.
28902 The default value of @env{GCC_EXEC_PREFIX} is
28903 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
28904 the installed compiler. In many cases @var{prefix} is the value
28905 of @code{prefix} when you ran the @file{configure} script.
28907 Other prefixes specified with @option{-B} take precedence over this prefix.
28909 This prefix is also used for finding files such as @file{crt0.o} that are
28910 used for linking.
28912 In addition, the prefix is used in an unusual way in finding the
28913 directories to search for header files.  For each of the standard
28914 directories whose name normally begins with @samp{/usr/local/lib/gcc}
28915 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
28916 replacing that beginning with the specified prefix to produce an
28917 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
28918 @file{foo/bar} just before it searches the standard directory 
28919 @file{/usr/local/lib/bar}.
28920 If a standard directory begins with the configured
28921 @var{prefix} then the value of @var{prefix} is replaced by
28922 @env{GCC_EXEC_PREFIX} when looking for header files.
28924 @item COMPILER_PATH
28925 @findex COMPILER_PATH
28926 The value of @env{COMPILER_PATH} is a colon-separated list of
28927 directories, much like @env{PATH}.  GCC tries the directories thus
28928 specified when searching for subprograms, if it cannot find the
28929 subprograms using @env{GCC_EXEC_PREFIX}.
28931 @item LIBRARY_PATH
28932 @findex LIBRARY_PATH
28933 The value of @env{LIBRARY_PATH} is a colon-separated list of
28934 directories, much like @env{PATH}.  When configured as a native compiler,
28935 GCC tries the directories thus specified when searching for special
28936 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
28937 using GCC also uses these directories when searching for ordinary
28938 libraries for the @option{-l} option (but directories specified with
28939 @option{-L} come first).
28941 @item LANG
28942 @findex LANG
28943 @cindex locale definition
28944 This variable is used to pass locale information to the compiler.  One way in
28945 which this information is used is to determine the character set to be used
28946 when character literals, string literals and comments are parsed in C and C++.
28947 When the compiler is configured to allow multibyte characters,
28948 the following values for @env{LANG} are recognized:
28950 @table @samp
28951 @item C-JIS
28952 Recognize JIS characters.
28953 @item C-SJIS
28954 Recognize SJIS characters.
28955 @item C-EUCJP
28956 Recognize EUCJP characters.
28957 @end table
28959 If @env{LANG} is not defined, or if it has some other value, then the
28960 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
28961 recognize and translate multibyte characters.
28962 @end table
28964 @noindent
28965 Some additional environment variables affect the behavior of the
28966 preprocessor.
28968 @include cppenv.texi
28970 @c man end
28972 @node Precompiled Headers
28973 @section Using Precompiled Headers
28974 @cindex precompiled headers
28975 @cindex speed of compilation
28977 Often large projects have many header files that are included in every
28978 source file.  The time the compiler takes to process these header files
28979 over and over again can account for nearly all of the time required to
28980 build the project.  To make builds faster, GCC allows you to
28981 @dfn{precompile} a header file.
28983 To create a precompiled header file, simply compile it as you would any
28984 other file, if necessary using the @option{-x} option to make the driver
28985 treat it as a C or C++ header file.  You may want to use a
28986 tool like @command{make} to keep the precompiled header up-to-date when
28987 the headers it contains change.
28989 A precompiled header file is searched for when @code{#include} is
28990 seen in the compilation.  As it searches for the included file
28991 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
28992 compiler looks for a precompiled header in each directory just before it
28993 looks for the include file in that directory.  The name searched for is
28994 the name specified in the @code{#include} with @samp{.gch} appended.  If
28995 the precompiled header file cannot be used, it is ignored.
28997 For instance, if you have @code{#include "all.h"}, and you have
28998 @file{all.h.gch} in the same directory as @file{all.h}, then the
28999 precompiled header file is used if possible, and the original
29000 header is used otherwise.
29002 Alternatively, you might decide to put the precompiled header file in a
29003 directory and use @option{-I} to ensure that directory is searched
29004 before (or instead of) the directory containing the original header.
29005 Then, if you want to check that the precompiled header file is always
29006 used, you can put a file of the same name as the original header in this
29007 directory containing an @code{#error} command.
29009 This also works with @option{-include}.  So yet another way to use
29010 precompiled headers, good for projects not designed with precompiled
29011 header files in mind, is to simply take most of the header files used by
29012 a project, include them from another header file, precompile that header
29013 file, and @option{-include} the precompiled header.  If the header files
29014 have guards against multiple inclusion, they are skipped because
29015 they've already been included (in the precompiled header).
29017 If you need to precompile the same header file for different
29018 languages, targets, or compiler options, you can instead make a
29019 @emph{directory} named like @file{all.h.gch}, and put each precompiled
29020 header in the directory, perhaps using @option{-o}.  It doesn't matter
29021 what you call the files in the directory; every precompiled header in
29022 the directory is considered.  The first precompiled header
29023 encountered in the directory that is valid for this compilation is
29024 used; they're searched in no particular order.
29026 There are many other possibilities, limited only by your imagination,
29027 good sense, and the constraints of your build system.
29029 A precompiled header file can be used only when these conditions apply:
29031 @itemize
29032 @item
29033 Only one precompiled header can be used in a particular compilation.
29035 @item
29036 A precompiled header cannot be used once the first C token is seen.  You
29037 can have preprocessor directives before a precompiled header; you cannot
29038 include a precompiled header from inside another header.
29040 @item
29041 The precompiled header file must be produced for the same language as
29042 the current compilation.  You cannot use a C precompiled header for a C++
29043 compilation.
29045 @item
29046 The precompiled header file must have been produced by the same compiler
29047 binary as the current compilation is using.
29049 @item
29050 Any macros defined before the precompiled header is included must
29051 either be defined in the same way as when the precompiled header was
29052 generated, or must not affect the precompiled header, which usually
29053 means that they don't appear in the precompiled header at all.
29055 The @option{-D} option is one way to define a macro before a
29056 precompiled header is included; using a @code{#define} can also do it.
29057 There are also some options that define macros implicitly, like
29058 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
29059 defined this way.
29061 @item If debugging information is output when using the precompiled
29062 header, using @option{-g} or similar, the same kind of debugging information
29063 must have been output when building the precompiled header.  However,
29064 a precompiled header built using @option{-g} can be used in a compilation
29065 when no debugging information is being output.
29067 @item The same @option{-m} options must generally be used when building
29068 and using the precompiled header.  @xref{Submodel Options},
29069 for any cases where this rule is relaxed.
29071 @item Each of the following options must be the same when building and using
29072 the precompiled header:
29074 @gccoptlist{-fexceptions}
29076 @item
29077 Some other command-line options starting with @option{-f},
29078 @option{-p}, or @option{-O} must be defined in the same way as when
29079 the precompiled header was generated.  At present, it's not clear
29080 which options are safe to change and which are not; the safest choice
29081 is to use exactly the same options when generating and using the
29082 precompiled header.  The following are known to be safe:
29084 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
29085 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
29086 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
29087 -pedantic-errors}
29089 @end itemize
29091 For all of these except the last, the compiler automatically
29092 ignores the precompiled header if the conditions aren't met.  If you
29093 find an option combination that doesn't work and doesn't cause the
29094 precompiled header to be ignored, please consider filing a bug report,
29095 see @ref{Bugs}.
29097 If you do use differing options when generating and using the
29098 precompiled header, the actual behavior is a mixture of the
29099 behavior for the options.  For instance, if you use @option{-g} to
29100 generate the precompiled header but not when using it, you may or may
29101 not get debugging information for routines in the precompiled header.