2017-10-16 Tamar Christina <tamar.christina@arm.com>
[official-gcc.git] / gcc / doc / invoke.texi
blobb358e09b45d6019d7053cd677907f9aee9a3c7bd
1 @c Copyright (C) 1988-2017 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-2017 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), adb(1), dbx(1), sdb(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}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
219 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
220 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
221 -Wno-non-template-friend  -Wold-style-cast @gol
222 -Woverloaded-virtual  -Wno-pmf-conversions @gol
223 -Wsign-promo  -Wvirtual-inheritance}
225 @item Objective-C and Objective-C++ Language Options
226 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
227 Objective-C and Objective-C++ Dialects}.
228 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
229 -fgnu-runtime  -fnext-runtime @gol
230 -fno-nil-receivers @gol
231 -fobjc-abi-version=@var{n} @gol
232 -fobjc-call-cxx-cdtors @gol
233 -fobjc-direct-dispatch @gol
234 -fobjc-exceptions @gol
235 -fobjc-gc @gol
236 -fobjc-nilcheck @gol
237 -fobjc-std=objc1 @gol
238 -fno-local-ivars @gol
239 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
240 -freplace-objc-classes @gol
241 -fzero-link @gol
242 -gen-decls @gol
243 -Wassign-intercept @gol
244 -Wno-protocol  -Wselector @gol
245 -Wstrict-selector-match @gol
246 -Wundeclared-selector}
248 @item Diagnostic Message Formatting Options
249 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
250 @gccoptlist{-fmessage-length=@var{n}  @gol
251 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
252 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
253 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
254 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
255 -fdiagnostics-show-template-tree -fno-elide-type @gol
256 -fno-show-column}
258 @item Warning Options
259 @xref{Warning Options,,Options to Request or Suppress Warnings}.
260 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
261 -pedantic-errors @gol
262 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
263 -Walloc-zero  -Walloc-size-larger-than=@var{n}
264 -Walloca  -Walloca-larger-than=@var{n} @gol
265 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
266 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
267 -Wno-builtin-declaration-mismatch @gol
268 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
269 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  @gol
270 -Wcast-align  -Wcast-align=strict  -Wcast-qual  @gol
271 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
272 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
273 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
274 -Wdelete-incomplete @gol
275 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
276 -Wdisabled-optimization @gol
277 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
278 -Wno-div-by-zero  -Wdouble-promotion @gol
279 -Wduplicated-branches  -Wduplicated-cond @gol
280 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
281 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
282 -Wfloat-equal  -Wformat  -Wformat=2 @gol
283 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
284 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
285 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
286 -Wformat-y2k  -Wframe-address @gol
287 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
288 -Wif-not-aligned @gol
289 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
290 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
291 -Wimplicit-function-declaration  -Wimplicit-int @gol
292 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
293 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
294 -Winvalid-pch  -Wlarger-than=@var{len} @gol
295 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
296 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
297 -Wmisleading-indentation  -Wmissing-braces @gol
298 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
299 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
300 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
301 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
302 -Woverride-init-side-effects  -Woverlength-strings @gol
303 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
304 -Wparentheses  -Wno-pedantic-ms-format @gol
305 -Wplacement-new  -Wplacement-new=@var{n} @gol
306 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
307 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
308 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
309 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
310 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
311 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
312 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
313 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
314 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
315 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
316 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
317 -Wstringop-overflow=@var{n} @gol
318 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
319 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
320 -Wmissing-format-attribute  -Wsubobject-linkage @gol
321 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
322 -Wswitch-unreachable  -Wsync-nand @gol
323 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
324 -Wtype-limits  -Wundef @gol
325 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
326 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
327 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
328 -Wunused-parameter  -Wno-unused-result @gol
329 -Wunused-value  -Wunused-variable @gol
330 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
331 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
332 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
333 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
334 -Wzero-as-null-pointer-constant  -Whsa}
336 @item C and Objective-C-only Warning Options
337 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
338 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
339 -Wold-style-declaration  -Wold-style-definition @gol
340 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
341 -Wdeclaration-after-statement  -Wpointer-sign}
343 @item Debugging Options
344 @xref{Debugging Options,,Options for Debugging Your Program}.
345 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-@var{version} @gol
346 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
347 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
348 -gcolumn-info  -gno-column-info @gol
349 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
350 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
351 -fno-eliminate-unused-debug-types @gol
352 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
353 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
354 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
355 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
356 -fvar-tracking  -fvar-tracking-assignments}
358 @item Optimization Options
359 @xref{Optimize Options,,Options that Control Optimization}.
360 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
361 -falign-jumps[=@var{n}] @gol
362 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
363 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
364 -fauto-inc-dec  -fbranch-probabilities @gol
365 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
366 -fbtr-bb-exclusive  -fcaller-saves @gol
367 -fcombine-stack-adjustments  -fconserve-stack @gol
368 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
369 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
370 -fcx-limited-range @gol
371 -fdata-sections  -fdce  -fdelayed-branch @gol
372 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
373 -fdevirtualize-at-ltrans  -fdse @gol
374 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
375 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
376 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
377 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
378 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
379 -fif-conversion2  -findirect-inlining @gol
380 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
381 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
382 -fipa-bit-cp -fipa-vrp @gol
383 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
384 -fira-algorithm=@var{algorithm} @gol
385 -fira-region=@var{region}  -fira-hoist-pressure @gol
386 -fira-loop-pressure  -fno-ira-share-save-slots @gol
387 -fno-ira-share-spill-slots @gol
388 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
389 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
390 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
391 -floop-block  -floop-interchange  -floop-strip-mine @gol
392 -floop-unroll-and-jam  -floop-nest-optimize @gol
393 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
394 -flto-partition=@var{alg}  -fmerge-all-constants @gol
395 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
396 -fmove-loop-invariants  -fno-branch-count-reg @gol
397 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
398 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
399 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
400 -fno-sched-spec  -fno-signed-zeros @gol
401 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
402 -fomit-frame-pointer  -foptimize-sibling-calls @gol
403 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
404 -fprefetch-loop-arrays @gol
405 -fprofile-correction @gol
406 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
407 -fprofile-reorder-functions @gol
408 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
409 -freorder-blocks-algorithm=@var{algorithm} @gol
410 -freorder-blocks-and-partition  -freorder-functions @gol
411 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
412 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
413 -fsched-spec-load  -fsched-spec-load-dangerous @gol
414 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
415 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
416 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
417 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
418 -fschedule-fusion @gol
419 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
420 -fselective-scheduling  -fselective-scheduling2 @gol
421 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
422 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
423 -fsignaling-nans @gol
424 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
425 -fsplit-paths @gol
426 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
427 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
428 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
429 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
430 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
431 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
432 -ftree-loop-if-convert  -ftree-loop-im @gol
433 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
434 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
435 -ftree-loop-vectorize @gol
436 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
437 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
438 -ftree-switch-conversion  -ftree-tail-merge @gol
439 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
440 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
441 -funsafe-math-optimizations  -funswitch-loops @gol
442 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
443 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
444 --param @var{name}=@var{value}
445 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
447 @item Program Instrumentation Options
448 @xref{Instrumentation Options,,Program Instrumentation Options}.
449 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
450 -fprofile-abs-path @gol
451 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
452 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
453 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
454 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
455 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
456 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
457 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
458 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
459 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
460 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
461 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
462 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
463 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
464 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
465 -fstack-protector-explicit  -fstack-check @gol
466 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
467 -fno-stack-limit  -fsplit-stack @gol
468 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
469 -fvtv-counts  -fvtv-debug @gol
470 -finstrument-functions @gol
471 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
472 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
474 @item Preprocessor Options
475 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
476 @gccoptlist{-A@var{question}=@var{answer} @gol
477 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
478 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
479 -dD  -dI  -dM  -dN  -dU @gol
480 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
481 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
482 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
483 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
484 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
485 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
486 -H  -imacros @var{file}  -include @var{file} @gol
487 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
488 -no-integrated-cpp  -P  -pthread  -remap @gol
489 -traditional  -traditional-cpp  -trigraphs @gol
490 -U@var{macro}  -undef  @gol
491 -Wp,@var{option}  -Xpreprocessor @var{option}}
493 @item Assembler Options
494 @xref{Assembler Options,,Passing Options to the Assembler}.
495 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
497 @item Linker Options
498 @xref{Link Options,,Options for Linking}.
499 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
500 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
501 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
502 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
503 -static-libmpx  -static-libmpxwrappers @gol
504 -shared  -shared-libgcc  -symbolic @gol
505 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
506 -u @var{symbol}  -z @var{keyword}}
508 @item Directory Options
509 @xref{Directory Options,,Options for Directory Search}.
510 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
511 -idirafter @var{dir} @gol
512 -imacros @var{file}  -imultilib @var{dir} @gol
513 -iplugindir=@var{dir}  -iprefix @var{file} @gol
514 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
515 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
516 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
517 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
519 @item Code Generation Options
520 @xref{Code Gen Options,,Options for Code Generation Conventions}.
521 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
522 -ffixed-@var{reg}  -fexceptions @gol
523 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
524 -fasynchronous-unwind-tables @gol
525 -fno-gnu-unique @gol
526 -finhibit-size-directive  -fno-common  -fno-ident @gol
527 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
528 -fno-jump-tables @gol
529 -frecord-gcc-switches @gol
530 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
531 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
532 -fleading-underscore  -ftls-model=@var{model} @gol
533 -fstack-reuse=@var{reuse_level} @gol
534 -ftrampolines  -ftrapv  -fwrapv @gol
535 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
536 -fstrict-volatile-bitfields  -fsync-libcalls}
538 @item Developer Options
539 @xref{Developer Options,,GCC Developer Options}.
540 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
541 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
542 -fdbg-cnt=@var{counter-value-list} @gol
543 -fdisable-ipa-@var{pass_name} @gol
544 -fdisable-rtl-@var{pass_name} @gol
545 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
546 -fdisable-tree-@var{pass_name} @gol
547 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
548 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
549 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
550 -fdump-final-insns@r{[}=@var{file}@r{]}
551 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
552 -fdump-lang-all @gol
553 -fdump-lang-@var{switch} @gol
554 -fdump-lang-@var{switch}-@var{options} @gol
555 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
556 -fdump-passes @gol
557 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
558 -fdump-statistics @gol
559 -fdump-tree-all @gol
560 -fdump-tree-@var{switch} @gol
561 -fdump-tree-@var{switch}-@var{options} @gol
562 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
563 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
564 -fenable-@var{kind}-@var{pass} @gol
565 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
566 -fira-verbose=@var{n} @gol
567 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
568 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
569 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
570 -fprofile-report @gol
571 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
572 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
573 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
574 -fvar-tracking-assignments-toggle  -gtoggle @gol
575 -print-file-name=@var{library}  -print-libgcc-file-name @gol
576 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
577 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
578 -print-sysroot  -print-sysroot-headers-suffix @gol
579 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
581 @item Machine-Dependent Options
582 @xref{Submodel Options,,Machine-Dependent Options}.
583 @c This list is ordered alphanumerically by subsection name.
584 @c Try and put the significant identifier (CPU or system) first,
585 @c so users have a clue at guessing where the ones they want will be.
587 @emph{AArch64 Options}
588 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
589 -mgeneral-regs-only @gol
590 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
591 -mstrict-align @gol
592 -momit-leaf-frame-pointer @gol
593 -mtls-dialect=desc  -mtls-dialect=traditional @gol
594 -mtls-size=@var{size} @gol
595 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
596 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
597 -mpc-relative-literal-loads @gol
598 -msign-return-address=@var{scope} @gol
599 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  -moverride=@var{string}}
601 @emph{Adapteva Epiphany Options}
602 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
603 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
604 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
605 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
606 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
607 -msplit-vecmove-early  -m1reg-@var{reg}}
609 @emph{ARC Options}
610 @gccoptlist{-mbarrel-shifter @gol
611 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
612 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
613 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
614 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
615 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
616 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
617 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
618 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
619 -mvolatile-cache  -mtp-regno=@var{regno} @gol
620 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
621 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
622 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
623 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
624 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
625 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
626 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
627 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
629 @emph{ARM Options}
630 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
631 -mabi=@var{name} @gol
632 -mapcs-stack-check  -mno-apcs-stack-check @gol
633 -mapcs-reentrant  -mno-apcs-reentrant @gol
634 -msched-prolog  -mno-sched-prolog @gol
635 -mlittle-endian  -mbig-endian @gol
636 -mbe8 -mbe32 @gol
637 -mfloat-abi=@var{name} @gol
638 -mfp16-format=@var{name}
639 -mthumb-interwork  -mno-thumb-interwork @gol
640 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
641 -mtune=@var{name}  -mprint-tune-info @gol
642 -mstructure-size-boundary=@var{n} @gol
643 -mabort-on-noreturn @gol
644 -mlong-calls  -mno-long-calls @gol
645 -msingle-pic-base  -mno-single-pic-base @gol
646 -mpic-register=@var{reg} @gol
647 -mnop-fun-dllimport @gol
648 -mpoke-function-name @gol
649 -mthumb  -marm @gol
650 -mtpcs-frame  -mtpcs-leaf-frame @gol
651 -mcaller-super-interworking  -mcallee-super-interworking @gol
652 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
653 -mword-relocations @gol
654 -mfix-cortex-m3-ldrd @gol
655 -munaligned-access @gol
656 -mneon-for-64bits @gol
657 -mslow-flash-data @gol
658 -masm-syntax-unified @gol
659 -mrestrict-it @gol
660 -mpure-code @gol
661 -mcmse}
663 @emph{AVR Options}
664 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
665 -mbranch-cost=@var{cost} @gol
666 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
667 -mn_flash=@var{size}  -mno-interrupts @gol
668 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
669 -mshort-calls  -nodevicelib @gol
670 -Waddr-space-convert  -Wmisspelled-isr}
672 @emph{Blackfin Options}
673 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
674 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
675 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
676 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
677 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
678 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
679 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
680 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
681 -micplb}
683 @emph{C6X Options}
684 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
685 -msim  -msdata=@var{sdata-type}}
687 @emph{CRIS Options}
688 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
689 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
690 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
691 -mstack-align  -mdata-align  -mconst-align @gol
692 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
693 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
694 -mmul-bug-workaround  -mno-mul-bug-workaround}
696 @emph{CR16 Options}
697 @gccoptlist{-mmac @gol
698 -mcr16cplus  -mcr16c @gol
699 -msim  -mint32  -mbit-ops
700 -mdata-model=@var{model}}
702 @emph{Darwin Options}
703 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
704 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
705 -client_name  -compatibility_version  -current_version @gol
706 -dead_strip @gol
707 -dependency-file  -dylib_file  -dylinker_install_name @gol
708 -dynamic  -dynamiclib  -exported_symbols_list @gol
709 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
710 -force_flat_namespace  -headerpad_max_install_names @gol
711 -iframework @gol
712 -image_base  -init  -install_name  -keep_private_externs @gol
713 -multi_module  -multiply_defined  -multiply_defined_unused @gol
714 -noall_load   -no_dead_strip_inits_and_terms @gol
715 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
716 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
717 -private_bundle  -read_only_relocs  -sectalign @gol
718 -sectobjectsymbols  -whyload  -seg1addr @gol
719 -sectcreate  -sectobjectsymbols  -sectorder @gol
720 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
721 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
722 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
723 -single_module  -static  -sub_library  -sub_umbrella @gol
724 -twolevel_namespace  -umbrella  -undefined @gol
725 -unexported_symbols_list  -weak_reference_mismatches @gol
726 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
727 -mkernel  -mone-byte-bool}
729 @emph{DEC Alpha Options}
730 @gccoptlist{-mno-fp-regs  -msoft-float @gol
731 -mieee  -mieee-with-inexact  -mieee-conformant @gol
732 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
733 -mtrap-precision=@var{mode}  -mbuild-constants @gol
734 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
735 -mbwx  -mmax  -mfix  -mcix @gol
736 -mfloat-vax  -mfloat-ieee @gol
737 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
738 -msmall-text  -mlarge-text @gol
739 -mmemory-latency=@var{time}}
741 @emph{FR30 Options}
742 @gccoptlist{-msmall-model  -mno-lsim}
744 @emph{FT32 Options}
745 @gccoptlist{-msim  -mlra  -mnodiv}
747 @emph{FRV Options}
748 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
749 -mhard-float  -msoft-float @gol
750 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
751 -mdouble  -mno-double @gol
752 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
753 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
754 -mlinked-fp  -mlong-calls  -malign-labels @gol
755 -mlibrary-pic  -macc-4  -macc-8 @gol
756 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
757 -moptimize-membar  -mno-optimize-membar @gol
758 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
759 -mvliw-branch  -mno-vliw-branch @gol
760 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
761 -mno-nested-cond-exec  -mtomcat-stats @gol
762 -mTLS  -mtls @gol
763 -mcpu=@var{cpu}}
765 @emph{GNU/Linux Options}
766 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
767 -tno-android-cc  -tno-android-ld}
769 @emph{H8/300 Options}
770 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
772 @emph{HPPA Options}
773 @gccoptlist{-march=@var{architecture-type} @gol
774 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
775 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
776 -mfixed-range=@var{register-range} @gol
777 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
778 -mlong-load-store  -mno-disable-fpregs @gol
779 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
780 -mno-jump-in-delay  -mno-long-load-store @gol
781 -mno-portable-runtime  -mno-soft-float @gol
782 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
783 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
784 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
785 -munix=@var{unix-std}  -nolibdld  -static  -threads}
787 @emph{IA-64 Options}
788 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
789 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
790 -mconstant-gp  -mauto-pic  -mfused-madd @gol
791 -minline-float-divide-min-latency @gol
792 -minline-float-divide-max-throughput @gol
793 -mno-inline-float-divide @gol
794 -minline-int-divide-min-latency @gol
795 -minline-int-divide-max-throughput  @gol
796 -mno-inline-int-divide @gol
797 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
798 -mno-inline-sqrt @gol
799 -mdwarf2-asm  -mearly-stop-bits @gol
800 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
801 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
802 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
803 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
804 -msched-spec-ldc  -msched-spec-control-ldc @gol
805 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
806 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
807 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
808 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
810 @emph{LM32 Options}
811 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
812 -msign-extend-enabled  -muser-enabled}
814 @emph{M32R/D Options}
815 @gccoptlist{-m32r2  -m32rx  -m32r @gol
816 -mdebug @gol
817 -malign-loops  -mno-align-loops @gol
818 -missue-rate=@var{number} @gol
819 -mbranch-cost=@var{number} @gol
820 -mmodel=@var{code-size-model-type} @gol
821 -msdata=@var{sdata-type} @gol
822 -mno-flush-func  -mflush-func=@var{name} @gol
823 -mno-flush-trap  -mflush-trap=@var{number} @gol
824 -G @var{num}}
826 @emph{M32C Options}
827 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
829 @emph{M680x0 Options}
830 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
831 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
832 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
833 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
834 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
835 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
836 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
837 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
838 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
840 @emph{MCore Options}
841 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
842 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
843 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
844 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
845 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
847 @emph{MeP Options}
848 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
849 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
850 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
851 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
852 -mtiny=@var{n}}
854 @emph{MicroBlaze Options}
855 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
856 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
857 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
858 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
859 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
861 @emph{MIPS Options}
862 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
863 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
864 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
865 -mips16  -mno-mips16  -mflip-mips16 @gol
866 -minterlink-compressed  -mno-interlink-compressed @gol
867 -minterlink-mips16  -mno-interlink-mips16 @gol
868 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
869 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
870 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
871 -mno-float  -msingle-float  -mdouble-float @gol
872 -modd-spreg  -mno-odd-spreg @gol
873 -mabs=@var{mode}  -mnan=@var{encoding} @gol
874 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
875 -mmcu  -mmno-mcu @gol
876 -meva  -mno-eva @gol
877 -mvirt  -mno-virt @gol
878 -mxpa  -mno-xpa @gol
879 -mmicromips  -mno-micromips @gol
880 -mmsa  -mno-msa @gol
881 -mfpu=@var{fpu-type} @gol
882 -msmartmips  -mno-smartmips @gol
883 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
884 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
885 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
886 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
887 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
888 -membedded-data  -mno-embedded-data @gol
889 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
890 -mcode-readable=@var{setting} @gol
891 -msplit-addresses  -mno-split-addresses @gol
892 -mexplicit-relocs  -mno-explicit-relocs @gol
893 -mcheck-zero-division  -mno-check-zero-division @gol
894 -mdivide-traps  -mdivide-breaks @gol
895 -mload-store-pairs  -mno-load-store-pairs @gol
896 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
897 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
898 -mfix-24k  -mno-fix-24k @gol
899 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
900 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
901 -mfix-vr4120  -mno-fix-vr4120 @gol
902 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
903 -mflush-func=@var{func}  -mno-flush-func @gol
904 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
905 -mcompact-branches=@var{policy} @gol
906 -mfp-exceptions  -mno-fp-exceptions @gol
907 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
908 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
909 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
910 -mframe-header-opt  -mno-frame-header-opt}
912 @emph{MMIX Options}
913 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
914 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
915 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
916 -mno-base-addresses  -msingle-exit  -mno-single-exit}
918 @emph{MN10300 Options}
919 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
920 -mno-am33  -mam33  -mam33-2  -mam34 @gol
921 -mtune=@var{cpu-type} @gol
922 -mreturn-pointer-on-d0 @gol
923 -mno-crt0  -mrelax  -mliw  -msetlb}
925 @emph{Moxie Options}
926 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
928 @emph{MSP430 Options}
929 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
930 -mwarn-mcu @gol
931 -mcode-region=  -mdata-region= @gol
932 -msilicon-errata=  -msilicon-errata-warn= @gol
933 -mhwmult=  -minrt}
935 @emph{NDS32 Options}
936 @gccoptlist{-mbig-endian  -mlittle-endian @gol
937 -mreduced-regs  -mfull-regs @gol
938 -mcmov  -mno-cmov @gol
939 -mperf-ext  -mno-perf-ext @gol
940 -mv3push  -mno-v3push @gol
941 -m16bit  -mno-16bit @gol
942 -misr-vector-size=@var{num} @gol
943 -mcache-block-size=@var{num} @gol
944 -march=@var{arch} @gol
945 -mcmodel=@var{code-model} @gol
946 -mctor-dtor  -mrelax}
948 @emph{Nios II Options}
949 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
950 -mel  -meb @gol
951 -mno-bypass-cache  -mbypass-cache @gol
952 -mno-cache-volatile  -mcache-volatile @gol
953 -mno-fast-sw-div  -mfast-sw-div @gol
954 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
955 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
956 -mcustom-fpu-cfg=@var{name} @gol
957 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
958 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
960 @emph{Nvidia PTX Options}
961 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
963 @emph{PDP-11 Options}
964 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
965 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
966 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
967 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
968 -mbranch-expensive  -mbranch-cheap @gol
969 -munix-asm  -mdec-asm}
971 @emph{picoChip Options}
972 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
973 -msymbol-as-address  -mno-inefficient-warnings}
975 @emph{PowerPC Options}
976 See RS/6000 and PowerPC Options.
978 @emph{RISC-V Options}
979 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
980 -mmemcpy  -mno-memcpy @gol
981 -mplt  -mno-plt @gol
982 -mabi=@var{ABI-string} @gol
983 -mfdiv  -mno-fdiv @gol
984 -mdiv  -mno-div @gol
985 -march=@var{ISA-string} @gol
986 -mtune=@var{processor-string} @gol
987 -msmall-data-limit=@var{N-bytes} @gol
988 -msave-restore  -mno-save-restore @gol
989 -mstrict-align -mno-strict-align @gol
990 -mcmodel=@var{code-model} @gol
991 -mexplicit-relocs  -mno-explicit-relocs @gol}
993 @emph{RL78 Options}
994 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
995 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
996 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
998 @emph{RS/6000 and PowerPC Options}
999 @gccoptlist{-mcpu=@var{cpu-type} @gol
1000 -mtune=@var{cpu-type} @gol
1001 -mcmodel=@var{code-model} @gol
1002 -mpowerpc64 @gol
1003 -maltivec  -mno-altivec @gol
1004 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1005 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1006 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1007 -mfprnd  -mno-fprnd @gol
1008 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1009 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1010 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1011 -malign-power  -malign-natural @gol
1012 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1013 -msingle-float  -mdouble-float  -msimple-fpu @gol
1014 -mstring  -mno-string  -mupdate  -mno-update @gol
1015 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1016 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1017 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1018 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1019 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1020 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1021 -mprioritize-restricted-insns=@var{priority} @gol
1022 -msched-costly-dep=@var{dependence_type} @gol
1023 -minsert-sched-nops=@var{scheme} @gol
1024 -mcall-sysv  -mcall-netbsd @gol
1025 -maix-struct-return  -msvr4-struct-return @gol
1026 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1027 -mblock-move-inline-limit=@var{num} @gol
1028 -misel  -mno-isel @gol
1029 -misel=yes  -misel=no @gol
1030 -mspe  -mno-spe @gol
1031 -mspe=yes  -mspe=no @gol
1032 -mpaired @gol
1033 -mvrsave  -mno-vrsave @gol
1034 -mmulhw  -mno-mulhw @gol
1035 -mdlmzb  -mno-dlmzb @gol
1036 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1037 -mprototype  -mno-prototype @gol
1038 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1039 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1040 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1041 -mno-recip-precision @gol
1042 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1043 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1044 -msave-toc-indirect  -mno-save-toc-indirect @gol
1045 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1046 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1047 -mquad-memory  -mno-quad-memory @gol
1048 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1049 -mcompat-align-parm  -mno-compat-align-parm @gol
1050 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1051 -mgnu-attribute  -mno-gnu-attribute @gol
1052 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1053 -mstack-protector-guard-offset=@var{offset}}
1055 @emph{RX Options}
1056 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1057 -mcpu=@gol
1058 -mbig-endian-data  -mlittle-endian-data @gol
1059 -msmall-data @gol
1060 -msim  -mno-sim@gol
1061 -mas100-syntax  -mno-as100-syntax@gol
1062 -mrelax@gol
1063 -mmax-constant-size=@gol
1064 -mint-register=@gol
1065 -mpid@gol
1066 -mallow-string-insns  -mno-allow-string-insns@gol
1067 -mjsr@gol
1068 -mno-warn-multiple-fast-interrupts@gol
1069 -msave-acc-in-interrupts}
1071 @emph{S/390 and zSeries Options}
1072 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1073 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1074 -mlong-double-64  -mlong-double-128 @gol
1075 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1076 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1077 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1078 -mhtm  -mvx  -mzvector @gol
1079 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1080 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1081 -mhotpatch=@var{halfwords},@var{halfwords}}
1083 @emph{Score Options}
1084 @gccoptlist{-meb  -mel @gol
1085 -mnhwloop @gol
1086 -muls @gol
1087 -mmac @gol
1088 -mscore5  -mscore5u  -mscore7  -mscore7d}
1090 @emph{SH Options}
1091 @gccoptlist{-m1  -m2  -m2e @gol
1092 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1093 -m3  -m3e @gol
1094 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1095 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1096 -mb  -ml  -mdalign  -mrelax @gol
1097 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1098 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1099 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1100 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1101 -maccumulate-outgoing-args @gol
1102 -matomic-model=@var{atomic-model} @gol
1103 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1104 -mcbranch-force-delay-slot @gol
1105 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1106 -mpretend-cmove  -mtas}
1108 @emph{Solaris 2 Options}
1109 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1110 -pthreads}
1112 @emph{SPARC Options}
1113 @gccoptlist{-mcpu=@var{cpu-type} @gol
1114 -mtune=@var{cpu-type} @gol
1115 -mcmodel=@var{code-model} @gol
1116 -mmemory-model=@var{mem-model} @gol
1117 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1118 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1119 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1120 -mhard-quad-float  -msoft-quad-float @gol
1121 -mstack-bias  -mno-stack-bias @gol
1122 -mstd-struct-return  -mno-std-struct-return @gol
1123 -munaligned-doubles  -mno-unaligned-doubles @gol
1124 -muser-mode  -mno-user-mode @gol
1125 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1126 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1127 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1128 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1129 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1130 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1131 -mlra  -mno-lra}
1133 @emph{SPU Options}
1134 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1135 -msafe-dma  -munsafe-dma @gol
1136 -mbranch-hints @gol
1137 -msmall-mem  -mlarge-mem  -mstdmain @gol
1138 -mfixed-range=@var{register-range} @gol
1139 -mea32  -mea64 @gol
1140 -maddress-space-conversion  -mno-address-space-conversion @gol
1141 -mcache-size=@var{cache-size} @gol
1142 -matomic-updates  -mno-atomic-updates}
1144 @emph{System V Options}
1145 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1147 @emph{TILE-Gx Options}
1148 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1149 -mcmodel=@var{code-model}}
1151 @emph{TILEPro Options}
1152 @gccoptlist{-mcpu=@var{cpu}  -m32}
1154 @emph{V850 Options}
1155 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1156 -mprolog-function  -mno-prolog-function  -mspace @gol
1157 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1158 -mapp-regs  -mno-app-regs @gol
1159 -mdisable-callt  -mno-disable-callt @gol
1160 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1161 -mv850e  -mv850  -mv850e3v5 @gol
1162 -mloop @gol
1163 -mrelax @gol
1164 -mlong-jumps @gol
1165 -msoft-float @gol
1166 -mhard-float @gol
1167 -mgcc-abi @gol
1168 -mrh850-abi @gol
1169 -mbig-switch}
1171 @emph{VAX Options}
1172 @gccoptlist{-mg  -mgnu  -munix}
1174 @emph{Visium Options}
1175 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1176 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1178 @emph{VMS Options}
1179 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1180 -mpointer-size=@var{size}}
1182 @emph{VxWorks Options}
1183 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1184 -Xbind-lazy  -Xbind-now}
1186 @emph{x86 Options}
1187 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1188 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1189 -mfpmath=@var{unit} @gol
1190 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1191 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1192 -mno-wide-multiply  -mrtd  -malign-double @gol
1193 -mpreferred-stack-boundary=@var{num} @gol
1194 -mincoming-stack-boundary=@var{num} @gol
1195 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1196 -mrecip  -mrecip=@var{opt} @gol
1197 -mvzeroupper  -mprefer-avx128 -mprefer-avx256 @gol
1198 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1199 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1200 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1201 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1202 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1203 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1204 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1205 -mmwaitx  -mclzero  -mpku  -mthreads @gol
1206 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1207 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1208 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1209 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1210 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1211 -mregparm=@var{num}  -msseregparm @gol
1212 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1213 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1214 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1215 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1216 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1217 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1218 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1219 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1220 -mstack-protector-guard-reg=@var{reg} @gol
1221 -mstack-protector-guard-offset=@var{offset} @gol
1222 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1223 -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1225 @emph{x86 Windows Options}
1226 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1227 -mnop-fun-dllimport  -mthread @gol
1228 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1230 @emph{Xstormy16 Options}
1231 @gccoptlist{-msim}
1233 @emph{Xtensa Options}
1234 @gccoptlist{-mconst16  -mno-const16 @gol
1235 -mfused-madd  -mno-fused-madd @gol
1236 -mforce-no-pic @gol
1237 -mserialize-volatile  -mno-serialize-volatile @gol
1238 -mtext-section-literals  -mno-text-section-literals @gol
1239 -mauto-litpools  -mno-auto-litpools @gol
1240 -mtarget-align  -mno-target-align @gol
1241 -mlongcalls  -mno-longcalls}
1243 @emph{zSeries Options}
1244 See S/390 and zSeries Options.
1245 @end table
1248 @node Overall Options
1249 @section Options Controlling the Kind of Output
1251 Compilation can involve up to four stages: preprocessing, compilation
1252 proper, assembly and linking, always in that order.  GCC is capable of
1253 preprocessing and compiling several files either into several
1254 assembler input files, or into one assembler input file; then each
1255 assembler input file produces an object file, and linking combines all
1256 the object files (those newly compiled, and those specified as input)
1257 into an executable file.
1259 @cindex file name suffix
1260 For any given input file, the file name suffix determines what kind of
1261 compilation is done:
1263 @table @gcctabopt
1264 @item @var{file}.c
1265 C source code that must be preprocessed.
1267 @item @var{file}.i
1268 C source code that should not be preprocessed.
1270 @item @var{file}.ii
1271 C++ source code that should not be preprocessed.
1273 @item @var{file}.m
1274 Objective-C source code.  Note that you must link with the @file{libobjc}
1275 library to make an Objective-C program work.
1277 @item @var{file}.mi
1278 Objective-C source code that should not be preprocessed.
1280 @item @var{file}.mm
1281 @itemx @var{file}.M
1282 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1283 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1284 to a literal capital M@.
1286 @item @var{file}.mii
1287 Objective-C++ source code that should not be preprocessed.
1289 @item @var{file}.h
1290 C, C++, Objective-C or Objective-C++ header file to be turned into a
1291 precompiled header (default), or C, C++ header file to be turned into an
1292 Ada spec (via the @option{-fdump-ada-spec} switch).
1294 @item @var{file}.cc
1295 @itemx @var{file}.cp
1296 @itemx @var{file}.cxx
1297 @itemx @var{file}.cpp
1298 @itemx @var{file}.CPP
1299 @itemx @var{file}.c++
1300 @itemx @var{file}.C
1301 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1302 the last two letters must both be literally @samp{x}.  Likewise,
1303 @samp{.C} refers to a literal capital C@.
1305 @item @var{file}.mm
1306 @itemx @var{file}.M
1307 Objective-C++ source code that must be preprocessed.
1309 @item @var{file}.mii
1310 Objective-C++ source code that should not be preprocessed.
1312 @item @var{file}.hh
1313 @itemx @var{file}.H
1314 @itemx @var{file}.hp
1315 @itemx @var{file}.hxx
1316 @itemx @var{file}.hpp
1317 @itemx @var{file}.HPP
1318 @itemx @var{file}.h++
1319 @itemx @var{file}.tcc
1320 C++ header file to be turned into a precompiled header or Ada spec.
1322 @item @var{file}.f
1323 @itemx @var{file}.for
1324 @itemx @var{file}.ftn
1325 Fixed form Fortran source code that should not be preprocessed.
1327 @item @var{file}.F
1328 @itemx @var{file}.FOR
1329 @itemx @var{file}.fpp
1330 @itemx @var{file}.FPP
1331 @itemx @var{file}.FTN
1332 Fixed form Fortran source code that must be preprocessed (with the traditional
1333 preprocessor).
1335 @item @var{file}.f90
1336 @itemx @var{file}.f95
1337 @itemx @var{file}.f03
1338 @itemx @var{file}.f08
1339 Free form Fortran source code that should not be preprocessed.
1341 @item @var{file}.F90
1342 @itemx @var{file}.F95
1343 @itemx @var{file}.F03
1344 @itemx @var{file}.F08
1345 Free form Fortran source code that must be preprocessed (with the
1346 traditional preprocessor).
1348 @item @var{file}.go
1349 Go source code.
1351 @item @var{file}.brig
1352 BRIG files (binary representation of HSAIL).
1354 @item @var{file}.ads
1355 Ada source code file that contains a library unit declaration (a
1356 declaration of a package, subprogram, or generic, or a generic
1357 instantiation), or a library unit renaming declaration (a package,
1358 generic, or subprogram renaming declaration).  Such files are also
1359 called @dfn{specs}.
1361 @item @var{file}.adb
1362 Ada source code file containing a library unit body (a subprogram or
1363 package body).  Such files are also called @dfn{bodies}.
1365 @c GCC also knows about some suffixes for languages not yet included:
1366 @c Pascal:
1367 @c @var{file}.p
1368 @c @var{file}.pas
1369 @c Ratfor:
1370 @c @var{file}.r
1372 @item @var{file}.s
1373 Assembler code.
1375 @item @var{file}.S
1376 @itemx @var{file}.sx
1377 Assembler code that must be preprocessed.
1379 @item @var{other}
1380 An object file to be fed straight into linking.
1381 Any file name with no recognized suffix is treated this way.
1382 @end table
1384 @opindex x
1385 You can specify the input language explicitly with the @option{-x} option:
1387 @table @gcctabopt
1388 @item -x @var{language}
1389 Specify explicitly the @var{language} for the following input files
1390 (rather than letting the compiler choose a default based on the file
1391 name suffix).  This option applies to all following input files until
1392 the next @option{-x} option.  Possible values for @var{language} are:
1393 @smallexample
1394 c  c-header  cpp-output
1395 c++  c++-header  c++-cpp-output
1396 objective-c  objective-c-header  objective-c-cpp-output
1397 objective-c++ objective-c++-header objective-c++-cpp-output
1398 assembler  assembler-with-cpp
1400 f77  f77-cpp-input f95  f95-cpp-input
1402 brig
1403 @end smallexample
1405 @item -x none
1406 Turn off any specification of a language, so that subsequent files are
1407 handled according to their file name suffixes (as they are if @option{-x}
1408 has not been used at all).
1409 @end table
1411 If you only want some of the stages of compilation, you can use
1412 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1413 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1414 @command{gcc} is to stop.  Note that some combinations (for example,
1415 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1417 @table @gcctabopt
1418 @item -c
1419 @opindex c
1420 Compile or assemble the source files, but do not link.  The linking
1421 stage simply is not done.  The ultimate output is in the form of an
1422 object file for each source file.
1424 By default, the object file name for a source file is made by replacing
1425 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1427 Unrecognized input files, not requiring compilation or assembly, are
1428 ignored.
1430 @item -S
1431 @opindex S
1432 Stop after the stage of compilation proper; do not assemble.  The output
1433 is in the form of an assembler code file for each non-assembler input
1434 file specified.
1436 By default, the assembler file name for a source file is made by
1437 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1439 Input files that don't require compilation are ignored.
1441 @item -E
1442 @opindex E
1443 Stop after the preprocessing stage; do not run the compiler proper.  The
1444 output is in the form of preprocessed source code, which is sent to the
1445 standard output.
1447 Input files that don't require preprocessing are ignored.
1449 @cindex output file option
1450 @item -o @var{file}
1451 @opindex o
1452 Place output in file @var{file}.  This applies to whatever
1453 sort of output is being produced, whether it be an executable file,
1454 an object file, an assembler file or preprocessed C code.
1456 If @option{-o} is not specified, the default is to put an executable
1457 file in @file{a.out}, the object file for
1458 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1459 assembler file in @file{@var{source}.s}, a precompiled header file in
1460 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1461 standard output.
1463 @item -v
1464 @opindex v
1465 Print (on standard error output) the commands executed to run the stages
1466 of compilation.  Also print the version number of the compiler driver
1467 program and of the preprocessor and the compiler proper.
1469 @item -###
1470 @opindex ###
1471 Like @option{-v} except the commands are not executed and arguments
1472 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1473 This is useful for shell scripts to capture the driver-generated command lines.
1475 @item --help
1476 @opindex help
1477 Print (on the standard output) a description of the command-line options
1478 understood by @command{gcc}.  If the @option{-v} option is also specified
1479 then @option{--help} is also passed on to the various processes
1480 invoked by @command{gcc}, so that they can display the command-line options
1481 they accept.  If the @option{-Wextra} option has also been specified
1482 (prior to the @option{--help} option), then command-line options that
1483 have no documentation associated with them are also displayed.
1485 @item --target-help
1486 @opindex target-help
1487 Print (on the standard output) a description of target-specific command-line
1488 options for each tool.  For some targets extra target-specific
1489 information may also be printed.
1491 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1492 Print (on the standard output) a description of the command-line
1493 options understood by the compiler that fit into all specified classes
1494 and qualifiers.  These are the supported classes:
1496 @table @asis
1497 @item @samp{optimizers}
1498 Display all of the optimization options supported by the
1499 compiler.
1501 @item @samp{warnings}
1502 Display all of the options controlling warning messages
1503 produced by the compiler.
1505 @item @samp{target}
1506 Display target-specific options.  Unlike the
1507 @option{--target-help} option however, target-specific options of the
1508 linker and assembler are not displayed.  This is because those
1509 tools do not currently support the extended @option{--help=} syntax.
1511 @item @samp{params}
1512 Display the values recognized by the @option{--param}
1513 option.
1515 @item @var{language}
1516 Display the options supported for @var{language}, where
1517 @var{language} is the name of one of the languages supported in this
1518 version of GCC@.
1520 @item @samp{common}
1521 Display the options that are common to all languages.
1522 @end table
1524 These are the supported qualifiers:
1526 @table @asis
1527 @item @samp{undocumented}
1528 Display only those options that are undocumented.
1530 @item @samp{joined}
1531 Display options taking an argument that appears after an equal
1532 sign in the same continuous piece of text, such as:
1533 @samp{--help=target}.
1535 @item @samp{separate}
1536 Display options taking an argument that appears as a separate word
1537 following the original option, such as: @samp{-o output-file}.
1538 @end table
1540 Thus for example to display all the undocumented target-specific
1541 switches supported by the compiler, use:
1543 @smallexample
1544 --help=target,undocumented
1545 @end smallexample
1547 The sense of a qualifier can be inverted by prefixing it with the
1548 @samp{^} character, so for example to display all binary warning
1549 options (i.e., ones that are either on or off and that do not take an
1550 argument) that have a description, use:
1552 @smallexample
1553 --help=warnings,^joined,^undocumented
1554 @end smallexample
1556 The argument to @option{--help=} should not consist solely of inverted
1557 qualifiers.
1559 Combining several classes is possible, although this usually
1560 restricts the output so much that there is nothing to display.  One
1561 case where it does work, however, is when one of the classes is
1562 @var{target}.  For example, to display all the target-specific
1563 optimization options, use:
1565 @smallexample
1566 --help=target,optimizers
1567 @end smallexample
1569 The @option{--help=} option can be repeated on the command line.  Each
1570 successive use displays its requested class of options, skipping
1571 those that have already been displayed.
1573 If the @option{-Q} option appears on the command line before the
1574 @option{--help=} option, then the descriptive text displayed by
1575 @option{--help=} is changed.  Instead of describing the displayed
1576 options, an indication is given as to whether the option is enabled,
1577 disabled or set to a specific value (assuming that the compiler
1578 knows this at the point where the @option{--help=} option is used).
1580 Here is a truncated example from the ARM port of @command{gcc}:
1582 @smallexample
1583   % gcc -Q -mabi=2 --help=target -c
1584   The following options are target specific:
1585   -mabi=                                2
1586   -mabort-on-noreturn                   [disabled]
1587   -mapcs                                [disabled]
1588 @end smallexample
1590 The output is sensitive to the effects of previous command-line
1591 options, so for example it is possible to find out which optimizations
1592 are enabled at @option{-O2} by using:
1594 @smallexample
1595 -Q -O2 --help=optimizers
1596 @end smallexample
1598 Alternatively you can discover which binary optimizations are enabled
1599 by @option{-O3} by using:
1601 @smallexample
1602 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1603 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1604 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1605 @end smallexample
1607 @item --version
1608 @opindex version
1609 Display the version number and copyrights of the invoked GCC@.
1611 @item -pass-exit-codes
1612 @opindex pass-exit-codes
1613 Normally the @command{gcc} program exits with the code of 1 if any
1614 phase of the compiler returns a non-success return code.  If you specify
1615 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1616 the numerically highest error produced by any phase returning an error
1617 indication.  The C, C++, and Fortran front ends return 4 if an internal
1618 compiler error is encountered.
1620 @item -pipe
1621 @opindex pipe
1622 Use pipes rather than temporary files for communication between the
1623 various stages of compilation.  This fails to work on some systems where
1624 the assembler is unable to read from a pipe; but the GNU assembler has
1625 no trouble.
1627 @item -specs=@var{file}
1628 @opindex specs
1629 Process @var{file} after the compiler reads in the standard @file{specs}
1630 file, in order to override the defaults which the @command{gcc} driver
1631 program uses when determining what switches to pass to @command{cc1},
1632 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1633 @option{-specs=@var{file}} can be specified on the command line, and they
1634 are processed in order, from left to right.  @xref{Spec Files}, for
1635 information about the format of the @var{file}.
1637 @item -wrapper
1638 @opindex wrapper
1639 Invoke all subcommands under a wrapper program.  The name of the
1640 wrapper program and its parameters are passed as a comma separated
1641 list.
1643 @smallexample
1644 gcc -c t.c -wrapper gdb,--args
1645 @end smallexample
1647 @noindent
1648 This invokes all subprograms of @command{gcc} under
1649 @samp{gdb --args}, thus the invocation of @command{cc1} is
1650 @samp{gdb --args cc1 @dots{}}.
1652 @item -fplugin=@var{name}.so
1653 @opindex fplugin
1654 Load the plugin code in file @var{name}.so, assumed to be a
1655 shared object to be dlopen'd by the compiler.  The base name of
1656 the shared object file is used to identify the plugin for the
1657 purposes of argument parsing (See
1658 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1659 Each plugin should define the callback functions specified in the
1660 Plugins API.
1662 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1663 @opindex fplugin-arg
1664 Define an argument called @var{key} with a value of @var{value}
1665 for the plugin called @var{name}.
1667 @item -fdump-ada-spec@r{[}-slim@r{]}
1668 @opindex fdump-ada-spec
1669 For C and C++ source and include files, generate corresponding Ada specs.
1670 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1671 GNAT User's Guide}, which provides detailed documentation on this feature.
1673 @item -fada-spec-parent=@var{unit}
1674 @opindex fada-spec-parent
1675 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1676 Ada specs as child units of parent @var{unit}.
1678 @item -fdump-go-spec=@var{file}
1679 @opindex fdump-go-spec
1680 For input files in any language, generate corresponding Go
1681 declarations in @var{file}.  This generates Go @code{const},
1682 @code{type}, @code{var}, and @code{func} declarations which may be a
1683 useful way to start writing a Go interface to code written in some
1684 other language.
1686 @include @value{srcdir}/../libiberty/at-file.texi
1687 @end table
1689 @node Invoking G++
1690 @section Compiling C++ Programs
1692 @cindex suffixes for C++ source
1693 @cindex C++ source file suffixes
1694 C++ source files conventionally use one of the suffixes @samp{.C},
1695 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1696 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1697 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1698 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1699 files with these names and compiles them as C++ programs even if you
1700 call the compiler the same way as for compiling C programs (usually
1701 with the name @command{gcc}).
1703 @findex g++
1704 @findex c++
1705 However, the use of @command{gcc} does not add the C++ library.
1706 @command{g++} is a program that calls GCC and automatically specifies linking
1707 against the C++ library.  It treats @samp{.c},
1708 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1709 files unless @option{-x} is used.  This program is also useful when
1710 precompiling a C header file with a @samp{.h} extension for use in C++
1711 compilations.  On many systems, @command{g++} is also installed with
1712 the name @command{c++}.
1714 @cindex invoking @command{g++}
1715 When you compile C++ programs, you may specify many of the same
1716 command-line options that you use for compiling programs in any
1717 language; or command-line options meaningful for C and related
1718 languages; or options that are meaningful only for C++ programs.
1719 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1720 explanations of options for languages related to C@.
1721 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1722 explanations of options that are meaningful only for C++ programs.
1724 @node C Dialect Options
1725 @section Options Controlling C Dialect
1726 @cindex dialect options
1727 @cindex language dialect options
1728 @cindex options, dialect
1730 The following options control the dialect of C (or languages derived
1731 from C, such as C++, Objective-C and Objective-C++) that the compiler
1732 accepts:
1734 @table @gcctabopt
1735 @cindex ANSI support
1736 @cindex ISO support
1737 @item -ansi
1738 @opindex ansi
1739 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1740 equivalent to @option{-std=c++98}.
1742 This turns off certain features of GCC that are incompatible with ISO
1743 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1744 such as the @code{asm} and @code{typeof} keywords, and
1745 predefined macros such as @code{unix} and @code{vax} that identify the
1746 type of system you are using.  It also enables the undesirable and
1747 rarely used ISO trigraph feature.  For the C compiler,
1748 it disables recognition of C++ style @samp{//} comments as well as
1749 the @code{inline} keyword.
1751 The alternate keywords @code{__asm__}, @code{__extension__},
1752 @code{__inline__} and @code{__typeof__} continue to work despite
1753 @option{-ansi}.  You would not want to use them in an ISO C program, of
1754 course, but it is useful to put them in header files that might be included
1755 in compilations done with @option{-ansi}.  Alternate predefined macros
1756 such as @code{__unix__} and @code{__vax__} are also available, with or
1757 without @option{-ansi}.
1759 The @option{-ansi} option does not cause non-ISO programs to be
1760 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1761 addition to @option{-ansi}.  @xref{Warning Options}.
1763 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1764 option is used.  Some header files may notice this macro and refrain
1765 from declaring certain functions or defining certain macros that the
1766 ISO standard doesn't call for; this is to avoid interfering with any
1767 programs that might use these names for other things.
1769 Functions that are normally built in but do not have semantics
1770 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1771 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1772 built-in functions provided by GCC}, for details of the functions
1773 affected.
1775 @item -std=
1776 @opindex std
1777 Determine the language standard. @xref{Standards,,Language Standards
1778 Supported by GCC}, for details of these standard versions.  This option
1779 is currently only supported when compiling C or C++.
1781 The compiler can accept several base standards, such as @samp{c90} or
1782 @samp{c++98}, and GNU dialects of those standards, such as
1783 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1784 compiler accepts all programs following that standard plus those
1785 using GNU extensions that do not contradict it.  For example,
1786 @option{-std=c90} turns off certain features of GCC that are
1787 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1788 keywords, but not other GNU extensions that do not have a meaning in
1789 ISO C90, such as omitting the middle term of a @code{?:}
1790 expression. On the other hand, when a GNU dialect of a standard is
1791 specified, all features supported by the compiler are enabled, even when
1792 those features change the meaning of the base standard.  As a result, some
1793 strict-conforming programs may be rejected.  The particular standard
1794 is used by @option{-Wpedantic} to identify which features are GNU
1795 extensions given that version of the standard. For example
1796 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1797 comments, while @option{-std=gnu99 -Wpedantic} does not.
1799 A value for this option must be provided; possible values are
1801 @table @samp
1802 @item c90
1803 @itemx c89
1804 @itemx iso9899:1990
1805 Support all ISO C90 programs (certain GNU extensions that conflict
1806 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1808 @item iso9899:199409
1809 ISO C90 as modified in amendment 1.
1811 @item c99
1812 @itemx c9x
1813 @itemx iso9899:1999
1814 @itemx iso9899:199x
1815 ISO C99.  This standard is substantially completely supported, modulo
1816 bugs and floating-point issues
1817 (mainly but not entirely relating to optional C99 features from
1818 Annexes F and G).  See
1819 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1820 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1822 @item c11
1823 @itemx c1x
1824 @itemx iso9899:2011
1825 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1826 substantially completely supported, modulo bugs, floating-point issues
1827 (mainly but not entirely relating to optional C11 features from
1828 Annexes F and G) and the optional Annexes K (Bounds-checking
1829 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1831 @item gnu90
1832 @itemx gnu89
1833 GNU dialect of ISO C90 (including some C99 features).
1835 @item gnu99
1836 @itemx gnu9x
1837 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1839 @item gnu11
1840 @itemx gnu1x
1841 GNU dialect of ISO C11.  This is the default for C code.
1842 The name @samp{gnu1x} is deprecated.
1844 @item c++98
1845 @itemx c++03
1846 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1847 additional defect reports. Same as @option{-ansi} for C++ code.
1849 @item gnu++98
1850 @itemx gnu++03
1851 GNU dialect of @option{-std=c++98}.
1853 @item c++11
1854 @itemx c++0x
1855 The 2011 ISO C++ standard plus amendments.
1856 The name @samp{c++0x} is deprecated.
1858 @item gnu++11
1859 @itemx gnu++0x
1860 GNU dialect of @option{-std=c++11}.
1861 The name @samp{gnu++0x} is deprecated.
1863 @item c++14
1864 @itemx c++1y
1865 The 2014 ISO C++ standard plus amendments.
1866 The name @samp{c++1y} is deprecated.
1868 @item gnu++14
1869 @itemx gnu++1y
1870 GNU dialect of @option{-std=c++14}.
1871 This is the default for C++ code.
1872 The name @samp{gnu++1y} is deprecated.
1874 @item c++17
1875 @itemx c++1z
1876 The 2017 ISO C++ standard plus amendments.
1877 The name @samp{c++1z} is deprecated.
1879 @item gnu++17
1880 @itemx gnu++1z
1881 GNU dialect of @option{-std=c++17}.
1882 The name @samp{gnu++1z} is deprecated.
1884 @item c++2a
1885 The next revision of the ISO C++ standard, tentatively planned for
1886 2020.  Support is highly experimental, and will almost certainly
1887 change in incompatible ways in future releases.
1889 @item gnu++2a
1890 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1891 and will almost certainly change in incompatible ways in future
1892 releases.
1893 @end table
1895 @item -fgnu89-inline
1896 @opindex fgnu89-inline
1897 The option @option{-fgnu89-inline} tells GCC to use the traditional
1898 GNU semantics for @code{inline} functions when in C99 mode.
1899 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1900 Using this option is roughly equivalent to adding the
1901 @code{gnu_inline} function attribute to all inline functions
1902 (@pxref{Function Attributes}).
1904 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1905 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1906 specifies the default behavior).
1907 This option is not supported in @option{-std=c90} or
1908 @option{-std=gnu90} mode.
1910 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1911 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1912 in effect for @code{inline} functions.  @xref{Common Predefined
1913 Macros,,,cpp,The C Preprocessor}.
1915 @item -fpermitted-flt-eval-methods=@var{style}
1916 @opindex fpermitted-flt-eval-methods
1917 @opindex fpermitted-flt-eval-methods=c11
1918 @opindex fpermitted-flt-eval-methods=ts-18661-3
1919 ISO/IEC TS 18661-3 defines new permissible values for
1920 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1921 a semantic type that is an interchange or extended format should be
1922 evaluated to the precision and range of that type.  These new values are
1923 a superset of those permitted under C99/C11, which does not specify the
1924 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1925 conforming to C11 may not have been written expecting the possibility of
1926 the new values.
1928 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1929 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1930 or the extended set of values specified in ISO/IEC TS 18661-3.
1932 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1934 The default when in a standards compliant mode (@option{-std=c11} or similar)
1935 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1936 dialect (@option{-std=gnu11} or similar) is
1937 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1939 @item -aux-info @var{filename}
1940 @opindex aux-info
1941 Output to the given filename prototyped declarations for all functions
1942 declared and/or defined in a translation unit, including those in header
1943 files.  This option is silently ignored in any language other than C@.
1945 Besides declarations, the file indicates, in comments, the origin of
1946 each declaration (source file and line), whether the declaration was
1947 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1948 @samp{O} for old, respectively, in the first character after the line
1949 number and the colon), and whether it came from a declaration or a
1950 definition (@samp{C} or @samp{F}, respectively, in the following
1951 character).  In the case of function definitions, a K&R-style list of
1952 arguments followed by their declarations is also provided, inside
1953 comments, after the declaration.
1955 @item -fallow-parameterless-variadic-functions
1956 @opindex fallow-parameterless-variadic-functions
1957 Accept variadic functions without named parameters.
1959 Although it is possible to define such a function, this is not very
1960 useful as it is not possible to read the arguments.  This is only
1961 supported for C as this construct is allowed by C++.
1963 @item -fno-asm
1964 @opindex fno-asm
1965 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1966 keyword, so that code can use these words as identifiers.  You can use
1967 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1968 instead.  @option{-ansi} implies @option{-fno-asm}.
1970 In C++, this switch only affects the @code{typeof} keyword, since
1971 @code{asm} and @code{inline} are standard keywords.  You may want to
1972 use the @option{-fno-gnu-keywords} flag instead, which has the same
1973 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1974 switch only affects the @code{asm} and @code{typeof} keywords, since
1975 @code{inline} is a standard keyword in ISO C99.
1977 @item -fno-builtin
1978 @itemx -fno-builtin-@var{function}
1979 @opindex fno-builtin
1980 @cindex built-in functions
1981 Don't recognize built-in functions that do not begin with
1982 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1983 functions provided by GCC}, for details of the functions affected,
1984 including those which are not built-in functions when @option{-ansi} or
1985 @option{-std} options for strict ISO C conformance are used because they
1986 do not have an ISO standard meaning.
1988 GCC normally generates special code to handle certain built-in functions
1989 more efficiently; for instance, calls to @code{alloca} may become single
1990 instructions which adjust the stack directly, and calls to @code{memcpy}
1991 may become inline copy loops.  The resulting code is often both smaller
1992 and faster, but since the function calls no longer appear as such, you
1993 cannot set a breakpoint on those calls, nor can you change the behavior
1994 of the functions by linking with a different library.  In addition,
1995 when a function is recognized as a built-in function, GCC may use
1996 information about that function to warn about problems with calls to
1997 that function, or to generate more efficient code, even if the
1998 resulting code still contains calls to that function.  For example,
1999 warnings are given with @option{-Wformat} for bad calls to
2000 @code{printf} when @code{printf} is built in and @code{strlen} is
2001 known not to modify global memory.
2003 With the @option{-fno-builtin-@var{function}} option
2004 only the built-in function @var{function} is
2005 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2006 function is named that is not built-in in this version of GCC, this
2007 option is ignored.  There is no corresponding
2008 @option{-fbuiltin-@var{function}} option; if you wish to enable
2009 built-in functions selectively when using @option{-fno-builtin} or
2010 @option{-ffreestanding}, you may define macros such as:
2012 @smallexample
2013 #define abs(n)          __builtin_abs ((n))
2014 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2015 @end smallexample
2017 @item -fgimple
2018 @opindex fgimple
2020 Enable parsing of function definitions marked with @code{__GIMPLE}.
2021 This is an experimental feature that allows unit testing of GIMPLE
2022 passes.
2024 @item -fhosted
2025 @opindex fhosted
2026 @cindex hosted environment
2028 Assert that compilation targets a hosted environment.  This implies
2029 @option{-fbuiltin}.  A hosted environment is one in which the
2030 entire standard library is available, and in which @code{main} has a return
2031 type of @code{int}.  Examples are nearly everything except a kernel.
2032 This is equivalent to @option{-fno-freestanding}.
2034 @item -ffreestanding
2035 @opindex ffreestanding
2036 @cindex hosted environment
2038 Assert that compilation targets a freestanding environment.  This
2039 implies @option{-fno-builtin}.  A freestanding environment
2040 is one in which the standard library may not exist, and program startup may
2041 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2042 This is equivalent to @option{-fno-hosted}.
2044 @xref{Standards,,Language Standards Supported by GCC}, for details of
2045 freestanding and hosted environments.
2047 @item -fopenacc
2048 @opindex fopenacc
2049 @cindex OpenACC accelerator programming
2050 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2051 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2052 compiler generates accelerated code according to the OpenACC Application
2053 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2054 implies @option{-pthread}, and thus is only supported on targets that
2055 have support for @option{-pthread}.
2057 @item -fopenacc-dim=@var{geom}
2058 @opindex fopenacc-dim
2059 @cindex OpenACC accelerator programming
2060 Specify default compute dimensions for parallel offload regions that do
2061 not explicitly specify.  The @var{geom} value is a triple of
2062 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2063 can be omitted, to use a target-specific default value.
2065 @item -fopenmp
2066 @opindex fopenmp
2067 @cindex OpenMP parallel
2068 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2069 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2070 compiler generates parallel code according to the OpenMP Application
2071 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2072 implies @option{-pthread}, and thus is only supported on targets that
2073 have support for @option{-pthread}. @option{-fopenmp} implies
2074 @option{-fopenmp-simd}.
2076 @item -fopenmp-simd
2077 @opindex fopenmp-simd
2078 @cindex OpenMP SIMD
2079 @cindex SIMD
2080 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2081 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2082 are ignored.
2084 @item -fcilkplus
2085 @opindex fcilkplus
2086 @cindex Enable Cilk Plus
2087 Enable the usage of Cilk Plus language extension features for C/C++.
2088 When the option @option{-fcilkplus} is specified, enable the usage of
2089 the Cilk Plus Language extension features for C/C++.  The present
2090 implementation follows ABI version 1.2.  This is an experimental
2091 feature that is only partially complete, and whose interface may
2092 change in future versions of GCC as the official specification
2093 changes.  Currently, all features but @code{_Cilk_for} have been
2094 implemented.
2096 @item -fgnu-tm
2097 @opindex fgnu-tm
2098 When the option @option{-fgnu-tm} is specified, the compiler
2099 generates code for the Linux variant of Intel's current Transactional
2100 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2101 an experimental feature whose interface may change in future versions
2102 of GCC, as the official specification changes.  Please note that not
2103 all architectures are supported for this feature.
2105 For more information on GCC's support for transactional memory,
2106 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2107 Transactional Memory Library}.
2109 Note that the transactional memory feature is not supported with
2110 non-call exceptions (@option{-fnon-call-exceptions}).
2112 @item -fms-extensions
2113 @opindex fms-extensions
2114 Accept some non-standard constructs used in Microsoft header files.
2116 In C++ code, this allows member names in structures to be similar
2117 to previous types declarations.
2119 @smallexample
2120 typedef int UOW;
2121 struct ABC @{
2122   UOW UOW;
2124 @end smallexample
2126 Some cases of unnamed fields in structures and unions are only
2127 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2128 fields within structs/unions}, for details.
2130 Note that this option is off for all targets but x86 
2131 targets using ms-abi.
2133 @item -fplan9-extensions
2134 @opindex fplan9-extensions
2135 Accept some non-standard constructs used in Plan 9 code.
2137 This enables @option{-fms-extensions}, permits passing pointers to
2138 structures with anonymous fields to functions that expect pointers to
2139 elements of the type of the field, and permits referring to anonymous
2140 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2141 struct/union fields within structs/unions}, for details.  This is only
2142 supported for C, not C++.
2144 @item -fcond-mismatch
2145 @opindex fcond-mismatch
2146 Allow conditional expressions with mismatched types in the second and
2147 third arguments.  The value of such an expression is void.  This option
2148 is not supported for C++.
2150 @item -flax-vector-conversions
2151 @opindex flax-vector-conversions
2152 Allow implicit conversions between vectors with differing numbers of
2153 elements and/or incompatible element types.  This option should not be
2154 used for new code.
2156 @item -funsigned-char
2157 @opindex funsigned-char
2158 Let the type @code{char} be unsigned, like @code{unsigned char}.
2160 Each kind of machine has a default for what @code{char} should
2161 be.  It is either like @code{unsigned char} by default or like
2162 @code{signed char} by default.
2164 Ideally, a portable program should always use @code{signed char} or
2165 @code{unsigned char} when it depends on the signedness of an object.
2166 But many programs have been written to use plain @code{char} and
2167 expect it to be signed, or expect it to be unsigned, depending on the
2168 machines they were written for.  This option, and its inverse, let you
2169 make such a program work with the opposite default.
2171 The type @code{char} is always a distinct type from each of
2172 @code{signed char} or @code{unsigned char}, even though its behavior
2173 is always just like one of those two.
2175 @item -fsigned-char
2176 @opindex fsigned-char
2177 Let the type @code{char} be signed, like @code{signed char}.
2179 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2180 the negative form of @option{-funsigned-char}.  Likewise, the option
2181 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2183 @item -fsigned-bitfields
2184 @itemx -funsigned-bitfields
2185 @itemx -fno-signed-bitfields
2186 @itemx -fno-unsigned-bitfields
2187 @opindex fsigned-bitfields
2188 @opindex funsigned-bitfields
2189 @opindex fno-signed-bitfields
2190 @opindex fno-unsigned-bitfields
2191 These options control whether a bit-field is signed or unsigned, when the
2192 declaration does not use either @code{signed} or @code{unsigned}.  By
2193 default, such a bit-field is signed, because this is consistent: the
2194 basic integer types such as @code{int} are signed types.
2196 @item -fsso-struct=@var{endianness}
2197 @opindex fsso-struct
2198 Set the default scalar storage order of structures and unions to the
2199 specified endianness.  The accepted values are @samp{big-endian},
2200 @samp{little-endian} and @samp{native} for the native endianness of
2201 the target (the default).  This option is not supported for C++.
2203 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2204 code that is not binary compatible with code generated without it if the
2205 specified endianness is not the native endianness of the target.
2206 @end table
2208 @node C++ Dialect Options
2209 @section Options Controlling C++ Dialect
2211 @cindex compiler options, C++
2212 @cindex C++ options, command-line
2213 @cindex options, C++
2214 This section describes the command-line options that are only meaningful
2215 for C++ programs.  You can also use most of the GNU compiler options
2216 regardless of what language your program is in.  For example, you
2217 might compile a file @file{firstClass.C} like this:
2219 @smallexample
2220 g++ -g -fstrict-enums -O -c firstClass.C
2221 @end smallexample
2223 @noindent
2224 In this example, only @option{-fstrict-enums} is an option meant
2225 only for C++ programs; you can use the other options with any
2226 language supported by GCC@.
2228 Some options for compiling C programs, such as @option{-std}, are also
2229 relevant for C++ programs.
2230 @xref{C Dialect Options,,Options Controlling C Dialect}.
2232 Here is a list of options that are @emph{only} for compiling C++ programs:
2234 @table @gcctabopt
2236 @item -fabi-version=@var{n}
2237 @opindex fabi-version
2238 Use version @var{n} of the C++ ABI@.  The default is version 0.
2240 Version 0 refers to the version conforming most closely to
2241 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2242 will change in different versions of G++ as ABI bugs are fixed.
2244 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2246 Version 2 is the version of the C++ ABI that first appeared in G++
2247 3.4, and was the default through G++ 4.9.
2249 Version 3 corrects an error in mangling a constant address as a
2250 template argument.
2252 Version 4, which first appeared in G++ 4.5, implements a standard
2253 mangling for vector types.
2255 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2256 attribute const/volatile on function pointer types, decltype of a
2257 plain decl, and use of a function parameter in the declaration of
2258 another parameter.
2260 Version 6, which first appeared in G++ 4.7, corrects the promotion
2261 behavior of C++11 scoped enums and the mangling of template argument
2262 packs, const/static_cast, prefix ++ and --, and a class scope function
2263 used as a template argument.
2265 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2266 builtin type and corrects the mangling of lambdas in default argument
2267 scope.
2269 Version 8, which first appeared in G++ 4.9, corrects the substitution
2270 behavior of function types with function-cv-qualifiers.
2272 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2273 @code{nullptr_t}.
2275 Version 10, which first appeared in G++ 6.1, adds mangling of
2276 attributes that affect type identity, such as ia32 calling convention
2277 attributes (e.g. @samp{stdcall}).
2279 Version 11, which first appeared in G++ 7, corrects the mangling of
2280 sizeof... expressions and operator names.  For multiple entities with
2281 the same name within a function, that are declared in different scopes,
2282 the mangling now changes starting with the twelfth occurrence.  It also
2283 implies @option{-fnew-inheriting-ctors}.
2285 See also @option{-Wabi}.
2287 @item -fabi-compat-version=@var{n}
2288 @opindex fabi-compat-version
2289 On targets that support strong aliases, G++
2290 works around mangling changes by creating an alias with the correct
2291 mangled name when defining a symbol with an incorrect mangled name.
2292 This switch specifies which ABI version to use for the alias.
2294 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2295 compatibility).  If another ABI version is explicitly selected, this
2296 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2297 use @option{-fabi-compat-version=2}.
2299 If this option is not provided but @option{-Wabi=@var{n}} is, that
2300 version is used for compatibility aliases.  If this option is provided
2301 along with @option{-Wabi} (without the version), the version from this
2302 option is used for the warning.
2304 @item -fno-access-control
2305 @opindex fno-access-control
2306 Turn off all access checking.  This switch is mainly useful for working
2307 around bugs in the access control code.
2309 @item -faligned-new
2310 @opindex faligned-new
2311 Enable support for C++17 @code{new} of types that require more
2312 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2313 numeric argument such as @code{-faligned-new=32} can be used to
2314 specify how much alignment (in bytes) is provided by that function,
2315 but few users will need to override the default of
2316 @code{alignof(std::max_align_t)}.
2318 This flag is enabled by default for @option{-std=c++17}.
2320 @item -fcheck-new
2321 @opindex fcheck-new
2322 Check that the pointer returned by @code{operator new} is non-null
2323 before attempting to modify the storage allocated.  This check is
2324 normally unnecessary because the C++ standard specifies that
2325 @code{operator new} only returns @code{0} if it is declared
2326 @code{throw()}, in which case the compiler always checks the
2327 return value even without this option.  In all other cases, when
2328 @code{operator new} has a non-empty exception specification, memory
2329 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2330 @samp{new (nothrow)}.
2332 @item -fconcepts
2333 @opindex fconcepts
2334 Enable support for the C++ Extensions for Concepts Technical
2335 Specification, ISO 19217 (2015), which allows code like
2337 @smallexample
2338 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2339 template <Addable T> T add (T a, T b) @{ return a + b; @}
2340 @end smallexample
2342 @item -fconstexpr-depth=@var{n}
2343 @opindex fconstexpr-depth
2344 Set the maximum nested evaluation depth for C++11 constexpr functions
2345 to @var{n}.  A limit is needed to detect endless recursion during
2346 constant expression evaluation.  The minimum specified by the standard
2347 is 512.
2349 @item -fconstexpr-loop-limit=@var{n}
2350 @opindex fconstexpr-loop-limit
2351 Set the maximum number of iterations for a loop in C++14 constexpr functions
2352 to @var{n}.  A limit is needed to detect infinite loops during
2353 constant expression evaluation.  The default is 262144 (1<<18).
2355 @item -fdeduce-init-list
2356 @opindex fdeduce-init-list
2357 Enable deduction of a template type parameter as
2358 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2360 @smallexample
2361 template <class T> auto forward(T t) -> decltype (realfn (t))
2363   return realfn (t);
2366 void f()
2368   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2370 @end smallexample
2372 This deduction was implemented as a possible extension to the
2373 originally proposed semantics for the C++11 standard, but was not part
2374 of the final standard, so it is disabled by default.  This option is
2375 deprecated, and may be removed in a future version of G++.
2377 @item -ffriend-injection
2378 @opindex ffriend-injection
2379 Inject friend functions into the enclosing namespace, so that they are
2380 visible outside the scope of the class in which they are declared.
2381 Friend functions were documented to work this way in the old Annotated
2382 C++ Reference Manual.  
2383 However, in ISO C++ a friend function that is not declared
2384 in an enclosing scope can only be found using argument dependent
2385 lookup.  GCC defaults to the standard behavior.
2387 This option is for compatibility, and may be removed in a future
2388 release of G++.
2390 @item -fno-elide-constructors
2391 @opindex fno-elide-constructors
2392 The C++ standard allows an implementation to omit creating a temporary
2393 that is only used to initialize another object of the same type.
2394 Specifying this option disables that optimization, and forces G++ to
2395 call the copy constructor in all cases.  This option also causes G++
2396 to call trivial member functions which otherwise would be expanded inline.
2398 In C++17, the compiler is required to omit these temporaries, but this
2399 option still affects trivial member functions.
2401 @item -fno-enforce-eh-specs
2402 @opindex fno-enforce-eh-specs
2403 Don't generate code to check for violation of exception specifications
2404 at run time.  This option violates the C++ standard, but may be useful
2405 for reducing code size in production builds, much like defining
2406 @code{NDEBUG}.  This does not give user code permission to throw
2407 exceptions in violation of the exception specifications; the compiler
2408 still optimizes based on the specifications, so throwing an
2409 unexpected exception results in undefined behavior at run time.
2411 @item -fextern-tls-init
2412 @itemx -fno-extern-tls-init
2413 @opindex fextern-tls-init
2414 @opindex fno-extern-tls-init
2415 The C++11 and OpenMP standards allow @code{thread_local} and
2416 @code{threadprivate} variables to have dynamic (runtime)
2417 initialization.  To support this, any use of such a variable goes
2418 through a wrapper function that performs any necessary initialization.
2419 When the use and definition of the variable are in the same
2420 translation unit, this overhead can be optimized away, but when the
2421 use is in a different translation unit there is significant overhead
2422 even if the variable doesn't actually need dynamic initialization.  If
2423 the programmer can be sure that no use of the variable in a
2424 non-defining TU needs to trigger dynamic initialization (either
2425 because the variable is statically initialized, or a use of the
2426 variable in the defining TU will be executed before any uses in
2427 another TU), they can avoid this overhead with the
2428 @option{-fno-extern-tls-init} option.
2430 On targets that support symbol aliases, the default is
2431 @option{-fextern-tls-init}.  On targets that do not support symbol
2432 aliases, the default is @option{-fno-extern-tls-init}.
2434 @item -ffor-scope
2435 @itemx -fno-for-scope
2436 @opindex ffor-scope
2437 @opindex fno-for-scope
2438 If @option{-ffor-scope} is specified, the scope of variables declared in
2439 a @i{for-init-statement} is limited to the @code{for} loop itself,
2440 as specified by the C++ standard.
2441 If @option{-fno-for-scope} is specified, the scope of variables declared in
2442 a @i{for-init-statement} extends to the end of the enclosing scope,
2443 as was the case in old versions of G++, and other (traditional)
2444 implementations of C++.
2446 If neither flag is given, the default is to follow the standard,
2447 but to allow and give a warning for old-style code that would
2448 otherwise be invalid, or have different behavior.
2450 @item -fno-gnu-keywords
2451 @opindex fno-gnu-keywords
2452 Do not recognize @code{typeof} as a keyword, so that code can use this
2453 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2454 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2455 @option{-std=c++98}, @option{-std=c++11}, etc.
2457 @item -fno-implicit-templates
2458 @opindex fno-implicit-templates
2459 Never emit code for non-inline templates that are instantiated
2460 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2461 @xref{Template Instantiation}, for more information.
2463 @item -fno-implicit-inline-templates
2464 @opindex fno-implicit-inline-templates
2465 Don't emit code for implicit instantiations of inline templates, either.
2466 The default is to handle inlines differently so that compiles with and
2467 without optimization need the same set of explicit instantiations.
2469 @item -fno-implement-inlines
2470 @opindex fno-implement-inlines
2471 To save space, do not emit out-of-line copies of inline functions
2472 controlled by @code{#pragma implementation}.  This causes linker
2473 errors if these functions are not inlined everywhere they are called.
2475 @item -fms-extensions
2476 @opindex fms-extensions
2477 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2478 int and getting a pointer to member function via non-standard syntax.
2480 @item -fnew-inheriting-ctors
2481 @opindex fnew-inheriting-ctors
2482 Enable the P0136 adjustment to the semantics of C++11 constructor
2483 inheritance.  This is part of C++17 but also considered to be a Defect
2484 Report against C++11 and C++14.  This flag is enabled by default
2485 unless @option{-fabi-version=10} or lower is specified.
2487 @item -fnew-ttp-matching
2488 @opindex fnew-ttp-matching
2489 Enable the P0522 resolution to Core issue 150, template template
2490 parameters and default arguments: this allows a template with default
2491 template arguments as an argument for a template template parameter
2492 with fewer template parameters.  This flag is enabled by default for
2493 @option{-std=c++17}.
2495 @item -fno-nonansi-builtins
2496 @opindex fno-nonansi-builtins
2497 Disable built-in declarations of functions that are not mandated by
2498 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2499 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2501 @item -fnothrow-opt
2502 @opindex fnothrow-opt
2503 Treat a @code{throw()} exception specification as if it were a
2504 @code{noexcept} specification to reduce or eliminate the text size
2505 overhead relative to a function with no exception specification.  If
2506 the function has local variables of types with non-trivial
2507 destructors, the exception specification actually makes the
2508 function smaller because the EH cleanups for those variables can be
2509 optimized away.  The semantic effect is that an exception thrown out of
2510 a function with such an exception specification results in a call
2511 to @code{terminate} rather than @code{unexpected}.
2513 @item -fno-operator-names
2514 @opindex fno-operator-names
2515 Do not treat the operator name keywords @code{and}, @code{bitand},
2516 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2517 synonyms as keywords.
2519 @item -fno-optional-diags
2520 @opindex fno-optional-diags
2521 Disable diagnostics that the standard says a compiler does not need to
2522 issue.  Currently, the only such diagnostic issued by G++ is the one for
2523 a name having multiple meanings within a class.
2525 @item -fpermissive
2526 @opindex fpermissive
2527 Downgrade some diagnostics about nonconformant code from errors to
2528 warnings.  Thus, using @option{-fpermissive} allows some
2529 nonconforming code to compile.
2531 @item -fno-pretty-templates
2532 @opindex fno-pretty-templates
2533 When an error message refers to a specialization of a function
2534 template, the compiler normally prints the signature of the
2535 template followed by the template arguments and any typedefs or
2536 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2537 rather than @code{void f(int)}) so that it's clear which template is
2538 involved.  When an error message refers to a specialization of a class
2539 template, the compiler omits any template arguments that match
2540 the default template arguments for that template.  If either of these
2541 behaviors make it harder to understand the error message rather than
2542 easier, you can use @option{-fno-pretty-templates} to disable them.
2544 @item -frepo
2545 @opindex frepo
2546 Enable automatic template instantiation at link time.  This option also
2547 implies @option{-fno-implicit-templates}.  @xref{Template
2548 Instantiation}, for more information.
2550 @item -fno-rtti
2551 @opindex fno-rtti
2552 Disable generation of information about every class with virtual
2553 functions for use by the C++ run-time type identification features
2554 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2555 of the language, you can save some space by using this flag.  Note that
2556 exception handling uses the same information, but G++ generates it as
2557 needed. The @code{dynamic_cast} operator can still be used for casts that
2558 do not require run-time type information, i.e.@: casts to @code{void *} or to
2559 unambiguous base classes.
2561 @item -fsized-deallocation
2562 @opindex fsized-deallocation
2563 Enable the built-in global declarations
2564 @smallexample
2565 void operator delete (void *, std::size_t) noexcept;
2566 void operator delete[] (void *, std::size_t) noexcept;
2567 @end smallexample
2568 as introduced in C++14.  This is useful for user-defined replacement
2569 deallocation functions that, for example, use the size of the object
2570 to make deallocation faster.  Enabled by default under
2571 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2572 warns about places that might want to add a definition.
2574 @item -fstrict-enums
2575 @opindex fstrict-enums
2576 Allow the compiler to optimize using the assumption that a value of
2577 enumerated type can only be one of the values of the enumeration (as
2578 defined in the C++ standard; basically, a value that can be
2579 represented in the minimum number of bits needed to represent all the
2580 enumerators).  This assumption may not be valid if the program uses a
2581 cast to convert an arbitrary integer value to the enumerated type.
2583 @item -fstrong-eval-order
2584 @opindex fstrong-eval-order
2585 Evaluate member access, array subscripting, and shift expressions in
2586 left-to-right order, and evaluate assignment in right-to-left order,
2587 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2588 @option{-fstrong-eval-order=some} enables just the ordering of member
2589 access and shift expressions, and is the default without
2590 @option{-std=c++17}.
2592 @item -ftemplate-backtrace-limit=@var{n}
2593 @opindex ftemplate-backtrace-limit
2594 Set the maximum number of template instantiation notes for a single
2595 warning or error to @var{n}.  The default value is 10.
2597 @item -ftemplate-depth=@var{n}
2598 @opindex ftemplate-depth
2599 Set the maximum instantiation depth for template classes to @var{n}.
2600 A limit on the template instantiation depth is needed to detect
2601 endless recursions during template class instantiation.  ANSI/ISO C++
2602 conforming programs must not rely on a maximum depth greater than 17
2603 (changed to 1024 in C++11).  The default value is 900, as the compiler
2604 can run out of stack space before hitting 1024 in some situations.
2606 @item -fno-threadsafe-statics
2607 @opindex fno-threadsafe-statics
2608 Do not emit the extra code to use the routines specified in the C++
2609 ABI for thread-safe initialization of local statics.  You can use this
2610 option to reduce code size slightly in code that doesn't need to be
2611 thread-safe.
2613 @item -fuse-cxa-atexit
2614 @opindex fuse-cxa-atexit
2615 Register destructors for objects with static storage duration with the
2616 @code{__cxa_atexit} function rather than the @code{atexit} function.
2617 This option is required for fully standards-compliant handling of static
2618 destructors, but only works if your C library supports
2619 @code{__cxa_atexit}.
2621 @item -fno-use-cxa-get-exception-ptr
2622 @opindex fno-use-cxa-get-exception-ptr
2623 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2624 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2625 if the runtime routine is not available.
2627 @item -fvisibility-inlines-hidden
2628 @opindex fvisibility-inlines-hidden
2629 This switch declares that the user does not attempt to compare
2630 pointers to inline functions or methods where the addresses of the two functions
2631 are taken in different shared objects.
2633 The effect of this is that GCC may, effectively, mark inline methods with
2634 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2635 appear in the export table of a DSO and do not require a PLT indirection
2636 when used within the DSO@.  Enabling this option can have a dramatic effect
2637 on load and link times of a DSO as it massively reduces the size of the
2638 dynamic export table when the library makes heavy use of templates.
2640 The behavior of this switch is not quite the same as marking the
2641 methods as hidden directly, because it does not affect static variables
2642 local to the function or cause the compiler to deduce that
2643 the function is defined in only one shared object.
2645 You may mark a method as having a visibility explicitly to negate the
2646 effect of the switch for that method.  For example, if you do want to
2647 compare pointers to a particular inline method, you might mark it as
2648 having default visibility.  Marking the enclosing class with explicit
2649 visibility has no effect.
2651 Explicitly instantiated inline methods are unaffected by this option
2652 as their linkage might otherwise cross a shared library boundary.
2653 @xref{Template Instantiation}.
2655 @item -fvisibility-ms-compat
2656 @opindex fvisibility-ms-compat
2657 This flag attempts to use visibility settings to make GCC's C++
2658 linkage model compatible with that of Microsoft Visual Studio.
2660 The flag makes these changes to GCC's linkage model:
2662 @enumerate
2663 @item
2664 It sets the default visibility to @code{hidden}, like
2665 @option{-fvisibility=hidden}.
2667 @item
2668 Types, but not their members, are not hidden by default.
2670 @item
2671 The One Definition Rule is relaxed for types without explicit
2672 visibility specifications that are defined in more than one
2673 shared object: those declarations are permitted if they are
2674 permitted when this option is not used.
2675 @end enumerate
2677 In new code it is better to use @option{-fvisibility=hidden} and
2678 export those classes that are intended to be externally visible.
2679 Unfortunately it is possible for code to rely, perhaps accidentally,
2680 on the Visual Studio behavior.
2682 Among the consequences of these changes are that static data members
2683 of the same type with the same name but defined in different shared
2684 objects are different, so changing one does not change the other;
2685 and that pointers to function members defined in different shared
2686 objects may not compare equal.  When this flag is given, it is a
2687 violation of the ODR to define types with the same name differently.
2689 @item -fno-weak
2690 @opindex fno-weak
2691 Do not use weak symbol support, even if it is provided by the linker.
2692 By default, G++ uses weak symbols if they are available.  This
2693 option exists only for testing, and should not be used by end-users;
2694 it results in inferior code and has no benefits.  This option may
2695 be removed in a future release of G++.
2697 @item -nostdinc++
2698 @opindex nostdinc++
2699 Do not search for header files in the standard directories specific to
2700 C++, but do still search the other standard directories.  (This option
2701 is used when building the C++ library.)
2702 @end table
2704 In addition, these optimization, warning, and code generation options
2705 have meanings only for C++ programs:
2707 @table @gcctabopt
2708 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2709 @opindex Wabi
2710 @opindex Wno-abi
2711 Warn when G++ it generates code that is probably not compatible with
2712 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2713 ABI with each major release, normally @option{-Wabi} will warn only if
2714 there is a check added later in a release series for an ABI issue
2715 discovered since the initial release.  @option{-Wabi} will warn about
2716 more things if an older ABI version is selected (with
2717 @option{-fabi-version=@var{n}}).
2719 @option{-Wabi} can also be used with an explicit version number to
2720 warn about compatibility with a particular @option{-fabi-version}
2721 level, e.g. @option{-Wabi=2} to warn about changes relative to
2722 @option{-fabi-version=2}.
2724 If an explicit version number is provided and
2725 @option{-fabi-compat-version} is not specified, the version number
2726 from this option is used for compatibility aliases.  If no explicit
2727 version number is provided with this option, but
2728 @option{-fabi-compat-version} is specified, that version number is
2729 used for ABI warnings.
2731 Although an effort has been made to warn about
2732 all such cases, there are probably some cases that are not warned about,
2733 even though G++ is generating incompatible code.  There may also be
2734 cases where warnings are emitted even though the code that is generated
2735 is compatible.
2737 You should rewrite your code to avoid these warnings if you are
2738 concerned about the fact that code generated by G++ may not be binary
2739 compatible with code generated by other compilers.
2741 Known incompatibilities in @option{-fabi-version=2} (which was the
2742 default from GCC 3.4 to 4.9) include:
2744 @itemize @bullet
2746 @item
2747 A template with a non-type template parameter of reference type was
2748 mangled incorrectly:
2749 @smallexample
2750 extern int N;
2751 template <int &> struct S @{@};
2752 void n (S<N>) @{2@}
2753 @end smallexample
2755 This was fixed in @option{-fabi-version=3}.
2757 @item
2758 SIMD vector types declared using @code{__attribute ((vector_size))} were
2759 mangled in a non-standard way that does not allow for overloading of
2760 functions taking vectors of different sizes.
2762 The mangling was changed in @option{-fabi-version=4}.
2764 @item
2765 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2766 qualifiers, and @code{decltype} of a plain declaration was folded away.
2768 These mangling issues were fixed in @option{-fabi-version=5}.
2770 @item
2771 Scoped enumerators passed as arguments to a variadic function are
2772 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2773 On most targets this does not actually affect the parameter passing
2774 ABI, as there is no way to pass an argument smaller than @code{int}.
2776 Also, the ABI changed the mangling of template argument packs,
2777 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2778 a class scope function used as a template argument.
2780 These issues were corrected in @option{-fabi-version=6}.
2782 @item
2783 Lambdas in default argument scope were mangled incorrectly, and the
2784 ABI changed the mangling of @code{nullptr_t}.
2786 These issues were corrected in @option{-fabi-version=7}.
2788 @item
2789 When mangling a function type with function-cv-qualifiers, the
2790 un-qualified function type was incorrectly treated as a substitution
2791 candidate.
2793 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2795 @item
2796 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2797 unaligned accesses.  Note that this did not affect the ABI of a
2798 function with a @code{nullptr_t} parameter, as parameters have a
2799 minimum alignment.
2801 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2803 @item
2804 Target-specific attributes that affect the identity of a type, such as
2805 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2806 did not affect the mangled name, leading to name collisions when
2807 function pointers were used as template arguments.
2809 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2811 @end itemize
2813 It also warns about psABI-related changes.  The known psABI changes at this
2814 point include:
2816 @itemize @bullet
2818 @item
2819 For SysV/x86-64, unions with @code{long double} members are 
2820 passed in memory as specified in psABI.  For example:
2822 @smallexample
2823 union U @{
2824   long double ld;
2825   int i;
2827 @end smallexample
2829 @noindent
2830 @code{union U} is always passed in memory.
2832 @end itemize
2834 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2835 @opindex Wabi-tag
2836 @opindex -Wabi-tag
2837 Warn when a type with an ABI tag is used in a context that does not
2838 have that ABI tag.  See @ref{C++ Attributes} for more information
2839 about ABI tags.
2841 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2842 @opindex Wctor-dtor-privacy
2843 @opindex Wno-ctor-dtor-privacy
2844 Warn when a class seems unusable because all the constructors or
2845 destructors in that class are private, and it has neither friends nor
2846 public static member functions.  Also warn if there are no non-private
2847 methods, and there's at least one private member function that isn't
2848 a constructor or destructor.
2850 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2851 @opindex Wdelete-non-virtual-dtor
2852 @opindex Wno-delete-non-virtual-dtor
2853 Warn when @code{delete} is used to destroy an instance of a class that
2854 has virtual functions and non-virtual destructor. It is unsafe to delete
2855 an instance of a derived class through a pointer to a base class if the
2856 base class does not have a virtual destructor.  This warning is enabled
2857 by @option{-Wall}.
2859 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2860 @opindex Wliteral-suffix
2861 @opindex Wno-literal-suffix
2862 Warn when a string or character literal is followed by a ud-suffix which does
2863 not begin with an underscore.  As a conforming extension, GCC treats such
2864 suffixes as separate preprocessing tokens in order to maintain backwards
2865 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2866 For example:
2868 @smallexample
2869 #define __STDC_FORMAT_MACROS
2870 #include <inttypes.h>
2871 #include <stdio.h>
2873 int main() @{
2874   int64_t i64 = 123;
2875   printf("My int64: %" PRId64"\n", i64);
2877 @end smallexample
2879 In this case, @code{PRId64} is treated as a separate preprocessing token.
2881 Additionally, warn when a user-defined literal operator is declared with
2882 a literal suffix identifier that doesn't begin with an underscore. Literal
2883 suffix identifiers that don't begin with an underscore are reserved for
2884 future standardization.
2886 This warning is enabled by default.
2888 @item -Wlto-type-mismatch
2889 @opindex Wlto-type-mismatch
2890 @opindex Wno-lto-type-mismatch
2892 During the link-time optimization warn about type mismatches in
2893 global declarations from different compilation units.
2894 Requires @option{-flto} to be enabled.  Enabled by default.
2896 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2897 @opindex Wnarrowing
2898 @opindex Wno-narrowing
2899 For C++11 and later standards, narrowing conversions are diagnosed by default,
2900 as required by the standard.  A narrowing conversion from a constant produces
2901 an error, and a narrowing conversion from a non-constant produces a warning,
2902 but @option{-Wno-narrowing} suppresses the diagnostic.
2903 Note that this does not affect the meaning of well-formed code;
2904 narrowing conversions are still considered ill-formed in SFINAE contexts.
2906 With @option{-Wnarrowing} in C++98, warn when a narrowing
2907 conversion prohibited by C++11 occurs within
2908 @samp{@{ @}}, e.g.
2910 @smallexample
2911 int i = @{ 2.2 @}; // error: narrowing from double to int
2912 @end smallexample
2914 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2916 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2917 @opindex Wnoexcept
2918 @opindex Wno-noexcept
2919 Warn when a noexcept-expression evaluates to false because of a call
2920 to a function that does not have a non-throwing exception
2921 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2922 the compiler to never throw an exception.
2924 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2925 @opindex Wnoexcept-type
2926 @opindex Wno-noexcept-type
2927 Warn if the C++17 feature making @code{noexcept} part of a function
2928 type changes the mangled name of a symbol relative to C++14.  Enabled
2929 by @option{-Wabi} and @option{-Wc++17-compat}.
2931 @smallexample
2932 template <class T> void f(T t) @{ t(); @};
2933 void g() noexcept;
2934 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++17 calls f<void(*)()noexcept>
2935 @end smallexample
2937 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2938 @opindex Wclass-memaccess
2939 Warn when the destination of a call to a raw memory function such as
2940 @code{memset} or @code{memcpy} is an object of class type writing into which
2941 might bypass the class non-trivial or deleted constructor or copy assignment,
2942 violate const-correctness or encapsulation, or corrupt the virtual table.
2943 Modifying the representation of such objects may violate invariants maintained
2944 by member functions of the class.  For example, the call to @code{memset}
2945 below is undefined becase it modifies a non-trivial class object and is,
2946 therefore, diagnosed.  The safe way to either initialize or clear the storage
2947 of objects of such types is by using the appropriate constructor or assignment
2948 operator, if one is available.
2949 @smallexample
2950 std::string str = "abc";
2951 memset (&str, 0, 3);
2952 @end smallexample
2953 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2955 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2956 @opindex Wnon-virtual-dtor
2957 @opindex Wno-non-virtual-dtor
2958 Warn when a class has virtual functions and an accessible non-virtual
2959 destructor itself or in an accessible polymorphic base class, in which
2960 case it is possible but unsafe to delete an instance of a derived
2961 class through a pointer to the class itself or base class.  This
2962 warning is automatically enabled if @option{-Weffc++} is specified.
2964 @item -Wregister @r{(C++ and Objective-C++ only)}
2965 @opindex Wregister
2966 @opindex Wno-register
2967 Warn on uses of the @code{register} storage class specifier, except
2968 when it is part of the GNU @ref{Explicit Register Variables} extension.
2969 The use of the @code{register} keyword as storage class specifier has
2970 been deprecated in C++11 and removed in C++17.
2971 Enabled by default with @option{-std=c++17}.
2973 @item -Wreorder @r{(C++ and Objective-C++ only)}
2974 @opindex Wreorder
2975 @opindex Wno-reorder
2976 @cindex reordering, warning
2977 @cindex warning for reordering of member initializers
2978 Warn when the order of member initializers given in the code does not
2979 match the order in which they must be executed.  For instance:
2981 @smallexample
2982 struct A @{
2983   int i;
2984   int j;
2985   A(): j (0), i (1) @{ @}
2987 @end smallexample
2989 @noindent
2990 The compiler rearranges the member initializers for @code{i}
2991 and @code{j} to match the declaration order of the members, emitting
2992 a warning to that effect.  This warning is enabled by @option{-Wall}.
2994 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2995 @opindex fext-numeric-literals
2996 @opindex fno-ext-numeric-literals
2997 Accept imaginary, fixed-point, or machine-defined
2998 literal number suffixes as GNU extensions.
2999 When this option is turned off these suffixes are treated
3000 as C++11 user-defined literal numeric suffixes.
3001 This is on by default for all pre-C++11 dialects and all GNU dialects:
3002 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3003 @option{-std=gnu++14}.
3004 This option is off by default
3005 for ISO C++11 onwards (@option{-std=c++11}, ...).
3006 @end table
3008 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3010 @table @gcctabopt
3011 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3012 @opindex Weffc++
3013 @opindex Wno-effc++
3014 Warn about violations of the following style guidelines from Scott Meyers'
3015 @cite{Effective C++} series of books:
3017 @itemize @bullet
3018 @item
3019 Define a copy constructor and an assignment operator for classes
3020 with dynamically-allocated memory.
3022 @item
3023 Prefer initialization to assignment in constructors.
3025 @item
3026 Have @code{operator=} return a reference to @code{*this}.
3028 @item
3029 Don't try to return a reference when you must return an object.
3031 @item
3032 Distinguish between prefix and postfix forms of increment and
3033 decrement operators.
3035 @item
3036 Never overload @code{&&}, @code{||}, or @code{,}.
3038 @end itemize
3040 This option also enables @option{-Wnon-virtual-dtor}, which is also
3041 one of the effective C++ recommendations.  However, the check is
3042 extended to warn about the lack of virtual destructor in accessible
3043 non-polymorphic bases classes too.
3045 When selecting this option, be aware that the standard library
3046 headers do not obey all of these guidelines; use @samp{grep -v}
3047 to filter out those warnings.
3049 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3050 @opindex Wstrict-null-sentinel
3051 @opindex Wno-strict-null-sentinel
3052 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3053 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3054 to @code{__null}.  Although it is a null pointer constant rather than a
3055 null pointer, it is guaranteed to be of the same size as a pointer.
3056 But this use is not portable across different compilers.
3058 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3059 @opindex Wno-non-template-friend
3060 @opindex Wnon-template-friend
3061 Disable warnings when non-template friend functions are declared
3062 within a template.  In very old versions of GCC that predate implementation
3063 of the ISO standard, declarations such as 
3064 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3065 could be interpreted as a particular specialization of a template
3066 function; the warning exists to diagnose compatibility problems, 
3067 and is enabled by default.
3069 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3070 @opindex Wold-style-cast
3071 @opindex Wno-old-style-cast
3072 Warn if an old-style (C-style) cast to a non-void type is used within
3073 a C++ program.  The new-style casts (@code{dynamic_cast},
3074 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3075 less vulnerable to unintended effects and much easier to search for.
3077 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3078 @opindex Woverloaded-virtual
3079 @opindex Wno-overloaded-virtual
3080 @cindex overloaded virtual function, warning
3081 @cindex warning for overloaded virtual function
3082 Warn when a function declaration hides virtual functions from a
3083 base class.  For example, in:
3085 @smallexample
3086 struct A @{
3087   virtual void f();
3090 struct B: public A @{
3091   void f(int);
3093 @end smallexample
3095 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3096 like:
3098 @smallexample
3099 B* b;
3100 b->f();
3101 @end smallexample
3103 @noindent
3104 fails to compile.
3106 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3107 @opindex Wno-pmf-conversions
3108 @opindex Wpmf-conversions
3109 Disable the diagnostic for converting a bound pointer to member function
3110 to a plain pointer.
3112 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3113 @opindex Wsign-promo
3114 @opindex Wno-sign-promo
3115 Warn when overload resolution chooses a promotion from unsigned or
3116 enumerated type to a signed type, over a conversion to an unsigned type of
3117 the same size.  Previous versions of G++ tried to preserve
3118 unsignedness, but the standard mandates the current behavior.
3120 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3121 @opindex Wtemplates
3122 Warn when a primary template declaration is encountered.  Some coding
3123 rules disallow templates, and this may be used to enforce that rule.
3124 The warning is inactive inside a system header file, such as the STL, so
3125 one can still use the STL.  One may also instantiate or specialize
3126 templates.
3128 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3129 @opindex Wmultiple-inheritance
3130 Warn when a class is defined with multiple direct base classes.  Some
3131 coding rules disallow multiple inheritance, and this may be used to
3132 enforce that rule.  The warning is inactive inside a system header file,
3133 such as the STL, so one can still use the STL.  One may also define
3134 classes that indirectly use multiple inheritance.
3136 @item -Wvirtual-inheritance
3137 @opindex Wvirtual-inheritance
3138 Warn when a class is defined with a virtual direct base class.  Some
3139 coding rules disallow multiple inheritance, and this may be used to
3140 enforce that rule.  The warning is inactive inside a system header file,
3141 such as the STL, so one can still use the STL.  One may also define
3142 classes that indirectly use virtual inheritance.
3144 @item -Wnamespaces
3145 @opindex Wnamespaces
3146 Warn when a namespace definition is opened.  Some coding rules disallow
3147 namespaces, and this may be used to enforce that rule.  The warning is
3148 inactive inside a system header file, such as the STL, so one can still
3149 use the STL.  One may also use using directives and qualified names.
3151 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3152 @opindex Wterminate
3153 @opindex Wno-terminate
3154 Disable the warning about a throw-expression that will immediately
3155 result in a call to @code{terminate}.
3156 @end table
3158 @node Objective-C and Objective-C++ Dialect Options
3159 @section Options Controlling Objective-C and Objective-C++ Dialects
3161 @cindex compiler options, Objective-C and Objective-C++
3162 @cindex Objective-C and Objective-C++ options, command-line
3163 @cindex options, Objective-C and Objective-C++
3164 (NOTE: This manual does not describe the Objective-C and Objective-C++
3165 languages themselves.  @xref{Standards,,Language Standards
3166 Supported by GCC}, for references.)
3168 This section describes the command-line options that are only meaningful
3169 for Objective-C and Objective-C++ programs.  You can also use most of
3170 the language-independent GNU compiler options.
3171 For example, you might compile a file @file{some_class.m} like this:
3173 @smallexample
3174 gcc -g -fgnu-runtime -O -c some_class.m
3175 @end smallexample
3177 @noindent
3178 In this example, @option{-fgnu-runtime} is an option meant only for
3179 Objective-C and Objective-C++ programs; you can use the other options with
3180 any language supported by GCC@.
3182 Note that since Objective-C is an extension of the C language, Objective-C
3183 compilations may also use options specific to the C front-end (e.g.,
3184 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3185 C++-specific options (e.g., @option{-Wabi}).
3187 Here is a list of options that are @emph{only} for compiling Objective-C
3188 and Objective-C++ programs:
3190 @table @gcctabopt
3191 @item -fconstant-string-class=@var{class-name}
3192 @opindex fconstant-string-class
3193 Use @var{class-name} as the name of the class to instantiate for each
3194 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3195 class name is @code{NXConstantString} if the GNU runtime is being used, and
3196 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3197 @option{-fconstant-cfstrings} option, if also present, overrides the
3198 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3199 to be laid out as constant CoreFoundation strings.
3201 @item -fgnu-runtime
3202 @opindex fgnu-runtime
3203 Generate object code compatible with the standard GNU Objective-C
3204 runtime.  This is the default for most types of systems.
3206 @item -fnext-runtime
3207 @opindex fnext-runtime
3208 Generate output compatible with the NeXT runtime.  This is the default
3209 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3210 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3211 used.
3213 @item -fno-nil-receivers
3214 @opindex fno-nil-receivers
3215 Assume that all Objective-C message dispatches (@code{[receiver
3216 message:arg]}) in this translation unit ensure that the receiver is
3217 not @code{nil}.  This allows for more efficient entry points in the
3218 runtime to be used.  This option is only available in conjunction with
3219 the NeXT runtime and ABI version 0 or 1.
3221 @item -fobjc-abi-version=@var{n}
3222 @opindex fobjc-abi-version
3223 Use version @var{n} of the Objective-C ABI for the selected runtime.
3224 This option is currently supported only for the NeXT runtime.  In that
3225 case, Version 0 is the traditional (32-bit) ABI without support for
3226 properties and other Objective-C 2.0 additions.  Version 1 is the
3227 traditional (32-bit) ABI with support for properties and other
3228 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3229 nothing is specified, the default is Version 0 on 32-bit target
3230 machines, and Version 2 on 64-bit target machines.
3232 @item -fobjc-call-cxx-cdtors
3233 @opindex fobjc-call-cxx-cdtors
3234 For each Objective-C class, check if any of its instance variables is a
3235 C++ object with a non-trivial default constructor.  If so, synthesize a
3236 special @code{- (id) .cxx_construct} instance method which runs
3237 non-trivial default constructors on any such instance variables, in order,
3238 and then return @code{self}.  Similarly, check if any instance variable
3239 is a C++ object with a non-trivial destructor, and if so, synthesize a
3240 special @code{- (void) .cxx_destruct} method which runs
3241 all such default destructors, in reverse order.
3243 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3244 methods thusly generated only operate on instance variables
3245 declared in the current Objective-C class, and not those inherited
3246 from superclasses.  It is the responsibility of the Objective-C
3247 runtime to invoke all such methods in an object's inheritance
3248 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3249 by the runtime immediately after a new object instance is allocated;
3250 the @code{- (void) .cxx_destruct} methods are invoked immediately
3251 before the runtime deallocates an object instance.
3253 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3254 support for invoking the @code{- (id) .cxx_construct} and
3255 @code{- (void) .cxx_destruct} methods.
3257 @item -fobjc-direct-dispatch
3258 @opindex fobjc-direct-dispatch
3259 Allow fast jumps to the message dispatcher.  On Darwin this is
3260 accomplished via the comm page.
3262 @item -fobjc-exceptions
3263 @opindex fobjc-exceptions
3264 Enable syntactic support for structured exception handling in
3265 Objective-C, similar to what is offered by C++.  This option
3266 is required to use the Objective-C keywords @code{@@try},
3267 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3268 @code{@@synchronized}.  This option is available with both the GNU
3269 runtime and the NeXT runtime (but not available in conjunction with
3270 the NeXT runtime on Mac OS X 10.2 and earlier).
3272 @item -fobjc-gc
3273 @opindex fobjc-gc
3274 Enable garbage collection (GC) in Objective-C and Objective-C++
3275 programs.  This option is only available with the NeXT runtime; the
3276 GNU runtime has a different garbage collection implementation that
3277 does not require special compiler flags.
3279 @item -fobjc-nilcheck
3280 @opindex fobjc-nilcheck
3281 For the NeXT runtime with version 2 of the ABI, check for a nil
3282 receiver in method invocations before doing the actual method call.
3283 This is the default and can be disabled using
3284 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3285 checked for nil in this way no matter what this flag is set to.
3286 Currently this flag does nothing when the GNU runtime, or an older
3287 version of the NeXT runtime ABI, is used.
3289 @item -fobjc-std=objc1
3290 @opindex fobjc-std
3291 Conform to the language syntax of Objective-C 1.0, the language
3292 recognized by GCC 4.0.  This only affects the Objective-C additions to
3293 the C/C++ language; it does not affect conformance to C/C++ standards,
3294 which is controlled by the separate C/C++ dialect option flags.  When
3295 this option is used with the Objective-C or Objective-C++ compiler,
3296 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3297 This is useful if you need to make sure that your Objective-C code can
3298 be compiled with older versions of GCC@.
3300 @item -freplace-objc-classes
3301 @opindex freplace-objc-classes
3302 Emit a special marker instructing @command{ld(1)} not to statically link in
3303 the resulting object file, and allow @command{dyld(1)} to load it in at
3304 run time instead.  This is used in conjunction with the Fix-and-Continue
3305 debugging mode, where the object file in question may be recompiled and
3306 dynamically reloaded in the course of program execution, without the need
3307 to restart the program itself.  Currently, Fix-and-Continue functionality
3308 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3309 and later.
3311 @item -fzero-link
3312 @opindex fzero-link
3313 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3314 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3315 compile time) with static class references that get initialized at load time,
3316 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3317 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3318 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3319 for individual class implementations to be modified during program execution.
3320 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3321 regardless of command-line options.
3323 @item -fno-local-ivars
3324 @opindex fno-local-ivars
3325 @opindex flocal-ivars
3326 By default instance variables in Objective-C can be accessed as if
3327 they were local variables from within the methods of the class they're
3328 declared in.  This can lead to shadowing between instance variables
3329 and other variables declared either locally inside a class method or
3330 globally with the same name.  Specifying the @option{-fno-local-ivars}
3331 flag disables this behavior thus avoiding variable shadowing issues.
3333 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3334 @opindex fivar-visibility
3335 Set the default instance variable visibility to the specified option
3336 so that instance variables declared outside the scope of any access
3337 modifier directives default to the specified visibility.
3339 @item -gen-decls
3340 @opindex gen-decls
3341 Dump interface declarations for all classes seen in the source file to a
3342 file named @file{@var{sourcename}.decl}.
3344 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3345 @opindex Wassign-intercept
3346 @opindex Wno-assign-intercept
3347 Warn whenever an Objective-C assignment is being intercepted by the
3348 garbage collector.
3350 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3351 @opindex Wno-protocol
3352 @opindex Wprotocol
3353 If a class is declared to implement a protocol, a warning is issued for
3354 every method in the protocol that is not implemented by the class.  The
3355 default behavior is to issue a warning for every method not explicitly
3356 implemented in the class, even if a method implementation is inherited
3357 from the superclass.  If you use the @option{-Wno-protocol} option, then
3358 methods inherited from the superclass are considered to be implemented,
3359 and no warning is issued for them.
3361 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3362 @opindex Wselector
3363 @opindex Wno-selector
3364 Warn if multiple methods of different types for the same selector are
3365 found during compilation.  The check is performed on the list of methods
3366 in the final stage of compilation.  Additionally, a check is performed
3367 for each selector appearing in a @code{@@selector(@dots{})}
3368 expression, and a corresponding method for that selector has been found
3369 during compilation.  Because these checks scan the method table only at
3370 the end of compilation, these warnings are not produced if the final
3371 stage of compilation is not reached, for example because an error is
3372 found during compilation, or because the @option{-fsyntax-only} option is
3373 being used.
3375 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3376 @opindex Wstrict-selector-match
3377 @opindex Wno-strict-selector-match
3378 Warn if multiple methods with differing argument and/or return types are
3379 found for a given selector when attempting to send a message using this
3380 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3381 is off (which is the default behavior), the compiler omits such warnings
3382 if any differences found are confined to types that share the same size
3383 and alignment.
3385 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3386 @opindex Wundeclared-selector
3387 @opindex Wno-undeclared-selector
3388 Warn if a @code{@@selector(@dots{})} expression referring to an
3389 undeclared selector is found.  A selector is considered undeclared if no
3390 method with that name has been declared before the
3391 @code{@@selector(@dots{})} expression, either explicitly in an
3392 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3393 an @code{@@implementation} section.  This option always performs its
3394 checks as soon as a @code{@@selector(@dots{})} expression is found,
3395 while @option{-Wselector} only performs its checks in the final stage of
3396 compilation.  This also enforces the coding style convention
3397 that methods and selectors must be declared before being used.
3399 @item -print-objc-runtime-info
3400 @opindex print-objc-runtime-info
3401 Generate C header describing the largest structure that is passed by
3402 value, if any.
3404 @end table
3406 @node Diagnostic Message Formatting Options
3407 @section Options to Control Diagnostic Messages Formatting
3408 @cindex options to control diagnostics formatting
3409 @cindex diagnostic messages
3410 @cindex message formatting
3412 Traditionally, diagnostic messages have been formatted irrespective of
3413 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3414 options described below
3415 to control the formatting algorithm for diagnostic messages, 
3416 e.g.@: how many characters per line, how often source location
3417 information should be reported.  Note that some language front ends may not
3418 honor these options.
3420 @table @gcctabopt
3421 @item -fmessage-length=@var{n}
3422 @opindex fmessage-length
3423 Try to format error messages so that they fit on lines of about
3424 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3425 done; each error message appears on a single line.  This is the
3426 default for all front ends.
3428 @item -fdiagnostics-show-location=once
3429 @opindex fdiagnostics-show-location
3430 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3431 reporter to emit source location information @emph{once}; that is, in
3432 case the message is too long to fit on a single physical line and has to
3433 be wrapped, the source location won't be emitted (as prefix) again,
3434 over and over, in subsequent continuation lines.  This is the default
3435 behavior.
3437 @item -fdiagnostics-show-location=every-line
3438 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3439 messages reporter to emit the same source location information (as
3440 prefix) for physical lines that result from the process of breaking
3441 a message which is too long to fit on a single line.
3443 @item -fdiagnostics-color[=@var{WHEN}]
3444 @itemx -fno-diagnostics-color
3445 @opindex fdiagnostics-color
3446 @cindex highlight, color
3447 @vindex GCC_COLORS @r{environment variable}
3448 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3449 or @samp{auto}.  The default depends on how the compiler has been configured,
3450 it can be any of the above @var{WHEN} options or also @samp{never}
3451 if @env{GCC_COLORS} environment variable isn't present in the environment,
3452 and @samp{auto} otherwise.
3453 @samp{auto} means to use color only when the standard error is a terminal.
3454 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3455 aliases for @option{-fdiagnostics-color=always} and
3456 @option{-fdiagnostics-color=never}, respectively.
3458 The colors are defined by the environment variable @env{GCC_COLORS}.
3459 Its value is a colon-separated list of capabilities and Select Graphic
3460 Rendition (SGR) substrings. SGR commands are interpreted by the
3461 terminal or terminal emulator.  (See the section in the documentation
3462 of your text terminal for permitted values and their meanings as
3463 character attributes.)  These substring values are integers in decimal
3464 representation and can be concatenated with semicolons.
3465 Common values to concatenate include
3466 @samp{1} for bold,
3467 @samp{4} for underline,
3468 @samp{5} for blink,
3469 @samp{7} for inverse,
3470 @samp{39} for default foreground color,
3471 @samp{30} to @samp{37} for foreground colors,
3472 @samp{90} to @samp{97} for 16-color mode foreground colors,
3473 @samp{38;5;0} to @samp{38;5;255}
3474 for 88-color and 256-color modes foreground colors,
3475 @samp{49} for default background color,
3476 @samp{40} to @samp{47} for background colors,
3477 @samp{100} to @samp{107} for 16-color mode background colors,
3478 and @samp{48;5;0} to @samp{48;5;255}
3479 for 88-color and 256-color modes background colors.
3481 The default @env{GCC_COLORS} is
3482 @smallexample
3483 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3484 quote=01:fixit-insert=32:fixit-delete=31:\
3485 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3486 type-diff=01;32
3487 @end smallexample
3488 @noindent
3489 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3490 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3491 @samp{01} is bold, and @samp{31} is red.
3492 Setting @env{GCC_COLORS} to the empty string disables colors.
3493 Supported capabilities are as follows.
3495 @table @code
3496 @item error=
3497 @vindex error GCC_COLORS @r{capability}
3498 SGR substring for error: markers.
3500 @item warning=
3501 @vindex warning GCC_COLORS @r{capability}
3502 SGR substring for warning: markers.
3504 @item note=
3505 @vindex note GCC_COLORS @r{capability}
3506 SGR substring for note: markers.
3508 @item range1=
3509 @vindex range1 GCC_COLORS @r{capability}
3510 SGR substring for first additional range.
3512 @item range2=
3513 @vindex range2 GCC_COLORS @r{capability}
3514 SGR substring for second additional range.
3516 @item locus=
3517 @vindex locus GCC_COLORS @r{capability}
3518 SGR substring for location information, @samp{file:line} or
3519 @samp{file:line:column} etc.
3521 @item quote=
3522 @vindex quote GCC_COLORS @r{capability}
3523 SGR substring for information printed within quotes.
3525 @item fixit-insert=
3526 @vindex fixit-insert GCC_COLORS @r{capability}
3527 SGR substring for fix-it hints suggesting text to
3528 be inserted or replaced.
3530 @item fixit-delete=
3531 @vindex fixit-delete GCC_COLORS @r{capability}
3532 SGR substring for fix-it hints suggesting text to
3533 be deleted.
3535 @item diff-filename=
3536 @vindex diff-filename GCC_COLORS @r{capability}
3537 SGR substring for filename headers within generated patches.
3539 @item diff-hunk=
3540 @vindex diff-hunk GCC_COLORS @r{capability}
3541 SGR substring for the starts of hunks within generated patches.
3543 @item diff-delete=
3544 @vindex diff-delete GCC_COLORS @r{capability}
3545 SGR substring for deleted lines within generated patches.
3547 @item diff-insert=
3548 @vindex diff-insert GCC_COLORS @r{capability}
3549 SGR substring for inserted lines within generated patches.
3551 @item type-diff=
3552 @vindex type-diff GCC_COLORS @r{capability}
3553 SGR substring for highlighting mismatching types within template
3554 arguments in the C++ frontend.
3555 @end table
3557 @item -fno-diagnostics-show-option
3558 @opindex fno-diagnostics-show-option
3559 @opindex fdiagnostics-show-option
3560 By default, each diagnostic emitted includes text indicating the
3561 command-line option that directly controls the diagnostic (if such an
3562 option is known to the diagnostic machinery).  Specifying the
3563 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3565 @item -fno-diagnostics-show-caret
3566 @opindex fno-diagnostics-show-caret
3567 @opindex fdiagnostics-show-caret
3568 By default, each diagnostic emitted includes the original source line
3569 and a caret @samp{^} indicating the column.  This option suppresses this
3570 information.  The source line is truncated to @var{n} characters, if
3571 the @option{-fmessage-length=n} option is given.  When the output is done
3572 to the terminal, the width is limited to the width given by the
3573 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3575 @item -fdiagnostics-parseable-fixits
3576 @opindex fdiagnostics-parseable-fixits
3577 Emit fix-it hints in a machine-parseable format, suitable for consumption
3578 by IDEs.  For each fix-it, a line will be printed after the relevant
3579 diagnostic, starting with the string ``fix-it:''.  For example:
3581 @smallexample
3582 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3583 @end smallexample
3585 The location is expressed as a half-open range, expressed as a count of
3586 bytes, starting at byte 1 for the initial column.  In the above example,
3587 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3588 given string:
3590 @smallexample
3591 00000000011111111112222222222
3592 12345678901234567890123456789
3593   gtk_widget_showall (dlg);
3594   ^^^^^^^^^^^^^^^^^^
3595   gtk_widget_show_all
3596 @end smallexample
3598 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3599 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3600 (e.g. vertical tab as ``\013'').
3602 An empty replacement string indicates that the given range is to be removed.
3603 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3604 be inserted at the given position.
3606 @item -fdiagnostics-generate-patch
3607 @opindex fdiagnostics-generate-patch
3608 Print fix-it hints to stderr in unified diff format, after any diagnostics
3609 are printed.  For example:
3611 @smallexample
3612 --- test.c
3613 +++ test.c
3614 @@ -42,5 +42,5 @@
3616  void show_cb(GtkDialog *dlg)
3617  @{
3618 -  gtk_widget_showall(dlg);
3619 +  gtk_widget_show_all(dlg);
3620  @}
3622 @end smallexample
3624 The diff may or may not be colorized, following the same rules
3625 as for diagnostics (see @option{-fdiagnostics-color}).
3627 @item -fdiagnostics-show-template-tree
3628 @opindex fdiagnostics-show-template-tree
3630 In the C++ frontend, when printing diagnostics showing mismatching
3631 template types, such as:
3633 @smallexample
3634   could not convert 'std::map<int, std::vector<double> >()'
3635     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3636 @end smallexample
3638 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3639 tree-like structure showing the common and differing parts of the types,
3640 such as:
3642 @smallexample
3643   map<
3644     [...],
3645     vector<
3646       [double != float]>>
3647 @end smallexample
3649 The parts that differ are highlighted with color (``double'' and
3650 ``float'' in this case).
3652 @item -fno-elide-type
3653 @opindex fno-elide-type
3654 @opindex felide-type
3655 By default when the C++ frontend prints diagnostics showing mismatching
3656 template types, common parts of the types are printed as ``[...]'' to
3657 simplify the error message.  For example:
3659 @smallexample
3660   could not convert 'std::map<int, std::vector<double> >()'
3661     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3662 @end smallexample
3664 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3665 This flag also affects the output of the
3666 @option{-fdiagnostics-show-template-tree} flag.
3668 @item -fno-show-column
3669 @opindex fno-show-column
3670 Do not print column numbers in diagnostics.  This may be necessary if
3671 diagnostics are being scanned by a program that does not understand the
3672 column numbers, such as @command{dejagnu}.
3674 @end table
3676 @node Warning Options
3677 @section Options to Request or Suppress Warnings
3678 @cindex options to control warnings
3679 @cindex warning messages
3680 @cindex messages, warning
3681 @cindex suppressing warnings
3683 Warnings are diagnostic messages that report constructions that
3684 are not inherently erroneous but that are risky or suggest there
3685 may have been an error.
3687 The following language-independent options do not enable specific
3688 warnings but control the kinds of diagnostics produced by GCC@.
3690 @table @gcctabopt
3691 @cindex syntax checking
3692 @item -fsyntax-only
3693 @opindex fsyntax-only
3694 Check the code for syntax errors, but don't do anything beyond that.
3696 @item -fmax-errors=@var{n}
3697 @opindex fmax-errors
3698 Limits the maximum number of error messages to @var{n}, at which point
3699 GCC bails out rather than attempting to continue processing the source
3700 code.  If @var{n} is 0 (the default), there is no limit on the number
3701 of error messages produced.  If @option{-Wfatal-errors} is also
3702 specified, then @option{-Wfatal-errors} takes precedence over this
3703 option.
3705 @item -w
3706 @opindex w
3707 Inhibit all warning messages.
3709 @item -Werror
3710 @opindex Werror
3711 @opindex Wno-error
3712 Make all warnings into errors.
3714 @item -Werror=
3715 @opindex Werror=
3716 @opindex Wno-error=
3717 Make the specified warning into an error.  The specifier for a warning
3718 is appended; for example @option{-Werror=switch} turns the warnings
3719 controlled by @option{-Wswitch} into errors.  This switch takes a
3720 negative form, to be used to negate @option{-Werror} for specific
3721 warnings; for example @option{-Wno-error=switch} makes
3722 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3723 is in effect.
3725 The warning message for each controllable warning includes the
3726 option that controls the warning.  That option can then be used with
3727 @option{-Werror=} and @option{-Wno-error=} as described above.
3728 (Printing of the option in the warning message can be disabled using the
3729 @option{-fno-diagnostics-show-option} flag.)
3731 Note that specifying @option{-Werror=}@var{foo} automatically implies
3732 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3733 imply anything.
3735 @item -Wfatal-errors
3736 @opindex Wfatal-errors
3737 @opindex Wno-fatal-errors
3738 This option causes the compiler to abort compilation on the first error
3739 occurred rather than trying to keep going and printing further error
3740 messages.
3742 @end table
3744 You can request many specific warnings with options beginning with
3745 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3746 implicit declarations.  Each of these specific warning options also
3747 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3748 example, @option{-Wno-implicit}.  This manual lists only one of the
3749 two forms, whichever is not the default.  For further
3750 language-specific options also refer to @ref{C++ Dialect Options} and
3751 @ref{Objective-C and Objective-C++ Dialect Options}.
3753 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3754 options, such as @option{-Wunused}, which may turn on further options,
3755 such as @option{-Wunused-value}. The combined effect of positive and
3756 negative forms is that more specific options have priority over less
3757 specific ones, independently of their position in the command-line. For
3758 options of the same specificity, the last one takes effect. Options
3759 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3760 as if they appeared at the end of the command-line.
3762 When an unrecognized warning option is requested (e.g.,
3763 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3764 that the option is not recognized.  However, if the @option{-Wno-} form
3765 is used, the behavior is slightly different: no diagnostic is
3766 produced for @option{-Wno-unknown-warning} unless other diagnostics
3767 are being produced.  This allows the use of new @option{-Wno-} options
3768 with old compilers, but if something goes wrong, the compiler
3769 warns that an unrecognized option is present.
3771 @table @gcctabopt
3772 @item -Wpedantic
3773 @itemx -pedantic
3774 @opindex pedantic
3775 @opindex Wpedantic
3776 Issue all the warnings demanded by strict ISO C and ISO C++;
3777 reject all programs that use forbidden extensions, and some other
3778 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3779 version of the ISO C standard specified by any @option{-std} option used.
3781 Valid ISO C and ISO C++ programs should compile properly with or without
3782 this option (though a rare few require @option{-ansi} or a
3783 @option{-std} option specifying the required version of ISO C)@.  However,
3784 without this option, certain GNU extensions and traditional C and C++
3785 features are supported as well.  With this option, they are rejected.
3787 @option{-Wpedantic} does not cause warning messages for use of the
3788 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3789 warnings are also disabled in the expression that follows
3790 @code{__extension__}.  However, only system header files should use
3791 these escape routes; application programs should avoid them.
3792 @xref{Alternate Keywords}.
3794 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3795 C conformance.  They soon find that it does not do quite what they want:
3796 it finds some non-ISO practices, but not all---only those for which
3797 ISO C @emph{requires} a diagnostic, and some others for which
3798 diagnostics have been added.
3800 A feature to report any failure to conform to ISO C might be useful in
3801 some instances, but would require considerable additional work and would
3802 be quite different from @option{-Wpedantic}.  We don't have plans to
3803 support such a feature in the near future.
3805 Where the standard specified with @option{-std} represents a GNU
3806 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3807 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3808 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3809 where they are required by the base standard.  (It does not make sense
3810 for such warnings to be given only for features not in the specified GNU
3811 C dialect, since by definition the GNU dialects of C include all
3812 features the compiler supports with the given option, and there would be
3813 nothing to warn about.)
3815 @item -pedantic-errors
3816 @opindex pedantic-errors
3817 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3818 requires a diagnostic, in some cases where there is undefined behavior
3819 at compile-time and in some other cases that do not prevent compilation
3820 of programs that are valid according to the standard. This is not
3821 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3822 by this option and not enabled by the latter and vice versa.
3824 @item -Wall
3825 @opindex Wall
3826 @opindex Wno-all
3827 This enables all the warnings about constructions that some users
3828 consider questionable, and that are easy to avoid (or modify to
3829 prevent the warning), even in conjunction with macros.  This also
3830 enables some language-specific warnings described in @ref{C++ Dialect
3831 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3833 @option{-Wall} turns on the following warning flags:
3835 @gccoptlist{-Waddress   @gol
3836 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3837 -Wbool-compare  @gol
3838 -Wbool-operation  @gol
3839 -Wc++11-compat  -Wc++14-compat  @gol
3840 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3841 -Wchar-subscripts  @gol
3842 -Wcomment  @gol
3843 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3844 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3845 -Wformat   @gol
3846 -Wint-in-bool-context  @gol
3847 -Wimplicit @r{(C and Objective-C only)} @gol
3848 -Wimplicit-int @r{(C and Objective-C only)} @gol
3849 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3850 -Winit-self @r{(only for C++)} @gol
3851 -Wlogical-not-parentheses @gol
3852 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3853 -Wmaybe-uninitialized @gol
3854 -Wmemset-elt-size @gol
3855 -Wmemset-transposed-args @gol
3856 -Wmisleading-indentation @r{(only for C/C++)} @gol
3857 -Wmissing-braces @r{(only for C/ObjC)} @gol
3858 -Wmultistatement-macros  @gol
3859 -Wnarrowing @r{(only for C++)}  @gol
3860 -Wnonnull  @gol
3861 -Wnonnull-compare  @gol
3862 -Wopenmp-simd @gol
3863 -Wparentheses  @gol
3864 -Wpointer-sign  @gol
3865 -Wreorder   @gol
3866 -Wreturn-type  @gol
3867 -Wsequence-point  @gol
3868 -Wsign-compare @r{(only in C++)}  @gol
3869 -Wsizeof-pointer-div @gol
3870 -Wsizeof-pointer-memaccess @gol
3871 -Wstrict-aliasing  @gol
3872 -Wstrict-overflow=1  @gol
3873 -Wswitch  @gol
3874 -Wtautological-compare  @gol
3875 -Wtrigraphs  @gol
3876 -Wuninitialized  @gol
3877 -Wunknown-pragmas  @gol
3878 -Wunused-function  @gol
3879 -Wunused-label     @gol
3880 -Wunused-value     @gol
3881 -Wunused-variable  @gol
3882 -Wvolatile-register-var @gol
3885 Note that some warning flags are not implied by @option{-Wall}.  Some of
3886 them warn about constructions that users generally do not consider
3887 questionable, but which occasionally you might wish to check for;
3888 others warn about constructions that are necessary or hard to avoid in
3889 some cases, and there is no simple way to modify the code to suppress
3890 the warning. Some of them are enabled by @option{-Wextra} but many of
3891 them must be enabled individually.
3893 @item -Wextra
3894 @opindex W
3895 @opindex Wextra
3896 @opindex Wno-extra
3897 This enables some extra warning flags that are not enabled by
3898 @option{-Wall}. (This option used to be called @option{-W}.  The older
3899 name is still supported, but the newer name is more descriptive.)
3901 @gccoptlist{-Wclobbered  @gol
3902 -Wempty-body  @gol
3903 -Wignored-qualifiers @gol
3904 -Wimplicit-fallthrough=3 @gol
3905 -Wmissing-field-initializers  @gol
3906 -Wmissing-parameter-type @r{(C only)}  @gol
3907 -Wold-style-declaration @r{(C only)}  @gol
3908 -Woverride-init  @gol
3909 -Wsign-compare @r{(C only)} @gol
3910 -Wtype-limits  @gol
3911 -Wuninitialized  @gol
3912 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3913 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3914 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3917 The option @option{-Wextra} also prints warning messages for the
3918 following cases:
3920 @itemize @bullet
3922 @item
3923 A pointer is compared against integer zero with @code{<}, @code{<=},
3924 @code{>}, or @code{>=}.
3926 @item
3927 (C++ only) An enumerator and a non-enumerator both appear in a
3928 conditional expression.
3930 @item
3931 (C++ only) Ambiguous virtual bases.
3933 @item
3934 (C++ only) Subscripting an array that has been declared @code{register}.
3936 @item
3937 (C++ only) Taking the address of a variable that has been declared
3938 @code{register}.
3940 @item
3941 (C++ only) A base class is not initialized in the copy constructor
3942 of a derived class.
3944 @end itemize
3946 @item -Wchar-subscripts
3947 @opindex Wchar-subscripts
3948 @opindex Wno-char-subscripts
3949 Warn if an array subscript has type @code{char}.  This is a common cause
3950 of error, as programmers often forget that this type is signed on some
3951 machines.
3952 This warning is enabled by @option{-Wall}.
3954 @item -Wchkp
3955 @opindex Wchkp
3956 Warn about an invalid memory access that is found by Pointer Bounds Checker
3957 (@option{-fcheck-pointer-bounds}).
3959 @item -Wno-coverage-mismatch
3960 @opindex Wno-coverage-mismatch
3961 Warn if feedback profiles do not match when using the
3962 @option{-fprofile-use} option.
3963 If a source file is changed between compiling with @option{-fprofile-gen} and
3964 with @option{-fprofile-use}, the files with the profile feedback can fail
3965 to match the source file and GCC cannot use the profile feedback
3966 information.  By default, this warning is enabled and is treated as an
3967 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3968 warning or @option{-Wno-error=coverage-mismatch} can be used to
3969 disable the error.  Disabling the error for this warning can result in
3970 poorly optimized code and is useful only in the
3971 case of very minor changes such as bug fixes to an existing code-base.
3972 Completely disabling the warning is not recommended.
3974 @item -Wno-cpp
3975 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3977 Suppress warning messages emitted by @code{#warning} directives.
3979 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3980 @opindex Wdouble-promotion
3981 @opindex Wno-double-promotion
3982 Give a warning when a value of type @code{float} is implicitly
3983 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3984 floating-point unit implement @code{float} in hardware, but emulate
3985 @code{double} in software.  On such a machine, doing computations
3986 using @code{double} values is much more expensive because of the
3987 overhead required for software emulation.
3989 It is easy to accidentally do computations with @code{double} because
3990 floating-point literals are implicitly of type @code{double}.  For
3991 example, in:
3992 @smallexample
3993 @group
3994 float area(float radius)
3996    return 3.14159 * radius * radius;
3998 @end group
3999 @end smallexample
4000 the compiler performs the entire computation with @code{double}
4001 because the floating-point literal is a @code{double}.
4003 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4004 @opindex Wduplicate-decl-specifier
4005 @opindex Wno-duplicate-decl-specifier
4006 Warn if a declaration has duplicate @code{const}, @code{volatile},
4007 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4008 @option{-Wall}.
4010 @item -Wformat
4011 @itemx -Wformat=@var{n}
4012 @opindex Wformat
4013 @opindex Wno-format
4014 @opindex ffreestanding
4015 @opindex fno-builtin
4016 @opindex Wformat=
4017 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4018 the arguments supplied have types appropriate to the format string
4019 specified, and that the conversions specified in the format string make
4020 sense.  This includes standard functions, and others specified by format
4021 attributes (@pxref{Function Attributes}), in the @code{printf},
4022 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4023 not in the C standard) families (or other target-specific families).
4024 Which functions are checked without format attributes having been
4025 specified depends on the standard version selected, and such checks of
4026 functions without the attribute specified are disabled by
4027 @option{-ffreestanding} or @option{-fno-builtin}.
4029 The formats are checked against the format features supported by GNU
4030 libc version 2.2.  These include all ISO C90 and C99 features, as well
4031 as features from the Single Unix Specification and some BSD and GNU
4032 extensions.  Other library implementations may not support all these
4033 features; GCC does not support warning about features that go beyond a
4034 particular library's limitations.  However, if @option{-Wpedantic} is used
4035 with @option{-Wformat}, warnings are given about format features not
4036 in the selected standard version (but not for @code{strfmon} formats,
4037 since those are not in any version of the C standard).  @xref{C Dialect
4038 Options,,Options Controlling C Dialect}.
4040 @table @gcctabopt
4041 @item -Wformat=1
4042 @itemx -Wformat
4043 @opindex Wformat
4044 @opindex Wformat=1
4045 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4046 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4047 @option{-Wformat} also checks for null format arguments for several
4048 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4049 aspects of this level of format checking can be disabled by the
4050 options: @option{-Wno-format-contains-nul},
4051 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4052 @option{-Wformat} is enabled by @option{-Wall}.
4054 @item -Wno-format-contains-nul
4055 @opindex Wno-format-contains-nul
4056 @opindex Wformat-contains-nul
4057 If @option{-Wformat} is specified, do not warn about format strings that
4058 contain NUL bytes.
4060 @item -Wno-format-extra-args
4061 @opindex Wno-format-extra-args
4062 @opindex Wformat-extra-args
4063 If @option{-Wformat} is specified, do not warn about excess arguments to a
4064 @code{printf} or @code{scanf} format function.  The C standard specifies
4065 that such arguments are ignored.
4067 Where the unused arguments lie between used arguments that are
4068 specified with @samp{$} operand number specifications, normally
4069 warnings are still given, since the implementation could not know what
4070 type to pass to @code{va_arg} to skip the unused arguments.  However,
4071 in the case of @code{scanf} formats, this option suppresses the
4072 warning if the unused arguments are all pointers, since the Single
4073 Unix Specification says that such unused arguments are allowed.
4075 @item -Wformat-overflow
4076 @itemx -Wformat-overflow=@var{level}
4077 @opindex Wformat-overflow
4078 @opindex Wno-format-overflow
4079 Warn about calls to formatted input/output functions such as @code{sprintf}
4080 and @code{vsprintf} that might overflow the destination buffer.  When the
4081 exact number of bytes written by a format directive cannot be determined
4082 at compile-time it is estimated based on heuristics that depend on the
4083 @var{level} argument and on optimization.  While enabling optimization
4084 will in most cases improve the accuracy of the warning, it may also
4085 result in false positives.
4087 @table @gcctabopt
4088 @item -Wformat-overflow
4089 @item -Wformat-overflow=1
4090 @opindex Wformat-overflow
4091 @opindex Wno-format-overflow
4092 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4093 employs a conservative approach that warns only about calls that most
4094 likely overflow the buffer.  At this level, numeric arguments to format
4095 directives with unknown values are assumed to have the value of one, and
4096 strings of unknown length to be empty.  Numeric arguments that are known
4097 to be bounded to a subrange of their type, or string arguments whose output
4098 is bounded either by their directive's precision or by a finite set of
4099 string literals, are assumed to take on the value within the range that
4100 results in the most bytes on output.  For example, the call to @code{sprintf}
4101 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4102 the terminating NUL character (@code{'\0'}) appended by the function
4103 to the destination buffer will be written past its end.  Increasing
4104 the size of the buffer by a single byte is sufficient to avoid the
4105 warning, though it may not be sufficient to avoid the overflow.
4107 @smallexample
4108 void f (int a, int b)
4110   char buf [12];
4111   sprintf (buf, "a = %i, b = %i\n", a, b);
4113 @end smallexample
4115 @item -Wformat-overflow=2
4116 Level @var{2} warns also about calls that might overflow the destination
4117 buffer given an argument of sufficient length or magnitude.  At level
4118 @var{2}, unknown numeric arguments are assumed to have the minimum
4119 representable value for signed types with a precision greater than 1, and
4120 the maximum representable value otherwise.  Unknown string arguments whose
4121 length cannot be assumed to be bounded either by the directive's precision,
4122 or by a finite set of string literals they may evaluate to, or the character
4123 array they may point to, are assumed to be 1 character long.
4125 At level @var{2}, the call in the example above is again diagnosed, but
4126 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4127 @code{%i} directive will write some of its digits beyond the end of
4128 the destination buffer.  To make the call safe regardless of the values
4129 of the two variables, the size of the destination buffer must be increased
4130 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4131 an informational note following the warning.
4133 An alternative to increasing the size of the destination buffer is to
4134 constrain the range of formatted values.  The maximum length of string
4135 arguments can be bounded by specifying the precision in the format
4136 directive.  When numeric arguments of format directives can be assumed
4137 to be bounded by less than the precision of their type, choosing
4138 an appropriate length modifier to the format specifier will reduce
4139 the required buffer size.  For example, if @var{a} and @var{b} in the
4140 example above can be assumed to be within the precision of
4141 the @code{short int} type then using either the @code{%hi} format
4142 directive or casting the argument to @code{short} reduces the maximum
4143 required size of the buffer to 24 bytes.
4145 @smallexample
4146 void f (int a, int b)
4148   char buf [23];
4149   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4151 @end smallexample
4152 @end table
4154 @item -Wno-format-zero-length
4155 @opindex Wno-format-zero-length
4156 @opindex Wformat-zero-length
4157 If @option{-Wformat} is specified, do not warn about zero-length formats.
4158 The C standard specifies that zero-length formats are allowed.
4161 @item -Wformat=2
4162 @opindex Wformat=2
4163 Enable @option{-Wformat} plus additional format checks.  Currently
4164 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4165 -Wformat-y2k}.
4167 @item -Wformat-nonliteral
4168 @opindex Wformat-nonliteral
4169 @opindex Wno-format-nonliteral
4170 If @option{-Wformat} is specified, also warn if the format string is not a
4171 string literal and so cannot be checked, unless the format function
4172 takes its format arguments as a @code{va_list}.
4174 @item -Wformat-security
4175 @opindex Wformat-security
4176 @opindex Wno-format-security
4177 If @option{-Wformat} is specified, also warn about uses of format
4178 functions that represent possible security problems.  At present, this
4179 warns about calls to @code{printf} and @code{scanf} functions where the
4180 format string is not a string literal and there are no format arguments,
4181 as in @code{printf (foo);}.  This may be a security hole if the format
4182 string came from untrusted input and contains @samp{%n}.  (This is
4183 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4184 in future warnings may be added to @option{-Wformat-security} that are not
4185 included in @option{-Wformat-nonliteral}.)
4187 @item -Wformat-signedness
4188 @opindex Wformat-signedness
4189 @opindex Wno-format-signedness
4190 If @option{-Wformat} is specified, also warn if the format string
4191 requires an unsigned argument and the argument is signed and vice versa.
4193 @item -Wformat-truncation
4194 @itemx -Wformat-truncation=@var{level}
4195 @opindex Wformat-truncation
4196 @opindex Wno-format-truncation
4197 Warn about calls to formatted input/output functions such as @code{snprintf}
4198 and @code{vsnprintf} that might result in output truncation.  When the exact
4199 number of bytes written by a format directive cannot be determined at
4200 compile-time it is estimated based on heuristics that depend on
4201 the @var{level} argument and on optimization.  While enabling optimization
4202 will in most cases improve the accuracy of the warning, it may also result
4203 in false positives.  Except as noted otherwise, the option uses the same
4204 logic @option{-Wformat-overflow}.
4206 @table @gcctabopt
4207 @item -Wformat-truncation
4208 @item -Wformat-truncation=1
4209 @opindex Wformat-truncation
4210 @opindex Wno-format-overflow
4211 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4212 employs a conservative approach that warns only about calls to bounded
4213 functions whose return value is unused and that will most likely result
4214 in output truncation.
4216 @item -Wformat-truncation=2
4217 Level @var{2} warns also about calls to bounded functions whose return
4218 value is used and that might result in truncation given an argument of
4219 sufficient length or magnitude.
4220 @end table
4222 @item -Wformat-y2k
4223 @opindex Wformat-y2k
4224 @opindex Wno-format-y2k
4225 If @option{-Wformat} is specified, also warn about @code{strftime}
4226 formats that may yield only a two-digit year.
4227 @end table
4229 @item -Wnonnull
4230 @opindex Wnonnull
4231 @opindex Wno-nonnull
4232 Warn about passing a null pointer for arguments marked as
4233 requiring a non-null value by the @code{nonnull} function attribute.
4235 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4236 can be disabled with the @option{-Wno-nonnull} option.
4238 @item -Wnonnull-compare
4239 @opindex Wnonnull-compare
4240 @opindex Wno-nonnull-compare
4241 Warn when comparing an argument marked with the @code{nonnull}
4242 function attribute against null inside the function.
4244 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4245 can be disabled with the @option{-Wno-nonnull-compare} option.
4247 @item -Wnull-dereference
4248 @opindex Wnull-dereference
4249 @opindex Wno-null-dereference
4250 Warn if the compiler detects paths that trigger erroneous or
4251 undefined behavior due to dereferencing a null pointer.  This option
4252 is only active when @option{-fdelete-null-pointer-checks} is active,
4253 which is enabled by optimizations in most targets.  The precision of
4254 the warnings depends on the optimization options used.
4256 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4257 @opindex Winit-self
4258 @opindex Wno-init-self
4259 Warn about uninitialized variables that are initialized with themselves.
4260 Note this option can only be used with the @option{-Wuninitialized} option.
4262 For example, GCC warns about @code{i} being uninitialized in the
4263 following snippet only when @option{-Winit-self} has been specified:
4264 @smallexample
4265 @group
4266 int f()
4268   int i = i;
4269   return i;
4271 @end group
4272 @end smallexample
4274 This warning is enabled by @option{-Wall} in C++.
4276 @item -Wimplicit-int @r{(C and Objective-C only)}
4277 @opindex Wimplicit-int
4278 @opindex Wno-implicit-int
4279 Warn when a declaration does not specify a type.
4280 This warning is enabled by @option{-Wall}.
4282 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4283 @opindex Wimplicit-function-declaration
4284 @opindex Wno-implicit-function-declaration
4285 Give a warning whenever a function is used before being declared. In
4286 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4287 enabled by default and it is made into an error by
4288 @option{-pedantic-errors}. This warning is also enabled by
4289 @option{-Wall}.
4291 @item -Wimplicit @r{(C and Objective-C only)}
4292 @opindex Wimplicit
4293 @opindex Wno-implicit
4294 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4295 This warning is enabled by @option{-Wall}.
4297 @item -Wimplicit-fallthrough
4298 @opindex Wimplicit-fallthrough
4299 @opindex Wno-implicit-fallthrough
4300 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4301 and @option{-Wno-implicit-fallthrough} is the same as
4302 @option{-Wimplicit-fallthrough=0}.
4304 @item -Wimplicit-fallthrough=@var{n}
4305 @opindex Wimplicit-fallthrough=
4306 Warn when a switch case falls through.  For example:
4308 @smallexample
4309 @group
4310 switch (cond)
4311   @{
4312   case 1:
4313     a = 1;
4314     break;
4315   case 2:
4316     a = 2;
4317   case 3:
4318     a = 3;
4319     break;
4320   @}
4321 @end group
4322 @end smallexample
4324 This warning does not warn when the last statement of a case cannot
4325 fall through, e.g. when there is a return statement or a call to function
4326 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4327 also takes into account control flow statements, such as ifs, and only
4328 warns when appropriate.  E.g.@:
4330 @smallexample
4331 @group
4332 switch (cond)
4333   @{
4334   case 1:
4335     if (i > 3) @{
4336       bar (5);
4337       break;
4338     @} else if (i < 1) @{
4339       bar (0);
4340     @} else
4341       return;
4342   default:
4343     @dots{}
4344   @}
4345 @end group
4346 @end smallexample
4348 Since there are occasions where a switch case fall through is desirable,
4349 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4350 to be used along with a null statement to suppress this warning that
4351 would normally occur:
4353 @smallexample
4354 @group
4355 switch (cond)
4356   @{
4357   case 1:
4358     bar (0);
4359     __attribute__ ((fallthrough));
4360   default:
4361     @dots{}
4362   @}
4363 @end group
4364 @end smallexample
4366 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4367 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4368 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4369 Instead of these attributes, it is also possible to add a fallthrough comment
4370 to silence the warning.  The whole body of the C or C++ style comment should
4371 match the given regular expressions listed below.  The option argument @var{n}
4372 specifies what kind of comments are accepted:
4374 @itemize @bullet
4376 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4378 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4379 expression, any comment is used as fallthrough comment.
4381 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4382 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4384 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4385 following regular expressions:
4387 @itemize @bullet
4389 @item @code{-fallthrough}
4391 @item @code{@@fallthrough@@}
4393 @item @code{lint -fallthrough[ \t]*}
4395 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4397 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4399 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4401 @end itemize
4403 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4404 following regular expressions:
4406 @itemize @bullet
4408 @item @code{-fallthrough}
4410 @item @code{@@fallthrough@@}
4412 @item @code{lint -fallthrough[ \t]*}
4414 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4416 @end itemize
4418 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4419 fallthrough comments, only attributes disable the warning.
4421 @end itemize
4423 The comment needs to be followed after optional whitespace and other comments
4424 by @code{case} or @code{default} keywords or by a user label that precedes some
4425 @code{case} or @code{default} label.
4427 @smallexample
4428 @group
4429 switch (cond)
4430   @{
4431   case 1:
4432     bar (0);
4433     /* FALLTHRU */
4434   default:
4435     @dots{}
4436   @}
4437 @end group
4438 @end smallexample
4440 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4442 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4443 @opindex Wif-not-aligned
4444 @opindex Wno-if-not-aligned
4445 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4446 should be issued.  This is is enabled by default.
4447 Use @option{-Wno-if-not-aligned} to disable it.
4449 @item -Wignored-qualifiers @r{(C and C++ only)}
4450 @opindex Wignored-qualifiers
4451 @opindex Wno-ignored-qualifiers
4452 Warn if the return type of a function has a type qualifier
4453 such as @code{const}.  For ISO C such a type qualifier has no effect,
4454 since the value returned by a function is not an lvalue.
4455 For C++, the warning is only emitted for scalar types or @code{void}.
4456 ISO C prohibits qualified @code{void} return types on function
4457 definitions, so such return types always receive a warning
4458 even without this option.
4460 This warning is also enabled by @option{-Wextra}.
4462 @item -Wignored-attributes @r{(C and C++ only)}
4463 @opindex Wignored-attributes
4464 @opindex Wno-ignored-attributes
4465 Warn when an attribute is ignored.  This is different from the
4466 @option{-Wattributes} option in that it warns whenever the compiler decides
4467 to drop an attribute, not that the attribute is either unknown, used in a
4468 wrong place, etc.  This warning is enabled by default.
4470 @item -Wmain
4471 @opindex Wmain
4472 @opindex Wno-main
4473 Warn if the type of @code{main} is suspicious.  @code{main} should be
4474 a function with external linkage, returning int, taking either zero
4475 arguments, two, or three arguments of appropriate types.  This warning
4476 is enabled by default in C++ and is enabled by either @option{-Wall}
4477 or @option{-Wpedantic}.
4479 @item -Wmisleading-indentation @r{(C and C++ only)}
4480 @opindex Wmisleading-indentation
4481 @opindex Wno-misleading-indentation
4482 Warn when the indentation of the code does not reflect the block structure.
4483 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4484 @code{for} clauses with a guarded statement that does not use braces,
4485 followed by an unguarded statement with the same indentation.
4487 In the following example, the call to ``bar'' is misleadingly indented as
4488 if it were guarded by the ``if'' conditional.
4490 @smallexample
4491   if (some_condition ())
4492     foo ();
4493     bar ();  /* Gotcha: this is not guarded by the "if".  */
4494 @end smallexample
4496 In the case of mixed tabs and spaces, the warning uses the
4497 @option{-ftabstop=} option to determine if the statements line up
4498 (defaulting to 8).
4500 The warning is not issued for code involving multiline preprocessor logic
4501 such as the following example.
4503 @smallexample
4504   if (flagA)
4505     foo (0);
4506 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4507   if (flagB)
4508 #endif
4509     foo (1);
4510 @end smallexample
4512 The warning is not issued after a @code{#line} directive, since this
4513 typically indicates autogenerated code, and no assumptions can be made
4514 about the layout of the file that the directive references.
4516 This warning is enabled by @option{-Wall} in C and C++.
4518 @item -Wmissing-braces
4519 @opindex Wmissing-braces
4520 @opindex Wno-missing-braces
4521 Warn if an aggregate or union initializer is not fully bracketed.  In
4522 the following example, the initializer for @code{a} is not fully
4523 bracketed, but that for @code{b} is fully bracketed.  This warning is
4524 enabled by @option{-Wall} in C.
4526 @smallexample
4527 int a[2][2] = @{ 0, 1, 2, 3 @};
4528 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4529 @end smallexample
4531 This warning is enabled by @option{-Wall}.
4533 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4534 @opindex Wmissing-include-dirs
4535 @opindex Wno-missing-include-dirs
4536 Warn if a user-supplied include directory does not exist.
4538 @item -Wmultistatement-macros
4539 @opindex Wmultistatement-macros
4540 @opindex Wno-multistatement-macros
4541 Warn about unsafe multiple statement macros that appear to be guarded
4542 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4543 @code{while}, in which only the first statement is actually guarded after
4544 the macro is expanded.
4546 For example:
4548 @smallexample
4549 #define DOIT x++; y++
4550 if (c)
4551   DOIT;
4552 @end smallexample
4554 will increment @code{y} unconditionally, not just when @code{c} holds.
4555 The can usually be fixed by wrapping the macro in a do-while loop:
4556 @smallexample
4557 #define DOIT do @{ x++; y++; @} while (0)
4558 if (c)
4559   DOIT;
4560 @end smallexample
4562 This warning is enabled by @option{-Wall} in C and C++.
4564 @item -Wparentheses
4565 @opindex Wparentheses
4566 @opindex Wno-parentheses
4567 Warn if parentheses are omitted in certain contexts, such
4568 as when there is an assignment in a context where a truth value
4569 is expected, or when operators are nested whose precedence people
4570 often get confused about.
4572 Also warn if a comparison like @code{x<=y<=z} appears; this is
4573 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4574 interpretation from that of ordinary mathematical notation.
4576 Also warn for dangerous uses of the GNU extension to
4577 @code{?:} with omitted middle operand. When the condition
4578 in the @code{?}: operator is a boolean expression, the omitted value is
4579 always 1.  Often programmers expect it to be a value computed
4580 inside the conditional expression instead.
4582 For C++ this also warns for some cases of unnecessary parentheses in
4583 declarations, which can indicate an attempt at a function call instead
4584 of a declaration:
4585 @smallexample
4587   // Declares a local variable called mymutex.
4588   std::unique_lock<std::mutex> (mymutex);
4589   // User meant std::unique_lock<std::mutex> lock (mymutex);
4591 @end smallexample
4593 This warning is enabled by @option{-Wall}.
4595 @item -Wsequence-point
4596 @opindex Wsequence-point
4597 @opindex Wno-sequence-point
4598 Warn about code that may have undefined semantics because of violations
4599 of sequence point rules in the C and C++ standards.
4601 The C and C++ standards define the order in which expressions in a C/C++
4602 program are evaluated in terms of @dfn{sequence points}, which represent
4603 a partial ordering between the execution of parts of the program: those
4604 executed before the sequence point, and those executed after it.  These
4605 occur after the evaluation of a full expression (one which is not part
4606 of a larger expression), after the evaluation of the first operand of a
4607 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4608 function is called (but after the evaluation of its arguments and the
4609 expression denoting the called function), and in certain other places.
4610 Other than as expressed by the sequence point rules, the order of
4611 evaluation of subexpressions of an expression is not specified.  All
4612 these rules describe only a partial order rather than a total order,
4613 since, for example, if two functions are called within one expression
4614 with no sequence point between them, the order in which the functions
4615 are called is not specified.  However, the standards committee have
4616 ruled that function calls do not overlap.
4618 It is not specified when between sequence points modifications to the
4619 values of objects take effect.  Programs whose behavior depends on this
4620 have undefined behavior; the C and C++ standards specify that ``Between
4621 the previous and next sequence point an object shall have its stored
4622 value modified at most once by the evaluation of an expression.
4623 Furthermore, the prior value shall be read only to determine the value
4624 to be stored.''.  If a program breaks these rules, the results on any
4625 particular implementation are entirely unpredictable.
4627 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4628 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4629 diagnosed by this option, and it may give an occasional false positive
4630 result, but in general it has been found fairly effective at detecting
4631 this sort of problem in programs.
4633 The C++17 standard will define the order of evaluation of operands in
4634 more cases: in particular it requires that the right-hand side of an
4635 assignment be evaluated before the left-hand side, so the above
4636 examples are no longer undefined.  But this warning will still warn
4637 about them, to help people avoid writing code that is undefined in C
4638 and earlier revisions of C++.
4640 The standard is worded confusingly, therefore there is some debate
4641 over the precise meaning of the sequence point rules in subtle cases.
4642 Links to discussions of the problem, including proposed formal
4643 definitions, may be found on the GCC readings page, at
4644 @uref{http://gcc.gnu.org/@/readings.html}.
4646 This warning is enabled by @option{-Wall} for C and C++.
4648 @item -Wno-return-local-addr
4649 @opindex Wno-return-local-addr
4650 @opindex Wreturn-local-addr
4651 Do not warn about returning a pointer (or in C++, a reference) to a
4652 variable that goes out of scope after the function returns.
4654 @item -Wreturn-type
4655 @opindex Wreturn-type
4656 @opindex Wno-return-type
4657 Warn whenever a function is defined with a return type that defaults
4658 to @code{int}.  Also warn about any @code{return} statement with no
4659 return value in a function whose return type is not @code{void}
4660 (falling off the end of the function body is considered returning
4661 without a value).
4663 For C only, warn about a @code{return} statement with an expression in a
4664 function whose return type is @code{void}, unless the expression type is
4665 also @code{void}.  As a GNU extension, the latter case is accepted
4666 without a warning unless @option{-Wpedantic} is used.
4668 For C++, a function without return type always produces a diagnostic
4669 message, even when @option{-Wno-return-type} is specified.  The only
4670 exceptions are @code{main} and functions defined in system headers.
4672 This warning is enabled by @option{-Wall}.
4674 @item -Wshift-count-negative
4675 @opindex Wshift-count-negative
4676 @opindex Wno-shift-count-negative
4677 Warn if shift count is negative. This warning is enabled by default.
4679 @item -Wshift-count-overflow
4680 @opindex Wshift-count-overflow
4681 @opindex Wno-shift-count-overflow
4682 Warn if shift count >= width of type. This warning is enabled by default.
4684 @item -Wshift-negative-value
4685 @opindex Wshift-negative-value
4686 @opindex Wno-shift-negative-value
4687 Warn if left shifting a negative value.  This warning is enabled by
4688 @option{-Wextra} in C99 and C++11 modes (and newer).
4690 @item -Wshift-overflow
4691 @itemx -Wshift-overflow=@var{n}
4692 @opindex Wshift-overflow
4693 @opindex Wno-shift-overflow
4694 Warn about left shift overflows.  This warning is enabled by
4695 default in C99 and C++11 modes (and newer).
4697 @table @gcctabopt
4698 @item -Wshift-overflow=1
4699 This is the warning level of @option{-Wshift-overflow} and is enabled
4700 by default in C99 and C++11 modes (and newer).  This warning level does
4701 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4702 an overflow is still rejected in contexts where an integer constant expression
4703 is required.)
4705 @item -Wshift-overflow=2
4706 This warning level also warns about left-shifting 1 into the sign bit,
4707 unless C++14 mode is active.
4708 @end table
4710 @item -Wswitch
4711 @opindex Wswitch
4712 @opindex Wno-switch
4713 Warn whenever a @code{switch} statement has an index of enumerated type
4714 and lacks a @code{case} for one or more of the named codes of that
4715 enumeration.  (The presence of a @code{default} label prevents this
4716 warning.)  @code{case} labels outside the enumeration range also
4717 provoke warnings when this option is used (even if there is a
4718 @code{default} label).
4719 This warning is enabled by @option{-Wall}.
4721 @item -Wswitch-default
4722 @opindex Wswitch-default
4723 @opindex Wno-switch-default
4724 Warn whenever a @code{switch} statement does not have a @code{default}
4725 case.
4727 @item -Wswitch-enum
4728 @opindex Wswitch-enum
4729 @opindex Wno-switch-enum
4730 Warn whenever a @code{switch} statement has an index of enumerated type
4731 and lacks a @code{case} for one or more of the named codes of that
4732 enumeration.  @code{case} labels outside the enumeration range also
4733 provoke warnings when this option is used.  The only difference
4734 between @option{-Wswitch} and this option is that this option gives a
4735 warning about an omitted enumeration code even if there is a
4736 @code{default} label.
4738 @item -Wswitch-bool
4739 @opindex Wswitch-bool
4740 @opindex Wno-switch-bool
4741 Warn whenever a @code{switch} statement has an index of boolean type
4742 and the case values are outside the range of a boolean type.
4743 It is possible to suppress this warning by casting the controlling
4744 expression to a type other than @code{bool}.  For example:
4745 @smallexample
4746 @group
4747 switch ((int) (a == 4))
4748   @{
4749   @dots{}
4750   @}
4751 @end group
4752 @end smallexample
4753 This warning is enabled by default for C and C++ programs.
4755 @item -Wswitch-unreachable
4756 @opindex Wswitch-unreachable
4757 @opindex Wno-switch-unreachable
4758 Warn whenever a @code{switch} statement contains statements between the
4759 controlling expression and the first case label, which will never be
4760 executed.  For example:
4761 @smallexample
4762 @group
4763 switch (cond)
4764   @{
4765    i = 15;
4766   @dots{}
4767    case 5:
4768   @dots{}
4769   @}
4770 @end group
4771 @end smallexample
4772 @option{-Wswitch-unreachable} does not warn if the statement between the
4773 controlling expression and the first case label is just a declaration:
4774 @smallexample
4775 @group
4776 switch (cond)
4777   @{
4778    int i;
4779   @dots{}
4780    case 5:
4781    i = 5;
4782   @dots{}
4783   @}
4784 @end group
4785 @end smallexample
4786 This warning is enabled by default for C and C++ programs.
4788 @item -Wsync-nand @r{(C and C++ only)}
4789 @opindex Wsync-nand
4790 @opindex Wno-sync-nand
4791 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4792 built-in functions are used.  These functions changed semantics in GCC 4.4.
4794 @item -Wunused-but-set-parameter
4795 @opindex Wunused-but-set-parameter
4796 @opindex Wno-unused-but-set-parameter
4797 Warn whenever a function parameter is assigned to, but otherwise unused
4798 (aside from its declaration).
4800 To suppress this warning use the @code{unused} attribute
4801 (@pxref{Variable Attributes}).
4803 This warning is also enabled by @option{-Wunused} together with
4804 @option{-Wextra}.
4806 @item -Wunused-but-set-variable
4807 @opindex Wunused-but-set-variable
4808 @opindex Wno-unused-but-set-variable
4809 Warn whenever a local variable is assigned to, but otherwise unused
4810 (aside from its declaration).
4811 This warning is enabled by @option{-Wall}.
4813 To suppress this warning use the @code{unused} attribute
4814 (@pxref{Variable Attributes}).
4816 This warning is also enabled by @option{-Wunused}, which is enabled
4817 by @option{-Wall}.
4819 @item -Wunused-function
4820 @opindex Wunused-function
4821 @opindex Wno-unused-function
4822 Warn whenever a static function is declared but not defined or a
4823 non-inline static function is unused.
4824 This warning is enabled by @option{-Wall}.
4826 @item -Wunused-label
4827 @opindex Wunused-label
4828 @opindex Wno-unused-label
4829 Warn whenever a label is declared but not used.
4830 This warning is enabled by @option{-Wall}.
4832 To suppress this warning use the @code{unused} attribute
4833 (@pxref{Variable Attributes}).
4835 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4836 @opindex Wunused-local-typedefs
4837 Warn when a typedef locally defined in a function is not used.
4838 This warning is enabled by @option{-Wall}.
4840 @item -Wunused-parameter
4841 @opindex Wunused-parameter
4842 @opindex Wno-unused-parameter
4843 Warn whenever a function parameter is unused aside from its declaration.
4845 To suppress this warning use the @code{unused} attribute
4846 (@pxref{Variable Attributes}).
4848 @item -Wno-unused-result
4849 @opindex Wunused-result
4850 @opindex Wno-unused-result
4851 Do not warn if a caller of a function marked with attribute
4852 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4853 its return value. The default is @option{-Wunused-result}.
4855 @item -Wunused-variable
4856 @opindex Wunused-variable
4857 @opindex Wno-unused-variable
4858 Warn whenever a local or static variable is unused aside from its
4859 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4860 but not for C++. This warning is enabled by @option{-Wall}.
4862 To suppress this warning use the @code{unused} attribute
4863 (@pxref{Variable Attributes}).
4865 @item -Wunused-const-variable
4866 @itemx -Wunused-const-variable=@var{n}
4867 @opindex Wunused-const-variable
4868 @opindex Wno-unused-const-variable
4869 Warn whenever a constant static variable is unused aside from its declaration.
4870 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4871 for C, but not for C++. In C this declares variable storage, but in C++ this
4872 is not an error since const variables take the place of @code{#define}s.
4874 To suppress this warning use the @code{unused} attribute
4875 (@pxref{Variable Attributes}).
4877 @table @gcctabopt
4878 @item -Wunused-const-variable=1
4879 This is the warning level that is enabled by @option{-Wunused-variable} for
4880 C.  It warns only about unused static const variables defined in the main
4881 compilation unit, but not about static const variables declared in any
4882 header included.
4884 @item -Wunused-const-variable=2
4885 This warning level also warns for unused constant static variables in
4886 headers (excluding system headers).  This is the warning level of
4887 @option{-Wunused-const-variable} and must be explicitly requested since
4888 in C++ this isn't an error and in C it might be harder to clean up all
4889 headers included.
4890 @end table
4892 @item -Wunused-value
4893 @opindex Wunused-value
4894 @opindex Wno-unused-value
4895 Warn whenever a statement computes a result that is explicitly not
4896 used. To suppress this warning cast the unused expression to
4897 @code{void}. This includes an expression-statement or the left-hand
4898 side of a comma expression that contains no side effects. For example,
4899 an expression such as @code{x[i,j]} causes a warning, while
4900 @code{x[(void)i,j]} does not.
4902 This warning is enabled by @option{-Wall}.
4904 @item -Wunused
4905 @opindex Wunused
4906 @opindex Wno-unused
4907 All the above @option{-Wunused} options combined.
4909 In order to get a warning about an unused function parameter, you must
4910 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4911 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4913 @item -Wuninitialized
4914 @opindex Wuninitialized
4915 @opindex Wno-uninitialized
4916 Warn if an automatic variable is used without first being initialized
4917 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4918 warn if a non-static reference or non-static @code{const} member
4919 appears in a class without constructors.
4921 If you want to warn about code that uses the uninitialized value of the
4922 variable in its own initializer, use the @option{-Winit-self} option.
4924 These warnings occur for individual uninitialized or clobbered
4925 elements of structure, union or array variables as well as for
4926 variables that are uninitialized or clobbered as a whole.  They do
4927 not occur for variables or elements declared @code{volatile}.  Because
4928 these warnings depend on optimization, the exact variables or elements
4929 for which there are warnings depends on the precise optimization
4930 options and version of GCC used.
4932 Note that there may be no warning about a variable that is used only
4933 to compute a value that itself is never used, because such
4934 computations may be deleted by data flow analysis before the warnings
4935 are printed.
4937 @item -Winvalid-memory-model
4938 @opindex Winvalid-memory-model
4939 @opindex Wno-invalid-memory-model
4940 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4941 and the C11 atomic generic functions with a memory consistency argument
4942 that is either invalid for the operation or outside the range of values
4943 of the @code{memory_order} enumeration.  For example, since the
4944 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4945 defined for the relaxed, release, and sequentially consistent memory
4946 orders the following code is diagnosed:
4948 @smallexample
4949 void store (int *i)
4951   __atomic_store_n (i, 0, memory_order_consume);
4953 @end smallexample
4955 @option{-Winvalid-memory-model} is enabled by default.
4957 @item -Wmaybe-uninitialized
4958 @opindex Wmaybe-uninitialized
4959 @opindex Wno-maybe-uninitialized
4960 For an automatic variable, if there exists a path from the function
4961 entry to a use of the variable that is initialized, but there exist
4962 some other paths for which the variable is not initialized, the compiler
4963 emits a warning if it cannot prove the uninitialized paths are not
4964 executed at run time. These warnings are made optional because GCC is
4965 not smart enough to see all the reasons why the code might be correct
4966 in spite of appearing to have an error.  Here is one example of how
4967 this can happen:
4969 @smallexample
4970 @group
4972   int x;
4973   switch (y)
4974     @{
4975     case 1: x = 1;
4976       break;
4977     case 2: x = 4;
4978       break;
4979     case 3: x = 5;
4980     @}
4981   foo (x);
4983 @end group
4984 @end smallexample
4986 @noindent
4987 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4988 always initialized, but GCC doesn't know this. To suppress the
4989 warning, you need to provide a default case with assert(0) or
4990 similar code.
4992 @cindex @code{longjmp} warnings
4993 This option also warns when a non-volatile automatic variable might be
4994 changed by a call to @code{longjmp}.  These warnings as well are possible
4995 only in optimizing compilation.
4997 The compiler sees only the calls to @code{setjmp}.  It cannot know
4998 where @code{longjmp} will be called; in fact, a signal handler could
4999 call it at any point in the code.  As a result, you may get a warning
5000 even when there is in fact no problem because @code{longjmp} cannot
5001 in fact be called at the place that would cause a problem.
5003 Some spurious warnings can be avoided if you declare all the functions
5004 you use that never return as @code{noreturn}.  @xref{Function
5005 Attributes}.
5007 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5009 @item -Wunknown-pragmas
5010 @opindex Wunknown-pragmas
5011 @opindex Wno-unknown-pragmas
5012 @cindex warning for unknown pragmas
5013 @cindex unknown pragmas, warning
5014 @cindex pragmas, warning of unknown
5015 Warn when a @code{#pragma} directive is encountered that is not understood by 
5016 GCC@.  If this command-line option is used, warnings are even issued
5017 for unknown pragmas in system header files.  This is not the case if
5018 the warnings are only enabled by the @option{-Wall} command-line option.
5020 @item -Wno-pragmas
5021 @opindex Wno-pragmas
5022 @opindex Wpragmas
5023 Do not warn about misuses of pragmas, such as incorrect parameters,
5024 invalid syntax, or conflicts between pragmas.  See also
5025 @option{-Wunknown-pragmas}.
5027 @item -Wstrict-aliasing
5028 @opindex Wstrict-aliasing
5029 @opindex Wno-strict-aliasing
5030 This option is only active when @option{-fstrict-aliasing} is active.
5031 It warns about code that might break the strict aliasing rules that the
5032 compiler is using for optimization.  The warning does not catch all
5033 cases, but does attempt to catch the more common pitfalls.  It is
5034 included in @option{-Wall}.
5035 It is equivalent to @option{-Wstrict-aliasing=3}
5037 @item -Wstrict-aliasing=n
5038 @opindex Wstrict-aliasing=n
5039 This option is only active when @option{-fstrict-aliasing} is active.
5040 It warns about code that might break the strict aliasing rules that the
5041 compiler is using for optimization.
5042 Higher levels correspond to higher accuracy (fewer false positives).
5043 Higher levels also correspond to more effort, similar to the way @option{-O} 
5044 works.
5045 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5047 Level 1: Most aggressive, quick, least accurate.
5048 Possibly useful when higher levels
5049 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5050 false negatives.  However, it has many false positives.
5051 Warns for all pointer conversions between possibly incompatible types,
5052 even if never dereferenced.  Runs in the front end only.
5054 Level 2: Aggressive, quick, not too precise.
5055 May still have many false positives (not as many as level 1 though),
5056 and few false negatives (but possibly more than level 1).
5057 Unlike level 1, it only warns when an address is taken.  Warns about
5058 incomplete types.  Runs in the front end only.
5060 Level 3 (default for @option{-Wstrict-aliasing}):
5061 Should have very few false positives and few false
5062 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5063 Takes care of the common pun+dereference pattern in the front end:
5064 @code{*(int*)&some_float}.
5065 If optimization is enabled, it also runs in the back end, where it deals
5066 with multiple statement cases using flow-sensitive points-to information.
5067 Only warns when the converted pointer is dereferenced.
5068 Does not warn about incomplete types.
5070 @item -Wstrict-overflow
5071 @itemx -Wstrict-overflow=@var{n}
5072 @opindex Wstrict-overflow
5073 @opindex Wno-strict-overflow
5074 This option is only active when signed overflow is undefined.
5075 It warns about cases where the compiler optimizes based on the
5076 assumption that signed overflow does not occur.  Note that it does not
5077 warn about all cases where the code might overflow: it only warns
5078 about cases where the compiler implements some optimization.  Thus
5079 this warning depends on the optimization level.
5081 An optimization that assumes that signed overflow does not occur is
5082 perfectly safe if the values of the variables involved are such that
5083 overflow never does, in fact, occur.  Therefore this warning can
5084 easily give a false positive: a warning about code that is not
5085 actually a problem.  To help focus on important issues, several
5086 warning levels are defined.  No warnings are issued for the use of
5087 undefined signed overflow when estimating how many iterations a loop
5088 requires, in particular when determining whether a loop will be
5089 executed at all.
5091 @table @gcctabopt
5092 @item -Wstrict-overflow=1
5093 Warn about cases that are both questionable and easy to avoid.  For
5094 example the compiler simplifies
5095 @code{x + 1 > x} to @code{1}.  This level of
5096 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5097 are not, and must be explicitly requested.
5099 @item -Wstrict-overflow=2
5100 Also warn about other cases where a comparison is simplified to a
5101 constant.  For example: @code{abs (x) >= 0}.  This can only be
5102 simplified when signed integer overflow is undefined, because
5103 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5104 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5105 @option{-Wstrict-overflow=2}.
5107 @item -Wstrict-overflow=3
5108 Also warn about other cases where a comparison is simplified.  For
5109 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5111 @item -Wstrict-overflow=4
5112 Also warn about other simplifications not covered by the above cases.
5113 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5115 @item -Wstrict-overflow=5
5116 Also warn about cases where the compiler reduces the magnitude of a
5117 constant involved in a comparison.  For example: @code{x + 2 > y} is
5118 simplified to @code{x + 1 >= y}.  This is reported only at the
5119 highest warning level because this simplification applies to many
5120 comparisons, so this warning level gives a very large number of
5121 false positives.
5122 @end table
5124 @item -Wstringop-overflow
5125 @itemx -Wstringop-overflow=@var{type}
5126 @opindex Wstringop-overflow
5127 @opindex Wno-stringop-overflow
5128 Warn for calls to string manipulation functions such as @code{memcpy} and
5129 @code{strcpy} that are determined to overflow the destination buffer.  The
5130 optional argument is one greater than the type of Object Size Checking to
5131 perform to determine the size of the destination.  @xref{Object Size Checking}.
5132 The argument is meaningful only for functions that operate on character arrays
5133 but not for raw memory functions like @code{memcpy} which always make use
5134 of Object Size type-0.  The option also warns for calls that specify a size
5135 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5136 The option produces the best results with optimization enabled but can detect
5137 a small subset of simple buffer overflows even without optimization in
5138 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5139 correspond to the standard functions.  In any case, the option warns about
5140 just a subset of buffer overflows detected by the corresponding overflow
5141 checking built-ins.  For example, the option will issue a warning for
5142 the @code{strcpy} call below because it copies at least 5 characters
5143 (the string @code{"blue"} including the terminating NUL) into the buffer
5144 of size 4.
5146 @smallexample
5147 enum Color @{ blue, purple, yellow @};
5148 const char* f (enum Color clr)
5150   static char buf [4];
5151   const char *str;
5152   switch (clr)
5153     @{
5154       case blue: str = "blue"; break;
5155       case purple: str = "purple"; break;
5156       case yellow: str = "yellow"; break;
5157     @}
5159   return strcpy (buf, str);   // warning here
5161 @end smallexample
5163 Option @option{-Wstringop-overflow=2} is enabled by default.
5165 @table @gcctabopt
5166 @item -Wstringop-overflow
5167 @item -Wstringop-overflow=1
5168 @opindex Wstringop-overflow
5169 @opindex Wno-stringop-overflow
5170 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5171 to determine the sizes of destination objects.  This is the default setting
5172 of the option.  At this setting the option will not warn for writes past
5173 the end of subobjects of larger objects accessed by pointers unless the
5174 size of the largest surrounding object is known.  When the destination may
5175 be one of several objects it is assumed to be the largest one of them.  On
5176 Linux systems, when optimization is enabled at this setting the option warns
5177 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5178 a non-zero value.
5180 @item -Wstringop-overflow=2
5181 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5182 to determine the sizes of destination objects.  At this setting the option
5183 will warn about overflows when writing to members of the largest complete
5184 objects whose exact size is known.  It will, however, not warn for excessive
5185 writes to the same members of unknown objects referenced by pointers since
5186 they may point to arrays containing unknown numbers of elements.
5188 @item -Wstringop-overflow=3
5189 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5190 to determine the sizes of destination objects.  At this setting the option
5191 warns about overflowing the smallest object or data member.  This is the
5192 most restrictive setting of the option that may result in warnings for safe
5193 code.
5195 @item -Wstringop-overflow=4
5196 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5197 to determine the sizes of destination objects.  At this setting the option
5198 will warn about overflowing any data members, and when the destination is
5199 one of several objects it uses the size of the largest of them to decide
5200 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5201 setting of the option may result in warnings for benign code.
5202 @end table
5204 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{]}
5205 @opindex Wsuggest-attribute=
5206 @opindex Wno-suggest-attribute=
5207 Warn for cases where adding an attribute may be beneficial. The
5208 attributes currently supported are listed below.
5210 @table @gcctabopt
5211 @item -Wsuggest-attribute=pure
5212 @itemx -Wsuggest-attribute=const
5213 @itemx -Wsuggest-attribute=noreturn
5214 @opindex Wsuggest-attribute=pure
5215 @opindex Wno-suggest-attribute=pure
5216 @opindex Wsuggest-attribute=const
5217 @opindex Wno-suggest-attribute=const
5218 @opindex Wsuggest-attribute=noreturn
5219 @opindex Wno-suggest-attribute=noreturn
5221 Warn about functions that might be candidates for attributes
5222 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5223 functions visible in other compilation units or (in the case of @code{pure} and
5224 @code{const}) if it cannot prove that the function returns normally. A function
5225 returns normally if it doesn't contain an infinite loop or return abnormally
5226 by throwing, calling @code{abort} or trapping.  This analysis requires option
5227 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5228 higher.  Higher optimization levels improve the accuracy of the analysis.
5230 @item -Wsuggest-attribute=format
5231 @itemx -Wmissing-format-attribute
5232 @opindex Wsuggest-attribute=format
5233 @opindex Wmissing-format-attribute
5234 @opindex Wno-suggest-attribute=format
5235 @opindex Wno-missing-format-attribute
5236 @opindex Wformat
5237 @opindex Wno-format
5239 Warn about function pointers that might be candidates for @code{format}
5240 attributes.  Note these are only possible candidates, not absolute ones.
5241 GCC guesses that function pointers with @code{format} attributes that
5242 are used in assignment, initialization, parameter passing or return
5243 statements should have a corresponding @code{format} attribute in the
5244 resulting type.  I.e.@: the left-hand side of the assignment or
5245 initialization, the type of the parameter variable, or the return type
5246 of the containing function respectively should also have a @code{format}
5247 attribute to avoid the warning.
5249 GCC also warns about function definitions that might be
5250 candidates for @code{format} attributes.  Again, these are only
5251 possible candidates.  GCC guesses that @code{format} attributes
5252 might be appropriate for any function that calls a function like
5253 @code{vprintf} or @code{vscanf}, but this might not always be the
5254 case, and some functions for which @code{format} attributes are
5255 appropriate may not be detected.
5257 @item -Wsuggest-attribute=cold
5258 @opindex Wsuggest-attribute=cold
5259 @opindex Wno-suggest-attribute=cold
5261 Warn about functions that might be candidates for @code{cold} attribute.  This
5262 is based on static detection and generally will only warn about functions which
5263 always leads to a call to another @code{cold} function such as wrappers of
5264 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5265 @end table
5267 @item -Wsuggest-final-types
5268 @opindex Wno-suggest-final-types
5269 @opindex Wsuggest-final-types
5270 Warn about types with virtual methods where code quality would be improved
5271 if the type were declared with the C++11 @code{final} specifier, 
5272 or, if possible,
5273 declared in an anonymous namespace. This allows GCC to more aggressively
5274 devirtualize the polymorphic calls. This warning is more effective with link
5275 time optimization, where the information about the class hierarchy graph is
5276 more complete.
5278 @item -Wsuggest-final-methods
5279 @opindex Wno-suggest-final-methods
5280 @opindex Wsuggest-final-methods
5281 Warn about virtual methods where code quality would be improved if the method
5282 were declared with the C++11 @code{final} specifier, 
5283 or, if possible, its type were
5284 declared in an anonymous namespace or with the @code{final} specifier.
5285 This warning is
5286 more effective with link-time optimization, where the information about the
5287 class hierarchy graph is more complete. It is recommended to first consider
5288 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5289 annotations.
5291 @item -Wsuggest-override
5292 Warn about overriding virtual functions that are not marked with the override
5293 keyword.
5295 @item -Walloc-zero
5296 @opindex Wno-alloc-zero
5297 @opindex Walloc-zero
5298 Warn about calls to allocation functions decorated with attribute
5299 @code{alloc_size} that specify zero bytes, including those to the built-in
5300 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5301 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5302 when called with a zero size differs among implementations (and in the case
5303 of @code{realloc} has been deprecated) relying on it may result in subtle
5304 portability bugs and should be avoided.
5306 @item -Walloc-size-larger-than=@var{n}
5307 Warn about calls to functions decorated with attribute @code{alloc_size}
5308 that attempt to allocate objects larger than the specified number of bytes,
5309 or where the result of the size computation in an integer type with infinite
5310 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5311 may end in one of the standard suffixes designating a multiple of bytes
5312 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5313 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5314 @xref{Function Attributes}.
5316 @item -Walloca
5317 @opindex Wno-alloca
5318 @opindex Walloca
5319 This option warns on all uses of @code{alloca} in the source.
5321 @item -Walloca-larger-than=@var{n}
5322 This option warns on calls to @code{alloca} that are not bounded by a
5323 controlling predicate limiting its argument of integer type to at most
5324 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5325 Arguments of non-integer types are considered unbounded even if they
5326 appear to be constrained to the expected range.
5328 For example, a bounded case of @code{alloca} could be:
5330 @smallexample
5331 void func (size_t n)
5333   void *p;
5334   if (n <= 1000)
5335     p = alloca (n);
5336   else
5337     p = malloc (n);
5338   f (p);
5340 @end smallexample
5342 In the above example, passing @code{-Walloca-larger-than=1000} would not
5343 issue a warning because the call to @code{alloca} is known to be at most
5344 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5345 the compiler would emit a warning.
5347 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5348 controlling predicate constraining its integer argument.  For example:
5350 @smallexample
5351 void func ()
5353   void *p = alloca (n);
5354   f (p);
5356 @end smallexample
5358 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5359 a warning, but this time because of the lack of bounds checking.
5361 Note, that even seemingly correct code involving signed integers could
5362 cause a warning:
5364 @smallexample
5365 void func (signed int n)
5367   if (n < 500)
5368     @{
5369       p = alloca (n);
5370       f (p);
5371     @}
5373 @end smallexample
5375 In the above example, @var{n} could be negative, causing a larger than
5376 expected argument to be implicitly cast into the @code{alloca} call.
5378 This option also warns when @code{alloca} is used in a loop.
5380 This warning is not enabled by @option{-Wall}, and is only active when
5381 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5383 See also @option{-Wvla-larger-than=@var{n}}.
5385 @item -Warray-bounds
5386 @itemx -Warray-bounds=@var{n}
5387 @opindex Wno-array-bounds
5388 @opindex Warray-bounds
5389 This option is only active when @option{-ftree-vrp} is active
5390 (default for @option{-O2} and above). It warns about subscripts to arrays
5391 that are always out of bounds. This warning is enabled by @option{-Wall}.
5393 @table @gcctabopt
5394 @item -Warray-bounds=1
5395 This is the warning level of @option{-Warray-bounds} and is enabled
5396 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5398 @item -Warray-bounds=2
5399 This warning level also warns about out of bounds access for
5400 arrays at the end of a struct and for arrays accessed through
5401 pointers. This warning level may give a larger number of
5402 false positives and is deactivated by default.
5403 @end table
5405 @item -Wattribute-alias
5406 Warn about declarations using the @code{alias} and similar attributes whose
5407 target is incompatible with the type of the alias.  @xref{Function Attributes,
5408 ,Declaring Attributes of Functions}.
5410 @item -Wbool-compare
5411 @opindex Wno-bool-compare
5412 @opindex Wbool-compare
5413 Warn about boolean expression compared with an integer value different from
5414 @code{true}/@code{false}.  For instance, the following comparison is
5415 always false:
5416 @smallexample
5417 int n = 5;
5418 @dots{}
5419 if ((n > 1) == 2) @{ @dots{} @}
5420 @end smallexample
5421 This warning is enabled by @option{-Wall}.
5423 @item -Wbool-operation
5424 @opindex Wno-bool-operation
5425 @opindex Wbool-operation
5426 Warn about suspicious operations on expressions of a boolean type.  For
5427 instance, bitwise negation of a boolean is very likely a bug in the program.
5428 For C, this warning also warns about incrementing or decrementing a boolean,
5429 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5430 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5432 This warning is enabled by @option{-Wall}.
5434 @item -Wduplicated-branches
5435 @opindex Wno-duplicated-branches
5436 @opindex Wduplicated-branches
5437 Warn when an if-else has identical branches.  This warning detects cases like
5438 @smallexample
5439 if (p != NULL)
5440   return 0;
5441 else
5442   return 0;
5443 @end smallexample
5444 It doesn't warn when both branches contain just a null statement.  This warning
5445 also warn for conditional operators:
5446 @smallexample
5447   int i = x ? *p : *p;
5448 @end smallexample
5450 @item -Wduplicated-cond
5451 @opindex Wno-duplicated-cond
5452 @opindex Wduplicated-cond
5453 Warn about duplicated conditions in an if-else-if chain.  For instance,
5454 warn for the following code:
5455 @smallexample
5456 if (p->q != NULL) @{ @dots{} @}
5457 else if (p->q != NULL) @{ @dots{} @}
5458 @end smallexample
5460 @item -Wframe-address
5461 @opindex Wno-frame-address
5462 @opindex Wframe-address
5463 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5464 is called with an argument greater than 0.  Such calls may return indeterminate
5465 values or crash the program.  The warning is included in @option{-Wall}.
5467 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5468 @opindex Wno-discarded-qualifiers
5469 @opindex Wdiscarded-qualifiers
5470 Do not warn if type qualifiers on pointers are being discarded.
5471 Typically, the compiler warns if a @code{const char *} variable is
5472 passed to a function that takes a @code{char *} parameter.  This option
5473 can be used to suppress such a warning.
5475 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5476 @opindex Wno-discarded-array-qualifiers
5477 @opindex Wdiscarded-array-qualifiers
5478 Do not warn if type qualifiers on arrays which are pointer targets
5479 are being discarded. Typically, the compiler warns if a
5480 @code{const int (*)[]} variable is passed to a function that
5481 takes a @code{int (*)[]} parameter.  This option can be used to
5482 suppress such a warning.
5484 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5485 @opindex Wno-incompatible-pointer-types
5486 @opindex Wincompatible-pointer-types
5487 Do not warn when there is a conversion between pointers that have incompatible
5488 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5489 which warns for pointer argument passing or assignment with different
5490 signedness.
5492 @item -Wno-int-conversion @r{(C and Objective-C only)}
5493 @opindex Wno-int-conversion
5494 @opindex Wint-conversion
5495 Do not warn about incompatible integer to pointer and pointer to integer
5496 conversions.  This warning is about implicit conversions; for explicit
5497 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5498 @option{-Wno-pointer-to-int-cast} may be used.
5500 @item -Wno-div-by-zero
5501 @opindex Wno-div-by-zero
5502 @opindex Wdiv-by-zero
5503 Do not warn about compile-time integer division by zero.  Floating-point
5504 division by zero is not warned about, as it can be a legitimate way of
5505 obtaining infinities and NaNs.
5507 @item -Wsystem-headers
5508 @opindex Wsystem-headers
5509 @opindex Wno-system-headers
5510 @cindex warnings from system headers
5511 @cindex system headers, warnings from
5512 Print warning messages for constructs found in system header files.
5513 Warnings from system headers are normally suppressed, on the assumption
5514 that they usually do not indicate real problems and would only make the
5515 compiler output harder to read.  Using this command-line option tells
5516 GCC to emit warnings from system headers as if they occurred in user
5517 code.  However, note that using @option{-Wall} in conjunction with this
5518 option does @emph{not} warn about unknown pragmas in system
5519 headers---for that, @option{-Wunknown-pragmas} must also be used.
5521 @item -Wtautological-compare
5522 @opindex Wtautological-compare
5523 @opindex Wno-tautological-compare
5524 Warn if a self-comparison always evaluates to true or false.  This
5525 warning detects various mistakes such as:
5526 @smallexample
5527 int i = 1;
5528 @dots{}
5529 if (i > i) @{ @dots{} @}
5530 @end smallexample
5532 This warning also warns about bitwise comparisons that always evaluate
5533 to true or false, for instance:
5534 @smallexample
5535 if ((a & 16) == 10) @{ @dots{} @}
5536 @end smallexample
5537 will always be false.
5539 This warning is enabled by @option{-Wall}.
5541 @item -Wtrampolines
5542 @opindex Wtrampolines
5543 @opindex Wno-trampolines
5544 Warn about trampolines generated for pointers to nested functions.
5545 A trampoline is a small piece of data or code that is created at run
5546 time on the stack when the address of a nested function is taken, and is
5547 used to call the nested function indirectly.  For some targets, it is
5548 made up of data only and thus requires no special treatment.  But, for
5549 most targets, it is made up of code and thus requires the stack to be
5550 made executable in order for the program to work properly.
5552 @item -Wfloat-equal
5553 @opindex Wfloat-equal
5554 @opindex Wno-float-equal
5555 Warn if floating-point values are used in equality comparisons.
5557 The idea behind this is that sometimes it is convenient (for the
5558 programmer) to consider floating-point values as approximations to
5559 infinitely precise real numbers.  If you are doing this, then you need
5560 to compute (by analyzing the code, or in some other way) the maximum or
5561 likely maximum error that the computation introduces, and allow for it
5562 when performing comparisons (and when producing output, but that's a
5563 different problem).  In particular, instead of testing for equality, you
5564 should check to see whether the two values have ranges that overlap; and
5565 this is done with the relational operators, so equality comparisons are
5566 probably mistaken.
5568 @item -Wtraditional @r{(C and Objective-C only)}
5569 @opindex Wtraditional
5570 @opindex Wno-traditional
5571 Warn about certain constructs that behave differently in traditional and
5572 ISO C@.  Also warn about ISO C constructs that have no traditional C
5573 equivalent, and/or problematic constructs that should be avoided.
5575 @itemize @bullet
5576 @item
5577 Macro parameters that appear within string literals in the macro body.
5578 In traditional C macro replacement takes place within string literals,
5579 but in ISO C it does not.
5581 @item
5582 In traditional C, some preprocessor directives did not exist.
5583 Traditional preprocessors only considered a line to be a directive
5584 if the @samp{#} appeared in column 1 on the line.  Therefore
5585 @option{-Wtraditional} warns about directives that traditional C
5586 understands but ignores because the @samp{#} does not appear as the
5587 first character on the line.  It also suggests you hide directives like
5588 @code{#pragma} not understood by traditional C by indenting them.  Some
5589 traditional implementations do not recognize @code{#elif}, so this option
5590 suggests avoiding it altogether.
5592 @item
5593 A function-like macro that appears without arguments.
5595 @item
5596 The unary plus operator.
5598 @item
5599 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5600 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5601 constants.)  Note, these suffixes appear in macros defined in the system
5602 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5603 Use of these macros in user code might normally lead to spurious
5604 warnings, however GCC's integrated preprocessor has enough context to
5605 avoid warning in these cases.
5607 @item
5608 A function declared external in one block and then used after the end of
5609 the block.
5611 @item
5612 A @code{switch} statement has an operand of type @code{long}.
5614 @item
5615 A non-@code{static} function declaration follows a @code{static} one.
5616 This construct is not accepted by some traditional C compilers.
5618 @item
5619 The ISO type of an integer constant has a different width or
5620 signedness from its traditional type.  This warning is only issued if
5621 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5622 typically represent bit patterns, are not warned about.
5624 @item
5625 Usage of ISO string concatenation is detected.
5627 @item
5628 Initialization of automatic aggregates.
5630 @item
5631 Identifier conflicts with labels.  Traditional C lacks a separate
5632 namespace for labels.
5634 @item
5635 Initialization of unions.  If the initializer is zero, the warning is
5636 omitted.  This is done under the assumption that the zero initializer in
5637 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5638 initializer warnings and relies on default initialization to zero in the
5639 traditional C case.
5641 @item
5642 Conversions by prototypes between fixed/floating-point values and vice
5643 versa.  The absence of these prototypes when compiling with traditional
5644 C causes serious problems.  This is a subset of the possible
5645 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5647 @item
5648 Use of ISO C style function definitions.  This warning intentionally is
5649 @emph{not} issued for prototype declarations or variadic functions
5650 because these ISO C features appear in your code when using
5651 libiberty's traditional C compatibility macros, @code{PARAMS} and
5652 @code{VPARAMS}.  This warning is also bypassed for nested functions
5653 because that feature is already a GCC extension and thus not relevant to
5654 traditional C compatibility.
5655 @end itemize
5657 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5658 @opindex Wtraditional-conversion
5659 @opindex Wno-traditional-conversion
5660 Warn if a prototype causes a type conversion that is different from what
5661 would happen to the same argument in the absence of a prototype.  This
5662 includes conversions of fixed point to floating and vice versa, and
5663 conversions changing the width or signedness of a fixed-point argument
5664 except when the same as the default promotion.
5666 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5667 @opindex Wdeclaration-after-statement
5668 @opindex Wno-declaration-after-statement
5669 Warn when a declaration is found after a statement in a block.  This
5670 construct, known from C++, was introduced with ISO C99 and is by default
5671 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5673 @item -Wshadow
5674 @opindex Wshadow
5675 @opindex Wno-shadow
5676 Warn whenever a local variable or type declaration shadows another
5677 variable, parameter, type, class member (in C++), or instance variable
5678 (in Objective-C) or whenever a built-in function is shadowed. Note
5679 that in C++, the compiler warns if a local variable shadows an
5680 explicit typedef, but not if it shadows a struct/class/enum.
5681 Same as @option{-Wshadow=global}.
5683 @item -Wno-shadow-ivar @r{(Objective-C only)}
5684 @opindex Wno-shadow-ivar
5685 @opindex Wshadow-ivar
5686 Do not warn whenever a local variable shadows an instance variable in an
5687 Objective-C method.
5689 @item -Wshadow=global
5690 @opindex Wshadow=local
5691 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5693 @item -Wshadow=local
5694 @opindex Wshadow=local
5695 Warn when a local variable shadows another local variable or parameter.
5696 This warning is enabled by @option{-Wshadow=global}.
5698 @item -Wshadow=compatible-local
5699 @opindex Wshadow=compatible-local
5700 Warn when a local variable shadows another local variable or parameter
5701 whose type is compatible with that of the shadowing variable. In C++,
5702 type compatibility here means the type of the shadowing variable can be
5703 converted to that of the shadowed variable. The creation of this flag
5704 (in addition to @option{-Wshadow=local}) is based on the idea that when
5705 a local variable shadows another one of incompatible type, it is most
5706 likely intentional, not a bug or typo, as shown in the following example:
5708 @smallexample
5709 @group
5710 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5712   for (int i = 0; i < N; ++i)
5713   @{
5714     ...
5715   @}
5716   ...
5718 @end group
5719 @end smallexample
5721 Since the two variable @code{i} in the example above have incompatible types,
5722 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5723 Because their types are incompatible, if a programmer accidentally uses one
5724 in place of the other, type checking will catch that and emit an error or
5725 warning. So not warning (about shadowing) in this case will not lead to
5726 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5727 possibly reduce the number of warnings triggered by intentional shadowing.
5729 This warning is enabled by @option{-Wshadow=local}.
5731 @item -Wlarger-than=@var{len}
5732 @opindex Wlarger-than=@var{len}
5733 @opindex Wlarger-than-@var{len}
5734 Warn whenever an object of larger than @var{len} bytes is defined.
5736 @item -Wframe-larger-than=@var{len}
5737 @opindex Wframe-larger-than
5738 Warn if the size of a function frame is larger than @var{len} bytes.
5739 The computation done to determine the stack frame size is approximate
5740 and not conservative.
5741 The actual requirements may be somewhat greater than @var{len}
5742 even if you do not get a warning.  In addition, any space allocated
5743 via @code{alloca}, variable-length arrays, or related constructs
5744 is not included by the compiler when determining
5745 whether or not to issue a warning.
5747 @item -Wno-free-nonheap-object
5748 @opindex Wno-free-nonheap-object
5749 @opindex Wfree-nonheap-object
5750 Do not warn when attempting to free an object that was not allocated
5751 on the heap.
5753 @item -Wstack-usage=@var{len}
5754 @opindex Wstack-usage
5755 Warn if the stack usage of a function might be larger than @var{len} bytes.
5756 The computation done to determine the stack usage is conservative.
5757 Any space allocated via @code{alloca}, variable-length arrays, or related
5758 constructs is included by the compiler when determining whether or not to
5759 issue a warning.
5761 The message is in keeping with the output of @option{-fstack-usage}.
5763 @itemize
5764 @item
5765 If the stack usage is fully static but exceeds the specified amount, it's:
5767 @smallexample
5768   warning: stack usage is 1120 bytes
5769 @end smallexample
5770 @item
5771 If the stack usage is (partly) dynamic but bounded, it's:
5773 @smallexample
5774   warning: stack usage might be 1648 bytes
5775 @end smallexample
5776 @item
5777 If the stack usage is (partly) dynamic and not bounded, it's:
5779 @smallexample
5780   warning: stack usage might be unbounded
5781 @end smallexample
5782 @end itemize
5784 @item -Wunsafe-loop-optimizations
5785 @opindex Wunsafe-loop-optimizations
5786 @opindex Wno-unsafe-loop-optimizations
5787 Warn if the loop cannot be optimized because the compiler cannot
5788 assume anything on the bounds of the loop indices.  With
5789 @option{-funsafe-loop-optimizations} warn if the compiler makes
5790 such assumptions.
5792 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5793 @opindex Wno-pedantic-ms-format
5794 @opindex Wpedantic-ms-format
5795 When used in combination with @option{-Wformat}
5796 and @option{-pedantic} without GNU extensions, this option
5797 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5798 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5799 which depend on the MS runtime.
5801 @item -Waligned-new
5802 @opindex Waligned-new
5803 @opindex Wno-aligned-new
5804 Warn about a new-expression of a type that requires greater alignment
5805 than the @code{alignof(std::max_align_t)} but uses an allocation
5806 function without an explicit alignment parameter. This option is
5807 enabled by @option{-Wall}.
5809 Normally this only warns about global allocation functions, but
5810 @option{-Waligned-new=all} also warns about class member allocation
5811 functions.
5813 @item -Wplacement-new
5814 @itemx -Wplacement-new=@var{n}
5815 @opindex Wplacement-new
5816 @opindex Wno-placement-new
5817 Warn about placement new expressions with undefined behavior, such as
5818 constructing an object in a buffer that is smaller than the type of
5819 the object.  For example, the placement new expression below is diagnosed
5820 because it attempts to construct an array of 64 integers in a buffer only
5821 64 bytes large.
5822 @smallexample
5823 char buf [64];
5824 new (buf) int[64];
5825 @end smallexample
5826 This warning is enabled by default.
5828 @table @gcctabopt
5829 @item -Wplacement-new=1
5830 This is the default warning level of @option{-Wplacement-new}.  At this
5831 level the warning is not issued for some strictly undefined constructs that
5832 GCC allows as extensions for compatibility with legacy code.  For example,
5833 the following @code{new} expression is not diagnosed at this level even
5834 though it has undefined behavior according to the C++ standard because
5835 it writes past the end of the one-element array.
5836 @smallexample
5837 struct S @{ int n, a[1]; @};
5838 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5839 new (s->a)int [32]();
5840 @end smallexample
5842 @item -Wplacement-new=2
5843 At this level, in addition to diagnosing all the same constructs as at level
5844 1, a diagnostic is also issued for placement new expressions that construct
5845 an object in the last member of structure whose type is an array of a single
5846 element and whose size is less than the size of the object being constructed.
5847 While the previous example would be diagnosed, the following construct makes
5848 use of the flexible member array extension to avoid the warning at level 2.
5849 @smallexample
5850 struct S @{ int n, a[]; @};
5851 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5852 new (s->a)int [32]();
5853 @end smallexample
5855 @end table
5857 @item -Wpointer-arith
5858 @opindex Wpointer-arith
5859 @opindex Wno-pointer-arith
5860 Warn about anything that depends on the ``size of'' a function type or
5861 of @code{void}.  GNU C assigns these types a size of 1, for
5862 convenience in calculations with @code{void *} pointers and pointers
5863 to functions.  In C++, warn also when an arithmetic operation involves
5864 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5866 @item -Wpointer-compare
5867 @opindex Wpointer-compare
5868 @opindex Wno-pointer-compare
5869 Warn if a pointer is compared with a zero character constant.  This usually
5870 means that the pointer was meant to be dereferenced.  For example:
5872 @smallexample
5873 const char *p = foo ();
5874 if (p == '\0')
5875   return 42;
5876 @end smallexample
5878 Note that the code above is invalid in C++11.
5880 This warning is enabled by default.
5882 @item -Wtype-limits
5883 @opindex Wtype-limits
5884 @opindex Wno-type-limits
5885 Warn if a comparison is always true or always false due to the limited
5886 range of the data type, but do not warn for constant expressions.  For
5887 example, warn if an unsigned variable is compared against zero with
5888 @code{<} or @code{>=}.  This warning is also enabled by
5889 @option{-Wextra}.
5891 @include cppwarnopts.texi
5893 @item -Wbad-function-cast @r{(C and Objective-C only)}
5894 @opindex Wbad-function-cast
5895 @opindex Wno-bad-function-cast
5896 Warn when a function call is cast to a non-matching type.
5897 For example, warn if a call to a function returning an integer type 
5898 is cast to a pointer type.
5900 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5901 @opindex Wc90-c99-compat
5902 @opindex Wno-c90-c99-compat
5903 Warn about features not present in ISO C90, but present in ISO C99.
5904 For instance, warn about use of variable length arrays, @code{long long}
5905 type, @code{bool} type, compound literals, designated initializers, and so
5906 on.  This option is independent of the standards mode.  Warnings are disabled
5907 in the expression that follows @code{__extension__}.
5909 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5910 @opindex Wc99-c11-compat
5911 @opindex Wno-c99-c11-compat
5912 Warn about features not present in ISO C99, but present in ISO C11.
5913 For instance, warn about use of anonymous structures and unions,
5914 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5915 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5916 and so on.  This option is independent of the standards mode.  Warnings are
5917 disabled in the expression that follows @code{__extension__}.
5919 @item -Wc++-compat @r{(C and Objective-C only)}
5920 @opindex Wc++-compat
5921 Warn about ISO C constructs that are outside of the common subset of
5922 ISO C and ISO C++, e.g.@: request for implicit conversion from
5923 @code{void *} to a pointer to non-@code{void} type.
5925 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5926 @opindex Wc++11-compat
5927 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5928 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5929 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5930 enabled by @option{-Wall}.
5932 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5933 @opindex Wc++14-compat
5934 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5935 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5937 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
5938 @opindex Wc++17-compat
5939 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5940 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
5942 @item -Wcast-qual
5943 @opindex Wcast-qual
5944 @opindex Wno-cast-qual
5945 Warn whenever a pointer is cast so as to remove a type qualifier from
5946 the target type.  For example, warn if a @code{const char *} is cast
5947 to an ordinary @code{char *}.
5949 Also warn when making a cast that introduces a type qualifier in an
5950 unsafe way.  For example, casting @code{char **} to @code{const char **}
5951 is unsafe, as in this example:
5953 @smallexample
5954   /* p is char ** value.  */
5955   const char **q = (const char **) p;
5956   /* Assignment of readonly string to const char * is OK.  */
5957   *q = "string";
5958   /* Now char** pointer points to read-only memory.  */
5959   **p = 'b';
5960 @end smallexample
5962 @item -Wcast-align
5963 @opindex Wcast-align
5964 @opindex Wno-cast-align
5965 Warn whenever a pointer is cast such that the required alignment of the
5966 target is increased.  For example, warn if a @code{char *} is cast to
5967 an @code{int *} on machines where integers can only be accessed at
5968 two- or four-byte boundaries.
5970 @item -Wcast-align=strict
5971 @opindex Wcast-align=strict
5972 Warn whenever a pointer is cast such that the required alignment of the
5973 target is increased.  For example, warn if a @code{char *} is cast to
5974 an @code{int *} regardless of the target machine.
5976 @item -Wwrite-strings
5977 @opindex Wwrite-strings
5978 @opindex Wno-write-strings
5979 When compiling C, give string constants the type @code{const
5980 char[@var{length}]} so that copying the address of one into a
5981 non-@code{const} @code{char *} pointer produces a warning.  These
5982 warnings help you find at compile time code that can try to write
5983 into a string constant, but only if you have been very careful about
5984 using @code{const} in declarations and prototypes.  Otherwise, it is
5985 just a nuisance. This is why we did not make @option{-Wall} request
5986 these warnings.
5988 When compiling C++, warn about the deprecated conversion from string
5989 literals to @code{char *}.  This warning is enabled by default for C++
5990 programs.
5992 @item -Wcatch-value
5993 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
5994 @opindex Wcatch-value
5995 @opindex Wno-catch-value
5996 Warn about catch handlers that do not catch via reference.
5997 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
5998 warn about polymorphic class types that are caught by value.
5999 With @option{-Wcatch-value=2} warn about all class types that are caught
6000 by value. With @option{-Wcatch-value=3} warn about all types that are
6001 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6003 @item -Wclobbered
6004 @opindex Wclobbered
6005 @opindex Wno-clobbered
6006 Warn for variables that might be changed by @code{longjmp} or
6007 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6009 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6010 @opindex Wconditionally-supported
6011 @opindex Wno-conditionally-supported
6012 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6014 @item -Wconversion
6015 @opindex Wconversion
6016 @opindex Wno-conversion
6017 Warn for implicit conversions that may alter a value. This includes
6018 conversions between real and integer, like @code{abs (x)} when
6019 @code{x} is @code{double}; conversions between signed and unsigned,
6020 like @code{unsigned ui = -1}; and conversions to smaller types, like
6021 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6022 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6023 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6024 conversions between signed and unsigned integers can be disabled by
6025 using @option{-Wno-sign-conversion}.
6027 For C++, also warn for confusing overload resolution for user-defined
6028 conversions; and conversions that never use a type conversion
6029 operator: conversions to @code{void}, the same type, a base class or a
6030 reference to them. Warnings about conversions between signed and
6031 unsigned integers are disabled by default in C++ unless
6032 @option{-Wsign-conversion} is explicitly enabled.
6034 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6035 @opindex Wconversion-null
6036 @opindex Wno-conversion-null
6037 Do not warn for conversions between @code{NULL} and non-pointer
6038 types. @option{-Wconversion-null} is enabled by default.
6040 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6041 @opindex Wzero-as-null-pointer-constant
6042 @opindex Wno-zero-as-null-pointer-constant
6043 Warn when a literal @samp{0} is used as null pointer constant.  This can
6044 be useful to facilitate the conversion to @code{nullptr} in C++11.
6046 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6047 @opindex Wsubobject-linkage
6048 @opindex Wno-subobject-linkage
6049 Warn if a class type has a base or a field whose type uses the anonymous
6050 namespace or depends on a type with no linkage.  If a type A depends on
6051 a type B with no or internal linkage, defining it in multiple
6052 translation units would be an ODR violation because the meaning of B
6053 is different in each translation unit.  If A only appears in a single
6054 translation unit, the best way to silence the warning is to give it
6055 internal linkage by putting it in an anonymous namespace as well.  The
6056 compiler doesn't give this warning for types defined in the main .C
6057 file, as those are unlikely to have multiple definitions.
6058 @option{-Wsubobject-linkage} is enabled by default.
6060 @item -Wdangling-else
6061 @opindex Wdangling-else
6062 @opindex Wno-dangling-else
6063 Warn about constructions where there may be confusion to which
6064 @code{if} statement an @code{else} branch belongs.  Here is an example of
6065 such a case:
6067 @smallexample
6068 @group
6070   if (a)
6071     if (b)
6072       foo ();
6073   else
6074     bar ();
6076 @end group
6077 @end smallexample
6079 In C/C++, every @code{else} branch belongs to the innermost possible
6080 @code{if} statement, which in this example is @code{if (b)}.  This is
6081 often not what the programmer expected, as illustrated in the above
6082 example by indentation the programmer chose.  When there is the
6083 potential for this confusion, GCC issues a warning when this flag
6084 is specified.  To eliminate the warning, add explicit braces around
6085 the innermost @code{if} statement so there is no way the @code{else}
6086 can belong to the enclosing @code{if}.  The resulting code
6087 looks like this:
6089 @smallexample
6090 @group
6092   if (a)
6093     @{
6094       if (b)
6095         foo ();
6096       else
6097         bar ();
6098     @}
6100 @end group
6101 @end smallexample
6103 This warning is enabled by @option{-Wparentheses}.
6105 @item -Wdate-time
6106 @opindex Wdate-time
6107 @opindex Wno-date-time
6108 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6109 are encountered as they might prevent bit-wise-identical reproducible
6110 compilations.
6112 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6113 @opindex Wdelete-incomplete
6114 @opindex Wno-delete-incomplete
6115 Warn when deleting a pointer to incomplete type, which may cause
6116 undefined behavior at runtime.  This warning is enabled by default.
6118 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6119 @opindex Wuseless-cast
6120 @opindex Wno-useless-cast
6121 Warn when an expression is casted to its own type.
6123 @item -Wempty-body
6124 @opindex Wempty-body
6125 @opindex Wno-empty-body
6126 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6127 while} statement.  This warning is also enabled by @option{-Wextra}.
6129 @item -Wenum-compare
6130 @opindex Wenum-compare
6131 @opindex Wno-enum-compare
6132 Warn about a comparison between values of different enumerated types.
6133 In C++ enumerated type mismatches in conditional expressions are also
6134 diagnosed and the warning is enabled by default.  In C this warning is 
6135 enabled by @option{-Wall}.
6137 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6138 @opindex Wextra-semi
6139 @opindex Wno-extra-semi
6140 Warn about redundant semicolon after in-class function definition.
6142 @item -Wjump-misses-init @r{(C, Objective-C only)}
6143 @opindex Wjump-misses-init
6144 @opindex Wno-jump-misses-init
6145 Warn if a @code{goto} statement or a @code{switch} statement jumps
6146 forward across the initialization of a variable, or jumps backward to a
6147 label after the variable has been initialized.  This only warns about
6148 variables that are initialized when they are declared.  This warning is
6149 only supported for C and Objective-C; in C++ this sort of branch is an
6150 error in any case.
6152 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6153 can be disabled with the @option{-Wno-jump-misses-init} option.
6155 @item -Wsign-compare
6156 @opindex Wsign-compare
6157 @opindex Wno-sign-compare
6158 @cindex warning for comparison of signed and unsigned values
6159 @cindex comparison of signed and unsigned values, warning
6160 @cindex signed and unsigned values, comparison warning
6161 Warn when a comparison between signed and unsigned values could produce
6162 an incorrect result when the signed value is converted to unsigned.
6163 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6164 also enabled by @option{-Wextra}.
6166 @item -Wsign-conversion
6167 @opindex Wsign-conversion
6168 @opindex Wno-sign-conversion
6169 Warn for implicit conversions that may change the sign of an integer
6170 value, like assigning a signed integer expression to an unsigned
6171 integer variable. An explicit cast silences the warning. In C, this
6172 option is enabled also by @option{-Wconversion}.
6174 @item -Wfloat-conversion
6175 @opindex Wfloat-conversion
6176 @opindex Wno-float-conversion
6177 Warn for implicit conversions that reduce the precision of a real value.
6178 This includes conversions from real to integer, and from higher precision
6179 real to lower precision real values.  This option is also enabled by
6180 @option{-Wconversion}.
6182 @item -Wno-scalar-storage-order
6183 @opindex -Wno-scalar-storage-order
6184 @opindex -Wscalar-storage-order
6185 Do not warn on suspicious constructs involving reverse scalar storage order.
6187 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6188 @opindex Wsized-deallocation
6189 @opindex Wno-sized-deallocation
6190 Warn about a definition of an unsized deallocation function
6191 @smallexample
6192 void operator delete (void *) noexcept;
6193 void operator delete[] (void *) noexcept;
6194 @end smallexample
6195 without a definition of the corresponding sized deallocation function
6196 @smallexample
6197 void operator delete (void *, std::size_t) noexcept;
6198 void operator delete[] (void *, std::size_t) noexcept;
6199 @end smallexample
6200 or vice versa.  Enabled by @option{-Wextra} along with
6201 @option{-fsized-deallocation}.
6203 @item -Wsizeof-pointer-div
6204 @opindex Wsizeof-pointer-div
6205 @opindex Wno-sizeof-pointer-div
6206 Warn for suspicious divisions of two sizeof expressions that divide
6207 the pointer size by the element size, which is the usual way to compute
6208 the array size but won't work out correctly with pointers.  This warning
6209 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6210 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6212 @item -Wsizeof-pointer-memaccess
6213 @opindex Wsizeof-pointer-memaccess
6214 @opindex Wno-sizeof-pointer-memaccess
6215 Warn for suspicious length parameters to certain string and memory built-in
6216 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
6217 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
6218 but a pointer, and suggests a possible fix, or about
6219 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
6220 @option{-Wall}.
6222 @item -Wsizeof-array-argument
6223 @opindex Wsizeof-array-argument
6224 @opindex Wno-sizeof-array-argument
6225 Warn when the @code{sizeof} operator is applied to a parameter that is
6226 declared as an array in a function definition.  This warning is enabled by
6227 default for C and C++ programs.
6229 @item -Wmemset-elt-size
6230 @opindex Wmemset-elt-size
6231 @opindex Wno-memset-elt-size
6232 Warn for suspicious calls to the @code{memset} built-in function, if the
6233 first argument references an array, and the third argument is a number
6234 equal to the number of elements, but not equal to the size of the array
6235 in memory.  This indicates that the user has omitted a multiplication by
6236 the element size.  This warning is enabled by @option{-Wall}.
6238 @item -Wmemset-transposed-args
6239 @opindex Wmemset-transposed-args
6240 @opindex Wno-memset-transposed-args
6241 Warn for suspicious calls to the @code{memset} built-in function, if the
6242 second argument is not zero and the third argument is zero.  This warns e.g.@
6243 about @code{memset (buf, sizeof buf, 0)} where most probably
6244 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6245 is only emitted if the third argument is literal zero.  If it is some
6246 expression that is folded to zero, a cast of zero to some type, etc., 
6247 it is far less likely that the user has mistakenly exchanged the arguments 
6248 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6250 @item -Waddress
6251 @opindex Waddress
6252 @opindex Wno-address
6253 Warn about suspicious uses of memory addresses. These include using
6254 the address of a function in a conditional expression, such as
6255 @code{void func(void); if (func)}, and comparisons against the memory
6256 address of a string literal, such as @code{if (x == "abc")}.  Such
6257 uses typically indicate a programmer error: the address of a function
6258 always evaluates to true, so their use in a conditional usually
6259 indicate that the programmer forgot the parentheses in a function
6260 call; and comparisons against string literals result in unspecified
6261 behavior and are not portable in C, so they usually indicate that the
6262 programmer intended to use @code{strcmp}.  This warning is enabled by
6263 @option{-Wall}.
6265 @item -Wlogical-op
6266 @opindex Wlogical-op
6267 @opindex Wno-logical-op
6268 Warn about suspicious uses of logical operators in expressions.
6269 This includes using logical operators in contexts where a
6270 bit-wise operator is likely to be expected.  Also warns when
6271 the operands of a logical operator are the same:
6272 @smallexample
6273 extern int a;
6274 if (a < 0 && a < 0) @{ @dots{} @}
6275 @end smallexample
6277 @item -Wlogical-not-parentheses
6278 @opindex Wlogical-not-parentheses
6279 @opindex Wno-logical-not-parentheses
6280 Warn about logical not used on the left hand side operand of a comparison.
6281 This option does not warn if the right operand is considered to be a boolean
6282 expression.  Its purpose is to detect suspicious code like the following:
6283 @smallexample
6284 int a;
6285 @dots{}
6286 if (!a > 1) @{ @dots{} @}
6287 @end smallexample
6289 It is possible to suppress the warning by wrapping the LHS into
6290 parentheses:
6291 @smallexample
6292 if ((!a) > 1) @{ @dots{} @}
6293 @end smallexample
6295 This warning is enabled by @option{-Wall}.
6297 @item -Waggregate-return
6298 @opindex Waggregate-return
6299 @opindex Wno-aggregate-return
6300 Warn if any functions that return structures or unions are defined or
6301 called.  (In languages where you can return an array, this also elicits
6302 a warning.)
6304 @item -Wno-aggressive-loop-optimizations
6305 @opindex Wno-aggressive-loop-optimizations
6306 @opindex Waggressive-loop-optimizations
6307 Warn if in a loop with constant number of iterations the compiler detects
6308 undefined behavior in some statement during one or more of the iterations.
6310 @item -Wno-attributes
6311 @opindex Wno-attributes
6312 @opindex Wattributes
6313 Do not warn if an unexpected @code{__attribute__} is used, such as
6314 unrecognized attributes, function attributes applied to variables,
6315 etc.  This does not stop errors for incorrect use of supported
6316 attributes.
6318 @item -Wno-builtin-declaration-mismatch
6319 @opindex Wno-builtin-declaration-mismatch
6320 @opindex Wbuiltin-declaration-mismatch
6321 Warn if a built-in function is declared with the wrong signature.
6322 This warning is enabled by default.
6324 @item -Wno-builtin-macro-redefined
6325 @opindex Wno-builtin-macro-redefined
6326 @opindex Wbuiltin-macro-redefined
6327 Do not warn if certain built-in macros are redefined.  This suppresses
6328 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6329 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6331 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6332 @opindex Wstrict-prototypes
6333 @opindex Wno-strict-prototypes
6334 Warn if a function is declared or defined without specifying the
6335 argument types.  (An old-style function definition is permitted without
6336 a warning if preceded by a declaration that specifies the argument
6337 types.)
6339 @item -Wold-style-declaration @r{(C and Objective-C only)}
6340 @opindex Wold-style-declaration
6341 @opindex Wno-old-style-declaration
6342 Warn for obsolescent usages, according to the C Standard, in a
6343 declaration. For example, warn if storage-class specifiers like
6344 @code{static} are not the first things in a declaration.  This warning
6345 is also enabled by @option{-Wextra}.
6347 @item -Wold-style-definition @r{(C and Objective-C only)}
6348 @opindex Wold-style-definition
6349 @opindex Wno-old-style-definition
6350 Warn if an old-style function definition is used.  A warning is given
6351 even if there is a previous prototype.
6353 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6354 @opindex Wmissing-parameter-type
6355 @opindex Wno-missing-parameter-type
6356 A function parameter is declared without a type specifier in K&R-style
6357 functions:
6359 @smallexample
6360 void foo(bar) @{ @}
6361 @end smallexample
6363 This warning is also enabled by @option{-Wextra}.
6365 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6366 @opindex Wmissing-prototypes
6367 @opindex Wno-missing-prototypes
6368 Warn if a global function is defined without a previous prototype
6369 declaration.  This warning is issued even if the definition itself
6370 provides a prototype.  Use this option to detect global functions
6371 that do not have a matching prototype declaration in a header file.
6372 This option is not valid for C++ because all function declarations
6373 provide prototypes and a non-matching declaration declares an
6374 overload rather than conflict with an earlier declaration.
6375 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6377 @item -Wmissing-declarations
6378 @opindex Wmissing-declarations
6379 @opindex Wno-missing-declarations
6380 Warn if a global function is defined without a previous declaration.
6381 Do so even if the definition itself provides a prototype.
6382 Use this option to detect global functions that are not declared in
6383 header files.  In C, no warnings are issued for functions with previous
6384 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6385 missing prototypes.  In C++, no warnings are issued for function templates,
6386 or for inline functions, or for functions in anonymous namespaces.
6388 @item -Wmissing-field-initializers
6389 @opindex Wmissing-field-initializers
6390 @opindex Wno-missing-field-initializers
6391 @opindex W
6392 @opindex Wextra
6393 @opindex Wno-extra
6394 Warn if a structure's initializer has some fields missing.  For
6395 example, the following code causes such a warning, because
6396 @code{x.h} is implicitly zero:
6398 @smallexample
6399 struct s @{ int f, g, h; @};
6400 struct s x = @{ 3, 4 @};
6401 @end smallexample
6403 This option does not warn about designated initializers, so the following
6404 modification does not trigger a warning:
6406 @smallexample
6407 struct s @{ int f, g, h; @};
6408 struct s x = @{ .f = 3, .g = 4 @};
6409 @end smallexample
6411 In C this option does not warn about the universal zero initializer
6412 @samp{@{ 0 @}}:
6414 @smallexample
6415 struct s @{ int f, g, h; @};
6416 struct s x = @{ 0 @};
6417 @end smallexample
6419 Likewise, in C++ this option does not warn about the empty @{ @}
6420 initializer, for example:
6422 @smallexample
6423 struct s @{ int f, g, h; @};
6424 s x = @{ @};
6425 @end smallexample
6427 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6428 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6430 @item -Wno-multichar
6431 @opindex Wno-multichar
6432 @opindex Wmultichar
6433 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6434 Usually they indicate a typo in the user's code, as they have
6435 implementation-defined values, and should not be used in portable code.
6437 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6438 @opindex Wnormalized=
6439 @opindex Wnormalized
6440 @opindex Wno-normalized
6441 @cindex NFC
6442 @cindex NFKC
6443 @cindex character set, input normalization
6444 In ISO C and ISO C++, two identifiers are different if they are
6445 different sequences of characters.  However, sometimes when characters
6446 outside the basic ASCII character set are used, you can have two
6447 different character sequences that look the same.  To avoid confusion,
6448 the ISO 10646 standard sets out some @dfn{normalization rules} which
6449 when applied ensure that two sequences that look the same are turned into
6450 the same sequence.  GCC can warn you if you are using identifiers that
6451 have not been normalized; this option controls that warning.
6453 There are four levels of warning supported by GCC@.  The default is
6454 @option{-Wnormalized=nfc}, which warns about any identifier that is
6455 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6456 recommended form for most uses.  It is equivalent to
6457 @option{-Wnormalized}.
6459 Unfortunately, there are some characters allowed in identifiers by
6460 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6461 identifiers.  That is, there's no way to use these symbols in portable
6462 ISO C or C++ and have all your identifiers in NFC@.
6463 @option{-Wnormalized=id} suppresses the warning for these characters.
6464 It is hoped that future versions of the standards involved will correct
6465 this, which is why this option is not the default.
6467 You can switch the warning off for all characters by writing
6468 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6469 only do this if you are using some other normalization scheme (like
6470 ``D''), because otherwise you can easily create bugs that are
6471 literally impossible to see.
6473 Some characters in ISO 10646 have distinct meanings but look identical
6474 in some fonts or display methodologies, especially once formatting has
6475 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6476 LETTER N'', displays just like a regular @code{n} that has been
6477 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6478 normalization scheme to convert all these into a standard form as
6479 well, and GCC warns if your code is not in NFKC if you use
6480 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6481 about every identifier that contains the letter O because it might be
6482 confused with the digit 0, and so is not the default, but may be
6483 useful as a local coding convention if the programming environment 
6484 cannot be fixed to display these characters distinctly.
6486 @item -Wno-deprecated
6487 @opindex Wno-deprecated
6488 @opindex Wdeprecated
6489 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6491 @item -Wno-deprecated-declarations
6492 @opindex Wno-deprecated-declarations
6493 @opindex Wdeprecated-declarations
6494 Do not warn about uses of functions (@pxref{Function Attributes}),
6495 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6496 Attributes}) marked as deprecated by using the @code{deprecated}
6497 attribute.
6499 @item -Wno-overflow
6500 @opindex Wno-overflow
6501 @opindex Woverflow
6502 Do not warn about compile-time overflow in constant expressions.
6504 @item -Wno-odr
6505 @opindex Wno-odr
6506 @opindex Wodr
6507 Warn about One Definition Rule violations during link-time optimization.
6508 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6510 @item -Wopenmp-simd
6511 @opindex Wopenm-simd
6512 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6513 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6514 option can be used to relax the cost model.
6516 @item -Woverride-init @r{(C and Objective-C only)}
6517 @opindex Woverride-init
6518 @opindex Wno-override-init
6519 @opindex W
6520 @opindex Wextra
6521 @opindex Wno-extra
6522 Warn if an initialized field without side effects is overridden when
6523 using designated initializers (@pxref{Designated Inits, , Designated
6524 Initializers}).
6526 This warning is included in @option{-Wextra}.  To get other
6527 @option{-Wextra} warnings without this one, use @option{-Wextra
6528 -Wno-override-init}.
6530 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6531 @opindex Woverride-init-side-effects
6532 @opindex Wno-override-init-side-effects
6533 Warn if an initialized field with side effects is overridden when
6534 using designated initializers (@pxref{Designated Inits, , Designated
6535 Initializers}).  This warning is enabled by default.
6537 @item -Wpacked
6538 @opindex Wpacked
6539 @opindex Wno-packed
6540 Warn if a structure is given the packed attribute, but the packed
6541 attribute has no effect on the layout or size of the structure.
6542 Such structures may be mis-aligned for little benefit.  For
6543 instance, in this code, the variable @code{f.x} in @code{struct bar}
6544 is misaligned even though @code{struct bar} does not itself
6545 have the packed attribute:
6547 @smallexample
6548 @group
6549 struct foo @{
6550   int x;
6551   char a, b, c, d;
6552 @} __attribute__((packed));
6553 struct bar @{
6554   char z;
6555   struct foo f;
6557 @end group
6558 @end smallexample
6560 @item -Wpacked-bitfield-compat
6561 @opindex Wpacked-bitfield-compat
6562 @opindex Wno-packed-bitfield-compat
6563 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6564 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6565 the change can lead to differences in the structure layout.  GCC
6566 informs you when the offset of such a field has changed in GCC 4.4.
6567 For example there is no longer a 4-bit padding between field @code{a}
6568 and @code{b} in this structure:
6570 @smallexample
6571 struct foo
6573   char a:4;
6574   char b:8;
6575 @} __attribute__ ((packed));
6576 @end smallexample
6578 This warning is enabled by default.  Use
6579 @option{-Wno-packed-bitfield-compat} to disable this warning.
6581 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6582 @opindex Wpacked-not-aligned
6583 @opindex Wno-packed-not-aligned
6584 Warn if a structure field with explicitly specified alignment in a
6585 packed struct or union is misaligned.  For example, a warning will
6586 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6587 'struct S' is less than 8}, in this code:
6589 @smallexample
6590 @group
6591 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6592 struct __attribute__ ((packed)) S @{
6593   struct S8 s8;
6595 @end group
6596 @end smallexample
6598 This warning is enabled by @option{-Wall}.
6600 @item -Wpadded
6601 @opindex Wpadded
6602 @opindex Wno-padded
6603 Warn if padding is included in a structure, either to align an element
6604 of the structure or to align the whole structure.  Sometimes when this
6605 happens it is possible to rearrange the fields of the structure to
6606 reduce the padding and so make the structure smaller.
6608 @item -Wredundant-decls
6609 @opindex Wredundant-decls
6610 @opindex Wno-redundant-decls
6611 Warn if anything is declared more than once in the same scope, even in
6612 cases where multiple declaration is valid and changes nothing.
6614 @item -Wrestrict
6615 @opindex Wrestrict
6616 @opindex Wno-restrict
6617 Warn when an argument passed to a restrict-qualified parameter
6618 aliases with another argument.
6620 @item -Wnested-externs @r{(C and Objective-C only)}
6621 @opindex Wnested-externs
6622 @opindex Wno-nested-externs
6623 Warn if an @code{extern} declaration is encountered within a function.
6625 @item -Wno-inherited-variadic-ctor
6626 @opindex Winherited-variadic-ctor
6627 @opindex Wno-inherited-variadic-ctor
6628 Suppress warnings about use of C++11 inheriting constructors when the
6629 base class inherited from has a C variadic constructor; the warning is
6630 on by default because the ellipsis is not inherited.
6632 @item -Winline
6633 @opindex Winline
6634 @opindex Wno-inline
6635 Warn if a function that is declared as inline cannot be inlined.
6636 Even with this option, the compiler does not warn about failures to
6637 inline functions declared in system headers.
6639 The compiler uses a variety of heuristics to determine whether or not
6640 to inline a function.  For example, the compiler takes into account
6641 the size of the function being inlined and the amount of inlining
6642 that has already been done in the current function.  Therefore,
6643 seemingly insignificant changes in the source program can cause the
6644 warnings produced by @option{-Winline} to appear or disappear.
6646 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6647 @opindex Wno-invalid-offsetof
6648 @opindex Winvalid-offsetof
6649 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6650 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6651 to a non-standard-layout type is undefined.  In existing C++ implementations,
6652 however, @code{offsetof} typically gives meaningful results.
6653 This flag is for users who are aware that they are
6654 writing nonportable code and who have deliberately chosen to ignore the
6655 warning about it.
6657 The restrictions on @code{offsetof} may be relaxed in a future version
6658 of the C++ standard.
6660 @item -Wint-in-bool-context
6661 @opindex Wint-in-bool-context
6662 @opindex Wno-int-in-bool-context
6663 Warn for suspicious use of integer values where boolean values are expected,
6664 such as conditional expressions (?:) using non-boolean integer constants in
6665 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6666 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6667 for all kinds of multiplications regardless of the data type.
6668 This warning is enabled by @option{-Wall}.
6670 @item -Wno-int-to-pointer-cast
6671 @opindex Wno-int-to-pointer-cast
6672 @opindex Wint-to-pointer-cast
6673 Suppress warnings from casts to pointer type of an integer of a
6674 different size. In C++, casting to a pointer type of smaller size is
6675 an error. @option{Wint-to-pointer-cast} is enabled by default.
6678 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6679 @opindex Wno-pointer-to-int-cast
6680 @opindex Wpointer-to-int-cast
6681 Suppress warnings from casts from a pointer to an integer type of a
6682 different size.
6684 @item -Winvalid-pch
6685 @opindex Winvalid-pch
6686 @opindex Wno-invalid-pch
6687 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6688 the search path but cannot be used.
6690 @item -Wlong-long
6691 @opindex Wlong-long
6692 @opindex Wno-long-long
6693 Warn if @code{long long} type is used.  This is enabled by either
6694 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6695 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6697 @item -Wvariadic-macros
6698 @opindex Wvariadic-macros
6699 @opindex Wno-variadic-macros
6700 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6701 alternate syntax is used in ISO C99 mode.  This is enabled by either
6702 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6703 messages, use @option{-Wno-variadic-macros}.
6705 @item -Wvarargs
6706 @opindex Wvarargs
6707 @opindex Wno-varargs
6708 Warn upon questionable usage of the macros used to handle variable
6709 arguments like @code{va_start}.  This is default.  To inhibit the
6710 warning messages, use @option{-Wno-varargs}.
6712 @item -Wvector-operation-performance
6713 @opindex Wvector-operation-performance
6714 @opindex Wno-vector-operation-performance
6715 Warn if vector operation is not implemented via SIMD capabilities of the
6716 architecture.  Mainly useful for the performance tuning.
6717 Vector operation can be implemented @code{piecewise}, which means that the
6718 scalar operation is performed on every vector element; 
6719 @code{in parallel}, which means that the vector operation is implemented
6720 using scalars of wider type, which normally is more performance efficient;
6721 and @code{as a single scalar}, which means that vector fits into a
6722 scalar type.
6724 @item -Wno-virtual-move-assign
6725 @opindex Wvirtual-move-assign
6726 @opindex Wno-virtual-move-assign
6727 Suppress warnings about inheriting from a virtual base with a
6728 non-trivial C++11 move assignment operator.  This is dangerous because
6729 if the virtual base is reachable along more than one path, it is
6730 moved multiple times, which can mean both objects end up in the
6731 moved-from state.  If the move assignment operator is written to avoid
6732 moving from a moved-from object, this warning can be disabled.
6734 @item -Wvla
6735 @opindex Wvla
6736 @opindex Wno-vla
6737 Warn if a variable-length array is used in the code.
6738 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6739 the variable-length array.
6741 @item -Wvla-larger-than=@var{n}
6742 If this option is used, the compiler will warn on uses of
6743 variable-length arrays where the size is either unbounded, or bounded
6744 by an argument that can be larger than @var{n} bytes.  This is similar
6745 to how @option{-Walloca-larger-than=@var{n}} works, but with
6746 variable-length arrays.
6748 Note that GCC may optimize small variable-length arrays of a known
6749 value into plain arrays, so this warning may not get triggered for
6750 such arrays.
6752 This warning is not enabled by @option{-Wall}, and is only active when
6753 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6755 See also @option{-Walloca-larger-than=@var{n}}.
6757 @item -Wvolatile-register-var
6758 @opindex Wvolatile-register-var
6759 @opindex Wno-volatile-register-var
6760 Warn if a register variable is declared volatile.  The volatile
6761 modifier does not inhibit all optimizations that may eliminate reads
6762 and/or writes to register variables.  This warning is enabled by
6763 @option{-Wall}.
6765 @item -Wdisabled-optimization
6766 @opindex Wdisabled-optimization
6767 @opindex Wno-disabled-optimization
6768 Warn if a requested optimization pass is disabled.  This warning does
6769 not generally indicate that there is anything wrong with your code; it
6770 merely indicates that GCC's optimizers are unable to handle the code
6771 effectively.  Often, the problem is that your code is too big or too
6772 complex; GCC refuses to optimize programs when the optimization
6773 itself is likely to take inordinate amounts of time.
6775 @item -Wpointer-sign @r{(C and Objective-C only)}
6776 @opindex Wpointer-sign
6777 @opindex Wno-pointer-sign
6778 Warn for pointer argument passing or assignment with different signedness.
6779 This option is only supported for C and Objective-C@.  It is implied by
6780 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6781 @option{-Wno-pointer-sign}.
6783 @item -Wstack-protector
6784 @opindex Wstack-protector
6785 @opindex Wno-stack-protector
6786 This option is only active when @option{-fstack-protector} is active.  It
6787 warns about functions that are not protected against stack smashing.
6789 @item -Woverlength-strings
6790 @opindex Woverlength-strings
6791 @opindex Wno-overlength-strings
6792 Warn about string constants that are longer than the ``minimum
6793 maximum'' length specified in the C standard.  Modern compilers
6794 generally allow string constants that are much longer than the
6795 standard's minimum limit, but very portable programs should avoid
6796 using longer strings.
6798 The limit applies @emph{after} string constant concatenation, and does
6799 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6800 C99, it was raised to 4095.  C++98 does not specify a normative
6801 minimum maximum, so we do not diagnose overlength strings in C++@.
6803 This option is implied by @option{-Wpedantic}, and can be disabled with
6804 @option{-Wno-overlength-strings}.
6806 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6807 @opindex Wunsuffixed-float-constants
6809 Issue a warning for any floating constant that does not have
6810 a suffix.  When used together with @option{-Wsystem-headers} it
6811 warns about such constants in system header files.  This can be useful
6812 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6813 from the decimal floating-point extension to C99.
6815 @item -Wno-designated-init @r{(C and Objective-C only)}
6816 Suppress warnings when a positional initializer is used to initialize
6817 a structure that has been marked with the @code{designated_init}
6818 attribute.
6820 @item -Whsa
6821 Issue a warning when HSAIL cannot be emitted for the compiled function or
6822 OpenMP construct.
6824 @end table
6826 @node Debugging Options
6827 @section Options for Debugging Your Program
6828 @cindex options, debugging
6829 @cindex debugging information options
6831 To tell GCC to emit extra information for use by a debugger, in almost 
6832 all cases you need only to add @option{-g} to your other options.
6834 GCC allows you to use @option{-g} with
6835 @option{-O}.  The shortcuts taken by optimized code may occasionally
6836 be surprising: some variables you declared may not exist
6837 at all; flow of control may briefly move where you did not expect it;
6838 some statements may not be executed because they compute constant
6839 results or their values are already at hand; some statements may
6840 execute in different places because they have been moved out of loops.
6841 Nevertheless it is possible to debug optimized output.  This makes
6842 it reasonable to use the optimizer for programs that might have bugs.
6844 If you are not using some other optimization option, consider
6845 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6846 With no @option{-O} option at all, some compiler passes that collect
6847 information useful for debugging do not run at all, so that
6848 @option{-Og} may result in a better debugging experience.
6850 @table @gcctabopt
6851 @item -g
6852 @opindex g
6853 Produce debugging information in the operating system's native format
6854 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6855 information.
6857 On most systems that use stabs format, @option{-g} enables use of extra
6858 debugging information that only GDB can use; this extra information
6859 makes debugging work better in GDB but probably makes other debuggers
6860 crash or
6861 refuse to read the program.  If you want to control for certain whether
6862 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6863 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6865 @item -ggdb
6866 @opindex ggdb
6867 Produce debugging information for use by GDB@.  This means to use the
6868 most expressive format available (DWARF, stabs, or the native format
6869 if neither of those are supported), including GDB extensions if at all
6870 possible.
6872 @item -gdwarf
6873 @itemx -gdwarf-@var{version}
6874 @opindex gdwarf
6875 Produce debugging information in DWARF format (if that is supported).
6876 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6877 for most targets is 4.  DWARF Version 5 is only experimental.
6879 Note that with DWARF Version 2, some ports require and always
6880 use some non-conflicting DWARF 3 extensions in the unwind tables.
6882 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6883 for maximum benefit.
6885 GCC no longer supports DWARF Version 1, which is substantially
6886 different than Version 2 and later.  For historical reasons, some
6887 other DWARF-related options such as
6888 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6889 in their names, but apply to all currently-supported versions of DWARF.
6891 @item -gstabs
6892 @opindex gstabs
6893 Produce debugging information in stabs format (if that is supported),
6894 without GDB extensions.  This is the format used by DBX on most BSD
6895 systems.  On MIPS, Alpha and System V Release 4 systems this option
6896 produces stabs debugging output that is not understood by DBX or SDB@.
6897 On System V Release 4 systems this option requires the GNU assembler.
6899 @item -gstabs+
6900 @opindex gstabs+
6901 Produce debugging information in stabs format (if that is supported),
6902 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6903 use of these extensions is likely to make other debuggers crash or
6904 refuse to read the program.
6906 @item -gcoff
6907 @opindex gcoff
6908 Produce debugging information in COFF format (if that is supported).
6909 This is the format used by SDB on most System V systems prior to
6910 System V Release 4.
6912 @item -gxcoff
6913 @opindex gxcoff
6914 Produce debugging information in XCOFF format (if that is supported).
6915 This is the format used by the DBX debugger on IBM RS/6000 systems.
6917 @item -gxcoff+
6918 @opindex gxcoff+
6919 Produce debugging information in XCOFF format (if that is supported),
6920 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6921 use of these extensions is likely to make other debuggers crash or
6922 refuse to read the program, and may cause assemblers other than the GNU
6923 assembler (GAS) to fail with an error.
6925 @item -gvms
6926 @opindex gvms
6927 Produce debugging information in Alpha/VMS debug format (if that is
6928 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6930 @item -g@var{level}
6931 @itemx -ggdb@var{level}
6932 @itemx -gstabs@var{level}
6933 @itemx -gcoff@var{level}
6934 @itemx -gxcoff@var{level}
6935 @itemx -gvms@var{level}
6936 Request debugging information and also use @var{level} to specify how
6937 much information.  The default level is 2.
6939 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6940 @option{-g}.
6942 Level 1 produces minimal information, enough for making backtraces in
6943 parts of the program that you don't plan to debug.  This includes
6944 descriptions of functions and external variables, and line number
6945 tables, but no information about local variables.
6947 Level 3 includes extra information, such as all the macro definitions
6948 present in the program.  Some debuggers support macro expansion when
6949 you use @option{-g3}.
6951 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6952 confusion with @option{-gdwarf-@var{level}}.
6953 Instead use an additional @option{-g@var{level}} option to change the
6954 debug level for DWARF.
6956 @item -feliminate-unused-debug-symbols
6957 @opindex feliminate-unused-debug-symbols
6958 Produce debugging information in stabs format (if that is supported),
6959 for only symbols that are actually used.
6961 @item -femit-class-debug-always
6962 @opindex femit-class-debug-always
6963 Instead of emitting debugging information for a C++ class in only one
6964 object file, emit it in all object files using the class.  This option
6965 should be used only with debuggers that are unable to handle the way GCC
6966 normally emits debugging information for classes because using this
6967 option increases the size of debugging information by as much as a
6968 factor of two.
6970 @item -fno-merge-debug-strings
6971 @opindex fmerge-debug-strings
6972 @opindex fno-merge-debug-strings
6973 Direct the linker to not merge together strings in the debugging
6974 information that are identical in different object files.  Merging is
6975 not supported by all assemblers or linkers.  Merging decreases the size
6976 of the debug information in the output file at the cost of increasing
6977 link processing time.  Merging is enabled by default.
6979 @item -fdebug-prefix-map=@var{old}=@var{new}
6980 @opindex fdebug-prefix-map
6981 When compiling files in directory @file{@var{old}}, record debugging
6982 information describing them as in @file{@var{new}} instead.
6984 @item -fvar-tracking
6985 @opindex fvar-tracking
6986 Run variable tracking pass.  It computes where variables are stored at each
6987 position in code.  Better debugging information is then generated
6988 (if the debugging information format supports this information).
6990 It is enabled by default when compiling with optimization (@option{-Os},
6991 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6992 the debug info format supports it.
6994 @item -fvar-tracking-assignments
6995 @opindex fvar-tracking-assignments
6996 @opindex fno-var-tracking-assignments
6997 Annotate assignments to user variables early in the compilation and
6998 attempt to carry the annotations over throughout the compilation all the
6999 way to the end, in an attempt to improve debug information while
7000 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7002 It can be enabled even if var-tracking is disabled, in which case
7003 annotations are created and maintained, but discarded at the end.
7004 By default, this flag is enabled together with @option{-fvar-tracking},
7005 except when selective scheduling is enabled.
7007 @item -gsplit-dwarf
7008 @opindex gsplit-dwarf
7009 Separate as much DWARF debugging information as possible into a
7010 separate output file with the extension @file{.dwo}.  This option allows
7011 the build system to avoid linking files with debug information.  To
7012 be useful, this option requires a debugger capable of reading @file{.dwo}
7013 files.
7015 @item -gpubnames
7016 @opindex gpubnames
7017 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7019 @item -ggnu-pubnames
7020 @opindex ggnu-pubnames
7021 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7022 suitable for conversion into a GDB@ index.  This option is only useful
7023 with a linker that can produce GDB@ index version 7.
7025 @item -fdebug-types-section
7026 @opindex fdebug-types-section
7027 @opindex fno-debug-types-section
7028 When using DWARF Version 4 or higher, type DIEs can be put into
7029 their own @code{.debug_types} section instead of making them part of the
7030 @code{.debug_info} section.  It is more efficient to put them in a separate
7031 comdat sections since the linker can then remove duplicates.
7032 But not all DWARF consumers support @code{.debug_types} sections yet
7033 and on some objects @code{.debug_types} produces larger instead of smaller
7034 debugging information.
7036 @item -grecord-gcc-switches
7037 @item -gno-record-gcc-switches
7038 @opindex grecord-gcc-switches
7039 @opindex gno-record-gcc-switches
7040 This switch causes the command-line options used to invoke the
7041 compiler that may affect code generation to be appended to the
7042 DW_AT_producer attribute in DWARF debugging information.  The options
7043 are concatenated with spaces separating them from each other and from
7044 the compiler version.  
7045 It is enabled by default.
7046 See also @option{-frecord-gcc-switches} for another
7047 way of storing compiler options into the object file.  
7049 @item -gstrict-dwarf
7050 @opindex gstrict-dwarf
7051 Disallow using extensions of later DWARF standard version than selected
7052 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7053 DWARF extensions from later standard versions is allowed.
7055 @item -gno-strict-dwarf
7056 @opindex gno-strict-dwarf
7057 Allow using extensions of later DWARF standard version than selected with
7058 @option{-gdwarf-@var{version}}.
7060 @item -gcolumn-info
7061 @item -gno-column-info
7062 @opindex gcolumn-info
7063 @opindex gno-column-info
7064 Emit location column information into DWARF debugging information, rather
7065 than just file and line.
7066 This option is disabled by default.
7068 @item -gz@r{[}=@var{type}@r{]}
7069 @opindex gz
7070 Produce compressed debug sections in DWARF format, if that is supported.
7071 If @var{type} is not given, the default type depends on the capabilities
7072 of the assembler and linker used.  @var{type} may be one of
7073 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7074 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7075 compression in traditional GNU format).  If the linker doesn't support
7076 writing compressed debug sections, the option is rejected.  Otherwise,
7077 if the assembler does not support them, @option{-gz} is silently ignored
7078 when producing object files.
7080 @item -femit-struct-debug-baseonly
7081 @opindex femit-struct-debug-baseonly
7082 Emit debug information for struct-like types
7083 only when the base name of the compilation source file
7084 matches the base name of file in which the struct is defined.
7086 This option substantially reduces the size of debugging information,
7087 but at significant potential loss in type information to the debugger.
7088 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7089 See @option{-femit-struct-debug-detailed} for more detailed control.
7091 This option works only with DWARF debug output.
7093 @item -femit-struct-debug-reduced
7094 @opindex femit-struct-debug-reduced
7095 Emit debug information for struct-like types
7096 only when the base name of the compilation source file
7097 matches the base name of file in which the type is defined,
7098 unless the struct is a template or defined in a system header.
7100 This option significantly reduces the size of debugging information,
7101 with some potential loss in type information to the debugger.
7102 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7103 See @option{-femit-struct-debug-detailed} for more detailed control.
7105 This option works only with DWARF debug output.
7107 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7108 @opindex femit-struct-debug-detailed
7109 Specify the struct-like types
7110 for which the compiler generates debug information.
7111 The intent is to reduce duplicate struct debug information
7112 between different object files within the same program.
7114 This option is a detailed version of
7115 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7116 which serves for most needs.
7118 A specification has the syntax@*
7119 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7121 The optional first word limits the specification to
7122 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7123 A struct type is used directly when it is the type of a variable, member.
7124 Indirect uses arise through pointers to structs.
7125 That is, when use of an incomplete struct is valid, the use is indirect.
7126 An example is
7127 @samp{struct one direct; struct two * indirect;}.
7129 The optional second word limits the specification to
7130 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7131 Generic structs are a bit complicated to explain.
7132 For C++, these are non-explicit specializations of template classes,
7133 or non-template classes within the above.
7134 Other programming languages have generics,
7135 but @option{-femit-struct-debug-detailed} does not yet implement them.
7137 The third word specifies the source files for those
7138 structs for which the compiler should emit debug information.
7139 The values @samp{none} and @samp{any} have the normal meaning.
7140 The value @samp{base} means that
7141 the base of name of the file in which the type declaration appears
7142 must match the base of the name of the main compilation file.
7143 In practice, this means that when compiling @file{foo.c}, debug information
7144 is generated for types declared in that file and @file{foo.h},
7145 but not other header files.
7146 The value @samp{sys} means those types satisfying @samp{base}
7147 or declared in system or compiler headers.
7149 You may need to experiment to determine the best settings for your application.
7151 The default is @option{-femit-struct-debug-detailed=all}.
7153 This option works only with DWARF debug output.
7155 @item -fno-dwarf2-cfi-asm
7156 @opindex fdwarf2-cfi-asm
7157 @opindex fno-dwarf2-cfi-asm
7158 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7159 instead of using GAS @code{.cfi_*} directives.
7161 @item -fno-eliminate-unused-debug-types
7162 @opindex feliminate-unused-debug-types
7163 @opindex fno-eliminate-unused-debug-types
7164 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7165 output for types that are nowhere used in the source file being compiled.
7166 Sometimes it is useful to have GCC emit debugging
7167 information for all types declared in a compilation
7168 unit, regardless of whether or not they are actually used
7169 in that compilation unit, for example 
7170 if, in the debugger, you want to cast a value to a type that is
7171 not actually used in your program (but is declared).  More often,
7172 however, this results in a significant amount of wasted space.
7173 @end table
7175 @node Optimize Options
7176 @section Options That Control Optimization
7177 @cindex optimize options
7178 @cindex options, optimization
7180 These options control various sorts of optimizations.
7182 Without any optimization option, the compiler's goal is to reduce the
7183 cost of compilation and to make debugging produce the expected
7184 results.  Statements are independent: if you stop the program with a
7185 breakpoint between statements, you can then assign a new value to any
7186 variable or change the program counter to any other statement in the
7187 function and get exactly the results you expect from the source
7188 code.
7190 Turning on optimization flags makes the compiler attempt to improve
7191 the performance and/or code size at the expense of compilation time
7192 and possibly the ability to debug the program.
7194 The compiler performs optimization based on the knowledge it has of the
7195 program.  Compiling multiple files at once to a single output file mode allows
7196 the compiler to use information gained from all of the files when compiling
7197 each of them.
7199 Not all optimizations are controlled directly by a flag.  Only
7200 optimizations that have a flag are listed in this section.
7202 Most optimizations are only enabled if an @option{-O} level is set on
7203 the command line.  Otherwise they are disabled, even if individual
7204 optimization flags are specified.
7206 Depending on the target and how GCC was configured, a slightly different
7207 set of optimizations may be enabled at each @option{-O} level than
7208 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7209 to find out the exact set of optimizations that are enabled at each level.
7210 @xref{Overall Options}, for examples.
7212 @table @gcctabopt
7213 @item -O
7214 @itemx -O1
7215 @opindex O
7216 @opindex O1
7217 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7218 more memory for a large function.
7220 With @option{-O}, the compiler tries to reduce code size and execution
7221 time, without performing any optimizations that take a great deal of
7222 compilation time.
7224 @option{-O} turns on the following optimization flags:
7225 @gccoptlist{
7226 -fauto-inc-dec @gol
7227 -fbranch-count-reg @gol
7228 -fcombine-stack-adjustments @gol
7229 -fcompare-elim @gol
7230 -fcprop-registers @gol
7231 -fdce @gol
7232 -fdefer-pop @gol
7233 -fdelayed-branch @gol
7234 -fdse @gol
7235 -fforward-propagate @gol
7236 -fguess-branch-probability @gol
7237 -fif-conversion2 @gol
7238 -fif-conversion @gol
7239 -finline-functions-called-once @gol
7240 -fipa-pure-const @gol
7241 -fipa-profile @gol
7242 -fipa-reference @gol
7243 -fmerge-constants @gol
7244 -fmove-loop-invariants @gol
7245 -freorder-blocks @gol
7246 -fshrink-wrap @gol
7247 -fshrink-wrap-separate @gol
7248 -fsplit-wide-types @gol
7249 -fssa-backprop @gol
7250 -fssa-phiopt @gol
7251 -ftree-bit-ccp @gol
7252 -ftree-ccp @gol
7253 -ftree-ch @gol
7254 -ftree-coalesce-vars @gol
7255 -ftree-copy-prop @gol
7256 -ftree-dce @gol
7257 -ftree-dominator-opts @gol
7258 -ftree-dse @gol
7259 -ftree-forwprop @gol
7260 -ftree-fre @gol
7261 -ftree-phiprop @gol
7262 -ftree-sink @gol
7263 -ftree-slsr @gol
7264 -ftree-sra @gol
7265 -ftree-pta @gol
7266 -ftree-ter @gol
7267 -funit-at-a-time}
7269 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7270 where doing so does not interfere with debugging.
7272 @item -O2
7273 @opindex O2
7274 Optimize even more.  GCC performs nearly all supported optimizations
7275 that do not involve a space-speed tradeoff.
7276 As compared to @option{-O}, this option increases both compilation time
7277 and the performance of the generated code.
7279 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7280 also turns on the following optimization flags:
7281 @gccoptlist{-fthread-jumps @gol
7282 -falign-functions  -falign-jumps @gol
7283 -falign-loops  -falign-labels @gol
7284 -fcaller-saves @gol
7285 -fcrossjumping @gol
7286 -fcse-follow-jumps  -fcse-skip-blocks @gol
7287 -fdelete-null-pointer-checks @gol
7288 -fdevirtualize -fdevirtualize-speculatively @gol
7289 -fexpensive-optimizations @gol
7290 -fgcse  -fgcse-lm  @gol
7291 -fhoist-adjacent-loads @gol
7292 -finline-small-functions @gol
7293 -findirect-inlining @gol
7294 -fipa-cp @gol
7295 -fipa-bit-cp @gol
7296 -fipa-vrp @gol
7297 -fipa-sra @gol
7298 -fipa-icf @gol
7299 -fisolate-erroneous-paths-dereference @gol
7300 -flra-remat @gol
7301 -foptimize-sibling-calls @gol
7302 -foptimize-strlen @gol
7303 -fpartial-inlining @gol
7304 -fpeephole2 @gol
7305 -freorder-blocks-algorithm=stc @gol
7306 -freorder-blocks-and-partition -freorder-functions @gol
7307 -frerun-cse-after-loop  @gol
7308 -fsched-interblock  -fsched-spec @gol
7309 -fschedule-insns  -fschedule-insns2 @gol
7310 -fstore-merging @gol
7311 -fstrict-aliasing @gol
7312 -ftree-builtin-call-dce @gol
7313 -ftree-switch-conversion -ftree-tail-merge @gol
7314 -fcode-hoisting @gol
7315 -ftree-pre @gol
7316 -ftree-vrp @gol
7317 -fipa-ra}
7319 Please note the warning under @option{-fgcse} about
7320 invoking @option{-O2} on programs that use computed gotos.
7322 @item -O3
7323 @opindex O3
7324 Optimize yet more.  @option{-O3} turns on all optimizations specified
7325 by @option{-O2} and also turns on the following optimization flags:
7326 @gccoptlist{-finline-functions @gol
7327 -funswitch-loops @gol
7328 -fpredictive-commoning @gol
7329 -fgcse-after-reload @gol
7330 -ftree-loop-vectorize @gol
7331 -ftree-loop-distribution @gol
7332 -ftree-loop-distribute-patterns @gol
7333 -fsplit-paths @gol
7334 -ftree-slp-vectorize @gol
7335 -fvect-cost-model @gol
7336 -ftree-partial-pre @gol
7337 -fpeel-loops @gol
7338 -fipa-cp-clone}
7340 @item -O0
7341 @opindex O0
7342 Reduce compilation time and make debugging produce the expected
7343 results.  This is the default.
7345 @item -Os
7346 @opindex Os
7347 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7348 do not typically increase code size.  It also performs further
7349 optimizations designed to reduce code size.
7351 @option{-Os} disables the following optimization flags:
7352 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7353 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7354 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7356 @item -Ofast
7357 @opindex Ofast
7358 Disregard strict standards compliance.  @option{-Ofast} enables all
7359 @option{-O3} optimizations.  It also enables optimizations that are not
7360 valid for all standard-compliant programs.
7361 It turns on @option{-ffast-math} and the Fortran-specific
7362 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7363 specified, and @option{-fno-protect-parens}.
7365 @item -Og
7366 @opindex Og
7367 Optimize debugging experience.  @option{-Og} enables optimizations
7368 that do not interfere with debugging. It should be the optimization
7369 level of choice for the standard edit-compile-debug cycle, offering
7370 a reasonable level of optimization while maintaining fast compilation
7371 and a good debugging experience.
7372 @end table
7374 If you use multiple @option{-O} options, with or without level numbers,
7375 the last such option is the one that is effective.
7377 Options of the form @option{-f@var{flag}} specify machine-independent
7378 flags.  Most flags have both positive and negative forms; the negative
7379 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7380 below, only one of the forms is listed---the one you typically 
7381 use.  You can figure out the other form by either removing @samp{no-}
7382 or adding it.
7384 The following options control specific optimizations.  They are either
7385 activated by @option{-O} options or are related to ones that are.  You
7386 can use the following flags in the rare cases when ``fine-tuning'' of
7387 optimizations to be performed is desired.
7389 @table @gcctabopt
7390 @item -fno-defer-pop
7391 @opindex fno-defer-pop
7392 Always pop the arguments to each function call as soon as that function
7393 returns.  For machines that must pop arguments after a function call,
7394 the compiler normally lets arguments accumulate on the stack for several
7395 function calls and pops them all at once.
7397 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7399 @item -fforward-propagate
7400 @opindex fforward-propagate
7401 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7402 instructions and checks if the result can be simplified.  If loop unrolling
7403 is active, two passes are performed and the second is scheduled after
7404 loop unrolling.
7406 This option is enabled by default at optimization levels @option{-O},
7407 @option{-O2}, @option{-O3}, @option{-Os}.
7409 @item -ffp-contract=@var{style}
7410 @opindex ffp-contract
7411 @option{-ffp-contract=off} disables floating-point expression contraction.
7412 @option{-ffp-contract=fast} enables floating-point expression contraction
7413 such as forming of fused multiply-add operations if the target has
7414 native support for them.
7415 @option{-ffp-contract=on} enables floating-point expression contraction
7416 if allowed by the language standard.  This is currently not implemented
7417 and treated equal to @option{-ffp-contract=off}.
7419 The default is @option{-ffp-contract=fast}.
7421 @item -fomit-frame-pointer
7422 @opindex fomit-frame-pointer
7423 Don't keep the frame pointer in a register for functions that
7424 don't need one.  This avoids the instructions to save, set up and
7425 restore frame pointers; it also makes an extra register available
7426 in many functions.  @strong{It also makes debugging impossible on
7427 some machines.}
7429 On some machines, such as the VAX, this flag has no effect, because
7430 the standard calling sequence automatically handles the frame pointer
7431 and nothing is saved by pretending it doesn't exist.  The
7432 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7433 whether a target machine supports this flag.  @xref{Registers,,Register
7434 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7436 The default setting (when not optimizing for
7437 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7438 @option{-fomit-frame-pointer}.  You can configure GCC with the
7439 @option{--enable-frame-pointer} configure option to change the default.
7441 Note that @option{-fno-omit-frame-pointer} doesn't force a new stack
7442 frame for all functions if it isn't otherwise needed, and hence doesn't
7443 guarantee a new frame pointer for all functions.
7445 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7447 @item -foptimize-sibling-calls
7448 @opindex foptimize-sibling-calls
7449 Optimize sibling and tail recursive calls.
7451 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7453 @item -foptimize-strlen
7454 @opindex foptimize-strlen
7455 Optimize various standard C string functions (e.g. @code{strlen},
7456 @code{strchr} or @code{strcpy}) and
7457 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7459 Enabled at levels @option{-O2}, @option{-O3}.
7461 @item -fno-inline
7462 @opindex fno-inline
7463 Do not expand any functions inline apart from those marked with
7464 the @code{always_inline} attribute.  This is the default when not
7465 optimizing.
7467 Single functions can be exempted from inlining by marking them
7468 with the @code{noinline} attribute.
7470 @item -finline-small-functions
7471 @opindex finline-small-functions
7472 Integrate functions into their callers when their body is smaller than expected
7473 function call code (so overall size of program gets smaller).  The compiler
7474 heuristically decides which functions are simple enough to be worth integrating
7475 in this way.  This inlining applies to all functions, even those not declared
7476 inline.
7478 Enabled at level @option{-O2}.
7480 @item -findirect-inlining
7481 @opindex findirect-inlining
7482 Inline also indirect calls that are discovered to be known at compile
7483 time thanks to previous inlining.  This option has any effect only
7484 when inlining itself is turned on by the @option{-finline-functions}
7485 or @option{-finline-small-functions} options.
7487 Enabled at level @option{-O2}.
7489 @item -finline-functions
7490 @opindex finline-functions
7491 Consider all functions for inlining, even if they are not declared inline.
7492 The compiler heuristically decides which functions are worth integrating
7493 in this way.
7495 If all calls to a given function are integrated, and the function is
7496 declared @code{static}, then the function is normally not output as
7497 assembler code in its own right.
7499 Enabled at level @option{-O3}.
7501 @item -finline-functions-called-once
7502 @opindex finline-functions-called-once
7503 Consider all @code{static} functions called once for inlining into their
7504 caller even if they are not marked @code{inline}.  If a call to a given
7505 function is integrated, then the function is not output as assembler code
7506 in its own right.
7508 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7510 @item -fearly-inlining
7511 @opindex fearly-inlining
7512 Inline functions marked by @code{always_inline} and functions whose body seems
7513 smaller than the function call overhead early before doing
7514 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7515 makes profiling significantly cheaper and usually inlining faster on programs
7516 having large chains of nested wrapper functions.
7518 Enabled by default.
7520 @item -fipa-sra
7521 @opindex fipa-sra
7522 Perform interprocedural scalar replacement of aggregates, removal of
7523 unused parameters and replacement of parameters passed by reference
7524 by parameters passed by value.
7526 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7528 @item -finline-limit=@var{n}
7529 @opindex finline-limit
7530 By default, GCC limits the size of functions that can be inlined.  This flag
7531 allows coarse control of this limit.  @var{n} is the size of functions that
7532 can be inlined in number of pseudo instructions.
7534 Inlining is actually controlled by a number of parameters, which may be
7535 specified individually by using @option{--param @var{name}=@var{value}}.
7536 The @option{-finline-limit=@var{n}} option sets some of these parameters
7537 as follows:
7539 @table @gcctabopt
7540 @item max-inline-insns-single
7541 is set to @var{n}/2.
7542 @item max-inline-insns-auto
7543 is set to @var{n}/2.
7544 @end table
7546 See below for a documentation of the individual
7547 parameters controlling inlining and for the defaults of these parameters.
7549 @emph{Note:} there may be no value to @option{-finline-limit} that results
7550 in default behavior.
7552 @emph{Note:} pseudo instruction represents, in this particular context, an
7553 abstract measurement of function's size.  In no way does it represent a count
7554 of assembly instructions and as such its exact meaning might change from one
7555 release to an another.
7557 @item -fno-keep-inline-dllexport
7558 @opindex fno-keep-inline-dllexport
7559 This is a more fine-grained version of @option{-fkeep-inline-functions},
7560 which applies only to functions that are declared using the @code{dllexport}
7561 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7562 Functions}.
7564 @item -fkeep-inline-functions
7565 @opindex fkeep-inline-functions
7566 In C, emit @code{static} functions that are declared @code{inline}
7567 into the object file, even if the function has been inlined into all
7568 of its callers.  This switch does not affect functions using the
7569 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7570 inline functions into the object file.
7572 @item -fkeep-static-functions
7573 @opindex fkeep-static-functions
7574 Emit @code{static} functions into the object file, even if the function
7575 is never used.
7577 @item -fkeep-static-consts
7578 @opindex fkeep-static-consts
7579 Emit variables declared @code{static const} when optimization isn't turned
7580 on, even if the variables aren't referenced.
7582 GCC enables this option by default.  If you want to force the compiler to
7583 check if a variable is referenced, regardless of whether or not
7584 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7586 @item -fmerge-constants
7587 @opindex fmerge-constants
7588 Attempt to merge identical constants (string constants and floating-point
7589 constants) across compilation units.
7591 This option is the default for optimized compilation if the assembler and
7592 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7593 behavior.
7595 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7597 @item -fmerge-all-constants
7598 @opindex fmerge-all-constants
7599 Attempt to merge identical constants and identical variables.
7601 This option implies @option{-fmerge-constants}.  In addition to
7602 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7603 arrays or initialized constant variables with integral or floating-point
7604 types.  Languages like C or C++ require each variable, including multiple
7605 instances of the same variable in recursive calls, to have distinct locations,
7606 so using this option results in non-conforming
7607 behavior.
7609 @item -fmodulo-sched
7610 @opindex fmodulo-sched
7611 Perform swing modulo scheduling immediately before the first scheduling
7612 pass.  This pass looks at innermost loops and reorders their
7613 instructions by overlapping different iterations.
7615 @item -fmodulo-sched-allow-regmoves
7616 @opindex fmodulo-sched-allow-regmoves
7617 Perform more aggressive SMS-based modulo scheduling with register moves
7618 allowed.  By setting this flag certain anti-dependences edges are
7619 deleted, which triggers the generation of reg-moves based on the
7620 life-range analysis.  This option is effective only with
7621 @option{-fmodulo-sched} enabled.
7623 @item -fno-branch-count-reg
7624 @opindex fno-branch-count-reg
7625 Avoid running a pass scanning for opportunities to use ``decrement and
7626 branch'' instructions on a count register instead of generating sequences
7627 of instructions that decrement a register, compare it against zero, and
7628 then branch based upon the result.  This option is only meaningful on
7629 architectures that support such instructions, which include x86, PowerPC,
7630 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7631 doesn't remove the decrement and branch instructions from the generated
7632 instruction stream introduced by other optimization passes.
7634 Enabled by default at @option{-O1} and higher.
7636 The default is @option{-fbranch-count-reg}.
7638 @item -fno-function-cse
7639 @opindex fno-function-cse
7640 Do not put function addresses in registers; make each instruction that
7641 calls a constant function contain the function's address explicitly.
7643 This option results in less efficient code, but some strange hacks
7644 that alter the assembler output may be confused by the optimizations
7645 performed when this option is not used.
7647 The default is @option{-ffunction-cse}
7649 @item -fno-zero-initialized-in-bss
7650 @opindex fno-zero-initialized-in-bss
7651 If the target supports a BSS section, GCC by default puts variables that
7652 are initialized to zero into BSS@.  This can save space in the resulting
7653 code.
7655 This option turns off this behavior because some programs explicitly
7656 rely on variables going to the data section---e.g., so that the
7657 resulting executable can find the beginning of that section and/or make
7658 assumptions based on that.
7660 The default is @option{-fzero-initialized-in-bss}.
7662 @item -fthread-jumps
7663 @opindex fthread-jumps
7664 Perform optimizations that check to see if a jump branches to a
7665 location where another comparison subsumed by the first is found.  If
7666 so, the first branch is redirected to either the destination of the
7667 second branch or a point immediately following it, depending on whether
7668 the condition is known to be true or false.
7670 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7672 @item -fsplit-wide-types
7673 @opindex fsplit-wide-types
7674 When using a type that occupies multiple registers, such as @code{long
7675 long} on a 32-bit system, split the registers apart and allocate them
7676 independently.  This normally generates better code for those types,
7677 but may make debugging more difficult.
7679 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7680 @option{-Os}.
7682 @item -fcse-follow-jumps
7683 @opindex fcse-follow-jumps
7684 In common subexpression elimination (CSE), scan through jump instructions
7685 when the target of the jump is not reached by any other path.  For
7686 example, when CSE encounters an @code{if} statement with an
7687 @code{else} clause, CSE follows the jump when the condition
7688 tested is false.
7690 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7692 @item -fcse-skip-blocks
7693 @opindex fcse-skip-blocks
7694 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7695 follow jumps that conditionally skip over blocks.  When CSE
7696 encounters a simple @code{if} statement with no else clause,
7697 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7698 body of the @code{if}.
7700 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7702 @item -frerun-cse-after-loop
7703 @opindex frerun-cse-after-loop
7704 Re-run common subexpression elimination after loop optimizations are
7705 performed.
7707 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7709 @item -fgcse
7710 @opindex fgcse
7711 Perform a global common subexpression elimination pass.
7712 This pass also performs global constant and copy propagation.
7714 @emph{Note:} When compiling a program using computed gotos, a GCC
7715 extension, you may get better run-time performance if you disable
7716 the global common subexpression elimination pass by adding
7717 @option{-fno-gcse} to the command line.
7719 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7721 @item -fgcse-lm
7722 @opindex fgcse-lm
7723 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7724 attempts to move loads that are only killed by stores into themselves.  This
7725 allows a loop containing a load/store sequence to be changed to a load outside
7726 the loop, and a copy/store within the loop.
7728 Enabled by default when @option{-fgcse} is enabled.
7730 @item -fgcse-sm
7731 @opindex fgcse-sm
7732 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7733 global common subexpression elimination.  This pass attempts to move
7734 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7735 loops containing a load/store sequence can be changed to a load before
7736 the loop and a store after the loop.
7738 Not enabled at any optimization level.
7740 @item -fgcse-las
7741 @opindex fgcse-las
7742 When @option{-fgcse-las} is enabled, the global common subexpression
7743 elimination pass eliminates redundant loads that come after stores to the
7744 same memory location (both partial and full redundancies).
7746 Not enabled at any optimization level.
7748 @item -fgcse-after-reload
7749 @opindex fgcse-after-reload
7750 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7751 pass is performed after reload.  The purpose of this pass is to clean up
7752 redundant spilling.
7754 @item -faggressive-loop-optimizations
7755 @opindex faggressive-loop-optimizations
7756 This option tells the loop optimizer to use language constraints to
7757 derive bounds for the number of iterations of a loop.  This assumes that
7758 loop code does not invoke undefined behavior by for example causing signed
7759 integer overflows or out-of-bound array accesses.  The bounds for the
7760 number of iterations of a loop are used to guide loop unrolling and peeling
7761 and loop exit test optimizations.
7762 This option is enabled by default.
7764 @item -funconstrained-commons
7765 @opindex funconstrained-commons
7766 This option tells the compiler that variables declared in common blocks
7767 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7768 prevents certain optimizations that depend on knowing the array bounds.
7770 @item -fcrossjumping
7771 @opindex fcrossjumping
7772 Perform cross-jumping transformation.
7773 This transformation unifies equivalent code and saves code size.  The
7774 resulting code may or may not perform better than without cross-jumping.
7776 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7778 @item -fauto-inc-dec
7779 @opindex fauto-inc-dec
7780 Combine increments or decrements of addresses with memory accesses.
7781 This pass is always skipped on architectures that do not have
7782 instructions to support this.  Enabled by default at @option{-O} and
7783 higher on architectures that support this.
7785 @item -fdce
7786 @opindex fdce
7787 Perform dead code elimination (DCE) on RTL@.
7788 Enabled by default at @option{-O} and higher.
7790 @item -fdse
7791 @opindex fdse
7792 Perform dead store elimination (DSE) on RTL@.
7793 Enabled by default at @option{-O} and higher.
7795 @item -fif-conversion
7796 @opindex fif-conversion
7797 Attempt to transform conditional jumps into branch-less equivalents.  This
7798 includes use of conditional moves, min, max, set flags and abs instructions, and
7799 some tricks doable by standard arithmetics.  The use of conditional execution
7800 on chips where it is available is controlled by @option{-fif-conversion2}.
7802 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7804 @item -fif-conversion2
7805 @opindex fif-conversion2
7806 Use conditional execution (where available) to transform conditional jumps into
7807 branch-less equivalents.
7809 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7811 @item -fdeclone-ctor-dtor
7812 @opindex fdeclone-ctor-dtor
7813 The C++ ABI requires multiple entry points for constructors and
7814 destructors: one for a base subobject, one for a complete object, and
7815 one for a virtual destructor that calls operator delete afterwards.
7816 For a hierarchy with virtual bases, the base and complete variants are
7817 clones, which means two copies of the function.  With this option, the
7818 base and complete variants are changed to be thunks that call a common
7819 implementation.
7821 Enabled by @option{-Os}.
7823 @item -fdelete-null-pointer-checks
7824 @opindex fdelete-null-pointer-checks
7825 Assume that programs cannot safely dereference null pointers, and that
7826 no code or data element resides at address zero.
7827 This option enables simple constant
7828 folding optimizations at all optimization levels.  In addition, other
7829 optimization passes in GCC use this flag to control global dataflow
7830 analyses that eliminate useless checks for null pointers; these assume
7831 that a memory access to address zero always results in a trap, so
7832 that if a pointer is checked after it has already been dereferenced,
7833 it cannot be null.
7835 Note however that in some environments this assumption is not true.
7836 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7837 for programs that depend on that behavior.
7839 This option is enabled by default on most targets.  On Nios II ELF, it
7840 defaults to off.  On AVR and CR16, this option is completely disabled.  
7842 Passes that use the dataflow information
7843 are enabled independently at different optimization levels.
7845 @item -fdevirtualize
7846 @opindex fdevirtualize
7847 Attempt to convert calls to virtual functions to direct calls.  This
7848 is done both within a procedure and interprocedurally as part of
7849 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7850 propagation (@option{-fipa-cp}).
7851 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7853 @item -fdevirtualize-speculatively
7854 @opindex fdevirtualize-speculatively
7855 Attempt to convert calls to virtual functions to speculative direct calls.
7856 Based on the analysis of the type inheritance graph, determine for a given call
7857 the set of likely targets. If the set is small, preferably of size 1, change
7858 the call into a conditional deciding between direct and indirect calls.  The
7859 speculative calls enable more optimizations, such as inlining.  When they seem
7860 useless after further optimization, they are converted back into original form.
7862 @item -fdevirtualize-at-ltrans
7863 @opindex fdevirtualize-at-ltrans
7864 Stream extra information needed for aggressive devirtualization when running
7865 the link-time optimizer in local transformation mode.  
7866 This option enables more devirtualization but
7867 significantly increases the size of streamed data. For this reason it is
7868 disabled by default.
7870 @item -fexpensive-optimizations
7871 @opindex fexpensive-optimizations
7872 Perform a number of minor optimizations that are relatively expensive.
7874 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7876 @item -free
7877 @opindex free
7878 Attempt to remove redundant extension instructions.  This is especially
7879 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7880 registers after writing to their lower 32-bit half.
7882 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7883 @option{-O3}, @option{-Os}.
7885 @item -fno-lifetime-dse
7886 @opindex fno-lifetime-dse
7887 In C++ the value of an object is only affected by changes within its
7888 lifetime: when the constructor begins, the object has an indeterminate
7889 value, and any changes during the lifetime of the object are dead when
7890 the object is destroyed.  Normally dead store elimination will take
7891 advantage of this; if your code relies on the value of the object
7892 storage persisting beyond the lifetime of the object, you can use this
7893 flag to disable this optimization.  To preserve stores before the
7894 constructor starts (e.g. because your operator new clears the object
7895 storage) but still treat the object as dead after the destructor you,
7896 can use @option{-flifetime-dse=1}.  The default behavior can be
7897 explicitly selected with @option{-flifetime-dse=2}.
7898 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7900 @item -flive-range-shrinkage
7901 @opindex flive-range-shrinkage
7902 Attempt to decrease register pressure through register live range
7903 shrinkage.  This is helpful for fast processors with small or moderate
7904 size register sets.
7906 @item -fira-algorithm=@var{algorithm}
7907 @opindex fira-algorithm
7908 Use the specified coloring algorithm for the integrated register
7909 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7910 specifies Chow's priority coloring, or @samp{CB}, which specifies
7911 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7912 for all architectures, but for those targets that do support it, it is
7913 the default because it generates better code.
7915 @item -fira-region=@var{region}
7916 @opindex fira-region
7917 Use specified regions for the integrated register allocator.  The
7918 @var{region} argument should be one of the following:
7920 @table @samp
7922 @item all
7923 Use all loops as register allocation regions.
7924 This can give the best results for machines with a small and/or
7925 irregular register set.
7927 @item mixed
7928 Use all loops except for loops with small register pressure 
7929 as the regions.  This value usually gives
7930 the best results in most cases and for most architectures,
7931 and is enabled by default when compiling with optimization for speed
7932 (@option{-O}, @option{-O2}, @dots{}).
7934 @item one
7935 Use all functions as a single region.  
7936 This typically results in the smallest code size, and is enabled by default for
7937 @option{-Os} or @option{-O0}.
7939 @end table
7941 @item -fira-hoist-pressure
7942 @opindex fira-hoist-pressure
7943 Use IRA to evaluate register pressure in the code hoisting pass for
7944 decisions to hoist expressions.  This option usually results in smaller
7945 code, but it can slow the compiler down.
7947 This option is enabled at level @option{-Os} for all targets.
7949 @item -fira-loop-pressure
7950 @opindex fira-loop-pressure
7951 Use IRA to evaluate register pressure in loops for decisions to move
7952 loop invariants.  This option usually results in generation
7953 of faster and smaller code on machines with large register files (>= 32
7954 registers), but it can slow the compiler down.
7956 This option is enabled at level @option{-O3} for some targets.
7958 @item -fno-ira-share-save-slots
7959 @opindex fno-ira-share-save-slots
7960 Disable sharing of stack slots used for saving call-used hard
7961 registers living through a call.  Each hard register gets a
7962 separate stack slot, and as a result function stack frames are
7963 larger.
7965 @item -fno-ira-share-spill-slots
7966 @opindex fno-ira-share-spill-slots
7967 Disable sharing of stack slots allocated for pseudo-registers.  Each
7968 pseudo-register that does not get a hard register gets a separate
7969 stack slot, and as a result function stack frames are larger.
7971 @item -flra-remat
7972 @opindex flra-remat
7973 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7974 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7975 values if it is profitable.
7977 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7979 @item -fdelayed-branch
7980 @opindex fdelayed-branch
7981 If supported for the target machine, attempt to reorder instructions
7982 to exploit instruction slots available after delayed branch
7983 instructions.
7985 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7987 @item -fschedule-insns
7988 @opindex fschedule-insns
7989 If supported for the target machine, attempt to reorder instructions to
7990 eliminate execution stalls due to required data being unavailable.  This
7991 helps machines that have slow floating point or memory load instructions
7992 by allowing other instructions to be issued until the result of the load
7993 or floating-point instruction is required.
7995 Enabled at levels @option{-O2}, @option{-O3}.
7997 @item -fschedule-insns2
7998 @opindex fschedule-insns2
7999 Similar to @option{-fschedule-insns}, but requests an additional pass of
8000 instruction scheduling after register allocation has been done.  This is
8001 especially useful on machines with a relatively small number of
8002 registers and where memory load instructions take more than one cycle.
8004 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8006 @item -fno-sched-interblock
8007 @opindex fno-sched-interblock
8008 Don't schedule instructions across basic blocks.  This is normally
8009 enabled by default when scheduling before register allocation, i.e.@:
8010 with @option{-fschedule-insns} or at @option{-O2} or higher.
8012 @item -fno-sched-spec
8013 @opindex fno-sched-spec
8014 Don't allow speculative motion of non-load instructions.  This is normally
8015 enabled by default when scheduling before register allocation, i.e.@:
8016 with @option{-fschedule-insns} or at @option{-O2} or higher.
8018 @item -fsched-pressure
8019 @opindex fsched-pressure
8020 Enable register pressure sensitive insn scheduling before register
8021 allocation.  This only makes sense when scheduling before register
8022 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8023 @option{-O2} or higher.  Usage of this option can improve the
8024 generated code and decrease its size by preventing register pressure
8025 increase above the number of available hard registers and subsequent
8026 spills in register allocation.
8028 @item -fsched-spec-load
8029 @opindex fsched-spec-load
8030 Allow speculative motion of some load instructions.  This only makes
8031 sense when scheduling before register allocation, i.e.@: with
8032 @option{-fschedule-insns} or at @option{-O2} or higher.
8034 @item -fsched-spec-load-dangerous
8035 @opindex fsched-spec-load-dangerous
8036 Allow speculative motion of more load instructions.  This only makes
8037 sense when scheduling before register allocation, i.e.@: with
8038 @option{-fschedule-insns} or at @option{-O2} or higher.
8040 @item -fsched-stalled-insns
8041 @itemx -fsched-stalled-insns=@var{n}
8042 @opindex fsched-stalled-insns
8043 Define how many insns (if any) can be moved prematurely from the queue
8044 of stalled insns into the ready list during the second scheduling pass.
8045 @option{-fno-sched-stalled-insns} means that no insns are moved
8046 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8047 on how many queued insns can be moved prematurely.
8048 @option{-fsched-stalled-insns} without a value is equivalent to
8049 @option{-fsched-stalled-insns=1}.
8051 @item -fsched-stalled-insns-dep
8052 @itemx -fsched-stalled-insns-dep=@var{n}
8053 @opindex fsched-stalled-insns-dep
8054 Define how many insn groups (cycles) are examined for a dependency
8055 on a stalled insn that is a candidate for premature removal from the queue
8056 of stalled insns.  This has an effect only during the second scheduling pass,
8057 and only if @option{-fsched-stalled-insns} is used.
8058 @option{-fno-sched-stalled-insns-dep} is equivalent to
8059 @option{-fsched-stalled-insns-dep=0}.
8060 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8061 @option{-fsched-stalled-insns-dep=1}.
8063 @item -fsched2-use-superblocks
8064 @opindex fsched2-use-superblocks
8065 When scheduling after register allocation, use superblock scheduling.
8066 This allows motion across basic block boundaries,
8067 resulting in faster schedules.  This option is experimental, as not all machine
8068 descriptions used by GCC model the CPU closely enough to avoid unreliable
8069 results from the algorithm.
8071 This only makes sense when scheduling after register allocation, i.e.@: with
8072 @option{-fschedule-insns2} or at @option{-O2} or higher.
8074 @item -fsched-group-heuristic
8075 @opindex fsched-group-heuristic
8076 Enable the group heuristic in the scheduler.  This heuristic favors
8077 the instruction that belongs to a schedule group.  This is enabled
8078 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8079 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8081 @item -fsched-critical-path-heuristic
8082 @opindex fsched-critical-path-heuristic
8083 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8084 instructions on the critical path.  This is enabled by default when
8085 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8086 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8088 @item -fsched-spec-insn-heuristic
8089 @opindex fsched-spec-insn-heuristic
8090 Enable the speculative instruction heuristic in the scheduler.  This
8091 heuristic favors speculative instructions with greater dependency weakness.
8092 This is enabled by default when scheduling is enabled, i.e.@:
8093 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8094 or at @option{-O2} or higher.
8096 @item -fsched-rank-heuristic
8097 @opindex fsched-rank-heuristic
8098 Enable the rank heuristic in the scheduler.  This heuristic favors
8099 the instruction belonging to a basic block with greater size or frequency.
8100 This is enabled by default when scheduling is enabled, i.e.@:
8101 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8102 at @option{-O2} or higher.
8104 @item -fsched-last-insn-heuristic
8105 @opindex fsched-last-insn-heuristic
8106 Enable the last-instruction heuristic in the scheduler.  This heuristic
8107 favors the instruction that is less dependent on the last instruction
8108 scheduled.  This is enabled by default when scheduling is enabled,
8109 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8110 at @option{-O2} or higher.
8112 @item -fsched-dep-count-heuristic
8113 @opindex fsched-dep-count-heuristic
8114 Enable the dependent-count heuristic in the scheduler.  This heuristic
8115 favors the instruction that has more instructions depending on it.
8116 This is enabled by default when scheduling is enabled, i.e.@:
8117 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8118 at @option{-O2} or higher.
8120 @item -freschedule-modulo-scheduled-loops
8121 @opindex freschedule-modulo-scheduled-loops
8122 Modulo scheduling is performed before traditional scheduling.  If a loop
8123 is modulo scheduled, later scheduling passes may change its schedule.  
8124 Use this option to control that behavior.
8126 @item -fselective-scheduling
8127 @opindex fselective-scheduling
8128 Schedule instructions using selective scheduling algorithm.  Selective
8129 scheduling runs instead of the first scheduler pass.
8131 @item -fselective-scheduling2
8132 @opindex fselective-scheduling2
8133 Schedule instructions using selective scheduling algorithm.  Selective
8134 scheduling runs instead of the second scheduler pass.
8136 @item -fsel-sched-pipelining
8137 @opindex fsel-sched-pipelining
8138 Enable software pipelining of innermost loops during selective scheduling.
8139 This option has no effect unless one of @option{-fselective-scheduling} or
8140 @option{-fselective-scheduling2} is turned on.
8142 @item -fsel-sched-pipelining-outer-loops
8143 @opindex fsel-sched-pipelining-outer-loops
8144 When pipelining loops during selective scheduling, also pipeline outer loops.
8145 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8147 @item -fsemantic-interposition
8148 @opindex fsemantic-interposition
8149 Some object formats, like ELF, allow interposing of symbols by the 
8150 dynamic linker.
8151 This means that for symbols exported from the DSO, the compiler cannot perform
8152 interprocedural propagation, inlining and other optimizations in anticipation
8153 that the function or variable in question may change. While this feature is
8154 useful, for example, to rewrite memory allocation functions by a debugging
8155 implementation, it is expensive in the terms of code quality.
8156 With @option{-fno-semantic-interposition} the compiler assumes that 
8157 if interposition happens for functions the overwriting function will have 
8158 precisely the same semantics (and side effects). 
8159 Similarly if interposition happens
8160 for variables, the constructor of the variable will be the same. The flag
8161 has no effect for functions explicitly declared inline 
8162 (where it is never allowed for interposition to change semantics) 
8163 and for symbols explicitly declared weak.
8165 @item -fshrink-wrap
8166 @opindex fshrink-wrap
8167 Emit function prologues only before parts of the function that need it,
8168 rather than at the top of the function.  This flag is enabled by default at
8169 @option{-O} and higher.
8171 @item -fshrink-wrap-separate
8172 @opindex fshrink-wrap-separate
8173 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8174 those parts are only executed when needed.
8175 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8176 is also turned on and the target supports this.
8178 @item -fcaller-saves
8179 @opindex fcaller-saves
8180 Enable allocation of values to registers that are clobbered by
8181 function calls, by emitting extra instructions to save and restore the
8182 registers around such calls.  Such allocation is done only when it
8183 seems to result in better code.
8185 This option is always enabled by default on certain machines, usually
8186 those which have no call-preserved registers to use instead.
8188 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8190 @item -fcombine-stack-adjustments
8191 @opindex fcombine-stack-adjustments
8192 Tracks stack adjustments (pushes and pops) and stack memory references
8193 and then tries to find ways to combine them.
8195 Enabled by default at @option{-O1} and higher.
8197 @item -fipa-ra
8198 @opindex fipa-ra
8199 Use caller save registers for allocation if those registers are not used by
8200 any called function.  In that case it is not necessary to save and restore
8201 them around calls.  This is only possible if called functions are part of
8202 same compilation unit as current function and they are compiled before it.
8204 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8205 is disabled if generated code will be instrumented for profiling
8206 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8207 exactly (this happens on targets that do not expose prologues
8208 and epilogues in RTL).
8210 @item -fconserve-stack
8211 @opindex fconserve-stack
8212 Attempt to minimize stack usage.  The compiler attempts to use less
8213 stack space, even if that makes the program slower.  This option
8214 implies setting the @option{large-stack-frame} parameter to 100
8215 and the @option{large-stack-frame-growth} parameter to 400.
8217 @item -ftree-reassoc
8218 @opindex ftree-reassoc
8219 Perform reassociation on trees.  This flag is enabled by default
8220 at @option{-O} and higher.
8222 @item -fcode-hoisting
8223 @opindex fcode-hoisting
8224 Perform code hoisting.  Code hoisting tries to move the
8225 evaluation of expressions executed on all paths to the function exit
8226 as early as possible.  This is especially useful as a code size
8227 optimization, but it often helps for code speed as well.
8228 This flag is enabled by default at @option{-O2} and higher.
8230 @item -ftree-pre
8231 @opindex ftree-pre
8232 Perform partial redundancy elimination (PRE) on trees.  This flag is
8233 enabled by default at @option{-O2} and @option{-O3}.
8235 @item -ftree-partial-pre
8236 @opindex ftree-partial-pre
8237 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8238 enabled by default at @option{-O3}.
8240 @item -ftree-forwprop
8241 @opindex ftree-forwprop
8242 Perform forward propagation on trees.  This flag is enabled by default
8243 at @option{-O} and higher.
8245 @item -ftree-fre
8246 @opindex ftree-fre
8247 Perform full redundancy elimination (FRE) on trees.  The difference
8248 between FRE and PRE is that FRE only considers expressions
8249 that are computed on all paths leading to the redundant computation.
8250 This analysis is faster than PRE, though it exposes fewer redundancies.
8251 This flag is enabled by default at @option{-O} and higher.
8253 @item -ftree-phiprop
8254 @opindex ftree-phiprop
8255 Perform hoisting of loads from conditional pointers on trees.  This
8256 pass is enabled by default at @option{-O} and higher.
8258 @item -fhoist-adjacent-loads
8259 @opindex fhoist-adjacent-loads
8260 Speculatively hoist loads from both branches of an if-then-else if the
8261 loads are from adjacent locations in the same structure and the target
8262 architecture has a conditional move instruction.  This flag is enabled
8263 by default at @option{-O2} and higher.
8265 @item -ftree-copy-prop
8266 @opindex ftree-copy-prop
8267 Perform copy propagation on trees.  This pass eliminates unnecessary
8268 copy operations.  This flag is enabled by default at @option{-O} and
8269 higher.
8271 @item -fipa-pure-const
8272 @opindex fipa-pure-const
8273 Discover which functions are pure or constant.
8274 Enabled by default at @option{-O} and higher.
8276 @item -fipa-reference
8277 @opindex fipa-reference
8278 Discover which static variables do not escape the
8279 compilation unit.
8280 Enabled by default at @option{-O} and higher.
8282 @item -fipa-pta
8283 @opindex fipa-pta
8284 Perform interprocedural pointer analysis and interprocedural modification
8285 and reference analysis.  This option can cause excessive memory and
8286 compile-time usage on large compilation units.  It is not enabled by
8287 default at any optimization level.
8289 @item -fipa-profile
8290 @opindex fipa-profile
8291 Perform interprocedural profile propagation.  The functions called only from
8292 cold functions are marked as cold. Also functions executed once (such as
8293 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8294 functions and loop less parts of functions executed once are then optimized for
8295 size.
8296 Enabled by default at @option{-O} and higher.
8298 @item -fipa-cp
8299 @opindex fipa-cp
8300 Perform interprocedural constant propagation.
8301 This optimization analyzes the program to determine when values passed
8302 to functions are constants and then optimizes accordingly.
8303 This optimization can substantially increase performance
8304 if the application has constants passed to functions.
8305 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8307 @item -fipa-cp-clone
8308 @opindex fipa-cp-clone
8309 Perform function cloning to make interprocedural constant propagation stronger.
8310 When enabled, interprocedural constant propagation performs function cloning
8311 when externally visible function can be called with constant arguments.
8312 Because this optimization can create multiple copies of functions,
8313 it may significantly increase code size
8314 (see @option{--param ipcp-unit-growth=@var{value}}).
8315 This flag is enabled by default at @option{-O3}.
8317 @item -fipa-bit-cp
8318 @opindex -fipa-bit-cp
8319 When enabled, perform interprocedural bitwise constant
8320 propagation. This flag is enabled by default at @option{-O2}. It
8321 requires that @option{-fipa-cp} is enabled.
8323 @item -fipa-vrp
8324 @opindex -fipa-vrp
8325 When enabled, perform interprocedural propagation of value
8326 ranges. This flag is enabled by default at @option{-O2}. It requires
8327 that @option{-fipa-cp} is enabled.
8329 @item -fipa-icf
8330 @opindex fipa-icf
8331 Perform Identical Code Folding for functions and read-only variables.
8332 The optimization reduces code size and may disturb unwind stacks by replacing
8333 a function by equivalent one with a different name. The optimization works
8334 more effectively with link-time optimization enabled.
8336 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8337 works on different levels and thus the optimizations are not same - there are
8338 equivalences that are found only by GCC and equivalences found only by Gold.
8340 This flag is enabled by default at @option{-O2} and @option{-Os}.
8342 @item -fisolate-erroneous-paths-dereference
8343 @opindex fisolate-erroneous-paths-dereference
8344 Detect paths that trigger erroneous or undefined behavior due to
8345 dereferencing a null pointer.  Isolate those paths from the main control
8346 flow and turn the statement with erroneous or undefined behavior into a trap.
8347 This flag is enabled by default at @option{-O2} and higher and depends on
8348 @option{-fdelete-null-pointer-checks} also being enabled.
8350 @item -fisolate-erroneous-paths-attribute
8351 @opindex fisolate-erroneous-paths-attribute
8352 Detect paths that trigger erroneous or undefined behavior due a null value
8353 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8354 attribute.  Isolate those paths from the main control flow and turn the
8355 statement with erroneous or undefined behavior into a trap.  This is not
8356 currently enabled, but may be enabled by @option{-O2} in the future.
8358 @item -ftree-sink
8359 @opindex ftree-sink
8360 Perform forward store motion on trees.  This flag is
8361 enabled by default at @option{-O} and higher.
8363 @item -ftree-bit-ccp
8364 @opindex ftree-bit-ccp
8365 Perform sparse conditional bit constant propagation on trees and propagate
8366 pointer alignment information.
8367 This pass only operates on local scalar variables and is enabled by default
8368 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8370 @item -ftree-ccp
8371 @opindex ftree-ccp
8372 Perform sparse conditional constant propagation (CCP) on trees.  This
8373 pass only operates on local scalar variables and is enabled by default
8374 at @option{-O} and higher.
8376 @item -fssa-backprop
8377 @opindex fssa-backprop
8378 Propagate information about uses of a value up the definition chain
8379 in order to simplify the definitions.  For example, this pass strips
8380 sign operations if the sign of a value never matters.  The flag is
8381 enabled by default at @option{-O} and higher.
8383 @item -fssa-phiopt
8384 @opindex fssa-phiopt
8385 Perform pattern matching on SSA PHI nodes to optimize conditional
8386 code.  This pass is enabled by default at @option{-O} and higher.
8388 @item -ftree-switch-conversion
8389 @opindex ftree-switch-conversion
8390 Perform conversion of simple initializations in a switch to
8391 initializations from a scalar array.  This flag is enabled by default
8392 at @option{-O2} and higher.
8394 @item -ftree-tail-merge
8395 @opindex ftree-tail-merge
8396 Look for identical code sequences.  When found, replace one with a jump to the
8397 other.  This optimization is known as tail merging or cross jumping.  This flag
8398 is enabled by default at @option{-O2} and higher.  The compilation time
8399 in this pass can
8400 be limited using @option{max-tail-merge-comparisons} parameter and
8401 @option{max-tail-merge-iterations} parameter.
8403 @item -ftree-dce
8404 @opindex ftree-dce
8405 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8406 default at @option{-O} and higher.
8408 @item -ftree-builtin-call-dce
8409 @opindex ftree-builtin-call-dce
8410 Perform conditional dead code elimination (DCE) for calls to built-in functions
8411 that may set @code{errno} but are otherwise side-effect free.  This flag is
8412 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8413 specified.
8415 @item -ftree-dominator-opts
8416 @opindex ftree-dominator-opts
8417 Perform a variety of simple scalar cleanups (constant/copy
8418 propagation, redundancy elimination, range propagation and expression
8419 simplification) based on a dominator tree traversal.  This also
8420 performs jump threading (to reduce jumps to jumps). This flag is
8421 enabled by default at @option{-O} and higher.
8423 @item -ftree-dse
8424 @opindex ftree-dse
8425 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8426 a memory location that is later overwritten by another store without
8427 any intervening loads.  In this case the earlier store can be deleted.  This
8428 flag is enabled by default at @option{-O} and higher.
8430 @item -ftree-ch
8431 @opindex ftree-ch
8432 Perform loop header copying on trees.  This is beneficial since it increases
8433 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8434 is enabled by default at @option{-O} and higher.  It is not enabled
8435 for @option{-Os}, since it usually increases code size.
8437 @item -ftree-loop-optimize
8438 @opindex ftree-loop-optimize
8439 Perform loop optimizations on trees.  This flag is enabled by default
8440 at @option{-O} and higher.
8442 @item -ftree-loop-linear
8443 @itemx -floop-interchange
8444 @itemx -floop-strip-mine
8445 @itemx -floop-block
8446 @itemx -floop-unroll-and-jam
8447 @opindex ftree-loop-linear
8448 @opindex floop-interchange
8449 @opindex floop-strip-mine
8450 @opindex floop-block
8451 @opindex floop-unroll-and-jam
8452 Perform loop nest optimizations.  Same as
8453 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8454 to be configured with @option{--with-isl} to enable the Graphite loop
8455 transformation infrastructure.
8457 @item -fgraphite-identity
8458 @opindex fgraphite-identity
8459 Enable the identity transformation for graphite.  For every SCoP we generate
8460 the polyhedral representation and transform it back to gimple.  Using
8461 @option{-fgraphite-identity} we can check the costs or benefits of the
8462 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8463 are also performed by the code generator isl, like index splitting and
8464 dead code elimination in loops.
8466 @item -floop-nest-optimize
8467 @opindex floop-nest-optimize
8468 Enable the isl based loop nest optimizer.  This is a generic loop nest
8469 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8470 structure optimized for data-locality and parallelism.  This option
8471 is experimental.
8473 @item -floop-parallelize-all
8474 @opindex floop-parallelize-all
8475 Use the Graphite data dependence analysis to identify loops that can
8476 be parallelized.  Parallelize all the loops that can be analyzed to
8477 not contain loop carried dependences without checking that it is
8478 profitable to parallelize the loops.
8480 @item -ftree-coalesce-vars
8481 @opindex ftree-coalesce-vars
8482 While transforming the program out of the SSA representation, attempt to
8483 reduce copying by coalescing versions of different user-defined
8484 variables, instead of just compiler temporaries.  This may severely
8485 limit the ability to debug an optimized program compiled with
8486 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8487 prevents SSA coalescing of user variables.  This option is enabled by
8488 default if optimization is enabled, and it does very little otherwise.
8490 @item -ftree-loop-if-convert
8491 @opindex ftree-loop-if-convert
8492 Attempt to transform conditional jumps in the innermost loops to
8493 branch-less equivalents.  The intent is to remove control-flow from
8494 the innermost loops in order to improve the ability of the
8495 vectorization pass to handle these loops.  This is enabled by default
8496 if vectorization is enabled.
8498 @item -ftree-loop-distribution
8499 @opindex ftree-loop-distribution
8500 Perform loop distribution.  This flag can improve cache performance on
8501 big loop bodies and allow further loop optimizations, like
8502 parallelization or vectorization, to take place.  For example, the loop
8503 @smallexample
8504 DO I = 1, N
8505   A(I) = B(I) + C
8506   D(I) = E(I) * F
8507 ENDDO
8508 @end smallexample
8509 is transformed to
8510 @smallexample
8511 DO I = 1, N
8512    A(I) = B(I) + C
8513 ENDDO
8514 DO I = 1, N
8515    D(I) = E(I) * F
8516 ENDDO
8517 @end smallexample
8519 @item -ftree-loop-distribute-patterns
8520 @opindex ftree-loop-distribute-patterns
8521 Perform loop distribution of patterns that can be code generated with
8522 calls to a library.  This flag is enabled by default at @option{-O3}.
8524 This pass distributes the initialization loops and generates a call to
8525 memset zero.  For example, the loop
8526 @smallexample
8527 DO I = 1, N
8528   A(I) = 0
8529   B(I) = A(I) + I
8530 ENDDO
8531 @end smallexample
8532 is transformed to
8533 @smallexample
8534 DO I = 1, N
8535    A(I) = 0
8536 ENDDO
8537 DO I = 1, N
8538    B(I) = A(I) + I
8539 ENDDO
8540 @end smallexample
8541 and the initialization loop is transformed into a call to memset zero.
8543 @item -ftree-loop-im
8544 @opindex ftree-loop-im
8545 Perform loop invariant motion on trees.  This pass moves only invariants that
8546 are hard to handle at RTL level (function calls, operations that expand to
8547 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8548 operands of conditions that are invariant out of the loop, so that we can use
8549 just trivial invariantness analysis in loop unswitching.  The pass also includes
8550 store motion.
8552 @item -ftree-loop-ivcanon
8553 @opindex ftree-loop-ivcanon
8554 Create a canonical counter for number of iterations in loops for which
8555 determining number of iterations requires complicated analysis.  Later
8556 optimizations then may determine the number easily.  Useful especially
8557 in connection with unrolling.
8559 @item -fivopts
8560 @opindex fivopts
8561 Perform induction variable optimizations (strength reduction, induction
8562 variable merging and induction variable elimination) on trees.
8564 @item -ftree-parallelize-loops=n
8565 @opindex ftree-parallelize-loops
8566 Parallelize loops, i.e., split their iteration space to run in n threads.
8567 This is only possible for loops whose iterations are independent
8568 and can be arbitrarily reordered.  The optimization is only
8569 profitable on multiprocessor machines, for loops that are CPU-intensive,
8570 rather than constrained e.g.@: by memory bandwidth.  This option
8571 implies @option{-pthread}, and thus is only supported on targets
8572 that have support for @option{-pthread}.
8574 @item -ftree-pta
8575 @opindex ftree-pta
8576 Perform function-local points-to analysis on trees.  This flag is
8577 enabled by default at @option{-O} and higher.
8579 @item -ftree-sra
8580 @opindex ftree-sra
8581 Perform scalar replacement of aggregates.  This pass replaces structure
8582 references with scalars to prevent committing structures to memory too
8583 early.  This flag is enabled by default at @option{-O} and higher.
8585 @item -fstore-merging
8586 @opindex fstore-merging
8587 Perform merging of narrow stores to consecutive memory addresses.  This pass
8588 merges contiguous stores of immediate values narrower than a word into fewer
8589 wider stores to reduce the number of instructions.  This is enabled by default
8590 at @option{-O2} and higher as well as @option{-Os}.
8592 @item -ftree-ter
8593 @opindex ftree-ter
8594 Perform temporary expression replacement during the SSA->normal phase.  Single
8595 use/single def temporaries are replaced at their use location with their
8596 defining expression.  This results in non-GIMPLE code, but gives the expanders
8597 much more complex trees to work on resulting in better RTL generation.  This is
8598 enabled by default at @option{-O} and higher.
8600 @item -ftree-slsr
8601 @opindex ftree-slsr
8602 Perform straight-line strength reduction on trees.  This recognizes related
8603 expressions involving multiplications and replaces them by less expensive
8604 calculations when possible.  This is enabled by default at @option{-O} and
8605 higher.
8607 @item -ftree-vectorize
8608 @opindex ftree-vectorize
8609 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8610 and @option{-ftree-slp-vectorize} if not explicitly specified.
8612 @item -ftree-loop-vectorize
8613 @opindex ftree-loop-vectorize
8614 Perform loop vectorization on trees. This flag is enabled by default at
8615 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8617 @item -ftree-slp-vectorize
8618 @opindex ftree-slp-vectorize
8619 Perform basic block vectorization on trees. This flag is enabled by default at
8620 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8622 @item -fvect-cost-model=@var{model}
8623 @opindex fvect-cost-model
8624 Alter the cost model used for vectorization.  The @var{model} argument
8625 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8626 With the @samp{unlimited} model the vectorized code-path is assumed
8627 to be profitable while with the @samp{dynamic} model a runtime check
8628 guards the vectorized code-path to enable it only for iteration
8629 counts that will likely execute faster than when executing the original
8630 scalar loop.  The @samp{cheap} model disables vectorization of
8631 loops where doing so would be cost prohibitive for example due to
8632 required runtime checks for data dependence or alignment but otherwise
8633 is equal to the @samp{dynamic} model.
8634 The default cost model depends on other optimization flags and is
8635 either @samp{dynamic} or @samp{cheap}.
8637 @item -fsimd-cost-model=@var{model}
8638 @opindex fsimd-cost-model
8639 Alter the cost model used for vectorization of loops marked with the OpenMP
8640 or Cilk Plus simd directive.  The @var{model} argument should be one of
8641 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8642 have the same meaning as described in @option{-fvect-cost-model} and by
8643 default a cost model defined with @option{-fvect-cost-model} is used.
8645 @item -ftree-vrp
8646 @opindex ftree-vrp
8647 Perform Value Range Propagation on trees.  This is similar to the
8648 constant propagation pass, but instead of values, ranges of values are
8649 propagated.  This allows the optimizers to remove unnecessary range
8650 checks like array bound checks and null pointer checks.  This is
8651 enabled by default at @option{-O2} and higher.  Null pointer check
8652 elimination is only done if @option{-fdelete-null-pointer-checks} is
8653 enabled.
8655 @item -fsplit-paths
8656 @opindex fsplit-paths
8657 Split paths leading to loop backedges.  This can improve dead code
8658 elimination and common subexpression elimination.  This is enabled by
8659 default at @option{-O2} and above.
8661 @item -fsplit-ivs-in-unroller
8662 @opindex fsplit-ivs-in-unroller
8663 Enables expression of values of induction variables in later iterations
8664 of the unrolled loop using the value in the first iteration.  This breaks
8665 long dependency chains, thus improving efficiency of the scheduling passes.
8667 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8668 same effect.  However, that is not reliable in cases where the loop body
8669 is more complicated than a single basic block.  It also does not work at all
8670 on some architectures due to restrictions in the CSE pass.
8672 This optimization is enabled by default.
8674 @item -fvariable-expansion-in-unroller
8675 @opindex fvariable-expansion-in-unroller
8676 With this option, the compiler creates multiple copies of some
8677 local variables when unrolling a loop, which can result in superior code.
8679 @item -fpartial-inlining
8680 @opindex fpartial-inlining
8681 Inline parts of functions.  This option has any effect only
8682 when inlining itself is turned on by the @option{-finline-functions}
8683 or @option{-finline-small-functions} options.
8685 Enabled at level @option{-O2}.
8687 @item -fpredictive-commoning
8688 @opindex fpredictive-commoning
8689 Perform predictive commoning optimization, i.e., reusing computations
8690 (especially memory loads and stores) performed in previous
8691 iterations of loops.
8693 This option is enabled at level @option{-O3}.
8695 @item -fprefetch-loop-arrays
8696 @opindex fprefetch-loop-arrays
8697 If supported by the target machine, generate instructions to prefetch
8698 memory to improve the performance of loops that access large arrays.
8700 This option may generate better or worse code; results are highly
8701 dependent on the structure of loops within the source code.
8703 Disabled at level @option{-Os}.
8705 @item -fno-printf-return-value
8706 @opindex fno-printf-return-value
8707 Do not substitute constants for known return value of formatted output
8708 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8709 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8710 transformation allows GCC to optimize or even eliminate branches based
8711 on the known return value of these functions called with arguments that
8712 are either constant, or whose values are known to be in a range that
8713 makes determining the exact return value possible.  For example, when
8714 @option{-fprintf-return-value} is in effect, both the branch and the
8715 body of the @code{if} statement (but not the call to @code{snprint})
8716 can be optimized away when @code{i} is a 32-bit or smaller integer
8717 because the return value is guaranteed to be at most 8.
8719 @smallexample
8720 char buf[9];
8721 if (snprintf (buf, "%08x", i) >= sizeof buf)
8722   @dots{}
8723 @end smallexample
8725 The @option{-fprintf-return-value} option relies on other optimizations
8726 and yields best results with @option{-O2}.  It works in tandem with the
8727 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8728 The @option{-fprintf-return-value} option is enabled by default.
8730 @item -fno-peephole
8731 @itemx -fno-peephole2
8732 @opindex fno-peephole
8733 @opindex fno-peephole2
8734 Disable any machine-specific peephole optimizations.  The difference
8735 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8736 are implemented in the compiler; some targets use one, some use the
8737 other, a few use both.
8739 @option{-fpeephole} is enabled by default.
8740 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8742 @item -fno-guess-branch-probability
8743 @opindex fno-guess-branch-probability
8744 Do not guess branch probabilities using heuristics.
8746 GCC uses heuristics to guess branch probabilities if they are
8747 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8748 heuristics are based on the control flow graph.  If some branch probabilities
8749 are specified by @code{__builtin_expect}, then the heuristics are
8750 used to guess branch probabilities for the rest of the control flow graph,
8751 taking the @code{__builtin_expect} info into account.  The interactions
8752 between the heuristics and @code{__builtin_expect} can be complex, and in
8753 some cases, it may be useful to disable the heuristics so that the effects
8754 of @code{__builtin_expect} are easier to understand.
8756 The default is @option{-fguess-branch-probability} at levels
8757 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8759 @item -freorder-blocks
8760 @opindex freorder-blocks
8761 Reorder basic blocks in the compiled function in order to reduce number of
8762 taken branches and improve code locality.
8764 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8766 @item -freorder-blocks-algorithm=@var{algorithm}
8767 @opindex freorder-blocks-algorithm
8768 Use the specified algorithm for basic block reordering.  The
8769 @var{algorithm} argument can be @samp{simple}, which does not increase
8770 code size (except sometimes due to secondary effects like alignment),
8771 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8772 put all often executed code together, minimizing the number of branches
8773 executed by making extra copies of code.
8775 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8776 @samp{stc} at levels @option{-O2}, @option{-O3}.
8778 @item -freorder-blocks-and-partition
8779 @opindex freorder-blocks-and-partition
8780 In addition to reordering basic blocks in the compiled function, in order
8781 to reduce number of taken branches, partitions hot and cold basic blocks
8782 into separate sections of the assembly and @file{.o} files, to improve
8783 paging and cache locality performance.
8785 This optimization is automatically turned off in the presence of
8786 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8787 section attribute and on any architecture that does not support named
8788 sections.  When @option{-fsplit-stack} is used this option is not
8789 enabled by default (to avoid linker errors), but may be enabled
8790 explicitly (if using a working linker).
8792 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8794 @item -freorder-functions
8795 @opindex freorder-functions
8796 Reorder functions in the object file in order to
8797 improve code locality.  This is implemented by using special
8798 subsections @code{.text.hot} for most frequently executed functions and
8799 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8800 the linker so object file format must support named sections and linker must
8801 place them in a reasonable way.
8803 Also profile feedback must be available to make this option effective.  See
8804 @option{-fprofile-arcs} for details.
8806 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8808 @item -fstrict-aliasing
8809 @opindex fstrict-aliasing
8810 Allow the compiler to assume the strictest aliasing rules applicable to
8811 the language being compiled.  For C (and C++), this activates
8812 optimizations based on the type of expressions.  In particular, an
8813 object of one type is assumed never to reside at the same address as an
8814 object of a different type, unless the types are almost the same.  For
8815 example, an @code{unsigned int} can alias an @code{int}, but not a
8816 @code{void*} or a @code{double}.  A character type may alias any other
8817 type.
8819 @anchor{Type-punning}Pay special attention to code like this:
8820 @smallexample
8821 union a_union @{
8822   int i;
8823   double d;
8826 int f() @{
8827   union a_union t;
8828   t.d = 3.0;
8829   return t.i;
8831 @end smallexample
8832 The practice of reading from a different union member than the one most
8833 recently written to (called ``type-punning'') is common.  Even with
8834 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8835 is accessed through the union type.  So, the code above works as
8836 expected.  @xref{Structures unions enumerations and bit-fields
8837 implementation}.  However, this code might not:
8838 @smallexample
8839 int f() @{
8840   union a_union t;
8841   int* ip;
8842   t.d = 3.0;
8843   ip = &t.i;
8844   return *ip;
8846 @end smallexample
8848 Similarly, access by taking the address, casting the resulting pointer
8849 and dereferencing the result has undefined behavior, even if the cast
8850 uses a union type, e.g.:
8851 @smallexample
8852 int f() @{
8853   double d = 3.0;
8854   return ((union a_union *) &d)->i;
8856 @end smallexample
8858 The @option{-fstrict-aliasing} option is enabled at levels
8859 @option{-O2}, @option{-O3}, @option{-Os}.
8861 @item -falign-functions
8862 @itemx -falign-functions=@var{n}
8863 @opindex falign-functions
8864 Align the start of functions to the next power-of-two greater than
8865 @var{n}, skipping up to @var{n} bytes.  For instance,
8866 @option{-falign-functions=32} aligns functions to the next 32-byte
8867 boundary, but @option{-falign-functions=24} aligns to the next
8868 32-byte boundary only if this can be done by skipping 23 bytes or less.
8870 @option{-fno-align-functions} and @option{-falign-functions=1} are
8871 equivalent and mean that functions are not aligned.
8873 Some assemblers only support this flag when @var{n} is a power of two;
8874 in that case, it is rounded up.
8876 If @var{n} is not specified or is zero, use a machine-dependent default.
8878 Enabled at levels @option{-O2}, @option{-O3}.
8880 @item -flimit-function-alignment
8881 If this option is enabled, the compiler tries to avoid unnecessarily
8882 overaligning functions. It attempts to instruct the assembler to align
8883 by the amount specified by @option{-falign-functions}, but not to
8884 skip more bytes than the size of the function.
8886 @item -falign-labels
8887 @itemx -falign-labels=@var{n}
8888 @opindex falign-labels
8889 Align all branch targets to a power-of-two boundary, skipping up to
8890 @var{n} bytes like @option{-falign-functions}.  This option can easily
8891 make code slower, because it must insert dummy operations for when the
8892 branch target is reached in the usual flow of the code.
8894 @option{-fno-align-labels} and @option{-falign-labels=1} are
8895 equivalent and mean that labels are not aligned.
8897 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8898 are greater than this value, then their values are used instead.
8900 If @var{n} is not specified or is zero, use a machine-dependent default
8901 which is very likely to be @samp{1}, meaning no alignment.
8903 Enabled at levels @option{-O2}, @option{-O3}.
8905 @item -falign-loops
8906 @itemx -falign-loops=@var{n}
8907 @opindex falign-loops
8908 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8909 like @option{-falign-functions}.  If the loops are
8910 executed many times, this makes up for any execution of the dummy
8911 operations.
8913 @option{-fno-align-loops} and @option{-falign-loops=1} are
8914 equivalent and mean that loops are not aligned.
8916 If @var{n} is not specified or is zero, use a machine-dependent default.
8918 Enabled at levels @option{-O2}, @option{-O3}.
8920 @item -falign-jumps
8921 @itemx -falign-jumps=@var{n}
8922 @opindex falign-jumps
8923 Align branch targets to a power-of-two boundary, for branch targets
8924 where the targets can only be reached by jumping, skipping up to @var{n}
8925 bytes like @option{-falign-functions}.  In this case, no dummy operations
8926 need be executed.
8928 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8929 equivalent and mean that loops are not aligned.
8931 If @var{n} is not specified or is zero, use a machine-dependent default.
8933 Enabled at levels @option{-O2}, @option{-O3}.
8935 @item -funit-at-a-time
8936 @opindex funit-at-a-time
8937 This option is left for compatibility reasons. @option{-funit-at-a-time}
8938 has no effect, while @option{-fno-unit-at-a-time} implies
8939 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8941 Enabled by default.
8943 @item -fno-toplevel-reorder
8944 @opindex fno-toplevel-reorder
8945 Do not reorder top-level functions, variables, and @code{asm}
8946 statements.  Output them in the same order that they appear in the
8947 input file.  When this option is used, unreferenced static variables
8948 are not removed.  This option is intended to support existing code
8949 that relies on a particular ordering.  For new code, it is better to
8950 use attributes when possible.
8952 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8953 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8954 targets.
8956 @item -fweb
8957 @opindex fweb
8958 Constructs webs as commonly used for register allocation purposes and assign
8959 each web individual pseudo register.  This allows the register allocation pass
8960 to operate on pseudos directly, but also strengthens several other optimization
8961 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8962 however, make debugging impossible, since variables no longer stay in a
8963 ``home register''.
8965 Enabled by default with @option{-funroll-loops}.
8967 @item -fwhole-program
8968 @opindex fwhole-program
8969 Assume that the current compilation unit represents the whole program being
8970 compiled.  All public functions and variables with the exception of @code{main}
8971 and those merged by attribute @code{externally_visible} become static functions
8972 and in effect are optimized more aggressively by interprocedural optimizers.
8974 This option should not be used in combination with @option{-flto}.
8975 Instead relying on a linker plugin should provide safer and more precise
8976 information.
8978 @item -flto[=@var{n}]
8979 @opindex flto
8980 This option runs the standard link-time optimizer.  When invoked
8981 with source code, it generates GIMPLE (one of GCC's internal
8982 representations) and writes it to special ELF sections in the object
8983 file.  When the object files are linked together, all the function
8984 bodies are read from these ELF sections and instantiated as if they
8985 had been part of the same translation unit.
8987 To use the link-time optimizer, @option{-flto} and optimization
8988 options should be specified at compile time and during the final link.
8989 It is recommended that you compile all the files participating in the
8990 same link with the same options and also specify those options at
8991 link time.  
8992 For example:
8994 @smallexample
8995 gcc -c -O2 -flto foo.c
8996 gcc -c -O2 -flto bar.c
8997 gcc -o myprog -flto -O2 foo.o bar.o
8998 @end smallexample
9000 The first two invocations to GCC save a bytecode representation
9001 of GIMPLE into special ELF sections inside @file{foo.o} and
9002 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9003 @file{foo.o} and @file{bar.o}, merges the two files into a single
9004 internal image, and compiles the result as usual.  Since both
9005 @file{foo.o} and @file{bar.o} are merged into a single image, this
9006 causes all the interprocedural analyses and optimizations in GCC to
9007 work across the two files as if they were a single one.  This means,
9008 for example, that the inliner is able to inline functions in
9009 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9011 Another (simpler) way to enable link-time optimization is:
9013 @smallexample
9014 gcc -o myprog -flto -O2 foo.c bar.c
9015 @end smallexample
9017 The above generates bytecode for @file{foo.c} and @file{bar.c},
9018 merges them together into a single GIMPLE representation and optimizes
9019 them as usual to produce @file{myprog}.
9021 The only important thing to keep in mind is that to enable link-time
9022 optimizations you need to use the GCC driver to perform the link step.
9023 GCC then automatically performs link-time optimization if any of the
9024 objects involved were compiled with the @option{-flto} command-line option.  
9025 You generally
9026 should specify the optimization options to be used for link-time
9027 optimization though GCC tries to be clever at guessing an
9028 optimization level to use from the options used at compile time
9029 if you fail to specify one at link time.  You can always override
9030 the automatic decision to do link-time optimization
9031 by passing @option{-fno-lto} to the link command.
9033 To make whole program optimization effective, it is necessary to make
9034 certain whole program assumptions.  The compiler needs to know
9035 what functions and variables can be accessed by libraries and runtime
9036 outside of the link-time optimized unit.  When supported by the linker,
9037 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9038 to the compiler about used and externally visible symbols.  When
9039 the linker plugin is not available, @option{-fwhole-program} should be
9040 used to allow the compiler to make these assumptions, which leads
9041 to more aggressive optimization decisions.
9043 When @option{-fuse-linker-plugin} is not enabled, when a file is
9044 compiled with @option{-flto}, the generated object file is larger than
9045 a regular object file because it contains GIMPLE bytecodes and the usual
9046 final code (see @option{-ffat-lto-objects}.  This means that
9047 object files with LTO information can be linked as normal object
9048 files; if @option{-fno-lto} is passed to the linker, no
9049 interprocedural optimizations are applied.  Note that when
9050 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9051 but you cannot perform a regular, non-LTO link on them.
9053 Additionally, the optimization flags used to compile individual files
9054 are not necessarily related to those used at link time.  For instance,
9056 @smallexample
9057 gcc -c -O0 -ffat-lto-objects -flto foo.c
9058 gcc -c -O0 -ffat-lto-objects -flto bar.c
9059 gcc -o myprog -O3 foo.o bar.o
9060 @end smallexample
9062 This produces individual object files with unoptimized assembler
9063 code, but the resulting binary @file{myprog} is optimized at
9064 @option{-O3}.  If, instead, the final binary is generated with
9065 @option{-fno-lto}, then @file{myprog} is not optimized.
9067 When producing the final binary, GCC only
9068 applies link-time optimizations to those files that contain bytecode.
9069 Therefore, you can mix and match object files and libraries with
9070 GIMPLE bytecodes and final object code.  GCC automatically selects
9071 which files to optimize in LTO mode and which files to link without
9072 further processing.
9074 There are some code generation flags preserved by GCC when
9075 generating bytecodes, as they need to be used during the final link
9076 stage.  Generally options specified at link time override those
9077 specified at compile time.
9079 If you do not specify an optimization level option @option{-O} at
9080 link time, then GCC uses the highest optimization level 
9081 used when compiling the object files.
9083 Currently, the following options and their settings are taken from
9084 the first object file that explicitly specifies them: 
9085 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9086 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9087 and all the @option{-m} target flags.
9089 Certain ABI-changing flags are required to match in all compilation units,
9090 and trying to override this at link time with a conflicting value
9091 is ignored.  This includes options such as @option{-freg-struct-return}
9092 and @option{-fpcc-struct-return}. 
9094 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9095 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9096 are passed through to the link stage and merged conservatively for
9097 conflicting translation units.  Specifically
9098 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9099 precedence; and for example @option{-ffp-contract=off} takes precedence
9100 over @option{-ffp-contract=fast}.  You can override them at link time.
9102 If LTO encounters objects with C linkage declared with incompatible
9103 types in separate translation units to be linked together (undefined
9104 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9105 issued.  The behavior is still undefined at run time.  Similar
9106 diagnostics may be raised for other languages.
9108 Another feature of LTO is that it is possible to apply interprocedural
9109 optimizations on files written in different languages:
9111 @smallexample
9112 gcc -c -flto foo.c
9113 g++ -c -flto bar.cc
9114 gfortran -c -flto baz.f90
9115 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9116 @end smallexample
9118 Notice that the final link is done with @command{g++} to get the C++
9119 runtime libraries and @option{-lgfortran} is added to get the Fortran
9120 runtime libraries.  In general, when mixing languages in LTO mode, you
9121 should use the same link command options as when mixing languages in a
9122 regular (non-LTO) compilation.
9124 If object files containing GIMPLE bytecode are stored in a library archive, say
9125 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9126 are using a linker with plugin support.  To create static libraries suitable
9127 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9128 and @command{ranlib}; 
9129 to show the symbols of object files with GIMPLE bytecode, use
9130 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9131 and @command{nm} have been compiled with plugin support.  At link time, use the the
9132 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9133 the LTO optimization process:
9135 @smallexample
9136 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9137 @end smallexample
9139 With the linker plugin enabled, the linker extracts the needed
9140 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9141 to make them part of the aggregated GIMPLE image to be optimized.
9143 If you are not using a linker with plugin support and/or do not
9144 enable the linker plugin, then the objects inside @file{libfoo.a}
9145 are extracted and linked as usual, but they do not participate
9146 in the LTO optimization process.  In order to make a static library suitable
9147 for both LTO optimization and usual linkage, compile its object files with
9148 @option{-flto} @option{-ffat-lto-objects}.
9150 Link-time optimizations do not require the presence of the whole program to
9151 operate.  If the program does not require any symbols to be exported, it is
9152 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9153 the interprocedural optimizers to use more aggressive assumptions which may
9154 lead to improved optimization opportunities.
9155 Use of @option{-fwhole-program} is not needed when linker plugin is
9156 active (see @option{-fuse-linker-plugin}).
9158 The current implementation of LTO makes no
9159 attempt to generate bytecode that is portable between different
9160 types of hosts.  The bytecode files are versioned and there is a
9161 strict version check, so bytecode files generated in one version of
9162 GCC do not work with an older or newer version of GCC.
9164 Link-time optimization does not work well with generation of debugging
9165 information.  Combining @option{-flto} with
9166 @option{-g} is currently experimental and expected to produce unexpected
9167 results.
9169 If you specify the optional @var{n}, the optimization and code
9170 generation done at link time is executed in parallel using @var{n}
9171 parallel jobs by utilizing an installed @command{make} program.  The
9172 environment variable @env{MAKE} may be used to override the program
9173 used.  The default value for @var{n} is 1.
9175 You can also specify @option{-flto=jobserver} to use GNU make's
9176 job server mode to determine the number of parallel jobs. This
9177 is useful when the Makefile calling GCC is already executing in parallel.
9178 You must prepend a @samp{+} to the command recipe in the parent Makefile
9179 for this to work.  This option likely only works if @env{MAKE} is
9180 GNU make.
9182 @item -flto-partition=@var{alg}
9183 @opindex flto-partition
9184 Specify the partitioning algorithm used by the link-time optimizer.
9185 The value is either @samp{1to1} to specify a partitioning mirroring
9186 the original source files or @samp{balanced} to specify partitioning
9187 into equally sized chunks (whenever possible) or @samp{max} to create
9188 new partition for every symbol where possible.  Specifying @samp{none}
9189 as an algorithm disables partitioning and streaming completely. 
9190 The default value is @samp{balanced}. While @samp{1to1} can be used
9191 as an workaround for various code ordering issues, the @samp{max}
9192 partitioning is intended for internal testing only.
9193 The value @samp{one} specifies that exactly one partition should be
9194 used while the value @samp{none} bypasses partitioning and executes
9195 the link-time optimization step directly from the WPA phase.
9197 @item -flto-odr-type-merging
9198 @opindex flto-odr-type-merging
9199 Enable streaming of mangled types names of C++ types and their unification
9200 at link time.  This increases size of LTO object files, but enables
9201 diagnostics about One Definition Rule violations.
9203 @item -flto-compression-level=@var{n}
9204 @opindex flto-compression-level
9205 This option specifies the level of compression used for intermediate
9206 language written to LTO object files, and is only meaningful in
9207 conjunction with LTO mode (@option{-flto}).  Valid
9208 values are 0 (no compression) to 9 (maximum compression).  Values
9209 outside this range are clamped to either 0 or 9.  If the option is not
9210 given, a default balanced compression setting is used.
9212 @item -fuse-linker-plugin
9213 @opindex fuse-linker-plugin
9214 Enables the use of a linker plugin during link-time optimization.  This
9215 option relies on plugin support in the linker, which is available in gold
9216 or in GNU ld 2.21 or newer.
9218 This option enables the extraction of object files with GIMPLE bytecode out
9219 of library archives. This improves the quality of optimization by exposing
9220 more code to the link-time optimizer.  This information specifies what
9221 symbols can be accessed externally (by non-LTO object or during dynamic
9222 linking).  Resulting code quality improvements on binaries (and shared
9223 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9224 See @option{-flto} for a description of the effect of this flag and how to
9225 use it.
9227 This option is enabled by default when LTO support in GCC is enabled
9228 and GCC was configured for use with
9229 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9231 @item -ffat-lto-objects
9232 @opindex ffat-lto-objects
9233 Fat LTO objects are object files that contain both the intermediate language
9234 and the object code. This makes them usable for both LTO linking and normal
9235 linking. This option is effective only when compiling with @option{-flto}
9236 and is ignored at link time.
9238 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9239 requires the complete toolchain to be aware of LTO. It requires a linker with
9240 linker plugin support for basic functionality.  Additionally,
9241 @command{nm}, @command{ar} and @command{ranlib}
9242 need to support linker plugins to allow a full-featured build environment
9243 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9244 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9245 to these tools. With non fat LTO makefiles need to be modified to use them.
9247 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9248 support.
9250 @item -fcompare-elim
9251 @opindex fcompare-elim
9252 After register allocation and post-register allocation instruction splitting,
9253 identify arithmetic instructions that compute processor flags similar to a
9254 comparison operation based on that arithmetic.  If possible, eliminate the
9255 explicit comparison operation.
9257 This pass only applies to certain targets that cannot explicitly represent
9258 the comparison operation before register allocation is complete.
9260 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9262 @item -fcprop-registers
9263 @opindex fcprop-registers
9264 After register allocation and post-register allocation instruction splitting,
9265 perform a copy-propagation pass to try to reduce scheduling dependencies
9266 and occasionally eliminate the copy.
9268 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9270 @item -fprofile-correction
9271 @opindex fprofile-correction
9272 Profiles collected using an instrumented binary for multi-threaded programs may
9273 be inconsistent due to missed counter updates. When this option is specified,
9274 GCC uses heuristics to correct or smooth out such inconsistencies. By
9275 default, GCC emits an error message when an inconsistent profile is detected.
9277 @item -fprofile-use
9278 @itemx -fprofile-use=@var{path}
9279 @opindex fprofile-use
9280 Enable profile feedback-directed optimizations, 
9281 and the following optimizations
9282 which are generally profitable only with profile feedback available:
9283 @option{-fbranch-probabilities}, @option{-fvpt},
9284 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9285 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9287 Before you can use this option, you must first generate profiling information.
9288 @xref{Instrumentation Options}, for information about the
9289 @option{-fprofile-generate} option.
9291 By default, GCC emits an error message if the feedback profiles do not
9292 match the source code.  This error can be turned into a warning by using
9293 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9294 code.
9296 If @var{path} is specified, GCC looks at the @var{path} to find
9297 the profile feedback data files. See @option{-fprofile-dir}.
9299 @item -fauto-profile
9300 @itemx -fauto-profile=@var{path}
9301 @opindex fauto-profile
9302 Enable sampling-based feedback-directed optimizations, 
9303 and the following optimizations
9304 which are generally profitable only with profile feedback available:
9305 @option{-fbranch-probabilities}, @option{-fvpt},
9306 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9307 @option{-ftree-vectorize},
9308 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9309 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9310 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9312 @var{path} is the name of a file containing AutoFDO profile information.
9313 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9315 Producing an AutoFDO profile data file requires running your program
9316 with the @command{perf} utility on a supported GNU/Linux target system.
9317 For more information, see @uref{https://perf.wiki.kernel.org/}.
9319 E.g.
9320 @smallexample
9321 perf record -e br_inst_retired:near_taken -b -o perf.data \
9322     -- your_program
9323 @end smallexample
9325 Then use the @command{create_gcov} tool to convert the raw profile data
9326 to a format that can be used by GCC.@  You must also supply the 
9327 unstripped binary for your program to this tool.  
9328 See @uref{https://github.com/google/autofdo}.
9330 E.g.
9331 @smallexample
9332 create_gcov --binary=your_program.unstripped --profile=perf.data \
9333     --gcov=profile.afdo
9334 @end smallexample
9335 @end table
9337 The following options control compiler behavior regarding floating-point 
9338 arithmetic.  These options trade off between speed and
9339 correctness.  All must be specifically enabled.
9341 @table @gcctabopt
9342 @item -ffloat-store
9343 @opindex ffloat-store
9344 Do not store floating-point variables in registers, and inhibit other
9345 options that might change whether a floating-point value is taken from a
9346 register or memory.
9348 @cindex floating-point precision
9349 This option prevents undesirable excess precision on machines such as
9350 the 68000 where the floating registers (of the 68881) keep more
9351 precision than a @code{double} is supposed to have.  Similarly for the
9352 x86 architecture.  For most programs, the excess precision does only
9353 good, but a few programs rely on the precise definition of IEEE floating
9354 point.  Use @option{-ffloat-store} for such programs, after modifying
9355 them to store all pertinent intermediate computations into variables.
9357 @item -fexcess-precision=@var{style}
9358 @opindex fexcess-precision
9359 This option allows further control over excess precision on machines
9360 where floating-point operations occur in a format with more precision or
9361 range than the IEEE standard and interchange floating-point types.  By
9362 default, @option{-fexcess-precision=fast} is in effect; this means that
9363 operations may be carried out in a wider precision than the types specified
9364 in the source if that would result in faster code, and it is unpredictable
9365 when rounding to the types specified in the source code takes place.
9366 When compiling C, if @option{-fexcess-precision=standard} is specified then
9367 excess precision follows the rules specified in ISO C99; in particular,
9368 both casts and assignments cause values to be rounded to their
9369 semantic types (whereas @option{-ffloat-store} only affects
9370 assignments).  This option is enabled by default for C if a strict
9371 conformance option such as @option{-std=c99} is used.
9372 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9373 regardless of whether a strict conformance option is used.
9375 @opindex mfpmath
9376 @option{-fexcess-precision=standard} is not implemented for languages
9377 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9378 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9379 semantics apply without excess precision, and in the latter, rounding
9380 is unpredictable.
9382 @item -ffast-math
9383 @opindex ffast-math
9384 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9385 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9386 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9387 @option{-fexcess-precision=fast}.
9389 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9391 This option is not turned on by any @option{-O} option besides
9392 @option{-Ofast} since it can result in incorrect output for programs
9393 that depend on an exact implementation of IEEE or ISO rules/specifications
9394 for math functions. It may, however, yield faster code for programs
9395 that do not require the guarantees of these specifications.
9397 @item -fno-math-errno
9398 @opindex fno-math-errno
9399 Do not set @code{errno} after calling math functions that are executed
9400 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9401 IEEE exceptions for math error handling may want to use this flag
9402 for speed while maintaining IEEE arithmetic compatibility.
9404 This option is not turned on by any @option{-O} option since
9405 it can result in incorrect output for programs that depend on
9406 an exact implementation of IEEE or ISO rules/specifications for
9407 math functions. It may, however, yield faster code for programs
9408 that do not require the guarantees of these specifications.
9410 The default is @option{-fmath-errno}.
9412 On Darwin systems, the math library never sets @code{errno}.  There is
9413 therefore no reason for the compiler to consider the possibility that
9414 it might, and @option{-fno-math-errno} is the default.
9416 @item -funsafe-math-optimizations
9417 @opindex funsafe-math-optimizations
9419 Allow optimizations for floating-point arithmetic that (a) assume
9420 that arguments and results are valid and (b) may violate IEEE or
9421 ANSI standards.  When used at link time, it may include libraries
9422 or startup files that change the default FPU control word or other
9423 similar optimizations.
9425 This option is not turned on by any @option{-O} option since
9426 it can result in incorrect output for programs that depend on
9427 an exact implementation of IEEE or ISO rules/specifications for
9428 math functions. It may, however, yield faster code for programs
9429 that do not require the guarantees of these specifications.
9430 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9431 @option{-fassociative-math} and @option{-freciprocal-math}.
9433 The default is @option{-fno-unsafe-math-optimizations}.
9435 @item -fassociative-math
9436 @opindex fassociative-math
9438 Allow re-association of operands in series of floating-point operations.
9439 This violates the ISO C and C++ language standard by possibly changing
9440 computation result.  NOTE: re-ordering may change the sign of zero as
9441 well as ignore NaNs and inhibit or create underflow or overflow (and
9442 thus cannot be used on code that relies on rounding behavior like
9443 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9444 and thus may not be used when ordered comparisons are required.
9445 This option requires that both @option{-fno-signed-zeros} and
9446 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9447 much sense with @option{-frounding-math}. For Fortran the option
9448 is automatically enabled when both @option{-fno-signed-zeros} and
9449 @option{-fno-trapping-math} are in effect.
9451 The default is @option{-fno-associative-math}.
9453 @item -freciprocal-math
9454 @opindex freciprocal-math
9456 Allow the reciprocal of a value to be used instead of dividing by
9457 the value if this enables optimizations.  For example @code{x / y}
9458 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9459 is subject to common subexpression elimination.  Note that this loses
9460 precision and increases the number of flops operating on the value.
9462 The default is @option{-fno-reciprocal-math}.
9464 @item -ffinite-math-only
9465 @opindex ffinite-math-only
9466 Allow optimizations for floating-point arithmetic that assume
9467 that arguments and results are not NaNs or +-Infs.
9469 This option is not turned on by any @option{-O} option since
9470 it can result in incorrect output for programs that depend on
9471 an exact implementation of IEEE or ISO rules/specifications for
9472 math functions. It may, however, yield faster code for programs
9473 that do not require the guarantees of these specifications.
9475 The default is @option{-fno-finite-math-only}.
9477 @item -fno-signed-zeros
9478 @opindex fno-signed-zeros
9479 Allow optimizations for floating-point arithmetic that ignore the
9480 signedness of zero.  IEEE arithmetic specifies the behavior of
9481 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9482 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9483 This option implies that the sign of a zero result isn't significant.
9485 The default is @option{-fsigned-zeros}.
9487 @item -fno-trapping-math
9488 @opindex fno-trapping-math
9489 Compile code assuming that floating-point operations cannot generate
9490 user-visible traps.  These traps include division by zero, overflow,
9491 underflow, inexact result and invalid operation.  This option requires
9492 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9493 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9495 This option should never be turned on by any @option{-O} option since
9496 it can result in incorrect output for programs that depend on
9497 an exact implementation of IEEE or ISO rules/specifications for
9498 math functions.
9500 The default is @option{-ftrapping-math}.
9502 @item -frounding-math
9503 @opindex frounding-math
9504 Disable transformations and optimizations that assume default floating-point
9505 rounding behavior.  This is round-to-zero for all floating point
9506 to integer conversions, and round-to-nearest for all other arithmetic
9507 truncations.  This option should be specified for programs that change
9508 the FP rounding mode dynamically, or that may be executed with a
9509 non-default rounding mode.  This option disables constant folding of
9510 floating-point expressions at compile time (which may be affected by
9511 rounding mode) and arithmetic transformations that are unsafe in the
9512 presence of sign-dependent rounding modes.
9514 The default is @option{-fno-rounding-math}.
9516 This option is experimental and does not currently guarantee to
9517 disable all GCC optimizations that are affected by rounding mode.
9518 Future versions of GCC may provide finer control of this setting
9519 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9520 will be used to specify the default state for @code{FENV_ACCESS}.
9522 @item -fsignaling-nans
9523 @opindex fsignaling-nans
9524 Compile code assuming that IEEE signaling NaNs may generate user-visible
9525 traps during floating-point operations.  Setting this option disables
9526 optimizations that may change the number of exceptions visible with
9527 signaling NaNs.  This option implies @option{-ftrapping-math}.
9529 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9530 be defined.
9532 The default is @option{-fno-signaling-nans}.
9534 This option is experimental and does not currently guarantee to
9535 disable all GCC optimizations that affect signaling NaN behavior.
9537 @item -fno-fp-int-builtin-inexact
9538 @opindex fno-fp-int-builtin-inexact
9539 Do not allow the built-in functions @code{ceil}, @code{floor},
9540 @code{round} and @code{trunc}, and their @code{float} and @code{long
9541 double} variants, to generate code that raises the ``inexact''
9542 floating-point exception for noninteger arguments.  ISO C99 and C11
9543 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9544 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9545 functions to do so.
9547 The default is @option{-ffp-int-builtin-inexact}, allowing the
9548 exception to be raised.  This option does nothing unless
9549 @option{-ftrapping-math} is in effect.
9551 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9552 generate a call to a library function then the ``inexact'' exception
9553 may be raised if the library implementation does not follow TS 18661.
9555 @item -fsingle-precision-constant
9556 @opindex fsingle-precision-constant
9557 Treat floating-point constants as single precision instead of
9558 implicitly converting them to double-precision constants.
9560 @item -fcx-limited-range
9561 @opindex fcx-limited-range
9562 When enabled, this option states that a range reduction step is not
9563 needed when performing complex division.  Also, there is no checking
9564 whether the result of a complex multiplication or division is @code{NaN
9565 + I*NaN}, with an attempt to rescue the situation in that case.  The
9566 default is @option{-fno-cx-limited-range}, but is enabled by
9567 @option{-ffast-math}.
9569 This option controls the default setting of the ISO C99
9570 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9571 all languages.
9573 @item -fcx-fortran-rules
9574 @opindex fcx-fortran-rules
9575 Complex multiplication and division follow Fortran rules.  Range
9576 reduction is done as part of complex division, but there is no checking
9577 whether the result of a complex multiplication or division is @code{NaN
9578 + I*NaN}, with an attempt to rescue the situation in that case.
9580 The default is @option{-fno-cx-fortran-rules}.
9582 @end table
9584 The following options control optimizations that may improve
9585 performance, but are not enabled by any @option{-O} options.  This
9586 section includes experimental options that may produce broken code.
9588 @table @gcctabopt
9589 @item -fbranch-probabilities
9590 @opindex fbranch-probabilities
9591 After running a program compiled with @option{-fprofile-arcs}
9592 (@pxref{Instrumentation Options}),
9593 you can compile it a second time using
9594 @option{-fbranch-probabilities}, to improve optimizations based on
9595 the number of times each branch was taken.  When a program
9596 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9597 counts to a file called @file{@var{sourcename}.gcda} for each source
9598 file.  The information in this data file is very dependent on the
9599 structure of the generated code, so you must use the same source code
9600 and the same optimization options for both compilations.
9602 With @option{-fbranch-probabilities}, GCC puts a
9603 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9604 These can be used to improve optimization.  Currently, they are only
9605 used in one place: in @file{reorg.c}, instead of guessing which path a
9606 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9607 exactly determine which path is taken more often.
9609 @item -fprofile-values
9610 @opindex fprofile-values
9611 If combined with @option{-fprofile-arcs}, it adds code so that some
9612 data about values of expressions in the program is gathered.
9614 With @option{-fbranch-probabilities}, it reads back the data gathered
9615 from profiling values of expressions for usage in optimizations.
9617 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9619 @item -fprofile-reorder-functions
9620 @opindex fprofile-reorder-functions
9621 Function reordering based on profile instrumentation collects
9622 first time of execution of a function and orders these functions
9623 in ascending order.
9625 Enabled with @option{-fprofile-use}.
9627 @item -fvpt
9628 @opindex fvpt
9629 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9630 to add code to gather information about values of expressions.
9632 With @option{-fbranch-probabilities}, it reads back the data gathered
9633 and actually performs the optimizations based on them.
9634 Currently the optimizations include specialization of division operations
9635 using the knowledge about the value of the denominator.
9637 @item -frename-registers
9638 @opindex frename-registers
9639 Attempt to avoid false dependencies in scheduled code by making use
9640 of registers left over after register allocation.  This optimization
9641 most benefits processors with lots of registers.  Depending on the
9642 debug information format adopted by the target, however, it can
9643 make debugging impossible, since variables no longer stay in
9644 a ``home register''.
9646 Enabled by default with @option{-funroll-loops}.
9648 @item -fschedule-fusion
9649 @opindex fschedule-fusion
9650 Performs a target dependent pass over the instruction stream to schedule
9651 instructions of same type together because target machine can execute them
9652 more efficiently if they are adjacent to each other in the instruction flow.
9654 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9656 @item -ftracer
9657 @opindex ftracer
9658 Perform tail duplication to enlarge superblock size.  This transformation
9659 simplifies the control flow of the function allowing other optimizations to do
9660 a better job.
9662 Enabled with @option{-fprofile-use}.
9664 @item -funroll-loops
9665 @opindex funroll-loops
9666 Unroll loops whose number of iterations can be determined at compile time or
9667 upon entry to the loop.  @option{-funroll-loops} implies
9668 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9669 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9670 a small constant number of iterations).  This option makes code larger, and may
9671 or may not make it run faster.
9673 Enabled with @option{-fprofile-use}.
9675 @item -funroll-all-loops
9676 @opindex funroll-all-loops
9677 Unroll all loops, even if their number of iterations is uncertain when
9678 the loop is entered.  This usually makes programs run more slowly.
9679 @option{-funroll-all-loops} implies the same options as
9680 @option{-funroll-loops}.
9682 @item -fpeel-loops
9683 @opindex fpeel-loops
9684 Peels loops for which there is enough information that they do not
9685 roll much (from profile feedback or static analysis).  It also turns on
9686 complete loop peeling (i.e.@: complete removal of loops with small constant
9687 number of iterations).
9689 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9691 @item -fmove-loop-invariants
9692 @opindex fmove-loop-invariants
9693 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9694 at level @option{-O1}
9696 @item -fsplit-loops
9697 @opindex fsplit-loops
9698 Split a loop into two if it contains a condition that's always true
9699 for one side of the iteration space and false for the other.
9701 @item -funswitch-loops
9702 @opindex funswitch-loops
9703 Move branches with loop invariant conditions out of the loop, with duplicates
9704 of the loop on both branches (modified according to result of the condition).
9706 @item -ffunction-sections
9707 @itemx -fdata-sections
9708 @opindex ffunction-sections
9709 @opindex fdata-sections
9710 Place each function or data item into its own section in the output
9711 file if the target supports arbitrary sections.  The name of the
9712 function or the name of the data item determines the section's name
9713 in the output file.
9715 Use these options on systems where the linker can perform optimizations
9716 to improve locality of reference in the instruction space.  Most systems
9717 using the ELF object format and SPARC processors running Solaris 2 have
9718 linkers with such optimizations.  AIX may have these optimizations in
9719 the future.
9721 Only use these options when there are significant benefits from doing
9722 so.  When you specify these options, the assembler and linker
9723 create larger object and executable files and are also slower.
9724 You cannot use @command{gprof} on all systems if you
9725 specify this option, and you may have problems with debugging if
9726 you specify both this option and @option{-g}.
9728 @item -fbranch-target-load-optimize
9729 @opindex fbranch-target-load-optimize
9730 Perform branch target register load optimization before prologue / epilogue
9731 threading.
9732 The use of target registers can typically be exposed only during reload,
9733 thus hoisting loads out of loops and doing inter-block scheduling needs
9734 a separate optimization pass.
9736 @item -fbranch-target-load-optimize2
9737 @opindex fbranch-target-load-optimize2
9738 Perform branch target register load optimization after prologue / epilogue
9739 threading.
9741 @item -fbtr-bb-exclusive
9742 @opindex fbtr-bb-exclusive
9743 When performing branch target register load optimization, don't reuse
9744 branch target registers within any basic block.
9746 @item -fstdarg-opt
9747 @opindex fstdarg-opt
9748 Optimize the prologue of variadic argument functions with respect to usage of
9749 those arguments.
9751 @item -fsection-anchors
9752 @opindex fsection-anchors
9753 Try to reduce the number of symbolic address calculations by using
9754 shared ``anchor'' symbols to address nearby objects.  This transformation
9755 can help to reduce the number of GOT entries and GOT accesses on some
9756 targets.
9758 For example, the implementation of the following function @code{foo}:
9760 @smallexample
9761 static int a, b, c;
9762 int foo (void) @{ return a + b + c; @}
9763 @end smallexample
9765 @noindent
9766 usually calculates the addresses of all three variables, but if you
9767 compile it with @option{-fsection-anchors}, it accesses the variables
9768 from a common anchor point instead.  The effect is similar to the
9769 following pseudocode (which isn't valid C):
9771 @smallexample
9772 int foo (void)
9774   register int *xr = &x;
9775   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9777 @end smallexample
9779 Not all targets support this option.
9781 @item --param @var{name}=@var{value}
9782 @opindex param
9783 In some places, GCC uses various constants to control the amount of
9784 optimization that is done.  For example, GCC does not inline functions
9785 that contain more than a certain number of instructions.  You can
9786 control some of these constants on the command line using the
9787 @option{--param} option.
9789 The names of specific parameters, and the meaning of the values, are
9790 tied to the internals of the compiler, and are subject to change
9791 without notice in future releases.
9793 In each case, the @var{value} is an integer.  The allowable choices for
9794 @var{name} are:
9796 @table @gcctabopt
9797 @item predictable-branch-outcome
9798 When branch is predicted to be taken with probability lower than this threshold
9799 (in percent), then it is considered well predictable. The default is 10.
9801 @item max-rtl-if-conversion-insns
9802 RTL if-conversion tries to remove conditional branches around a block and
9803 replace them with conditionally executed instructions.  This parameter
9804 gives the maximum number of instructions in a block which should be
9805 considered for if-conversion.  The default is 10, though the compiler will
9806 also use other heuristics to decide whether if-conversion is likely to be
9807 profitable.
9809 @item max-rtl-if-conversion-predictable-cost
9810 @item max-rtl-if-conversion-unpredictable-cost
9811 RTL if-conversion will try to remove conditional branches around a block
9812 and replace them with conditionally executed instructions.  These parameters
9813 give the maximum permissible cost for the sequence that would be generated
9814 by if-conversion depending on whether the branch is statically determined
9815 to be predictable or not.  The units for this parameter are the same as
9816 those for the GCC internal seq_cost metric.  The compiler will try to
9817 provide a reasonable default for this parameter using the BRANCH_COST
9818 target macro.
9820 @item max-crossjump-edges
9821 The maximum number of incoming edges to consider for cross-jumping.
9822 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9823 the number of edges incoming to each block.  Increasing values mean
9824 more aggressive optimization, making the compilation time increase with
9825 probably small improvement in executable size.
9827 @item min-crossjump-insns
9828 The minimum number of instructions that must be matched at the end
9829 of two blocks before cross-jumping is performed on them.  This
9830 value is ignored in the case where all instructions in the block being
9831 cross-jumped from are matched.  The default value is 5.
9833 @item max-grow-copy-bb-insns
9834 The maximum code size expansion factor when copying basic blocks
9835 instead of jumping.  The expansion is relative to a jump instruction.
9836 The default value is 8.
9838 @item max-goto-duplication-insns
9839 The maximum number of instructions to duplicate to a block that jumps
9840 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9841 passes, GCC factors computed gotos early in the compilation process,
9842 and unfactors them as late as possible.  Only computed jumps at the
9843 end of a basic blocks with no more than max-goto-duplication-insns are
9844 unfactored.  The default value is 8.
9846 @item max-delay-slot-insn-search
9847 The maximum number of instructions to consider when looking for an
9848 instruction to fill a delay slot.  If more than this arbitrary number of
9849 instructions are searched, the time savings from filling the delay slot
9850 are minimal, so stop searching.  Increasing values mean more
9851 aggressive optimization, making the compilation time increase with probably
9852 small improvement in execution time.
9854 @item max-delay-slot-live-search
9855 When trying to fill delay slots, the maximum number of instructions to
9856 consider when searching for a block with valid live register
9857 information.  Increasing this arbitrarily chosen value means more
9858 aggressive optimization, increasing the compilation time.  This parameter
9859 should be removed when the delay slot code is rewritten to maintain the
9860 control-flow graph.
9862 @item max-gcse-memory
9863 The approximate maximum amount of memory that can be allocated in
9864 order to perform the global common subexpression elimination
9865 optimization.  If more memory than specified is required, the
9866 optimization is not done.
9868 @item max-gcse-insertion-ratio
9869 If the ratio of expression insertions to deletions is larger than this value
9870 for any expression, then RTL PRE inserts or removes the expression and thus
9871 leaves partially redundant computations in the instruction stream.  The default value is 20.
9873 @item max-pending-list-length
9874 The maximum number of pending dependencies scheduling allows
9875 before flushing the current state and starting over.  Large functions
9876 with few branches or calls can create excessively large lists which
9877 needlessly consume memory and resources.
9879 @item max-modulo-backtrack-attempts
9880 The maximum number of backtrack attempts the scheduler should make
9881 when modulo scheduling a loop.  Larger values can exponentially increase
9882 compilation time.
9884 @item max-inline-insns-single
9885 Several parameters control the tree inliner used in GCC@.
9886 This number sets the maximum number of instructions (counted in GCC's
9887 internal representation) in a single function that the tree inliner
9888 considers for inlining.  This only affects functions declared
9889 inline and methods implemented in a class declaration (C++).
9890 The default value is 400.
9892 @item max-inline-insns-auto
9893 When you use @option{-finline-functions} (included in @option{-O3}),
9894 a lot of functions that would otherwise not be considered for inlining
9895 by the compiler are investigated.  To those functions, a different
9896 (more restrictive) limit compared to functions declared inline can
9897 be applied.
9898 The default value is 40.
9900 @item inline-min-speedup
9901 When estimated performance improvement of caller + callee runtime exceeds this
9902 threshold (in percent), the function can be inlined regardless of the limit on
9903 @option{--param max-inline-insns-single} and @option{--param
9904 max-inline-insns-auto}.
9906 @item large-function-insns
9907 The limit specifying really large functions.  For functions larger than this
9908 limit after inlining, inlining is constrained by
9909 @option{--param large-function-growth}.  This parameter is useful primarily
9910 to avoid extreme compilation time caused by non-linear algorithms used by the
9911 back end.
9912 The default value is 2700.
9914 @item large-function-growth
9915 Specifies maximal growth of large function caused by inlining in percents.
9916 The default value is 100 which limits large function growth to 2.0 times
9917 the original size.
9919 @item large-unit-insns
9920 The limit specifying large translation unit.  Growth caused by inlining of
9921 units larger than this limit is limited by @option{--param inline-unit-growth}.
9922 For small units this might be too tight.
9923 For example, consider a unit consisting of function A
9924 that is inline and B that just calls A three times.  If B is small relative to
9925 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9926 large units consisting of small inlineable functions, however, the overall unit
9927 growth limit is needed to avoid exponential explosion of code size.  Thus for
9928 smaller units, the size is increased to @option{--param large-unit-insns}
9929 before applying @option{--param inline-unit-growth}.  The default is 10000.
9931 @item inline-unit-growth
9932 Specifies maximal overall growth of the compilation unit caused by inlining.
9933 The default value is 20 which limits unit growth to 1.2 times the original
9934 size. Cold functions (either marked cold via an attribute or by profile
9935 feedback) are not accounted into the unit size.
9937 @item ipcp-unit-growth
9938 Specifies maximal overall growth of the compilation unit caused by
9939 interprocedural constant propagation.  The default value is 10 which limits
9940 unit growth to 1.1 times the original size.
9942 @item large-stack-frame
9943 The limit specifying large stack frames.  While inlining the algorithm is trying
9944 to not grow past this limit too much.  The default value is 256 bytes.
9946 @item large-stack-frame-growth
9947 Specifies maximal growth of large stack frames caused by inlining in percents.
9948 The default value is 1000 which limits large stack frame growth to 11 times
9949 the original size.
9951 @item max-inline-insns-recursive
9952 @itemx max-inline-insns-recursive-auto
9953 Specifies the maximum number of instructions an out-of-line copy of a
9954 self-recursive inline
9955 function can grow into by performing recursive inlining.
9957 @option{--param max-inline-insns-recursive} applies to functions
9958 declared inline.
9959 For functions not declared inline, recursive inlining
9960 happens only when @option{-finline-functions} (included in @option{-O3}) is
9961 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9962 default value is 450.
9964 @item max-inline-recursive-depth
9965 @itemx max-inline-recursive-depth-auto
9966 Specifies the maximum recursion depth used for recursive inlining.
9968 @option{--param max-inline-recursive-depth} applies to functions
9969 declared inline.  For functions not declared inline, recursive inlining
9970 happens only when @option{-finline-functions} (included in @option{-O3}) is
9971 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9972 default value is 8.
9974 @item min-inline-recursive-probability
9975 Recursive inlining is profitable only for function having deep recursion
9976 in average and can hurt for function having little recursion depth by
9977 increasing the prologue size or complexity of function body to other
9978 optimizers.
9980 When profile feedback is available (see @option{-fprofile-generate}) the actual
9981 recursion depth can be guessed from the probability that function recurses
9982 via a given call expression.  This parameter limits inlining only to call
9983 expressions whose probability exceeds the given threshold (in percents).
9984 The default value is 10.
9986 @item early-inlining-insns
9987 Specify growth that the early inliner can make.  In effect it increases
9988 the amount of inlining for code having a large abstraction penalty.
9989 The default value is 14.
9991 @item max-early-inliner-iterations
9992 Limit of iterations of the early inliner.  This basically bounds
9993 the number of nested indirect calls the early inliner can resolve.
9994 Deeper chains are still handled by late inlining.
9996 @item comdat-sharing-probability
9997 Probability (in percent) that C++ inline function with comdat visibility
9998 are shared across multiple compilation units.  The default value is 20.
10000 @item profile-func-internal-id
10001 A parameter to control whether to use function internal id in profile
10002 database lookup. If the value is 0, the compiler uses an id that
10003 is based on function assembler name and filename, which makes old profile
10004 data more tolerant to source changes such as function reordering etc.
10005 The default value is 0.
10007 @item min-vect-loop-bound
10008 The minimum number of iterations under which loops are not vectorized
10009 when @option{-ftree-vectorize} is used.  The number of iterations after
10010 vectorization needs to be greater than the value specified by this option
10011 to allow vectorization.  The default value is 0.
10013 @item gcse-cost-distance-ratio
10014 Scaling factor in calculation of maximum distance an expression
10015 can be moved by GCSE optimizations.  This is currently supported only in the
10016 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10017 is with simple expressions, i.e., the expressions that have cost
10018 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10019 hoisting of simple expressions.  The default value is 10.
10021 @item gcse-unrestricted-cost
10022 Cost, roughly measured as the cost of a single typical machine
10023 instruction, at which GCSE optimizations do not constrain
10024 the distance an expression can travel.  This is currently
10025 supported only in the code hoisting pass.  The lesser the cost,
10026 the more aggressive code hoisting is.  Specifying 0 
10027 allows all expressions to travel unrestricted distances.
10028 The default value is 3.
10030 @item max-hoist-depth
10031 The depth of search in the dominator tree for expressions to hoist.
10032 This is used to avoid quadratic behavior in hoisting algorithm.
10033 The value of 0 does not limit on the search, but may slow down compilation
10034 of huge functions.  The default value is 30.
10036 @item max-tail-merge-comparisons
10037 The maximum amount of similar bbs to compare a bb with.  This is used to
10038 avoid quadratic behavior in tree tail merging.  The default value is 10.
10040 @item max-tail-merge-iterations
10041 The maximum amount of iterations of the pass over the function.  This is used to
10042 limit compilation time in tree tail merging.  The default value is 2.
10044 @item store-merging-allow-unaligned
10045 Allow the store merging pass to introduce unaligned stores if it is legal to
10046 do so.  The default value is 1.
10048 @item max-stores-to-merge
10049 The maximum number of stores to attempt to merge into wider stores in the store
10050 merging pass.  The minimum value is 2 and the default is 64.
10052 @item max-unrolled-insns
10053 The maximum number of instructions that a loop may have to be unrolled.
10054 If a loop is unrolled, this parameter also determines how many times
10055 the loop code is unrolled.
10057 @item max-average-unrolled-insns
10058 The maximum number of instructions biased by probabilities of their execution
10059 that a loop may have to be unrolled.  If a loop is unrolled,
10060 this parameter also determines how many times the loop code is unrolled.
10062 @item max-unroll-times
10063 The maximum number of unrollings of a single loop.
10065 @item max-peeled-insns
10066 The maximum number of instructions that a loop may have to be peeled.
10067 If a loop is peeled, this parameter also determines how many times
10068 the loop code is peeled.
10070 @item max-peel-times
10071 The maximum number of peelings of a single loop.
10073 @item max-peel-branches
10074 The maximum number of branches on the hot path through the peeled sequence.
10076 @item max-completely-peeled-insns
10077 The maximum number of insns of a completely peeled loop.
10079 @item max-completely-peel-times
10080 The maximum number of iterations of a loop to be suitable for complete peeling.
10082 @item max-completely-peel-loop-nest-depth
10083 The maximum depth of a loop nest suitable for complete peeling.
10085 @item max-unswitch-insns
10086 The maximum number of insns of an unswitched loop.
10088 @item max-unswitch-level
10089 The maximum number of branches unswitched in a single loop.
10091 @item max-loop-headers-insns
10092 The maximum number of insns in loop header duplicated by the copy loop headers
10093 pass.
10095 @item lim-expensive
10096 The minimum cost of an expensive expression in the loop invariant motion.
10098 @item iv-consider-all-candidates-bound
10099 Bound on number of candidates for induction variables, below which
10100 all candidates are considered for each use in induction variable
10101 optimizations.  If there are more candidates than this,
10102 only the most relevant ones are considered to avoid quadratic time complexity.
10104 @item iv-max-considered-uses
10105 The induction variable optimizations give up on loops that contain more
10106 induction variable uses.
10108 @item iv-always-prune-cand-set-bound
10109 If the number of candidates in the set is smaller than this value,
10110 always try to remove unnecessary ivs from the set
10111 when adding a new one.
10113 @item avg-loop-niter
10114 Average number of iterations of a loop.
10116 @item dse-max-object-size
10117 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10118 Larger values may result in larger compilation times.
10120 @item scev-max-expr-size
10121 Bound on size of expressions used in the scalar evolutions analyzer.
10122 Large expressions slow the analyzer.
10124 @item scev-max-expr-complexity
10125 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10126 Complex expressions slow the analyzer.
10128 @item max-tree-if-conversion-phi-args
10129 Maximum number of arguments in a PHI supported by TREE if conversion
10130 unless the loop is marked with simd pragma.
10132 @item vect-max-version-for-alignment-checks
10133 The maximum number of run-time checks that can be performed when
10134 doing loop versioning for alignment in the vectorizer.
10136 @item vect-max-version-for-alias-checks
10137 The maximum number of run-time checks that can be performed when
10138 doing loop versioning for alias in the vectorizer.
10140 @item vect-max-peeling-for-alignment
10141 The maximum number of loop peels to enhance access alignment
10142 for vectorizer. Value -1 means no limit.
10144 @item max-iterations-to-track
10145 The maximum number of iterations of a loop the brute-force algorithm
10146 for analysis of the number of iterations of the loop tries to evaluate.
10148 @item hot-bb-count-ws-permille
10149 A basic block profile count is considered hot if it contributes to 
10150 the given permillage (i.e. 0...1000) of the entire profiled execution.
10152 @item hot-bb-frequency-fraction
10153 Select fraction of the entry block frequency of executions of basic block in
10154 function given basic block needs to have to be considered hot.
10156 @item max-predicted-iterations
10157 The maximum number of loop iterations we predict statically.  This is useful
10158 in cases where a function contains a single loop with known bound and
10159 another loop with unknown bound.
10160 The known number of iterations is predicted correctly, while
10161 the unknown number of iterations average to roughly 10.  This means that the
10162 loop without bounds appears artificially cold relative to the other one.
10164 @item builtin-expect-probability
10165 Control the probability of the expression having the specified value. This
10166 parameter takes a percentage (i.e. 0 ... 100) as input.
10167 The default probability of 90 is obtained empirically.
10169 @item align-threshold
10171 Select fraction of the maximal frequency of executions of a basic block in
10172 a function to align the basic block.
10174 @item align-loop-iterations
10176 A loop expected to iterate at least the selected number of iterations is
10177 aligned.
10179 @item tracer-dynamic-coverage
10180 @itemx tracer-dynamic-coverage-feedback
10182 This value is used to limit superblock formation once the given percentage of
10183 executed instructions is covered.  This limits unnecessary code size
10184 expansion.
10186 The @option{tracer-dynamic-coverage-feedback} parameter
10187 is used only when profile
10188 feedback is available.  The real profiles (as opposed to statically estimated
10189 ones) are much less balanced allowing the threshold to be larger value.
10191 @item tracer-max-code-growth
10192 Stop tail duplication once code growth has reached given percentage.  This is
10193 a rather artificial limit, as most of the duplicates are eliminated later in
10194 cross jumping, so it may be set to much higher values than is the desired code
10195 growth.
10197 @item tracer-min-branch-ratio
10199 Stop reverse growth when the reverse probability of best edge is less than this
10200 threshold (in percent).
10202 @item tracer-min-branch-probability
10203 @itemx tracer-min-branch-probability-feedback
10205 Stop forward growth if the best edge has probability lower than this
10206 threshold.
10208 Similarly to @option{tracer-dynamic-coverage} two parameters are
10209 provided.  @option{tracer-min-branch-probability-feedback} is used for
10210 compilation with profile feedback and @option{tracer-min-branch-probability}
10211 compilation without.  The value for compilation with profile feedback
10212 needs to be more conservative (higher) in order to make tracer
10213 effective.
10215 @item stack-clash-protection-guard-size
10216 Specify the size of the operating system provided stack guard as
10217 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10218 Acceptable values are between 12 and 30.  Higher values may reduce the
10219 number of explicit probes, but a value larger than the operating system
10220 provided guard will leave code vulnerable to stack clash style attacks.
10222 @item stack-clash-protection-probe-interval
10223 Stack clash protection involves probing stack space as it is allocated.  This
10224 param controls the maximum distance between probes into the stack as 2 raised
10225 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10226 12.  Higher values may reduce the number of explicit probes, but a value
10227 larger than the operating system provided guard will leave code vulnerable to
10228 stack clash style attacks.
10230 @item max-cse-path-length
10232 The maximum number of basic blocks on path that CSE considers.
10233 The default is 10.
10235 @item max-cse-insns
10236 The maximum number of instructions CSE processes before flushing.
10237 The default is 1000.
10239 @item ggc-min-expand
10241 GCC uses a garbage collector to manage its own memory allocation.  This
10242 parameter specifies the minimum percentage by which the garbage
10243 collector's heap should be allowed to expand between collections.
10244 Tuning this may improve compilation speed; it has no effect on code
10245 generation.
10247 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10248 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10249 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10250 GCC is not able to calculate RAM on a particular platform, the lower
10251 bound of 30% is used.  Setting this parameter and
10252 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10253 every opportunity.  This is extremely slow, but can be useful for
10254 debugging.
10256 @item ggc-min-heapsize
10258 Minimum size of the garbage collector's heap before it begins bothering
10259 to collect garbage.  The first collection occurs after the heap expands
10260 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10261 tuning this may improve compilation speed, and has no effect on code
10262 generation.
10264 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10265 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10266 with a lower bound of 4096 (four megabytes) and an upper bound of
10267 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10268 particular platform, the lower bound is used.  Setting this parameter
10269 very large effectively disables garbage collection.  Setting this
10270 parameter and @option{ggc-min-expand} to zero causes a full collection
10271 to occur at every opportunity.
10273 @item max-reload-search-insns
10274 The maximum number of instruction reload should look backward for equivalent
10275 register.  Increasing values mean more aggressive optimization, making the
10276 compilation time increase with probably slightly better performance.
10277 The default value is 100.
10279 @item max-cselib-memory-locations
10280 The maximum number of memory locations cselib should take into account.
10281 Increasing values mean more aggressive optimization, making the compilation time
10282 increase with probably slightly better performance.  The default value is 500.
10284 @item max-sched-ready-insns
10285 The maximum number of instructions ready to be issued the scheduler should
10286 consider at any given time during the first scheduling pass.  Increasing
10287 values mean more thorough searches, making the compilation time increase
10288 with probably little benefit.  The default value is 100.
10290 @item max-sched-region-blocks
10291 The maximum number of blocks in a region to be considered for
10292 interblock scheduling.  The default value is 10.
10294 @item max-pipeline-region-blocks
10295 The maximum number of blocks in a region to be considered for
10296 pipelining in the selective scheduler.  The default value is 15.
10298 @item max-sched-region-insns
10299 The maximum number of insns in a region to be considered for
10300 interblock scheduling.  The default value is 100.
10302 @item max-pipeline-region-insns
10303 The maximum number of insns in a region to be considered for
10304 pipelining in the selective scheduler.  The default value is 200.
10306 @item min-spec-prob
10307 The minimum probability (in percents) of reaching a source block
10308 for interblock speculative scheduling.  The default value is 40.
10310 @item max-sched-extend-regions-iters
10311 The maximum number of iterations through CFG to extend regions.
10312 A value of 0 (the default) disables region extensions.
10314 @item max-sched-insn-conflict-delay
10315 The maximum conflict delay for an insn to be considered for speculative motion.
10316 The default value is 3.
10318 @item sched-spec-prob-cutoff
10319 The minimal probability of speculation success (in percents), so that
10320 speculative insns are scheduled.
10321 The default value is 40.
10323 @item sched-state-edge-prob-cutoff
10324 The minimum probability an edge must have for the scheduler to save its
10325 state across it.
10326 The default value is 10.
10328 @item sched-mem-true-dep-cost
10329 Minimal distance (in CPU cycles) between store and load targeting same
10330 memory locations.  The default value is 1.
10332 @item selsched-max-lookahead
10333 The maximum size of the lookahead window of selective scheduling.  It is a
10334 depth of search for available instructions.
10335 The default value is 50.
10337 @item selsched-max-sched-times
10338 The maximum number of times that an instruction is scheduled during
10339 selective scheduling.  This is the limit on the number of iterations
10340 through which the instruction may be pipelined.  The default value is 2.
10342 @item selsched-insns-to-rename
10343 The maximum number of best instructions in the ready list that are considered
10344 for renaming in the selective scheduler.  The default value is 2.
10346 @item sms-min-sc
10347 The minimum value of stage count that swing modulo scheduler
10348 generates.  The default value is 2.
10350 @item max-last-value-rtl
10351 The maximum size measured as number of RTLs that can be recorded in an expression
10352 in combiner for a pseudo register as last known value of that register.  The default
10353 is 10000.
10355 @item max-combine-insns
10356 The maximum number of instructions the RTL combiner tries to combine.
10357 The default value is 2 at @option{-Og} and 4 otherwise.
10359 @item integer-share-limit
10360 Small integer constants can use a shared data structure, reducing the
10361 compiler's memory usage and increasing its speed.  This sets the maximum
10362 value of a shared integer constant.  The default value is 256.
10364 @item ssp-buffer-size
10365 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10366 protection when @option{-fstack-protection} is used.
10368 @item min-size-for-stack-sharing
10369 The minimum size of variables taking part in stack slot sharing when not
10370 optimizing. The default value is 32.
10372 @item max-jump-thread-duplication-stmts
10373 Maximum number of statements allowed in a block that needs to be
10374 duplicated when threading jumps.
10376 @item max-fields-for-field-sensitive
10377 Maximum number of fields in a structure treated in
10378 a field sensitive manner during pointer analysis.  The default is zero
10379 for @option{-O0} and @option{-O1},
10380 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10382 @item prefetch-latency
10383 Estimate on average number of instructions that are executed before
10384 prefetch finishes.  The distance prefetched ahead is proportional
10385 to this constant.  Increasing this number may also lead to less
10386 streams being prefetched (see @option{simultaneous-prefetches}).
10388 @item simultaneous-prefetches
10389 Maximum number of prefetches that can run at the same time.
10391 @item l1-cache-line-size
10392 The size of cache line in L1 cache, in bytes.
10394 @item l1-cache-size
10395 The size of L1 cache, in kilobytes.
10397 @item l2-cache-size
10398 The size of L2 cache, in kilobytes.
10400 @item min-insn-to-prefetch-ratio
10401 The minimum ratio between the number of instructions and the
10402 number of prefetches to enable prefetching in a loop.
10404 @item prefetch-min-insn-to-mem-ratio
10405 The minimum ratio between the number of instructions and the
10406 number of memory references to enable prefetching in a loop.
10408 @item use-canonical-types
10409 Whether the compiler should use the ``canonical'' type system.  By
10410 default, this should always be 1, which uses a more efficient internal
10411 mechanism for comparing types in C++ and Objective-C++.  However, if
10412 bugs in the canonical type system are causing compilation failures,
10413 set this value to 0 to disable canonical types.
10415 @item switch-conversion-max-branch-ratio
10416 Switch initialization conversion refuses to create arrays that are
10417 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10418 branches in the switch.
10420 @item max-partial-antic-length
10421 Maximum length of the partial antic set computed during the tree
10422 partial redundancy elimination optimization (@option{-ftree-pre}) when
10423 optimizing at @option{-O3} and above.  For some sorts of source code
10424 the enhanced partial redundancy elimination optimization can run away,
10425 consuming all of the memory available on the host machine.  This
10426 parameter sets a limit on the length of the sets that are computed,
10427 which prevents the runaway behavior.  Setting a value of 0 for
10428 this parameter allows an unlimited set length.
10430 @item sccvn-max-scc-size
10431 Maximum size of a strongly connected component (SCC) during SCCVN
10432 processing.  If this limit is hit, SCCVN processing for the whole
10433 function is not done and optimizations depending on it are
10434 disabled.  The default maximum SCC size is 10000.
10436 @item sccvn-max-alias-queries-per-access
10437 Maximum number of alias-oracle queries we perform when looking for
10438 redundancies for loads and stores.  If this limit is hit the search
10439 is aborted and the load or store is not considered redundant.  The
10440 number of queries is algorithmically limited to the number of
10441 stores on all paths from the load to the function entry.
10442 The default maximum number of queries is 1000.
10444 @item ira-max-loops-num
10445 IRA uses regional register allocation by default.  If a function
10446 contains more loops than the number given by this parameter, only at most
10447 the given number of the most frequently-executed loops form regions
10448 for regional register allocation.  The default value of the
10449 parameter is 100.
10451 @item ira-max-conflict-table-size 
10452 Although IRA uses a sophisticated algorithm to compress the conflict
10453 table, the table can still require excessive amounts of memory for
10454 huge functions.  If the conflict table for a function could be more
10455 than the size in MB given by this parameter, the register allocator
10456 instead uses a faster, simpler, and lower-quality
10457 algorithm that does not require building a pseudo-register conflict table.  
10458 The default value of the parameter is 2000.
10460 @item ira-loop-reserved-regs
10461 IRA can be used to evaluate more accurate register pressure in loops
10462 for decisions to move loop invariants (see @option{-O3}).  The number
10463 of available registers reserved for some other purposes is given
10464 by this parameter.  The default value of the parameter is 2, which is
10465 the minimal number of registers needed by typical instructions.
10466 This value is the best found from numerous experiments.
10468 @item lra-inheritance-ebb-probability-cutoff
10469 LRA tries to reuse values reloaded in registers in subsequent insns.
10470 This optimization is called inheritance.  EBB is used as a region to
10471 do this optimization.  The parameter defines a minimal fall-through
10472 edge probability in percentage used to add BB to inheritance EBB in
10473 LRA.  The default value of the parameter is 40.  The value was chosen
10474 from numerous runs of SPEC2000 on x86-64.
10476 @item loop-invariant-max-bbs-in-loop
10477 Loop invariant motion can be very expensive, both in compilation time and
10478 in amount of needed compile-time memory, with very large loops.  Loops
10479 with more basic blocks than this parameter won't have loop invariant
10480 motion optimization performed on them.  The default value of the
10481 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10483 @item loop-max-datarefs-for-datadeps
10484 Building data dependencies is expensive for very large loops.  This
10485 parameter limits the number of data references in loops that are
10486 considered for data dependence analysis.  These large loops are no
10487 handled by the optimizations using loop data dependencies.
10488 The default value is 1000.
10490 @item max-vartrack-size
10491 Sets a maximum number of hash table slots to use during variable
10492 tracking dataflow analysis of any function.  If this limit is exceeded
10493 with variable tracking at assignments enabled, analysis for that
10494 function is retried without it, after removing all debug insns from
10495 the function.  If the limit is exceeded even without debug insns, var
10496 tracking analysis is completely disabled for the function.  Setting
10497 the parameter to zero makes it unlimited.
10499 @item max-vartrack-expr-depth
10500 Sets a maximum number of recursion levels when attempting to map
10501 variable names or debug temporaries to value expressions.  This trades
10502 compilation time for more complete debug information.  If this is set too
10503 low, value expressions that are available and could be represented in
10504 debug information may end up not being used; setting this higher may
10505 enable the compiler to find more complex debug expressions, but compile
10506 time and memory use may grow.  The default is 12.
10508 @item min-nondebug-insn-uid
10509 Use uids starting at this parameter for nondebug insns.  The range below
10510 the parameter is reserved exclusively for debug insns created by
10511 @option{-fvar-tracking-assignments}, but debug insns may get
10512 (non-overlapping) uids above it if the reserved range is exhausted.
10514 @item ipa-sra-ptr-growth-factor
10515 IPA-SRA replaces a pointer to an aggregate with one or more new
10516 parameters only when their cumulative size is less or equal to
10517 @option{ipa-sra-ptr-growth-factor} times the size of the original
10518 pointer parameter.
10520 @item sra-max-scalarization-size-Ospeed
10521 @item sra-max-scalarization-size-Osize
10522 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10523 replace scalar parts of aggregates with uses of independent scalar
10524 variables.  These parameters control the maximum size, in storage units,
10525 of aggregate which is considered for replacement when compiling for
10526 speed
10527 (@option{sra-max-scalarization-size-Ospeed}) or size
10528 (@option{sra-max-scalarization-size-Osize}) respectively.
10530 @item tm-max-aggregate-size
10531 When making copies of thread-local variables in a transaction, this
10532 parameter specifies the size in bytes after which variables are
10533 saved with the logging functions as opposed to save/restore code
10534 sequence pairs.  This option only applies when using
10535 @option{-fgnu-tm}.
10537 @item graphite-max-nb-scop-params
10538 To avoid exponential effects in the Graphite loop transforms, the
10539 number of parameters in a Static Control Part (SCoP) is bounded.  The
10540 default value is 10 parameters, a value of zero can be used to lift
10541 the bound.  A variable whose value is unknown at compilation time and
10542 defined outside a SCoP is a parameter of the SCoP.
10544 @item loop-block-tile-size
10545 Loop blocking or strip mining transforms, enabled with
10546 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10547 loop in the loop nest by a given number of iterations.  The strip
10548 length can be changed using the @option{loop-block-tile-size}
10549 parameter.  The default value is 51 iterations.
10551 @item loop-unroll-jam-size
10552 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10553 default value is 4.
10555 @item loop-unroll-jam-depth
10556 Specify the dimension to be unrolled (counting from the most inner loop)
10557 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10559 @item ipa-cp-value-list-size
10560 IPA-CP attempts to track all possible values and types passed to a function's
10561 parameter in order to propagate them and perform devirtualization.
10562 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10563 stores per one formal parameter of a function.
10565 @item ipa-cp-eval-threshold
10566 IPA-CP calculates its own score of cloning profitability heuristics
10567 and performs those cloning opportunities with scores that exceed
10568 @option{ipa-cp-eval-threshold}.
10570 @item ipa-cp-recursion-penalty
10571 Percentage penalty the recursive functions will receive when they
10572 are evaluated for cloning.
10574 @item ipa-cp-single-call-penalty
10575 Percentage penalty functions containing a single call to another
10576 function will receive when they are evaluated for cloning.
10579 @item ipa-max-agg-items
10580 IPA-CP is also capable to propagate a number of scalar values passed
10581 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10582 number of such values per one parameter.
10584 @item ipa-cp-loop-hint-bonus
10585 When IPA-CP determines that a cloning candidate would make the number
10586 of iterations of a loop known, it adds a bonus of
10587 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10588 the candidate.
10590 @item ipa-cp-array-index-hint-bonus
10591 When IPA-CP determines that a cloning candidate would make the index of
10592 an array access known, it adds a bonus of
10593 @option{ipa-cp-array-index-hint-bonus} to the profitability
10594 score of the candidate.
10596 @item ipa-max-aa-steps
10597 During its analysis of function bodies, IPA-CP employs alias analysis
10598 in order to track values pointed to by function parameters.  In order
10599 not spend too much time analyzing huge functions, it gives up and
10600 consider all memory clobbered after examining
10601 @option{ipa-max-aa-steps} statements modifying memory.
10603 @item lto-partitions
10604 Specify desired number of partitions produced during WHOPR compilation.
10605 The number of partitions should exceed the number of CPUs used for compilation.
10606 The default value is 32.
10608 @item lto-min-partition
10609 Size of minimal partition for WHOPR (in estimated instructions).
10610 This prevents expenses of splitting very small programs into too many
10611 partitions.
10613 @item lto-max-partition
10614 Size of max partition for WHOPR (in estimated instructions).
10615 to provide an upper bound for individual size of partition.
10616 Meant to be used only with balanced partitioning.
10618 @item cxx-max-namespaces-for-diagnostic-help
10619 The maximum number of namespaces to consult for suggestions when C++
10620 name lookup fails for an identifier.  The default is 1000.
10622 @item sink-frequency-threshold
10623 The maximum relative execution frequency (in percents) of the target block
10624 relative to a statement's original block to allow statement sinking of a
10625 statement.  Larger numbers result in more aggressive statement sinking.
10626 The default value is 75.  A small positive adjustment is applied for
10627 statements with memory operands as those are even more profitable so sink.
10629 @item max-stores-to-sink
10630 The maximum number of conditional store pairs that can be sunk.  Set to 0
10631 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10632 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10634 @item allow-store-data-races
10635 Allow optimizers to introduce new data races on stores.
10636 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10637 at optimization level @option{-Ofast}.
10639 @item case-values-threshold
10640 The smallest number of different values for which it is best to use a
10641 jump-table instead of a tree of conditional branches.  If the value is
10642 0, use the default for the machine.  The default is 0.
10644 @item tree-reassoc-width
10645 Set the maximum number of instructions executed in parallel in
10646 reassociated tree. This parameter overrides target dependent
10647 heuristics used by default if has non zero value.
10649 @item sched-pressure-algorithm
10650 Choose between the two available implementations of
10651 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10652 and is the more likely to prevent instructions from being reordered.
10653 Algorithm 2 was designed to be a compromise between the relatively
10654 conservative approach taken by algorithm 1 and the rather aggressive
10655 approach taken by the default scheduler.  It relies more heavily on
10656 having a regular register file and accurate register pressure classes.
10657 See @file{haifa-sched.c} in the GCC sources for more details.
10659 The default choice depends on the target.
10661 @item max-slsr-cand-scan
10662 Set the maximum number of existing candidates that are considered when
10663 seeking a basis for a new straight-line strength reduction candidate.
10665 @item asan-globals
10666 Enable buffer overflow detection for global objects.  This kind
10667 of protection is enabled by default if you are using
10668 @option{-fsanitize=address} option.
10669 To disable global objects protection use @option{--param asan-globals=0}.
10671 @item asan-stack
10672 Enable buffer overflow detection for stack objects.  This kind of
10673 protection is enabled by default when using @option{-fsanitize=address}.
10674 To disable stack protection use @option{--param asan-stack=0} option.
10676 @item asan-instrument-reads
10677 Enable buffer overflow detection for memory reads.  This kind of
10678 protection is enabled by default when using @option{-fsanitize=address}.
10679 To disable memory reads protection use
10680 @option{--param asan-instrument-reads=0}.
10682 @item asan-instrument-writes
10683 Enable buffer overflow detection for memory writes.  This kind of
10684 protection is enabled by default when using @option{-fsanitize=address}.
10685 To disable memory writes protection use
10686 @option{--param asan-instrument-writes=0} option.
10688 @item asan-memintrin
10689 Enable detection for built-in functions.  This kind of protection
10690 is enabled by default when using @option{-fsanitize=address}.
10691 To disable built-in functions protection use
10692 @option{--param asan-memintrin=0}.
10694 @item asan-use-after-return
10695 Enable detection of use-after-return.  This kind of protection
10696 is enabled by default when using the @option{-fsanitize=address} option.
10697 To disable it use @option{--param asan-use-after-return=0}.
10699 Note: By default the check is disabled at run time.  To enable it,
10700 add @code{detect_stack_use_after_return=1} to the environment variable
10701 @env{ASAN_OPTIONS}.
10703 @item asan-instrumentation-with-call-threshold
10704 If number of memory accesses in function being instrumented
10705 is greater or equal to this number, use callbacks instead of inline checks.
10706 E.g. to disable inline code use
10707 @option{--param asan-instrumentation-with-call-threshold=0}.
10709 @item use-after-scope-direct-emission-threshold
10710 If the size of a local variable in bytes is smaller or equal to this
10711 number, directly poison (or unpoison) shadow memory instead of using
10712 run-time callbacks.  The default value is 256.
10714 @item chkp-max-ctor-size
10715 Static constructors generated by Pointer Bounds Checker may become very
10716 large and significantly increase compile time at optimization level
10717 @option{-O1} and higher.  This parameter is a maximum number of statements
10718 in a single generated constructor.  Default value is 5000.
10720 @item max-fsm-thread-path-insns
10721 Maximum number of instructions to copy when duplicating blocks on a
10722 finite state automaton jump thread path.  The default is 100.
10724 @item max-fsm-thread-length
10725 Maximum number of basic blocks on a finite state automaton jump thread
10726 path.  The default is 10.
10728 @item max-fsm-thread-paths
10729 Maximum number of new jump thread paths to create for a finite state
10730 automaton.  The default is 50.
10732 @item parloops-chunk-size
10733 Chunk size of omp schedule for loops parallelized by parloops.  The default
10734 is 0.
10736 @item parloops-schedule
10737 Schedule type of omp schedule for loops parallelized by parloops (static,
10738 dynamic, guided, auto, runtime).  The default is static.
10740 @item max-ssa-name-query-depth
10741 Maximum depth of recursion when querying properties of SSA names in things
10742 like fold routines.  One level of recursion corresponds to following a
10743 use-def chain.
10745 @item hsa-gen-debug-stores
10746 Enable emission of special debug stores within HSA kernels which are
10747 then read and reported by libgomp plugin.  Generation of these stores
10748 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10749 enable it.
10751 @item max-speculative-devirt-maydefs
10752 The maximum number of may-defs we analyze when looking for a must-def
10753 specifying the dynamic type of an object that invokes a virtual call
10754 we may be able to devirtualize speculatively.
10756 @item max-vrp-switch-assertions
10757 The maximum number of assertions to add along the default edge of a switch
10758 statement during VRP.  The default is 10.
10759 @end table
10760 @end table
10762 @node Instrumentation Options
10763 @section Program Instrumentation Options
10764 @cindex instrumentation options
10765 @cindex program instrumentation options
10766 @cindex run-time error checking options
10767 @cindex profiling options
10768 @cindex options, program instrumentation
10769 @cindex options, run-time error checking
10770 @cindex options, profiling
10772 GCC supports a number of command-line options that control adding
10773 run-time instrumentation to the code it normally generates.  
10774 For example, one purpose of instrumentation is collect profiling
10775 statistics for use in finding program hot spots, code coverage
10776 analysis, or profile-guided optimizations.
10777 Another class of program instrumentation is adding run-time checking 
10778 to detect programming errors like invalid pointer
10779 dereferences or out-of-bounds array accesses, as well as deliberately
10780 hostile attacks such as stack smashing or C++ vtable hijacking.
10781 There is also a general hook which can be used to implement other
10782 forms of tracing or function-level instrumentation for debug or
10783 program analysis purposes.
10785 @table @gcctabopt
10786 @cindex @command{prof}
10787 @item -p
10788 @opindex p
10789 Generate extra code to write profile information suitable for the
10790 analysis program @command{prof}.  You must use this option when compiling
10791 the source files you want data about, and you must also use it when
10792 linking.
10794 @cindex @command{gprof}
10795 @item -pg
10796 @opindex pg
10797 Generate extra code to write profile information suitable for the
10798 analysis program @command{gprof}.  You must use this option when compiling
10799 the source files you want data about, and you must also use it when
10800 linking.
10802 @item -fprofile-arcs
10803 @opindex fprofile-arcs
10804 Add code so that program flow @dfn{arcs} are instrumented.  During
10805 execution the program records how many times each branch and call is
10806 executed and how many times it is taken or returns.  On targets that support
10807 constructors with priority support, profiling properly handles constructors,
10808 destructors and C++ constructors (and destructors) of classes which are used
10809 as a type of a global variable.
10811 When the compiled
10812 program exits it saves this data to a file called
10813 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10814 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10815 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10816 @var{auxname} is generated from the name of the output file, if
10817 explicitly specified and it is not the final executable, otherwise it is
10818 the basename of the source file.  In both cases any suffix is removed
10819 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10820 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10821 @xref{Cross-profiling}.
10823 @cindex @command{gcov}
10824 @item --coverage
10825 @opindex coverage
10827 This option is used to compile and link code instrumented for coverage
10828 analysis.  The option is a synonym for @option{-fprofile-arcs}
10829 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10830 linking).  See the documentation for those options for more details.
10832 @itemize
10834 @item
10835 Compile the source files with @option{-fprofile-arcs} plus optimization
10836 and code generation options.  For test coverage analysis, use the
10837 additional @option{-ftest-coverage} option.  You do not need to profile
10838 every source file in a program.
10840 @item
10841 Compile the source files additionally with @option{-fprofile-abs-path}
10842 to create absolute path names in the @file{.gcno} files.  This allows
10843 @command{gcov} to find the correct sources in projects where compilations
10844 occur with different working directories.
10846 @item
10847 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10848 (the latter implies the former).
10850 @item
10851 Run the program on a representative workload to generate the arc profile
10852 information.  This may be repeated any number of times.  You can run
10853 concurrent instances of your program, and provided that the file system
10854 supports locking, the data files will be correctly updated.  Also
10855 @code{fork} calls are detected and correctly handled (double counting
10856 will not happen).
10858 @item
10859 For profile-directed optimizations, compile the source files again with
10860 the same optimization and code generation options plus
10861 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10862 Control Optimization}).
10864 @item
10865 For test coverage analysis, use @command{gcov} to produce human readable
10866 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10867 @command{gcov} documentation for further information.
10869 @end itemize
10871 With @option{-fprofile-arcs}, for each function of your program GCC
10872 creates a program flow graph, then finds a spanning tree for the graph.
10873 Only arcs that are not on the spanning tree have to be instrumented: the
10874 compiler adds code to count the number of times that these arcs are
10875 executed.  When an arc is the only exit or only entrance to a block, the
10876 instrumentation code can be added to the block; otherwise, a new basic
10877 block must be created to hold the instrumentation code.
10879 @need 2000
10880 @item -ftest-coverage
10881 @opindex ftest-coverage
10882 Produce a notes file that the @command{gcov} code-coverage utility
10883 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10884 show program coverage.  Each source file's note file is called
10885 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10886 above for a description of @var{auxname} and instructions on how to
10887 generate test coverage data.  Coverage data matches the source files
10888 more closely if you do not optimize.
10890 @item -fprofile-abs-path
10891 @opindex fprofile-abs-path
10892 Automatically convert relative source file names to absolute path names
10893 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
10894 sources in projects where compilations occur with different working
10895 directories.
10897 @item -fprofile-dir=@var{path}
10898 @opindex fprofile-dir
10900 Set the directory to search for the profile data files in to @var{path}.
10901 This option affects only the profile data generated by
10902 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10903 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10904 and its related options.  Both absolute and relative paths can be used.
10905 By default, GCC uses the current directory as @var{path}, thus the
10906 profile data file appears in the same directory as the object file.
10908 @item -fprofile-generate
10909 @itemx -fprofile-generate=@var{path}
10910 @opindex fprofile-generate
10912 Enable options usually used for instrumenting application to produce
10913 profile useful for later recompilation with profile feedback based
10914 optimization.  You must use @option{-fprofile-generate} both when
10915 compiling and when linking your program.
10917 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10919 If @var{path} is specified, GCC looks at the @var{path} to find
10920 the profile feedback data files. See @option{-fprofile-dir}.
10922 To optimize the program based on the collected profile information, use
10923 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10925 @item -fprofile-update=@var{method}
10926 @opindex fprofile-update
10928 Alter the update method for an application instrumented for profile
10929 feedback based optimization.  The @var{method} argument should be one of
10930 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10931 The first one is useful for single-threaded applications,
10932 while the second one prevents profile corruption by emitting thread-safe code.
10934 @strong{Warning:} When an application does not properly join all threads
10935 (or creates an detached thread), a profile file can be still corrupted.
10937 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10938 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10939 automatically selects @samp{prefer-atomic} when @option{-pthread}
10940 is present in the command line.
10942 @item -fsanitize=address
10943 @opindex fsanitize=address
10944 Enable AddressSanitizer, a fast memory error detector.
10945 Memory access instructions are instrumented to detect
10946 out-of-bounds and use-after-free bugs.
10947 The option enables @option{-fsanitize-address-use-after-scope}.
10948 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10949 more details.  The run-time behavior can be influenced using the
10950 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10951 the available options are shown at startup of the instrumented program.  See
10952 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10953 for a list of supported options.
10954 The option cannot be combined with @option{-fsanitize=thread}
10955 and/or @option{-fcheck-pointer-bounds}.
10957 @item -fsanitize=kernel-address
10958 @opindex fsanitize=kernel-address
10959 Enable AddressSanitizer for Linux kernel.
10960 See @uref{https://github.com/google/kasan/wiki} for more details.
10961 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10963 @item -fsanitize=thread
10964 @opindex fsanitize=thread
10965 Enable ThreadSanitizer, a fast data race detector.
10966 Memory access instructions are instrumented to detect
10967 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10968 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10969 environment variable; see
10970 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10971 supported options.
10972 The option cannot be combined with @option{-fsanitize=address},
10973 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
10975 Note that sanitized atomic builtins cannot throw exceptions when
10976 operating on invalid memory addresses with non-call exceptions
10977 (@option{-fnon-call-exceptions}).
10979 @item -fsanitize=leak
10980 @opindex fsanitize=leak
10981 Enable LeakSanitizer, a memory leak detector.
10982 This option only matters for linking of executables and
10983 the executable is linked against a library that overrides @code{malloc}
10984 and other allocator functions.  See
10985 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10986 details.  The run-time behavior can be influenced using the
10987 @env{LSAN_OPTIONS} environment variable.
10988 The option cannot be combined with @option{-fsanitize=thread}.
10990 @item -fsanitize=undefined
10991 @opindex fsanitize=undefined
10992 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10993 Various computations are instrumented to detect undefined behavior
10994 at runtime.  Current suboptions are:
10996 @table @gcctabopt
10998 @item -fsanitize=shift
10999 @opindex fsanitize=shift
11000 This option enables checking that the result of a shift operation is
11001 not undefined.  Note that what exactly is considered undefined differs
11002 slightly between C and C++, as well as between ISO C90 and C99, etc.
11003 This option has two suboptions, @option{-fsanitize=shift-base} and
11004 @option{-fsanitize=shift-exponent}.
11006 @item -fsanitize=shift-exponent
11007 @opindex fsanitize=shift-exponent
11008 This option enables checking that the second argument of a shift operation
11009 is not negative and is smaller than the precision of the promoted first
11010 argument.
11012 @item -fsanitize=shift-base
11013 @opindex fsanitize=shift-base
11014 If the second argument of a shift operation is within range, check that the
11015 result of a shift operation is not undefined.  Note that what exactly is
11016 considered undefined differs slightly between C and C++, as well as between
11017 ISO C90 and C99, etc.
11019 @item -fsanitize=integer-divide-by-zero
11020 @opindex fsanitize=integer-divide-by-zero
11021 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11023 @item -fsanitize=unreachable
11024 @opindex fsanitize=unreachable
11025 With this option, the compiler turns the @code{__builtin_unreachable}
11026 call into a diagnostics message call instead.  When reaching the
11027 @code{__builtin_unreachable} call, the behavior is undefined.
11029 @item -fsanitize=vla-bound
11030 @opindex fsanitize=vla-bound
11031 This option instructs the compiler to check that the size of a variable
11032 length array is positive.
11034 @item -fsanitize=null
11035 @opindex fsanitize=null
11036 This option enables pointer checking.  Particularly, the application
11037 built with this option turned on will issue an error message when it
11038 tries to dereference a NULL pointer, or if a reference (possibly an
11039 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11040 on an object pointed by a NULL pointer.
11042 @item -fsanitize=return
11043 @opindex fsanitize=return
11044 This option enables return statement checking.  Programs
11045 built with this option turned on will issue an error message
11046 when the end of a non-void function is reached without actually
11047 returning a value.  This option works in C++ only.
11049 @item -fsanitize=signed-integer-overflow
11050 @opindex fsanitize=signed-integer-overflow
11051 This option enables signed integer overflow checking.  We check that
11052 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11053 does not overflow in the signed arithmetics.  Note, integer promotion
11054 rules must be taken into account.  That is, the following is not an
11055 overflow:
11056 @smallexample
11057 signed char a = SCHAR_MAX;
11058 a++;
11059 @end smallexample
11061 @item -fsanitize=bounds
11062 @opindex fsanitize=bounds
11063 This option enables instrumentation of array bounds.  Various out of bounds
11064 accesses are detected.  Flexible array members, flexible array member-like
11065 arrays, and initializers of variables with static storage are not instrumented.
11066 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11068 @item -fsanitize=bounds-strict
11069 @opindex fsanitize=bounds-strict
11070 This option enables strict instrumentation of array bounds.  Most out of bounds
11071 accesses are detected, including flexible array members and flexible array
11072 member-like arrays.  Initializers of variables with static storage are not
11073 instrumented.  The option cannot be combined
11074 with @option{-fcheck-pointer-bounds}.
11076 @item -fsanitize=alignment
11077 @opindex fsanitize=alignment
11079 This option enables checking of alignment of pointers when they are
11080 dereferenced, or when a reference is bound to insufficiently aligned target,
11081 or when a method or constructor is invoked on insufficiently aligned object.
11083 @item -fsanitize=object-size
11084 @opindex fsanitize=object-size
11085 This option enables instrumentation of memory references using the
11086 @code{__builtin_object_size} function.  Various out of bounds pointer
11087 accesses are detected.
11089 @item -fsanitize=float-divide-by-zero
11090 @opindex fsanitize=float-divide-by-zero
11091 Detect floating-point division by zero.  Unlike other similar options,
11092 @option{-fsanitize=float-divide-by-zero} is not enabled by
11093 @option{-fsanitize=undefined}, since floating-point division by zero can
11094 be a legitimate way of obtaining infinities and NaNs.
11096 @item -fsanitize=float-cast-overflow
11097 @opindex fsanitize=float-cast-overflow
11098 This option enables floating-point type to integer conversion checking.
11099 We check that the result of the conversion does not overflow.
11100 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11101 not enabled by @option{-fsanitize=undefined}.
11102 This option does not work well with @code{FE_INVALID} exceptions enabled.
11104 @item -fsanitize=nonnull-attribute
11105 @opindex fsanitize=nonnull-attribute
11107 This option enables instrumentation of calls, checking whether null values
11108 are not passed to arguments marked as requiring a non-null value by the
11109 @code{nonnull} function attribute.
11111 @item -fsanitize=returns-nonnull-attribute
11112 @opindex fsanitize=returns-nonnull-attribute
11114 This option enables instrumentation of return statements in functions
11115 marked with @code{returns_nonnull} function attribute, to detect returning
11116 of null values from such functions.
11118 @item -fsanitize=bool
11119 @opindex fsanitize=bool
11121 This option enables instrumentation of loads from bool.  If a value other
11122 than 0/1 is loaded, a run-time error is issued.
11124 @item -fsanitize=enum
11125 @opindex fsanitize=enum
11127 This option enables instrumentation of loads from an enum type.  If
11128 a value outside the range of values for the enum type is loaded,
11129 a run-time error is issued.
11131 @item -fsanitize=vptr
11132 @opindex fsanitize=vptr
11134 This option enables instrumentation of C++ member function calls, member
11135 accesses and some conversions between pointers to base and derived classes,
11136 to verify the referenced object has the correct dynamic type.
11138 @item -fsanitize=pointer-overflow
11139 @opindex fsanitize=pointer-overflow
11141 This option enables instrumentation of pointer arithmetics.  If the pointer
11142 arithmetics overflows, a run-time error is issued.
11144 @end table
11146 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11147 @option{-fsanitize=undefined} gives a diagnostic message.
11148 This currently works only for the C family of languages.
11150 @item -fno-sanitize=all
11151 @opindex fno-sanitize=all
11153 This option disables all previously enabled sanitizers.
11154 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11155 together.
11157 @item -fasan-shadow-offset=@var{number}
11158 @opindex fasan-shadow-offset
11159 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11160 It is useful for experimenting with different shadow memory layouts in
11161 Kernel AddressSanitizer.
11163 @item -fsanitize-sections=@var{s1},@var{s2},...
11164 @opindex fsanitize-sections
11165 Sanitize global variables in selected user-defined sections.  @var{si} may
11166 contain wildcards.
11168 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11169 @opindex fsanitize-recover
11170 @opindex fno-sanitize-recover
11171 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11172 mentioned in comma-separated list of @var{opts}.  Enabling this option
11173 for a sanitizer component causes it to attempt to continue
11174 running the program as if no error happened.  This means multiple
11175 runtime errors can be reported in a single program run, and the exit
11176 code of the program may indicate success even when errors
11177 have been reported.  The @option{-fno-sanitize-recover=} option
11178 can be used to alter
11179 this behavior: only the first detected error is reported
11180 and program then exits with a non-zero exit code.
11182 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11183 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11184 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11185 @option{-fsanitize=bounds-strict},
11186 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11187 For these sanitizers error recovery is turned on by default,
11188 except @option{-fsanitize=address}, for which this feature is experimental.
11189 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11190 accepted, the former enables recovery for all sanitizers that support it,
11191 the latter disables recovery for all sanitizers that support it.
11193 Even if a recovery mode is turned on the compiler side, it needs to be also
11194 enabled on the runtime library side, otherwise the failures are still fatal.
11195 The runtime library defaults to @code{halt_on_error=0} for
11196 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11197 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11198 setting the @code{halt_on_error} flag in the corresponding environment variable.
11200 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11201 equivalent to specifying an @var{opts} list of:
11203 @smallexample
11204 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11205 @end smallexample
11207 @item -fsanitize-address-use-after-scope
11208 @opindex fsanitize-address-use-after-scope
11209 Enable sanitization of local variables to detect use-after-scope bugs.
11210 The option sets @option{-fstack-reuse} to @samp{none}.
11212 @item -fsanitize-undefined-trap-on-error
11213 @opindex fsanitize-undefined-trap-on-error
11214 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11215 report undefined behavior using @code{__builtin_trap} rather than
11216 a @code{libubsan} library routine.  The advantage of this is that the
11217 @code{libubsan} library is not needed and is not linked in, so this
11218 is usable even in freestanding environments.
11220 @item -fsanitize-coverage=trace-pc
11221 @opindex fsanitize-coverage=trace-pc
11222 Enable coverage-guided fuzzing code instrumentation.
11223 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11225 @item -fsanitize-coverage=trace-cmp
11226 @opindex fsanitize-coverage=trace-cmp
11227 Enable dataflow guided fuzzing code instrumentation.
11228 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11229 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11230 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11231 variable or @code{__sanitizer_cov_trace_const_cmp1},
11232 @code{__sanitizer_cov_trace_const_cmp2},
11233 @code{__sanitizer_cov_trace_const_cmp4} or
11234 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11235 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11236 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11237 @code{__sanitizer_cov_trace_switch} for switch statements.
11239 @item -fbounds-check
11240 @opindex fbounds-check
11241 For front ends that support it, generate additional code to check that
11242 indices used to access arrays are within the declared range.  This is
11243 currently only supported by the Fortran front end, where this option
11244 defaults to false.
11246 @item -fcheck-pointer-bounds
11247 @opindex fcheck-pointer-bounds
11248 @opindex fno-check-pointer-bounds
11249 @cindex Pointer Bounds Checker options
11250 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11251 is instrumented with checks of the pointer used for memory access against
11252 bounds associated with that pointer.  
11254 Currently there
11255 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11256 and @option{-mmpx} are required to enable this feature.  
11257 MPX-based instrumentation requires
11258 a runtime library to enable MPX in hardware and handle bounds
11259 violation signals.  By default when @option{-fcheck-pointer-bounds}
11260 and @option{-mmpx} options are used to link a program, the GCC driver
11261 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11262 Bounds checking on calls to dynamic libraries requires a linker
11263 with @option{-z bndplt} support; if GCC was configured with a linker
11264 without support for this option (including the Gold linker and older
11265 versions of ld), a warning is given if you link with @option{-mmpx}
11266 without also specifying @option{-static}, since the overall effectiveness
11267 of the bounds checking protection is reduced.
11268 See also @option{-static-libmpxwrappers}.
11270 MPX-based instrumentation
11271 may be used for debugging and also may be included in production code
11272 to increase program security.  Depending on usage, you may
11273 have different requirements for the runtime library.  The current version
11274 of the MPX runtime library is more oriented for use as a debugging
11275 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11276 also @option{-static-libmpx}.  The runtime library  behavior can be
11277 influenced using various @env{CHKP_RT_*} environment variables.  See
11278 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11279 for more details.
11281 Generated instrumentation may be controlled by various
11282 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11283 structure field attribute (@pxref{Type Attributes}) and
11284 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11285 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11286 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11287 Bounds Checker builtins}, for more information.
11289 @item -fchkp-check-incomplete-type
11290 @opindex fchkp-check-incomplete-type
11291 @opindex fno-chkp-check-incomplete-type
11292 Generate pointer bounds checks for variables with incomplete type.
11293 Enabled by default.
11295 @item -fchkp-narrow-bounds
11296 @opindex fchkp-narrow-bounds
11297 @opindex fno-chkp-narrow-bounds
11298 Controls bounds used by Pointer Bounds Checker for pointers to object
11299 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11300 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11301 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11303 @item -fchkp-first-field-has-own-bounds
11304 @opindex fchkp-first-field-has-own-bounds
11305 @opindex fno-chkp-first-field-has-own-bounds
11306 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11307 first field in the structure.  By default a pointer to the first field has
11308 the same bounds as a pointer to the whole structure.
11310 @item -fchkp-flexible-struct-trailing-arrays
11311 @opindex fchkp-flexible-struct-trailing-arrays
11312 @opindex fno-chkp-flexible-struct-trailing-arrays
11313 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11314 possibly flexible.  By default only array fields with zero length or that are
11315 marked with attribute bnd_variable_size are treated as flexible.
11317 @item -fchkp-narrow-to-innermost-array
11318 @opindex fchkp-narrow-to-innermost-array
11319 @opindex fno-chkp-narrow-to-innermost-array
11320 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11321 case of nested static array access.  By default this option is disabled and
11322 bounds of the outermost array are used.
11324 @item -fchkp-optimize
11325 @opindex fchkp-optimize
11326 @opindex fno-chkp-optimize
11327 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11328 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11330 @item -fchkp-use-fast-string-functions
11331 @opindex fchkp-use-fast-string-functions
11332 @opindex fno-chkp-use-fast-string-functions
11333 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11334 by Pointer Bounds Checker.  Disabled by default.
11336 @item -fchkp-use-nochk-string-functions
11337 @opindex fchkp-use-nochk-string-functions
11338 @opindex fno-chkp-use-nochk-string-functions
11339 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11340 by Pointer Bounds Checker.  Disabled by default.
11342 @item -fchkp-use-static-bounds
11343 @opindex fchkp-use-static-bounds
11344 @opindex fno-chkp-use-static-bounds
11345 Allow Pointer Bounds Checker to generate static bounds holding
11346 bounds of static variables.  Enabled by default.
11348 @item -fchkp-use-static-const-bounds
11349 @opindex fchkp-use-static-const-bounds
11350 @opindex fno-chkp-use-static-const-bounds
11351 Use statically-initialized bounds for constant bounds instead of
11352 generating them each time they are required.  By default enabled when
11353 @option{-fchkp-use-static-bounds} is enabled.
11355 @item -fchkp-treat-zero-dynamic-size-as-infinite
11356 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11357 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11358 With this option, objects with incomplete type whose
11359 dynamically-obtained size is zero are treated as having infinite size
11360 instead by Pointer Bounds
11361 Checker.  This option may be helpful if a program is linked with a library
11362 missing size information for some symbols.  Disabled by default.
11364 @item -fchkp-check-read
11365 @opindex fchkp-check-read
11366 @opindex fno-chkp-check-read
11367 Instructs Pointer Bounds Checker to generate checks for all read
11368 accesses to memory.  Enabled by default.
11370 @item -fchkp-check-write
11371 @opindex fchkp-check-write
11372 @opindex fno-chkp-check-write
11373 Instructs Pointer Bounds Checker to generate checks for all write
11374 accesses to memory.  Enabled by default.
11376 @item -fchkp-store-bounds
11377 @opindex fchkp-store-bounds
11378 @opindex fno-chkp-store-bounds
11379 Instructs Pointer Bounds Checker to generate bounds stores for
11380 pointer writes.  Enabled by default.
11382 @item -fchkp-instrument-calls
11383 @opindex fchkp-instrument-calls
11384 @opindex fno-chkp-instrument-calls
11385 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11386 Enabled by default.
11388 @item -fchkp-instrument-marked-only
11389 @opindex fchkp-instrument-marked-only
11390 @opindex fno-chkp-instrument-marked-only
11391 Instructs Pointer Bounds Checker to instrument only functions
11392 marked with the @code{bnd_instrument} attribute
11393 (@pxref{Function Attributes}).  Disabled by default.
11395 @item -fchkp-use-wrappers
11396 @opindex fchkp-use-wrappers
11397 @opindex fno-chkp-use-wrappers
11398 Allows Pointer Bounds Checker to replace calls to built-in functions
11399 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11400 is used to link a program, the GCC driver automatically links
11401 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11402 Enabled by default.
11404 @item -fstack-protector
11405 @opindex fstack-protector
11406 Emit extra code to check for buffer overflows, such as stack smashing
11407 attacks.  This is done by adding a guard variable to functions with
11408 vulnerable objects.  This includes functions that call @code{alloca}, and
11409 functions with buffers larger than 8 bytes.  The guards are initialized
11410 when a function is entered and then checked when the function exits.
11411 If a guard check fails, an error message is printed and the program exits.
11413 @item -fstack-protector-all
11414 @opindex fstack-protector-all
11415 Like @option{-fstack-protector} except that all functions are protected.
11417 @item -fstack-protector-strong
11418 @opindex fstack-protector-strong
11419 Like @option{-fstack-protector} but includes additional functions to
11420 be protected --- those that have local array definitions, or have
11421 references to local frame addresses.
11423 @item -fstack-protector-explicit
11424 @opindex fstack-protector-explicit
11425 Like @option{-fstack-protector} but only protects those functions which
11426 have the @code{stack_protect} attribute.
11428 @item -fstack-check
11429 @opindex fstack-check
11430 Generate code to verify that you do not go beyond the boundary of the
11431 stack.  You should specify this flag if you are running in an
11432 environment with multiple threads, but you only rarely need to specify it in
11433 a single-threaded environment since stack overflow is automatically
11434 detected on nearly all systems if there is only one stack.
11436 Note that this switch does not actually cause checking to be done; the
11437 operating system or the language runtime must do that.  The switch causes
11438 generation of code to ensure that they see the stack being extended.
11440 You can additionally specify a string parameter: @samp{no} means no
11441 checking, @samp{generic} means force the use of old-style checking,
11442 @samp{specific} means use the best checking method and is equivalent
11443 to bare @option{-fstack-check}.
11445 Old-style checking is a generic mechanism that requires no specific
11446 target support in the compiler but comes with the following drawbacks:
11448 @enumerate
11449 @item
11450 Modified allocation strategy for large objects: they are always
11451 allocated dynamically if their size exceeds a fixed threshold.  Note this
11452 may change the semantics of some code.
11454 @item
11455 Fixed limit on the size of the static frame of functions: when it is
11456 topped by a particular function, stack checking is not reliable and
11457 a warning is issued by the compiler.
11459 @item
11460 Inefficiency: because of both the modified allocation strategy and the
11461 generic implementation, code performance is hampered.
11462 @end enumerate
11464 Note that old-style stack checking is also the fallback method for
11465 @samp{specific} if no target support has been added in the compiler.
11467 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11468 and stack overflows.  @samp{specific} is an excellent choice when compiling
11469 Ada code.  It is not generally sufficient to protect against stack-clash
11470 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11472 @item -fstack-clash-protection
11473 @opindex fstack-clash-protection
11474 Generate code to prevent stack clash style attacks.  When this option is
11475 enabled, the compiler will only allocate one page of stack space at a time
11476 and each page is accessed immediately after allocation.  Thus, it prevents
11477 allocations from jumping over any stack guard page provided by the
11478 operating system.
11480 Most targets do not fully support stack clash protection.  However, on
11481 those targets @option{-fstack-clash-protection} will protect dynamic stack
11482 allocations.  @option{-fstack-clash-protection} may also provide limited
11483 protection for static stack allocations if the target supports
11484 @option{-fstack-check=specific}.
11486 @item -fstack-limit-register=@var{reg}
11487 @itemx -fstack-limit-symbol=@var{sym}
11488 @itemx -fno-stack-limit
11489 @opindex fstack-limit-register
11490 @opindex fstack-limit-symbol
11491 @opindex fno-stack-limit
11492 Generate code to ensure that the stack does not grow beyond a certain value,
11493 either the value of a register or the address of a symbol.  If a larger
11494 stack is required, a signal is raised at run time.  For most targets,
11495 the signal is raised before the stack overruns the boundary, so
11496 it is possible to catch the signal without taking special precautions.
11498 For instance, if the stack starts at absolute address @samp{0x80000000}
11499 and grows downwards, you can use the flags
11500 @option{-fstack-limit-symbol=__stack_limit} and
11501 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11502 of 128KB@.  Note that this may only work with the GNU linker.
11504 You can locally override stack limit checking by using the
11505 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11507 @item -fsplit-stack
11508 @opindex fsplit-stack
11509 Generate code to automatically split the stack before it overflows.
11510 The resulting program has a discontiguous stack which can only
11511 overflow if the program is unable to allocate any more memory.  This
11512 is most useful when running threaded programs, as it is no longer
11513 necessary to calculate a good stack size to use for each thread.  This
11514 is currently only implemented for the x86 targets running
11515 GNU/Linux.
11517 When code compiled with @option{-fsplit-stack} calls code compiled
11518 without @option{-fsplit-stack}, there may not be much stack space
11519 available for the latter code to run.  If compiling all code,
11520 including library code, with @option{-fsplit-stack} is not an option,
11521 then the linker can fix up these calls so that the code compiled
11522 without @option{-fsplit-stack} always has a large stack.  Support for
11523 this is implemented in the gold linker in GNU binutils release 2.21
11524 and later.
11526 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11527 @opindex fvtable-verify
11528 This option is only available when compiling C++ code.
11529 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11530 feature that verifies at run time, for every virtual call, that
11531 the vtable pointer through which the call is made is valid for the type of
11532 the object, and has not been corrupted or overwritten.  If an invalid vtable
11533 pointer is detected at run time, an error is reported and execution of the
11534 program is immediately halted.
11536 This option causes run-time data structures to be built at program startup,
11537 which are used for verifying the vtable pointers.  
11538 The options @samp{std} and @samp{preinit}
11539 control the timing of when these data structures are built.  In both cases the
11540 data structures are built before execution reaches @code{main}.  Using
11541 @option{-fvtable-verify=std} causes the data structures to be built after
11542 shared libraries have been loaded and initialized.
11543 @option{-fvtable-verify=preinit} causes them to be built before shared
11544 libraries have been loaded and initialized.
11546 If this option appears multiple times in the command line with different
11547 values specified, @samp{none} takes highest priority over both @samp{std} and
11548 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11550 @item -fvtv-debug
11551 @opindex fvtv-debug
11552 When used in conjunction with @option{-fvtable-verify=std} or 
11553 @option{-fvtable-verify=preinit}, causes debug versions of the 
11554 runtime functions for the vtable verification feature to be called.  
11555 This flag also causes the compiler to log information about which 
11556 vtable pointers it finds for each class.
11557 This information is written to a file named @file{vtv_set_ptr_data.log} 
11558 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11559 if that is defined or the current working directory otherwise.
11561 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11562 file, be sure to delete any existing one.
11564 @item -fvtv-counts
11565 @opindex fvtv-counts
11566 This is a debugging flag.  When used in conjunction with
11567 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11568 causes the compiler to keep track of the total number of virtual calls
11569 it encounters and the number of verifications it inserts.  It also
11570 counts the number of calls to certain run-time library functions
11571 that it inserts and logs this information for each compilation unit.
11572 The compiler writes this information to a file named
11573 @file{vtv_count_data.log} in the directory named by the environment
11574 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11575 directory otherwise.  It also counts the size of the vtable pointer sets
11576 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11577 in the same directory.
11579 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11580 files, be sure to delete any existing ones.
11582 @item -finstrument-functions
11583 @opindex finstrument-functions
11584 Generate instrumentation calls for entry and exit to functions.  Just
11585 after function entry and just before function exit, the following
11586 profiling functions are called with the address of the current
11587 function and its call site.  (On some platforms,
11588 @code{__builtin_return_address} does not work beyond the current
11589 function, so the call site information may not be available to the
11590 profiling functions otherwise.)
11592 @smallexample
11593 void __cyg_profile_func_enter (void *this_fn,
11594                                void *call_site);
11595 void __cyg_profile_func_exit  (void *this_fn,
11596                                void *call_site);
11597 @end smallexample
11599 The first argument is the address of the start of the current function,
11600 which may be looked up exactly in the symbol table.
11602 This instrumentation is also done for functions expanded inline in other
11603 functions.  The profiling calls indicate where, conceptually, the
11604 inline function is entered and exited.  This means that addressable
11605 versions of such functions must be available.  If all your uses of a
11606 function are expanded inline, this may mean an additional expansion of
11607 code size.  If you use @code{extern inline} in your C code, an
11608 addressable version of such functions must be provided.  (This is
11609 normally the case anyway, but if you get lucky and the optimizer always
11610 expands the functions inline, you might have gotten away without
11611 providing static copies.)
11613 A function may be given the attribute @code{no_instrument_function}, in
11614 which case this instrumentation is not done.  This can be used, for
11615 example, for the profiling functions listed above, high-priority
11616 interrupt routines, and any functions from which the profiling functions
11617 cannot safely be called (perhaps signal handlers, if the profiling
11618 routines generate output or allocate memory).
11620 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11621 @opindex finstrument-functions-exclude-file-list
11623 Set the list of functions that are excluded from instrumentation (see
11624 the description of @option{-finstrument-functions}).  If the file that
11625 contains a function definition matches with one of @var{file}, then
11626 that function is not instrumented.  The match is done on substrings:
11627 if the @var{file} parameter is a substring of the file name, it is
11628 considered to be a match.
11630 For example:
11632 @smallexample
11633 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11634 @end smallexample
11636 @noindent
11637 excludes any inline function defined in files whose pathnames
11638 contain @file{/bits/stl} or @file{include/sys}.
11640 If, for some reason, you want to include letter @samp{,} in one of
11641 @var{sym}, write @samp{\,}. For example,
11642 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11643 (note the single quote surrounding the option).
11645 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11646 @opindex finstrument-functions-exclude-function-list
11648 This is similar to @option{-finstrument-functions-exclude-file-list},
11649 but this option sets the list of function names to be excluded from
11650 instrumentation.  The function name to be matched is its user-visible
11651 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11652 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11653 match is done on substrings: if the @var{sym} parameter is a substring
11654 of the function name, it is considered to be a match.  For C99 and C++
11655 extended identifiers, the function name must be given in UTF-8, not
11656 using universal character names.
11658 @item -fpatchable-function-entry=@var{N}[,@var{M}]
11659 @opindex fpatchable-function-entry
11660 Generate @var{N} NOPs right at the beginning
11661 of each function, with the function entry point before the @var{M}th NOP.
11662 If @var{M} is omitted, it defaults to @code{0} so the
11663 function entry points to the address just at the first NOP.
11664 The NOP instructions reserve extra space which can be used to patch in
11665 any desired instrumentation at run time, provided that the code segment
11666 is writable.  The amount of space is controllable indirectly via
11667 the number of NOPs; the NOP instruction used corresponds to the instruction
11668 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
11669 is target-specific and may also depend on the architecture variant and/or
11670 other compilation options.
11672 For run-time identification, the starting addresses of these areas,
11673 which correspond to their respective function entries minus @var{M},
11674 are additionally collected in the @code{__patchable_function_entries}
11675 section of the resulting binary.
11677 Note that the value of @code{__attribute__ ((patchable_function_entry
11678 (N,M)))} takes precedence over command-line option
11679 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
11680 the area size or to remove it completely on a single function.
11681 If @code{N=0}, no pad location is recorded.
11683 The NOP instructions are inserted at---and maybe before, depending on
11684 @var{M}---the function entry address, even before the prologue.
11686 @end table
11689 @node Preprocessor Options
11690 @section Options Controlling the Preprocessor
11691 @cindex preprocessor options
11692 @cindex options, preprocessor
11694 These options control the C preprocessor, which is run on each C source
11695 file before actual compilation.
11697 If you use the @option{-E} option, nothing is done except preprocessing.
11698 Some of these options make sense only together with @option{-E} because
11699 they cause the preprocessor output to be unsuitable for actual
11700 compilation.
11702 In addition to the options listed here, there are a number of options 
11703 to control search paths for include files documented in 
11704 @ref{Directory Options}.  
11705 Options to control preprocessor diagnostics are listed in 
11706 @ref{Warning Options}.
11708 @table @gcctabopt
11709 @include cppopts.texi
11711 @item -Wp,@var{option}
11712 @opindex Wp
11713 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11714 and pass @var{option} directly through to the preprocessor.  If
11715 @var{option} contains commas, it is split into multiple options at the
11716 commas.  However, many options are modified, translated or interpreted
11717 by the compiler driver before being passed to the preprocessor, and
11718 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11719 interface is undocumented and subject to change, so whenever possible
11720 you should avoid using @option{-Wp} and let the driver handle the
11721 options instead.
11723 @item -Xpreprocessor @var{option}
11724 @opindex Xpreprocessor
11725 Pass @var{option} as an option to the preprocessor.  You can use this to
11726 supply system-specific preprocessor options that GCC does not 
11727 recognize.
11729 If you want to pass an option that takes an argument, you must use
11730 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11732 @item -no-integrated-cpp
11733 @opindex no-integrated-cpp
11734 Perform preprocessing as a separate pass before compilation.
11735 By default, GCC performs preprocessing as an integrated part of
11736 input tokenization and parsing.
11737 If this option is provided, the appropriate language front end
11738 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11739 and Objective-C, respectively) is instead invoked twice,
11740 once for preprocessing only and once for actual compilation
11741 of the preprocessed input.
11742 This option may be useful in conjunction with the @option{-B} or
11743 @option{-wrapper} options to specify an alternate preprocessor or
11744 perform additional processing of the program source between
11745 normal preprocessing and compilation.
11747 @end table
11749 @node Assembler Options
11750 @section Passing Options to the Assembler
11752 @c prevent bad page break with this line
11753 You can pass options to the assembler.
11755 @table @gcctabopt
11756 @item -Wa,@var{option}
11757 @opindex Wa
11758 Pass @var{option} as an option to the assembler.  If @var{option}
11759 contains commas, it is split into multiple options at the commas.
11761 @item -Xassembler @var{option}
11762 @opindex Xassembler
11763 Pass @var{option} as an option to the assembler.  You can use this to
11764 supply system-specific assembler options that GCC does not
11765 recognize.
11767 If you want to pass an option that takes an argument, you must use
11768 @option{-Xassembler} twice, once for the option and once for the argument.
11770 @end table
11772 @node Link Options
11773 @section Options for Linking
11774 @cindex link options
11775 @cindex options, linking
11777 These options come into play when the compiler links object files into
11778 an executable output file.  They are meaningless if the compiler is
11779 not doing a link step.
11781 @table @gcctabopt
11782 @cindex file names
11783 @item @var{object-file-name}
11784 A file name that does not end in a special recognized suffix is
11785 considered to name an object file or library.  (Object files are
11786 distinguished from libraries by the linker according to the file
11787 contents.)  If linking is done, these object files are used as input
11788 to the linker.
11790 @item -c
11791 @itemx -S
11792 @itemx -E
11793 @opindex c
11794 @opindex S
11795 @opindex E
11796 If any of these options is used, then the linker is not run, and
11797 object file names should not be used as arguments.  @xref{Overall
11798 Options}.
11800 @item -fuse-ld=bfd
11801 @opindex fuse-ld=bfd
11802 Use the @command{bfd} linker instead of the default linker.
11804 @item -fuse-ld=gold
11805 @opindex fuse-ld=gold
11806 Use the @command{gold} linker instead of the default linker.
11808 @cindex Libraries
11809 @item -l@var{library}
11810 @itemx -l @var{library}
11811 @opindex l
11812 Search the library named @var{library} when linking.  (The second
11813 alternative with the library as a separate argument is only for
11814 POSIX compliance and is not recommended.)
11816 It makes a difference where in the command you write this option; the
11817 linker searches and processes libraries and object files in the order they
11818 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11819 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11820 to functions in @samp{z}, those functions may not be loaded.
11822 The linker searches a standard list of directories for the library,
11823 which is actually a file named @file{lib@var{library}.a}.  The linker
11824 then uses this file as if it had been specified precisely by name.
11826 The directories searched include several standard system directories
11827 plus any that you specify with @option{-L}.
11829 Normally the files found this way are library files---archive files
11830 whose members are object files.  The linker handles an archive file by
11831 scanning through it for members which define symbols that have so far
11832 been referenced but not defined.  But if the file that is found is an
11833 ordinary object file, it is linked in the usual fashion.  The only
11834 difference between using an @option{-l} option and specifying a file name
11835 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11836 and searches several directories.
11838 @item -lobjc
11839 @opindex lobjc
11840 You need this special case of the @option{-l} option in order to
11841 link an Objective-C or Objective-C++ program.
11843 @item -nostartfiles
11844 @opindex nostartfiles
11845 Do not use the standard system startup files when linking.
11846 The standard system libraries are used normally, unless @option{-nostdlib}
11847 or @option{-nodefaultlibs} is used.
11849 @item -nodefaultlibs
11850 @opindex nodefaultlibs
11851 Do not use the standard system libraries when linking.
11852 Only the libraries you specify are passed to the linker, and options
11853 specifying linkage of the system libraries, such as @option{-static-libgcc}
11854 or @option{-shared-libgcc}, are ignored.  
11855 The standard startup files are used normally, unless @option{-nostartfiles}
11856 is used.  
11858 The compiler may generate calls to @code{memcmp},
11859 @code{memset}, @code{memcpy} and @code{memmove}.
11860 These entries are usually resolved by entries in
11861 libc.  These entry points should be supplied through some other
11862 mechanism when this option is specified.
11864 @item -nostdlib
11865 @opindex nostdlib
11866 Do not use the standard system startup files or libraries when linking.
11867 No startup files and only the libraries you specify are passed to
11868 the linker, and options specifying linkage of the system libraries, such as
11869 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11871 The compiler may generate calls to @code{memcmp}, @code{memset},
11872 @code{memcpy} and @code{memmove}.
11873 These entries are usually resolved by entries in
11874 libc.  These entry points should be supplied through some other
11875 mechanism when this option is specified.
11877 @cindex @option{-lgcc}, use with @option{-nostdlib}
11878 @cindex @option{-nostdlib} and unresolved references
11879 @cindex unresolved references and @option{-nostdlib}
11880 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11881 @cindex @option{-nodefaultlibs} and unresolved references
11882 @cindex unresolved references and @option{-nodefaultlibs}
11883 One of the standard libraries bypassed by @option{-nostdlib} and
11884 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11885 which GCC uses to overcome shortcomings of particular machines, or special
11886 needs for some languages.
11887 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11888 Collection (GCC) Internals},
11889 for more discussion of @file{libgcc.a}.)
11890 In most cases, you need @file{libgcc.a} even when you want to avoid
11891 other standard libraries.  In other words, when you specify @option{-nostdlib}
11892 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11893 This ensures that you have no unresolved references to internal GCC
11894 library subroutines.
11895 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11896 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11897 GNU Compiler Collection (GCC) Internals}.)
11899 @item -pie
11900 @opindex pie
11901 Produce a dynamically linked position independent executable on targets
11902 that support it.  For predictable results, you must also specify the same
11903 set of options used for compilation (@option{-fpie}, @option{-fPIE},
11904 or model suboptions) when you specify this linker option.
11906 @item -no-pie
11907 @opindex no-pie
11908 Don't produce a dynamically linked position independent executable.
11910 @item -static-pie
11911 @opindex static-pie
11912 Produce a static position independent executable on targets that support
11913 it.  A static position independent executable is similar to a static
11914 executable, but can be loaded at any address without a dynamic linker.
11915 For predictable results, you must also specify the same set of options
11916 used for compilation (@option{-fpie}, @option{-fPIE}, or model
11917 suboptions) when you specify this linker option.
11919 @item -pthread
11920 @opindex pthread
11921 Link with the POSIX threads library.  This option is supported on 
11922 GNU/Linux targets, most other Unix derivatives, and also on 
11923 x86 Cygwin and MinGW targets.  On some targets this option also sets 
11924 flags for the preprocessor, so it should be used consistently for both
11925 compilation and linking.
11927 @item -rdynamic
11928 @opindex rdynamic
11929 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11930 that support it. This instructs the linker to add all symbols, not
11931 only used ones, to the dynamic symbol table. This option is needed
11932 for some uses of @code{dlopen} or to allow obtaining backtraces
11933 from within a program.
11935 @item -s
11936 @opindex s
11937 Remove all symbol table and relocation information from the executable.
11939 @item -static
11940 @opindex static
11941 On systems that support dynamic linking, this overrides @option{-pie}
11942 and prevents linking with the shared libraries.  On other systems, this
11943 option has no effect.
11945 @item -shared
11946 @opindex shared
11947 Produce a shared object which can then be linked with other objects to
11948 form an executable.  Not all systems support this option.  For predictable
11949 results, you must also specify the same set of options used for compilation
11950 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11951 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11952 needs to build supplementary stub code for constructors to work.  On
11953 multi-libbed systems, @samp{gcc -shared} must select the correct support
11954 libraries to link against.  Failing to supply the correct flags may lead
11955 to subtle defects.  Supplying them in cases where they are not necessary
11956 is innocuous.}
11958 @item -shared-libgcc
11959 @itemx -static-libgcc
11960 @opindex shared-libgcc
11961 @opindex static-libgcc
11962 On systems that provide @file{libgcc} as a shared library, these options
11963 force the use of either the shared or static version, respectively.
11964 If no shared version of @file{libgcc} was built when the compiler was
11965 configured, these options have no effect.
11967 There are several situations in which an application should use the
11968 shared @file{libgcc} instead of the static version.  The most common
11969 of these is when the application wishes to throw and catch exceptions
11970 across different shared libraries.  In that case, each of the libraries
11971 as well as the application itself should use the shared @file{libgcc}.
11973 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
11974  whenever you build a shared library or a main executable, because C++
11975  programs typically use exceptions, so this is the right thing to do.
11977 If, instead, you use the GCC driver to create shared libraries, you may
11978 find that they are not always linked with the shared @file{libgcc}.
11979 If GCC finds, at its configuration time, that you have a non-GNU linker
11980 or a GNU linker that does not support option @option{--eh-frame-hdr},
11981 it links the shared version of @file{libgcc} into shared libraries
11982 by default.  Otherwise, it takes advantage of the linker and optimizes
11983 away the linking with the shared version of @file{libgcc}, linking with
11984 the static version of libgcc by default.  This allows exceptions to
11985 propagate through such shared libraries, without incurring relocation
11986 costs at library load time.
11988 However, if a library or main executable is supposed to throw or catch
11989 exceptions, you must link it using the G++ driver, as appropriate
11990 for the languages used in the program, or using the option
11991 @option{-shared-libgcc}, such that it is linked with the shared
11992 @file{libgcc}.
11994 @item -static-libasan
11995 @opindex static-libasan
11996 When the @option{-fsanitize=address} option is used to link a program,
11997 the GCC driver automatically links against @option{libasan}.  If
11998 @file{libasan} is available as a shared library, and the @option{-static}
11999 option is not used, then this links against the shared version of
12000 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12001 driver to link @file{libasan} statically, without necessarily linking
12002 other libraries statically.
12004 @item -static-libtsan
12005 @opindex static-libtsan
12006 When the @option{-fsanitize=thread} option is used to link a program,
12007 the GCC driver automatically links against @option{libtsan}.  If
12008 @file{libtsan} is available as a shared library, and the @option{-static}
12009 option is not used, then this links against the shared version of
12010 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12011 driver to link @file{libtsan} statically, without necessarily linking
12012 other libraries statically.
12014 @item -static-liblsan
12015 @opindex static-liblsan
12016 When the @option{-fsanitize=leak} option is used to link a program,
12017 the GCC driver automatically links against @option{liblsan}.  If
12018 @file{liblsan} is available as a shared library, and the @option{-static}
12019 option is not used, then this links against the shared version of
12020 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12021 driver to link @file{liblsan} statically, without necessarily linking
12022 other libraries statically.
12024 @item -static-libubsan
12025 @opindex static-libubsan
12026 When the @option{-fsanitize=undefined} option is used to link a program,
12027 the GCC driver automatically links against @option{libubsan}.  If
12028 @file{libubsan} is available as a shared library, and the @option{-static}
12029 option is not used, then this links against the shared version of
12030 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12031 driver to link @file{libubsan} statically, without necessarily linking
12032 other libraries statically.
12034 @item -static-libmpx
12035 @opindex static-libmpx
12036 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12037 used to link a program, the GCC driver automatically links against
12038 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12039 and the @option{-static} option is not used, then this links against
12040 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12041 option directs the GCC driver to link @file{libmpx} statically,
12042 without necessarily linking other libraries statically.
12044 @item -static-libmpxwrappers
12045 @opindex static-libmpxwrappers
12046 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12047 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12048 GCC driver automatically links against @file{libmpxwrappers}.  If
12049 @file{libmpxwrappers} is available as a shared library, and the
12050 @option{-static} option is not used, then this links against the shared
12051 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12052 option directs the GCC driver to link @file{libmpxwrappers} statically,
12053 without necessarily linking other libraries statically.
12055 @item -static-libstdc++
12056 @opindex static-libstdc++
12057 When the @command{g++} program is used to link a C++ program, it
12058 normally automatically links against @option{libstdc++}.  If
12059 @file{libstdc++} is available as a shared library, and the
12060 @option{-static} option is not used, then this links against the
12061 shared version of @file{libstdc++}.  That is normally fine.  However, it
12062 is sometimes useful to freeze the version of @file{libstdc++} used by
12063 the program without going all the way to a fully static link.  The
12064 @option{-static-libstdc++} option directs the @command{g++} driver to
12065 link @file{libstdc++} statically, without necessarily linking other
12066 libraries statically.
12068 @item -symbolic
12069 @opindex symbolic
12070 Bind references to global symbols when building a shared object.  Warn
12071 about any unresolved references (unless overridden by the link editor
12072 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12073 this option.
12075 @item -T @var{script}
12076 @opindex T
12077 @cindex linker script
12078 Use @var{script} as the linker script.  This option is supported by most
12079 systems using the GNU linker.  On some targets, such as bare-board
12080 targets without an operating system, the @option{-T} option may be required
12081 when linking to avoid references to undefined symbols.
12083 @item -Xlinker @var{option}
12084 @opindex Xlinker
12085 Pass @var{option} as an option to the linker.  You can use this to
12086 supply system-specific linker options that GCC does not recognize.
12088 If you want to pass an option that takes a separate argument, you must use
12089 @option{-Xlinker} twice, once for the option and once for the argument.
12090 For example, to pass @option{-assert definitions}, you must write
12091 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12092 @option{-Xlinker "-assert definitions"}, because this passes the entire
12093 string as a single argument, which is not what the linker expects.
12095 When using the GNU linker, it is usually more convenient to pass
12096 arguments to linker options using the @option{@var{option}=@var{value}}
12097 syntax than as separate arguments.  For example, you can specify
12098 @option{-Xlinker -Map=output.map} rather than
12099 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12100 this syntax for command-line options.
12102 @item -Wl,@var{option}
12103 @opindex Wl
12104 Pass @var{option} as an option to the linker.  If @var{option} contains
12105 commas, it is split into multiple options at the commas.  You can use this
12106 syntax to pass an argument to the option.
12107 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12108 linker.  When using the GNU linker, you can also get the same effect with
12109 @option{-Wl,-Map=output.map}.
12111 @item -u @var{symbol}
12112 @opindex u
12113 Pretend the symbol @var{symbol} is undefined, to force linking of
12114 library modules to define it.  You can use @option{-u} multiple times with
12115 different symbols to force loading of additional library modules.
12117 @item -z @var{keyword}
12118 @opindex z
12119 @option{-z} is passed directly on to the linker along with the keyword
12120 @var{keyword}. See the section in the documentation of your linker for
12121 permitted values and their meanings.
12122 @end table
12124 @node Directory Options
12125 @section Options for Directory Search
12126 @cindex directory options
12127 @cindex options, directory search
12128 @cindex search path
12130 These options specify directories to search for header files, for
12131 libraries and for parts of the compiler:
12133 @table @gcctabopt
12134 @include cppdiropts.texi
12136 @item -iplugindir=@var{dir}
12137 @opindex iplugindir=
12138 Set the directory to search for plugins that are passed
12139 by @option{-fplugin=@var{name}} instead of
12140 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12141 to be used by the user, but only passed by the driver.
12143 @item -L@var{dir}
12144 @opindex L
12145 Add directory @var{dir} to the list of directories to be searched
12146 for @option{-l}.
12148 @item -B@var{prefix}
12149 @opindex B
12150 This option specifies where to find the executables, libraries,
12151 include files, and data files of the compiler itself.
12153 The compiler driver program runs one or more of the subprograms
12154 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12155 @var{prefix} as a prefix for each program it tries to run, both with and
12156 without @samp{@var{machine}/@var{version}/} for the corresponding target
12157 machine and compiler version.
12159 For each subprogram to be run, the compiler driver first tries the
12160 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12161 is not specified, the driver tries two standard prefixes, 
12162 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12163 those results in a file name that is found, the unmodified program
12164 name is searched for using the directories specified in your
12165 @env{PATH} environment variable.
12167 The compiler checks to see if the path provided by @option{-B}
12168 refers to a directory, and if necessary it adds a directory
12169 separator character at the end of the path.
12171 @option{-B} prefixes that effectively specify directory names also apply
12172 to libraries in the linker, because the compiler translates these
12173 options into @option{-L} options for the linker.  They also apply to
12174 include files in the preprocessor, because the compiler translates these
12175 options into @option{-isystem} options for the preprocessor.  In this case,
12176 the compiler appends @samp{include} to the prefix.
12178 The runtime support file @file{libgcc.a} can also be searched for using
12179 the @option{-B} prefix, if needed.  If it is not found there, the two
12180 standard prefixes above are tried, and that is all.  The file is left
12181 out of the link if it is not found by those means.
12183 Another way to specify a prefix much like the @option{-B} prefix is to use
12184 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12185 Variables}.
12187 As a special kludge, if the path provided by @option{-B} is
12188 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12189 9, then it is replaced by @file{[dir/]include}.  This is to help
12190 with boot-strapping the compiler.
12192 @item -no-canonical-prefixes
12193 @opindex no-canonical-prefixes
12194 Do not expand any symbolic links, resolve references to @samp{/../}
12195 or @samp{/./}, or make the path absolute when generating a relative
12196 prefix.
12198 @item --sysroot=@var{dir}
12199 @opindex sysroot
12200 Use @var{dir} as the logical root directory for headers and libraries.
12201 For example, if the compiler normally searches for headers in
12202 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12203 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12205 If you use both this option and the @option{-isysroot} option, then
12206 the @option{--sysroot} option applies to libraries, but the
12207 @option{-isysroot} option applies to header files.
12209 The GNU linker (beginning with version 2.16) has the necessary support
12210 for this option.  If your linker does not support this option, the
12211 header file aspect of @option{--sysroot} still works, but the
12212 library aspect does not.
12214 @item --no-sysroot-suffix
12215 @opindex no-sysroot-suffix
12216 For some targets, a suffix is added to the root directory specified
12217 with @option{--sysroot}, depending on the other options used, so that
12218 headers may for example be found in
12219 @file{@var{dir}/@var{suffix}/usr/include} instead of
12220 @file{@var{dir}/usr/include}.  This option disables the addition of
12221 such a suffix.
12223 @end table
12225 @node Code Gen Options
12226 @section Options for Code Generation Conventions
12227 @cindex code generation conventions
12228 @cindex options, code generation
12229 @cindex run-time options
12231 These machine-independent options control the interface conventions
12232 used in code generation.
12234 Most of them have both positive and negative forms; the negative form
12235 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12236 one of the forms is listed---the one that is not the default.  You
12237 can figure out the other form by either removing @samp{no-} or adding
12240 @table @gcctabopt
12241 @item -fstack-reuse=@var{reuse-level}
12242 @opindex fstack_reuse
12243 This option controls stack space reuse for user declared local/auto variables
12244 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12245 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12246 local variables and temporaries, @samp{named_vars} enables the reuse only for
12247 user defined local variables with names, and @samp{none} disables stack reuse
12248 completely. The default value is @samp{all}. The option is needed when the
12249 program extends the lifetime of a scoped local variable or a compiler generated
12250 temporary beyond the end point defined by the language.  When a lifetime of
12251 a variable ends, and if the variable lives in memory, the optimizing compiler
12252 has the freedom to reuse its stack space with other temporaries or scoped
12253 local variables whose live range does not overlap with it. Legacy code extending
12254 local lifetime is likely to break with the stack reuse optimization.
12256 For example,
12258 @smallexample
12259    int *p;
12260    @{
12261      int local1;
12263      p = &local1;
12264      local1 = 10;
12265      ....
12266    @}
12267    @{
12268       int local2;
12269       local2 = 20;
12270       ...
12271    @}
12273    if (*p == 10)  // out of scope use of local1
12274      @{
12276      @}
12277 @end smallexample
12279 Another example:
12280 @smallexample
12282    struct A
12283    @{
12284        A(int k) : i(k), j(k) @{ @}
12285        int i;
12286        int j;
12287    @};
12289    A *ap;
12291    void foo(const A& ar)
12292    @{
12293       ap = &ar;
12294    @}
12296    void bar()
12297    @{
12298       foo(A(10)); // temp object's lifetime ends when foo returns
12300       @{
12301         A a(20);
12302         ....
12303       @}
12304       ap->i+= 10;  // ap references out of scope temp whose space
12305                    // is reused with a. What is the value of ap->i?
12306    @}
12308 @end smallexample
12310 The lifetime of a compiler generated temporary is well defined by the C++
12311 standard. When a lifetime of a temporary ends, and if the temporary lives
12312 in memory, the optimizing compiler has the freedom to reuse its stack
12313 space with other temporaries or scoped local variables whose live range
12314 does not overlap with it. However some of the legacy code relies on
12315 the behavior of older compilers in which temporaries' stack space is
12316 not reused, the aggressive stack reuse can lead to runtime errors. This
12317 option is used to control the temporary stack reuse optimization.
12319 @item -ftrapv
12320 @opindex ftrapv
12321 This option generates traps for signed overflow on addition, subtraction,
12322 multiplication operations.
12323 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12324 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12325 @option{-fwrapv} being effective.  Note that only active options override, so
12326 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12327 results in @option{-ftrapv} being effective.
12329 @item -fwrapv
12330 @opindex fwrapv
12331 This option instructs the compiler to assume that signed arithmetic
12332 overflow of addition, subtraction and multiplication wraps around
12333 using twos-complement representation.  This flag enables some optimizations
12334 and disables others.
12335 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12336 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12337 @option{-fwrapv} being effective.  Note that only active options override, so
12338 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12339 results in @option{-ftrapv} being effective.
12341 @item -fexceptions
12342 @opindex fexceptions
12343 Enable exception handling.  Generates extra code needed to propagate
12344 exceptions.  For some targets, this implies GCC generates frame
12345 unwind information for all functions, which can produce significant data
12346 size overhead, although it does not affect execution.  If you do not
12347 specify this option, GCC enables it by default for languages like
12348 C++ that normally require exception handling, and disables it for
12349 languages like C that do not normally require it.  However, you may need
12350 to enable this option when compiling C code that needs to interoperate
12351 properly with exception handlers written in C++.  You may also wish to
12352 disable this option if you are compiling older C++ programs that don't
12353 use exception handling.
12355 @item -fnon-call-exceptions
12356 @opindex fnon-call-exceptions
12357 Generate code that allows trapping instructions to throw exceptions.
12358 Note that this requires platform-specific runtime support that does
12359 not exist everywhere.  Moreover, it only allows @emph{trapping}
12360 instructions to throw exceptions, i.e.@: memory references or floating-point
12361 instructions.  It does not allow exceptions to be thrown from
12362 arbitrary signal handlers such as @code{SIGALRM}.
12364 @item -fdelete-dead-exceptions
12365 @opindex fdelete-dead-exceptions
12366 Consider that instructions that may throw exceptions but don't otherwise
12367 contribute to the execution of the program can be optimized away.
12368 This option is enabled by default for the Ada front end, as permitted by
12369 the Ada language specification.
12370 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12372 @item -funwind-tables
12373 @opindex funwind-tables
12374 Similar to @option{-fexceptions}, except that it just generates any needed
12375 static data, but does not affect the generated code in any other way.
12376 You normally do not need to enable this option; instead, a language processor
12377 that needs this handling enables it on your behalf.
12379 @item -fasynchronous-unwind-tables
12380 @opindex fasynchronous-unwind-tables
12381 Generate unwind table in DWARF format, if supported by target machine.  The
12382 table is exact at each instruction boundary, so it can be used for stack
12383 unwinding from asynchronous events (such as debugger or garbage collector).
12385 @item -fno-gnu-unique
12386 @opindex fno-gnu-unique
12387 On systems with recent GNU assembler and C library, the C++ compiler
12388 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12389 of template static data members and static local variables in inline
12390 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12391 is necessary to avoid problems with a library used by two different
12392 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12393 therefore disagreeing with the other one about the binding of the
12394 symbol.  But this causes @code{dlclose} to be ignored for affected
12395 DSOs; if your program relies on reinitialization of a DSO via
12396 @code{dlclose} and @code{dlopen}, you can use
12397 @option{-fno-gnu-unique}.
12399 @item -fpcc-struct-return
12400 @opindex fpcc-struct-return
12401 Return ``short'' @code{struct} and @code{union} values in memory like
12402 longer ones, rather than in registers.  This convention is less
12403 efficient, but it has the advantage of allowing intercallability between
12404 GCC-compiled files and files compiled with other compilers, particularly
12405 the Portable C Compiler (pcc).
12407 The precise convention for returning structures in memory depends
12408 on the target configuration macros.
12410 Short structures and unions are those whose size and alignment match
12411 that of some integer type.
12413 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12414 switch is not binary compatible with code compiled with the
12415 @option{-freg-struct-return} switch.
12416 Use it to conform to a non-default application binary interface.
12418 @item -freg-struct-return
12419 @opindex freg-struct-return
12420 Return @code{struct} and @code{union} values in registers when possible.
12421 This is more efficient for small structures than
12422 @option{-fpcc-struct-return}.
12424 If you specify neither @option{-fpcc-struct-return} nor
12425 @option{-freg-struct-return}, GCC defaults to whichever convention is
12426 standard for the target.  If there is no standard convention, GCC
12427 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12428 the principal compiler.  In those cases, we can choose the standard, and
12429 we chose the more efficient register return alternative.
12431 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12432 switch is not binary compatible with code compiled with the
12433 @option{-fpcc-struct-return} switch.
12434 Use it to conform to a non-default application binary interface.
12436 @item -fshort-enums
12437 @opindex fshort-enums
12438 Allocate to an @code{enum} type only as many bytes as it needs for the
12439 declared range of possible values.  Specifically, the @code{enum} type
12440 is equivalent to the smallest integer type that has enough room.
12442 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12443 code that is not binary compatible with code generated without that switch.
12444 Use it to conform to a non-default application binary interface.
12446 @item -fshort-wchar
12447 @opindex fshort-wchar
12448 Override the underlying type for @code{wchar_t} to be @code{short
12449 unsigned int} instead of the default for the target.  This option is
12450 useful for building programs to run under WINE@.
12452 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12453 code that is not binary compatible with code generated without that switch.
12454 Use it to conform to a non-default application binary interface.
12456 @item -fno-common
12457 @opindex fno-common
12458 @cindex tentative definitions
12459 In C code, this option controls the placement of global variables 
12460 defined without an initializer, known as @dfn{tentative definitions} 
12461 in the C standard.  Tentative definitions are distinct from declarations 
12462 of a variable with the @code{extern} keyword, which do not allocate storage.
12464 Unix C compilers have traditionally allocated storage for
12465 uninitialized global variables in a common block.  This allows the
12466 linker to resolve all tentative definitions of the same variable
12467 in different compilation units to the same object, or to a non-tentative
12468 definition.  
12469 This is the behavior specified by @option{-fcommon}, and is the default for 
12470 GCC on most targets.  
12471 On the other hand, this behavior is not required by ISO
12472 C, and on some targets may carry a speed or code size penalty on
12473 variable references.
12475 The @option{-fno-common} option specifies that the compiler should instead
12476 place uninitialized global variables in the data section of the object file.
12477 This inhibits the merging of tentative definitions by the linker so
12478 you get a multiple-definition error if the same 
12479 variable is defined in more than one compilation unit.
12480 Compiling with @option{-fno-common} is useful on targets for which
12481 it provides better performance, or if you wish to verify that the
12482 program will work on other systems that always treat uninitialized
12483 variable definitions this way.
12485 @item -fno-ident
12486 @opindex fno-ident
12487 Ignore the @code{#ident} directive.
12489 @item -finhibit-size-directive
12490 @opindex finhibit-size-directive
12491 Don't output a @code{.size} assembler directive, or anything else that
12492 would cause trouble if the function is split in the middle, and the
12493 two halves are placed at locations far apart in memory.  This option is
12494 used when compiling @file{crtstuff.c}; you should not need to use it
12495 for anything else.
12497 @item -fverbose-asm
12498 @opindex fverbose-asm
12499 Put extra commentary information in the generated assembly code to
12500 make it more readable.  This option is generally only of use to those
12501 who actually need to read the generated assembly code (perhaps while
12502 debugging the compiler itself).
12504 @option{-fno-verbose-asm}, the default, causes the
12505 extra information to be omitted and is useful when comparing two assembler
12506 files.
12508 The added comments include:
12510 @itemize @bullet
12512 @item
12513 information on the compiler version and command-line options,
12515 @item
12516 the source code lines associated with the assembly instructions,
12517 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12519 @item
12520 hints on which high-level expressions correspond to
12521 the various assembly instruction operands.
12523 @end itemize
12525 For example, given this C source file:
12527 @smallexample
12528 int test (int n)
12530   int i;
12531   int total = 0;
12533   for (i = 0; i < n; i++)
12534     total += i * i;
12536   return total;
12538 @end smallexample
12540 compiling to (x86_64) assembly via @option{-S} and emitting the result
12541 direct to stdout via @option{-o} @option{-}
12543 @smallexample
12544 gcc -S test.c -fverbose-asm -Os -o -
12545 @end smallexample
12547 gives output similar to this:
12549 @smallexample
12550         .file   "test.c"
12551 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12552   [...snip...]
12553 # options passed:
12554   [...snip...]
12556         .text
12557         .globl  test
12558         .type   test, @@function
12559 test:
12560 .LFB0:
12561         .cfi_startproc
12562 # test.c:4:   int total = 0;
12563         xorl    %eax, %eax      # <retval>
12564 # test.c:6:   for (i = 0; i < n; i++)
12565         xorl    %edx, %edx      # i
12566 .L2:
12567 # test.c:6:   for (i = 0; i < n; i++)
12568         cmpl    %edi, %edx      # n, i
12569         jge     .L5     #,
12570 # test.c:7:     total += i * i;
12571         movl    %edx, %ecx      # i, tmp92
12572         imull   %edx, %ecx      # i, tmp92
12573 # test.c:6:   for (i = 0; i < n; i++)
12574         incl    %edx    # i
12575 # test.c:7:     total += i * i;
12576         addl    %ecx, %eax      # tmp92, <retval>
12577         jmp     .L2     #
12578 .L5:
12579 # test.c:10: @}
12580         ret
12581         .cfi_endproc
12582 .LFE0:
12583         .size   test, .-test
12584         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12585         .section        .note.GNU-stack,"",@@progbits
12586 @end smallexample
12588 The comments are intended for humans rather than machines and hence the
12589 precise format of the comments is subject to change.
12591 @item -frecord-gcc-switches
12592 @opindex frecord-gcc-switches
12593 This switch causes the command line used to invoke the
12594 compiler to be recorded into the object file that is being created.
12595 This switch is only implemented on some targets and the exact format
12596 of the recording is target and binary file format dependent, but it
12597 usually takes the form of a section containing ASCII text.  This
12598 switch is related to the @option{-fverbose-asm} switch, but that
12599 switch only records information in the assembler output file as
12600 comments, so it never reaches the object file.
12601 See also @option{-grecord-gcc-switches} for another
12602 way of storing compiler options into the object file.
12604 @item -fpic
12605 @opindex fpic
12606 @cindex global offset table
12607 @cindex PIC
12608 Generate position-independent code (PIC) suitable for use in a shared
12609 library, if supported for the target machine.  Such code accesses all
12610 constant addresses through a global offset table (GOT)@.  The dynamic
12611 loader resolves the GOT entries when the program starts (the dynamic
12612 loader is not part of GCC; it is part of the operating system).  If
12613 the GOT size for the linked executable exceeds a machine-specific
12614 maximum size, you get an error message from the linker indicating that
12615 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12616 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12617 on the m68k and RS/6000.  The x86 has no such limit.)
12619 Position-independent code requires special support, and therefore works
12620 only on certain machines.  For the x86, GCC supports PIC for System V
12621 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12622 position-independent.
12624 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12625 are defined to 1.
12627 @item -fPIC
12628 @opindex fPIC
12629 If supported for the target machine, emit position-independent code,
12630 suitable for dynamic linking and avoiding any limit on the size of the
12631 global offset table.  This option makes a difference on AArch64, m68k,
12632 PowerPC and SPARC@.
12634 Position-independent code requires special support, and therefore works
12635 only on certain machines.
12637 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12638 are defined to 2.
12640 @item -fpie
12641 @itemx -fPIE
12642 @opindex fpie
12643 @opindex fPIE
12644 These options are similar to @option{-fpic} and @option{-fPIC}, but
12645 generated position independent code can be only linked into executables.
12646 Usually these options are used when @option{-pie} GCC option is
12647 used during linking.
12649 @option{-fpie} and @option{-fPIE} both define the macros
12650 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12651 for @option{-fpie} and 2 for @option{-fPIE}.
12653 @item -fno-plt
12654 @opindex fno-plt
12655 Do not use the PLT for external function calls in position-independent code.
12656 Instead, load the callee address at call sites from the GOT and branch to it.
12657 This leads to more efficient code by eliminating PLT stubs and exposing
12658 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12659 PLT stubs expect the GOT pointer in a specific register, this gives more
12660 register allocation freedom to the compiler.
12661 Lazy binding requires use of the PLT; 
12662 with @option{-fno-plt} all external symbols are resolved at load time.
12664 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12665 through the PLT for specific external functions.
12667 In position-dependent code, a few targets also convert calls to
12668 functions that are marked to not use the PLT to use the GOT instead.
12670 @item -fno-jump-tables
12671 @opindex fno-jump-tables
12672 Do not use jump tables for switch statements even where it would be
12673 more efficient than other code generation strategies.  This option is
12674 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12675 building code that forms part of a dynamic linker and cannot
12676 reference the address of a jump table.  On some targets, jump tables
12677 do not require a GOT and this option is not needed.
12679 @item -ffixed-@var{reg}
12680 @opindex ffixed
12681 Treat the register named @var{reg} as a fixed register; generated code
12682 should never refer to it (except perhaps as a stack pointer, frame
12683 pointer or in some other fixed role).
12685 @var{reg} must be the name of a register.  The register names accepted
12686 are machine-specific and are defined in the @code{REGISTER_NAMES}
12687 macro in the machine description macro file.
12689 This flag does not have a negative form, because it specifies a
12690 three-way choice.
12692 @item -fcall-used-@var{reg}
12693 @opindex fcall-used
12694 Treat the register named @var{reg} as an allocable register that is
12695 clobbered by function calls.  It may be allocated for temporaries or
12696 variables that do not live across a call.  Functions compiled this way
12697 do not save and restore the register @var{reg}.
12699 It is an error to use this flag with the frame pointer or stack pointer.
12700 Use of this flag for other registers that have fixed pervasive roles in
12701 the machine's execution model produces disastrous results.
12703 This flag does not have a negative form, because it specifies a
12704 three-way choice.
12706 @item -fcall-saved-@var{reg}
12707 @opindex fcall-saved
12708 Treat the register named @var{reg} as an allocable register saved by
12709 functions.  It may be allocated even for temporaries or variables that
12710 live across a call.  Functions compiled this way save and restore
12711 the register @var{reg} if they use it.
12713 It is an error to use this flag with the frame pointer or stack pointer.
12714 Use of this flag for other registers that have fixed pervasive roles in
12715 the machine's execution model produces disastrous results.
12717 A different sort of disaster results from the use of this flag for
12718 a register in which function values may be returned.
12720 This flag does not have a negative form, because it specifies a
12721 three-way choice.
12723 @item -fpack-struct[=@var{n}]
12724 @opindex fpack-struct
12725 Without a value specified, pack all structure members together without
12726 holes.  When a value is specified (which must be a small power of two), pack
12727 structure members according to this value, representing the maximum
12728 alignment (that is, objects with default alignment requirements larger than
12729 this are output potentially unaligned at the next fitting location.
12731 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12732 code that is not binary compatible with code generated without that switch.
12733 Additionally, it makes the code suboptimal.
12734 Use it to conform to a non-default application binary interface.
12736 @item -fleading-underscore
12737 @opindex fleading-underscore
12738 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12739 change the way C symbols are represented in the object file.  One use
12740 is to help link with legacy assembly code.
12742 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12743 generate code that is not binary compatible with code generated without that
12744 switch.  Use it to conform to a non-default application binary interface.
12745 Not all targets provide complete support for this switch.
12747 @item -ftls-model=@var{model}
12748 @opindex ftls-model
12749 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12750 The @var{model} argument should be one of @samp{global-dynamic},
12751 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12752 Note that the choice is subject to optimization: the compiler may use
12753 a more efficient model for symbols not visible outside of the translation
12754 unit, or if @option{-fpic} is not given on the command line.
12756 The default without @option{-fpic} is @samp{initial-exec}; with
12757 @option{-fpic} the default is @samp{global-dynamic}.
12759 @item -ftrampolines
12760 @opindex ftrampolines
12761 For targets that normally need trampolines for nested functions, always
12762 generate them instead of using descriptors.  Otherwise, for targets that
12763 do not need them, like for example HP-PA or IA-64, do nothing.
12765 A trampoline is a small piece of code that is created at run time on the
12766 stack when the address of a nested function is taken, and is used to call
12767 the nested function indirectly.  Therefore, it requires the stack to be
12768 made executable in order for the program to work properly.
12770 @option{-fno-trampolines} is enabled by default on a language by language
12771 basis to let the compiler avoid generating them, if it computes that this
12772 is safe, and replace them with descriptors.  Descriptors are made up of data
12773 only, but the generated code must be prepared to deal with them.  As of this
12774 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12776 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12777 @option{-fno-trampolines} are not binary compatible if nested functions are
12778 present.  This option must therefore be used on a program-wide basis and be
12779 manipulated with extreme care.
12781 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12782 @opindex fvisibility
12783 Set the default ELF image symbol visibility to the specified option---all
12784 symbols are marked with this unless overridden within the code.
12785 Using this feature can very substantially improve linking and
12786 load times of shared object libraries, produce more optimized
12787 code, provide near-perfect API export and prevent symbol clashes.
12788 It is @strong{strongly} recommended that you use this in any shared objects
12789 you distribute.
12791 Despite the nomenclature, @samp{default} always means public; i.e.,
12792 available to be linked against from outside the shared object.
12793 @samp{protected} and @samp{internal} are pretty useless in real-world
12794 usage so the only other commonly used option is @samp{hidden}.
12795 The default if @option{-fvisibility} isn't specified is
12796 @samp{default}, i.e., make every symbol public.
12798 A good explanation of the benefits offered by ensuring ELF
12799 symbols have the correct visibility is given by ``How To Write
12800 Shared Libraries'' by Ulrich Drepper (which can be found at
12801 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12802 solution made possible by this option to marking things hidden when
12803 the default is public is to make the default hidden and mark things
12804 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12805 and @code{__attribute__ ((visibility("default")))} instead of
12806 @code{__declspec(dllexport)} you get almost identical semantics with
12807 identical syntax.  This is a great boon to those working with
12808 cross-platform projects.
12810 For those adding visibility support to existing code, you may find
12811 @code{#pragma GCC visibility} of use.  This works by you enclosing
12812 the declarations you wish to set visibility for with (for example)
12813 @code{#pragma GCC visibility push(hidden)} and
12814 @code{#pragma GCC visibility pop}.
12815 Bear in mind that symbol visibility should be viewed @strong{as
12816 part of the API interface contract} and thus all new code should
12817 always specify visibility when it is not the default; i.e., declarations
12818 only for use within the local DSO should @strong{always} be marked explicitly
12819 as hidden as so to avoid PLT indirection overheads---making this
12820 abundantly clear also aids readability and self-documentation of the code.
12821 Note that due to ISO C++ specification requirements, @code{operator new} and
12822 @code{operator delete} must always be of default visibility.
12824 Be aware that headers from outside your project, in particular system
12825 headers and headers from any other library you use, may not be
12826 expecting to be compiled with visibility other than the default.  You
12827 may need to explicitly say @code{#pragma GCC visibility push(default)}
12828 before including any such headers.
12830 @code{extern} declarations are not affected by @option{-fvisibility}, so
12831 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12832 no modifications.  However, this means that calls to @code{extern}
12833 functions with no explicit visibility use the PLT, so it is more
12834 effective to use @code{__attribute ((visibility))} and/or
12835 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12836 declarations should be treated as hidden.
12838 Note that @option{-fvisibility} does affect C++ vague linkage
12839 entities. This means that, for instance, an exception class that is
12840 be thrown between DSOs must be explicitly marked with default
12841 visibility so that the @samp{type_info} nodes are unified between
12842 the DSOs.
12844 An overview of these techniques, their benefits and how to use them
12845 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12847 @item -fstrict-volatile-bitfields
12848 @opindex fstrict-volatile-bitfields
12849 This option should be used if accesses to volatile bit-fields (or other
12850 structure fields, although the compiler usually honors those types
12851 anyway) should use a single access of the width of the
12852 field's type, aligned to a natural alignment if possible.  For
12853 example, targets with memory-mapped peripheral registers might require
12854 all such accesses to be 16 bits wide; with this flag you can
12855 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12856 is 16 bits on these targets) to force GCC to use 16-bit accesses
12857 instead of, perhaps, a more efficient 32-bit access.
12859 If this option is disabled, the compiler uses the most efficient
12860 instruction.  In the previous example, that might be a 32-bit load
12861 instruction, even though that accesses bytes that do not contain
12862 any portion of the bit-field, or memory-mapped registers unrelated to
12863 the one being updated.
12865 In some cases, such as when the @code{packed} attribute is applied to a 
12866 structure field, it may not be possible to access the field with a single
12867 read or write that is correctly aligned for the target machine.  In this
12868 case GCC falls back to generating multiple accesses rather than code that 
12869 will fault or truncate the result at run time.
12871 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12872 not allowed to touch non bit-field members.  It is therefore recommended
12873 to define all bits of the field's type as bit-field members.
12875 The default value of this option is determined by the application binary
12876 interface for the target processor.
12878 @item -fsync-libcalls
12879 @opindex fsync-libcalls
12880 This option controls whether any out-of-line instance of the @code{__sync}
12881 family of functions may be used to implement the C++11 @code{__atomic}
12882 family of functions.
12884 The default value of this option is enabled, thus the only useful form
12885 of the option is @option{-fno-sync-libcalls}.  This option is used in
12886 the implementation of the @file{libatomic} runtime library.
12888 @end table
12890 @node Developer Options
12891 @section GCC Developer Options
12892 @cindex developer options
12893 @cindex debugging GCC
12894 @cindex debug dump options
12895 @cindex dump options
12896 @cindex compilation statistics
12898 This section describes command-line options that are primarily of
12899 interest to GCC developers, including options to support compiler
12900 testing and investigation of compiler bugs and compile-time
12901 performance problems.  This includes options that produce debug dumps
12902 at various points in the compilation; that print statistics such as
12903 memory use and execution time; and that print information about GCC's
12904 configuration, such as where it searches for libraries.  You should
12905 rarely need to use any of these options for ordinary compilation and
12906 linking tasks.
12908 @table @gcctabopt
12910 @item -d@var{letters}
12911 @itemx -fdump-rtl-@var{pass}
12912 @itemx -fdump-rtl-@var{pass}=@var{filename}
12913 @opindex d
12914 @opindex fdump-rtl-@var{pass}
12915 Says to make debugging dumps during compilation at times specified by
12916 @var{letters}.  This is used for debugging the RTL-based passes of the
12917 compiler.  The file names for most of the dumps are made by appending
12918 a pass number and a word to the @var{dumpname}, and the files are
12919 created in the directory of the output file.  In case of
12920 @option{=@var{filename}} option, the dump is output on the given file
12921 instead of the pass numbered dump files.  Note that the pass number is
12922 assigned as passes are registered into the pass manager.  Most passes
12923 are registered in the order that they will execute and for these passes
12924 the number corresponds to the pass execution order.  However, passes
12925 registered by plugins, passes specific to compilation targets, or
12926 passes that are otherwise registered after all the other passes are
12927 numbered higher than a pass named "final", even if they are executed
12928 earlier.  @var{dumpname} is generated from the name of the output
12929 file if explicitly specified and not an executable, otherwise it is
12930 the basename of the source file.  
12932 Some @option{-d@var{letters}} switches have different meaning when
12933 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
12934 for information about preprocessor-specific dump options.
12936 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12937 @option{-d} option @var{letters}.  Here are the possible
12938 letters for use in @var{pass} and @var{letters}, and their meanings:
12940 @table @gcctabopt
12942 @item -fdump-rtl-alignments
12943 @opindex fdump-rtl-alignments
12944 Dump after branch alignments have been computed.
12946 @item -fdump-rtl-asmcons
12947 @opindex fdump-rtl-asmcons
12948 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12950 @item -fdump-rtl-auto_inc_dec
12951 @opindex fdump-rtl-auto_inc_dec
12952 Dump after auto-inc-dec discovery.  This pass is only run on
12953 architectures that have auto inc or auto dec instructions.
12955 @item -fdump-rtl-barriers
12956 @opindex fdump-rtl-barriers
12957 Dump after cleaning up the barrier instructions.
12959 @item -fdump-rtl-bbpart
12960 @opindex fdump-rtl-bbpart
12961 Dump after partitioning hot and cold basic blocks.
12963 @item -fdump-rtl-bbro
12964 @opindex fdump-rtl-bbro
12965 Dump after block reordering.
12967 @item -fdump-rtl-btl1
12968 @itemx -fdump-rtl-btl2
12969 @opindex fdump-rtl-btl2
12970 @opindex fdump-rtl-btl2
12971 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12972 after the two branch
12973 target load optimization passes.
12975 @item -fdump-rtl-bypass
12976 @opindex fdump-rtl-bypass
12977 Dump after jump bypassing and control flow optimizations.
12979 @item -fdump-rtl-combine
12980 @opindex fdump-rtl-combine
12981 Dump after the RTL instruction combination pass.
12983 @item -fdump-rtl-compgotos
12984 @opindex fdump-rtl-compgotos
12985 Dump after duplicating the computed gotos.
12987 @item -fdump-rtl-ce1
12988 @itemx -fdump-rtl-ce2
12989 @itemx -fdump-rtl-ce3
12990 @opindex fdump-rtl-ce1
12991 @opindex fdump-rtl-ce2
12992 @opindex fdump-rtl-ce3
12993 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12994 @option{-fdump-rtl-ce3} enable dumping after the three
12995 if conversion passes.
12997 @item -fdump-rtl-cprop_hardreg
12998 @opindex fdump-rtl-cprop_hardreg
12999 Dump after hard register copy propagation.
13001 @item -fdump-rtl-csa
13002 @opindex fdump-rtl-csa
13003 Dump after combining stack adjustments.
13005 @item -fdump-rtl-cse1
13006 @itemx -fdump-rtl-cse2
13007 @opindex fdump-rtl-cse1
13008 @opindex fdump-rtl-cse2
13009 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13010 the two common subexpression elimination passes.
13012 @item -fdump-rtl-dce
13013 @opindex fdump-rtl-dce
13014 Dump after the standalone dead code elimination passes.
13016 @item -fdump-rtl-dbr
13017 @opindex fdump-rtl-dbr
13018 Dump after delayed branch scheduling.
13020 @item -fdump-rtl-dce1
13021 @itemx -fdump-rtl-dce2
13022 @opindex fdump-rtl-dce1
13023 @opindex fdump-rtl-dce2
13024 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13025 the two dead store elimination passes.
13027 @item -fdump-rtl-eh
13028 @opindex fdump-rtl-eh
13029 Dump after finalization of EH handling code.
13031 @item -fdump-rtl-eh_ranges
13032 @opindex fdump-rtl-eh_ranges
13033 Dump after conversion of EH handling range regions.
13035 @item -fdump-rtl-expand
13036 @opindex fdump-rtl-expand
13037 Dump after RTL generation.
13039 @item -fdump-rtl-fwprop1
13040 @itemx -fdump-rtl-fwprop2
13041 @opindex fdump-rtl-fwprop1
13042 @opindex fdump-rtl-fwprop2
13043 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13044 dumping after the two forward propagation passes.
13046 @item -fdump-rtl-gcse1
13047 @itemx -fdump-rtl-gcse2
13048 @opindex fdump-rtl-gcse1
13049 @opindex fdump-rtl-gcse2
13050 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13051 after global common subexpression elimination.
13053 @item -fdump-rtl-init-regs
13054 @opindex fdump-rtl-init-regs
13055 Dump after the initialization of the registers.
13057 @item -fdump-rtl-initvals
13058 @opindex fdump-rtl-initvals
13059 Dump after the computation of the initial value sets.
13061 @item -fdump-rtl-into_cfglayout
13062 @opindex fdump-rtl-into_cfglayout
13063 Dump after converting to cfglayout mode.
13065 @item -fdump-rtl-ira
13066 @opindex fdump-rtl-ira
13067 Dump after iterated register allocation.
13069 @item -fdump-rtl-jump
13070 @opindex fdump-rtl-jump
13071 Dump after the second jump optimization.
13073 @item -fdump-rtl-loop2
13074 @opindex fdump-rtl-loop2
13075 @option{-fdump-rtl-loop2} enables dumping after the rtl
13076 loop optimization passes.
13078 @item -fdump-rtl-mach
13079 @opindex fdump-rtl-mach
13080 Dump after performing the machine dependent reorganization pass, if that
13081 pass exists.
13083 @item -fdump-rtl-mode_sw
13084 @opindex fdump-rtl-mode_sw
13085 Dump after removing redundant mode switches.
13087 @item -fdump-rtl-rnreg
13088 @opindex fdump-rtl-rnreg
13089 Dump after register renumbering.
13091 @item -fdump-rtl-outof_cfglayout
13092 @opindex fdump-rtl-outof_cfglayout
13093 Dump after converting from cfglayout mode.
13095 @item -fdump-rtl-peephole2
13096 @opindex fdump-rtl-peephole2
13097 Dump after the peephole pass.
13099 @item -fdump-rtl-postreload
13100 @opindex fdump-rtl-postreload
13101 Dump after post-reload optimizations.
13103 @item -fdump-rtl-pro_and_epilogue
13104 @opindex fdump-rtl-pro_and_epilogue
13105 Dump after generating the function prologues and epilogues.
13107 @item -fdump-rtl-sched1
13108 @itemx -fdump-rtl-sched2
13109 @opindex fdump-rtl-sched1
13110 @opindex fdump-rtl-sched2
13111 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13112 after the basic block scheduling passes.
13114 @item -fdump-rtl-ree
13115 @opindex fdump-rtl-ree
13116 Dump after sign/zero extension elimination.
13118 @item -fdump-rtl-seqabstr
13119 @opindex fdump-rtl-seqabstr
13120 Dump after common sequence discovery.
13122 @item -fdump-rtl-shorten
13123 @opindex fdump-rtl-shorten
13124 Dump after shortening branches.
13126 @item -fdump-rtl-sibling
13127 @opindex fdump-rtl-sibling
13128 Dump after sibling call optimizations.
13130 @item -fdump-rtl-split1
13131 @itemx -fdump-rtl-split2
13132 @itemx -fdump-rtl-split3
13133 @itemx -fdump-rtl-split4
13134 @itemx -fdump-rtl-split5
13135 @opindex fdump-rtl-split1
13136 @opindex fdump-rtl-split2
13137 @opindex fdump-rtl-split3
13138 @opindex fdump-rtl-split4
13139 @opindex fdump-rtl-split5
13140 These options enable dumping after five rounds of
13141 instruction splitting.
13143 @item -fdump-rtl-sms
13144 @opindex fdump-rtl-sms
13145 Dump after modulo scheduling.  This pass is only run on some
13146 architectures.
13148 @item -fdump-rtl-stack
13149 @opindex fdump-rtl-stack
13150 Dump after conversion from GCC's ``flat register file'' registers to the
13151 x87's stack-like registers.  This pass is only run on x86 variants.
13153 @item -fdump-rtl-subreg1
13154 @itemx -fdump-rtl-subreg2
13155 @opindex fdump-rtl-subreg1
13156 @opindex fdump-rtl-subreg2
13157 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13158 the two subreg expansion passes.
13160 @item -fdump-rtl-unshare
13161 @opindex fdump-rtl-unshare
13162 Dump after all rtl has been unshared.
13164 @item -fdump-rtl-vartrack
13165 @opindex fdump-rtl-vartrack
13166 Dump after variable tracking.
13168 @item -fdump-rtl-vregs
13169 @opindex fdump-rtl-vregs
13170 Dump after converting virtual registers to hard registers.
13172 @item -fdump-rtl-web
13173 @opindex fdump-rtl-web
13174 Dump after live range splitting.
13176 @item -fdump-rtl-regclass
13177 @itemx -fdump-rtl-subregs_of_mode_init
13178 @itemx -fdump-rtl-subregs_of_mode_finish
13179 @itemx -fdump-rtl-dfinit
13180 @itemx -fdump-rtl-dfinish
13181 @opindex fdump-rtl-regclass
13182 @opindex fdump-rtl-subregs_of_mode_init
13183 @opindex fdump-rtl-subregs_of_mode_finish
13184 @opindex fdump-rtl-dfinit
13185 @opindex fdump-rtl-dfinish
13186 These dumps are defined but always produce empty files.
13188 @item -da
13189 @itemx -fdump-rtl-all
13190 @opindex da
13191 @opindex fdump-rtl-all
13192 Produce all the dumps listed above.
13194 @item -dA
13195 @opindex dA
13196 Annotate the assembler output with miscellaneous debugging information.
13198 @item -dD
13199 @opindex dD
13200 Dump all macro definitions, at the end of preprocessing, in addition to
13201 normal output.
13203 @item -dH
13204 @opindex dH
13205 Produce a core dump whenever an error occurs.
13207 @item -dp
13208 @opindex dp
13209 Annotate the assembler output with a comment indicating which
13210 pattern and alternative is used.  The length of each instruction is
13211 also printed.
13213 @item -dP
13214 @opindex dP
13215 Dump the RTL in the assembler output as a comment before each instruction.
13216 Also turns on @option{-dp} annotation.
13218 @item -dx
13219 @opindex dx
13220 Just generate RTL for a function instead of compiling it.  Usually used
13221 with @option{-fdump-rtl-expand}.
13222 @end table
13224 @item -fdump-noaddr
13225 @opindex fdump-noaddr
13226 When doing debugging dumps, suppress address output.  This makes it more
13227 feasible to use diff on debugging dumps for compiler invocations with
13228 different compiler binaries and/or different
13229 text / bss / data / heap / stack / dso start locations.
13231 @item -freport-bug
13232 @opindex freport-bug
13233 Collect and dump debug information into a temporary file if an
13234 internal compiler error (ICE) occurs.
13236 @item -fdump-unnumbered
13237 @opindex fdump-unnumbered
13238 When doing debugging dumps, suppress instruction numbers and address output.
13239 This makes it more feasible to use diff on debugging dumps for compiler
13240 invocations with different options, in particular with and without
13241 @option{-g}.
13243 @item -fdump-unnumbered-links
13244 @opindex fdump-unnumbered-links
13245 When doing debugging dumps (see @option{-d} option above), suppress
13246 instruction numbers for the links to the previous and next instructions
13247 in a sequence.
13249 @item -fdump-ipa-@var{switch}
13250 @opindex fdump-ipa
13251 Control the dumping at various stages of inter-procedural analysis
13252 language tree to a file.  The file name is generated by appending a
13253 switch specific suffix to the source file name, and the file is created
13254 in the same directory as the output file.  The following dumps are
13255 possible:
13257 @table @samp
13258 @item all
13259 Enables all inter-procedural analysis dumps.
13261 @item cgraph
13262 Dumps information about call-graph optimization, unused function removal,
13263 and inlining decisions.
13265 @item inline
13266 Dump after function inlining.
13268 @end table
13270 @item -fdump-lang-all
13271 @itemx -fdump-lang-@var{switch}
13272 @itemx -fdump-lang-@var{switch}-@var{options}
13273 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13274 @opindex fdump-lang-all
13275 @opindex fdump-lang
13276 Control the dumping of language-specific information.  The @var{options}
13277 and @var{filename} portions behave as described in the
13278 @option{-fdump-tree} option.  The following @var{switch} values are
13279 accepted:
13281 @table @samp
13282 @item all
13284 Enable all language-specific dumps.
13286 @item class
13287 Dump class hierarchy information.  Virtual table information is emitted
13288 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13290 @item raw
13291 Dump the raw internal tree data.  This option is applicable to C++ only.
13293 @end table
13295 @item -fdump-passes
13296 @opindex fdump-passes
13297 Print on @file{stderr} the list of optimization passes that are turned
13298 on and off by the current command-line options.
13300 @item -fdump-statistics-@var{option}
13301 @opindex fdump-statistics
13302 Enable and control dumping of pass statistics in a separate file.  The
13303 file name is generated by appending a suffix ending in
13304 @samp{.statistics} to the source file name, and the file is created in
13305 the same directory as the output file.  If the @samp{-@var{option}}
13306 form is used, @samp{-stats} causes counters to be summed over the
13307 whole compilation unit while @samp{-details} dumps every event as
13308 the passes generate them.  The default with no option is to sum
13309 counters for each function compiled.
13311 @item -fdump-tree-all
13312 @itemx -fdump-tree-@var{switch}
13313 @itemx -fdump-tree-@var{switch}-@var{options}
13314 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13315 @opindex fdump-tree-all
13316 @opindex fdump-tree
13317 Control the dumping at various stages of processing the intermediate
13318 language tree to a file.  The file name is generated by appending a
13319 switch-specific suffix to the source file name, and the file is
13320 created in the same directory as the output file. In case of
13321 @option{=@var{filename}} option, the dump is output on the given file
13322 instead of the auto named dump files.  If the @samp{-@var{options}}
13323 form is used, @var{options} is a list of @samp{-} separated options
13324 which control the details of the dump.  Not all options are applicable
13325 to all dumps; those that are not meaningful are ignored.  The
13326 following options are available
13328 @table @samp
13329 @item address
13330 Print the address of each node.  Usually this is not meaningful as it
13331 changes according to the environment and source file.  Its primary use
13332 is for tying up a dump file with a debug environment.
13333 @item asmname
13334 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13335 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13336 use working backward from mangled names in the assembly file.
13337 @item slim
13338 When dumping front-end intermediate representations, inhibit dumping
13339 of members of a scope or body of a function merely because that scope
13340 has been reached.  Only dump such items when they are directly reachable
13341 by some other path.
13343 When dumping pretty-printed trees, this option inhibits dumping the
13344 bodies of control structures.
13346 When dumping RTL, print the RTL in slim (condensed) form instead of
13347 the default LISP-like representation.
13348 @item raw
13349 Print a raw representation of the tree.  By default, trees are
13350 pretty-printed into a C-like representation.
13351 @item details
13352 Enable more detailed dumps (not honored by every dump option). Also
13353 include information from the optimization passes.
13354 @item stats
13355 Enable dumping various statistics about the pass (not honored by every dump
13356 option).
13357 @item blocks
13358 Enable showing basic block boundaries (disabled in raw dumps).
13359 @item graph
13360 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13361 dump a representation of the control flow graph suitable for viewing with
13362 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13363 the file is pretty-printed as a subgraph, so that GraphViz can render them
13364 all in a single plot.
13366 This option currently only works for RTL dumps, and the RTL is always
13367 dumped in slim form.
13368 @item vops
13369 Enable showing virtual operands for every statement.
13370 @item lineno
13371 Enable showing line numbers for statements.
13372 @item uid
13373 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13374 @item verbose
13375 Enable showing the tree dump for each statement.
13376 @item eh
13377 Enable showing the EH region number holding each statement.
13378 @item scev
13379 Enable showing scalar evolution analysis details.
13380 @item optimized
13381 Enable showing optimization information (only available in certain
13382 passes).
13383 @item missed
13384 Enable showing missed optimization information (only available in certain
13385 passes).
13386 @item note
13387 Enable other detailed optimization information (only available in
13388 certain passes).
13389 @item =@var{filename}
13390 Instead of an auto named dump file, output into the given file
13391 name. The file names @file{stdout} and @file{stderr} are treated
13392 specially and are considered already open standard streams. For
13393 example,
13395 @smallexample
13396 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13397      -fdump-tree-pre=/dev/stderr file.c
13398 @end smallexample
13400 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13401 output on to @file{stderr}. If two conflicting dump filenames are
13402 given for the same pass, then the latter option overrides the earlier
13403 one.
13405 @item all
13406 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13407 and @option{lineno}.
13409 @item optall
13410 Turn on all optimization options, i.e., @option{optimized},
13411 @option{missed}, and @option{note}.
13412 @end table
13414 To determine what tree dumps are available or find the dump for a pass
13415 of interest follow the steps below.
13417 @enumerate
13418 @item
13419 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13420 look for a code that corresponds to the pass you are interested in.
13421 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13422 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13423 The number at the end distinguishes distinct invocations of the same pass.
13424 @item
13425 To enable the creation of the dump file, append the pass code to
13426 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13427 to enable the dump from the Early Value Range Propagation pass, invoke
13428 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13429 specify the name of the dump file.  If you don't specify one, GCC
13430 creates as described below.
13431 @item
13432 Find the pass dump in a file whose name is composed of three components
13433 separated by a period: the name of the source file GCC was invoked to
13434 compile, a numeric suffix indicating the pass number followed by the
13435 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13436 and finally the pass code.  For example, the Early VRP pass dump might
13437 be in a file named @file{myfile.c.038t.evrp} in the current working
13438 directory.  Note that the numeric codes are not stable and may change
13439 from one version of GCC to another.
13440 @end enumerate
13442 @item -fopt-info
13443 @itemx -fopt-info-@var{options}
13444 @itemx -fopt-info-@var{options}=@var{filename}
13445 @opindex fopt-info
13446 Controls optimization dumps from various optimization passes. If the
13447 @samp{-@var{options}} form is used, @var{options} is a list of
13448 @samp{-} separated option keywords to select the dump details and
13449 optimizations.  
13451 The @var{options} can be divided into two groups: options describing the
13452 verbosity of the dump, and options describing which optimizations
13453 should be included. The options from both the groups can be freely
13454 mixed as they are non-overlapping. However, in case of any conflicts,
13455 the later options override the earlier options on the command
13456 line. 
13458 The following options control the dump verbosity:
13460 @table @samp
13461 @item optimized
13462 Print information when an optimization is successfully applied. It is
13463 up to a pass to decide which information is relevant. For example, the
13464 vectorizer passes print the source location of loops which are
13465 successfully vectorized.
13466 @item missed
13467 Print information about missed optimizations. Individual passes
13468 control which information to include in the output. 
13469 @item note
13470 Print verbose information about optimizations, such as certain
13471 transformations, more detailed messages about decisions etc.
13472 @item all
13473 Print detailed optimization information. This includes
13474 @samp{optimized}, @samp{missed}, and @samp{note}.
13475 @end table
13477 One or more of the following option keywords can be used to describe a
13478 group of optimizations:
13480 @table @samp
13481 @item ipa
13482 Enable dumps from all interprocedural optimizations.
13483 @item loop
13484 Enable dumps from all loop optimizations.
13485 @item inline
13486 Enable dumps from all inlining optimizations.
13487 @item omp
13488 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13489 @item vec
13490 Enable dumps from all vectorization optimizations.
13491 @item optall
13492 Enable dumps from all optimizations. This is a superset of
13493 the optimization groups listed above.
13494 @end table
13496 If @var{options} is
13497 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13498 info about successful optimizations from all the passes.  
13500 If the @var{filename} is provided, then the dumps from all the
13501 applicable optimizations are concatenated into the @var{filename}.
13502 Otherwise the dump is output onto @file{stderr}. Though multiple
13503 @option{-fopt-info} options are accepted, only one of them can include
13504 a @var{filename}. If other filenames are provided then all but the
13505 first such option are ignored.
13507 Note that the output @var{filename} is overwritten
13508 in case of multiple translation units. If a combined output from
13509 multiple translation units is desired, @file{stderr} should be used
13510 instead.
13512 In the following example, the optimization info is output to
13513 @file{stderr}:
13515 @smallexample
13516 gcc -O3 -fopt-info
13517 @end smallexample
13519 This example:
13520 @smallexample
13521 gcc -O3 -fopt-info-missed=missed.all
13522 @end smallexample
13524 @noindent
13525 outputs missed optimization report from all the passes into
13526 @file{missed.all}, and this one:
13528 @smallexample
13529 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13530 @end smallexample
13532 @noindent
13533 prints information about missed optimization opportunities from
13534 vectorization passes on @file{stderr}.  
13535 Note that @option{-fopt-info-vec-missed} is equivalent to 
13536 @option{-fopt-info-missed-vec}.  The order of the optimization group
13537 names and message types listed after @option{-fopt-info} does not matter.
13539 As another example,
13540 @smallexample
13541 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13542 @end smallexample
13544 @noindent
13545 outputs information about missed optimizations as well as
13546 optimized locations from all the inlining passes into
13547 @file{inline.txt}.
13549 Finally, consider:
13551 @smallexample
13552 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13553 @end smallexample
13555 @noindent
13556 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13557 in conflict since only one output file is allowed. In this case, only
13558 the first option takes effect and the subsequent options are
13559 ignored. Thus only @file{vec.miss} is produced which contains
13560 dumps from the vectorizer about missed opportunities.
13562 @item -fsched-verbose=@var{n}
13563 @opindex fsched-verbose
13564 On targets that use instruction scheduling, this option controls the
13565 amount of debugging output the scheduler prints to the dump files.
13567 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13568 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13569 For @var{n} greater than one, it also output basic block probabilities,
13570 detailed ready list information and unit/insn info.  For @var{n} greater
13571 than two, it includes RTL at abort point, control-flow and regions info.
13572 And for @var{n} over four, @option{-fsched-verbose} also includes
13573 dependence info.
13577 @item -fenable-@var{kind}-@var{pass}
13578 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13579 @opindex fdisable-
13580 @opindex fenable-
13582 This is a set of options that are used to explicitly disable/enable
13583 optimization passes.  These options are intended for use for debugging GCC.
13584 Compiler users should use regular options for enabling/disabling
13585 passes instead.
13587 @table @gcctabopt
13589 @item -fdisable-ipa-@var{pass}
13590 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13591 statically invoked in the compiler multiple times, the pass name should be
13592 appended with a sequential number starting from 1.
13594 @item -fdisable-rtl-@var{pass}
13595 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13596 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13597 statically invoked in the compiler multiple times, the pass name should be
13598 appended with a sequential number starting from 1.  @var{range-list} is a 
13599 comma-separated list of function ranges or assembler names.  Each range is a number
13600 pair separated by a colon.  The range is inclusive in both ends.  If the range
13601 is trivial, the number pair can be simplified as a single number.  If the
13602 function's call graph node's @var{uid} falls within one of the specified ranges,
13603 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13604 function header of a dump file, and the pass names can be dumped by using
13605 option @option{-fdump-passes}.
13607 @item -fdisable-tree-@var{pass}
13608 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13609 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13610 option arguments.
13612 @item -fenable-ipa-@var{pass}
13613 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13614 statically invoked in the compiler multiple times, the pass name should be
13615 appended with a sequential number starting from 1.
13617 @item -fenable-rtl-@var{pass}
13618 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13619 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13620 description and examples.
13622 @item -fenable-tree-@var{pass}
13623 @itemx -fenable-tree-@var{pass}=@var{range-list}
13624 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13625 of option arguments.
13627 @end table
13629 Here are some examples showing uses of these options.
13631 @smallexample
13633 # disable ccp1 for all functions
13634    -fdisable-tree-ccp1
13635 # disable complete unroll for function whose cgraph node uid is 1
13636    -fenable-tree-cunroll=1
13637 # disable gcse2 for functions at the following ranges [1,1],
13638 # [300,400], and [400,1000]
13639 # disable gcse2 for functions foo and foo2
13640    -fdisable-rtl-gcse2=foo,foo2
13641 # disable early inlining
13642    -fdisable-tree-einline
13643 # disable ipa inlining
13644    -fdisable-ipa-inline
13645 # enable tree full unroll
13646    -fenable-tree-unroll
13648 @end smallexample
13650 @item -fchecking
13651 @itemx -fchecking=@var{n}
13652 @opindex fchecking
13653 @opindex fno-checking
13654 Enable internal consistency checking.  The default depends on
13655 the compiler configuration.  @option{-fchecking=2} enables further
13656 internal consistency checking that might affect code generation.
13658 @item -frandom-seed=@var{string}
13659 @opindex frandom-seed
13660 This option provides a seed that GCC uses in place of
13661 random numbers in generating certain symbol names
13662 that have to be different in every compiled file.  It is also used to
13663 place unique stamps in coverage data files and the object files that
13664 produce them.  You can use the @option{-frandom-seed} option to produce
13665 reproducibly identical object files.
13667 The @var{string} can either be a number (decimal, octal or hex) or an
13668 arbitrary string (in which case it's converted to a number by
13669 computing CRC32).
13671 The @var{string} should be different for every file you compile.
13673 @item -save-temps
13674 @itemx -save-temps=cwd
13675 @opindex save-temps
13676 Store the usual ``temporary'' intermediate files permanently; place them
13677 in the current directory and name them based on the source file.  Thus,
13678 compiling @file{foo.c} with @option{-c -save-temps} produces files
13679 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13680 preprocessed @file{foo.i} output file even though the compiler now
13681 normally uses an integrated preprocessor.
13683 When used in combination with the @option{-x} command-line option,
13684 @option{-save-temps} is sensible enough to avoid over writing an
13685 input source file with the same extension as an intermediate file.
13686 The corresponding intermediate file may be obtained by renaming the
13687 source file before using @option{-save-temps}.
13689 If you invoke GCC in parallel, compiling several different source
13690 files that share a common base name in different subdirectories or the
13691 same source file compiled for multiple output destinations, it is
13692 likely that the different parallel compilers will interfere with each
13693 other, and overwrite the temporary files.  For instance:
13695 @smallexample
13696 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13697 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13698 @end smallexample
13700 may result in @file{foo.i} and @file{foo.o} being written to
13701 simultaneously by both compilers.
13703 @item -save-temps=obj
13704 @opindex save-temps=obj
13705 Store the usual ``temporary'' intermediate files permanently.  If the
13706 @option{-o} option is used, the temporary files are based on the
13707 object file.  If the @option{-o} option is not used, the
13708 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13710 For example:
13712 @smallexample
13713 gcc -save-temps=obj -c foo.c
13714 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13715 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13716 @end smallexample
13718 @noindent
13719 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13720 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13721 @file{dir2/yfoobar.o}.
13723 @item -time@r{[}=@var{file}@r{]}
13724 @opindex time
13725 Report the CPU time taken by each subprocess in the compilation
13726 sequence.  For C source files, this is the compiler proper and assembler
13727 (plus the linker if linking is done).
13729 Without the specification of an output file, the output looks like this:
13731 @smallexample
13732 # cc1 0.12 0.01
13733 # as 0.00 0.01
13734 @end smallexample
13736 The first number on each line is the ``user time'', that is time spent
13737 executing the program itself.  The second number is ``system time'',
13738 time spent executing operating system routines on behalf of the program.
13739 Both numbers are in seconds.
13741 With the specification of an output file, the output is appended to the
13742 named file, and it looks like this:
13744 @smallexample
13745 0.12 0.01 cc1 @var{options}
13746 0.00 0.01 as @var{options}
13747 @end smallexample
13749 The ``user time'' and the ``system time'' are moved before the program
13750 name, and the options passed to the program are displayed, so that one
13751 can later tell what file was being compiled, and with which options.
13753 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13754 @opindex fdump-final-insns
13755 Dump the final internal representation (RTL) to @var{file}.  If the
13756 optional argument is omitted (or if @var{file} is @code{.}), the name
13757 of the dump file is determined by appending @code{.gkd} to the
13758 compilation output file name.
13760 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13761 @opindex fcompare-debug
13762 @opindex fno-compare-debug
13763 If no error occurs during compilation, run the compiler a second time,
13764 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13765 passed to the second compilation.  Dump the final internal
13766 representation in both compilations, and print an error if they differ.
13768 If the equal sign is omitted, the default @option{-gtoggle} is used.
13770 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13771 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13772 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13773 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13774 is used.
13776 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13777 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13778 of the final representation and the second compilation, preventing even
13779 @env{GCC_COMPARE_DEBUG} from taking effect.
13781 To verify full coverage during @option{-fcompare-debug} testing, set
13782 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13783 which GCC rejects as an invalid option in any actual compilation
13784 (rather than preprocessing, assembly or linking).  To get just a
13785 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13786 not overridden} will do.
13788 @item -fcompare-debug-second
13789 @opindex fcompare-debug-second
13790 This option is implicitly passed to the compiler for the second
13791 compilation requested by @option{-fcompare-debug}, along with options to
13792 silence warnings, and omitting other options that would cause
13793 side-effect compiler outputs to files or to the standard output.  Dump
13794 files and preserved temporary files are renamed so as to contain the
13795 @code{.gk} additional extension during the second compilation, to avoid
13796 overwriting those generated by the first.
13798 When this option is passed to the compiler driver, it causes the
13799 @emph{first} compilation to be skipped, which makes it useful for little
13800 other than debugging the compiler proper.
13802 @item -gtoggle
13803 @opindex gtoggle
13804 Turn off generation of debug info, if leaving out this option
13805 generates it, or turn it on at level 2 otherwise.  The position of this
13806 argument in the command line does not matter; it takes effect after all
13807 other options are processed, and it does so only once, no matter how
13808 many times it is given.  This is mainly intended to be used with
13809 @option{-fcompare-debug}.
13811 @item -fvar-tracking-assignments-toggle
13812 @opindex fvar-tracking-assignments-toggle
13813 @opindex fno-var-tracking-assignments-toggle
13814 Toggle @option{-fvar-tracking-assignments}, in the same way that
13815 @option{-gtoggle} toggles @option{-g}.
13817 @item -Q
13818 @opindex Q
13819 Makes the compiler print out each function name as it is compiled, and
13820 print some statistics about each pass when it finishes.
13822 @item -ftime-report
13823 @opindex ftime-report
13824 Makes the compiler print some statistics about the time consumed by each
13825 pass when it finishes.
13827 @item -ftime-report-details
13828 @opindex ftime-report-details
13829 Record the time consumed by infrastructure parts separately for each pass.
13831 @item -fira-verbose=@var{n}
13832 @opindex fira-verbose
13833 Control the verbosity of the dump file for the integrated register allocator.
13834 The default value is 5.  If the value @var{n} is greater or equal to 10,
13835 the dump output is sent to stderr using the same format as @var{n} minus 10.
13837 @item -flto-report
13838 @opindex flto-report
13839 Prints a report with internal details on the workings of the link-time
13840 optimizer.  The contents of this report vary from version to version.
13841 It is meant to be useful to GCC developers when processing object
13842 files in LTO mode (via @option{-flto}).
13844 Disabled by default.
13846 @item -flto-report-wpa
13847 @opindex flto-report-wpa
13848 Like @option{-flto-report}, but only print for the WPA phase of Link
13849 Time Optimization.
13851 @item -fmem-report
13852 @opindex fmem-report
13853 Makes the compiler print some statistics about permanent memory
13854 allocation when it finishes.
13856 @item -fmem-report-wpa
13857 @opindex fmem-report-wpa
13858 Makes the compiler print some statistics about permanent memory
13859 allocation for the WPA phase only.
13861 @item -fpre-ipa-mem-report
13862 @opindex fpre-ipa-mem-report
13863 @item -fpost-ipa-mem-report
13864 @opindex fpost-ipa-mem-report
13865 Makes the compiler print some statistics about permanent memory
13866 allocation before or after interprocedural optimization.
13868 @item -fprofile-report
13869 @opindex fprofile-report
13870 Makes the compiler print some statistics about consistency of the
13871 (estimated) profile and effect of individual passes.
13873 @item -fstack-usage
13874 @opindex fstack-usage
13875 Makes the compiler output stack usage information for the program, on a
13876 per-function basis.  The filename for the dump is made by appending
13877 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13878 the output file, if explicitly specified and it is not an executable,
13879 otherwise it is the basename of the source file.  An entry is made up
13880 of three fields:
13882 @itemize
13883 @item
13884 The name of the function.
13885 @item
13886 A number of bytes.
13887 @item
13888 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13889 @end itemize
13891 The qualifier @code{static} means that the function manipulates the stack
13892 statically: a fixed number of bytes are allocated for the frame on function
13893 entry and released on function exit; no stack adjustments are otherwise made
13894 in the function.  The second field is this fixed number of bytes.
13896 The qualifier @code{dynamic} means that the function manipulates the stack
13897 dynamically: in addition to the static allocation described above, stack
13898 adjustments are made in the body of the function, for example to push/pop
13899 arguments around function calls.  If the qualifier @code{bounded} is also
13900 present, the amount of these adjustments is bounded at compile time and
13901 the second field is an upper bound of the total amount of stack used by
13902 the function.  If it is not present, the amount of these adjustments is
13903 not bounded at compile time and the second field only represents the
13904 bounded part.
13906 @item -fstats
13907 @opindex fstats
13908 Emit statistics about front-end processing at the end of the compilation.
13909 This option is supported only by the C++ front end, and
13910 the information is generally only useful to the G++ development team.
13912 @item -fdbg-cnt-list
13913 @opindex fdbg-cnt-list
13914 Print the name and the counter upper bound for all debug counters.
13917 @item -fdbg-cnt=@var{counter-value-list}
13918 @opindex fdbg-cnt
13919 Set the internal debug counter upper bound.  @var{counter-value-list}
13920 is a comma-separated list of @var{name}:@var{value} pairs
13921 which sets the upper bound of each debug counter @var{name} to @var{value}.
13922 All debug counters have the initial upper bound of @code{UINT_MAX};
13923 thus @code{dbg_cnt} returns true always unless the upper bound
13924 is set by this option.
13925 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13926 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13928 @item -print-file-name=@var{library}
13929 @opindex print-file-name
13930 Print the full absolute name of the library file @var{library} that
13931 would be used when linking---and don't do anything else.  With this
13932 option, GCC does not compile or link anything; it just prints the
13933 file name.
13935 @item -print-multi-directory
13936 @opindex print-multi-directory
13937 Print the directory name corresponding to the multilib selected by any
13938 other switches present in the command line.  This directory is supposed
13939 to exist in @env{GCC_EXEC_PREFIX}.
13941 @item -print-multi-lib
13942 @opindex print-multi-lib
13943 Print the mapping from multilib directory names to compiler switches
13944 that enable them.  The directory name is separated from the switches by
13945 @samp{;}, and each switch starts with an @samp{@@} instead of the
13946 @samp{-}, without spaces between multiple switches.  This is supposed to
13947 ease shell processing.
13949 @item -print-multi-os-directory
13950 @opindex print-multi-os-directory
13951 Print the path to OS libraries for the selected
13952 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13953 present in the @file{lib} subdirectory and no multilibs are used, this is
13954 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13955 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13956 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13957 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13959 @item -print-multiarch
13960 @opindex print-multiarch
13961 Print the path to OS libraries for the selected multiarch,
13962 relative to some @file{lib} subdirectory.
13964 @item -print-prog-name=@var{program}
13965 @opindex print-prog-name
13966 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13968 @item -print-libgcc-file-name
13969 @opindex print-libgcc-file-name
13970 Same as @option{-print-file-name=libgcc.a}.
13972 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13973 but you do want to link with @file{libgcc.a}.  You can do:
13975 @smallexample
13976 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13977 @end smallexample
13979 @item -print-search-dirs
13980 @opindex print-search-dirs
13981 Print the name of the configured installation directory and a list of
13982 program and library directories @command{gcc} searches---and don't do anything else.
13984 This is useful when @command{gcc} prints the error message
13985 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13986 To resolve this you either need to put @file{cpp0} and the other compiler
13987 components where @command{gcc} expects to find them, or you can set the environment
13988 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13989 Don't forget the trailing @samp{/}.
13990 @xref{Environment Variables}.
13992 @item -print-sysroot
13993 @opindex print-sysroot
13994 Print the target sysroot directory that is used during
13995 compilation.  This is the target sysroot specified either at configure
13996 time or using the @option{--sysroot} option, possibly with an extra
13997 suffix that depends on compilation options.  If no target sysroot is
13998 specified, the option prints nothing.
14000 @item -print-sysroot-headers-suffix
14001 @opindex print-sysroot-headers-suffix
14002 Print the suffix added to the target sysroot when searching for
14003 headers, or give an error if the compiler is not configured with such
14004 a suffix---and don't do anything else.
14006 @item -dumpmachine
14007 @opindex dumpmachine
14008 Print the compiler's target machine (for example,
14009 @samp{i686-pc-linux-gnu})---and don't do anything else.
14011 @item -dumpversion
14012 @opindex dumpversion
14013 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14014 anything else.  This is the compiler version used in filesystem paths,
14015 specs, can be depending on how the compiler has been configured just
14016 a single number (major version), two numbers separated by dot (major and
14017 minor version) or three numbers separated by dots (major, minor and patchlevel
14018 version).
14020 @item -dumpfullversion
14021 @opindex dumpfullversion
14022 Print the full compiler version, always 3 numbers separated by dots,
14023 major, minor and patchlevel version.
14025 @item -dumpspecs
14026 @opindex dumpspecs
14027 Print the compiler's built-in specs---and don't do anything else.  (This
14028 is used when GCC itself is being built.)  @xref{Spec Files}.
14029 @end table
14031 @node Submodel Options
14032 @section Machine-Dependent Options
14033 @cindex submodel options
14034 @cindex specifying hardware config
14035 @cindex hardware models and configurations, specifying
14036 @cindex target-dependent options
14037 @cindex machine-dependent options
14039 Each target machine supported by GCC can have its own options---for
14040 example, to allow you to compile for a particular processor variant or
14041 ABI, or to control optimizations specific to that machine.  By
14042 convention, the names of machine-specific options start with
14043 @samp{-m}.
14045 Some configurations of the compiler also support additional target-specific
14046 options, usually for compatibility with other compilers on the same
14047 platform.
14049 @c This list is ordered alphanumerically by subsection name.
14050 @c It should be the same order and spelling as these options are listed
14051 @c in Machine Dependent Options
14053 @menu
14054 * AArch64 Options::
14055 * Adapteva Epiphany Options::
14056 * ARC Options::
14057 * ARM Options::
14058 * AVR Options::
14059 * Blackfin Options::
14060 * C6X Options::
14061 * CRIS Options::
14062 * CR16 Options::
14063 * Darwin Options::
14064 * DEC Alpha Options::
14065 * FR30 Options::
14066 * FT32 Options::
14067 * FRV Options::
14068 * GNU/Linux Options::
14069 * H8/300 Options::
14070 * HPPA Options::
14071 * IA-64 Options::
14072 * LM32 Options::
14073 * M32C Options::
14074 * M32R/D Options::
14075 * M680x0 Options::
14076 * MCore Options::
14077 * MeP Options::
14078 * MicroBlaze Options::
14079 * MIPS Options::
14080 * MMIX Options::
14081 * MN10300 Options::
14082 * Moxie Options::
14083 * MSP430 Options::
14084 * NDS32 Options::
14085 * Nios II Options::
14086 * Nvidia PTX Options::
14087 * PDP-11 Options::
14088 * picoChip Options::
14089 * PowerPC Options::
14090 * RISC-V Options::
14091 * RL78 Options::
14092 * RS/6000 and PowerPC Options::
14093 * RX Options::
14094 * S/390 and zSeries Options::
14095 * Score Options::
14096 * SH Options::
14097 * Solaris 2 Options::
14098 * SPARC Options::
14099 * SPU Options::
14100 * System V Options::
14101 * TILE-Gx Options::
14102 * TILEPro Options::
14103 * V850 Options::
14104 * VAX Options::
14105 * Visium Options::
14106 * VMS Options::
14107 * VxWorks Options::
14108 * x86 Options::
14109 * x86 Windows Options::
14110 * Xstormy16 Options::
14111 * Xtensa Options::
14112 * zSeries Options::
14113 @end menu
14115 @node AArch64 Options
14116 @subsection AArch64 Options
14117 @cindex AArch64 Options
14119 These options are defined for AArch64 implementations:
14121 @table @gcctabopt
14123 @item -mabi=@var{name}
14124 @opindex mabi
14125 Generate code for the specified data model.  Permissible values
14126 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14127 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14128 but long int and pointers are 64 bits.
14130 The default depends on the specific target configuration.  Note that
14131 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14132 entire program with the same ABI, and link with a compatible set of libraries.
14134 @item -mbig-endian
14135 @opindex mbig-endian
14136 Generate big-endian code.  This is the default when GCC is configured for an
14137 @samp{aarch64_be-*-*} target.
14139 @item -mgeneral-regs-only
14140 @opindex mgeneral-regs-only
14141 Generate code which uses only the general-purpose registers.  This will prevent
14142 the compiler from using floating-point and Advanced SIMD registers but will not
14143 impose any restrictions on the assembler.
14145 @item -mlittle-endian
14146 @opindex mlittle-endian
14147 Generate little-endian code.  This is the default when GCC is configured for an
14148 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14150 @item -mcmodel=tiny
14151 @opindex mcmodel=tiny
14152 Generate code for the tiny code model.  The program and its statically defined
14153 symbols must be within 1MB of each other.  Programs can be statically or
14154 dynamically linked.
14156 @item -mcmodel=small
14157 @opindex mcmodel=small
14158 Generate code for the small code model.  The program and its statically defined
14159 symbols must be within 4GB of each other.  Programs can be statically or
14160 dynamically linked.  This is the default code model.
14162 @item -mcmodel=large
14163 @opindex mcmodel=large
14164 Generate code for the large code model.  This makes no assumptions about
14165 addresses and sizes of sections.  Programs can be statically linked only.
14167 @item -mstrict-align
14168 @opindex mstrict-align
14169 Avoid generating memory accesses that may not be aligned on a natural object
14170 boundary as described in the architecture specification.
14172 @item -momit-leaf-frame-pointer
14173 @itemx -mno-omit-leaf-frame-pointer
14174 @opindex momit-leaf-frame-pointer
14175 @opindex mno-omit-leaf-frame-pointer
14176 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14177 default.
14179 @item -mtls-dialect=desc
14180 @opindex mtls-dialect=desc
14181 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14182 of TLS variables.  This is the default.
14184 @item -mtls-dialect=traditional
14185 @opindex mtls-dialect=traditional
14186 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14187 of TLS variables.
14189 @item -mtls-size=@var{size}
14190 @opindex mtls-size
14191 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14192 This option requires binutils 2.26 or newer.
14194 @item -mfix-cortex-a53-835769
14195 @itemx -mno-fix-cortex-a53-835769
14196 @opindex mfix-cortex-a53-835769
14197 @opindex mno-fix-cortex-a53-835769
14198 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14199 This involves inserting a NOP instruction between memory instructions and
14200 64-bit integer multiply-accumulate instructions.
14202 @item -mfix-cortex-a53-843419
14203 @itemx -mno-fix-cortex-a53-843419
14204 @opindex mfix-cortex-a53-843419
14205 @opindex mno-fix-cortex-a53-843419
14206 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14207 This erratum workaround is made at link time and this will only pass the
14208 corresponding flag to the linker.
14210 @item -mlow-precision-recip-sqrt
14211 @item -mno-low-precision-recip-sqrt
14212 @opindex mlow-precision-recip-sqrt
14213 @opindex mno-low-precision-recip-sqrt
14214 Enable or disable the reciprocal square root approximation.
14215 This option only has an effect if @option{-ffast-math} or
14216 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14217 precision of reciprocal square root results to about 16 bits for
14218 single precision and to 32 bits for double precision.
14220 @item -mlow-precision-sqrt
14221 @item -mno-low-precision-sqrt
14222 @opindex -mlow-precision-sqrt
14223 @opindex -mno-low-precision-sqrt
14224 Enable or disable the square root approximation.
14225 This option only has an effect if @option{-ffast-math} or
14226 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14227 precision of square root results to about 16 bits for
14228 single precision and to 32 bits for double precision.
14229 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14231 @item -mlow-precision-div
14232 @item -mno-low-precision-div
14233 @opindex -mlow-precision-div
14234 @opindex -mno-low-precision-div
14235 Enable or disable the division approximation.
14236 This option only has an effect if @option{-ffast-math} or
14237 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14238 precision of division results to about 16 bits for
14239 single precision and to 32 bits for double precision.
14241 @item -march=@var{name}
14242 @opindex march
14243 Specify the name of the target architecture and, optionally, one or
14244 more feature modifiers.  This option has the form
14245 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14247 The permissible values for @var{arch} are @samp{armv8-a},
14248 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14250 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14251 support for the ARMv8.3-A architecture extensions.
14253 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14254 support for the ARMv8.2-A architecture extensions.
14256 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14257 support for the ARMv8.1-A architecture extension.  In particular, it
14258 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14260 The value @samp{native} is available on native AArch64 GNU/Linux and
14261 causes the compiler to pick the architecture of the host system.  This
14262 option has no effect if the compiler is unable to recognize the
14263 architecture of the host system,
14265 The permissible values for @var{feature} are listed in the sub-section
14266 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14267 Feature Modifiers}.  Where conflicting feature modifiers are
14268 specified, the right-most feature is used.
14270 GCC uses @var{name} to determine what kind of instructions it can emit
14271 when generating assembly code.  If @option{-march} is specified
14272 without either of @option{-mtune} or @option{-mcpu} also being
14273 specified, the code is tuned to perform well across a range of target
14274 processors implementing the target architecture.
14276 @item -mtune=@var{name}
14277 @opindex mtune
14278 Specify the name of the target processor for which GCC should tune the
14279 performance of the code.  Permissible values for this option are:
14280 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14281 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14282 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx},
14283 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14284 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14285 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14286 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14287 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14288 @samp{native}.
14290 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14291 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14292 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14293 big.LITTLE system.
14295 Additionally on native AArch64 GNU/Linux systems the value
14296 @samp{native} tunes performance to the host system.  This option has no effect
14297 if the compiler is unable to recognize the processor of the host system.
14299 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14300 are specified, the code is tuned to perform well across a range
14301 of target processors.
14303 This option cannot be suffixed by feature modifiers.
14305 @item -mcpu=@var{name}
14306 @opindex mcpu
14307 Specify the name of the target processor, optionally suffixed by one
14308 or more feature modifiers.  This option has the form
14309 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14310 the permissible values for @var{cpu} are the same as those available
14311 for @option{-mtune}.  The permissible values for @var{feature} are
14312 documented in the sub-section on
14313 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14314 Feature Modifiers}.  Where conflicting feature modifiers are
14315 specified, the right-most feature is used.
14317 GCC uses @var{name} to determine what kind of instructions it can emit when
14318 generating assembly code (as if by @option{-march}) and to determine
14319 the target processor for which to tune for performance (as if
14320 by @option{-mtune}).  Where this option is used in conjunction
14321 with @option{-march} or @option{-mtune}, those options take precedence
14322 over the appropriate part of this option.
14324 @item -moverride=@var{string}
14325 @opindex moverride
14326 Override tuning decisions made by the back-end in response to a
14327 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14328 for @var{string} in this option are not guaranteed to be consistent
14329 across releases.
14331 This option is only intended to be useful when developing GCC.
14333 @item -mpc-relative-literal-loads
14334 @itemx -mno-pc-relative-literal-loads
14335 @opindex mpc-relative-literal-loads
14336 @opindex mno-pc-relative-literal-loads
14337 Enable or disable PC-relative literal loads.  With this option literal pools are
14338 accessed using a single instruction and emitted after each function.  This
14339 limits the maximum size of functions to 1MB.  This is enabled by default for
14340 @option{-mcmodel=tiny}.
14342 @item -msign-return-address=@var{scope}
14343 @opindex msign-return-address
14344 Select the function scope on which return address signing will be applied.
14345 Permissible values are @samp{none}, which disables return address signing,
14346 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14347 functions, and @samp{all}, which enables pointer signing for all functions.  The
14348 default value is @samp{none}.
14350 @end table
14352 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14353 @anchor{aarch64-feature-modifiers}
14354 @cindex @option{-march} feature modifiers
14355 @cindex @option{-mcpu} feature modifiers
14356 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14357 the following and their inverses @option{no@var{feature}}:
14359 @table @samp
14360 @item crc
14361 Enable CRC extension.  This is on by default for
14362 @option{-march=armv8.1-a}.
14363 @item crypto
14364 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14365 instructions.
14366 @item fp
14367 Enable floating-point instructions.  This is on by default for all possible
14368 values for options @option{-march} and @option{-mcpu}.
14369 @item simd
14370 Enable Advanced SIMD instructions.  This also enables floating-point
14371 instructions.  This is on by default for all possible values for options
14372 @option{-march} and @option{-mcpu}.
14373 @item lse
14374 Enable Large System Extension instructions.  This is on by default for
14375 @option{-march=armv8.1-a}.
14376 @item rdma
14377 Enable Round Double Multiply Accumulate instructions.  This is on by default
14378 for @option{-march=armv8.1-a}.
14379 @item fp16
14380 Enable FP16 extension.  This also enables floating-point instructions.
14381 @item rcpc
14382 Enable the RcPc extension.  This does not change code generation from GCC,
14383 but is passed on to the assembler, enabling inline asm statements to use
14384 instructions from the RcPc extension.
14385 @item dotprod
14386 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14388 @end table
14390 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14391 Conversely, @option{nofp} implies @option{nosimd}, which implies
14392 @option{nocrypto}.
14394 @node Adapteva Epiphany Options
14395 @subsection Adapteva Epiphany Options
14397 These @samp{-m} options are defined for Adapteva Epiphany:
14399 @table @gcctabopt
14400 @item -mhalf-reg-file
14401 @opindex mhalf-reg-file
14402 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14403 That allows code to run on hardware variants that lack these registers.
14405 @item -mprefer-short-insn-regs
14406 @opindex mprefer-short-insn-regs
14407 Preferentially allocate registers that allow short instruction generation.
14408 This can result in increased instruction count, so this may either reduce or
14409 increase overall code size.
14411 @item -mbranch-cost=@var{num}
14412 @opindex mbranch-cost
14413 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14414 This cost is only a heuristic and is not guaranteed to produce
14415 consistent results across releases.
14417 @item -mcmove
14418 @opindex mcmove
14419 Enable the generation of conditional moves.
14421 @item -mnops=@var{num}
14422 @opindex mnops
14423 Emit @var{num} NOPs before every other generated instruction.
14425 @item -mno-soft-cmpsf
14426 @opindex mno-soft-cmpsf
14427 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14428 and test the flags.  This is faster than a software comparison, but can
14429 get incorrect results in the presence of NaNs, or when two different small
14430 numbers are compared such that their difference is calculated as zero.
14431 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14432 software comparisons.
14434 @item -mstack-offset=@var{num}
14435 @opindex mstack-offset
14436 Set the offset between the top of the stack and the stack pointer.
14437 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14438 can be used by leaf functions without stack allocation.
14439 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14440 Note also that this option changes the ABI; compiling a program with a
14441 different stack offset than the libraries have been compiled with
14442 generally does not work.
14443 This option can be useful if you want to evaluate if a different stack
14444 offset would give you better code, but to actually use a different stack
14445 offset to build working programs, it is recommended to configure the
14446 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14448 @item -mno-round-nearest
14449 @opindex mno-round-nearest
14450 Make the scheduler assume that the rounding mode has been set to
14451 truncating.  The default is @option{-mround-nearest}.
14453 @item -mlong-calls
14454 @opindex mlong-calls
14455 If not otherwise specified by an attribute, assume all calls might be beyond
14456 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14457 function address into a register before performing a (otherwise direct) call.
14458 This is the default.
14460 @item -mshort-calls
14461 @opindex short-calls
14462 If not otherwise specified by an attribute, assume all direct calls are
14463 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14464 for direct calls.  The default is @option{-mlong-calls}.
14466 @item -msmall16
14467 @opindex msmall16
14468 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14469 apply to function addresses for which @option{-mlong-calls} semantics
14470 are in effect.
14472 @item -mfp-mode=@var{mode}
14473 @opindex mfp-mode
14474 Set the prevailing mode of the floating-point unit.
14475 This determines the floating-point mode that is provided and expected
14476 at function call and return time.  Making this mode match the mode you
14477 predominantly need at function start can make your programs smaller and
14478 faster by avoiding unnecessary mode switches.
14480 @var{mode} can be set to one the following values:
14482 @table @samp
14483 @item caller
14484 Any mode at function entry is valid, and retained or restored when
14485 the function returns, and when it calls other functions.
14486 This mode is useful for compiling libraries or other compilation units
14487 you might want to incorporate into different programs with different
14488 prevailing FPU modes, and the convenience of being able to use a single
14489 object file outweighs the size and speed overhead for any extra
14490 mode switching that might be needed, compared with what would be needed
14491 with a more specific choice of prevailing FPU mode.
14493 @item truncate
14494 This is the mode used for floating-point calculations with
14495 truncating (i.e.@: round towards zero) rounding mode.  That includes
14496 conversion from floating point to integer.
14498 @item round-nearest
14499 This is the mode used for floating-point calculations with
14500 round-to-nearest-or-even rounding mode.
14502 @item int
14503 This is the mode used to perform integer calculations in the FPU, e.g.@:
14504 integer multiply, or integer multiply-and-accumulate.
14505 @end table
14507 The default is @option{-mfp-mode=caller}
14509 @item -mnosplit-lohi
14510 @itemx -mno-postinc
14511 @itemx -mno-postmodify
14512 @opindex mnosplit-lohi
14513 @opindex mno-postinc
14514 @opindex mno-postmodify
14515 Code generation tweaks that disable, respectively, splitting of 32-bit
14516 loads, generation of post-increment addresses, and generation of
14517 post-modify addresses.  The defaults are @option{msplit-lohi},
14518 @option{-mpost-inc}, and @option{-mpost-modify}.
14520 @item -mnovect-double
14521 @opindex mno-vect-double
14522 Change the preferred SIMD mode to SImode.  The default is
14523 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14525 @item -max-vect-align=@var{num}
14526 @opindex max-vect-align
14527 The maximum alignment for SIMD vector mode types.
14528 @var{num} may be 4 or 8.  The default is 8.
14529 Note that this is an ABI change, even though many library function
14530 interfaces are unaffected if they don't use SIMD vector modes
14531 in places that affect size and/or alignment of relevant types.
14533 @item -msplit-vecmove-early
14534 @opindex msplit-vecmove-early
14535 Split vector moves into single word moves before reload.  In theory this
14536 can give better register allocation, but so far the reverse seems to be
14537 generally the case.
14539 @item -m1reg-@var{reg}
14540 @opindex m1reg-
14541 Specify a register to hold the constant @minus{}1, which makes loading small negative
14542 constants and certain bitmasks faster.
14543 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14544 which specify use of that register as a fixed register,
14545 and @samp{none}, which means that no register is used for this
14546 purpose.  The default is @option{-m1reg-none}.
14548 @end table
14550 @node ARC Options
14551 @subsection ARC Options
14552 @cindex ARC options
14554 The following options control the architecture variant for which code
14555 is being compiled:
14557 @c architecture variants
14558 @table @gcctabopt
14560 @item -mbarrel-shifter
14561 @opindex mbarrel-shifter
14562 Generate instructions supported by barrel shifter.  This is the default
14563 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14565 @item -mcpu=@var{cpu}
14566 @opindex mcpu
14567 Set architecture type, register usage, and instruction scheduling
14568 parameters for @var{cpu}.  There are also shortcut alias options
14569 available for backward compatibility and convenience.  Supported
14570 values for @var{cpu} are
14572 @table @samp
14573 @opindex mA6
14574 @opindex mARC600
14575 @item arc600
14576 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14578 @item arc601
14579 @opindex mARC601
14580 Compile for ARC601.  Alias: @option{-mARC601}.
14582 @item arc700
14583 @opindex mA7
14584 @opindex mARC700
14585 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14586 This is the default when configured with @option{--with-cpu=arc700}@.
14588 @item arcem
14589 Compile for ARC EM.
14591 @item archs
14592 Compile for ARC HS.
14594 @item em
14595 Compile for ARC EM CPU with no hardware extensions.
14597 @item em4
14598 Compile for ARC EM4 CPU.
14600 @item em4_dmips
14601 Compile for ARC EM4 DMIPS CPU.
14603 @item em4_fpus
14604 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14605 extension.
14607 @item em4_fpuda
14608 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14609 double assist instructions.
14611 @item hs
14612 Compile for ARC HS CPU with no hardware extensions except the atomic
14613 instructions.
14615 @item hs34
14616 Compile for ARC HS34 CPU.
14618 @item hs38
14619 Compile for ARC HS38 CPU.
14621 @item hs38_linux
14622 Compile for ARC HS38 CPU with all hardware extensions on.
14624 @item arc600_norm
14625 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14627 @item arc600_mul32x16
14628 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14629 instructions enabled.
14631 @item arc600_mul64
14632 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14633 instructions enabled.
14635 @item arc601_norm
14636 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14638 @item arc601_mul32x16
14639 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14640 instructions enabled.
14642 @item arc601_mul64
14643 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14644 instructions enabled.
14646 @item nps400
14647 Compile for ARC 700 on NPS400 chip.
14649 @end table
14651 @item -mdpfp
14652 @opindex mdpfp
14653 @itemx -mdpfp-compact
14654 @opindex mdpfp-compact
14655 Generate double-precision FPX instructions, tuned for the compact
14656 implementation.
14658 @item -mdpfp-fast
14659 @opindex mdpfp-fast
14660 Generate double-precision FPX instructions, tuned for the fast
14661 implementation.
14663 @item -mno-dpfp-lrsr
14664 @opindex mno-dpfp-lrsr
14665 Disable @code{lr} and @code{sr} instructions from using FPX extension
14666 aux registers.
14668 @item -mea
14669 @opindex mea
14670 Generate extended arithmetic instructions.  Currently only
14671 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14672 supported.  This is always enabled for @option{-mcpu=ARC700}.
14674 @item -mno-mpy
14675 @opindex mno-mpy
14676 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14677 deprecated.
14679 @item -mmul32x16
14680 @opindex mmul32x16
14681 Generate 32x16-bit multiply and multiply-accumulate instructions.
14683 @item -mmul64
14684 @opindex mmul64
14685 Generate @code{mul64} and @code{mulu64} instructions.  
14686 Only valid for @option{-mcpu=ARC600}.
14688 @item -mnorm
14689 @opindex mnorm
14690 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14691 is in effect.
14693 @item -mspfp
14694 @opindex mspfp
14695 @itemx -mspfp-compact
14696 @opindex mspfp-compact
14697 Generate single-precision FPX instructions, tuned for the compact
14698 implementation.
14700 @item -mspfp-fast
14701 @opindex mspfp-fast
14702 Generate single-precision FPX instructions, tuned for the fast
14703 implementation.
14705 @item -msimd
14706 @opindex msimd
14707 Enable generation of ARC SIMD instructions via target-specific
14708 builtins.  Only valid for @option{-mcpu=ARC700}.
14710 @item -msoft-float
14711 @opindex msoft-float
14712 This option ignored; it is provided for compatibility purposes only.
14713 Software floating-point code is emitted by default, and this default
14714 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14715 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14716 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14718 @item -mswap
14719 @opindex mswap
14720 Generate @code{swap} instructions.
14722 @item -matomic
14723 @opindex matomic
14724 This enables use of the locked load/store conditional extension to implement
14725 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14726 EM cores.
14728 @item -mdiv-rem
14729 @opindex mdiv-rem
14730 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14732 @item -mcode-density
14733 @opindex mcode-density
14734 Enable code density instructions for ARC EM.  
14735 This option is on by default for ARC HS.
14737 @item -mll64
14738 @opindex mll64
14739 Enable double load/store operations for ARC HS cores.
14741 @item -mtp-regno=@var{regno}
14742 @opindex mtp-regno
14743 Specify thread pointer register number.
14745 @item -mmpy-option=@var{multo}
14746 @opindex mmpy-option
14747 Compile ARCv2 code with a multiplier design option.  You can specify 
14748 the option using either a string or numeric value for @var{multo}.  
14749 @samp{wlh1} is the default value.  The recognized values are:
14751 @table @samp
14752 @item 0
14753 @itemx none
14754 No multiplier available.
14756 @item 1
14757 @itemx w
14758 16x16 multiplier, fully pipelined.
14759 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14761 @item 2
14762 @itemx wlh1
14763 32x32 multiplier, fully
14764 pipelined (1 stage).  The following instructions are additionally
14765 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14767 @item 3
14768 @itemx wlh2
14769 32x32 multiplier, fully pipelined
14770 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14771 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14773 @item 4
14774 @itemx wlh3
14775 Two 16x16 multipliers, blocking,
14776 sequential.  The following instructions are additionally enabled: @code{mpy},
14777 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14779 @item 5
14780 @itemx wlh4
14781 One 16x16 multiplier, blocking,
14782 sequential.  The following instructions are additionally enabled: @code{mpy},
14783 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14785 @item 6
14786 @itemx wlh5
14787 One 32x4 multiplier, blocking,
14788 sequential.  The following instructions are additionally enabled: @code{mpy},
14789 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14791 @item 7
14792 @itemx plus_dmpy
14793 ARC HS SIMD support.
14795 @item 8
14796 @itemx plus_macd
14797 ARC HS SIMD support.
14799 @item 9
14800 @itemx plus_qmacw
14801 ARC HS SIMD support.
14803 @end table
14805 This option is only available for ARCv2 cores@.
14807 @item -mfpu=@var{fpu}
14808 @opindex mfpu
14809 Enables support for specific floating-point hardware extensions for ARCv2
14810 cores.  Supported values for @var{fpu} are:
14812 @table @samp
14814 @item fpus
14815 Enables support for single-precision floating-point hardware
14816 extensions@.
14818 @item fpud
14819 Enables support for double-precision floating-point hardware
14820 extensions.  The single-precision floating-point extension is also
14821 enabled.  Not available for ARC EM@.
14823 @item fpuda
14824 Enables support for double-precision floating-point hardware
14825 extensions using double-precision assist instructions.  The single-precision
14826 floating-point extension is also enabled.  This option is
14827 only available for ARC EM@.
14829 @item fpuda_div
14830 Enables support for double-precision floating-point hardware
14831 extensions using double-precision assist instructions.
14832 The single-precision floating-point, square-root, and divide 
14833 extensions are also enabled.  This option is
14834 only available for ARC EM@.
14836 @item fpuda_fma
14837 Enables support for double-precision floating-point hardware
14838 extensions using double-precision assist instructions.
14839 The single-precision floating-point and fused multiply and add 
14840 hardware extensions are also enabled.  This option is
14841 only available for ARC EM@.
14843 @item fpuda_all
14844 Enables support for double-precision floating-point hardware
14845 extensions using double-precision assist instructions.
14846 All single-precision floating-point hardware extensions are also
14847 enabled.  This option is only available for ARC EM@.
14849 @item fpus_div
14850 Enables support for single-precision floating-point, square-root and divide 
14851 hardware extensions@.
14853 @item fpud_div
14854 Enables support for double-precision floating-point, square-root and divide 
14855 hardware extensions.  This option
14856 includes option @samp{fpus_div}. Not available for ARC EM@.
14858 @item fpus_fma
14859 Enables support for single-precision floating-point and 
14860 fused multiply and add hardware extensions@.
14862 @item fpud_fma
14863 Enables support for double-precision floating-point and 
14864 fused multiply and add hardware extensions.  This option
14865 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14867 @item fpus_all
14868 Enables support for all single-precision floating-point hardware
14869 extensions@.
14871 @item fpud_all
14872 Enables support for all single- and double-precision floating-point
14873 hardware extensions.  Not available for ARC EM@.
14875 @end table
14877 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
14878 @opindex mirq-ctrl-saved
14879 Specifies general-purposes registers that the processor automatically
14880 saves/restores on interrupt entry and exit.  @var{register-range} is
14881 specified as two registers separated by a dash.  The register range
14882 always starts with @code{r0}, the upper limit is @code{fp} register.
14883 @var{blink} and @var{lp_count} are optional.  This option is only
14884 valid for ARC EM and ARC HS cores.
14886 @item -mrgf-banked-regs=@var{number}
14887 @opindex mrgf-banked-regs
14888 Specifies the number of registers replicated in second register bank
14889 on entry to fast interrupt.  Fast interrupts are interrupts with the
14890 highest priority level P0.  These interrupts save only PC and STATUS32
14891 registers to avoid memory transactions during interrupt entry and exit
14892 sequences.  Use this option when you are using fast interrupts in an
14893 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
14895 @item -mlpc-width=@var{width}
14896 @opindex mlpc-width
14897 Specify the width of the @code{lp_count} register.  Valid values for
14898 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
14899 fixed to 32 bits.  If the width is less than 32, the compiler does not
14900 attempt to transform loops in your program to use the zero-delay loop
14901 mechanism unless it is known that the @code{lp_count} register can
14902 hold the required loop-counter value.  Depending on the width
14903 specified, the compiler and run-time library might continue to use the
14904 loop mechanism for various needs.  This option defines macro
14905 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
14907 @end table
14909 The following options are passed through to the assembler, and also
14910 define preprocessor macro symbols.
14912 @c Flags used by the assembler, but for which we define preprocessor
14913 @c macro symbols as well.
14914 @table @gcctabopt
14915 @item -mdsp-packa
14916 @opindex mdsp-packa
14917 Passed down to the assembler to enable the DSP Pack A extensions.
14918 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14919 deprecated.
14921 @item -mdvbf
14922 @opindex mdvbf
14923 Passed down to the assembler to enable the dual Viterbi butterfly
14924 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14925 option is deprecated.
14927 @c ARC700 4.10 extension instruction
14928 @item -mlock
14929 @opindex mlock
14930 Passed down to the assembler to enable the locked load/store
14931 conditional extension.  Also sets the preprocessor symbol
14932 @code{__Xlock}.
14934 @item -mmac-d16
14935 @opindex mmac-d16
14936 Passed down to the assembler.  Also sets the preprocessor symbol
14937 @code{__Xxmac_d16}.  This option is deprecated.
14939 @item -mmac-24
14940 @opindex mmac-24
14941 Passed down to the assembler.  Also sets the preprocessor symbol
14942 @code{__Xxmac_24}.  This option is deprecated.
14944 @c ARC700 4.10 extension instruction
14945 @item -mrtsc
14946 @opindex mrtsc
14947 Passed down to the assembler to enable the 64-bit time-stamp counter
14948 extension instruction.  Also sets the preprocessor symbol
14949 @code{__Xrtsc}.  This option is deprecated.
14951 @c ARC700 4.10 extension instruction
14952 @item -mswape
14953 @opindex mswape
14954 Passed down to the assembler to enable the swap byte ordering
14955 extension instruction.  Also sets the preprocessor symbol
14956 @code{__Xswape}.
14958 @item -mtelephony
14959 @opindex mtelephony
14960 Passed down to the assembler to enable dual- and single-operand
14961 instructions for telephony.  Also sets the preprocessor symbol
14962 @code{__Xtelephony}.  This option is deprecated.
14964 @item -mxy
14965 @opindex mxy
14966 Passed down to the assembler to enable the XY memory extension.  Also
14967 sets the preprocessor symbol @code{__Xxy}.
14969 @end table
14971 The following options control how the assembly code is annotated:
14973 @c Assembly annotation options
14974 @table @gcctabopt
14975 @item -misize
14976 @opindex misize
14977 Annotate assembler instructions with estimated addresses.
14979 @item -mannotate-align
14980 @opindex mannotate-align
14981 Explain what alignment considerations lead to the decision to make an
14982 instruction short or long.
14984 @end table
14986 The following options are passed through to the linker:
14988 @c options passed through to the linker
14989 @table @gcctabopt
14990 @item -marclinux
14991 @opindex marclinux
14992 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14993 This option is enabled by default in tool chains built for
14994 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14995 when profiling is not requested.
14997 @item -marclinux_prof
14998 @opindex marclinux_prof
14999 Passed through to the linker, to specify use of the
15000 @code{arclinux_prof} emulation.  This option is enabled by default in
15001 tool chains built for @w{@code{arc-linux-uclibc}} and
15002 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15004 @end table
15006 The following options control the semantics of generated code:
15008 @c semantically relevant code generation options
15009 @table @gcctabopt
15010 @item -mlong-calls
15011 @opindex mlong-calls
15012 Generate calls as register indirect calls, thus providing access
15013 to the full 32-bit address range.
15015 @item -mmedium-calls
15016 @opindex mmedium-calls
15017 Don't use less than 25-bit addressing range for calls, which is the
15018 offset available for an unconditional branch-and-link
15019 instruction.  Conditional execution of function calls is suppressed, to
15020 allow use of the 25-bit range, rather than the 21-bit range with
15021 conditional branch-and-link.  This is the default for tool chains built
15022 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15024 @item -G @var{num}
15025 @opindex G
15026 Put definitions of externally-visible data in a small data section if
15027 that data is no bigger than @var{num} bytes.  The default value of
15028 @var{num} is 4 for any ARC configuration, or 8 when we have double
15029 load/store operations.
15031 @item -mno-sdata
15032 @opindex mno-sdata
15033 Do not generate sdata references.  This is the default for tool chains
15034 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15035 targets.
15037 @item -mvolatile-cache
15038 @opindex mvolatile-cache
15039 Use ordinarily cached memory accesses for volatile references.  This is the
15040 default.
15042 @item -mno-volatile-cache
15043 @opindex mno-volatile-cache
15044 Enable cache bypass for volatile references.
15046 @end table
15048 The following options fine tune code generation:
15049 @c code generation tuning options
15050 @table @gcctabopt
15051 @item -malign-call
15052 @opindex malign-call
15053 Do alignment optimizations for call instructions.
15055 @item -mauto-modify-reg
15056 @opindex mauto-modify-reg
15057 Enable the use of pre/post modify with register displacement.
15059 @item -mbbit-peephole
15060 @opindex mbbit-peephole
15061 Enable bbit peephole2.
15063 @item -mno-brcc
15064 @opindex mno-brcc
15065 This option disables a target-specific pass in @file{arc_reorg} to
15066 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15067 It has no effect on
15068 generation of these instructions driven by the combiner pass.
15070 @item -mcase-vector-pcrel
15071 @opindex mcase-vector-pcrel
15072 Use PC-relative switch case tables to enable case table shortening.
15073 This is the default for @option{-Os}.
15075 @item -mcompact-casesi
15076 @opindex mcompact-casesi
15077 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15078 and only available for ARCv1 cores.
15080 @item -mno-cond-exec
15081 @opindex mno-cond-exec
15082 Disable the ARCompact-specific pass to generate conditional 
15083 execution instructions.
15085 Due to delay slot scheduling and interactions between operand numbers,
15086 literal sizes, instruction lengths, and the support for conditional execution,
15087 the target-independent pass to generate conditional execution is often lacking,
15088 so the ARC port has kept a special pass around that tries to find more
15089 conditional execution generation opportunities after register allocation,
15090 branch shortening, and delay slot scheduling have been done.  This pass
15091 generally, but not always, improves performance and code size, at the cost of
15092 extra compilation time, which is why there is an option to switch it off.
15093 If you have a problem with call instructions exceeding their allowable
15094 offset range because they are conditionalized, you should consider using
15095 @option{-mmedium-calls} instead.
15097 @item -mearly-cbranchsi
15098 @opindex mearly-cbranchsi
15099 Enable pre-reload use of the @code{cbranchsi} pattern.
15101 @item -mexpand-adddi
15102 @opindex mexpand-adddi
15103 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15104 @code{add.f}, @code{adc} etc.  This option is deprecated.
15106 @item -mindexed-loads
15107 @opindex mindexed-loads
15108 Enable the use of indexed loads.  This can be problematic because some
15109 optimizers then assume that indexed stores exist, which is not
15110 the case.
15112 @opindex mlra
15113 Enable Local Register Allocation.  This is still experimental for ARC,
15114 so by default the compiler uses standard reload
15115 (i.e. @option{-mno-lra}).
15117 @item -mlra-priority-none
15118 @opindex mlra-priority-none
15119 Don't indicate any priority for target registers.
15121 @item -mlra-priority-compact
15122 @opindex mlra-priority-compact
15123 Indicate target register priority for r0..r3 / r12..r15.
15125 @item -mlra-priority-noncompact
15126 @opindex mlra-priority-noncompact
15127 Reduce target register priority for r0..r3 / r12..r15.
15129 @item -mno-millicode
15130 @opindex mno-millicode
15131 When optimizing for size (using @option{-Os}), prologues and epilogues
15132 that have to save or restore a large number of registers are often
15133 shortened by using call to a special function in libgcc; this is
15134 referred to as a @emph{millicode} call.  As these calls can pose
15135 performance issues, and/or cause linking issues when linking in a
15136 nonstandard way, this option is provided to turn off millicode call
15137 generation.
15139 @item -mmixed-code
15140 @opindex mmixed-code
15141 Tweak register allocation to help 16-bit instruction generation.
15142 This generally has the effect of decreasing the average instruction size
15143 while increasing the instruction count.
15145 @item -mq-class
15146 @opindex mq-class
15147 Enable @samp{q} instruction alternatives.
15148 This is the default for @option{-Os}.
15150 @item -mRcq
15151 @opindex mRcq
15152 Enable @samp{Rcq} constraint handling.  
15153 Most short code generation depends on this.
15154 This is the default.
15156 @item -mRcw
15157 @opindex mRcw
15158 Enable @samp{Rcw} constraint handling.  
15159 Most ccfsm condexec mostly depends on this.
15160 This is the default.
15162 @item -msize-level=@var{level}
15163 @opindex msize-level
15164 Fine-tune size optimization with regards to instruction lengths and alignment.
15165 The recognized values for @var{level} are:
15166 @table @samp
15167 @item 0
15168 No size optimization.  This level is deprecated and treated like @samp{1}.
15170 @item 1
15171 Short instructions are used opportunistically.
15173 @item 2
15174 In addition, alignment of loops and of code after barriers are dropped.
15176 @item 3
15177 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15179 @end table
15181 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15182 the behavior when this is not set is equivalent to level @samp{1}.
15184 @item -mtune=@var{cpu}
15185 @opindex mtune
15186 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15187 by @option{-mcpu=}.
15189 Supported values for @var{cpu} are
15191 @table @samp
15192 @item ARC600
15193 Tune for ARC600 CPU.
15195 @item ARC601
15196 Tune for ARC601 CPU.
15198 @item ARC700
15199 Tune for ARC700 CPU with standard multiplier block.
15201 @item ARC700-xmac
15202 Tune for ARC700 CPU with XMAC block.
15204 @item ARC725D
15205 Tune for ARC725D CPU.
15207 @item ARC750D
15208 Tune for ARC750D CPU.
15210 @end table
15212 @item -mmultcost=@var{num}
15213 @opindex mmultcost
15214 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15215 normal instruction.
15217 @item -munalign-prob-threshold=@var{probability}
15218 @opindex munalign-prob-threshold
15219 Set probability threshold for unaligning branches.
15220 When tuning for @samp{ARC700} and optimizing for speed, branches without
15221 filled delay slot are preferably emitted unaligned and long, unless
15222 profiling indicates that the probability for the branch to be taken
15223 is below @var{probability}.  @xref{Cross-profiling}.
15224 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15226 @end table
15228 The following options are maintained for backward compatibility, but
15229 are now deprecated and will be removed in a future release:
15231 @c Deprecated options
15232 @table @gcctabopt
15234 @item -margonaut
15235 @opindex margonaut
15236 Obsolete FPX.
15238 @item -mbig-endian
15239 @opindex mbig-endian
15240 @itemx -EB
15241 @opindex EB
15242 Compile code for big-endian targets.  Use of these options is now
15243 deprecated.  Big-endian code is supported by configuring GCC to build
15244 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15245 for which big endian is the default.
15247 @item -mlittle-endian
15248 @opindex mlittle-endian
15249 @itemx -EL
15250 @opindex EL
15251 Compile code for little-endian targets.  Use of these options is now
15252 deprecated.  Little-endian code is supported by configuring GCC to build 
15253 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15254 for which little endian is the default.
15256 @item -mbarrel_shifter
15257 @opindex mbarrel_shifter
15258 Replaced by @option{-mbarrel-shifter}.
15260 @item -mdpfp_compact
15261 @opindex mdpfp_compact
15262 Replaced by @option{-mdpfp-compact}.
15264 @item -mdpfp_fast
15265 @opindex mdpfp_fast
15266 Replaced by @option{-mdpfp-fast}.
15268 @item -mdsp_packa
15269 @opindex mdsp_packa
15270 Replaced by @option{-mdsp-packa}.
15272 @item -mEA
15273 @opindex mEA
15274 Replaced by @option{-mea}.
15276 @item -mmac_24
15277 @opindex mmac_24
15278 Replaced by @option{-mmac-24}.
15280 @item -mmac_d16
15281 @opindex mmac_d16
15282 Replaced by @option{-mmac-d16}.
15284 @item -mspfp_compact
15285 @opindex mspfp_compact
15286 Replaced by @option{-mspfp-compact}.
15288 @item -mspfp_fast
15289 @opindex mspfp_fast
15290 Replaced by @option{-mspfp-fast}.
15292 @item -mtune=@var{cpu}
15293 @opindex mtune
15294 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15295 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15296 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15298 @item -multcost=@var{num}
15299 @opindex multcost
15300 Replaced by @option{-mmultcost}.
15302 @end table
15304 @node ARM Options
15305 @subsection ARM Options
15306 @cindex ARM options
15308 These @samp{-m} options are defined for the ARM port:
15310 @table @gcctabopt
15311 @item -mabi=@var{name}
15312 @opindex mabi
15313 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15314 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15316 @item -mapcs-frame
15317 @opindex mapcs-frame
15318 Generate a stack frame that is compliant with the ARM Procedure Call
15319 Standard for all functions, even if this is not strictly necessary for
15320 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15321 with this option causes the stack frames not to be generated for
15322 leaf functions.  The default is @option{-mno-apcs-frame}.
15323 This option is deprecated.
15325 @item -mapcs
15326 @opindex mapcs
15327 This is a synonym for @option{-mapcs-frame} and is deprecated.
15329 @ignore
15330 @c not currently implemented
15331 @item -mapcs-stack-check
15332 @opindex mapcs-stack-check
15333 Generate code to check the amount of stack space available upon entry to
15334 every function (that actually uses some stack space).  If there is
15335 insufficient space available then either the function
15336 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15337 called, depending upon the amount of stack space required.  The runtime
15338 system is required to provide these functions.  The default is
15339 @option{-mno-apcs-stack-check}, since this produces smaller code.
15341 @c not currently implemented
15342 @item -mapcs-reentrant
15343 @opindex mapcs-reentrant
15344 Generate reentrant, position-independent code.  The default is
15345 @option{-mno-apcs-reentrant}.
15346 @end ignore
15348 @item -mthumb-interwork
15349 @opindex mthumb-interwork
15350 Generate code that supports calling between the ARM and Thumb
15351 instruction sets.  Without this option, on pre-v5 architectures, the
15352 two instruction sets cannot be reliably used inside one program.  The
15353 default is @option{-mno-thumb-interwork}, since slightly larger code
15354 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15355 configurations this option is meaningless.
15357 @item -mno-sched-prolog
15358 @opindex mno-sched-prolog
15359 Prevent the reordering of instructions in the function prologue, or the
15360 merging of those instruction with the instructions in the function's
15361 body.  This means that all functions start with a recognizable set
15362 of instructions (or in fact one of a choice from a small set of
15363 different function prologues), and this information can be used to
15364 locate the start of functions inside an executable piece of code.  The
15365 default is @option{-msched-prolog}.
15367 @item -mfloat-abi=@var{name}
15368 @opindex mfloat-abi
15369 Specifies which floating-point ABI to use.  Permissible values
15370 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15372 Specifying @samp{soft} causes GCC to generate output containing
15373 library calls for floating-point operations.
15374 @samp{softfp} allows the generation of code using hardware floating-point
15375 instructions, but still uses the soft-float calling conventions.
15376 @samp{hard} allows generation of floating-point instructions
15377 and uses FPU-specific calling conventions.
15379 The default depends on the specific target configuration.  Note that
15380 the hard-float and soft-float ABIs are not link-compatible; you must
15381 compile your entire program with the same ABI, and link with a
15382 compatible set of libraries.
15384 @item -mlittle-endian
15385 @opindex mlittle-endian
15386 Generate code for a processor running in little-endian mode.  This is
15387 the default for all standard configurations.
15389 @item -mbig-endian
15390 @opindex mbig-endian
15391 Generate code for a processor running in big-endian mode; the default is
15392 to compile code for a little-endian processor.
15394 @item -mbe8
15395 @itemx -mbe32
15396 @opindex mbe8
15397 When linking a big-endian image select between BE8 and BE32 formats.
15398 The option has no effect for little-endian images and is ignored.  The
15399 default is dependent on the selected target architecture.  For ARMv6
15400 and later architectures the default is BE8, for older architectures
15401 the default is BE32.  BE32 format has been deprecated by ARM.
15403 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15404 @opindex march
15405 This specifies the name of the target ARM architecture.  GCC uses this
15406 name to determine what kind of instructions it can emit when generating
15407 assembly code.  This option can be used in conjunction with or instead
15408 of the @option{-mcpu=} option.
15410 Permissible names are:
15411 @samp{armv4t},
15412 @samp{armv5t}, @samp{armv5te},
15413 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15414 @samp{armv6z}, @samp{armv6zk},
15415 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15416 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a},
15417 @samp{armv7-r},
15418 @samp{armv8-r},
15419 @samp{armv6-m}, @samp{armv6s-m},
15420 @samp{armv7-m}, @samp{armv7e-m},
15421 @samp{armv8-m.base}, @samp{armv8-m.main},
15422 @samp{iwmmxt} and @samp{iwmmxt2}.
15424 Additionally, the following architectures, which lack support for the
15425 Thumb exection state, are recognized but support is deprecated:
15426 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15427 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15429 Many of the architectures support extensions.  These can be added by
15430 appending @samp{+@var{extension}} to the architecture name.  Extension
15431 options are processed in order and capabilities accumulate.  An extension
15432 will also enable any necessary base extensions
15433 upon which it depends.  For example, the @samp{+crypto} extension
15434 will always enable the @samp{+simd} extension.  The exception to the
15435 additive construction is for extensions that are prefixed with
15436 @samp{+no@dots{}}: these extensions disable the specified option and
15437 any other extensions that may depend on the presence of that
15438 extension.
15440 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15441 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15442 entirely disabled by the @samp{+nofp} option that follows it.
15444 Most extension names are generically named, but have an effect that is
15445 dependent upon the architecture to which it is applied.  For example,
15446 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15447 @samp{armv8-a} architectures, but will enable the original ARMv7
15448 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-a
15449 variant for @samp{armv8-a}.
15451 The table below lists the supported extensions for each architecture.
15452 Architectures not mentioned do not support any extensions.
15454 @table @samp
15455 @item  armv5e
15456 @itemx armv5te
15457 @itemx armv6
15458 @itemx armv6j
15459 @itemx armv6k
15460 @itemx armv6kz
15461 @itemx armv6t2
15462 @itemx armv6z
15463 @itemx armv6zk
15464 @table @samp
15465 @item +fp
15466 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15467 used as an alias for this extension.
15469 @item +nofp
15470 Disable the floating-point instructions.
15471 @end table
15473 @item armv7
15474 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15475 @table @samp
15476 @item +fp
15477 The VFPv3 floating-point instructions, with 16 double-precision
15478 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15479 for this extension.  Note that floating-point is not supported by the
15480 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15481 ARMv7-R architectures.
15483 @item +nofp
15484 Disable the floating-point instructions.
15485 @end table
15487 @item armv7-a
15488 @table @samp
15489 @item +fp
15490 The VFPv3 floating-point instructions, with 16 double-precision
15491 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15492 for this extension.
15494 @item +simd
15495 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15496 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15497 for this extension.
15499 @item +vfpv3
15500 The VFPv3 floating-point instructions, with 32 double-precision
15501 registers.
15503 @item +vfpv3-d16-fp16
15504 The VFPv3 floating-point instructions, with 16 double-precision
15505 registers and the half-precision floating-point conversion operations.
15507 @item +vfpv3-fp16
15508 The VFPv3 floating-point instructions, with 32 double-precision
15509 registers and the half-precision floating-point conversion operations.
15511 @item +vfpv4-d16
15512 The VFPv4 floating-point instructions, with 16 double-precision
15513 registers.
15515 @item +vfpv4
15516 The VFPv4 floating-point instructions, with 32 double-precision
15517 registers.
15519 @item +neon-fp16
15520 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15521 the half-precision floating-point conversion operations.
15523 @item +neon-vfpv4
15524 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15526 @item +nosimd
15527 Disable the Advanced SIMD instructions (does not disable floating point).
15529 @item +nofp
15530 Disable the floating-point and Advanced SIMD instructions.
15531 @end table
15533 @item armv7ve
15534 The extended version of the ARMv7-A architecture with support for
15535 virtualization.
15536 @table @samp
15537 @item +fp
15538 The VFPv4 floating-point instructions, with 16 double-precision registers.
15539 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15541 @item +simd
15542 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15543 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15545 @item +vfpv3-d16
15546 The VFPv3 floating-point instructions, with 16 double-precision
15547 registers.
15549 @item +vfpv3
15550 The VFPv3 floating-point instructions, with 32 double-precision
15551 registers.
15553 @item +vfpv3-d16-fp16
15554 The VFPv3 floating-point instructions, with 16 double-precision
15555 registers and the half-precision floating-point conversion operations.
15557 @item +vfpv3-fp16
15558 The VFPv3 floating-point instructions, with 32 double-precision
15559 registers and the half-precision floating-point conversion operations.
15561 @item +vfpv4-d16
15562 The VFPv4 floating-point instructions, with 16 double-precision
15563 registers.
15565 @item +vfpv4
15566 The VFPv4 floating-point instructions, with 32 double-precision
15567 registers.
15569 @item +neon
15570 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15571 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15573 @item +neon-fp16
15574 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15575 the half-precision floating-point conversion operations.
15577 @item +nosimd
15578 Disable the Advanced SIMD instructions (does not disable floating point).
15580 @item +nofp
15581 Disable the floating-point and Advanced SIMD instructions.
15582 @end table
15584 @item armv8-a
15585 @table @samp
15586 @item +crc
15587 The Cyclic Redundancy Check (CRC) instructions.
15588 @item +simd
15589 The ARMv8 Advanced SIMD and floating-point instructions.
15590 @item +crypto
15591 The cryptographic instructions.
15592 @item +nocrypto
15593 Disable the cryptographic isntructions.
15594 @item +nofp
15595 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15596 @end table
15598 @item armv8.1-a
15599 @table @samp
15600 @item +simd
15601 The ARMv8.1 Advanced SIMD and floating-point instructions.
15603 @item +crypto
15604 The cryptographic instructions.  This also enables the Advanced SIMD and
15605 floating-point instructions.
15607 @item +nocrypto
15608 Disable the cryptographic isntructions.
15610 @item +nofp
15611 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15612 @end table
15614 @item armv8.2-a
15615 @table @samp
15616 @item +fp16
15617 The half-precision floating-point data processing instructions.
15618 This also enables the Advanced SIMD and floating-point instructions.
15620 @item +simd
15621 The ARMv8.1 Advanced SIMD and floating-point instructions.
15623 @item +crypto
15624 The cryptographic instructions.  This also enables the Advanced SIMD and
15625 floating-point instructions.
15627 @item +dotprod
15628 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
15630 @item +nocrypto
15631 Disable the cryptographic extension.
15633 @item +nofp
15634 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15635 @end table
15637 @item armv7-r
15638 @table @samp
15639 @item +fp.sp
15640 The single-precision VFPv3 floating-point instructions.  The extension
15641 @samp{+vfpv3xd} can be used as an alias for this extension.
15643 @item +fp
15644 The VFPv3 floating-point instructions with 16 double-precision registers.
15645 The extension +vfpv3-d16 can be used as an alias for this extension.
15647 @item +nofp
15648 Disable the floating-point extension.
15650 @item +idiv
15651 The ARM-state integer division instructions.
15653 @item +noidiv
15654 Disable the ARM-state integer division extension.
15655 @end table
15657 @item armv7e-m
15658 @table @samp
15659 @item +fp
15660 The single-precision VFPv4 floating-point instructions.
15662 @item +fpv5
15663 The single-precision FPv5 floating-point instructions.
15665 @item +fp.dp
15666 The single- and double-precision FPv5 floating-point instructions.
15668 @item +nofp
15669 Disable the floating-point extensions.
15670 @end table
15672 @item  armv8-m.main
15673 @table @samp
15674 @item +dsp
15675 The DSP instructions.
15677 @item +nodsp
15678 Disable the DSP extension.
15680 @item +fp
15681 The single-precision floating-point instructions.
15683 @item +fp.dp
15684 The single- and double-precision floating-point instructions.
15686 @item +nofp
15687 Disable the floating-point extension.
15688 @end table
15690 @item armv8-r
15691 @table @samp
15692 @item +crc
15693 The Cyclic Redundancy Check (CRC) instructions.
15694 @item +fp.sp
15695 The single-precision FPv5 floating-point instructions.
15696 @item +simd
15697 The ARMv8 Advanced SIMD and floating-point instructions.
15698 @item +crypto
15699 The cryptographic instructions.
15700 @item +nocrypto
15701 Disable the cryptographic isntructions.
15702 @item +nofp
15703 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15704 @end table
15706 @end table
15708 @option{-march=native} causes the compiler to auto-detect the architecture
15709 of the build computer.  At present, this feature is only supported on
15710 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15711 is unsuccessful the option has no effect.
15713 @item -mtune=@var{name}
15714 @opindex mtune
15715 This option specifies the name of the target ARM processor for
15716 which GCC should tune the performance of the code.
15717 For some ARM implementations better performance can be obtained by using
15718 this option.
15719 Permissible names are: @samp{arm2}, @samp{arm250},
15720 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15721 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15722 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15723 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15724 @samp{arm720},
15725 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15726 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15727 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15728 @samp{strongarm1110},
15729 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15730 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15731 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15732 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15733 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15734 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15735 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15736 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15737 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15738 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
15739 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
15740 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
15741 @samp{cortex-r8}, @samp{cortex-r52},
15742 @samp{cortex-m33},
15743 @samp{cortex-m23},
15744 @samp{cortex-m7},
15745 @samp{cortex-m4},
15746 @samp{cortex-m3},
15747 @samp{cortex-m1},
15748 @samp{cortex-m0},
15749 @samp{cortex-m0plus},
15750 @samp{cortex-m1.small-multiply},
15751 @samp{cortex-m0.small-multiply},
15752 @samp{cortex-m0plus.small-multiply},
15753 @samp{exynos-m1},
15754 @samp{marvell-pj4},
15755 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15756 @samp{fa526}, @samp{fa626},
15757 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15758 @samp{xgene1}.
15760 Additionally, this option can specify that GCC should tune the performance
15761 of the code for a big.LITTLE system.  Permissible names are:
15762 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15763 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15764 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
15765 @samp{cortex-a75.cortex-a55}.
15767 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15768 performance for a blend of processors within architecture @var{arch}.
15769 The aim is to generate code that run well on the current most popular
15770 processors, balancing between optimizations that benefit some CPUs in the
15771 range, and avoiding performance pitfalls of other CPUs.  The effects of
15772 this option may change in future GCC versions as CPU models come and go.
15774 @option{-mtune} permits the same extension options as @option{-mcpu}, but
15775 the extension options do not affect the tuning of the generated code.
15777 @option{-mtune=native} causes the compiler to auto-detect the CPU
15778 of the build computer.  At present, this feature is only supported on
15779 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15780 unsuccessful the option has no effect.
15782 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
15783 @opindex mcpu
15784 This specifies the name of the target ARM processor.  GCC uses this name
15785 to derive the name of the target ARM architecture (as if specified
15786 by @option{-march}) and the ARM processor type for which to tune for
15787 performance (as if specified by @option{-mtune}).  Where this option
15788 is used in conjunction with @option{-march} or @option{-mtune},
15789 those options take precedence over the appropriate part of this option.
15791 Many of the supported CPUs implement optional architectural
15792 extensions.  Where this is so the architectural extensions are
15793 normally enabled by default.  If implementations that lack the
15794 extension exist, then the extension syntax can be used to disable
15795 those extensions that have been omitted.  For floating-point and
15796 Advanced SIMD (Neon) instructions, the settings of the options
15797 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
15798 floating-point and Advanced SIMD instructions will only be used if
15799 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
15800 @option{-mfpu} other than @samp{auto} will override the available
15801 floating-point and SIMD extension instructions.
15803 For example, @samp{cortex-a9} can be found in three major
15804 configurations: integer only, with just a floating-point unit or with
15805 floating-point and Advanced SIMD.  The default is to enable all the
15806 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
15807 be used to disable just the SIMD or both the SIMD and floating-point
15808 instructions respectively.
15810 Permissible names for this option are the same as those for
15811 @option{-mtune}.
15813 The following extension options are common to the listed CPUs:
15815 @table @samp
15816 @item  +nofp
15817 Disables the floating-point instructions on @samp{arm9e},
15818 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
15819 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
15820 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15821 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
15822 Disables the floating-point and SIMD instructions on
15823 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
15824 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
15825 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
15826 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
15827 @samp{cortex-a53} and @samp{cortex-a55}.
15829 @item +nofp.dp
15830 Disables the double-precision component of the floating-point instructions
15831 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
15833 @item +nosimd
15834 Disables the SIMD (but not floating-point) instructions on
15835 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
15836 and @samp{cortex-a9}.
15838 @item +crypto
15839 Enables the cryptographic instructions on @samp{cortex-a32},
15840 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
15841 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
15842 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15843 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
15844 @samp{cortex-a75.cortex-a55}.
15845 @end table
15847 Additionally the @samp{generic-armv7-a} pseudo target defaults to
15848 VFPv3 with 16 double-precision registers.  It supports the following
15849 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
15850 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
15851 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
15852 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
15853 @option{-march=armv7-a}.
15855 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15856 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15857 See @option{-mtune} for more information.
15859 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15860 of the build computer.  At present, this feature is only supported on
15861 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15862 is unsuccessful the option has no effect.
15864 @item -mfpu=@var{name}
15865 @opindex mfpu
15866 This specifies what floating-point hardware (or hardware emulation) is
15867 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
15868 @samp{vfpv3},
15869 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15870 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15871 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15872 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15873 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15874 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15875 is an alias for @samp{vfpv2}.
15877 The setting @samp{auto} is the default and is special.  It causes the
15878 compiler to select the floating-point and Advanced SIMD instructions
15879 based on the settings of @option{-mcpu} and @option{-march}.
15881 If the selected floating-point hardware includes the NEON extension
15882 (e.g. @option{-mfpu=neon}), note that floating-point
15883 operations are not generated by GCC's auto-vectorization pass unless
15884 @option{-funsafe-math-optimizations} is also specified.  This is
15885 because NEON hardware does not fully implement the IEEE 754 standard for
15886 floating-point arithmetic (in particular denormal values are treated as
15887 zero), so the use of NEON instructions may lead to a loss of precision.
15889 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}).
15891 @item -mfp16-format=@var{name}
15892 @opindex mfp16-format
15893 Specify the format of the @code{__fp16} half-precision floating-point type.
15894 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15895 the default is @samp{none}, in which case the @code{__fp16} type is not
15896 defined.  @xref{Half-Precision}, for more information.
15898 @item -mstructure-size-boundary=@var{n}
15899 @opindex mstructure-size-boundary
15900 The sizes of all structures and unions are rounded up to a multiple
15901 of the number of bits set by this option.  Permissible values are 8, 32
15902 and 64.  The default value varies for different toolchains.  For the COFF
15903 targeted toolchain the default value is 8.  A value of 64 is only allowed
15904 if the underlying ABI supports it.
15906 Specifying a larger number can produce faster, more efficient code, but
15907 can also increase the size of the program.  Different values are potentially
15908 incompatible.  Code compiled with one value cannot necessarily expect to
15909 work with code or libraries compiled with another value, if they exchange
15910 information using structures or unions.
15912 This option is deprecated.
15914 @item -mabort-on-noreturn
15915 @opindex mabort-on-noreturn
15916 Generate a call to the function @code{abort} at the end of a
15917 @code{noreturn} function.  It is executed if the function tries to
15918 return.
15920 @item -mlong-calls
15921 @itemx -mno-long-calls
15922 @opindex mlong-calls
15923 @opindex mno-long-calls
15924 Tells the compiler to perform function calls by first loading the
15925 address of the function into a register and then performing a subroutine
15926 call on this register.  This switch is needed if the target function
15927 lies outside of the 64-megabyte addressing range of the offset-based
15928 version of subroutine call instruction.
15930 Even if this switch is enabled, not all function calls are turned
15931 into long calls.  The heuristic is that static functions, functions
15932 that have the @code{short_call} attribute, functions that are inside
15933 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15934 definitions have already been compiled within the current compilation
15935 unit are not turned into long calls.  The exceptions to this rule are
15936 that weak function definitions, functions with the @code{long_call}
15937 attribute or the @code{section} attribute, and functions that are within
15938 the scope of a @code{#pragma long_calls} directive are always
15939 turned into long calls.
15941 This feature is not enabled by default.  Specifying
15942 @option{-mno-long-calls} restores the default behavior, as does
15943 placing the function calls within the scope of a @code{#pragma
15944 long_calls_off} directive.  Note these switches have no effect on how
15945 the compiler generates code to handle function calls via function
15946 pointers.
15948 @item -msingle-pic-base
15949 @opindex msingle-pic-base
15950 Treat the register used for PIC addressing as read-only, rather than
15951 loading it in the prologue for each function.  The runtime system is
15952 responsible for initializing this register with an appropriate value
15953 before execution begins.
15955 @item -mpic-register=@var{reg}
15956 @opindex mpic-register
15957 Specify the register to be used for PIC addressing.
15958 For standard PIC base case, the default is any suitable register
15959 determined by compiler.  For single PIC base case, the default is
15960 @samp{R9} if target is EABI based or stack-checking is enabled,
15961 otherwise the default is @samp{R10}.
15963 @item -mpic-data-is-text-relative
15964 @opindex mpic-data-is-text-relative
15965 Assume that the displacement between the text and data segments is fixed
15966 at static link time.  This permits using PC-relative addressing
15967 operations to access data known to be in the data segment.  For
15968 non-VxWorks RTP targets, this option is enabled by default.  When
15969 disabled on such targets, it will enable @option{-msingle-pic-base} by
15970 default.
15972 @item -mpoke-function-name
15973 @opindex mpoke-function-name
15974 Write the name of each function into the text section, directly
15975 preceding the function prologue.  The generated code is similar to this:
15977 @smallexample
15978      t0
15979          .ascii "arm_poke_function_name", 0
15980          .align
15981      t1
15982          .word 0xff000000 + (t1 - t0)
15983      arm_poke_function_name
15984          mov     ip, sp
15985          stmfd   sp!, @{fp, ip, lr, pc@}
15986          sub     fp, ip, #4
15987 @end smallexample
15989 When performing a stack backtrace, code can inspect the value of
15990 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15991 location @code{pc - 12} and the top 8 bits are set, then we know that
15992 there is a function name embedded immediately preceding this location
15993 and has length @code{((pc[-3]) & 0xff000000)}.
15995 @item -mthumb
15996 @itemx -marm
15997 @opindex marm
15998 @opindex mthumb
16000 Select between generating code that executes in ARM and Thumb
16001 states.  The default for most configurations is to generate code
16002 that executes in ARM state, but the default can be changed by
16003 configuring GCC with the @option{--with-mode=}@var{state}
16004 configure option.
16006 You can also override the ARM and Thumb mode for each function
16007 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16008 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16010 @item -mtpcs-frame
16011 @opindex mtpcs-frame
16012 Generate a stack frame that is compliant with the Thumb Procedure Call
16013 Standard for all non-leaf functions.  (A leaf function is one that does
16014 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16016 @item -mtpcs-leaf-frame
16017 @opindex mtpcs-leaf-frame
16018 Generate a stack frame that is compliant with the Thumb Procedure Call
16019 Standard for all leaf functions.  (A leaf function is one that does
16020 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16022 @item -mcallee-super-interworking
16023 @opindex mcallee-super-interworking
16024 Gives all externally visible functions in the file being compiled an ARM
16025 instruction set header which switches to Thumb mode before executing the
16026 rest of the function.  This allows these functions to be called from
16027 non-interworking code.  This option is not valid in AAPCS configurations
16028 because interworking is enabled by default.
16030 @item -mcaller-super-interworking
16031 @opindex mcaller-super-interworking
16032 Allows calls via function pointers (including virtual functions) to
16033 execute correctly regardless of whether the target code has been
16034 compiled for interworking or not.  There is a small overhead in the cost
16035 of executing a function pointer if this option is enabled.  This option
16036 is not valid in AAPCS configurations because interworking is enabled
16037 by default.
16039 @item -mtp=@var{name}
16040 @opindex mtp
16041 Specify the access model for the thread local storage pointer.  The valid
16042 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16043 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16044 (supported in the arm6k architecture), and @samp{auto}, which uses the
16045 best available method for the selected processor.  The default setting is
16046 @samp{auto}.
16048 @item -mtls-dialect=@var{dialect}
16049 @opindex mtls-dialect
16050 Specify the dialect to use for accessing thread local storage.  Two
16051 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16052 @samp{gnu} dialect selects the original GNU scheme for supporting
16053 local and global dynamic TLS models.  The @samp{gnu2} dialect
16054 selects the GNU descriptor scheme, which provides better performance
16055 for shared libraries.  The GNU descriptor scheme is compatible with
16056 the original scheme, but does require new assembler, linker and
16057 library support.  Initial and local exec TLS models are unaffected by
16058 this option and always use the original scheme.
16060 @item -mword-relocations
16061 @opindex mword-relocations
16062 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16063 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16064 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16065 is specified.
16067 @item -mfix-cortex-m3-ldrd
16068 @opindex mfix-cortex-m3-ldrd
16069 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16070 with overlapping destination and base registers are used.  This option avoids
16071 generating these instructions.  This option is enabled by default when
16072 @option{-mcpu=cortex-m3} is specified.
16074 @item -munaligned-access
16075 @itemx -mno-unaligned-access
16076 @opindex munaligned-access
16077 @opindex mno-unaligned-access
16078 Enables (or disables) reading and writing of 16- and 32- bit values
16079 from addresses that are not 16- or 32- bit aligned.  By default
16080 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16081 ARMv8-M Baseline architectures, and enabled for all other
16082 architectures.  If unaligned access is not enabled then words in packed
16083 data structures are accessed a byte at a time.
16085 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16086 generated object file to either true or false, depending upon the
16087 setting of this option.  If unaligned access is enabled then the
16088 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16089 defined.
16091 @item -mneon-for-64bits
16092 @opindex mneon-for-64bits
16093 Enables using Neon to handle scalar 64-bits operations. This is
16094 disabled by default since the cost of moving data from core registers
16095 to Neon is high.
16097 @item -mslow-flash-data
16098 @opindex mslow-flash-data
16099 Assume loading data from flash is slower than fetching instruction.
16100 Therefore literal load is minimized for better performance.
16101 This option is only supported when compiling for ARMv7 M-profile and
16102 off by default.
16104 @item -masm-syntax-unified
16105 @opindex masm-syntax-unified
16106 Assume inline assembler is using unified asm syntax.  The default is
16107 currently off which implies divided syntax.  This option has no impact
16108 on Thumb2. However, this may change in future releases of GCC.
16109 Divided syntax should be considered deprecated.
16111 @item -mrestrict-it
16112 @opindex mrestrict-it
16113 Restricts generation of IT blocks to conform to the rules of ARMv8.
16114 IT blocks can only contain a single 16-bit instruction from a select
16115 set of instructions. This option is on by default for ARMv8 Thumb mode.
16117 @item -mprint-tune-info
16118 @opindex mprint-tune-info
16119 Print CPU tuning information as comment in assembler file.  This is
16120 an option used only for regression testing of the compiler and not
16121 intended for ordinary use in compiling code.  This option is disabled
16122 by default.
16124 @item -mpure-code
16125 @opindex mpure-code
16126 Do not allow constant data to be placed in code sections.
16127 Additionally, when compiling for ELF object format give all text sections the
16128 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16129 is only available when generating non-pic code for M-profile targets with the
16130 MOVT instruction.
16132 @item -mcmse
16133 @opindex mcmse
16134 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16135 Development Tools Engineering Specification", which can be found on
16136 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16137 @end table
16139 @node AVR Options
16140 @subsection AVR Options
16141 @cindex AVR Options
16143 These options are defined for AVR implementations:
16145 @table @gcctabopt
16146 @item -mmcu=@var{mcu}
16147 @opindex mmcu
16148 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16150 The default for this option is@tie{}@samp{avr2}.
16152 GCC supports the following AVR devices and ISAs:
16154 @include avr-mmcu.texi
16156 @item -mabsdata
16157 @opindex mabsdata
16159 Assume that all data in static storage can be accessed by LDS / STS
16160 instructions.  This option has only an effect on reduced Tiny devices like
16161 ATtiny40.  See also the @code{absdata}
16162 @ref{AVR Variable Attributes,variable attribute}.
16164 @item -maccumulate-args
16165 @opindex maccumulate-args
16166 Accumulate outgoing function arguments and acquire/release the needed
16167 stack space for outgoing function arguments once in function
16168 prologue/epilogue.  Without this option, outgoing arguments are pushed
16169 before calling a function and popped afterwards.
16171 Popping the arguments after the function call can be expensive on
16172 AVR so that accumulating the stack space might lead to smaller
16173 executables because arguments need not be removed from the
16174 stack after such a function call.
16176 This option can lead to reduced code size for functions that perform
16177 several calls to functions that get their arguments on the stack like
16178 calls to printf-like functions.
16180 @item -mbranch-cost=@var{cost}
16181 @opindex mbranch-cost
16182 Set the branch costs for conditional branch instructions to
16183 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16184 integers. The default branch cost is 0.
16186 @item -mcall-prologues
16187 @opindex mcall-prologues
16188 Functions prologues/epilogues are expanded as calls to appropriate
16189 subroutines.  Code size is smaller.
16191 @item -mgas-isr-prologues
16192 @opindex mgas-isr-prologues
16193 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16194 instruction supported by GNU Binutils.
16195 If this option is on, the feature can still be disabled for individual
16196 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16197 function attribute.  This feature is activated per default
16198 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16199 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16201 @item -mint8
16202 @opindex mint8
16203 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16204 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16205 and @code{long long} is 4 bytes.  Please note that this option does not
16206 conform to the C standards, but it results in smaller code
16207 size.
16209 @item -mn-flash=@var{num}
16210 @opindex mn-flash
16211 Assume that the flash memory has a size of 
16212 @var{num} times 64@tie{}KiB.
16214 @item -mno-interrupts
16215 @opindex mno-interrupts
16216 Generated code is not compatible with hardware interrupts.
16217 Code size is smaller.
16219 @item -mrelax
16220 @opindex mrelax
16221 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16222 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16223 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16224 the assembler's command line and the @option{--relax} option to the
16225 linker's command line.
16227 Jump relaxing is performed by the linker because jump offsets are not
16228 known before code is located. Therefore, the assembler code generated by the
16229 compiler is the same, but the instructions in the executable may
16230 differ from instructions in the assembler code.
16232 Relaxing must be turned on if linker stubs are needed, see the
16233 section on @code{EIND} and linker stubs below.
16235 @item -mrmw
16236 @opindex mrmw
16237 Assume that the device supports the Read-Modify-Write
16238 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16240 @item -mshort-calls
16241 @opindex mshort-calls
16243 Assume that @code{RJMP} and @code{RCALL} can target the whole
16244 program memory.
16246 This option is used internally for multilib selection.  It is
16247 not an optimization option, and you don't need to set it by hand.
16249 @item -msp8
16250 @opindex msp8
16251 Treat the stack pointer register as an 8-bit register,
16252 i.e.@: assume the high byte of the stack pointer is zero.
16253 In general, you don't need to set this option by hand.
16255 This option is used internally by the compiler to select and
16256 build multilibs for architectures @code{avr2} and @code{avr25}.
16257 These architectures mix devices with and without @code{SPH}.
16258 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16259 the compiler driver adds or removes this option from the compiler
16260 proper's command line, because the compiler then knows if the device
16261 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16262 register or not.
16264 @item -mstrict-X
16265 @opindex mstrict-X
16266 Use address register @code{X} in a way proposed by the hardware.  This means
16267 that @code{X} is only used in indirect, post-increment or
16268 pre-decrement addressing.
16270 Without this option, the @code{X} register may be used in the same way
16271 as @code{Y} or @code{Z} which then is emulated by additional
16272 instructions.  
16273 For example, loading a value with @code{X+const} addressing with a
16274 small non-negative @code{const < 64} to a register @var{Rn} is
16275 performed as
16277 @example
16278 adiw r26, const   ; X += const
16279 ld   @var{Rn}, X        ; @var{Rn} = *X
16280 sbiw r26, const   ; X -= const
16281 @end example
16283 @item -mtiny-stack
16284 @opindex mtiny-stack
16285 Only change the lower 8@tie{}bits of the stack pointer.
16287 @item -mfract-convert-truncate
16288 @opindex mfract-convert-truncate
16289 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16291 @item -nodevicelib
16292 @opindex nodevicelib
16293 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16295 @item -Waddr-space-convert
16296 @opindex Waddr-space-convert
16297 Warn about conversions between address spaces in the case where the
16298 resulting address space is not contained in the incoming address space.
16300 @item -Wmisspelled-isr
16301 @opindex Wmisspelled-isr
16302 Warn if the ISR is misspelled, i.e. without __vector prefix.
16303 Enabled by default.
16304 @end table
16306 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16307 @cindex @code{EIND}
16308 Pointers in the implementation are 16@tie{}bits wide.
16309 The address of a function or label is represented as word address so
16310 that indirect jumps and calls can target any code address in the
16311 range of 64@tie{}Ki words.
16313 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16314 bytes of program memory space, there is a special function register called
16315 @code{EIND} that serves as most significant part of the target address
16316 when @code{EICALL} or @code{EIJMP} instructions are used.
16318 Indirect jumps and calls on these devices are handled as follows by
16319 the compiler and are subject to some limitations:
16321 @itemize @bullet
16323 @item
16324 The compiler never sets @code{EIND}.
16326 @item
16327 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16328 instructions or might read @code{EIND} directly in order to emulate an
16329 indirect call/jump by means of a @code{RET} instruction.
16331 @item
16332 The compiler assumes that @code{EIND} never changes during the startup
16333 code or during the application. In particular, @code{EIND} is not
16334 saved/restored in function or interrupt service routine
16335 prologue/epilogue.
16337 @item
16338 For indirect calls to functions and computed goto, the linker
16339 generates @emph{stubs}. Stubs are jump pads sometimes also called
16340 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16341 The stub contains a direct jump to the desired address.
16343 @item
16344 Linker relaxation must be turned on so that the linker generates
16345 the stubs correctly in all situations. See the compiler option
16346 @option{-mrelax} and the linker option @option{--relax}.
16347 There are corner cases where the linker is supposed to generate stubs
16348 but aborts without relaxation and without a helpful error message.
16350 @item
16351 The default linker script is arranged for code with @code{EIND = 0}.
16352 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16353 linker script has to be used in order to place the sections whose
16354 name start with @code{.trampolines} into the segment where @code{EIND}
16355 points to.
16357 @item
16358 The startup code from libgcc never sets @code{EIND}.
16359 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16360 For the impact of AVR-LibC on @code{EIND}, see the
16361 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16363 @item
16364 It is legitimate for user-specific startup code to set up @code{EIND}
16365 early, for example by means of initialization code located in
16366 section @code{.init3}. Such code runs prior to general startup code
16367 that initializes RAM and calls constructors, but after the bit
16368 of startup code from AVR-LibC that sets @code{EIND} to the segment
16369 where the vector table is located.
16370 @example
16371 #include <avr/io.h>
16373 static void
16374 __attribute__((section(".init3"),naked,used,no_instrument_function))
16375 init3_set_eind (void)
16377   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16378                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16380 @end example
16382 @noindent
16383 The @code{__trampolines_start} symbol is defined in the linker script.
16385 @item
16386 Stubs are generated automatically by the linker if
16387 the following two conditions are met:
16388 @itemize @minus
16390 @item The address of a label is taken by means of the @code{gs} modifier
16391 (short for @emph{generate stubs}) like so:
16392 @example
16393 LDI r24, lo8(gs(@var{func}))
16394 LDI r25, hi8(gs(@var{func}))
16395 @end example
16396 @item The final location of that label is in a code segment
16397 @emph{outside} the segment where the stubs are located.
16398 @end itemize
16400 @item
16401 The compiler emits such @code{gs} modifiers for code labels in the
16402 following situations:
16403 @itemize @minus
16404 @item Taking address of a function or code label.
16405 @item Computed goto.
16406 @item If prologue-save function is used, see @option{-mcall-prologues}
16407 command-line option.
16408 @item Switch/case dispatch tables. If you do not want such dispatch
16409 tables you can specify the @option{-fno-jump-tables} command-line option.
16410 @item C and C++ constructors/destructors called during startup/shutdown.
16411 @item If the tools hit a @code{gs()} modifier explained above.
16412 @end itemize
16414 @item
16415 Jumping to non-symbolic addresses like so is @emph{not} supported:
16417 @example
16418 int main (void)
16420     /* Call function at word address 0x2 */
16421     return ((int(*)(void)) 0x2)();
16423 @end example
16425 Instead, a stub has to be set up, i.e.@: the function has to be called
16426 through a symbol (@code{func_4} in the example):
16428 @example
16429 int main (void)
16431     extern int func_4 (void);
16433     /* Call function at byte address 0x4 */
16434     return func_4();
16436 @end example
16438 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16439 Alternatively, @code{func_4} can be defined in the linker script.
16440 @end itemize
16442 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16443 @cindex @code{RAMPD}
16444 @cindex @code{RAMPX}
16445 @cindex @code{RAMPY}
16446 @cindex @code{RAMPZ}
16447 Some AVR devices support memories larger than the 64@tie{}KiB range
16448 that can be accessed with 16-bit pointers.  To access memory locations
16449 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16450 register is used as high part of the address:
16451 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16452 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16453 register, respectively, to get a wide address. Similarly,
16454 @code{RAMPD} is used together with direct addressing.
16456 @itemize
16457 @item
16458 The startup code initializes the @code{RAMP} special function
16459 registers with zero.
16461 @item
16462 If a @ref{AVR Named Address Spaces,named address space} other than
16463 generic or @code{__flash} is used, then @code{RAMPZ} is set
16464 as needed before the operation.
16466 @item
16467 If the device supports RAM larger than 64@tie{}KiB and the compiler
16468 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16469 is reset to zero after the operation.
16471 @item
16472 If the device comes with a specific @code{RAMP} register, the ISR
16473 prologue/epilogue saves/restores that SFR and initializes it with
16474 zero in case the ISR code might (implicitly) use it.
16476 @item
16477 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16478 If you use inline assembler to read from locations outside the
16479 16-bit address range and change one of the @code{RAMP} registers,
16480 you must reset it to zero after the access.
16482 @end itemize
16484 @subsubsection AVR Built-in Macros
16486 GCC defines several built-in macros so that the user code can test
16487 for the presence or absence of features.  Almost any of the following
16488 built-in macros are deduced from device capabilities and thus
16489 triggered by the @option{-mmcu=} command-line option.
16491 For even more AVR-specific built-in macros see
16492 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16494 @table @code
16496 @item __AVR_ARCH__
16497 Build-in macro that resolves to a decimal number that identifies the
16498 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16499 Possible values are:
16501 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16502 @code{4}, @code{5}, @code{51}, @code{6}
16504 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16505 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16507 respectively and
16509 @code{100},
16510 @code{102}, @code{103}, @code{104},
16511 @code{105}, @code{106}, @code{107}
16513 for @var{mcu}=@code{avrtiny},
16514 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16515 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16516 If @var{mcu} specifies a device, this built-in macro is set
16517 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16518 defined to @code{4}.
16520 @item __AVR_@var{Device}__
16521 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16522 the device's name. For example, @option{-mmcu=atmega8} defines the
16523 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16524 @code{__AVR_ATtiny261A__}, etc.
16526 The built-in macros' names follow
16527 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16528 the device name as from the AVR user manual. The difference between
16529 @var{Device} in the built-in macro and @var{device} in
16530 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16532 If @var{device} is not a device but only a core architecture like
16533 @samp{avr51}, this macro is not defined.
16535 @item __AVR_DEVICE_NAME__
16536 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16537 the device's name. For example, with @option{-mmcu=atmega8} the macro
16538 is defined to @code{atmega8}.
16540 If @var{device} is not a device but only a core architecture like
16541 @samp{avr51}, this macro is not defined.
16543 @item __AVR_XMEGA__
16544 The device / architecture belongs to the XMEGA family of devices.
16546 @item __AVR_HAVE_ELPM__
16547 The device has the @code{ELPM} instruction.
16549 @item __AVR_HAVE_ELPMX__
16550 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16551 R@var{n},Z+} instructions.
16553 @item __AVR_HAVE_MOVW__
16554 The device has the @code{MOVW} instruction to perform 16-bit
16555 register-register moves.
16557 @item __AVR_HAVE_LPMX__
16558 The device has the @code{LPM R@var{n},Z} and
16559 @code{LPM R@var{n},Z+} instructions.
16561 @item __AVR_HAVE_MUL__
16562 The device has a hardware multiplier. 
16564 @item __AVR_HAVE_JMP_CALL__
16565 The device has the @code{JMP} and @code{CALL} instructions.
16566 This is the case for devices with more than 8@tie{}KiB of program
16567 memory.
16569 @item __AVR_HAVE_EIJMP_EICALL__
16570 @itemx __AVR_3_BYTE_PC__
16571 The device has the @code{EIJMP} and @code{EICALL} instructions.
16572 This is the case for devices with more than 128@tie{}KiB of program memory.
16573 This also means that the program counter
16574 (PC) is 3@tie{}bytes wide.
16576 @item __AVR_2_BYTE_PC__
16577 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16578 with up to 128@tie{}KiB of program memory.
16580 @item __AVR_HAVE_8BIT_SP__
16581 @itemx __AVR_HAVE_16BIT_SP__
16582 The stack pointer (SP) register is treated as 8-bit respectively
16583 16-bit register by the compiler.
16584 The definition of these macros is affected by @option{-mtiny-stack}.
16586 @item __AVR_HAVE_SPH__
16587 @itemx __AVR_SP8__
16588 The device has the SPH (high part of stack pointer) special function
16589 register or has an 8-bit stack pointer, respectively.
16590 The definition of these macros is affected by @option{-mmcu=} and
16591 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16592 by @option{-msp8}.
16594 @item __AVR_HAVE_RAMPD__
16595 @itemx __AVR_HAVE_RAMPX__
16596 @itemx __AVR_HAVE_RAMPY__
16597 @itemx __AVR_HAVE_RAMPZ__
16598 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16599 @code{RAMPZ} special function register, respectively.
16601 @item __NO_INTERRUPTS__
16602 This macro reflects the @option{-mno-interrupts} command-line option.
16604 @item __AVR_ERRATA_SKIP__
16605 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16606 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16607 instructions because of a hardware erratum.  Skip instructions are
16608 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16609 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16610 set.
16612 @item __AVR_ISA_RMW__
16613 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16615 @item __AVR_SFR_OFFSET__=@var{offset}
16616 Instructions that can address I/O special function registers directly
16617 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16618 address as if addressed by an instruction to access RAM like @code{LD}
16619 or @code{STS}. This offset depends on the device architecture and has
16620 to be subtracted from the RAM address in order to get the
16621 respective I/O@tie{}address.
16623 @item __AVR_SHORT_CALLS__
16624 The @option{-mshort-calls} command line option is set.
16626 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16627 Some devices support reading from flash memory by means of @code{LD*}
16628 instructions.  The flash memory is seen in the data address space
16629 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16630 is not defined, this feature is not available.  If defined,
16631 the address space is linear and there is no need to put
16632 @code{.rodata} into RAM.  This is handled by the default linker
16633 description file, and is currently available for
16634 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16635 there is no need to use address spaces like @code{__flash} or
16636 features like attribute @code{progmem} and @code{pgm_read_*}.
16638 @item __WITH_AVRLIBC__
16639 The compiler is configured to be used together with AVR-Libc.
16640 See the @option{--with-avrlibc} configure option.
16642 @end table
16644 @node Blackfin Options
16645 @subsection Blackfin Options
16646 @cindex Blackfin Options
16648 @table @gcctabopt
16649 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16650 @opindex mcpu=
16651 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16652 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16653 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16654 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16655 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16656 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16657 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16658 @samp{bf561}, @samp{bf592}.
16660 The optional @var{sirevision} specifies the silicon revision of the target
16661 Blackfin processor.  Any workarounds available for the targeted silicon revision
16662 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16663 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16664 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16665 hexadecimal digits representing the major and minor numbers in the silicon
16666 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16667 is not defined.  If @var{sirevision} is @samp{any}, the
16668 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16669 If this optional @var{sirevision} is not used, GCC assumes the latest known
16670 silicon revision of the targeted Blackfin processor.
16672 GCC defines a preprocessor macro for the specified @var{cpu}.
16673 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16674 provided by libgloss to be linked in if @option{-msim} is not given.
16676 Without this option, @samp{bf532} is used as the processor by default.
16678 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16679 only the preprocessor macro is defined.
16681 @item -msim
16682 @opindex msim
16683 Specifies that the program will be run on the simulator.  This causes
16684 the simulator BSP provided by libgloss to be linked in.  This option
16685 has effect only for @samp{bfin-elf} toolchain.
16686 Certain other options, such as @option{-mid-shared-library} and
16687 @option{-mfdpic}, imply @option{-msim}.
16689 @item -momit-leaf-frame-pointer
16690 @opindex momit-leaf-frame-pointer
16691 Don't keep the frame pointer in a register for leaf functions.  This
16692 avoids the instructions to save, set up and restore frame pointers and
16693 makes an extra register available in leaf functions.  The option
16694 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
16695 which might make debugging harder.
16697 @item -mspecld-anomaly
16698 @opindex mspecld-anomaly
16699 When enabled, the compiler ensures that the generated code does not
16700 contain speculative loads after jump instructions. If this option is used,
16701 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16703 @item -mno-specld-anomaly
16704 @opindex mno-specld-anomaly
16705 Don't generate extra code to prevent speculative loads from occurring.
16707 @item -mcsync-anomaly
16708 @opindex mcsync-anomaly
16709 When enabled, the compiler ensures that the generated code does not
16710 contain CSYNC or SSYNC instructions too soon after conditional branches.
16711 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16713 @item -mno-csync-anomaly
16714 @opindex mno-csync-anomaly
16715 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16716 occurring too soon after a conditional branch.
16718 @item -mlow-64k
16719 @opindex mlow-64k
16720 When enabled, the compiler is free to take advantage of the knowledge that
16721 the entire program fits into the low 64k of memory.
16723 @item -mno-low-64k
16724 @opindex mno-low-64k
16725 Assume that the program is arbitrarily large.  This is the default.
16727 @item -mstack-check-l1
16728 @opindex mstack-check-l1
16729 Do stack checking using information placed into L1 scratchpad memory by the
16730 uClinux kernel.
16732 @item -mid-shared-library
16733 @opindex mid-shared-library
16734 Generate code that supports shared libraries via the library ID method.
16735 This allows for execute in place and shared libraries in an environment
16736 without virtual memory management.  This option implies @option{-fPIC}.
16737 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16739 @item -mno-id-shared-library
16740 @opindex mno-id-shared-library
16741 Generate code that doesn't assume ID-based shared libraries are being used.
16742 This is the default.
16744 @item -mleaf-id-shared-library
16745 @opindex mleaf-id-shared-library
16746 Generate code that supports shared libraries via the library ID method,
16747 but assumes that this library or executable won't link against any other
16748 ID shared libraries.  That allows the compiler to use faster code for jumps
16749 and calls.
16751 @item -mno-leaf-id-shared-library
16752 @opindex mno-leaf-id-shared-library
16753 Do not assume that the code being compiled won't link against any ID shared
16754 libraries.  Slower code is generated for jump and call insns.
16756 @item -mshared-library-id=n
16757 @opindex mshared-library-id
16758 Specifies the identification number of the ID-based shared library being
16759 compiled.  Specifying a value of 0 generates more compact code; specifying
16760 other values forces the allocation of that number to the current
16761 library but is no more space- or time-efficient than omitting this option.
16763 @item -msep-data
16764 @opindex msep-data
16765 Generate code that allows the data segment to be located in a different
16766 area of memory from the text segment.  This allows for execute in place in
16767 an environment without virtual memory management by eliminating relocations
16768 against the text section.
16770 @item -mno-sep-data
16771 @opindex mno-sep-data
16772 Generate code that assumes that the data segment follows the text segment.
16773 This is the default.
16775 @item -mlong-calls
16776 @itemx -mno-long-calls
16777 @opindex mlong-calls
16778 @opindex mno-long-calls
16779 Tells the compiler to perform function calls by first loading the
16780 address of the function into a register and then performing a subroutine
16781 call on this register.  This switch is needed if the target function
16782 lies outside of the 24-bit addressing range of the offset-based
16783 version of subroutine call instruction.
16785 This feature is not enabled by default.  Specifying
16786 @option{-mno-long-calls} restores the default behavior.  Note these
16787 switches have no effect on how the compiler generates code to handle
16788 function calls via function pointers.
16790 @item -mfast-fp
16791 @opindex mfast-fp
16792 Link with the fast floating-point library. This library relaxes some of
16793 the IEEE floating-point standard's rules for checking inputs against
16794 Not-a-Number (NAN), in the interest of performance.
16796 @item -minline-plt
16797 @opindex minline-plt
16798 Enable inlining of PLT entries in function calls to functions that are
16799 not known to bind locally.  It has no effect without @option{-mfdpic}.
16801 @item -mmulticore
16802 @opindex mmulticore
16803 Build a standalone application for multicore Blackfin processors. 
16804 This option causes proper start files and link scripts supporting 
16805 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16806 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16808 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16809 selects the one-application-per-core programming model.  Without
16810 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16811 programming model is used. In this model, the main function of Core B
16812 should be named as @code{coreb_main}.
16814 If this option is not used, the single-core application programming
16815 model is used.
16817 @item -mcorea
16818 @opindex mcorea
16819 Build a standalone application for Core A of BF561 when using
16820 the one-application-per-core programming model. Proper start files
16821 and link scripts are used to support Core A, and the macro
16822 @code{__BFIN_COREA} is defined.
16823 This option can only be used in conjunction with @option{-mmulticore}.
16825 @item -mcoreb
16826 @opindex mcoreb
16827 Build a standalone application for Core B of BF561 when using
16828 the one-application-per-core programming model. Proper start files
16829 and link scripts are used to support Core B, and the macro
16830 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16831 should be used instead of @code{main}. 
16832 This option can only be used in conjunction with @option{-mmulticore}.
16834 @item -msdram
16835 @opindex msdram
16836 Build a standalone application for SDRAM. Proper start files and
16837 link scripts are used to put the application into SDRAM, and the macro
16838 @code{__BFIN_SDRAM} is defined.
16839 The loader should initialize SDRAM before loading the application.
16841 @item -micplb
16842 @opindex micplb
16843 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16844 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16845 are enabled; for standalone applications the default is off.
16846 @end table
16848 @node C6X Options
16849 @subsection C6X Options
16850 @cindex C6X Options
16852 @table @gcctabopt
16853 @item -march=@var{name}
16854 @opindex march
16855 This specifies the name of the target architecture.  GCC uses this
16856 name to determine what kind of instructions it can emit when generating
16857 assembly code.  Permissible names are: @samp{c62x},
16858 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16860 @item -mbig-endian
16861 @opindex mbig-endian
16862 Generate code for a big-endian target.
16864 @item -mlittle-endian
16865 @opindex mlittle-endian
16866 Generate code for a little-endian target.  This is the default.
16868 @item -msim
16869 @opindex msim
16870 Choose startup files and linker script suitable for the simulator.
16872 @item -msdata=default
16873 @opindex msdata=default
16874 Put small global and static data in the @code{.neardata} section,
16875 which is pointed to by register @code{B14}.  Put small uninitialized
16876 global and static data in the @code{.bss} section, which is adjacent
16877 to the @code{.neardata} section.  Put small read-only data into the
16878 @code{.rodata} section.  The corresponding sections used for large
16879 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16881 @item -msdata=all
16882 @opindex msdata=all
16883 Put all data, not just small objects, into the sections reserved for
16884 small data, and use addressing relative to the @code{B14} register to
16885 access them.
16887 @item -msdata=none
16888 @opindex msdata=none
16889 Make no use of the sections reserved for small data, and use absolute
16890 addresses to access all data.  Put all initialized global and static
16891 data in the @code{.fardata} section, and all uninitialized data in the
16892 @code{.far} section.  Put all constant data into the @code{.const}
16893 section.
16894 @end table
16896 @node CRIS Options
16897 @subsection CRIS Options
16898 @cindex CRIS Options
16900 These options are defined specifically for the CRIS ports.
16902 @table @gcctabopt
16903 @item -march=@var{architecture-type}
16904 @itemx -mcpu=@var{architecture-type}
16905 @opindex march
16906 @opindex mcpu
16907 Generate code for the specified architecture.  The choices for
16908 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16909 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16910 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16911 @samp{v10}.
16913 @item -mtune=@var{architecture-type}
16914 @opindex mtune
16915 Tune to @var{architecture-type} everything applicable about the generated
16916 code, except for the ABI and the set of available instructions.  The
16917 choices for @var{architecture-type} are the same as for
16918 @option{-march=@var{architecture-type}}.
16920 @item -mmax-stack-frame=@var{n}
16921 @opindex mmax-stack-frame
16922 Warn when the stack frame of a function exceeds @var{n} bytes.
16924 @item -metrax4
16925 @itemx -metrax100
16926 @opindex metrax4
16927 @opindex metrax100
16928 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16929 @option{-march=v3} and @option{-march=v8} respectively.
16931 @item -mmul-bug-workaround
16932 @itemx -mno-mul-bug-workaround
16933 @opindex mmul-bug-workaround
16934 @opindex mno-mul-bug-workaround
16935 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16936 models where it applies.  This option is active by default.
16938 @item -mpdebug
16939 @opindex mpdebug
16940 Enable CRIS-specific verbose debug-related information in the assembly
16941 code.  This option also has the effect of turning off the @samp{#NO_APP}
16942 formatted-code indicator to the assembler at the beginning of the
16943 assembly file.
16945 @item -mcc-init
16946 @opindex mcc-init
16947 Do not use condition-code results from previous instruction; always emit
16948 compare and test instructions before use of condition codes.
16950 @item -mno-side-effects
16951 @opindex mno-side-effects
16952 Do not emit instructions with side effects in addressing modes other than
16953 post-increment.
16955 @item -mstack-align
16956 @itemx -mno-stack-align
16957 @itemx -mdata-align
16958 @itemx -mno-data-align
16959 @itemx -mconst-align
16960 @itemx -mno-const-align
16961 @opindex mstack-align
16962 @opindex mno-stack-align
16963 @opindex mdata-align
16964 @opindex mno-data-align
16965 @opindex mconst-align
16966 @opindex mno-const-align
16967 These options (@samp{no-} options) arrange (eliminate arrangements) for the
16968 stack frame, individual data and constants to be aligned for the maximum
16969 single data access size for the chosen CPU model.  The default is to
16970 arrange for 32-bit alignment.  ABI details such as structure layout are
16971 not affected by these options.
16973 @item -m32-bit
16974 @itemx -m16-bit
16975 @itemx -m8-bit
16976 @opindex m32-bit
16977 @opindex m16-bit
16978 @opindex m8-bit
16979 Similar to the stack- data- and const-align options above, these options
16980 arrange for stack frame, writable data and constants to all be 32-bit,
16981 16-bit or 8-bit aligned.  The default is 32-bit alignment.
16983 @item -mno-prologue-epilogue
16984 @itemx -mprologue-epilogue
16985 @opindex mno-prologue-epilogue
16986 @opindex mprologue-epilogue
16987 With @option{-mno-prologue-epilogue}, the normal function prologue and
16988 epilogue which set up the stack frame are omitted and no return
16989 instructions or return sequences are generated in the code.  Use this
16990 option only together with visual inspection of the compiled code: no
16991 warnings or errors are generated when call-saved registers must be saved,
16992 or storage for local variables needs to be allocated.
16994 @item -mno-gotplt
16995 @itemx -mgotplt
16996 @opindex mno-gotplt
16997 @opindex mgotplt
16998 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
16999 instruction sequences that load addresses for functions from the PLT part
17000 of the GOT rather than (traditional on other architectures) calls to the
17001 PLT@.  The default is @option{-mgotplt}.
17003 @item -melf
17004 @opindex melf
17005 Legacy no-op option only recognized with the cris-axis-elf and
17006 cris-axis-linux-gnu targets.
17008 @item -mlinux
17009 @opindex mlinux
17010 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17012 @item -sim
17013 @opindex sim
17014 This option, recognized for the cris-axis-elf, arranges
17015 to link with input-output functions from a simulator library.  Code,
17016 initialized data and zero-initialized data are allocated consecutively.
17018 @item -sim2
17019 @opindex sim2
17020 Like @option{-sim}, but pass linker options to locate initialized data at
17021 0x40000000 and zero-initialized data at 0x80000000.
17022 @end table
17024 @node CR16 Options
17025 @subsection CR16 Options
17026 @cindex CR16 Options
17028 These options are defined specifically for the CR16 ports.
17030 @table @gcctabopt
17032 @item -mmac
17033 @opindex mmac
17034 Enable the use of multiply-accumulate instructions. Disabled by default.
17036 @item -mcr16cplus
17037 @itemx -mcr16c
17038 @opindex mcr16cplus
17039 @opindex mcr16c
17040 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17041 is default.
17043 @item -msim
17044 @opindex msim
17045 Links the library libsim.a which is in compatible with simulator. Applicable
17046 to ELF compiler only.
17048 @item -mint32
17049 @opindex mint32
17050 Choose integer type as 32-bit wide.
17052 @item -mbit-ops
17053 @opindex mbit-ops
17054 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17056 @item -mdata-model=@var{model}
17057 @opindex mdata-model
17058 Choose a data model. The choices for @var{model} are @samp{near},
17059 @samp{far} or @samp{medium}. @samp{medium} is default.
17060 However, @samp{far} is not valid with @option{-mcr16c}, as the
17061 CR16C architecture does not support the far data model.
17062 @end table
17064 @node Darwin Options
17065 @subsection Darwin Options
17066 @cindex Darwin options
17068 These options are defined for all architectures running the Darwin operating
17069 system.
17071 FSF GCC on Darwin does not create ``fat'' object files; it creates
17072 an object file for the single architecture that GCC was built to
17073 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17074 @option{-arch} options are used; it does so by running the compiler or
17075 linker multiple times and joining the results together with
17076 @file{lipo}.
17078 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17079 @samp{i686}) is determined by the flags that specify the ISA
17080 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17081 @option{-force_cpusubtype_ALL} option can be used to override this.
17083 The Darwin tools vary in their behavior when presented with an ISA
17084 mismatch.  The assembler, @file{as}, only permits instructions to
17085 be used that are valid for the subtype of the file it is generating,
17086 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17087 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17088 and prints an error if asked to create a shared library with a less
17089 restrictive subtype than its input files (for instance, trying to put
17090 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17091 for executables, @command{ld}, quietly gives the executable the most
17092 restrictive subtype of any of its input files.
17094 @table @gcctabopt
17095 @item -F@var{dir}
17096 @opindex F
17097 Add the framework directory @var{dir} to the head of the list of
17098 directories to be searched for header files.  These directories are
17099 interleaved with those specified by @option{-I} options and are
17100 scanned in a left-to-right order.
17102 A framework directory is a directory with frameworks in it.  A
17103 framework is a directory with a @file{Headers} and/or
17104 @file{PrivateHeaders} directory contained directly in it that ends
17105 in @file{.framework}.  The name of a framework is the name of this
17106 directory excluding the @file{.framework}.  Headers associated with
17107 the framework are found in one of those two directories, with
17108 @file{Headers} being searched first.  A subframework is a framework
17109 directory that is in a framework's @file{Frameworks} directory.
17110 Includes of subframework headers can only appear in a header of a
17111 framework that contains the subframework, or in a sibling subframework
17112 header.  Two subframeworks are siblings if they occur in the same
17113 framework.  A subframework should not have the same name as a
17114 framework; a warning is issued if this is violated.  Currently a
17115 subframework cannot have subframeworks; in the future, the mechanism
17116 may be extended to support this.  The standard frameworks can be found
17117 in @file{/System/Library/Frameworks} and
17118 @file{/Library/Frameworks}.  An example include looks like
17119 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17120 the name of the framework and @file{header.h} is found in the
17121 @file{PrivateHeaders} or @file{Headers} directory.
17123 @item -iframework@var{dir}
17124 @opindex iframework
17125 Like @option{-F} except the directory is a treated as a system
17126 directory.  The main difference between this @option{-iframework} and
17127 @option{-F} is that with @option{-iframework} the compiler does not
17128 warn about constructs contained within header files found via
17129 @var{dir}.  This option is valid only for the C family of languages.
17131 @item -gused
17132 @opindex gused
17133 Emit debugging information for symbols that are used.  For stabs
17134 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17135 This is by default ON@.
17137 @item -gfull
17138 @opindex gfull
17139 Emit debugging information for all symbols and types.
17141 @item -mmacosx-version-min=@var{version}
17142 The earliest version of MacOS X that this executable will run on
17143 is @var{version}.  Typical values of @var{version} include @code{10.1},
17144 @code{10.2}, and @code{10.3.9}.
17146 If the compiler was built to use the system's headers by default,
17147 then the default for this option is the system version on which the
17148 compiler is running, otherwise the default is to make choices that
17149 are compatible with as many systems and code bases as possible.
17151 @item -mkernel
17152 @opindex mkernel
17153 Enable kernel development mode.  The @option{-mkernel} option sets
17154 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17155 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17156 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17157 applicable.  This mode also sets @option{-mno-altivec},
17158 @option{-msoft-float}, @option{-fno-builtin} and
17159 @option{-mlong-branch} for PowerPC targets.
17161 @item -mone-byte-bool
17162 @opindex mone-byte-bool
17163 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17164 By default @code{sizeof(bool)} is @code{4} when compiling for
17165 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17166 option has no effect on x86.
17168 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17169 to generate code that is not binary compatible with code generated
17170 without that switch.  Using this switch may require recompiling all
17171 other modules in a program, including system libraries.  Use this
17172 switch to conform to a non-default data model.
17174 @item -mfix-and-continue
17175 @itemx -ffix-and-continue
17176 @itemx -findirect-data
17177 @opindex mfix-and-continue
17178 @opindex ffix-and-continue
17179 @opindex findirect-data
17180 Generate code suitable for fast turnaround development, such as to
17181 allow GDB to dynamically load @file{.o} files into already-running
17182 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17183 are provided for backwards compatibility.
17185 @item -all_load
17186 @opindex all_load
17187 Loads all members of static archive libraries.
17188 See man ld(1) for more information.
17190 @item -arch_errors_fatal
17191 @opindex arch_errors_fatal
17192 Cause the errors having to do with files that have the wrong architecture
17193 to be fatal.
17195 @item -bind_at_load
17196 @opindex bind_at_load
17197 Causes the output file to be marked such that the dynamic linker will
17198 bind all undefined references when the file is loaded or launched.
17200 @item -bundle
17201 @opindex bundle
17202 Produce a Mach-o bundle format file.
17203 See man ld(1) for more information.
17205 @item -bundle_loader @var{executable}
17206 @opindex bundle_loader
17207 This option specifies the @var{executable} that will load the build
17208 output file being linked.  See man ld(1) for more information.
17210 @item -dynamiclib
17211 @opindex dynamiclib
17212 When passed this option, GCC produces a dynamic library instead of
17213 an executable when linking, using the Darwin @file{libtool} command.
17215 @item -force_cpusubtype_ALL
17216 @opindex force_cpusubtype_ALL
17217 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17218 one controlled by the @option{-mcpu} or @option{-march} option.
17220 @item -allowable_client  @var{client_name}
17221 @itemx -client_name
17222 @itemx -compatibility_version
17223 @itemx -current_version
17224 @itemx -dead_strip
17225 @itemx -dependency-file
17226 @itemx -dylib_file
17227 @itemx -dylinker_install_name
17228 @itemx -dynamic
17229 @itemx -exported_symbols_list
17230 @itemx -filelist
17231 @need 800
17232 @itemx -flat_namespace
17233 @itemx -force_flat_namespace
17234 @itemx -headerpad_max_install_names
17235 @itemx -image_base
17236 @itemx -init
17237 @itemx -install_name
17238 @itemx -keep_private_externs
17239 @itemx -multi_module
17240 @itemx -multiply_defined
17241 @itemx -multiply_defined_unused
17242 @need 800
17243 @itemx -noall_load
17244 @itemx -no_dead_strip_inits_and_terms
17245 @itemx -nofixprebinding
17246 @itemx -nomultidefs
17247 @itemx -noprebind
17248 @itemx -noseglinkedit
17249 @itemx -pagezero_size
17250 @itemx -prebind
17251 @itemx -prebind_all_twolevel_modules
17252 @itemx -private_bundle
17253 @need 800
17254 @itemx -read_only_relocs
17255 @itemx -sectalign
17256 @itemx -sectobjectsymbols
17257 @itemx -whyload
17258 @itemx -seg1addr
17259 @itemx -sectcreate
17260 @itemx -sectobjectsymbols
17261 @itemx -sectorder
17262 @itemx -segaddr
17263 @itemx -segs_read_only_addr
17264 @need 800
17265 @itemx -segs_read_write_addr
17266 @itemx -seg_addr_table
17267 @itemx -seg_addr_table_filename
17268 @itemx -seglinkedit
17269 @itemx -segprot
17270 @itemx -segs_read_only_addr
17271 @itemx -segs_read_write_addr
17272 @itemx -single_module
17273 @itemx -static
17274 @itemx -sub_library
17275 @need 800
17276 @itemx -sub_umbrella
17277 @itemx -twolevel_namespace
17278 @itemx -umbrella
17279 @itemx -undefined
17280 @itemx -unexported_symbols_list
17281 @itemx -weak_reference_mismatches
17282 @itemx -whatsloaded
17283 @opindex allowable_client
17284 @opindex client_name
17285 @opindex compatibility_version
17286 @opindex current_version
17287 @opindex dead_strip
17288 @opindex dependency-file
17289 @opindex dylib_file
17290 @opindex dylinker_install_name
17291 @opindex dynamic
17292 @opindex exported_symbols_list
17293 @opindex filelist
17294 @opindex flat_namespace
17295 @opindex force_flat_namespace
17296 @opindex headerpad_max_install_names
17297 @opindex image_base
17298 @opindex init
17299 @opindex install_name
17300 @opindex keep_private_externs
17301 @opindex multi_module
17302 @opindex multiply_defined
17303 @opindex multiply_defined_unused
17304 @opindex noall_load
17305 @opindex no_dead_strip_inits_and_terms
17306 @opindex nofixprebinding
17307 @opindex nomultidefs
17308 @opindex noprebind
17309 @opindex noseglinkedit
17310 @opindex pagezero_size
17311 @opindex prebind
17312 @opindex prebind_all_twolevel_modules
17313 @opindex private_bundle
17314 @opindex read_only_relocs
17315 @opindex sectalign
17316 @opindex sectobjectsymbols
17317 @opindex whyload
17318 @opindex seg1addr
17319 @opindex sectcreate
17320 @opindex sectobjectsymbols
17321 @opindex sectorder
17322 @opindex segaddr
17323 @opindex segs_read_only_addr
17324 @opindex segs_read_write_addr
17325 @opindex seg_addr_table
17326 @opindex seg_addr_table_filename
17327 @opindex seglinkedit
17328 @opindex segprot
17329 @opindex segs_read_only_addr
17330 @opindex segs_read_write_addr
17331 @opindex single_module
17332 @opindex static
17333 @opindex sub_library
17334 @opindex sub_umbrella
17335 @opindex twolevel_namespace
17336 @opindex umbrella
17337 @opindex undefined
17338 @opindex unexported_symbols_list
17339 @opindex weak_reference_mismatches
17340 @opindex whatsloaded
17341 These options are passed to the Darwin linker.  The Darwin linker man page
17342 describes them in detail.
17343 @end table
17345 @node DEC Alpha Options
17346 @subsection DEC Alpha Options
17348 These @samp{-m} options are defined for the DEC Alpha implementations:
17350 @table @gcctabopt
17351 @item -mno-soft-float
17352 @itemx -msoft-float
17353 @opindex mno-soft-float
17354 @opindex msoft-float
17355 Use (do not use) the hardware floating-point instructions for
17356 floating-point operations.  When @option{-msoft-float} is specified,
17357 functions in @file{libgcc.a} are used to perform floating-point
17358 operations.  Unless they are replaced by routines that emulate the
17359 floating-point operations, or compiled in such a way as to call such
17360 emulations routines, these routines issue floating-point
17361 operations.   If you are compiling for an Alpha without floating-point
17362 operations, you must ensure that the library is built so as not to call
17363 them.
17365 Note that Alpha implementations without floating-point operations are
17366 required to have floating-point registers.
17368 @item -mfp-reg
17369 @itemx -mno-fp-regs
17370 @opindex mfp-reg
17371 @opindex mno-fp-regs
17372 Generate code that uses (does not use) the floating-point register set.
17373 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17374 register set is not used, floating-point operands are passed in integer
17375 registers as if they were integers and floating-point results are passed
17376 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17377 so any function with a floating-point argument or return value called by code
17378 compiled with @option{-mno-fp-regs} must also be compiled with that
17379 option.
17381 A typical use of this option is building a kernel that does not use,
17382 and hence need not save and restore, any floating-point registers.
17384 @item -mieee
17385 @opindex mieee
17386 The Alpha architecture implements floating-point hardware optimized for
17387 maximum performance.  It is mostly compliant with the IEEE floating-point
17388 standard.  However, for full compliance, software assistance is
17389 required.  This option generates code fully IEEE-compliant code
17390 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17391 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17392 defined during compilation.  The resulting code is less efficient but is
17393 able to correctly support denormalized numbers and exceptional IEEE
17394 values such as not-a-number and plus/minus infinity.  Other Alpha
17395 compilers call this option @option{-ieee_with_no_inexact}.
17397 @item -mieee-with-inexact
17398 @opindex mieee-with-inexact
17399 This is like @option{-mieee} except the generated code also maintains
17400 the IEEE @var{inexact-flag}.  Turning on this option causes the
17401 generated code to implement fully-compliant IEEE math.  In addition to
17402 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17403 macro.  On some Alpha implementations the resulting code may execute
17404 significantly slower than the code generated by default.  Since there is
17405 very little code that depends on the @var{inexact-flag}, you should
17406 normally not specify this option.  Other Alpha compilers call this
17407 option @option{-ieee_with_inexact}.
17409 @item -mfp-trap-mode=@var{trap-mode}
17410 @opindex mfp-trap-mode
17411 This option controls what floating-point related traps are enabled.
17412 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17413 The trap mode can be set to one of four values:
17415 @table @samp
17416 @item n
17417 This is the default (normal) setting.  The only traps that are enabled
17418 are the ones that cannot be disabled in software (e.g., division by zero
17419 trap).
17421 @item u
17422 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17423 as well.
17425 @item su
17426 Like @samp{u}, but the instructions are marked to be safe for software
17427 completion (see Alpha architecture manual for details).
17429 @item sui
17430 Like @samp{su}, but inexact traps are enabled as well.
17431 @end table
17433 @item -mfp-rounding-mode=@var{rounding-mode}
17434 @opindex mfp-rounding-mode
17435 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17436 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17439 @table @samp
17440 @item n
17441 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17442 the nearest machine number or towards the even machine number in case
17443 of a tie.
17445 @item m
17446 Round towards minus infinity.
17448 @item c
17449 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17451 @item d
17452 Dynamic rounding mode.  A field in the floating-point control register
17453 (@var{fpcr}, see Alpha architecture reference manual) controls the
17454 rounding mode in effect.  The C library initializes this register for
17455 rounding towards plus infinity.  Thus, unless your program modifies the
17456 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17457 @end table
17459 @item -mtrap-precision=@var{trap-precision}
17460 @opindex mtrap-precision
17461 In the Alpha architecture, floating-point traps are imprecise.  This
17462 means without software assistance it is impossible to recover from a
17463 floating trap and program execution normally needs to be terminated.
17464 GCC can generate code that can assist operating system trap handlers
17465 in determining the exact location that caused a floating-point trap.
17466 Depending on the requirements of an application, different levels of
17467 precisions can be selected:
17469 @table @samp
17470 @item p
17471 Program precision.  This option is the default and means a trap handler
17472 can only identify which program caused a floating-point exception.
17474 @item f
17475 Function precision.  The trap handler can determine the function that
17476 caused a floating-point exception.
17478 @item i
17479 Instruction precision.  The trap handler can determine the exact
17480 instruction that caused a floating-point exception.
17481 @end table
17483 Other Alpha compilers provide the equivalent options called
17484 @option{-scope_safe} and @option{-resumption_safe}.
17486 @item -mieee-conformant
17487 @opindex mieee-conformant
17488 This option marks the generated code as IEEE conformant.  You must not
17489 use this option unless you also specify @option{-mtrap-precision=i} and either
17490 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17491 is to emit the line @samp{.eflag 48} in the function prologue of the
17492 generated assembly file.
17494 @item -mbuild-constants
17495 @opindex mbuild-constants
17496 Normally GCC examines a 32- or 64-bit integer constant to
17497 see if it can construct it from smaller constants in two or three
17498 instructions.  If it cannot, it outputs the constant as a literal and
17499 generates code to load it from the data segment at run time.
17501 Use this option to require GCC to construct @emph{all} integer constants
17502 using code, even if it takes more instructions (the maximum is six).
17504 You typically use this option to build a shared library dynamic
17505 loader.  Itself a shared library, it must relocate itself in memory
17506 before it can find the variables and constants in its own data segment.
17508 @item -mbwx
17509 @itemx -mno-bwx
17510 @itemx -mcix
17511 @itemx -mno-cix
17512 @itemx -mfix
17513 @itemx -mno-fix
17514 @itemx -mmax
17515 @itemx -mno-max
17516 @opindex mbwx
17517 @opindex mno-bwx
17518 @opindex mcix
17519 @opindex mno-cix
17520 @opindex mfix
17521 @opindex mno-fix
17522 @opindex mmax
17523 @opindex mno-max
17524 Indicate whether GCC should generate code to use the optional BWX,
17525 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17526 sets supported by the CPU type specified via @option{-mcpu=} option or that
17527 of the CPU on which GCC was built if none is specified.
17529 @item -mfloat-vax
17530 @itemx -mfloat-ieee
17531 @opindex mfloat-vax
17532 @opindex mfloat-ieee
17533 Generate code that uses (does not use) VAX F and G floating-point
17534 arithmetic instead of IEEE single and double precision.
17536 @item -mexplicit-relocs
17537 @itemx -mno-explicit-relocs
17538 @opindex mexplicit-relocs
17539 @opindex mno-explicit-relocs
17540 Older Alpha assemblers provided no way to generate symbol relocations
17541 except via assembler macros.  Use of these macros does not allow
17542 optimal instruction scheduling.  GNU binutils as of version 2.12
17543 supports a new syntax that allows the compiler to explicitly mark
17544 which relocations should apply to which instructions.  This option
17545 is mostly useful for debugging, as GCC detects the capabilities of
17546 the assembler when it is built and sets the default accordingly.
17548 @item -msmall-data
17549 @itemx -mlarge-data
17550 @opindex msmall-data
17551 @opindex mlarge-data
17552 When @option{-mexplicit-relocs} is in effect, static data is
17553 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17554 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17555 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17556 16-bit relocations off of the @code{$gp} register.  This limits the
17557 size of the small data area to 64KB, but allows the variables to be
17558 directly accessed via a single instruction.
17560 The default is @option{-mlarge-data}.  With this option the data area
17561 is limited to just below 2GB@.  Programs that require more than 2GB of
17562 data must use @code{malloc} or @code{mmap} to allocate the data in the
17563 heap instead of in the program's data segment.
17565 When generating code for shared libraries, @option{-fpic} implies
17566 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17568 @item -msmall-text
17569 @itemx -mlarge-text
17570 @opindex msmall-text
17571 @opindex mlarge-text
17572 When @option{-msmall-text} is used, the compiler assumes that the
17573 code of the entire program (or shared library) fits in 4MB, and is
17574 thus reachable with a branch instruction.  When @option{-msmall-data}
17575 is used, the compiler can assume that all local symbols share the
17576 same @code{$gp} value, and thus reduce the number of instructions
17577 required for a function call from 4 to 1.
17579 The default is @option{-mlarge-text}.
17581 @item -mcpu=@var{cpu_type}
17582 @opindex mcpu
17583 Set the instruction set and instruction scheduling parameters for
17584 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17585 style name or the corresponding chip number.  GCC supports scheduling
17586 parameters for the EV4, EV5 and EV6 family of processors and
17587 chooses the default values for the instruction set from the processor
17588 you specify.  If you do not specify a processor type, GCC defaults
17589 to the processor on which the compiler was built.
17591 Supported values for @var{cpu_type} are
17593 @table @samp
17594 @item ev4
17595 @itemx ev45
17596 @itemx 21064
17597 Schedules as an EV4 and has no instruction set extensions.
17599 @item ev5
17600 @itemx 21164
17601 Schedules as an EV5 and has no instruction set extensions.
17603 @item ev56
17604 @itemx 21164a
17605 Schedules as an EV5 and supports the BWX extension.
17607 @item pca56
17608 @itemx 21164pc
17609 @itemx 21164PC
17610 Schedules as an EV5 and supports the BWX and MAX extensions.
17612 @item ev6
17613 @itemx 21264
17614 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17616 @item ev67
17617 @itemx 21264a
17618 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17619 @end table
17621 Native toolchains also support the value @samp{native},
17622 which selects the best architecture option for the host processor.
17623 @option{-mcpu=native} has no effect if GCC does not recognize
17624 the processor.
17626 @item -mtune=@var{cpu_type}
17627 @opindex mtune
17628 Set only the instruction scheduling parameters for machine type
17629 @var{cpu_type}.  The instruction set is not changed.
17631 Native toolchains also support the value @samp{native},
17632 which selects the best architecture option for the host processor.
17633 @option{-mtune=native} has no effect if GCC does not recognize
17634 the processor.
17636 @item -mmemory-latency=@var{time}
17637 @opindex mmemory-latency
17638 Sets the latency the scheduler should assume for typical memory
17639 references as seen by the application.  This number is highly
17640 dependent on the memory access patterns used by the application
17641 and the size of the external cache on the machine.
17643 Valid options for @var{time} are
17645 @table @samp
17646 @item @var{number}
17647 A decimal number representing clock cycles.
17649 @item L1
17650 @itemx L2
17651 @itemx L3
17652 @itemx main
17653 The compiler contains estimates of the number of clock cycles for
17654 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17655 (also called Dcache, Scache, and Bcache), as well as to main memory.
17656 Note that L3 is only valid for EV5.
17658 @end table
17659 @end table
17661 @node FR30 Options
17662 @subsection FR30 Options
17663 @cindex FR30 Options
17665 These options are defined specifically for the FR30 port.
17667 @table @gcctabopt
17669 @item -msmall-model
17670 @opindex msmall-model
17671 Use the small address space model.  This can produce smaller code, but
17672 it does assume that all symbolic values and addresses fit into a
17673 20-bit range.
17675 @item -mno-lsim
17676 @opindex mno-lsim
17677 Assume that runtime support has been provided and so there is no need
17678 to include the simulator library (@file{libsim.a}) on the linker
17679 command line.
17681 @end table
17683 @node FT32 Options
17684 @subsection FT32 Options
17685 @cindex FT32 Options
17687 These options are defined specifically for the FT32 port.
17689 @table @gcctabopt
17691 @item -msim
17692 @opindex msim
17693 Specifies that the program will be run on the simulator.  This causes
17694 an alternate runtime startup and library to be linked.
17695 You must not use this option when generating programs that will run on
17696 real hardware; you must provide your own runtime library for whatever
17697 I/O functions are needed.
17699 @item -mlra
17700 @opindex mlra
17701 Enable Local Register Allocation.  This is still experimental for FT32,
17702 so by default the compiler uses standard reload.
17704 @item -mnodiv
17705 @opindex mnodiv
17706 Do not use div and mod instructions.
17708 @end table
17710 @node FRV Options
17711 @subsection FRV Options
17712 @cindex FRV Options
17714 @table @gcctabopt
17715 @item -mgpr-32
17716 @opindex mgpr-32
17718 Only use the first 32 general-purpose registers.
17720 @item -mgpr-64
17721 @opindex mgpr-64
17723 Use all 64 general-purpose registers.
17725 @item -mfpr-32
17726 @opindex mfpr-32
17728 Use only the first 32 floating-point registers.
17730 @item -mfpr-64
17731 @opindex mfpr-64
17733 Use all 64 floating-point registers.
17735 @item -mhard-float
17736 @opindex mhard-float
17738 Use hardware instructions for floating-point operations.
17740 @item -msoft-float
17741 @opindex msoft-float
17743 Use library routines for floating-point operations.
17745 @item -malloc-cc
17746 @opindex malloc-cc
17748 Dynamically allocate condition code registers.
17750 @item -mfixed-cc
17751 @opindex mfixed-cc
17753 Do not try to dynamically allocate condition code registers, only
17754 use @code{icc0} and @code{fcc0}.
17756 @item -mdword
17757 @opindex mdword
17759 Change ABI to use double word insns.
17761 @item -mno-dword
17762 @opindex mno-dword
17764 Do not use double word instructions.
17766 @item -mdouble
17767 @opindex mdouble
17769 Use floating-point double instructions.
17771 @item -mno-double
17772 @opindex mno-double
17774 Do not use floating-point double instructions.
17776 @item -mmedia
17777 @opindex mmedia
17779 Use media instructions.
17781 @item -mno-media
17782 @opindex mno-media
17784 Do not use media instructions.
17786 @item -mmuladd
17787 @opindex mmuladd
17789 Use multiply and add/subtract instructions.
17791 @item -mno-muladd
17792 @opindex mno-muladd
17794 Do not use multiply and add/subtract instructions.
17796 @item -mfdpic
17797 @opindex mfdpic
17799 Select the FDPIC ABI, which uses function descriptors to represent
17800 pointers to functions.  Without any PIC/PIE-related options, it
17801 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17802 assumes GOT entries and small data are within a 12-bit range from the
17803 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17804 are computed with 32 bits.
17805 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17807 @item -minline-plt
17808 @opindex minline-plt
17810 Enable inlining of PLT entries in function calls to functions that are
17811 not known to bind locally.  It has no effect without @option{-mfdpic}.
17812 It's enabled by default if optimizing for speed and compiling for
17813 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17814 optimization option such as @option{-O3} or above is present in the
17815 command line.
17817 @item -mTLS
17818 @opindex mTLS
17820 Assume a large TLS segment when generating thread-local code.
17822 @item -mtls
17823 @opindex mtls
17825 Do not assume a large TLS segment when generating thread-local code.
17827 @item -mgprel-ro
17828 @opindex mgprel-ro
17830 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17831 that is known to be in read-only sections.  It's enabled by default,
17832 except for @option{-fpic} or @option{-fpie}: even though it may help
17833 make the global offset table smaller, it trades 1 instruction for 4.
17834 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17835 one of which may be shared by multiple symbols, and it avoids the need
17836 for a GOT entry for the referenced symbol, so it's more likely to be a
17837 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17839 @item -multilib-library-pic
17840 @opindex multilib-library-pic
17842 Link with the (library, not FD) pic libraries.  It's implied by
17843 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17844 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17845 it explicitly.
17847 @item -mlinked-fp
17848 @opindex mlinked-fp
17850 Follow the EABI requirement of always creating a frame pointer whenever
17851 a stack frame is allocated.  This option is enabled by default and can
17852 be disabled with @option{-mno-linked-fp}.
17854 @item -mlong-calls
17855 @opindex mlong-calls
17857 Use indirect addressing to call functions outside the current
17858 compilation unit.  This allows the functions to be placed anywhere
17859 within the 32-bit address space.
17861 @item -malign-labels
17862 @opindex malign-labels
17864 Try to align labels to an 8-byte boundary by inserting NOPs into the
17865 previous packet.  This option only has an effect when VLIW packing
17866 is enabled.  It doesn't create new packets; it merely adds NOPs to
17867 existing ones.
17869 @item -mlibrary-pic
17870 @opindex mlibrary-pic
17872 Generate position-independent EABI code.
17874 @item -macc-4
17875 @opindex macc-4
17877 Use only the first four media accumulator registers.
17879 @item -macc-8
17880 @opindex macc-8
17882 Use all eight media accumulator registers.
17884 @item -mpack
17885 @opindex mpack
17887 Pack VLIW instructions.
17889 @item -mno-pack
17890 @opindex mno-pack
17892 Do not pack VLIW instructions.
17894 @item -mno-eflags
17895 @opindex mno-eflags
17897 Do not mark ABI switches in e_flags.
17899 @item -mcond-move
17900 @opindex mcond-move
17902 Enable the use of conditional-move instructions (default).
17904 This switch is mainly for debugging the compiler and will likely be removed
17905 in a future version.
17907 @item -mno-cond-move
17908 @opindex mno-cond-move
17910 Disable the use of conditional-move instructions.
17912 This switch is mainly for debugging the compiler and will likely be removed
17913 in a future version.
17915 @item -mscc
17916 @opindex mscc
17918 Enable the use of conditional set instructions (default).
17920 This switch is mainly for debugging the compiler and will likely be removed
17921 in a future version.
17923 @item -mno-scc
17924 @opindex mno-scc
17926 Disable the use of conditional set instructions.
17928 This switch is mainly for debugging the compiler and will likely be removed
17929 in a future version.
17931 @item -mcond-exec
17932 @opindex mcond-exec
17934 Enable the use of conditional execution (default).
17936 This switch is mainly for debugging the compiler and will likely be removed
17937 in a future version.
17939 @item -mno-cond-exec
17940 @opindex mno-cond-exec
17942 Disable the use of conditional execution.
17944 This switch is mainly for debugging the compiler and will likely be removed
17945 in a future version.
17947 @item -mvliw-branch
17948 @opindex mvliw-branch
17950 Run a pass to pack branches into VLIW instructions (default).
17952 This switch is mainly for debugging the compiler and will likely be removed
17953 in a future version.
17955 @item -mno-vliw-branch
17956 @opindex mno-vliw-branch
17958 Do not run a pass to pack branches into VLIW instructions.
17960 This switch is mainly for debugging the compiler and will likely be removed
17961 in a future version.
17963 @item -mmulti-cond-exec
17964 @opindex mmulti-cond-exec
17966 Enable optimization of @code{&&} and @code{||} in conditional execution
17967 (default).
17969 This switch is mainly for debugging the compiler and will likely be removed
17970 in a future version.
17972 @item -mno-multi-cond-exec
17973 @opindex mno-multi-cond-exec
17975 Disable optimization of @code{&&} and @code{||} in conditional execution.
17977 This switch is mainly for debugging the compiler and will likely be removed
17978 in a future version.
17980 @item -mnested-cond-exec
17981 @opindex mnested-cond-exec
17983 Enable nested conditional execution optimizations (default).
17985 This switch is mainly for debugging the compiler and will likely be removed
17986 in a future version.
17988 @item -mno-nested-cond-exec
17989 @opindex mno-nested-cond-exec
17991 Disable nested conditional execution optimizations.
17993 This switch is mainly for debugging the compiler and will likely be removed
17994 in a future version.
17996 @item -moptimize-membar
17997 @opindex moptimize-membar
17999 This switch removes redundant @code{membar} instructions from the
18000 compiler-generated code.  It is enabled by default.
18002 @item -mno-optimize-membar
18003 @opindex mno-optimize-membar
18005 This switch disables the automatic removal of redundant @code{membar}
18006 instructions from the generated code.
18008 @item -mtomcat-stats
18009 @opindex mtomcat-stats
18011 Cause gas to print out tomcat statistics.
18013 @item -mcpu=@var{cpu}
18014 @opindex mcpu
18016 Select the processor type for which to generate code.  Possible values are
18017 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18018 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18020 @end table
18022 @node GNU/Linux Options
18023 @subsection GNU/Linux Options
18025 These @samp{-m} options are defined for GNU/Linux targets:
18027 @table @gcctabopt
18028 @item -mglibc
18029 @opindex mglibc
18030 Use the GNU C library.  This is the default except
18031 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18032 @samp{*-*-linux-*android*} targets.
18034 @item -muclibc
18035 @opindex muclibc
18036 Use uClibc C library.  This is the default on
18037 @samp{*-*-linux-*uclibc*} targets.
18039 @item -mmusl
18040 @opindex mmusl
18041 Use the musl C library.  This is the default on
18042 @samp{*-*-linux-*musl*} targets.
18044 @item -mbionic
18045 @opindex mbionic
18046 Use Bionic C library.  This is the default on
18047 @samp{*-*-linux-*android*} targets.
18049 @item -mandroid
18050 @opindex mandroid
18051 Compile code compatible with Android platform.  This is the default on
18052 @samp{*-*-linux-*android*} targets.
18054 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18055 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18056 this option makes the GCC driver pass Android-specific options to the linker.
18057 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18058 to be defined.
18060 @item -tno-android-cc
18061 @opindex tno-android-cc
18062 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18063 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18064 @option{-fno-rtti} by default.
18066 @item -tno-android-ld
18067 @opindex tno-android-ld
18068 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18069 linking options to the linker.
18071 @end table
18073 @node H8/300 Options
18074 @subsection H8/300 Options
18076 These @samp{-m} options are defined for the H8/300 implementations:
18078 @table @gcctabopt
18079 @item -mrelax
18080 @opindex mrelax
18081 Shorten some address references at link time, when possible; uses the
18082 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18083 ld, Using ld}, for a fuller description.
18085 @item -mh
18086 @opindex mh
18087 Generate code for the H8/300H@.
18089 @item -ms
18090 @opindex ms
18091 Generate code for the H8S@.
18093 @item -mn
18094 @opindex mn
18095 Generate code for the H8S and H8/300H in the normal mode.  This switch
18096 must be used either with @option{-mh} or @option{-ms}.
18098 @item -ms2600
18099 @opindex ms2600
18100 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18102 @item -mexr
18103 @opindex mexr
18104 Extended registers are stored on stack before execution of function
18105 with monitor attribute. Default option is @option{-mexr}.
18106 This option is valid only for H8S targets.
18108 @item -mno-exr
18109 @opindex mno-exr
18110 Extended registers are not stored on stack before execution of function 
18111 with monitor attribute. Default option is @option{-mno-exr}. 
18112 This option is valid only for H8S targets.
18114 @item -mint32
18115 @opindex mint32
18116 Make @code{int} data 32 bits by default.
18118 @item -malign-300
18119 @opindex malign-300
18120 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18121 The default for the H8/300H and H8S is to align longs and floats on
18122 4-byte boundaries.
18123 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18124 This option has no effect on the H8/300.
18125 @end table
18127 @node HPPA Options
18128 @subsection HPPA Options
18129 @cindex HPPA Options
18131 These @samp{-m} options are defined for the HPPA family of computers:
18133 @table @gcctabopt
18134 @item -march=@var{architecture-type}
18135 @opindex march
18136 Generate code for the specified architecture.  The choices for
18137 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18138 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18139 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18140 architecture option for your machine.  Code compiled for lower numbered
18141 architectures runs on higher numbered architectures, but not the
18142 other way around.
18144 @item -mpa-risc-1-0
18145 @itemx -mpa-risc-1-1
18146 @itemx -mpa-risc-2-0
18147 @opindex mpa-risc-1-0
18148 @opindex mpa-risc-1-1
18149 @opindex mpa-risc-2-0
18150 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18152 @item -mcaller-copies
18153 @opindex mcaller-copies
18154 The caller copies function arguments passed by hidden reference.  This
18155 option should be used with care as it is not compatible with the default
18156 32-bit runtime.  However, only aggregates larger than eight bytes are
18157 passed by hidden reference and the option provides better compatibility
18158 with OpenMP.
18160 @item -mjump-in-delay
18161 @opindex mjump-in-delay
18162 This option is ignored and provided for compatibility purposes only.
18164 @item -mdisable-fpregs
18165 @opindex mdisable-fpregs
18166 Prevent floating-point registers from being used in any manner.  This is
18167 necessary for compiling kernels that perform lazy context switching of
18168 floating-point registers.  If you use this option and attempt to perform
18169 floating-point operations, the compiler aborts.
18171 @item -mdisable-indexing
18172 @opindex mdisable-indexing
18173 Prevent the compiler from using indexing address modes.  This avoids some
18174 rather obscure problems when compiling MIG generated code under MACH@.
18176 @item -mno-space-regs
18177 @opindex mno-space-regs
18178 Generate code that assumes the target has no space registers.  This allows
18179 GCC to generate faster indirect calls and use unscaled index address modes.
18181 Such code is suitable for level 0 PA systems and kernels.
18183 @item -mfast-indirect-calls
18184 @opindex mfast-indirect-calls
18185 Generate code that assumes calls never cross space boundaries.  This
18186 allows GCC to emit code that performs faster indirect calls.
18188 This option does not work in the presence of shared libraries or nested
18189 functions.
18191 @item -mfixed-range=@var{register-range}
18192 @opindex mfixed-range
18193 Generate code treating the given register range as fixed registers.
18194 A fixed register is one that the register allocator cannot use.  This is
18195 useful when compiling kernel code.  A register range is specified as
18196 two registers separated by a dash.  Multiple register ranges can be
18197 specified separated by a comma.
18199 @item -mlong-load-store
18200 @opindex mlong-load-store
18201 Generate 3-instruction load and store sequences as sometimes required by
18202 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18203 the HP compilers.
18205 @item -mportable-runtime
18206 @opindex mportable-runtime
18207 Use the portable calling conventions proposed by HP for ELF systems.
18209 @item -mgas
18210 @opindex mgas
18211 Enable the use of assembler directives only GAS understands.
18213 @item -mschedule=@var{cpu-type}
18214 @opindex mschedule
18215 Schedule code according to the constraints for the machine type
18216 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18217 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18218 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18219 proper scheduling option for your machine.  The default scheduling is
18220 @samp{8000}.
18222 @item -mlinker-opt
18223 @opindex mlinker-opt
18224 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18225 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18226 linkers in which they give bogus error messages when linking some programs.
18228 @item -msoft-float
18229 @opindex msoft-float
18230 Generate output containing library calls for floating point.
18231 @strong{Warning:} the requisite libraries are not available for all HPPA
18232 targets.  Normally the facilities of the machine's usual C compiler are
18233 used, but this cannot be done directly in cross-compilation.  You must make
18234 your own arrangements to provide suitable library functions for
18235 cross-compilation.
18237 @option{-msoft-float} changes the calling convention in the output file;
18238 therefore, it is only useful if you compile @emph{all} of a program with
18239 this option.  In particular, you need to compile @file{libgcc.a}, the
18240 library that comes with GCC, with @option{-msoft-float} in order for
18241 this to work.
18243 @item -msio
18244 @opindex msio
18245 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18246 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18247 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18248 options are available under HP-UX and HI-UX@.
18250 @item -mgnu-ld
18251 @opindex mgnu-ld
18252 Use options specific to GNU @command{ld}.
18253 This passes @option{-shared} to @command{ld} when
18254 building a shared library.  It is the default when GCC is configured,
18255 explicitly or implicitly, with the GNU linker.  This option does not
18256 affect which @command{ld} is called; it only changes what parameters
18257 are passed to that @command{ld}.
18258 The @command{ld} that is called is determined by the
18259 @option{--with-ld} configure option, GCC's program search path, and
18260 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18261 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18262 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18264 @item -mhp-ld
18265 @opindex mhp-ld
18266 Use options specific to HP @command{ld}.
18267 This passes @option{-b} to @command{ld} when building
18268 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18269 links.  It is the default when GCC is configured, explicitly or
18270 implicitly, with the HP linker.  This option does not affect
18271 which @command{ld} is called; it only changes what parameters are passed to that
18272 @command{ld}.
18273 The @command{ld} that is called is determined by the @option{--with-ld}
18274 configure option, GCC's program search path, and finally by the user's
18275 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18276 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18277 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18279 @item -mlong-calls
18280 @opindex mno-long-calls
18281 Generate code that uses long call sequences.  This ensures that a call
18282 is always able to reach linker generated stubs.  The default is to generate
18283 long calls only when the distance from the call site to the beginning
18284 of the function or translation unit, as the case may be, exceeds a
18285 predefined limit set by the branch type being used.  The limits for
18286 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18287 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18288 240,000 bytes.
18290 Distances are measured from the beginning of functions when using the
18291 @option{-ffunction-sections} option, or when using the @option{-mgas}
18292 and @option{-mno-portable-runtime} options together under HP-UX with
18293 the SOM linker.
18295 It is normally not desirable to use this option as it degrades
18296 performance.  However, it may be useful in large applications,
18297 particularly when partial linking is used to build the application.
18299 The types of long calls used depends on the capabilities of the
18300 assembler and linker, and the type of code being generated.  The
18301 impact on systems that support long absolute calls, and long pic
18302 symbol-difference or pc-relative calls should be relatively small.
18303 However, an indirect call is used on 32-bit ELF systems in pic code
18304 and it is quite long.
18306 @item -munix=@var{unix-std}
18307 @opindex march
18308 Generate compiler predefines and select a startfile for the specified
18309 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18310 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18311 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18312 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18313 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18314 and later.
18316 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18317 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18318 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18319 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18320 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18321 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18323 It is @emph{important} to note that this option changes the interfaces
18324 for various library routines.  It also affects the operational behavior
18325 of the C library.  Thus, @emph{extreme} care is needed in using this
18326 option.
18328 Library code that is intended to operate with more than one UNIX
18329 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18330 as appropriate.  Most GNU software doesn't provide this capability.
18332 @item -nolibdld
18333 @opindex nolibdld
18334 Suppress the generation of link options to search libdld.sl when the
18335 @option{-static} option is specified on HP-UX 10 and later.
18337 @item -static
18338 @opindex static
18339 The HP-UX implementation of setlocale in libc has a dependency on
18340 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18341 when the @option{-static} option is specified, special link options
18342 are needed to resolve this dependency.
18344 On HP-UX 10 and later, the GCC driver adds the necessary options to
18345 link with libdld.sl when the @option{-static} option is specified.
18346 This causes the resulting binary to be dynamic.  On the 64-bit port,
18347 the linkers generate dynamic binaries by default in any case.  The
18348 @option{-nolibdld} option can be used to prevent the GCC driver from
18349 adding these link options.
18351 @item -threads
18352 @opindex threads
18353 Add support for multithreading with the @dfn{dce thread} library
18354 under HP-UX@.  This option sets flags for both the preprocessor and
18355 linker.
18356 @end table
18358 @node IA-64 Options
18359 @subsection IA-64 Options
18360 @cindex IA-64 Options
18362 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18364 @table @gcctabopt
18365 @item -mbig-endian
18366 @opindex mbig-endian
18367 Generate code for a big-endian target.  This is the default for HP-UX@.
18369 @item -mlittle-endian
18370 @opindex mlittle-endian
18371 Generate code for a little-endian target.  This is the default for AIX5
18372 and GNU/Linux.
18374 @item -mgnu-as
18375 @itemx -mno-gnu-as
18376 @opindex mgnu-as
18377 @opindex mno-gnu-as
18378 Generate (or don't) code for the GNU assembler.  This is the default.
18379 @c Also, this is the default if the configure option @option{--with-gnu-as}
18380 @c is used.
18382 @item -mgnu-ld
18383 @itemx -mno-gnu-ld
18384 @opindex mgnu-ld
18385 @opindex mno-gnu-ld
18386 Generate (or don't) code for the GNU linker.  This is the default.
18387 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18388 @c is used.
18390 @item -mno-pic
18391 @opindex mno-pic
18392 Generate code that does not use a global pointer register.  The result
18393 is not position independent code, and violates the IA-64 ABI@.
18395 @item -mvolatile-asm-stop
18396 @itemx -mno-volatile-asm-stop
18397 @opindex mvolatile-asm-stop
18398 @opindex mno-volatile-asm-stop
18399 Generate (or don't) a stop bit immediately before and after volatile asm
18400 statements.
18402 @item -mregister-names
18403 @itemx -mno-register-names
18404 @opindex mregister-names
18405 @opindex mno-register-names
18406 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18407 the stacked registers.  This may make assembler output more readable.
18409 @item -mno-sdata
18410 @itemx -msdata
18411 @opindex mno-sdata
18412 @opindex msdata
18413 Disable (or enable) optimizations that use the small data section.  This may
18414 be useful for working around optimizer bugs.
18416 @item -mconstant-gp
18417 @opindex mconstant-gp
18418 Generate code that uses a single constant global pointer value.  This is
18419 useful when compiling kernel code.
18421 @item -mauto-pic
18422 @opindex mauto-pic
18423 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18424 This is useful when compiling firmware code.
18426 @item -minline-float-divide-min-latency
18427 @opindex minline-float-divide-min-latency
18428 Generate code for inline divides of floating-point values
18429 using the minimum latency algorithm.
18431 @item -minline-float-divide-max-throughput
18432 @opindex minline-float-divide-max-throughput
18433 Generate code for inline divides of floating-point values
18434 using the maximum throughput algorithm.
18436 @item -mno-inline-float-divide
18437 @opindex mno-inline-float-divide
18438 Do not generate inline code for divides of floating-point values.
18440 @item -minline-int-divide-min-latency
18441 @opindex minline-int-divide-min-latency
18442 Generate code for inline divides of integer values
18443 using the minimum latency algorithm.
18445 @item -minline-int-divide-max-throughput
18446 @opindex minline-int-divide-max-throughput
18447 Generate code for inline divides of integer values
18448 using the maximum throughput algorithm.
18450 @item -mno-inline-int-divide
18451 @opindex mno-inline-int-divide
18452 Do not generate inline code for divides of integer values.
18454 @item -minline-sqrt-min-latency
18455 @opindex minline-sqrt-min-latency
18456 Generate code for inline square roots
18457 using the minimum latency algorithm.
18459 @item -minline-sqrt-max-throughput
18460 @opindex minline-sqrt-max-throughput
18461 Generate code for inline square roots
18462 using the maximum throughput algorithm.
18464 @item -mno-inline-sqrt
18465 @opindex mno-inline-sqrt
18466 Do not generate inline code for @code{sqrt}.
18468 @item -mfused-madd
18469 @itemx -mno-fused-madd
18470 @opindex mfused-madd
18471 @opindex mno-fused-madd
18472 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18473 instructions.  The default is to use these instructions.
18475 @item -mno-dwarf2-asm
18476 @itemx -mdwarf2-asm
18477 @opindex mno-dwarf2-asm
18478 @opindex mdwarf2-asm
18479 Don't (or do) generate assembler code for the DWARF line number debugging
18480 info.  This may be useful when not using the GNU assembler.
18482 @item -mearly-stop-bits
18483 @itemx -mno-early-stop-bits
18484 @opindex mearly-stop-bits
18485 @opindex mno-early-stop-bits
18486 Allow stop bits to be placed earlier than immediately preceding the
18487 instruction that triggered the stop bit.  This can improve instruction
18488 scheduling, but does not always do so.
18490 @item -mfixed-range=@var{register-range}
18491 @opindex mfixed-range
18492 Generate code treating the given register range as fixed registers.
18493 A fixed register is one that the register allocator cannot use.  This is
18494 useful when compiling kernel code.  A register range is specified as
18495 two registers separated by a dash.  Multiple register ranges can be
18496 specified separated by a comma.
18498 @item -mtls-size=@var{tls-size}
18499 @opindex mtls-size
18500 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18503 @item -mtune=@var{cpu-type}
18504 @opindex mtune
18505 Tune the instruction scheduling for a particular CPU, Valid values are
18506 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18507 and @samp{mckinley}.
18509 @item -milp32
18510 @itemx -mlp64
18511 @opindex milp32
18512 @opindex mlp64
18513 Generate code for a 32-bit or 64-bit environment.
18514 The 32-bit environment sets int, long and pointer to 32 bits.
18515 The 64-bit environment sets int to 32 bits and long and pointer
18516 to 64 bits.  These are HP-UX specific flags.
18518 @item -mno-sched-br-data-spec
18519 @itemx -msched-br-data-spec
18520 @opindex mno-sched-br-data-spec
18521 @opindex msched-br-data-spec
18522 (Dis/En)able data speculative scheduling before reload.
18523 This results in generation of @code{ld.a} instructions and
18524 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18525 The default setting is disabled.
18527 @item -msched-ar-data-spec
18528 @itemx -mno-sched-ar-data-spec
18529 @opindex msched-ar-data-spec
18530 @opindex mno-sched-ar-data-spec
18531 (En/Dis)able data speculative scheduling after reload.
18532 This results in generation of @code{ld.a} instructions and
18533 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18534 The default setting is enabled.
18536 @item -mno-sched-control-spec
18537 @itemx -msched-control-spec
18538 @opindex mno-sched-control-spec
18539 @opindex msched-control-spec
18540 (Dis/En)able control speculative scheduling.  This feature is
18541 available only during region scheduling (i.e.@: before reload).
18542 This results in generation of the @code{ld.s} instructions and
18543 the corresponding check instructions @code{chk.s}.
18544 The default setting is disabled.
18546 @item -msched-br-in-data-spec
18547 @itemx -mno-sched-br-in-data-spec
18548 @opindex msched-br-in-data-spec
18549 @opindex mno-sched-br-in-data-spec
18550 (En/Dis)able speculative scheduling of the instructions that
18551 are dependent on the data speculative loads before reload.
18552 This is effective only with @option{-msched-br-data-spec} enabled.
18553 The default setting is enabled.
18555 @item -msched-ar-in-data-spec
18556 @itemx -mno-sched-ar-in-data-spec
18557 @opindex msched-ar-in-data-spec
18558 @opindex mno-sched-ar-in-data-spec
18559 (En/Dis)able speculative scheduling of the instructions that
18560 are dependent on the data speculative loads after reload.
18561 This is effective only with @option{-msched-ar-data-spec} enabled.
18562 The default setting is enabled.
18564 @item -msched-in-control-spec
18565 @itemx -mno-sched-in-control-spec
18566 @opindex msched-in-control-spec
18567 @opindex mno-sched-in-control-spec
18568 (En/Dis)able speculative scheduling of the instructions that
18569 are dependent on the control speculative loads.
18570 This is effective only with @option{-msched-control-spec} enabled.
18571 The default setting is enabled.
18573 @item -mno-sched-prefer-non-data-spec-insns
18574 @itemx -msched-prefer-non-data-spec-insns
18575 @opindex mno-sched-prefer-non-data-spec-insns
18576 @opindex msched-prefer-non-data-spec-insns
18577 If enabled, data-speculative instructions are chosen for schedule
18578 only if there are no other choices at the moment.  This makes
18579 the use of the data speculation much more conservative.
18580 The default setting is disabled.
18582 @item -mno-sched-prefer-non-control-spec-insns
18583 @itemx -msched-prefer-non-control-spec-insns
18584 @opindex mno-sched-prefer-non-control-spec-insns
18585 @opindex msched-prefer-non-control-spec-insns
18586 If enabled, control-speculative instructions are chosen for schedule
18587 only if there are no other choices at the moment.  This makes
18588 the use of the control speculation much more conservative.
18589 The default setting is disabled.
18591 @item -mno-sched-count-spec-in-critical-path
18592 @itemx -msched-count-spec-in-critical-path
18593 @opindex mno-sched-count-spec-in-critical-path
18594 @opindex msched-count-spec-in-critical-path
18595 If enabled, speculative dependencies are considered during
18596 computation of the instructions priorities.  This makes the use of the
18597 speculation a bit more conservative.
18598 The default setting is disabled.
18600 @item -msched-spec-ldc
18601 @opindex msched-spec-ldc
18602 Use a simple data speculation check.  This option is on by default.
18604 @item -msched-control-spec-ldc
18605 @opindex msched-spec-ldc
18606 Use a simple check for control speculation.  This option is on by default.
18608 @item -msched-stop-bits-after-every-cycle
18609 @opindex msched-stop-bits-after-every-cycle
18610 Place a stop bit after every cycle when scheduling.  This option is on
18611 by default.
18613 @item -msched-fp-mem-deps-zero-cost
18614 @opindex msched-fp-mem-deps-zero-cost
18615 Assume that floating-point stores and loads are not likely to cause a conflict
18616 when placed into the same instruction group.  This option is disabled by
18617 default.
18619 @item -msel-sched-dont-check-control-spec
18620 @opindex msel-sched-dont-check-control-spec
18621 Generate checks for control speculation in selective scheduling.
18622 This flag is disabled by default.
18624 @item -msched-max-memory-insns=@var{max-insns}
18625 @opindex msched-max-memory-insns
18626 Limit on the number of memory insns per instruction group, giving lower
18627 priority to subsequent memory insns attempting to schedule in the same
18628 instruction group. Frequently useful to prevent cache bank conflicts.
18629 The default value is 1.
18631 @item -msched-max-memory-insns-hard-limit
18632 @opindex msched-max-memory-insns-hard-limit
18633 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18634 disallowing more than that number in an instruction group.
18635 Otherwise, the limit is ``soft'', meaning that non-memory operations
18636 are preferred when the limit is reached, but memory operations may still
18637 be scheduled.
18639 @end table
18641 @node LM32 Options
18642 @subsection LM32 Options
18643 @cindex LM32 options
18645 These @option{-m} options are defined for the LatticeMico32 architecture:
18647 @table @gcctabopt
18648 @item -mbarrel-shift-enabled
18649 @opindex mbarrel-shift-enabled
18650 Enable barrel-shift instructions.
18652 @item -mdivide-enabled
18653 @opindex mdivide-enabled
18654 Enable divide and modulus instructions.
18656 @item -mmultiply-enabled
18657 @opindex multiply-enabled
18658 Enable multiply instructions.
18660 @item -msign-extend-enabled
18661 @opindex msign-extend-enabled
18662 Enable sign extend instructions.
18664 @item -muser-enabled
18665 @opindex muser-enabled
18666 Enable user-defined instructions.
18668 @end table
18670 @node M32C Options
18671 @subsection M32C Options
18672 @cindex M32C options
18674 @table @gcctabopt
18675 @item -mcpu=@var{name}
18676 @opindex mcpu=
18677 Select the CPU for which code is generated.  @var{name} may be one of
18678 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18679 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18680 the M32C/80 series.
18682 @item -msim
18683 @opindex msim
18684 Specifies that the program will be run on the simulator.  This causes
18685 an alternate runtime library to be linked in which supports, for
18686 example, file I/O@.  You must not use this option when generating
18687 programs that will run on real hardware; you must provide your own
18688 runtime library for whatever I/O functions are needed.
18690 @item -memregs=@var{number}
18691 @opindex memregs=
18692 Specifies the number of memory-based pseudo-registers GCC uses
18693 during code generation.  These pseudo-registers are used like real
18694 registers, so there is a tradeoff between GCC's ability to fit the
18695 code into available registers, and the performance penalty of using
18696 memory instead of registers.  Note that all modules in a program must
18697 be compiled with the same value for this option.  Because of that, you
18698 must not use this option with GCC's default runtime libraries.
18700 @end table
18702 @node M32R/D Options
18703 @subsection M32R/D Options
18704 @cindex M32R/D options
18706 These @option{-m} options are defined for Renesas M32R/D architectures:
18708 @table @gcctabopt
18709 @item -m32r2
18710 @opindex m32r2
18711 Generate code for the M32R/2@.
18713 @item -m32rx
18714 @opindex m32rx
18715 Generate code for the M32R/X@.
18717 @item -m32r
18718 @opindex m32r
18719 Generate code for the M32R@.  This is the default.
18721 @item -mmodel=small
18722 @opindex mmodel=small
18723 Assume all objects live in the lower 16MB of memory (so that their addresses
18724 can be loaded with the @code{ld24} instruction), and assume all subroutines
18725 are reachable with the @code{bl} instruction.
18726 This is the default.
18728 The addressability of a particular object can be set with the
18729 @code{model} attribute.
18731 @item -mmodel=medium
18732 @opindex mmodel=medium
18733 Assume objects may be anywhere in the 32-bit address space (the compiler
18734 generates @code{seth/add3} instructions to load their addresses), and
18735 assume all subroutines are reachable with the @code{bl} instruction.
18737 @item -mmodel=large
18738 @opindex mmodel=large
18739 Assume objects may be anywhere in the 32-bit address space (the compiler
18740 generates @code{seth/add3} instructions to load their addresses), and
18741 assume subroutines may not be reachable with the @code{bl} instruction
18742 (the compiler generates the much slower @code{seth/add3/jl}
18743 instruction sequence).
18745 @item -msdata=none
18746 @opindex msdata=none
18747 Disable use of the small data area.  Variables are put into
18748 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18749 @code{section} attribute has been specified).
18750 This is the default.
18752 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18753 Objects may be explicitly put in the small data area with the
18754 @code{section} attribute using one of these sections.
18756 @item -msdata=sdata
18757 @opindex msdata=sdata
18758 Put small global and static data in the small data area, but do not
18759 generate special code to reference them.
18761 @item -msdata=use
18762 @opindex msdata=use
18763 Put small global and static data in the small data area, and generate
18764 special instructions to reference them.
18766 @item -G @var{num}
18767 @opindex G
18768 @cindex smaller data references
18769 Put global and static objects less than or equal to @var{num} bytes
18770 into the small data or BSS sections instead of the normal data or BSS
18771 sections.  The default value of @var{num} is 8.
18772 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18773 for this option to have any effect.
18775 All modules should be compiled with the same @option{-G @var{num}} value.
18776 Compiling with different values of @var{num} may or may not work; if it
18777 doesn't the linker gives an error message---incorrect code is not
18778 generated.
18780 @item -mdebug
18781 @opindex mdebug
18782 Makes the M32R-specific code in the compiler display some statistics
18783 that might help in debugging programs.
18785 @item -malign-loops
18786 @opindex malign-loops
18787 Align all loops to a 32-byte boundary.
18789 @item -mno-align-loops
18790 @opindex mno-align-loops
18791 Do not enforce a 32-byte alignment for loops.  This is the default.
18793 @item -missue-rate=@var{number}
18794 @opindex missue-rate=@var{number}
18795 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18796 or 2.
18798 @item -mbranch-cost=@var{number}
18799 @opindex mbranch-cost=@var{number}
18800 @var{number} can only be 1 or 2.  If it is 1 then branches are
18801 preferred over conditional code, if it is 2, then the opposite applies.
18803 @item -mflush-trap=@var{number}
18804 @opindex mflush-trap=@var{number}
18805 Specifies the trap number to use to flush the cache.  The default is
18806 12.  Valid numbers are between 0 and 15 inclusive.
18808 @item -mno-flush-trap
18809 @opindex mno-flush-trap
18810 Specifies that the cache cannot be flushed by using a trap.
18812 @item -mflush-func=@var{name}
18813 @opindex mflush-func=@var{name}
18814 Specifies the name of the operating system function to call to flush
18815 the cache.  The default is @samp{_flush_cache}, but a function call
18816 is only used if a trap is not available.
18818 @item -mno-flush-func
18819 @opindex mno-flush-func
18820 Indicates that there is no OS function for flushing the cache.
18822 @end table
18824 @node M680x0 Options
18825 @subsection M680x0 Options
18826 @cindex M680x0 options
18828 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18829 The default settings depend on which architecture was selected when
18830 the compiler was configured; the defaults for the most common choices
18831 are given below.
18833 @table @gcctabopt
18834 @item -march=@var{arch}
18835 @opindex march
18836 Generate code for a specific M680x0 or ColdFire instruction set
18837 architecture.  Permissible values of @var{arch} for M680x0
18838 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18839 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18840 architectures are selected according to Freescale's ISA classification
18841 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18842 @samp{isab} and @samp{isac}.
18844 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18845 code for a ColdFire target.  The @var{arch} in this macro is one of the
18846 @option{-march} arguments given above.
18848 When used together, @option{-march} and @option{-mtune} select code
18849 that runs on a family of similar processors but that is optimized
18850 for a particular microarchitecture.
18852 @item -mcpu=@var{cpu}
18853 @opindex mcpu
18854 Generate code for a specific M680x0 or ColdFire processor.
18855 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18856 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18857 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18858 below, which also classifies the CPUs into families:
18860 @multitable @columnfractions 0.20 0.80
18861 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18862 @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}
18863 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18864 @item @samp{5206e} @tab @samp{5206e}
18865 @item @samp{5208} @tab @samp{5207} @samp{5208}
18866 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18867 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18868 @item @samp{5216} @tab @samp{5214} @samp{5216}
18869 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18870 @item @samp{5225} @tab @samp{5224} @samp{5225}
18871 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18872 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18873 @item @samp{5249} @tab @samp{5249}
18874 @item @samp{5250} @tab @samp{5250}
18875 @item @samp{5271} @tab @samp{5270} @samp{5271}
18876 @item @samp{5272} @tab @samp{5272}
18877 @item @samp{5275} @tab @samp{5274} @samp{5275}
18878 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18879 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18880 @item @samp{5307} @tab @samp{5307}
18881 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18882 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18883 @item @samp{5407} @tab @samp{5407}
18884 @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}
18885 @end multitable
18887 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18888 @var{arch} is compatible with @var{cpu}.  Other combinations of
18889 @option{-mcpu} and @option{-march} are rejected.
18891 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18892 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18893 where the value of @var{family} is given by the table above.
18895 @item -mtune=@var{tune}
18896 @opindex mtune
18897 Tune the code for a particular microarchitecture within the
18898 constraints set by @option{-march} and @option{-mcpu}.
18899 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18900 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18901 and @samp{cpu32}.  The ColdFire microarchitectures
18902 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18904 You can also use @option{-mtune=68020-40} for code that needs
18905 to run relatively well on 68020, 68030 and 68040 targets.
18906 @option{-mtune=68020-60} is similar but includes 68060 targets
18907 as well.  These two options select the same tuning decisions as
18908 @option{-m68020-40} and @option{-m68020-60} respectively.
18910 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18911 when tuning for 680x0 architecture @var{arch}.  It also defines
18912 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18913 option is used.  If GCC is tuning for a range of architectures,
18914 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18915 it defines the macros for every architecture in the range.
18917 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18918 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18919 of the arguments given above.
18921 @item -m68000
18922 @itemx -mc68000
18923 @opindex m68000
18924 @opindex mc68000
18925 Generate output for a 68000.  This is the default
18926 when the compiler is configured for 68000-based systems.
18927 It is equivalent to @option{-march=68000}.
18929 Use this option for microcontrollers with a 68000 or EC000 core,
18930 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18932 @item -m68010
18933 @opindex m68010
18934 Generate output for a 68010.  This is the default
18935 when the compiler is configured for 68010-based systems.
18936 It is equivalent to @option{-march=68010}.
18938 @item -m68020
18939 @itemx -mc68020
18940 @opindex m68020
18941 @opindex mc68020
18942 Generate output for a 68020.  This is the default
18943 when the compiler is configured for 68020-based systems.
18944 It is equivalent to @option{-march=68020}.
18946 @item -m68030
18947 @opindex m68030
18948 Generate output for a 68030.  This is the default when the compiler is
18949 configured for 68030-based systems.  It is equivalent to
18950 @option{-march=68030}.
18952 @item -m68040
18953 @opindex m68040
18954 Generate output for a 68040.  This is the default when the compiler is
18955 configured for 68040-based systems.  It is equivalent to
18956 @option{-march=68040}.
18958 This option inhibits the use of 68881/68882 instructions that have to be
18959 emulated by software on the 68040.  Use this option if your 68040 does not
18960 have code to emulate those instructions.
18962 @item -m68060
18963 @opindex m68060
18964 Generate output for a 68060.  This is the default when the compiler is
18965 configured for 68060-based systems.  It is equivalent to
18966 @option{-march=68060}.
18968 This option inhibits the use of 68020 and 68881/68882 instructions that
18969 have to be emulated by software on the 68060.  Use this option if your 68060
18970 does not have code to emulate those instructions.
18972 @item -mcpu32
18973 @opindex mcpu32
18974 Generate output for a CPU32.  This is the default
18975 when the compiler is configured for CPU32-based systems.
18976 It is equivalent to @option{-march=cpu32}.
18978 Use this option for microcontrollers with a
18979 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
18980 68336, 68340, 68341, 68349 and 68360.
18982 @item -m5200
18983 @opindex m5200
18984 Generate output for a 520X ColdFire CPU@.  This is the default
18985 when the compiler is configured for 520X-based systems.
18986 It is equivalent to @option{-mcpu=5206}, and is now deprecated
18987 in favor of that option.
18989 Use this option for microcontroller with a 5200 core, including
18990 the MCF5202, MCF5203, MCF5204 and MCF5206.
18992 @item -m5206e
18993 @opindex m5206e
18994 Generate output for a 5206e ColdFire CPU@.  The option is now
18995 deprecated in favor of the equivalent @option{-mcpu=5206e}.
18997 @item -m528x
18998 @opindex m528x
18999 Generate output for a member of the ColdFire 528X family.
19000 The option is now deprecated in favor of the equivalent
19001 @option{-mcpu=528x}.
19003 @item -m5307
19004 @opindex m5307
19005 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19006 in favor of the equivalent @option{-mcpu=5307}.
19008 @item -m5407
19009 @opindex m5407
19010 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19011 in favor of the equivalent @option{-mcpu=5407}.
19013 @item -mcfv4e
19014 @opindex mcfv4e
19015 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19016 This includes use of hardware floating-point instructions.
19017 The option is equivalent to @option{-mcpu=547x}, and is now
19018 deprecated in favor of that option.
19020 @item -m68020-40
19021 @opindex m68020-40
19022 Generate output for a 68040, without using any of the new instructions.
19023 This results in code that can run relatively efficiently on either a
19024 68020/68881 or a 68030 or a 68040.  The generated code does use the
19025 68881 instructions that are emulated on the 68040.
19027 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19029 @item -m68020-60
19030 @opindex m68020-60
19031 Generate output for a 68060, without using any of the new instructions.
19032 This results in code that can run relatively efficiently on either a
19033 68020/68881 or a 68030 or a 68040.  The generated code does use the
19034 68881 instructions that are emulated on the 68060.
19036 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19038 @item -mhard-float
19039 @itemx -m68881
19040 @opindex mhard-float
19041 @opindex m68881
19042 Generate floating-point instructions.  This is the default for 68020
19043 and above, and for ColdFire devices that have an FPU@.  It defines the
19044 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19045 on ColdFire targets.
19047 @item -msoft-float
19048 @opindex msoft-float
19049 Do not generate floating-point instructions; use library calls instead.
19050 This is the default for 68000, 68010, and 68832 targets.  It is also
19051 the default for ColdFire devices that have no FPU.
19053 @item -mdiv
19054 @itemx -mno-div
19055 @opindex mdiv
19056 @opindex mno-div
19057 Generate (do not generate) ColdFire hardware divide and remainder
19058 instructions.  If @option{-march} is used without @option{-mcpu},
19059 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19060 architectures.  Otherwise, the default is taken from the target CPU
19061 (either the default CPU, or the one specified by @option{-mcpu}).  For
19062 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19063 @option{-mcpu=5206e}.
19065 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19067 @item -mshort
19068 @opindex mshort
19069 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19070 Additionally, parameters passed on the stack are also aligned to a
19071 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19073 @item -mno-short
19074 @opindex mno-short
19075 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19077 @item -mnobitfield
19078 @itemx -mno-bitfield
19079 @opindex mnobitfield
19080 @opindex mno-bitfield
19081 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19082 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19084 @item -mbitfield
19085 @opindex mbitfield
19086 Do use the bit-field instructions.  The @option{-m68020} option implies
19087 @option{-mbitfield}.  This is the default if you use a configuration
19088 designed for a 68020.
19090 @item -mrtd
19091 @opindex mrtd
19092 Use a different function-calling convention, in which functions
19093 that take a fixed number of arguments return with the @code{rtd}
19094 instruction, which pops their arguments while returning.  This
19095 saves one instruction in the caller since there is no need to pop
19096 the arguments there.
19098 This calling convention is incompatible with the one normally
19099 used on Unix, so you cannot use it if you need to call libraries
19100 compiled with the Unix compiler.
19102 Also, you must provide function prototypes for all functions that
19103 take variable numbers of arguments (including @code{printf});
19104 otherwise incorrect code is generated for calls to those
19105 functions.
19107 In addition, seriously incorrect code results if you call a
19108 function with too many arguments.  (Normally, extra arguments are
19109 harmlessly ignored.)
19111 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19112 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19114 @item -mno-rtd
19115 @opindex mno-rtd
19116 Do not use the calling conventions selected by @option{-mrtd}.
19117 This is the default.
19119 @item -malign-int
19120 @itemx -mno-align-int
19121 @opindex malign-int
19122 @opindex mno-align-int
19123 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19124 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19125 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19126 Aligning variables on 32-bit boundaries produces code that runs somewhat
19127 faster on processors with 32-bit busses at the expense of more memory.
19129 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19130 aligns structures containing the above types differently than
19131 most published application binary interface specifications for the m68k.
19133 @item -mpcrel
19134 @opindex mpcrel
19135 Use the pc-relative addressing mode of the 68000 directly, instead of
19136 using a global offset table.  At present, this option implies @option{-fpic},
19137 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19138 not presently supported with @option{-mpcrel}, though this could be supported for
19139 68020 and higher processors.
19141 @item -mno-strict-align
19142 @itemx -mstrict-align
19143 @opindex mno-strict-align
19144 @opindex mstrict-align
19145 Do not (do) assume that unaligned memory references are handled by
19146 the system.
19148 @item -msep-data
19149 Generate code that allows the data segment to be located in a different
19150 area of memory from the text segment.  This allows for execute-in-place in
19151 an environment without virtual memory management.  This option implies
19152 @option{-fPIC}.
19154 @item -mno-sep-data
19155 Generate code that assumes that the data segment follows the text segment.
19156 This is the default.
19158 @item -mid-shared-library
19159 Generate code that supports shared libraries via the library ID method.
19160 This allows for execute-in-place and shared libraries in an environment
19161 without virtual memory management.  This option implies @option{-fPIC}.
19163 @item -mno-id-shared-library
19164 Generate code that doesn't assume ID-based shared libraries are being used.
19165 This is the default.
19167 @item -mshared-library-id=n
19168 Specifies the identification number of the ID-based shared library being
19169 compiled.  Specifying a value of 0 generates more compact code; specifying
19170 other values forces the allocation of that number to the current
19171 library, but is no more space- or time-efficient than omitting this option.
19173 @item -mxgot
19174 @itemx -mno-xgot
19175 @opindex mxgot
19176 @opindex mno-xgot
19177 When generating position-independent code for ColdFire, generate code
19178 that works if the GOT has more than 8192 entries.  This code is
19179 larger and slower than code generated without this option.  On M680x0
19180 processors, this option is not needed; @option{-fPIC} suffices.
19182 GCC normally uses a single instruction to load values from the GOT@.
19183 While this is relatively efficient, it only works if the GOT
19184 is smaller than about 64k.  Anything larger causes the linker
19185 to report an error such as:
19187 @cindex relocation truncated to fit (ColdFire)
19188 @smallexample
19189 relocation truncated to fit: R_68K_GOT16O foobar
19190 @end smallexample
19192 If this happens, you should recompile your code with @option{-mxgot}.
19193 It should then work with very large GOTs.  However, code generated with
19194 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19195 the value of a global symbol.
19197 Note that some linkers, including newer versions of the GNU linker,
19198 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19199 you should only need to use @option{-mxgot} when compiling a single
19200 object file that accesses more than 8192 GOT entries.  Very few do.
19202 These options have no effect unless GCC is generating
19203 position-independent code.
19205 @item -mlong-jump-table-offsets
19206 @opindex mlong-jump-table-offsets
19207 Use 32-bit offsets in @code{switch} tables.  The default is to use
19208 16-bit offsets.
19210 @end table
19212 @node MCore Options
19213 @subsection MCore Options
19214 @cindex MCore options
19216 These are the @samp{-m} options defined for the Motorola M*Core
19217 processors.
19219 @table @gcctabopt
19221 @item -mhardlit
19222 @itemx -mno-hardlit
19223 @opindex mhardlit
19224 @opindex mno-hardlit
19225 Inline constants into the code stream if it can be done in two
19226 instructions or less.
19228 @item -mdiv
19229 @itemx -mno-div
19230 @opindex mdiv
19231 @opindex mno-div
19232 Use the divide instruction.  (Enabled by default).
19234 @item -mrelax-immediate
19235 @itemx -mno-relax-immediate
19236 @opindex mrelax-immediate
19237 @opindex mno-relax-immediate
19238 Allow arbitrary-sized immediates in bit operations.
19240 @item -mwide-bitfields
19241 @itemx -mno-wide-bitfields
19242 @opindex mwide-bitfields
19243 @opindex mno-wide-bitfields
19244 Always treat bit-fields as @code{int}-sized.
19246 @item -m4byte-functions
19247 @itemx -mno-4byte-functions
19248 @opindex m4byte-functions
19249 @opindex mno-4byte-functions
19250 Force all functions to be aligned to a 4-byte boundary.
19252 @item -mcallgraph-data
19253 @itemx -mno-callgraph-data
19254 @opindex mcallgraph-data
19255 @opindex mno-callgraph-data
19256 Emit callgraph information.
19258 @item -mslow-bytes
19259 @itemx -mno-slow-bytes
19260 @opindex mslow-bytes
19261 @opindex mno-slow-bytes
19262 Prefer word access when reading byte quantities.
19264 @item -mlittle-endian
19265 @itemx -mbig-endian
19266 @opindex mlittle-endian
19267 @opindex mbig-endian
19268 Generate code for a little-endian target.
19270 @item -m210
19271 @itemx -m340
19272 @opindex m210
19273 @opindex m340
19274 Generate code for the 210 processor.
19276 @item -mno-lsim
19277 @opindex mno-lsim
19278 Assume that runtime support has been provided and so omit the
19279 simulator library (@file{libsim.a)} from the linker command line.
19281 @item -mstack-increment=@var{size}
19282 @opindex mstack-increment
19283 Set the maximum amount for a single stack increment operation.  Large
19284 values can increase the speed of programs that contain functions
19285 that need a large amount of stack space, but they can also trigger a
19286 segmentation fault if the stack is extended too much.  The default
19287 value is 0x1000.
19289 @end table
19291 @node MeP Options
19292 @subsection MeP Options
19293 @cindex MeP options
19295 @table @gcctabopt
19297 @item -mabsdiff
19298 @opindex mabsdiff
19299 Enables the @code{abs} instruction, which is the absolute difference
19300 between two registers.
19302 @item -mall-opts
19303 @opindex mall-opts
19304 Enables all the optional instructions---average, multiply, divide, bit
19305 operations, leading zero, absolute difference, min/max, clip, and
19306 saturation.
19309 @item -maverage
19310 @opindex maverage
19311 Enables the @code{ave} instruction, which computes the average of two
19312 registers.
19314 @item -mbased=@var{n}
19315 @opindex mbased=
19316 Variables of size @var{n} bytes or smaller are placed in the
19317 @code{.based} section by default.  Based variables use the @code{$tp}
19318 register as a base register, and there is a 128-byte limit to the
19319 @code{.based} section.
19321 @item -mbitops
19322 @opindex mbitops
19323 Enables the bit operation instructions---bit test (@code{btstm}), set
19324 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19325 test-and-set (@code{tas}).
19327 @item -mc=@var{name}
19328 @opindex mc=
19329 Selects which section constant data is placed in.  @var{name} may
19330 be @samp{tiny}, @samp{near}, or @samp{far}.
19332 @item -mclip
19333 @opindex mclip
19334 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19335 useful unless you also provide @option{-mminmax}.
19337 @item -mconfig=@var{name}
19338 @opindex mconfig=
19339 Selects one of the built-in core configurations.  Each MeP chip has
19340 one or more modules in it; each module has a core CPU and a variety of
19341 coprocessors, optional instructions, and peripherals.  The
19342 @code{MeP-Integrator} tool, not part of GCC, provides these
19343 configurations through this option; using this option is the same as
19344 using all the corresponding command-line options.  The default
19345 configuration is @samp{default}.
19347 @item -mcop
19348 @opindex mcop
19349 Enables the coprocessor instructions.  By default, this is a 32-bit
19350 coprocessor.  Note that the coprocessor is normally enabled via the
19351 @option{-mconfig=} option.
19353 @item -mcop32
19354 @opindex mcop32
19355 Enables the 32-bit coprocessor's instructions.
19357 @item -mcop64
19358 @opindex mcop64
19359 Enables the 64-bit coprocessor's instructions.
19361 @item -mivc2
19362 @opindex mivc2
19363 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19365 @item -mdc
19366 @opindex mdc
19367 Causes constant variables to be placed in the @code{.near} section.
19369 @item -mdiv
19370 @opindex mdiv
19371 Enables the @code{div} and @code{divu} instructions.
19373 @item -meb
19374 @opindex meb
19375 Generate big-endian code.
19377 @item -mel
19378 @opindex mel
19379 Generate little-endian code.
19381 @item -mio-volatile
19382 @opindex mio-volatile
19383 Tells the compiler that any variable marked with the @code{io}
19384 attribute is to be considered volatile.
19386 @item -ml
19387 @opindex ml
19388 Causes variables to be assigned to the @code{.far} section by default.
19390 @item -mleadz
19391 @opindex mleadz
19392 Enables the @code{leadz} (leading zero) instruction.
19394 @item -mm
19395 @opindex mm
19396 Causes variables to be assigned to the @code{.near} section by default.
19398 @item -mminmax
19399 @opindex mminmax
19400 Enables the @code{min} and @code{max} instructions.
19402 @item -mmult
19403 @opindex mmult
19404 Enables the multiplication and multiply-accumulate instructions.
19406 @item -mno-opts
19407 @opindex mno-opts
19408 Disables all the optional instructions enabled by @option{-mall-opts}.
19410 @item -mrepeat
19411 @opindex mrepeat
19412 Enables the @code{repeat} and @code{erepeat} instructions, used for
19413 low-overhead looping.
19415 @item -ms
19416 @opindex ms
19417 Causes all variables to default to the @code{.tiny} section.  Note
19418 that there is a 65536-byte limit to this section.  Accesses to these
19419 variables use the @code{%gp} base register.
19421 @item -msatur
19422 @opindex msatur
19423 Enables the saturation instructions.  Note that the compiler does not
19424 currently generate these itself, but this option is included for
19425 compatibility with other tools, like @code{as}.
19427 @item -msdram
19428 @opindex msdram
19429 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19431 @item -msim
19432 @opindex msim
19433 Link the simulator run-time libraries.
19435 @item -msimnovec
19436 @opindex msimnovec
19437 Link the simulator runtime libraries, excluding built-in support
19438 for reset and exception vectors and tables.
19440 @item -mtf
19441 @opindex mtf
19442 Causes all functions to default to the @code{.far} section.  Without
19443 this option, functions default to the @code{.near} section.
19445 @item -mtiny=@var{n}
19446 @opindex mtiny=
19447 Variables that are @var{n} bytes or smaller are allocated to the
19448 @code{.tiny} section.  These variables use the @code{$gp} base
19449 register.  The default for this option is 4, but note that there's a
19450 65536-byte limit to the @code{.tiny} section.
19452 @end table
19454 @node MicroBlaze Options
19455 @subsection MicroBlaze Options
19456 @cindex MicroBlaze Options
19458 @table @gcctabopt
19460 @item -msoft-float
19461 @opindex msoft-float
19462 Use software emulation for floating point (default).
19464 @item -mhard-float
19465 @opindex mhard-float
19466 Use hardware floating-point instructions.
19468 @item -mmemcpy
19469 @opindex mmemcpy
19470 Do not optimize block moves, use @code{memcpy}.
19472 @item -mno-clearbss
19473 @opindex mno-clearbss
19474 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19476 @item -mcpu=@var{cpu-type}
19477 @opindex mcpu=
19478 Use features of, and schedule code for, the given CPU.
19479 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19480 where @var{X} is a major version, @var{YY} is the minor version, and
19481 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19482 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19484 @item -mxl-soft-mul
19485 @opindex mxl-soft-mul
19486 Use software multiply emulation (default).
19488 @item -mxl-soft-div
19489 @opindex mxl-soft-div
19490 Use software emulation for divides (default).
19492 @item -mxl-barrel-shift
19493 @opindex mxl-barrel-shift
19494 Use the hardware barrel shifter.
19496 @item -mxl-pattern-compare
19497 @opindex mxl-pattern-compare
19498 Use pattern compare instructions.
19500 @item -msmall-divides
19501 @opindex msmall-divides
19502 Use table lookup optimization for small signed integer divisions.
19504 @item -mxl-stack-check
19505 @opindex mxl-stack-check
19506 This option is deprecated.  Use @option{-fstack-check} instead.
19508 @item -mxl-gp-opt
19509 @opindex mxl-gp-opt
19510 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19512 @item -mxl-multiply-high
19513 @opindex mxl-multiply-high
19514 Use multiply high instructions for high part of 32x32 multiply.
19516 @item -mxl-float-convert
19517 @opindex mxl-float-convert
19518 Use hardware floating-point conversion instructions.
19520 @item -mxl-float-sqrt
19521 @opindex mxl-float-sqrt
19522 Use hardware floating-point square root instruction.
19524 @item -mbig-endian
19525 @opindex mbig-endian
19526 Generate code for a big-endian target.
19528 @item -mlittle-endian
19529 @opindex mlittle-endian
19530 Generate code for a little-endian target.
19532 @item -mxl-reorder
19533 @opindex mxl-reorder
19534 Use reorder instructions (swap and byte reversed load/store).
19536 @item -mxl-mode-@var{app-model}
19537 Select application model @var{app-model}.  Valid models are
19538 @table @samp
19539 @item executable
19540 normal executable (default), uses startup code @file{crt0.o}.
19542 @item xmdstub
19543 for use with Xilinx Microprocessor Debugger (XMD) based
19544 software intrusive debug agent called xmdstub. This uses startup file
19545 @file{crt1.o} and sets the start address of the program to 0x800.
19547 @item bootstrap
19548 for applications that are loaded using a bootloader.
19549 This model uses startup file @file{crt2.o} which does not contain a processor
19550 reset vector handler. This is suitable for transferring control on a
19551 processor reset to the bootloader rather than the application.
19553 @item novectors
19554 for applications that do not require any of the
19555 MicroBlaze vectors. This option may be useful for applications running
19556 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19557 @end table
19559 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19560 @option{-mxl-mode-@var{app-model}}.
19562 @end table
19564 @node MIPS Options
19565 @subsection MIPS Options
19566 @cindex MIPS options
19568 @table @gcctabopt
19570 @item -EB
19571 @opindex EB
19572 Generate big-endian code.
19574 @item -EL
19575 @opindex EL
19576 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19577 configurations.
19579 @item -march=@var{arch}
19580 @opindex march
19581 Generate code that runs on @var{arch}, which can be the name of a
19582 generic MIPS ISA, or the name of a particular processor.
19583 The ISA names are:
19584 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19585 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19586 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19587 @samp{mips64r5} and @samp{mips64r6}.
19588 The processor names are:
19589 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19590 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19591 @samp{5kc}, @samp{5kf},
19592 @samp{20kc},
19593 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19594 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19595 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19596 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19597 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19598 @samp{i6400},
19599 @samp{interaptiv},
19600 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19601 @samp{m4k},
19602 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19603 @samp{m5100}, @samp{m5101},
19604 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19605 @samp{orion},
19606 @samp{p5600},
19607 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19608 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19609 @samp{rm7000}, @samp{rm9000},
19610 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19611 @samp{sb1},
19612 @samp{sr71000},
19613 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19614 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19615 @samp{xlr} and @samp{xlp}.
19616 The special value @samp{from-abi} selects the
19617 most compatible architecture for the selected ABI (that is,
19618 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19620 The native Linux/GNU toolchain also supports the value @samp{native},
19621 which selects the best architecture option for the host processor.
19622 @option{-march=native} has no effect if GCC does not recognize
19623 the processor.
19625 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19626 (for example, @option{-march=r2k}).  Prefixes are optional, and
19627 @samp{vr} may be written @samp{r}.
19629 Names of the form @samp{@var{n}f2_1} refer to processors with
19630 FPUs clocked at half the rate of the core, names of the form
19631 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19632 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19633 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19634 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19635 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19636 accepted as synonyms for @samp{@var{n}f1_1}.
19638 GCC defines two macros based on the value of this option.  The first
19639 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19640 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19641 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19642 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19643 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19645 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19646 above.  In other words, it has the full prefix and does not
19647 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19648 the macro names the resolved architecture (either @code{"mips1"} or
19649 @code{"mips3"}).  It names the default architecture when no
19650 @option{-march} option is given.
19652 @item -mtune=@var{arch}
19653 @opindex mtune
19654 Optimize for @var{arch}.  Among other things, this option controls
19655 the way instructions are scheduled, and the perceived cost of arithmetic
19656 operations.  The list of @var{arch} values is the same as for
19657 @option{-march}.
19659 When this option is not used, GCC optimizes for the processor
19660 specified by @option{-march}.  By using @option{-march} and
19661 @option{-mtune} together, it is possible to generate code that
19662 runs on a family of processors, but optimize the code for one
19663 particular member of that family.
19665 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19666 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19667 @option{-march} ones described above.
19669 @item -mips1
19670 @opindex mips1
19671 Equivalent to @option{-march=mips1}.
19673 @item -mips2
19674 @opindex mips2
19675 Equivalent to @option{-march=mips2}.
19677 @item -mips3
19678 @opindex mips3
19679 Equivalent to @option{-march=mips3}.
19681 @item -mips4
19682 @opindex mips4
19683 Equivalent to @option{-march=mips4}.
19685 @item -mips32
19686 @opindex mips32
19687 Equivalent to @option{-march=mips32}.
19689 @item -mips32r3
19690 @opindex mips32r3
19691 Equivalent to @option{-march=mips32r3}.
19693 @item -mips32r5
19694 @opindex mips32r5
19695 Equivalent to @option{-march=mips32r5}.
19697 @item -mips32r6
19698 @opindex mips32r6
19699 Equivalent to @option{-march=mips32r6}.
19701 @item -mips64
19702 @opindex mips64
19703 Equivalent to @option{-march=mips64}.
19705 @item -mips64r2
19706 @opindex mips64r2
19707 Equivalent to @option{-march=mips64r2}.
19709 @item -mips64r3
19710 @opindex mips64r3
19711 Equivalent to @option{-march=mips64r3}.
19713 @item -mips64r5
19714 @opindex mips64r5
19715 Equivalent to @option{-march=mips64r5}.
19717 @item -mips64r6
19718 @opindex mips64r6
19719 Equivalent to @option{-march=mips64r6}.
19721 @item -mips16
19722 @itemx -mno-mips16
19723 @opindex mips16
19724 @opindex mno-mips16
19725 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19726 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19728 MIPS16 code generation can also be controlled on a per-function basis
19729 by means of @code{mips16} and @code{nomips16} attributes.
19730 @xref{Function Attributes}, for more information.
19732 @item -mflip-mips16
19733 @opindex mflip-mips16
19734 Generate MIPS16 code on alternating functions.  This option is provided
19735 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19736 not intended for ordinary use in compiling user code.
19738 @item -minterlink-compressed
19739 @item -mno-interlink-compressed
19740 @opindex minterlink-compressed
19741 @opindex mno-interlink-compressed
19742 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19743 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19745 For example, code using the standard ISA encoding cannot jump directly
19746 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19747 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19748 knows that the target of the jump is not compressed.
19750 @item -minterlink-mips16
19751 @itemx -mno-interlink-mips16
19752 @opindex minterlink-mips16
19753 @opindex mno-interlink-mips16
19754 Aliases of @option{-minterlink-compressed} and
19755 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19756 and are retained for backwards compatibility.
19758 @item -mabi=32
19759 @itemx -mabi=o64
19760 @itemx -mabi=n32
19761 @itemx -mabi=64
19762 @itemx -mabi=eabi
19763 @opindex mabi=32
19764 @opindex mabi=o64
19765 @opindex mabi=n32
19766 @opindex mabi=64
19767 @opindex mabi=eabi
19768 Generate code for the given ABI@.
19770 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19771 generates 64-bit code when you select a 64-bit architecture, but you
19772 can use @option{-mgp32} to get 32-bit code instead.
19774 For information about the O64 ABI, see
19775 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19777 GCC supports a variant of the o32 ABI in which floating-point registers
19778 are 64 rather than 32 bits wide.  You can select this combination with
19779 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19780 and @code{mfhc1} instructions and is therefore only supported for
19781 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19783 The register assignments for arguments and return values remain the
19784 same, but each scalar value is passed in a single 64-bit register
19785 rather than a pair of 32-bit registers.  For example, scalar
19786 floating-point values are returned in @samp{$f0} only, not a
19787 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19788 remains the same in that the even-numbered double-precision registers
19789 are saved.
19791 Two additional variants of the o32 ABI are supported to enable
19792 a transition from 32-bit to 64-bit registers.  These are FPXX
19793 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19794 The FPXX extension mandates that all code must execute correctly
19795 when run using 32-bit or 64-bit registers.  The code can be interlinked
19796 with either FP32 or FP64, but not both.
19797 The FP64A extension is similar to the FP64 extension but forbids the
19798 use of odd-numbered single-precision registers.  This can be used
19799 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19800 processors and allows both FP32 and FP64A code to interlink and
19801 run in the same process without changing FPU modes.
19803 @item -mabicalls
19804 @itemx -mno-abicalls
19805 @opindex mabicalls
19806 @opindex mno-abicalls
19807 Generate (do not generate) code that is suitable for SVR4-style
19808 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19809 systems.
19811 @item -mshared
19812 @itemx -mno-shared
19813 Generate (do not generate) code that is fully position-independent,
19814 and that can therefore be linked into shared libraries.  This option
19815 only affects @option{-mabicalls}.
19817 All @option{-mabicalls} code has traditionally been position-independent,
19818 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19819 as an extension, the GNU toolchain allows executables to use absolute
19820 accesses for locally-binding symbols.  It can also use shorter GP
19821 initialization sequences and generate direct calls to locally-defined
19822 functions.  This mode is selected by @option{-mno-shared}.
19824 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19825 objects that can only be linked by the GNU linker.  However, the option
19826 does not affect the ABI of the final executable; it only affects the ABI
19827 of relocatable objects.  Using @option{-mno-shared} generally makes
19828 executables both smaller and quicker.
19830 @option{-mshared} is the default.
19832 @item -mplt
19833 @itemx -mno-plt
19834 @opindex mplt
19835 @opindex mno-plt
19836 Assume (do not assume) that the static and dynamic linkers
19837 support PLTs and copy relocations.  This option only affects
19838 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19839 has no effect without @option{-msym32}.
19841 You can make @option{-mplt} the default by configuring
19842 GCC with @option{--with-mips-plt}.  The default is
19843 @option{-mno-plt} otherwise.
19845 @item -mxgot
19846 @itemx -mno-xgot
19847 @opindex mxgot
19848 @opindex mno-xgot
19849 Lift (do not lift) the usual restrictions on the size of the global
19850 offset table.
19852 GCC normally uses a single instruction to load values from the GOT@.
19853 While this is relatively efficient, it only works if the GOT
19854 is smaller than about 64k.  Anything larger causes the linker
19855 to report an error such as:
19857 @cindex relocation truncated to fit (MIPS)
19858 @smallexample
19859 relocation truncated to fit: R_MIPS_GOT16 foobar
19860 @end smallexample
19862 If this happens, you should recompile your code with @option{-mxgot}.
19863 This works with very large GOTs, although the code is also
19864 less efficient, since it takes three instructions to fetch the
19865 value of a global symbol.
19867 Note that some linkers can create multiple GOTs.  If you have such a
19868 linker, you should only need to use @option{-mxgot} when a single object
19869 file accesses more than 64k's worth of GOT entries.  Very few do.
19871 These options have no effect unless GCC is generating position
19872 independent code.
19874 @item -mgp32
19875 @opindex mgp32
19876 Assume that general-purpose registers are 32 bits wide.
19878 @item -mgp64
19879 @opindex mgp64
19880 Assume that general-purpose registers are 64 bits wide.
19882 @item -mfp32
19883 @opindex mfp32
19884 Assume that floating-point registers are 32 bits wide.
19886 @item -mfp64
19887 @opindex mfp64
19888 Assume that floating-point registers are 64 bits wide.
19890 @item -mfpxx
19891 @opindex mfpxx
19892 Do not assume the width of floating-point registers.
19894 @item -mhard-float
19895 @opindex mhard-float
19896 Use floating-point coprocessor instructions.
19898 @item -msoft-float
19899 @opindex msoft-float
19900 Do not use floating-point coprocessor instructions.  Implement
19901 floating-point calculations using library calls instead.
19903 @item -mno-float
19904 @opindex mno-float
19905 Equivalent to @option{-msoft-float}, but additionally asserts that the
19906 program being compiled does not perform any floating-point operations.
19907 This option is presently supported only by some bare-metal MIPS
19908 configurations, where it may select a special set of libraries
19909 that lack all floating-point support (including, for example, the
19910 floating-point @code{printf} formats).  
19911 If code compiled with @option{-mno-float} accidentally contains
19912 floating-point operations, it is likely to suffer a link-time
19913 or run-time failure.
19915 @item -msingle-float
19916 @opindex msingle-float
19917 Assume that the floating-point coprocessor only supports single-precision
19918 operations.
19920 @item -mdouble-float
19921 @opindex mdouble-float
19922 Assume that the floating-point coprocessor supports double-precision
19923 operations.  This is the default.
19925 @item -modd-spreg
19926 @itemx -mno-odd-spreg
19927 @opindex modd-spreg
19928 @opindex mno-odd-spreg
19929 Enable the use of odd-numbered single-precision floating-point registers
19930 for the o32 ABI.  This is the default for processors that are known to
19931 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19932 is set by default.
19934 @item -mabs=2008
19935 @itemx -mabs=legacy
19936 @opindex mabs=2008
19937 @opindex mabs=legacy
19938 These options control the treatment of the special not-a-number (NaN)
19939 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19940 @code{neg.@i{fmt}} machine instructions.
19942 By default or when @option{-mabs=legacy} is used the legacy
19943 treatment is selected.  In this case these instructions are considered
19944 arithmetic and avoided where correct operation is required and the
19945 input operand might be a NaN.  A longer sequence of instructions that
19946 manipulate the sign bit of floating-point datum manually is used
19947 instead unless the @option{-ffinite-math-only} option has also been
19948 specified.
19950 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
19951 this case these instructions are considered non-arithmetic and therefore
19952 operating correctly in all cases, including in particular where the
19953 input operand is a NaN.  These instructions are therefore always used
19954 for the respective operations.
19956 @item -mnan=2008
19957 @itemx -mnan=legacy
19958 @opindex mnan=2008
19959 @opindex mnan=legacy
19960 These options control the encoding of the special not-a-number (NaN)
19961 IEEE 754 floating-point data.
19963 The @option{-mnan=legacy} option selects the legacy encoding.  In this
19964 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
19965 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
19966 by the first bit of their trailing significand field being 1.
19968 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
19969 this case qNaNs are denoted by the first bit of their trailing
19970 significand field being 1, whereas sNaNs are denoted by the first bit of
19971 their trailing significand field being 0.
19973 The default is @option{-mnan=legacy} unless GCC has been configured with
19974 @option{--with-nan=2008}.
19976 @item -mllsc
19977 @itemx -mno-llsc
19978 @opindex mllsc
19979 @opindex mno-llsc
19980 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
19981 implement atomic memory built-in functions.  When neither option is
19982 specified, GCC uses the instructions if the target architecture
19983 supports them.
19985 @option{-mllsc} is useful if the runtime environment can emulate the
19986 instructions and @option{-mno-llsc} can be useful when compiling for
19987 nonstandard ISAs.  You can make either option the default by
19988 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
19989 respectively.  @option{--with-llsc} is the default for some
19990 configurations; see the installation documentation for details.
19992 @item -mdsp
19993 @itemx -mno-dsp
19994 @opindex mdsp
19995 @opindex mno-dsp
19996 Use (do not use) revision 1 of the MIPS DSP ASE@.
19997 @xref{MIPS DSP Built-in Functions}.  This option defines the
19998 preprocessor macro @code{__mips_dsp}.  It also defines
19999 @code{__mips_dsp_rev} to 1.
20001 @item -mdspr2
20002 @itemx -mno-dspr2
20003 @opindex mdspr2
20004 @opindex mno-dspr2
20005 Use (do not use) revision 2 of the MIPS DSP ASE@.
20006 @xref{MIPS DSP Built-in Functions}.  This option defines the
20007 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20008 It also defines @code{__mips_dsp_rev} to 2.
20010 @item -msmartmips
20011 @itemx -mno-smartmips
20012 @opindex msmartmips
20013 @opindex mno-smartmips
20014 Use (do not use) the MIPS SmartMIPS ASE.
20016 @item -mpaired-single
20017 @itemx -mno-paired-single
20018 @opindex mpaired-single
20019 @opindex mno-paired-single
20020 Use (do not use) paired-single floating-point instructions.
20021 @xref{MIPS Paired-Single Support}.  This option requires
20022 hardware floating-point support to be enabled.
20024 @item -mdmx
20025 @itemx -mno-mdmx
20026 @opindex mdmx
20027 @opindex mno-mdmx
20028 Use (do not use) MIPS Digital Media Extension instructions.
20029 This option can only be used when generating 64-bit code and requires
20030 hardware floating-point support to be enabled.
20032 @item -mips3d
20033 @itemx -mno-mips3d
20034 @opindex mips3d
20035 @opindex mno-mips3d
20036 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20037 The option @option{-mips3d} implies @option{-mpaired-single}.
20039 @item -mmicromips
20040 @itemx -mno-micromips
20041 @opindex mmicromips
20042 @opindex mno-mmicromips
20043 Generate (do not generate) microMIPS code.
20045 MicroMIPS code generation can also be controlled on a per-function basis
20046 by means of @code{micromips} and @code{nomicromips} attributes.
20047 @xref{Function Attributes}, for more information.
20049 @item -mmt
20050 @itemx -mno-mt
20051 @opindex mmt
20052 @opindex mno-mt
20053 Use (do not use) MT Multithreading instructions.
20055 @item -mmcu
20056 @itemx -mno-mcu
20057 @opindex mmcu
20058 @opindex mno-mcu
20059 Use (do not use) the MIPS MCU ASE instructions.
20061 @item -meva
20062 @itemx -mno-eva
20063 @opindex meva
20064 @opindex mno-eva
20065 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20067 @item -mvirt
20068 @itemx -mno-virt
20069 @opindex mvirt
20070 @opindex mno-virt
20071 Use (do not use) the MIPS Virtualization (VZ) instructions.
20073 @item -mxpa
20074 @itemx -mno-xpa
20075 @opindex mxpa
20076 @opindex mno-xpa
20077 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20079 @item -mlong64
20080 @opindex mlong64
20081 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20082 an explanation of the default and the way that the pointer size is
20083 determined.
20085 @item -mlong32
20086 @opindex mlong32
20087 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20089 The default size of @code{int}s, @code{long}s and pointers depends on
20090 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20091 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20092 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20093 or the same size as integer registers, whichever is smaller.
20095 @item -msym32
20096 @itemx -mno-sym32
20097 @opindex msym32
20098 @opindex mno-sym32
20099 Assume (do not assume) that all symbols have 32-bit values, regardless
20100 of the selected ABI@.  This option is useful in combination with
20101 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20102 to generate shorter and faster references to symbolic addresses.
20104 @item -G @var{num}
20105 @opindex G
20106 Put definitions of externally-visible data in a small data section
20107 if that data is no bigger than @var{num} bytes.  GCC can then generate
20108 more efficient accesses to the data; see @option{-mgpopt} for details.
20110 The default @option{-G} option depends on the configuration.
20112 @item -mlocal-sdata
20113 @itemx -mno-local-sdata
20114 @opindex mlocal-sdata
20115 @opindex mno-local-sdata
20116 Extend (do not extend) the @option{-G} behavior to local data too,
20117 such as to static variables in C@.  @option{-mlocal-sdata} is the
20118 default for all configurations.
20120 If the linker complains that an application is using too much small data,
20121 you might want to try rebuilding the less performance-critical parts with
20122 @option{-mno-local-sdata}.  You might also want to build large
20123 libraries with @option{-mno-local-sdata}, so that the libraries leave
20124 more room for the main program.
20126 @item -mextern-sdata
20127 @itemx -mno-extern-sdata
20128 @opindex mextern-sdata
20129 @opindex mno-extern-sdata
20130 Assume (do not assume) that externally-defined data is in
20131 a small data section if the size of that data is within the @option{-G} limit.
20132 @option{-mextern-sdata} is the default for all configurations.
20134 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20135 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20136 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20137 is placed in a small data section.  If @var{Var} is defined by another
20138 module, you must either compile that module with a high-enough
20139 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20140 definition.  If @var{Var} is common, you must link the application
20141 with a high-enough @option{-G} setting.
20143 The easiest way of satisfying these restrictions is to compile
20144 and link every module with the same @option{-G} option.  However,
20145 you may wish to build a library that supports several different
20146 small data limits.  You can do this by compiling the library with
20147 the highest supported @option{-G} setting and additionally using
20148 @option{-mno-extern-sdata} to stop the library from making assumptions
20149 about externally-defined data.
20151 @item -mgpopt
20152 @itemx -mno-gpopt
20153 @opindex mgpopt
20154 @opindex mno-gpopt
20155 Use (do not use) GP-relative accesses for symbols that are known to be
20156 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20157 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20158 configurations.
20160 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20161 might not hold the value of @code{_gp}.  For example, if the code is
20162 part of a library that might be used in a boot monitor, programs that
20163 call boot monitor routines pass an unknown value in @code{$gp}.
20164 (In such situations, the boot monitor itself is usually compiled
20165 with @option{-G0}.)
20167 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20168 @option{-mno-extern-sdata}.
20170 @item -membedded-data
20171 @itemx -mno-embedded-data
20172 @opindex membedded-data
20173 @opindex mno-embedded-data
20174 Allocate variables to the read-only data section first if possible, then
20175 next in the small data section if possible, otherwise in data.  This gives
20176 slightly slower code than the default, but reduces the amount of RAM required
20177 when executing, and thus may be preferred for some embedded systems.
20179 @item -muninit-const-in-rodata
20180 @itemx -mno-uninit-const-in-rodata
20181 @opindex muninit-const-in-rodata
20182 @opindex mno-uninit-const-in-rodata
20183 Put uninitialized @code{const} variables in the read-only data section.
20184 This option is only meaningful in conjunction with @option{-membedded-data}.
20186 @item -mcode-readable=@var{setting}
20187 @opindex mcode-readable
20188 Specify whether GCC may generate code that reads from executable sections.
20189 There are three possible settings:
20191 @table @gcctabopt
20192 @item -mcode-readable=yes
20193 Instructions may freely access executable sections.  This is the
20194 default setting.
20196 @item -mcode-readable=pcrel
20197 MIPS16 PC-relative load instructions can access executable sections,
20198 but other instructions must not do so.  This option is useful on 4KSc
20199 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20200 It is also useful on processors that can be configured to have a dual
20201 instruction/data SRAM interface and that, like the M4K, automatically
20202 redirect PC-relative loads to the instruction RAM.
20204 @item -mcode-readable=no
20205 Instructions must not access executable sections.  This option can be
20206 useful on targets that are configured to have a dual instruction/data
20207 SRAM interface but that (unlike the M4K) do not automatically redirect
20208 PC-relative loads to the instruction RAM.
20209 @end table
20211 @item -msplit-addresses
20212 @itemx -mno-split-addresses
20213 @opindex msplit-addresses
20214 @opindex mno-split-addresses
20215 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20216 relocation operators.  This option has been superseded by
20217 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20219 @item -mexplicit-relocs
20220 @itemx -mno-explicit-relocs
20221 @opindex mexplicit-relocs
20222 @opindex mno-explicit-relocs
20223 Use (do not use) assembler relocation operators when dealing with symbolic
20224 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20225 is to use assembler macros instead.
20227 @option{-mexplicit-relocs} is the default if GCC was configured
20228 to use an assembler that supports relocation operators.
20230 @item -mcheck-zero-division
20231 @itemx -mno-check-zero-division
20232 @opindex mcheck-zero-division
20233 @opindex mno-check-zero-division
20234 Trap (do not trap) on integer division by zero.
20236 The default is @option{-mcheck-zero-division}.
20238 @item -mdivide-traps
20239 @itemx -mdivide-breaks
20240 @opindex mdivide-traps
20241 @opindex mdivide-breaks
20242 MIPS systems check for division by zero by generating either a
20243 conditional trap or a break instruction.  Using traps results in
20244 smaller code, but is only supported on MIPS II and later.  Also, some
20245 versions of the Linux kernel have a bug that prevents trap from
20246 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20247 allow conditional traps on architectures that support them and
20248 @option{-mdivide-breaks} to force the use of breaks.
20250 The default is usually @option{-mdivide-traps}, but this can be
20251 overridden at configure time using @option{--with-divide=breaks}.
20252 Divide-by-zero checks can be completely disabled using
20253 @option{-mno-check-zero-division}.
20255 @item -mload-store-pairs
20256 @itemx -mno-load-store-pairs
20257 @opindex mload-store-pairs
20258 @opindex mno-load-store-pairs
20259 Enable (disable) an optimization that pairs consecutive load or store
20260 instructions to enable load/store bonding.  This option is enabled by
20261 default but only takes effect when the selected architecture is known
20262 to support bonding.
20264 @item -mmemcpy
20265 @itemx -mno-memcpy
20266 @opindex mmemcpy
20267 @opindex mno-memcpy
20268 Force (do not force) the use of @code{memcpy} for non-trivial block
20269 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20270 most constant-sized copies.
20272 @item -mlong-calls
20273 @itemx -mno-long-calls
20274 @opindex mlong-calls
20275 @opindex mno-long-calls
20276 Disable (do not disable) use of the @code{jal} instruction.  Calling
20277 functions using @code{jal} is more efficient but requires the caller
20278 and callee to be in the same 256 megabyte segment.
20280 This option has no effect on abicalls code.  The default is
20281 @option{-mno-long-calls}.
20283 @item -mmad
20284 @itemx -mno-mad
20285 @opindex mmad
20286 @opindex mno-mad
20287 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20288 instructions, as provided by the R4650 ISA@.
20290 @item -mimadd
20291 @itemx -mno-imadd
20292 @opindex mimadd
20293 @opindex mno-imadd
20294 Enable (disable) use of the @code{madd} and @code{msub} integer
20295 instructions.  The default is @option{-mimadd} on architectures
20296 that support @code{madd} and @code{msub} except for the 74k 
20297 architecture where it was found to generate slower code.
20299 @item -mfused-madd
20300 @itemx -mno-fused-madd
20301 @opindex mfused-madd
20302 @opindex mno-fused-madd
20303 Enable (disable) use of the floating-point multiply-accumulate
20304 instructions, when they are available.  The default is
20305 @option{-mfused-madd}.
20307 On the R8000 CPU when multiply-accumulate instructions are used,
20308 the intermediate product is calculated to infinite precision
20309 and is not subject to the FCSR Flush to Zero bit.  This may be
20310 undesirable in some circumstances.  On other processors the result
20311 is numerically identical to the equivalent computation using
20312 separate multiply, add, subtract and negate instructions.
20314 @item -nocpp
20315 @opindex nocpp
20316 Tell the MIPS assembler to not run its preprocessor over user
20317 assembler files (with a @samp{.s} suffix) when assembling them.
20319 @item -mfix-24k
20320 @item -mno-fix-24k
20321 @opindex mfix-24k
20322 @opindex mno-fix-24k
20323 Work around the 24K E48 (lost data on stores during refill) errata.
20324 The workarounds are implemented by the assembler rather than by GCC@.
20326 @item -mfix-r4000
20327 @itemx -mno-fix-r4000
20328 @opindex mfix-r4000
20329 @opindex mno-fix-r4000
20330 Work around certain R4000 CPU errata:
20331 @itemize @minus
20332 @item
20333 A double-word or a variable shift may give an incorrect result if executed
20334 immediately after starting an integer division.
20335 @item
20336 A double-word or a variable shift may give an incorrect result if executed
20337 while an integer multiplication is in progress.
20338 @item
20339 An integer division may give an incorrect result if started in a delay slot
20340 of a taken branch or a jump.
20341 @end itemize
20343 @item -mfix-r4400
20344 @itemx -mno-fix-r4400
20345 @opindex mfix-r4400
20346 @opindex mno-fix-r4400
20347 Work around certain R4400 CPU errata:
20348 @itemize @minus
20349 @item
20350 A double-word or a variable shift may give an incorrect result if executed
20351 immediately after starting an integer division.
20352 @end itemize
20354 @item -mfix-r10000
20355 @itemx -mno-fix-r10000
20356 @opindex mfix-r10000
20357 @opindex mno-fix-r10000
20358 Work around certain R10000 errata:
20359 @itemize @minus
20360 @item
20361 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20362 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20363 @end itemize
20365 This option can only be used if the target architecture supports
20366 branch-likely instructions.  @option{-mfix-r10000} is the default when
20367 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20368 otherwise.
20370 @item -mfix-rm7000
20371 @itemx -mno-fix-rm7000
20372 @opindex mfix-rm7000
20373 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20374 workarounds are implemented by the assembler rather than by GCC@.
20376 @item -mfix-vr4120
20377 @itemx -mno-fix-vr4120
20378 @opindex mfix-vr4120
20379 Work around certain VR4120 errata:
20380 @itemize @minus
20381 @item
20382 @code{dmultu} does not always produce the correct result.
20383 @item
20384 @code{div} and @code{ddiv} do not always produce the correct result if one
20385 of the operands is negative.
20386 @end itemize
20387 The workarounds for the division errata rely on special functions in
20388 @file{libgcc.a}.  At present, these functions are only provided by
20389 the @code{mips64vr*-elf} configurations.
20391 Other VR4120 errata require a NOP to be inserted between certain pairs of
20392 instructions.  These errata are handled by the assembler, not by GCC itself.
20394 @item -mfix-vr4130
20395 @opindex mfix-vr4130
20396 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20397 workarounds are implemented by the assembler rather than by GCC,
20398 although GCC avoids using @code{mflo} and @code{mfhi} if the
20399 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20400 instructions are available instead.
20402 @item -mfix-sb1
20403 @itemx -mno-fix-sb1
20404 @opindex mfix-sb1
20405 Work around certain SB-1 CPU core errata.
20406 (This flag currently works around the SB-1 revision 2
20407 ``F1'' and ``F2'' floating-point errata.)
20409 @item -mr10k-cache-barrier=@var{setting}
20410 @opindex mr10k-cache-barrier
20411 Specify whether GCC should insert cache barriers to avoid the
20412 side-effects of speculation on R10K processors.
20414 In common with many processors, the R10K tries to predict the outcome
20415 of a conditional branch and speculatively executes instructions from
20416 the ``taken'' branch.  It later aborts these instructions if the
20417 predicted outcome is wrong.  However, on the R10K, even aborted
20418 instructions can have side effects.
20420 This problem only affects kernel stores and, depending on the system,
20421 kernel loads.  As an example, a speculatively-executed store may load
20422 the target memory into cache and mark the cache line as dirty, even if
20423 the store itself is later aborted.  If a DMA operation writes to the
20424 same area of memory before the ``dirty'' line is flushed, the cached
20425 data overwrites the DMA-ed data.  See the R10K processor manual
20426 for a full description, including other potential problems.
20428 One workaround is to insert cache barrier instructions before every memory
20429 access that might be speculatively executed and that might have side
20430 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20431 controls GCC's implementation of this workaround.  It assumes that
20432 aborted accesses to any byte in the following regions does not have
20433 side effects:
20435 @enumerate
20436 @item
20437 the memory occupied by the current function's stack frame;
20439 @item
20440 the memory occupied by an incoming stack argument;
20442 @item
20443 the memory occupied by an object with a link-time-constant address.
20444 @end enumerate
20446 It is the kernel's responsibility to ensure that speculative
20447 accesses to these regions are indeed safe.
20449 If the input program contains a function declaration such as:
20451 @smallexample
20452 void foo (void);
20453 @end smallexample
20455 then the implementation of @code{foo} must allow @code{j foo} and
20456 @code{jal foo} to be executed speculatively.  GCC honors this
20457 restriction for functions it compiles itself.  It expects non-GCC
20458 functions (such as hand-written assembly code) to do the same.
20460 The option has three forms:
20462 @table @gcctabopt
20463 @item -mr10k-cache-barrier=load-store
20464 Insert a cache barrier before a load or store that might be
20465 speculatively executed and that might have side effects even
20466 if aborted.
20468 @item -mr10k-cache-barrier=store
20469 Insert a cache barrier before a store that might be speculatively
20470 executed and that might have side effects even if aborted.
20472 @item -mr10k-cache-barrier=none
20473 Disable the insertion of cache barriers.  This is the default setting.
20474 @end table
20476 @item -mflush-func=@var{func}
20477 @itemx -mno-flush-func
20478 @opindex mflush-func
20479 Specifies the function to call to flush the I and D caches, or to not
20480 call any such function.  If called, the function must take the same
20481 arguments as the common @code{_flush_func}, that is, the address of the
20482 memory range for which the cache is being flushed, the size of the
20483 memory range, and the number 3 (to flush both caches).  The default
20484 depends on the target GCC was configured for, but commonly is either
20485 @code{_flush_func} or @code{__cpu_flush}.
20487 @item mbranch-cost=@var{num}
20488 @opindex mbranch-cost
20489 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20490 This cost is only a heuristic and is not guaranteed to produce
20491 consistent results across releases.  A zero cost redundantly selects
20492 the default, which is based on the @option{-mtune} setting.
20494 @item -mbranch-likely
20495 @itemx -mno-branch-likely
20496 @opindex mbranch-likely
20497 @opindex mno-branch-likely
20498 Enable or disable use of Branch Likely instructions, regardless of the
20499 default for the selected architecture.  By default, Branch Likely
20500 instructions may be generated if they are supported by the selected
20501 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20502 and processors that implement those architectures; for those, Branch
20503 Likely instructions are not be generated by default because the MIPS32
20504 and MIPS64 architectures specifically deprecate their use.
20506 @item -mcompact-branches=never
20507 @itemx -mcompact-branches=optimal
20508 @itemx -mcompact-branches=always
20509 @opindex mcompact-branches=never
20510 @opindex mcompact-branches=optimal
20511 @opindex mcompact-branches=always
20512 These options control which form of branches will be generated.  The
20513 default is @option{-mcompact-branches=optimal}.
20515 The @option{-mcompact-branches=never} option ensures that compact branch
20516 instructions will never be generated.
20518 The @option{-mcompact-branches=always} option ensures that a compact
20519 branch instruction will be generated if available.  If a compact branch
20520 instruction is not available, a delay slot form of the branch will be
20521 used instead.
20523 This option is supported from MIPS Release 6 onwards.
20525 The @option{-mcompact-branches=optimal} option will cause a delay slot
20526 branch to be used if one is available in the current ISA and the delay
20527 slot is successfully filled.  If the delay slot is not filled, a compact
20528 branch will be chosen if one is available.
20530 @item -mfp-exceptions
20531 @itemx -mno-fp-exceptions
20532 @opindex mfp-exceptions
20533 Specifies whether FP exceptions are enabled.  This affects how
20534 FP instructions are scheduled for some processors.
20535 The default is that FP exceptions are
20536 enabled.
20538 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20539 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20540 FP pipe.
20542 @item -mvr4130-align
20543 @itemx -mno-vr4130-align
20544 @opindex mvr4130-align
20545 The VR4130 pipeline is two-way superscalar, but can only issue two
20546 instructions together if the first one is 8-byte aligned.  When this
20547 option is enabled, GCC aligns pairs of instructions that it
20548 thinks should execute in parallel.
20550 This option only has an effect when optimizing for the VR4130.
20551 It normally makes code faster, but at the expense of making it bigger.
20552 It is enabled by default at optimization level @option{-O3}.
20554 @item -msynci
20555 @itemx -mno-synci
20556 @opindex msynci
20557 Enable (disable) generation of @code{synci} instructions on
20558 architectures that support it.  The @code{synci} instructions (if
20559 enabled) are generated when @code{__builtin___clear_cache} is
20560 compiled.
20562 This option defaults to @option{-mno-synci}, but the default can be
20563 overridden by configuring GCC with @option{--with-synci}.
20565 When compiling code for single processor systems, it is generally safe
20566 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20567 does not invalidate the instruction caches on all cores and may lead
20568 to undefined behavior.
20570 @item -mrelax-pic-calls
20571 @itemx -mno-relax-pic-calls
20572 @opindex mrelax-pic-calls
20573 Try to turn PIC calls that are normally dispatched via register
20574 @code{$25} into direct calls.  This is only possible if the linker can
20575 resolve the destination at link time and if the destination is within
20576 range for a direct call.
20578 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20579 an assembler and a linker that support the @code{.reloc} assembly
20580 directive and @option{-mexplicit-relocs} is in effect.  With
20581 @option{-mno-explicit-relocs}, this optimization can be performed by the
20582 assembler and the linker alone without help from the compiler.
20584 @item -mmcount-ra-address
20585 @itemx -mno-mcount-ra-address
20586 @opindex mmcount-ra-address
20587 @opindex mno-mcount-ra-address
20588 Emit (do not emit) code that allows @code{_mcount} to modify the
20589 calling function's return address.  When enabled, this option extends
20590 the usual @code{_mcount} interface with a new @var{ra-address}
20591 parameter, which has type @code{intptr_t *} and is passed in register
20592 @code{$12}.  @code{_mcount} can then modify the return address by
20593 doing both of the following:
20594 @itemize
20595 @item
20596 Returning the new address in register @code{$31}.
20597 @item
20598 Storing the new address in @code{*@var{ra-address}},
20599 if @var{ra-address} is nonnull.
20600 @end itemize
20602 The default is @option{-mno-mcount-ra-address}.
20604 @item -mframe-header-opt
20605 @itemx -mno-frame-header-opt
20606 @opindex mframe-header-opt
20607 Enable (disable) frame header optimization in the o32 ABI.  When using the
20608 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20609 function to write out register arguments.  When enabled, this optimization
20610 will suppress the allocation of the frame header if it can be determined that
20611 it is unused.
20613 This optimization is off by default at all optimization levels.
20615 @item -mlxc1-sxc1
20616 @itemx -mno-lxc1-sxc1
20617 @opindex mlxc1-sxc1
20618 When applicable, enable (disable) the generation of @code{lwxc1},
20619 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20621 @item -mmadd4
20622 @itemx -mno-madd4
20623 @opindex mmadd4
20624 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20625 @code{madd.d} and related instructions.  Enabled by default.
20627 @end table
20629 @node MMIX Options
20630 @subsection MMIX Options
20631 @cindex MMIX Options
20633 These options are defined for the MMIX:
20635 @table @gcctabopt
20636 @item -mlibfuncs
20637 @itemx -mno-libfuncs
20638 @opindex mlibfuncs
20639 @opindex mno-libfuncs
20640 Specify that intrinsic library functions are being compiled, passing all
20641 values in registers, no matter the size.
20643 @item -mepsilon
20644 @itemx -mno-epsilon
20645 @opindex mepsilon
20646 @opindex mno-epsilon
20647 Generate floating-point comparison instructions that compare with respect
20648 to the @code{rE} epsilon register.
20650 @item -mabi=mmixware
20651 @itemx -mabi=gnu
20652 @opindex mabi=mmixware
20653 @opindex mabi=gnu
20654 Generate code that passes function parameters and return values that (in
20655 the called function) are seen as registers @code{$0} and up, as opposed to
20656 the GNU ABI which uses global registers @code{$231} and up.
20658 @item -mzero-extend
20659 @itemx -mno-zero-extend
20660 @opindex mzero-extend
20661 @opindex mno-zero-extend
20662 When reading data from memory in sizes shorter than 64 bits, use (do not
20663 use) zero-extending load instructions by default, rather than
20664 sign-extending ones.
20666 @item -mknuthdiv
20667 @itemx -mno-knuthdiv
20668 @opindex mknuthdiv
20669 @opindex mno-knuthdiv
20670 Make the result of a division yielding a remainder have the same sign as
20671 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20672 remainder follows the sign of the dividend.  Both methods are
20673 arithmetically valid, the latter being almost exclusively used.
20675 @item -mtoplevel-symbols
20676 @itemx -mno-toplevel-symbols
20677 @opindex mtoplevel-symbols
20678 @opindex mno-toplevel-symbols
20679 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20680 code can be used with the @code{PREFIX} assembly directive.
20682 @item -melf
20683 @opindex melf
20684 Generate an executable in the ELF format, rather than the default
20685 @samp{mmo} format used by the @command{mmix} simulator.
20687 @item -mbranch-predict
20688 @itemx -mno-branch-predict
20689 @opindex mbranch-predict
20690 @opindex mno-branch-predict
20691 Use (do not use) the probable-branch instructions, when static branch
20692 prediction indicates a probable branch.
20694 @item -mbase-addresses
20695 @itemx -mno-base-addresses
20696 @opindex mbase-addresses
20697 @opindex mno-base-addresses
20698 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20699 base address automatically generates a request (handled by the assembler
20700 and the linker) for a constant to be set up in a global register.  The
20701 register is used for one or more base address requests within the range 0
20702 to 255 from the value held in the register.  The generally leads to short
20703 and fast code, but the number of different data items that can be
20704 addressed is limited.  This means that a program that uses lots of static
20705 data may require @option{-mno-base-addresses}.
20707 @item -msingle-exit
20708 @itemx -mno-single-exit
20709 @opindex msingle-exit
20710 @opindex mno-single-exit
20711 Force (do not force) generated code to have a single exit point in each
20712 function.
20713 @end table
20715 @node MN10300 Options
20716 @subsection MN10300 Options
20717 @cindex MN10300 options
20719 These @option{-m} options are defined for Matsushita MN10300 architectures:
20721 @table @gcctabopt
20722 @item -mmult-bug
20723 @opindex mmult-bug
20724 Generate code to avoid bugs in the multiply instructions for the MN10300
20725 processors.  This is the default.
20727 @item -mno-mult-bug
20728 @opindex mno-mult-bug
20729 Do not generate code to avoid bugs in the multiply instructions for the
20730 MN10300 processors.
20732 @item -mam33
20733 @opindex mam33
20734 Generate code using features specific to the AM33 processor.
20736 @item -mno-am33
20737 @opindex mno-am33
20738 Do not generate code using features specific to the AM33 processor.  This
20739 is the default.
20741 @item -mam33-2
20742 @opindex mam33-2
20743 Generate code using features specific to the AM33/2.0 processor.
20745 @item -mam34
20746 @opindex mam34
20747 Generate code using features specific to the AM34 processor.
20749 @item -mtune=@var{cpu-type}
20750 @opindex mtune
20751 Use the timing characteristics of the indicated CPU type when
20752 scheduling instructions.  This does not change the targeted processor
20753 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20754 @samp{am33-2} or @samp{am34}.
20756 @item -mreturn-pointer-on-d0
20757 @opindex mreturn-pointer-on-d0
20758 When generating a function that returns a pointer, return the pointer
20759 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20760 only in @code{a0}, and attempts to call such functions without a prototype
20761 result in errors.  Note that this option is on by default; use
20762 @option{-mno-return-pointer-on-d0} to disable it.
20764 @item -mno-crt0
20765 @opindex mno-crt0
20766 Do not link in the C run-time initialization object file.
20768 @item -mrelax
20769 @opindex mrelax
20770 Indicate to the linker that it should perform a relaxation optimization pass
20771 to shorten branches, calls and absolute memory addresses.  This option only
20772 has an effect when used on the command line for the final link step.
20774 This option makes symbolic debugging impossible.
20776 @item -mliw
20777 @opindex mliw
20778 Allow the compiler to generate @emph{Long Instruction Word}
20779 instructions if the target is the @samp{AM33} or later.  This is the
20780 default.  This option defines the preprocessor macro @code{__LIW__}.
20782 @item -mnoliw
20783 @opindex mnoliw
20784 Do not allow the compiler to generate @emph{Long Instruction Word}
20785 instructions.  This option defines the preprocessor macro
20786 @code{__NO_LIW__}.
20788 @item -msetlb
20789 @opindex msetlb
20790 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20791 instructions if the target is the @samp{AM33} or later.  This is the
20792 default.  This option defines the preprocessor macro @code{__SETLB__}.
20794 @item -mnosetlb
20795 @opindex mnosetlb
20796 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20797 instructions.  This option defines the preprocessor macro
20798 @code{__NO_SETLB__}.
20800 @end table
20802 @node Moxie Options
20803 @subsection Moxie Options
20804 @cindex Moxie Options
20806 @table @gcctabopt
20808 @item -meb
20809 @opindex meb
20810 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20811 configurations.
20813 @item -mel
20814 @opindex mel
20815 Generate little-endian code.
20817 @item -mmul.x
20818 @opindex mmul.x
20819 Generate mul.x and umul.x instructions.  This is the default for
20820 @samp{moxiebox-*-*} configurations.
20822 @item -mno-crt0
20823 @opindex mno-crt0
20824 Do not link in the C run-time initialization object file.
20826 @end table
20828 @node MSP430 Options
20829 @subsection MSP430 Options
20830 @cindex MSP430 Options
20832 These options are defined for the MSP430:
20834 @table @gcctabopt
20836 @item -masm-hex
20837 @opindex masm-hex
20838 Force assembly output to always use hex constants.  Normally such
20839 constants are signed decimals, but this option is available for
20840 testsuite and/or aesthetic purposes.
20842 @item -mmcu=
20843 @opindex mmcu=
20844 Select the MCU to target.  This is used to create a C preprocessor
20845 symbol based upon the MCU name, converted to upper case and pre- and
20846 post-fixed with @samp{__}.  This in turn is used by the
20847 @file{msp430.h} header file to select an MCU-specific supplementary
20848 header file.
20850 The option also sets the ISA to use.  If the MCU name is one that is
20851 known to only support the 430 ISA then that is selected, otherwise the
20852 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20853 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20854 name selects the 430X ISA.
20856 In addition an MCU-specific linker script is added to the linker
20857 command line.  The script's name is the name of the MCU with
20858 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20859 command line defines the C preprocessor symbol @code{__XXX__} and
20860 cause the linker to search for a script called @file{xxx.ld}.
20862 This option is also passed on to the assembler.
20864 @item -mwarn-mcu
20865 @itemx -mno-warn-mcu
20866 @opindex mwarn-mcu
20867 @opindex mno-warn-mcu
20868 This option enables or disables warnings about conflicts between the
20869 MCU name specified by the @option{-mmcu} option and the ISA set by the
20870 @option{-mcpu} option and/or the hardware multiply support set by the
20871 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20872 MCU names.  This option is on by default.
20874 @item -mcpu=
20875 @opindex mcpu=
20876 Specifies the ISA to use.  Accepted values are @samp{msp430},
20877 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20878 @option{-mmcu=} option should be used to select the ISA.
20880 @item -msim
20881 @opindex msim
20882 Link to the simulator runtime libraries and linker script.  Overrides
20883 any scripts that would be selected by the @option{-mmcu=} option.
20885 @item -mlarge
20886 @opindex mlarge
20887 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20889 @item -msmall
20890 @opindex msmall
20891 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20893 @item -mrelax
20894 @opindex mrelax
20895 This option is passed to the assembler and linker, and allows the
20896 linker to perform certain optimizations that cannot be done until
20897 the final link.
20899 @item mhwmult=
20900 @opindex mhwmult=
20901 Describes the type of hardware multiply supported by the target.
20902 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20903 for the original 16-bit-only multiply supported by early MCUs.
20904 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20905 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20906 A value of @samp{auto} can also be given.  This tells GCC to deduce
20907 the hardware multiply support based upon the MCU name provided by the
20908 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20909 the MCU name is not recognized then no hardware multiply support is
20910 assumed.  @code{auto} is the default setting.
20912 Hardware multiplies are normally performed by calling a library
20913 routine.  This saves space in the generated code.  When compiling at
20914 @option{-O3} or higher however the hardware multiplier is invoked
20915 inline.  This makes for bigger, but faster code.
20917 The hardware multiply routines disable interrupts whilst running and
20918 restore the previous interrupt state when they finish.  This makes
20919 them safe to use inside interrupt handlers as well as in normal code.
20921 @item -minrt
20922 @opindex minrt
20923 Enable the use of a minimum runtime environment - no static
20924 initializers or constructors.  This is intended for memory-constrained
20925 devices.  The compiler includes special symbols in some objects
20926 that tell the linker and runtime which code fragments are required.
20928 @item -mcode-region=
20929 @itemx -mdata-region=
20930 @opindex mcode-region
20931 @opindex mdata-region
20932 These options tell the compiler where to place functions and data that
20933 do not have one of the @code{lower}, @code{upper}, @code{either} or
20934 @code{section} attributes.  Possible values are @code{lower},
20935 @code{upper}, @code{either} or @code{any}.  The first three behave
20936 like the corresponding attribute.  The fourth possible value -
20937 @code{any} - is the default.  It leaves placement entirely up to the
20938 linker script and how it assigns the standard sections
20939 (@code{.text}, @code{.data}, etc) to the memory regions.
20941 @item -msilicon-errata=
20942 @opindex msilicon-errata
20943 This option passes on a request to assembler to enable the fixes for
20944 the named silicon errata.
20946 @item -msilicon-errata-warn=
20947 @opindex msilicon-errata-warn
20948 This option passes on a request to the assembler to enable warning
20949 messages when a silicon errata might need to be applied.
20951 @end table
20953 @node NDS32 Options
20954 @subsection NDS32 Options
20955 @cindex NDS32 Options
20957 These options are defined for NDS32 implementations:
20959 @table @gcctabopt
20961 @item -mbig-endian
20962 @opindex mbig-endian
20963 Generate code in big-endian mode.
20965 @item -mlittle-endian
20966 @opindex mlittle-endian
20967 Generate code in little-endian mode.
20969 @item -mreduced-regs
20970 @opindex mreduced-regs
20971 Use reduced-set registers for register allocation.
20973 @item -mfull-regs
20974 @opindex mfull-regs
20975 Use full-set registers for register allocation.
20977 @item -mcmov
20978 @opindex mcmov
20979 Generate conditional move instructions.
20981 @item -mno-cmov
20982 @opindex mno-cmov
20983 Do not generate conditional move instructions.
20985 @item -mperf-ext
20986 @opindex mperf-ext
20987 Generate performance extension instructions.
20989 @item -mno-perf-ext
20990 @opindex mno-perf-ext
20991 Do not generate performance extension instructions.
20993 @item -mv3push
20994 @opindex mv3push
20995 Generate v3 push25/pop25 instructions.
20997 @item -mno-v3push
20998 @opindex mno-v3push
20999 Do not generate v3 push25/pop25 instructions.
21001 @item -m16-bit
21002 @opindex m16-bit
21003 Generate 16-bit instructions.
21005 @item -mno-16-bit
21006 @opindex mno-16-bit
21007 Do not generate 16-bit instructions.
21009 @item -misr-vector-size=@var{num}
21010 @opindex misr-vector-size
21011 Specify the size of each interrupt vector, which must be 4 or 16.
21013 @item -mcache-block-size=@var{num}
21014 @opindex mcache-block-size
21015 Specify the size of each cache block,
21016 which must be a power of 2 between 4 and 512.
21018 @item -march=@var{arch}
21019 @opindex march
21020 Specify the name of the target architecture.
21022 @item -mcmodel=@var{code-model}
21023 @opindex mcmodel
21024 Set the code model to one of
21025 @table @asis
21026 @item @samp{small}
21027 All the data and read-only data segments must be within 512KB addressing space.
21028 The text segment must be within 16MB addressing space.
21029 @item @samp{medium}
21030 The data segment must be within 512KB while the read-only data segment can be
21031 within 4GB addressing space.  The text segment should be still within 16MB
21032 addressing space.
21033 @item @samp{large}
21034 All the text and data segments can be within 4GB addressing space.
21035 @end table
21037 @item -mctor-dtor
21038 @opindex mctor-dtor
21039 Enable constructor/destructor feature.
21041 @item -mrelax
21042 @opindex mrelax
21043 Guide linker to relax instructions.
21045 @end table
21047 @node Nios II Options
21048 @subsection Nios II Options
21049 @cindex Nios II options
21050 @cindex Altera Nios II options
21052 These are the options defined for the Altera Nios II processor.
21054 @table @gcctabopt
21056 @item -G @var{num}
21057 @opindex G
21058 @cindex smaller data references
21059 Put global and static objects less than or equal to @var{num} bytes
21060 into the small data or BSS sections instead of the normal data or BSS
21061 sections.  The default value of @var{num} is 8.
21063 @item -mgpopt=@var{option}
21064 @item -mgpopt
21065 @itemx -mno-gpopt
21066 @opindex mgpopt
21067 @opindex mno-gpopt
21068 Generate (do not generate) GP-relative accesses.  The following 
21069 @var{option} names are recognized:
21071 @table @samp
21073 @item none
21074 Do not generate GP-relative accesses.
21076 @item local
21077 Generate GP-relative accesses for small data objects that are not 
21078 external, weak, or uninitialized common symbols.  
21079 Also use GP-relative addressing for objects that
21080 have been explicitly placed in a small data section via a @code{section}
21081 attribute.
21083 @item global
21084 As for @samp{local}, but also generate GP-relative accesses for
21085 small data objects that are external, weak, or common.  If you use this option,
21086 you must ensure that all parts of your program (including libraries) are
21087 compiled with the same @option{-G} setting.
21089 @item data
21090 Generate GP-relative accesses for all data objects in the program.  If you
21091 use this option, the entire data and BSS segments
21092 of your program must fit in 64K of memory and you must use an appropriate
21093 linker script to allocate them within the addressable range of the
21094 global pointer.
21096 @item all
21097 Generate GP-relative addresses for function pointers as well as data
21098 pointers.  If you use this option, the entire text, data, and BSS segments
21099 of your program must fit in 64K of memory and you must use an appropriate
21100 linker script to allocate them within the addressable range of the
21101 global pointer.
21103 @end table
21105 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21106 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21108 The default is @option{-mgpopt} except when @option{-fpic} or
21109 @option{-fPIC} is specified to generate position-independent code.
21110 Note that the Nios II ABI does not permit GP-relative accesses from
21111 shared libraries.
21113 You may need to specify @option{-mno-gpopt} explicitly when building
21114 programs that include large amounts of small data, including large
21115 GOT data sections.  In this case, the 16-bit offset for GP-relative
21116 addressing may not be large enough to allow access to the entire 
21117 small data section.
21119 @item -mel
21120 @itemx -meb
21121 @opindex mel
21122 @opindex meb
21123 Generate little-endian (default) or big-endian (experimental) code,
21124 respectively.
21126 @item -march=@var{arch}
21127 @opindex march
21128 This specifies the name of the target Nios II architecture.  GCC uses this
21129 name to determine what kind of instructions it can emit when generating
21130 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21132 The preprocessor macro @code{__nios2_arch__} is available to programs,
21133 with value 1 or 2, indicating the targeted ISA level.
21135 @item -mbypass-cache
21136 @itemx -mno-bypass-cache
21137 @opindex mno-bypass-cache
21138 @opindex mbypass-cache
21139 Force all load and store instructions to always bypass cache by 
21140 using I/O variants of the instructions. The default is not to
21141 bypass the cache.
21143 @item -mno-cache-volatile 
21144 @itemx -mcache-volatile       
21145 @opindex mcache-volatile 
21146 @opindex mno-cache-volatile
21147 Volatile memory access bypass the cache using the I/O variants of 
21148 the load and store instructions. The default is not to bypass the cache.
21150 @item -mno-fast-sw-div
21151 @itemx -mfast-sw-div
21152 @opindex mno-fast-sw-div
21153 @opindex mfast-sw-div
21154 Do not use table-based fast divide for small numbers. The default 
21155 is to use the fast divide at @option{-O3} and above.
21157 @item -mno-hw-mul
21158 @itemx -mhw-mul
21159 @itemx -mno-hw-mulx
21160 @itemx -mhw-mulx
21161 @itemx -mno-hw-div
21162 @itemx -mhw-div
21163 @opindex mno-hw-mul
21164 @opindex mhw-mul
21165 @opindex mno-hw-mulx
21166 @opindex mhw-mulx
21167 @opindex mno-hw-div
21168 @opindex mhw-div
21169 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21170 instructions by the compiler. The default is to emit @code{mul}
21171 and not emit @code{div} and @code{mulx}.
21173 @item -mbmx
21174 @itemx -mno-bmx
21175 @itemx -mcdx
21176 @itemx -mno-cdx
21177 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21178 CDX (code density) instructions.  Enabling these instructions also
21179 requires @option{-march=r2}.  Since these instructions are optional
21180 extensions to the R2 architecture, the default is not to emit them.
21182 @item -mcustom-@var{insn}=@var{N}
21183 @itemx -mno-custom-@var{insn}
21184 @opindex mcustom-@var{insn}
21185 @opindex mno-custom-@var{insn}
21186 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21187 custom instruction with encoding @var{N} when generating code that uses 
21188 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21189 instruction 253 for single-precision floating-point add operations instead
21190 of the default behavior of using a library call.
21192 The following values of @var{insn} are supported.  Except as otherwise
21193 noted, floating-point operations are expected to be implemented with
21194 normal IEEE 754 semantics and correspond directly to the C operators or the
21195 equivalent GCC built-in functions (@pxref{Other Builtins}).
21197 Single-precision floating point:
21198 @table @asis
21200 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21201 Binary arithmetic operations.
21203 @item @samp{fnegs}
21204 Unary negation.
21206 @item @samp{fabss}
21207 Unary absolute value.
21209 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21210 Comparison operations.
21212 @item @samp{fmins}, @samp{fmaxs}
21213 Floating-point minimum and maximum.  These instructions are only
21214 generated if @option{-ffinite-math-only} is specified.
21216 @item @samp{fsqrts}
21217 Unary square root operation.
21219 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21220 Floating-point trigonometric and exponential functions.  These instructions
21221 are only generated if @option{-funsafe-math-optimizations} is also specified.
21223 @end table
21225 Double-precision floating point:
21226 @table @asis
21228 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21229 Binary arithmetic operations.
21231 @item @samp{fnegd}
21232 Unary negation.
21234 @item @samp{fabsd}
21235 Unary absolute value.
21237 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21238 Comparison operations.
21240 @item @samp{fmind}, @samp{fmaxd}
21241 Double-precision minimum and maximum.  These instructions are only
21242 generated if @option{-ffinite-math-only} is specified.
21244 @item @samp{fsqrtd}
21245 Unary square root operation.
21247 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21248 Double-precision trigonometric and exponential functions.  These instructions
21249 are only generated if @option{-funsafe-math-optimizations} is also specified.
21251 @end table
21253 Conversions:
21254 @table @asis
21255 @item @samp{fextsd}
21256 Conversion from single precision to double precision.
21258 @item @samp{ftruncds}
21259 Conversion from double precision to single precision.
21261 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21262 Conversion from floating point to signed or unsigned integer types, with
21263 truncation towards zero.
21265 @item @samp{round}
21266 Conversion from single-precision floating point to signed integer,
21267 rounding to the nearest integer and ties away from zero.
21268 This corresponds to the @code{__builtin_lroundf} function when
21269 @option{-fno-math-errno} is used.
21271 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21272 Conversion from signed or unsigned integer types to floating-point types.
21274 @end table
21276 In addition, all of the following transfer instructions for internal
21277 registers X and Y must be provided to use any of the double-precision
21278 floating-point instructions.  Custom instructions taking two
21279 double-precision source operands expect the first operand in the
21280 64-bit register X.  The other operand (or only operand of a unary
21281 operation) is given to the custom arithmetic instruction with the
21282 least significant half in source register @var{src1} and the most
21283 significant half in @var{src2}.  A custom instruction that returns a
21284 double-precision result returns the most significant 32 bits in the
21285 destination register and the other half in 32-bit register Y.  
21286 GCC automatically generates the necessary code sequences to write
21287 register X and/or read register Y when double-precision floating-point
21288 instructions are used.
21290 @table @asis
21292 @item @samp{fwrx}
21293 Write @var{src1} into the least significant half of X and @var{src2} into
21294 the most significant half of X.
21296 @item @samp{fwry}
21297 Write @var{src1} into Y.
21299 @item @samp{frdxhi}, @samp{frdxlo}
21300 Read the most or least (respectively) significant half of X and store it in
21301 @var{dest}.
21303 @item @samp{frdy}
21304 Read the value of Y and store it into @var{dest}.
21305 @end table
21307 Note that you can gain more local control over generation of Nios II custom
21308 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21309 and @code{target("no-custom-@var{insn}")} function attributes
21310 (@pxref{Function Attributes})
21311 or pragmas (@pxref{Function Specific Option Pragmas}).
21313 @item -mcustom-fpu-cfg=@var{name}
21314 @opindex mcustom-fpu-cfg
21316 This option enables a predefined, named set of custom instruction encodings
21317 (see @option{-mcustom-@var{insn}} above).  
21318 Currently, the following sets are defined:
21320 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21321 @gccoptlist{-mcustom-fmuls=252 @gol
21322 -mcustom-fadds=253 @gol
21323 -mcustom-fsubs=254 @gol
21324 -fsingle-precision-constant}
21326 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21327 @gccoptlist{-mcustom-fmuls=252 @gol
21328 -mcustom-fadds=253 @gol
21329 -mcustom-fsubs=254 @gol
21330 -mcustom-fdivs=255 @gol
21331 -fsingle-precision-constant}
21333 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21334 @gccoptlist{-mcustom-floatus=243 @gol
21335 -mcustom-fixsi=244 @gol
21336 -mcustom-floatis=245 @gol
21337 -mcustom-fcmpgts=246 @gol
21338 -mcustom-fcmples=249 @gol
21339 -mcustom-fcmpeqs=250 @gol
21340 -mcustom-fcmpnes=251 @gol
21341 -mcustom-fmuls=252 @gol
21342 -mcustom-fadds=253 @gol
21343 -mcustom-fsubs=254 @gol
21344 -mcustom-fdivs=255 @gol
21345 -fsingle-precision-constant}
21347 Custom instruction assignments given by individual
21348 @option{-mcustom-@var{insn}=} options override those given by
21349 @option{-mcustom-fpu-cfg=}, regardless of the
21350 order of the options on the command line.
21352 Note that you can gain more local control over selection of a FPU
21353 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21354 function attribute (@pxref{Function Attributes})
21355 or pragma (@pxref{Function Specific Option Pragmas}).
21357 @end table
21359 These additional @samp{-m} options are available for the Altera Nios II
21360 ELF (bare-metal) target:
21362 @table @gcctabopt
21364 @item -mhal
21365 @opindex mhal
21366 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21367 startup and termination code, and is typically used in conjunction with
21368 @option{-msys-crt0=} to specify the location of the alternate startup code
21369 provided by the HAL BSP.
21371 @item -msmallc
21372 @opindex msmallc
21373 Link with a limited version of the C library, @option{-lsmallc}, rather than
21374 Newlib.
21376 @item -msys-crt0=@var{startfile}
21377 @opindex msys-crt0
21378 @var{startfile} is the file name of the startfile (crt0) to use 
21379 when linking.  This option is only useful in conjunction with @option{-mhal}.
21381 @item -msys-lib=@var{systemlib}
21382 @opindex msys-lib
21383 @var{systemlib} is the library name of the library that provides
21384 low-level system calls required by the C library,
21385 e.g. @code{read} and @code{write}.
21386 This option is typically used to link with a library provided by a HAL BSP.
21388 @end table
21390 @node Nvidia PTX Options
21391 @subsection Nvidia PTX Options
21392 @cindex Nvidia PTX options
21393 @cindex nvptx options
21395 These options are defined for Nvidia PTX:
21397 @table @gcctabopt
21399 @item -m32
21400 @itemx -m64
21401 @opindex m32
21402 @opindex m64
21403 Generate code for 32-bit or 64-bit ABI.
21405 @item -mmainkernel
21406 @opindex mmainkernel
21407 Link in code for a __main kernel.  This is for stand-alone instead of
21408 offloading execution.
21410 @item -moptimize
21411 @opindex moptimize
21412 Apply partitioned execution optimizations.  This is the default when any
21413 level of optimization is selected.
21415 @item -msoft-stack
21416 @opindex msoft-stack
21417 Generate code that does not use @code{.local} memory
21418 directly for stack storage. Instead, a per-warp stack pointer is
21419 maintained explicitly. This enables variable-length stack allocation (with
21420 variable-length arrays or @code{alloca}), and when global memory is used for
21421 underlying storage, makes it possible to access automatic variables from other
21422 threads, or with atomic instructions. This code generation variant is used
21423 for OpenMP offloading, but the option is exposed on its own for the purpose
21424 of testing the compiler; to generate code suitable for linking into programs
21425 using OpenMP offloading, use option @option{-mgomp}.
21427 @item -muniform-simt
21428 @opindex muniform-simt
21429 Switch to code generation variant that allows to execute all threads in each
21430 warp, while maintaining memory state and side effects as if only one thread
21431 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21432 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21433 current lane index equals the master lane index), and the register being
21434 assigned is copied via a shuffle instruction from the master lane.  Outside of
21435 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21436 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21437 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21438 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21439 with current lane index to compute the master lane index.
21441 @item -mgomp
21442 @opindex mgomp
21443 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21444 @option{-muniform-simt} options, and selects corresponding multilib variant.
21446 @end table
21448 @node PDP-11 Options
21449 @subsection PDP-11 Options
21450 @cindex PDP-11 Options
21452 These options are defined for the PDP-11:
21454 @table @gcctabopt
21455 @item -mfpu
21456 @opindex mfpu
21457 Use hardware FPP floating point.  This is the default.  (FIS floating
21458 point on the PDP-11/40 is not supported.)
21460 @item -msoft-float
21461 @opindex msoft-float
21462 Do not use hardware floating point.
21464 @item -mac0
21465 @opindex mac0
21466 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21468 @item -mno-ac0
21469 @opindex mno-ac0
21470 Return floating-point results in memory.  This is the default.
21472 @item -m40
21473 @opindex m40
21474 Generate code for a PDP-11/40.
21476 @item -m45
21477 @opindex m45
21478 Generate code for a PDP-11/45.  This is the default.
21480 @item -m10
21481 @opindex m10
21482 Generate code for a PDP-11/10.
21484 @item -mbcopy-builtin
21485 @opindex mbcopy-builtin
21486 Use inline @code{movmemhi} patterns for copying memory.  This is the
21487 default.
21489 @item -mbcopy
21490 @opindex mbcopy
21491 Do not use inline @code{movmemhi} patterns for copying memory.
21493 @item -mint16
21494 @itemx -mno-int32
21495 @opindex mint16
21496 @opindex mno-int32
21497 Use 16-bit @code{int}.  This is the default.
21499 @item -mint32
21500 @itemx -mno-int16
21501 @opindex mint32
21502 @opindex mno-int16
21503 Use 32-bit @code{int}.
21505 @item -mfloat64
21506 @itemx -mno-float32
21507 @opindex mfloat64
21508 @opindex mno-float32
21509 Use 64-bit @code{float}.  This is the default.
21511 @item -mfloat32
21512 @itemx -mno-float64
21513 @opindex mfloat32
21514 @opindex mno-float64
21515 Use 32-bit @code{float}.
21517 @item -mabshi
21518 @opindex mabshi
21519 Use @code{abshi2} pattern.  This is the default.
21521 @item -mno-abshi
21522 @opindex mno-abshi
21523 Do not use @code{abshi2} pattern.
21525 @item -mbranch-expensive
21526 @opindex mbranch-expensive
21527 Pretend that branches are expensive.  This is for experimenting with
21528 code generation only.
21530 @item -mbranch-cheap
21531 @opindex mbranch-cheap
21532 Do not pretend that branches are expensive.  This is the default.
21534 @item -munix-asm
21535 @opindex munix-asm
21536 Use Unix assembler syntax.  This is the default when configured for
21537 @samp{pdp11-*-bsd}.
21539 @item -mdec-asm
21540 @opindex mdec-asm
21541 Use DEC assembler syntax.  This is the default when configured for any
21542 PDP-11 target other than @samp{pdp11-*-bsd}.
21543 @end table
21545 @node picoChip Options
21546 @subsection picoChip Options
21547 @cindex picoChip options
21549 These @samp{-m} options are defined for picoChip implementations:
21551 @table @gcctabopt
21553 @item -mae=@var{ae_type}
21554 @opindex mcpu
21555 Set the instruction set, register set, and instruction scheduling
21556 parameters for array element type @var{ae_type}.  Supported values
21557 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21559 @option{-mae=ANY} selects a completely generic AE type.  Code
21560 generated with this option runs on any of the other AE types.  The
21561 code is not as efficient as it would be if compiled for a specific
21562 AE type, and some types of operation (e.g., multiplication) do not
21563 work properly on all types of AE.
21565 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21566 for compiled code, and is the default.
21568 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21569 option may suffer from poor performance of byte (char) manipulation,
21570 since the DSP AE does not provide hardware support for byte load/stores.
21572 @item -msymbol-as-address
21573 Enable the compiler to directly use a symbol name as an address in a
21574 load/store instruction, without first loading it into a
21575 register.  Typically, the use of this option generates larger
21576 programs, which run faster than when the option isn't used.  However, the
21577 results vary from program to program, so it is left as a user option,
21578 rather than being permanently enabled.
21580 @item -mno-inefficient-warnings
21581 Disables warnings about the generation of inefficient code.  These
21582 warnings can be generated, for example, when compiling code that
21583 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21584 no hardware support for byte-level memory operations, so all byte
21585 load/stores must be synthesized from word load/store operations.  This is
21586 inefficient and a warning is generated to indicate
21587 that you should rewrite the code to avoid byte operations, or to target
21588 an AE type that has the necessary hardware support.  This option disables
21589 these warnings.
21591 @end table
21593 @node PowerPC Options
21594 @subsection PowerPC Options
21595 @cindex PowerPC options
21597 These are listed under @xref{RS/6000 and PowerPC Options}.
21599 @node RISC-V Options
21600 @subsection RISC-V Options
21601 @cindex RISC-V Options
21603 These command-line options are defined for RISC-V targets:
21605 @table @gcctabopt
21606 @item -mbranch-cost=@var{n}
21607 @opindex mbranch-cost
21608 Set the cost of branches to roughly @var{n} instructions.
21610 @item -mmemcpy
21611 @itemx -mno-memcpy
21612 @opindex mmemcpy
21613 Don't optimize block moves.
21615 @item -mplt
21616 @itemx -mno-plt
21617 @opindex plt
21618 When generating PIC code, allow the use of PLTs. Ignored for non-PIC.
21620 @item -mabi=@var{ABI-string}
21621 @opindex mabi
21622 Specify integer and floating-point calling convention.  This defaults to the
21623 natural calling convention: e.g.@ LP64 for RV64I, ILP32 for RV32I, LP64D for
21624 RV64G.
21626 @item -mfdiv
21627 @itemx -mno-fdiv
21628 @opindex mfdiv
21629 Use hardware floating-point divide and square root instructions.  This requires
21630 the F or D extensions for floating-point registers.
21632 @item -mdiv
21633 @itemx -mno-div
21634 @opindex mdiv
21635 Use hardware instructions for integer division.  This requires the M extension.
21637 @item -march=@var{ISA-string}
21638 @opindex march
21639 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21640 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21642 @item -mtune=@var{processor-string}
21643 @opindex mtune
21644 Optimize the output for the given processor, specified by microarchitecture
21645 name.
21647 @item -msmall-data-limit=@var{n}
21648 @opindex msmall-data-limit
21649 Put global and static data smaller than @var{n} bytes into a special section
21650 (on some targets).
21652 @item -msave-restore
21653 @itemx -mno-save-restore
21654 @opindex msave-restore
21655 Use smaller but slower prologue and epilogue code.
21657 @item -mstrict-align
21658 @itemx -mno-strict-align
21659 @opindex mstrict-align
21660 Do not generate unaligned memory accesses.
21662 @item -mcmodel=@var{code-model}
21663 @opindex mcmodel
21664 Specify the code model.
21666 @end table
21668 @node RL78 Options
21669 @subsection RL78 Options
21670 @cindex RL78 Options
21672 @table @gcctabopt
21674 @item -msim
21675 @opindex msim
21676 Links in additional target libraries to support operation within a
21677 simulator.
21679 @item -mmul=none
21680 @itemx -mmul=g10
21681 @itemx -mmul=g13
21682 @itemx -mmul=g14
21683 @itemx -mmul=rl78
21684 @opindex mmul
21685 Specifies the type of hardware multiplication and division support to
21686 be used.  The simplest is @code{none}, which uses software for both
21687 multiplication and division.  This is the default.  The @code{g13}
21688 value is for the hardware multiply/divide peripheral found on the
21689 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
21690 the multiplication and division instructions supported by the RL78/G14
21691 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
21692 the value @code{mg10} is an alias for @code{none}.
21694 In addition a C preprocessor macro is defined, based upon the setting
21695 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
21696 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
21698 @item -mcpu=g10
21699 @itemx -mcpu=g13
21700 @itemx -mcpu=g14
21701 @itemx -mcpu=rl78
21702 @opindex mcpu
21703 Specifies the RL78 core to target.  The default is the G14 core, also
21704 known as an S3 core or just RL78.  The G13 or S2 core does not have
21705 multiply or divide instructions, instead it uses a hardware peripheral
21706 for these operations.  The G10 or S1 core does not have register
21707 banks, so it uses a different calling convention.
21709 If this option is set it also selects the type of hardware multiply
21710 support to use, unless this is overridden by an explicit
21711 @option{-mmul=none} option on the command line.  Thus specifying
21712 @option{-mcpu=g13} enables the use of the G13 hardware multiply
21713 peripheral and specifying @option{-mcpu=g10} disables the use of
21714 hardware multiplications altogether.
21716 Note, although the RL78/G14 core is the default target, specifying
21717 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
21718 change the behavior of the toolchain since it also enables G14
21719 hardware multiply support.  If these options are not specified on the
21720 command line then software multiplication routines will be used even
21721 though the code targets the RL78 core.  This is for backwards
21722 compatibility with older toolchains which did not have hardware
21723 multiply and divide support.
21725 In addition a C preprocessor macro is defined, based upon the setting
21726 of this option.  Possible values are: @code{__RL78_G10__},
21727 @code{__RL78_G13__} or @code{__RL78_G14__}.
21729 @item -mg10
21730 @itemx -mg13
21731 @itemx -mg14
21732 @itemx -mrl78
21733 @opindex mg10
21734 @opindex mg13
21735 @opindex mg14
21736 @opindex mrl78
21737 These are aliases for the corresponding @option{-mcpu=} option.  They
21738 are provided for backwards compatibility.
21740 @item -mallregs
21741 @opindex mallregs
21742 Allow the compiler to use all of the available registers.  By default
21743 registers @code{r24..r31} are reserved for use in interrupt handlers.
21744 With this option enabled these registers can be used in ordinary
21745 functions as well.
21747 @item -m64bit-doubles
21748 @itemx -m32bit-doubles
21749 @opindex m64bit-doubles
21750 @opindex m32bit-doubles
21751 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21752 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21753 @option{-m32bit-doubles}.
21755 @item -msave-mduc-in-interrupts
21756 @item -mno-save-mduc-in-interrupts
21757 @opindex msave-mduc-in-interrupts
21758 @opindex mno-save-mduc-in-interrupts
21759 Specifies that interrupt handler functions should preserve the
21760 MDUC registers.  This is only necessary if normal code might use
21761 the MDUC registers, for example because it performs multiplication
21762 and division operations.  The default is to ignore the MDUC registers
21763 as this makes the interrupt handlers faster.  The target option -mg13
21764 needs to be passed for this to work as this feature is only available
21765 on the G13 target (S2 core).  The MDUC registers will only be saved
21766 if the interrupt handler performs a multiplication or division
21767 operation or it calls another function.
21769 @end table
21771 @node RS/6000 and PowerPC Options
21772 @subsection IBM RS/6000 and PowerPC Options
21773 @cindex RS/6000 and PowerPC Options
21774 @cindex IBM RS/6000 and PowerPC Options
21776 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
21777 @table @gcctabopt
21778 @item -mpowerpc-gpopt
21779 @itemx -mno-powerpc-gpopt
21780 @itemx -mpowerpc-gfxopt
21781 @itemx -mno-powerpc-gfxopt
21782 @need 800
21783 @itemx -mpowerpc64
21784 @itemx -mno-powerpc64
21785 @itemx -mmfcrf
21786 @itemx -mno-mfcrf
21787 @itemx -mpopcntb
21788 @itemx -mno-popcntb
21789 @itemx -mpopcntd
21790 @itemx -mno-popcntd
21791 @itemx -mfprnd
21792 @itemx -mno-fprnd
21793 @need 800
21794 @itemx -mcmpb
21795 @itemx -mno-cmpb
21796 @itemx -mmfpgpr
21797 @itemx -mno-mfpgpr
21798 @itemx -mhard-dfp
21799 @itemx -mno-hard-dfp
21800 @opindex mpowerpc-gpopt
21801 @opindex mno-powerpc-gpopt
21802 @opindex mpowerpc-gfxopt
21803 @opindex mno-powerpc-gfxopt
21804 @opindex mpowerpc64
21805 @opindex mno-powerpc64
21806 @opindex mmfcrf
21807 @opindex mno-mfcrf
21808 @opindex mpopcntb
21809 @opindex mno-popcntb
21810 @opindex mpopcntd
21811 @opindex mno-popcntd
21812 @opindex mfprnd
21813 @opindex mno-fprnd
21814 @opindex mcmpb
21815 @opindex mno-cmpb
21816 @opindex mmfpgpr
21817 @opindex mno-mfpgpr
21818 @opindex mhard-dfp
21819 @opindex mno-hard-dfp
21820 You use these options to specify which instructions are available on the
21821 processor you are using.  The default value of these options is
21822 determined when configuring GCC@.  Specifying the
21823 @option{-mcpu=@var{cpu_type}} overrides the specification of these
21824 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
21825 rather than the options listed above.
21827 Specifying @option{-mpowerpc-gpopt} allows
21828 GCC to use the optional PowerPC architecture instructions in the
21829 General Purpose group, including floating-point square root.  Specifying
21830 @option{-mpowerpc-gfxopt} allows GCC to
21831 use the optional PowerPC architecture instructions in the Graphics
21832 group, including floating-point select.
21834 The @option{-mmfcrf} option allows GCC to generate the move from
21835 condition register field instruction implemented on the POWER4
21836 processor and other processors that support the PowerPC V2.01
21837 architecture.
21838 The @option{-mpopcntb} option allows GCC to generate the popcount and
21839 double-precision FP reciprocal estimate instruction implemented on the
21840 POWER5 processor and other processors that support the PowerPC V2.02
21841 architecture.
21842 The @option{-mpopcntd} option allows GCC to generate the popcount
21843 instruction implemented on the POWER7 processor and other processors
21844 that support the PowerPC V2.06 architecture.
21845 The @option{-mfprnd} option allows GCC to generate the FP round to
21846 integer instructions implemented on the POWER5+ processor and other
21847 processors that support the PowerPC V2.03 architecture.
21848 The @option{-mcmpb} option allows GCC to generate the compare bytes
21849 instruction implemented on the POWER6 processor and other processors
21850 that support the PowerPC V2.05 architecture.
21851 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21852 general-purpose register instructions implemented on the POWER6X
21853 processor and other processors that support the extended PowerPC V2.05
21854 architecture.
21855 The @option{-mhard-dfp} option allows GCC to generate the decimal
21856 floating-point instructions implemented on some POWER processors.
21858 The @option{-mpowerpc64} option allows GCC to generate the additional
21859 64-bit instructions that are found in the full PowerPC64 architecture
21860 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21861 @option{-mno-powerpc64}.
21863 @item -mcpu=@var{cpu_type}
21864 @opindex mcpu
21865 Set architecture type, register usage, and
21866 instruction scheduling parameters for machine type @var{cpu_type}.
21867 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21868 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21869 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21870 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21871 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21872 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21873 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21874 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21875 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21876 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21877 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21878 and @samp{rs64}.
21880 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21881 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21882 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21883 architecture machine types, with an appropriate, generic processor
21884 model assumed for scheduling purposes.
21886 The other options specify a specific processor.  Code generated under
21887 those options runs best on that processor, and may not run at all on
21888 others.
21890 The @option{-mcpu} options automatically enable or disable the
21891 following options:
21893 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21894 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21895 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21896 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21897 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21898 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21900 The particular options set for any particular CPU varies between
21901 compiler versions, depending on what setting seems to produce optimal
21902 code for that CPU; it doesn't necessarily reflect the actual hardware's
21903 capabilities.  If you wish to set an individual option to a particular
21904 value, you may specify it after the @option{-mcpu} option, like
21905 @option{-mcpu=970 -mno-altivec}.
21907 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21908 not enabled or disabled by the @option{-mcpu} option at present because
21909 AIX does not have full support for these options.  You may still
21910 enable or disable them individually if you're sure it'll work in your
21911 environment.
21913 @item -mtune=@var{cpu_type}
21914 @opindex mtune
21915 Set the instruction scheduling parameters for machine type
21916 @var{cpu_type}, but do not set the architecture type or register usage,
21917 as @option{-mcpu=@var{cpu_type}} does.  The same
21918 values for @var{cpu_type} are used for @option{-mtune} as for
21919 @option{-mcpu}.  If both are specified, the code generated uses the
21920 architecture and registers set by @option{-mcpu}, but the
21921 scheduling parameters set by @option{-mtune}.
21923 @item -mcmodel=small
21924 @opindex mcmodel=small
21925 Generate PowerPC64 code for the small model: The TOC is limited to
21926 64k.
21928 @item -mcmodel=medium
21929 @opindex mcmodel=medium
21930 Generate PowerPC64 code for the medium model: The TOC and other static
21931 data may be up to a total of 4G in size.  This is the default for 64-bit
21932 Linux.
21934 @item -mcmodel=large
21935 @opindex mcmodel=large
21936 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21937 in size.  Other data and code is only limited by the 64-bit address
21938 space.
21940 @item -maltivec
21941 @itemx -mno-altivec
21942 @opindex maltivec
21943 @opindex mno-altivec
21944 Generate code that uses (does not use) AltiVec instructions, and also
21945 enable the use of built-in functions that allow more direct access to
21946 the AltiVec instruction set.  You may also need to set
21947 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21948 enhancements.
21950 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
21951 @option{-maltivec=be}, the element order for AltiVec intrinsics such
21952 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
21953 match array element order corresponding to the endianness of the
21954 target.  That is, element zero identifies the leftmost element in a
21955 vector register when targeting a big-endian platform, and identifies
21956 the rightmost element in a vector register when targeting a
21957 little-endian platform.
21959 @item -maltivec=be
21960 @opindex maltivec=be
21961 Generate AltiVec instructions using big-endian element order,
21962 regardless of whether the target is big- or little-endian.  This is
21963 the default when targeting a big-endian platform.
21965 The element order is used to interpret element numbers in AltiVec
21966 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21967 @code{vec_insert}.  By default, these match array element order
21968 corresponding to the endianness for the target.
21970 @item -maltivec=le
21971 @opindex maltivec=le
21972 Generate AltiVec instructions using little-endian element order,
21973 regardless of whether the target is big- or little-endian.  This is
21974 the default when targeting a little-endian platform.  This option is
21975 currently ignored when targeting a big-endian platform.
21977 The element order is used to interpret element numbers in AltiVec
21978 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21979 @code{vec_insert}.  By default, these match array element order
21980 corresponding to the endianness for the target.
21982 @item -mvrsave
21983 @itemx -mno-vrsave
21984 @opindex mvrsave
21985 @opindex mno-vrsave
21986 Generate VRSAVE instructions when generating AltiVec code.
21988 @item -msecure-plt
21989 @opindex msecure-plt
21990 Generate code that allows @command{ld} and @command{ld.so}
21991 to build executables and shared
21992 libraries with non-executable @code{.plt} and @code{.got} sections.
21993 This is a PowerPC
21994 32-bit SYSV ABI option.
21996 @item -mbss-plt
21997 @opindex mbss-plt
21998 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
21999 fills in, and
22000 requires @code{.plt} and @code{.got}
22001 sections that are both writable and executable.
22002 This is a PowerPC 32-bit SYSV ABI option.
22004 @item -misel
22005 @itemx -mno-isel
22006 @opindex misel
22007 @opindex mno-isel
22008 This switch enables or disables the generation of ISEL instructions.
22010 @item -misel=@var{yes/no}
22011 This switch has been deprecated.  Use @option{-misel} and
22012 @option{-mno-isel} instead.
22014 @item -mspe
22015 @itemx -mno-spe
22016 @opindex mspe
22017 @opindex mno-spe
22018 This switch enables or disables the generation of SPE simd
22019 instructions.
22021 @item -mpaired
22022 @itemx -mno-paired
22023 @opindex mpaired
22024 @opindex mno-paired
22025 This switch enables or disables the generation of PAIRED simd
22026 instructions.
22028 @item -mspe=@var{yes/no}
22029 This option has been deprecated.  Use @option{-mspe} and
22030 @option{-mno-spe} instead.
22032 @item -mvsx
22033 @itemx -mno-vsx
22034 @opindex mvsx
22035 @opindex mno-vsx
22036 Generate code that uses (does not use) vector/scalar (VSX)
22037 instructions, and also enable the use of built-in functions that allow
22038 more direct access to the VSX instruction set.
22040 @item -mcrypto
22041 @itemx -mno-crypto
22042 @opindex mcrypto
22043 @opindex mno-crypto
22044 Enable the use (disable) of the built-in functions that allow direct
22045 access to the cryptographic instructions that were added in version
22046 2.07 of the PowerPC ISA.
22048 @item -mdirect-move
22049 @itemx -mno-direct-move
22050 @opindex mdirect-move
22051 @opindex mno-direct-move
22052 Generate code that uses (does not use) the instructions to move data
22053 between the general purpose registers and the vector/scalar (VSX)
22054 registers that were added in version 2.07 of the PowerPC ISA.
22056 @item -mhtm
22057 @itemx -mno-htm
22058 @opindex mhtm
22059 @opindex mno-htm
22060 Enable (disable) the use of the built-in functions that allow direct
22061 access to the Hardware Transactional Memory (HTM) instructions that
22062 were added in version 2.07 of the PowerPC ISA.
22064 @item -mpower8-fusion
22065 @itemx -mno-power8-fusion
22066 @opindex mpower8-fusion
22067 @opindex mno-power8-fusion
22068 Generate code that keeps (does not keeps) some integer operations
22069 adjacent so that the instructions can be fused together on power8 and
22070 later processors.
22072 @item -mpower8-vector
22073 @itemx -mno-power8-vector
22074 @opindex mpower8-vector
22075 @opindex mno-power8-vector
22076 Generate code that uses (does not use) the vector and scalar
22077 instructions that were added in version 2.07 of the PowerPC ISA.  Also
22078 enable the use of built-in functions that allow more direct access to
22079 the vector instructions.
22081 @item -mquad-memory
22082 @itemx -mno-quad-memory
22083 @opindex mquad-memory
22084 @opindex mno-quad-memory
22085 Generate code that uses (does not use) the non-atomic quad word memory
22086 instructions.  The @option{-mquad-memory} option requires use of
22087 64-bit mode.
22089 @item -mquad-memory-atomic
22090 @itemx -mno-quad-memory-atomic
22091 @opindex mquad-memory-atomic
22092 @opindex mno-quad-memory-atomic
22093 Generate code that uses (does not use) the atomic quad word memory
22094 instructions.  The @option{-mquad-memory-atomic} option requires use of
22095 64-bit mode.
22097 @item -mfloat128
22098 @itemx -mno-float128
22099 @opindex mfloat128
22100 @opindex mno-float128
22101 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22102 and use either software emulation for IEEE 128-bit floating point or
22103 hardware instructions.
22105 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
22106 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
22107 use the IEEE 128-bit floating point support.  The IEEE 128-bit
22108 floating point support only works on PowerPC Linux systems.
22110 The default for @option{-mfloat128} is enabled on PowerPC Linux
22111 systems using the VSX instruction set, and disabled on other systems.
22113 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
22114 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
22115 point support will also enable the generation of ISA 3.0 IEEE 128-bit
22116 floating point instructions.  Otherwise, if you do not specify to
22117 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
22118 system, IEEE 128-bit floating point will be done with software
22119 emulation.
22121 @item -mfloat128-hardware
22122 @itemx -mno-float128-hardware
22123 @opindex mfloat128-hardware
22124 @opindex mno-float128-hardware
22125 Enable/disable using ISA 3.0 hardware instructions to support the
22126 @var{__float128} data type.
22128 The default for @option{-mfloat128-hardware} is enabled on PowerPC
22129 Linux systems using the ISA 3.0 instruction set, and disabled on other
22130 systems.
22132 @item -mfloat-gprs=@var{yes/single/double/no}
22133 @itemx -mfloat-gprs
22134 @opindex mfloat-gprs
22135 This switch enables or disables the generation of floating-point
22136 operations on the general-purpose registers for architectures that
22137 support it.
22139 The argument @samp{yes} or @samp{single} enables the use of
22140 single-precision floating-point operations.
22142 The argument @samp{double} enables the use of single and
22143 double-precision floating-point operations.
22145 The argument @samp{no} disables floating-point operations on the
22146 general-purpose registers.
22148 This option is currently only available on the MPC854x.
22150 @item -m32
22151 @itemx -m64
22152 @opindex m32
22153 @opindex m64
22154 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
22155 targets (including GNU/Linux).  The 32-bit environment sets int, long
22156 and pointer to 32 bits and generates code that runs on any PowerPC
22157 variant.  The 64-bit environment sets int to 32 bits and long and
22158 pointer to 64 bits, and generates code for PowerPC64, as for
22159 @option{-mpowerpc64}.
22161 @item -mfull-toc
22162 @itemx -mno-fp-in-toc
22163 @itemx -mno-sum-in-toc
22164 @itemx -mminimal-toc
22165 @opindex mfull-toc
22166 @opindex mno-fp-in-toc
22167 @opindex mno-sum-in-toc
22168 @opindex mminimal-toc
22169 Modify generation of the TOC (Table Of Contents), which is created for
22170 every executable file.  The @option{-mfull-toc} option is selected by
22171 default.  In that case, GCC allocates at least one TOC entry for
22172 each unique non-automatic variable reference in your program.  GCC
22173 also places floating-point constants in the TOC@.  However, only
22174 16,384 entries are available in the TOC@.
22176 If you receive a linker error message that saying you have overflowed
22177 the available TOC space, you can reduce the amount of TOC space used
22178 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22179 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22180 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22181 generate code to calculate the sum of an address and a constant at
22182 run time instead of putting that sum into the TOC@.  You may specify one
22183 or both of these options.  Each causes GCC to produce very slightly
22184 slower and larger code at the expense of conserving TOC space.
22186 If you still run out of space in the TOC even when you specify both of
22187 these options, specify @option{-mminimal-toc} instead.  This option causes
22188 GCC to make only one TOC entry for every file.  When you specify this
22189 option, GCC produces code that is slower and larger but which
22190 uses extremely little TOC space.  You may wish to use this option
22191 only on files that contain less frequently-executed code.
22193 @item -maix64
22194 @itemx -maix32
22195 @opindex maix64
22196 @opindex maix32
22197 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22198 @code{long} type, and the infrastructure needed to support them.
22199 Specifying @option{-maix64} implies @option{-mpowerpc64},
22200 while @option{-maix32} disables the 64-bit ABI and
22201 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22203 @item -mxl-compat
22204 @itemx -mno-xl-compat
22205 @opindex mxl-compat
22206 @opindex mno-xl-compat
22207 Produce code that conforms more closely to IBM XL compiler semantics
22208 when using AIX-compatible ABI@.  Pass floating-point arguments to
22209 prototyped functions beyond the register save area (RSA) on the stack
22210 in addition to argument FPRs.  Do not assume that most significant
22211 double in 128-bit long double value is properly rounded when comparing
22212 values and converting to double.  Use XL symbol names for long double
22213 support routines.
22215 The AIX calling convention was extended but not initially documented to
22216 handle an obscure K&R C case of calling a function that takes the
22217 address of its arguments with fewer arguments than declared.  IBM XL
22218 compilers access floating-point arguments that do not fit in the
22219 RSA from the stack when a subroutine is compiled without
22220 optimization.  Because always storing floating-point arguments on the
22221 stack is inefficient and rarely needed, this option is not enabled by
22222 default and only is necessary when calling subroutines compiled by IBM
22223 XL compilers without optimization.
22225 @item -mpe
22226 @opindex mpe
22227 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22228 application written to use message passing with special startup code to
22229 enable the application to run.  The system must have PE installed in the
22230 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22231 must be overridden with the @option{-specs=} option to specify the
22232 appropriate directory location.  The Parallel Environment does not
22233 support threads, so the @option{-mpe} option and the @option{-pthread}
22234 option are incompatible.
22236 @item -malign-natural
22237 @itemx -malign-power
22238 @opindex malign-natural
22239 @opindex malign-power
22240 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22241 @option{-malign-natural} overrides the ABI-defined alignment of larger
22242 types, such as floating-point doubles, on their natural size-based boundary.
22243 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22244 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22246 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22247 is not supported.
22249 @item -msoft-float
22250 @itemx -mhard-float
22251 @opindex msoft-float
22252 @opindex mhard-float
22253 Generate code that does not use (uses) the floating-point register set.
22254 Software floating-point emulation is provided if you use the
22255 @option{-msoft-float} option, and pass the option to GCC when linking.
22257 @item -msingle-float
22258 @itemx -mdouble-float
22259 @opindex msingle-float
22260 @opindex mdouble-float
22261 Generate code for single- or double-precision floating-point operations.
22262 @option{-mdouble-float} implies @option{-msingle-float}.
22264 @item -msimple-fpu
22265 @opindex msimple-fpu
22266 Do not generate @code{sqrt} and @code{div} instructions for hardware
22267 floating-point unit.
22269 @item -mfpu=@var{name}
22270 @opindex mfpu
22271 Specify type of floating-point unit.  Valid values for @var{name} are
22272 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22273 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22274 @samp{sp_full} (equivalent to @option{-msingle-float}),
22275 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22277 @item -mxilinx-fpu
22278 @opindex mxilinx-fpu
22279 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22281 @item -mmultiple
22282 @itemx -mno-multiple
22283 @opindex mmultiple
22284 @opindex mno-multiple
22285 Generate code that uses (does not use) the load multiple word
22286 instructions and the store multiple word instructions.  These
22287 instructions are generated by default on POWER systems, and not
22288 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22289 PowerPC systems, since those instructions do not work when the
22290 processor is in little-endian mode.  The exceptions are PPC740 and
22291 PPC750 which permit these instructions in little-endian mode.
22293 @item -mstring
22294 @itemx -mno-string
22295 @opindex mstring
22296 @opindex mno-string
22297 Generate code that uses (does not use) the load string instructions
22298 and the store string word instructions to save multiple registers and
22299 do small block moves.  These instructions are generated by default on
22300 POWER systems, and not generated on PowerPC systems.  Do not use
22301 @option{-mstring} on little-endian PowerPC systems, since those
22302 instructions do not work when the processor is in little-endian mode.
22303 The exceptions are PPC740 and PPC750 which permit these instructions
22304 in little-endian mode.
22306 @item -mupdate
22307 @itemx -mno-update
22308 @opindex mupdate
22309 @opindex mno-update
22310 Generate code that uses (does not use) the load or store instructions
22311 that update the base register to the address of the calculated memory
22312 location.  These instructions are generated by default.  If you use
22313 @option{-mno-update}, there is a small window between the time that the
22314 stack pointer is updated and the address of the previous frame is
22315 stored, which means code that walks the stack frame across interrupts or
22316 signals may get corrupted data.
22318 @item -mavoid-indexed-addresses
22319 @itemx -mno-avoid-indexed-addresses
22320 @opindex mavoid-indexed-addresses
22321 @opindex mno-avoid-indexed-addresses
22322 Generate code that tries to avoid (not avoid) the use of indexed load
22323 or store instructions. These instructions can incur a performance
22324 penalty on Power6 processors in certain situations, such as when
22325 stepping through large arrays that cross a 16M boundary.  This option
22326 is enabled by default when targeting Power6 and disabled otherwise.
22328 @item -mfused-madd
22329 @itemx -mno-fused-madd
22330 @opindex mfused-madd
22331 @opindex mno-fused-madd
22332 Generate code that uses (does not use) the floating-point multiply and
22333 accumulate instructions.  These instructions are generated by default
22334 if hardware floating point is used.  The machine-dependent
22335 @option{-mfused-madd} option is now mapped to the machine-independent
22336 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22337 mapped to @option{-ffp-contract=off}.
22339 @item -mmulhw
22340 @itemx -mno-mulhw
22341 @opindex mmulhw
22342 @opindex mno-mulhw
22343 Generate code that uses (does not use) the half-word multiply and
22344 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22345 These instructions are generated by default when targeting those
22346 processors.
22348 @item -mdlmzb
22349 @itemx -mno-dlmzb
22350 @opindex mdlmzb
22351 @opindex mno-dlmzb
22352 Generate code that uses (does not use) the string-search @samp{dlmzb}
22353 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22354 generated by default when targeting those processors.
22356 @item -mno-bit-align
22357 @itemx -mbit-align
22358 @opindex mno-bit-align
22359 @opindex mbit-align
22360 On System V.4 and embedded PowerPC systems do not (do) force structures
22361 and unions that contain bit-fields to be aligned to the base type of the
22362 bit-field.
22364 For example, by default a structure containing nothing but 8
22365 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22366 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22367 the structure is aligned to a 1-byte boundary and is 1 byte in
22368 size.
22370 @item -mno-strict-align
22371 @itemx -mstrict-align
22372 @opindex mno-strict-align
22373 @opindex mstrict-align
22374 On System V.4 and embedded PowerPC systems do not (do) assume that
22375 unaligned memory references are handled by the system.
22377 @item -mrelocatable
22378 @itemx -mno-relocatable
22379 @opindex mrelocatable
22380 @opindex mno-relocatable
22381 Generate code that allows (does not allow) a static executable to be
22382 relocated to a different address at run time.  A simple embedded
22383 PowerPC system loader should relocate the entire contents of
22384 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22385 a table of 32-bit addresses generated by this option.  For this to
22386 work, all objects linked together must be compiled with
22387 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22388 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22390 @item -mrelocatable-lib
22391 @itemx -mno-relocatable-lib
22392 @opindex mrelocatable-lib
22393 @opindex mno-relocatable-lib
22394 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22395 @code{.fixup} section to allow static executables to be relocated at
22396 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22397 alignment of @option{-mrelocatable}.  Objects compiled with
22398 @option{-mrelocatable-lib} may be linked with objects compiled with
22399 any combination of the @option{-mrelocatable} options.
22401 @item -mno-toc
22402 @itemx -mtoc
22403 @opindex mno-toc
22404 @opindex mtoc
22405 On System V.4 and embedded PowerPC systems do not (do) assume that
22406 register 2 contains a pointer to a global area pointing to the addresses
22407 used in the program.
22409 @item -mlittle
22410 @itemx -mlittle-endian
22411 @opindex mlittle
22412 @opindex mlittle-endian
22413 On System V.4 and embedded PowerPC systems compile code for the
22414 processor in little-endian mode.  The @option{-mlittle-endian} option is
22415 the same as @option{-mlittle}.
22417 @item -mbig
22418 @itemx -mbig-endian
22419 @opindex mbig
22420 @opindex mbig-endian
22421 On System V.4 and embedded PowerPC systems compile code for the
22422 processor in big-endian mode.  The @option{-mbig-endian} option is
22423 the same as @option{-mbig}.
22425 @item -mdynamic-no-pic
22426 @opindex mdynamic-no-pic
22427 On Darwin and Mac OS X systems, compile code so that it is not
22428 relocatable, but that its external references are relocatable.  The
22429 resulting code is suitable for applications, but not shared
22430 libraries.
22432 @item -msingle-pic-base
22433 @opindex msingle-pic-base
22434 Treat the register used for PIC addressing as read-only, rather than
22435 loading it in the prologue for each function.  The runtime system is
22436 responsible for initializing this register with an appropriate value
22437 before execution begins.
22439 @item -mprioritize-restricted-insns=@var{priority}
22440 @opindex mprioritize-restricted-insns
22441 This option controls the priority that is assigned to
22442 dispatch-slot restricted instructions during the second scheduling
22443 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22444 or @samp{2} to assign no, highest, or second-highest (respectively) 
22445 priority to dispatch-slot restricted
22446 instructions.
22448 @item -msched-costly-dep=@var{dependence_type}
22449 @opindex msched-costly-dep
22450 This option controls which dependences are considered costly
22451 by the target during instruction scheduling.  The argument
22452 @var{dependence_type} takes one of the following values:
22454 @table @asis
22455 @item @samp{no}
22456 No dependence is costly.
22458 @item @samp{all}
22459 All dependences are costly.
22461 @item @samp{true_store_to_load}
22462 A true dependence from store to load is costly.
22464 @item @samp{store_to_load}
22465 Any dependence from store to load is costly.
22467 @item @var{number}
22468 Any dependence for which the latency is greater than or equal to 
22469 @var{number} is costly.
22470 @end table
22472 @item -minsert-sched-nops=@var{scheme}
22473 @opindex minsert-sched-nops
22474 This option controls which NOP insertion scheme is used during
22475 the second scheduling pass.  The argument @var{scheme} takes one of the
22476 following values:
22478 @table @asis
22479 @item @samp{no}
22480 Don't insert NOPs.
22482 @item @samp{pad}
22483 Pad with NOPs any dispatch group that has vacant issue slots,
22484 according to the scheduler's grouping.
22486 @item @samp{regroup_exact}
22487 Insert NOPs to force costly dependent insns into
22488 separate groups.  Insert exactly as many NOPs as needed to force an insn
22489 to a new group, according to the estimated processor grouping.
22491 @item @var{number}
22492 Insert NOPs to force costly dependent insns into
22493 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22494 @end table
22496 @item -mcall-sysv
22497 @opindex mcall-sysv
22498 On System V.4 and embedded PowerPC systems compile code using calling
22499 conventions that adhere to the March 1995 draft of the System V
22500 Application Binary Interface, PowerPC processor supplement.  This is the
22501 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22503 @item -mcall-sysv-eabi
22504 @itemx -mcall-eabi
22505 @opindex mcall-sysv-eabi
22506 @opindex mcall-eabi
22507 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22509 @item -mcall-sysv-noeabi
22510 @opindex mcall-sysv-noeabi
22511 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22513 @item -mcall-aixdesc
22514 @opindex m
22515 On System V.4 and embedded PowerPC systems compile code for the AIX
22516 operating system.
22518 @item -mcall-linux
22519 @opindex mcall-linux
22520 On System V.4 and embedded PowerPC systems compile code for the
22521 Linux-based GNU system.
22523 @item -mcall-freebsd
22524 @opindex mcall-freebsd
22525 On System V.4 and embedded PowerPC systems compile code for the
22526 FreeBSD operating system.
22528 @item -mcall-netbsd
22529 @opindex mcall-netbsd
22530 On System V.4 and embedded PowerPC systems compile code for the
22531 NetBSD operating system.
22533 @item -mcall-openbsd
22534 @opindex mcall-netbsd
22535 On System V.4 and embedded PowerPC systems compile code for the
22536 OpenBSD operating system.
22538 @item -maix-struct-return
22539 @opindex maix-struct-return
22540 Return all structures in memory (as specified by the AIX ABI)@.
22542 @item -msvr4-struct-return
22543 @opindex msvr4-struct-return
22544 Return structures smaller than 8 bytes in registers (as specified by the
22545 SVR4 ABI)@.
22547 @item -mabi=@var{abi-type}
22548 @opindex mabi
22549 Extend the current ABI with a particular extension, or remove such extension.
22550 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22551 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22552 @samp{elfv1}, @samp{elfv2}@.
22554 @item -mabi=spe
22555 @opindex mabi=spe
22556 Extend the current ABI with SPE ABI extensions.  This does not change
22557 the default ABI, instead it adds the SPE ABI extensions to the current
22558 ABI@.
22560 @item -mabi=no-spe
22561 @opindex mabi=no-spe
22562 Disable Book-E SPE ABI extensions for the current ABI@.
22564 @item -mabi=ibmlongdouble
22565 @opindex mabi=ibmlongdouble
22566 Change the current ABI to use IBM extended-precision long double.
22567 This is a PowerPC 32-bit SYSV ABI option.
22569 @item -mabi=ieeelongdouble
22570 @opindex mabi=ieeelongdouble
22571 Change the current ABI to use IEEE extended-precision long double.
22572 This is a PowerPC 32-bit Linux ABI option.
22574 @item -mabi=elfv1
22575 @opindex mabi=elfv1
22576 Change the current ABI to use the ELFv1 ABI.
22577 This is the default ABI for big-endian PowerPC 64-bit Linux.
22578 Overriding the default ABI requires special system support and is
22579 likely to fail in spectacular ways.
22581 @item -mabi=elfv2
22582 @opindex mabi=elfv2
22583 Change the current ABI to use the ELFv2 ABI.
22584 This is the default ABI for little-endian PowerPC 64-bit Linux.
22585 Overriding the default ABI requires special system support and is
22586 likely to fail in spectacular ways.
22588 @item -mgnu-attribute
22589 @itemx -mno-gnu-attribute
22590 @opindex mgnu-attribute
22591 @opindex mno-gnu-attribute
22592 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22593 .gnu.attributes section that specify ABI variations in function
22594 parameters or return values.
22596 @item -mprototype
22597 @itemx -mno-prototype
22598 @opindex mprototype
22599 @opindex mno-prototype
22600 On System V.4 and embedded PowerPC systems assume that all calls to
22601 variable argument functions are properly prototyped.  Otherwise, the
22602 compiler must insert an instruction before every non-prototyped call to
22603 set or clear bit 6 of the condition code register (@code{CR}) to
22604 indicate whether floating-point values are passed in the floating-point
22605 registers in case the function takes variable arguments.  With
22606 @option{-mprototype}, only calls to prototyped variable argument functions
22607 set or clear the bit.
22609 @item -msim
22610 @opindex msim
22611 On embedded PowerPC systems, assume that the startup module is called
22612 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22613 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22614 configurations.
22616 @item -mmvme
22617 @opindex mmvme
22618 On embedded PowerPC systems, assume that the startup module is called
22619 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22620 @file{libc.a}.
22622 @item -mads
22623 @opindex mads
22624 On embedded PowerPC systems, assume that the startup module is called
22625 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22626 @file{libc.a}.
22628 @item -myellowknife
22629 @opindex myellowknife
22630 On embedded PowerPC systems, assume that the startup module is called
22631 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22632 @file{libc.a}.
22634 @item -mvxworks
22635 @opindex mvxworks
22636 On System V.4 and embedded PowerPC systems, specify that you are
22637 compiling for a VxWorks system.
22639 @item -memb
22640 @opindex memb
22641 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22642 header to indicate that @samp{eabi} extended relocations are used.
22644 @item -meabi
22645 @itemx -mno-eabi
22646 @opindex meabi
22647 @opindex mno-eabi
22648 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22649 Embedded Applications Binary Interface (EABI), which is a set of
22650 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22651 means that the stack is aligned to an 8-byte boundary, a function
22652 @code{__eabi} is called from @code{main} to set up the EABI
22653 environment, and the @option{-msdata} option can use both @code{r2} and
22654 @code{r13} to point to two separate small data areas.  Selecting
22655 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22656 no EABI initialization function is called from @code{main}, and the
22657 @option{-msdata} option only uses @code{r13} to point to a single
22658 small data area.  The @option{-meabi} option is on by default if you
22659 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22661 @item -msdata=eabi
22662 @opindex msdata=eabi
22663 On System V.4 and embedded PowerPC systems, put small initialized
22664 @code{const} global and static data in the @code{.sdata2} section, which
22665 is pointed to by register @code{r2}.  Put small initialized
22666 non-@code{const} global and static data in the @code{.sdata} section,
22667 which is pointed to by register @code{r13}.  Put small uninitialized
22668 global and static data in the @code{.sbss} section, which is adjacent to
22669 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22670 incompatible with the @option{-mrelocatable} option.  The
22671 @option{-msdata=eabi} option also sets the @option{-memb} option.
22673 @item -msdata=sysv
22674 @opindex msdata=sysv
22675 On System V.4 and embedded PowerPC systems, put small global and static
22676 data in the @code{.sdata} section, which is pointed to by register
22677 @code{r13}.  Put small uninitialized global and static data in the
22678 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22679 The @option{-msdata=sysv} option is incompatible with the
22680 @option{-mrelocatable} option.
22682 @item -msdata=default
22683 @itemx -msdata
22684 @opindex msdata=default
22685 @opindex msdata
22686 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22687 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22688 same as @option{-msdata=sysv}.
22690 @item -msdata=data
22691 @opindex msdata=data
22692 On System V.4 and embedded PowerPC systems, put small global
22693 data in the @code{.sdata} section.  Put small uninitialized global
22694 data in the @code{.sbss} section.  Do not use register @code{r13}
22695 to address small data however.  This is the default behavior unless
22696 other @option{-msdata} options are used.
22698 @item -msdata=none
22699 @itemx -mno-sdata
22700 @opindex msdata=none
22701 @opindex mno-sdata
22702 On embedded PowerPC systems, put all initialized global and static data
22703 in the @code{.data} section, and all uninitialized data in the
22704 @code{.bss} section.
22706 @item -mblock-move-inline-limit=@var{num}
22707 @opindex mblock-move-inline-limit
22708 Inline all block moves (such as calls to @code{memcpy} or structure
22709 copies) less than or equal to @var{num} bytes.  The minimum value for
22710 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22711 targets.  The default value is target-specific.
22713 @item -G @var{num}
22714 @opindex G
22715 @cindex smaller data references (PowerPC)
22716 @cindex .sdata/.sdata2 references (PowerPC)
22717 On embedded PowerPC systems, put global and static items less than or
22718 equal to @var{num} bytes into the small data or BSS sections instead of
22719 the normal data or BSS section.  By default, @var{num} is 8.  The
22720 @option{-G @var{num}} switch is also passed to the linker.
22721 All modules should be compiled with the same @option{-G @var{num}} value.
22723 @item -mregnames
22724 @itemx -mno-regnames
22725 @opindex mregnames
22726 @opindex mno-regnames
22727 On System V.4 and embedded PowerPC systems do (do not) emit register
22728 names in the assembly language output using symbolic forms.
22730 @item -mlongcall
22731 @itemx -mno-longcall
22732 @opindex mlongcall
22733 @opindex mno-longcall
22734 By default assume that all calls are far away so that a longer and more
22735 expensive calling sequence is required.  This is required for calls
22736 farther than 32 megabytes (33,554,432 bytes) from the current location.
22737 A short call is generated if the compiler knows
22738 the call cannot be that far away.  This setting can be overridden by
22739 the @code{shortcall} function attribute, or by @code{#pragma
22740 longcall(0)}.
22742 Some linkers are capable of detecting out-of-range calls and generating
22743 glue code on the fly.  On these systems, long calls are unnecessary and
22744 generate slower code.  As of this writing, the AIX linker can do this,
22745 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22746 to the GNU linker for 32-bit PowerPC systems as well.
22748 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
22749 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
22750 addresses represent the callee and the branch island.  The
22751 Darwin/PPC linker prefers the first address and generates a @code{bl
22752 callee} if the PPC @code{bl} instruction reaches the callee directly;
22753 otherwise, the linker generates @code{bl L42} to call the branch
22754 island.  The branch island is appended to the body of the
22755 calling function; it computes the full 32-bit address of the callee
22756 and jumps to it.
22758 On Mach-O (Darwin) systems, this option directs the compiler emit to
22759 the glue for every direct call, and the Darwin linker decides whether
22760 to use or discard it.
22762 In the future, GCC may ignore all longcall specifications
22763 when the linker is known to generate glue.
22765 @item -mtls-markers
22766 @itemx -mno-tls-markers
22767 @opindex mtls-markers
22768 @opindex mno-tls-markers
22769 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22770 specifying the function argument.  The relocation allows the linker to
22771 reliably associate function call with argument setup instructions for
22772 TLS optimization, which in turn allows GCC to better schedule the
22773 sequence.
22775 @item -mrecip
22776 @itemx -mno-recip
22777 @opindex mrecip
22778 This option enables use of the reciprocal estimate and
22779 reciprocal square root estimate instructions with additional
22780 Newton-Raphson steps to increase precision instead of doing a divide or
22781 square root and divide for floating-point arguments.  You should use
22782 the @option{-ffast-math} option when using @option{-mrecip} (or at
22783 least @option{-funsafe-math-optimizations},
22784 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22785 @option{-fno-trapping-math}).  Note that while the throughput of the
22786 sequence is generally higher than the throughput of the non-reciprocal
22787 instruction, the precision of the sequence can be decreased by up to 2
22788 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22789 roots.
22791 @item -mrecip=@var{opt}
22792 @opindex mrecip=opt
22793 This option controls which reciprocal estimate instructions
22794 may be used.  @var{opt} is a comma-separated list of options, which may
22795 be preceded by a @code{!} to invert the option:
22797 @table @samp
22799 @item all
22800 Enable all estimate instructions.
22802 @item default 
22803 Enable the default instructions, equivalent to @option{-mrecip}.
22805 @item none 
22806 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22808 @item div 
22809 Enable the reciprocal approximation instructions for both 
22810 single and double precision.
22812 @item divf 
22813 Enable the single-precision reciprocal approximation instructions.
22815 @item divd 
22816 Enable the double-precision reciprocal approximation instructions.
22818 @item rsqrt 
22819 Enable the reciprocal square root approximation instructions for both
22820 single and double precision.
22822 @item rsqrtf 
22823 Enable the single-precision reciprocal square root approximation instructions.
22825 @item rsqrtd 
22826 Enable the double-precision reciprocal square root approximation instructions.
22828 @end table
22830 So, for example, @option{-mrecip=all,!rsqrtd} enables
22831 all of the reciprocal estimate instructions, except for the
22832 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22833 which handle the double-precision reciprocal square root calculations.
22835 @item -mrecip-precision
22836 @itemx -mno-recip-precision
22837 @opindex mrecip-precision
22838 Assume (do not assume) that the reciprocal estimate instructions
22839 provide higher-precision estimates than is mandated by the PowerPC
22840 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22841 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22842 The double-precision square root estimate instructions are not generated by
22843 default on low-precision machines, since they do not provide an
22844 estimate that converges after three steps.
22846 @item -mveclibabi=@var{type}
22847 @opindex mveclibabi
22848 Specifies the ABI type to use for vectorizing intrinsics using an
22849 external library.  The only type supported at present is @samp{mass},
22850 which specifies to use IBM's Mathematical Acceleration Subsystem
22851 (MASS) libraries for vectorizing intrinsics using external libraries.
22852 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22853 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22854 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22855 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22856 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22857 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22858 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22859 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22860 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22861 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22862 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22863 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22864 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22865 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22866 for power7.  Both @option{-ftree-vectorize} and
22867 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22868 libraries must be specified at link time.
22870 @item -mfriz
22871 @itemx -mno-friz
22872 @opindex mfriz
22873 Generate (do not generate) the @code{friz} instruction when the
22874 @option{-funsafe-math-optimizations} option is used to optimize
22875 rounding of floating-point values to 64-bit integer and back to floating
22876 point.  The @code{friz} instruction does not return the same value if
22877 the floating-point number is too large to fit in an integer.
22879 @item -mpointers-to-nested-functions
22880 @itemx -mno-pointers-to-nested-functions
22881 @opindex mpointers-to-nested-functions
22882 Generate (do not generate) code to load up the static chain register
22883 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22884 systems where a function pointer points to a 3-word descriptor giving
22885 the function address, TOC value to be loaded in register @code{r2}, and
22886 static chain value to be loaded in register @code{r11}.  The
22887 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22888 call through pointers to nested functions or pointers
22889 to functions compiled in other languages that use the static chain if
22890 you use @option{-mno-pointers-to-nested-functions}.
22892 @item -msave-toc-indirect
22893 @itemx -mno-save-toc-indirect
22894 @opindex msave-toc-indirect
22895 Generate (do not generate) code to save the TOC value in the reserved
22896 stack location in the function prologue if the function calls through
22897 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22898 saved in the prologue, it is saved just before the call through the
22899 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22901 @item -mcompat-align-parm
22902 @itemx -mno-compat-align-parm
22903 @opindex mcompat-align-parm
22904 Generate (do not generate) code to pass structure parameters with a
22905 maximum alignment of 64 bits, for compatibility with older versions
22906 of GCC.
22908 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22909 structure parameter on a 128-bit boundary when that structure contained
22910 a member requiring 128-bit alignment.  This is corrected in more
22911 recent versions of GCC.  This option may be used to generate code
22912 that is compatible with functions compiled with older versions of
22913 GCC.
22915 The @option{-mno-compat-align-parm} option is the default.
22917 @item -mstack-protector-guard=@var{guard}
22918 @itemx -mstack-protector-guard-reg=@var{reg}
22919 @itemx -mstack-protector-guard-offset=@var{offset}
22920 @itemx -mstack-protector-guard-symbol=@var{symbol}
22921 @opindex mstack-protector-guard
22922 @opindex mstack-protector-guard-reg
22923 @opindex mstack-protector-guard-offset
22924 @opindex mstack-protector-guard-symbol
22925 Generate stack protection code using canary at @var{guard}.  Supported
22926 locations are @samp{global} for global canary or @samp{tls} for per-thread
22927 canary in the TLS block (the default with GNU libc version 2.4 or later).
22929 With the latter choice the options
22930 @option{-mstack-protector-guard-reg=@var{reg}} and
22931 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22932 which register to use as base register for reading the canary, and from what
22933 offset from that base register. The default for those is as specified in the
22934 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
22935 the offset with a symbol reference to a canary in the TLS block.
22936 @end table
22938 @node RX Options
22939 @subsection RX Options
22940 @cindex RX Options
22942 These command-line options are defined for RX targets:
22944 @table @gcctabopt
22945 @item -m64bit-doubles
22946 @itemx -m32bit-doubles
22947 @opindex m64bit-doubles
22948 @opindex m32bit-doubles
22949 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22950 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22951 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
22952 works on 32-bit values, which is why the default is
22953 @option{-m32bit-doubles}.
22955 @item -fpu
22956 @itemx -nofpu
22957 @opindex fpu
22958 @opindex nofpu
22959 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
22960 floating-point hardware.  The default is enabled for the RX600
22961 series and disabled for the RX200 series.
22963 Floating-point instructions are only generated for 32-bit floating-point 
22964 values, however, so the FPU hardware is not used for doubles if the
22965 @option{-m64bit-doubles} option is used.
22967 @emph{Note} If the @option{-fpu} option is enabled then
22968 @option{-funsafe-math-optimizations} is also enabled automatically.
22969 This is because the RX FPU instructions are themselves unsafe.
22971 @item -mcpu=@var{name}
22972 @opindex mcpu
22973 Selects the type of RX CPU to be targeted.  Currently three types are
22974 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
22975 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
22977 The only difference between @samp{RX600} and @samp{RX610} is that the
22978 @samp{RX610} does not support the @code{MVTIPL} instruction.
22980 The @samp{RX200} series does not have a hardware floating-point unit
22981 and so @option{-nofpu} is enabled by default when this type is
22982 selected.
22984 @item -mbig-endian-data
22985 @itemx -mlittle-endian-data
22986 @opindex mbig-endian-data
22987 @opindex mlittle-endian-data
22988 Store data (but not code) in the big-endian format.  The default is
22989 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
22990 format.
22992 @item -msmall-data-limit=@var{N}
22993 @opindex msmall-data-limit
22994 Specifies the maximum size in bytes of global and static variables
22995 which can be placed into the small data area.  Using the small data
22996 area can lead to smaller and faster code, but the size of area is
22997 limited and it is up to the programmer to ensure that the area does
22998 not overflow.  Also when the small data area is used one of the RX's
22999 registers (usually @code{r13}) is reserved for use pointing to this
23000 area, so it is no longer available for use by the compiler.  This
23001 could result in slower and/or larger code if variables are pushed onto
23002 the stack instead of being held in this register.
23004 Note, common variables (variables that have not been initialized) and
23005 constants are not placed into the small data area as they are assigned
23006 to other sections in the output executable.
23008 The default value is zero, which disables this feature.  Note, this
23009 feature is not enabled by default with higher optimization levels
23010 (@option{-O2} etc) because of the potentially detrimental effects of
23011 reserving a register.  It is up to the programmer to experiment and
23012 discover whether this feature is of benefit to their program.  See the
23013 description of the @option{-mpid} option for a description of how the
23014 actual register to hold the small data area pointer is chosen.
23016 @item -msim
23017 @itemx -mno-sim
23018 @opindex msim
23019 @opindex mno-sim
23020 Use the simulator runtime.  The default is to use the libgloss
23021 board-specific runtime.
23023 @item -mas100-syntax
23024 @itemx -mno-as100-syntax
23025 @opindex mas100-syntax
23026 @opindex mno-as100-syntax
23027 When generating assembler output use a syntax that is compatible with
23028 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
23029 assembler, but it has some restrictions so it is not generated by default.
23031 @item -mmax-constant-size=@var{N}
23032 @opindex mmax-constant-size
23033 Specifies the maximum size, in bytes, of a constant that can be used as
23034 an operand in a RX instruction.  Although the RX instruction set does
23035 allow constants of up to 4 bytes in length to be used in instructions,
23036 a longer value equates to a longer instruction.  Thus in some
23037 circumstances it can be beneficial to restrict the size of constants
23038 that are used in instructions.  Constants that are too big are instead
23039 placed into a constant pool and referenced via register indirection.
23041 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
23042 or 4 means that constants of any size are allowed.
23044 @item -mrelax
23045 @opindex mrelax
23046 Enable linker relaxation.  Linker relaxation is a process whereby the
23047 linker attempts to reduce the size of a program by finding shorter
23048 versions of various instructions.  Disabled by default.
23050 @item -mint-register=@var{N}
23051 @opindex mint-register
23052 Specify the number of registers to reserve for fast interrupt handler
23053 functions.  The value @var{N} can be between 0 and 4.  A value of 1
23054 means that register @code{r13} is reserved for the exclusive use
23055 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
23056 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
23057 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
23058 A value of 0, the default, does not reserve any registers.
23060 @item -msave-acc-in-interrupts
23061 @opindex msave-acc-in-interrupts
23062 Specifies that interrupt handler functions should preserve the
23063 accumulator register.  This is only necessary if normal code might use
23064 the accumulator register, for example because it performs 64-bit
23065 multiplications.  The default is to ignore the accumulator as this
23066 makes the interrupt handlers faster.
23068 @item -mpid
23069 @itemx -mno-pid
23070 @opindex mpid
23071 @opindex mno-pid
23072 Enables the generation of position independent data.  When enabled any
23073 access to constant data is done via an offset from a base address
23074 held in a register.  This allows the location of constant data to be
23075 determined at run time without requiring the executable to be
23076 relocated, which is a benefit to embedded applications with tight
23077 memory constraints.  Data that can be modified is not affected by this
23078 option.
23080 Note, using this feature reserves a register, usually @code{r13}, for
23081 the constant data base address.  This can result in slower and/or
23082 larger code, especially in complicated functions.
23084 The actual register chosen to hold the constant data base address
23085 depends upon whether the @option{-msmall-data-limit} and/or the
23086 @option{-mint-register} command-line options are enabled.  Starting
23087 with register @code{r13} and proceeding downwards, registers are
23088 allocated first to satisfy the requirements of @option{-mint-register},
23089 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
23090 is possible for the small data area register to be @code{r8} if both
23091 @option{-mint-register=4} and @option{-mpid} are specified on the
23092 command line.
23094 By default this feature is not enabled.  The default can be restored
23095 via the @option{-mno-pid} command-line option.
23097 @item -mno-warn-multiple-fast-interrupts
23098 @itemx -mwarn-multiple-fast-interrupts
23099 @opindex mno-warn-multiple-fast-interrupts
23100 @opindex mwarn-multiple-fast-interrupts
23101 Prevents GCC from issuing a warning message if it finds more than one
23102 fast interrupt handler when it is compiling a file.  The default is to
23103 issue a warning for each extra fast interrupt handler found, as the RX
23104 only supports one such interrupt.
23106 @item -mallow-string-insns
23107 @itemx -mno-allow-string-insns
23108 @opindex mallow-string-insns
23109 @opindex mno-allow-string-insns
23110 Enables or disables the use of the string manipulation instructions
23111 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
23112 @code{SWHILE} and also the @code{RMPA} instruction.  These
23113 instructions may prefetch data, which is not safe to do if accessing
23114 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
23115 for more information).
23117 The default is to allow these instructions, but it is not possible for
23118 GCC to reliably detect all circumstances where a string instruction
23119 might be used to access an I/O register, so their use cannot be
23120 disabled automatically.  Instead it is reliant upon the programmer to
23121 use the @option{-mno-allow-string-insns} option if their program
23122 accesses I/O space.
23124 When the instructions are enabled GCC defines the C preprocessor
23125 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
23126 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
23128 @item -mjsr
23129 @itemx -mno-jsr
23130 @opindex mjsr
23131 @opindex mno-jsr
23132 Use only (or not only) @code{JSR} instructions to access functions.
23133 This option can be used when code size exceeds the range of @code{BSR}
23134 instructions.  Note that @option{-mno-jsr} does not mean to not use
23135 @code{JSR} but instead means that any type of branch may be used.
23136 @end table
23138 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
23139 has special significance to the RX port when used with the
23140 @code{interrupt} function attribute.  This attribute indicates a
23141 function intended to process fast interrupts.  GCC ensures
23142 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
23143 and/or @code{r13} and only provided that the normal use of the
23144 corresponding registers have been restricted via the
23145 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
23146 options.
23148 @node S/390 and zSeries Options
23149 @subsection S/390 and zSeries Options
23150 @cindex S/390 and zSeries Options
23152 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
23154 @table @gcctabopt
23155 @item -mhard-float
23156 @itemx -msoft-float
23157 @opindex mhard-float
23158 @opindex msoft-float
23159 Use (do not use) the hardware floating-point instructions and registers
23160 for floating-point operations.  When @option{-msoft-float} is specified,
23161 functions in @file{libgcc.a} are used to perform floating-point
23162 operations.  When @option{-mhard-float} is specified, the compiler
23163 generates IEEE floating-point instructions.  This is the default.
23165 @item -mhard-dfp
23166 @itemx -mno-hard-dfp
23167 @opindex mhard-dfp
23168 @opindex mno-hard-dfp
23169 Use (do not use) the hardware decimal-floating-point instructions for
23170 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
23171 specified, functions in @file{libgcc.a} are used to perform
23172 decimal-floating-point operations.  When @option{-mhard-dfp} is
23173 specified, the compiler generates decimal-floating-point hardware
23174 instructions.  This is the default for @option{-march=z9-ec} or higher.
23176 @item -mlong-double-64
23177 @itemx -mlong-double-128
23178 @opindex mlong-double-64
23179 @opindex mlong-double-128
23180 These switches control the size of @code{long double} type. A size
23181 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23182 type. This is the default.
23184 @item -mbackchain
23185 @itemx -mno-backchain
23186 @opindex mbackchain
23187 @opindex mno-backchain
23188 Store (do not store) the address of the caller's frame as backchain pointer
23189 into the callee's stack frame.
23190 A backchain may be needed to allow debugging using tools that do not understand
23191 DWARF call frame information.
23192 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23193 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23194 the backchain is placed into the topmost word of the 96/160 byte register
23195 save area.
23197 In general, code compiled with @option{-mbackchain} is call-compatible with
23198 code compiled with @option{-mmo-backchain}; however, use of the backchain
23199 for debugging purposes usually requires that the whole binary is built with
23200 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23201 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23202 to build a linux kernel use @option{-msoft-float}.
23204 The default is to not maintain the backchain.
23206 @item -mpacked-stack
23207 @itemx -mno-packed-stack
23208 @opindex mpacked-stack
23209 @opindex mno-packed-stack
23210 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23211 specified, the compiler uses the all fields of the 96/160 byte register save
23212 area only for their default purpose; unused fields still take up stack space.
23213 When @option{-mpacked-stack} is specified, register save slots are densely
23214 packed at the top of the register save area; unused space is reused for other
23215 purposes, allowing for more efficient use of the available stack space.
23216 However, when @option{-mbackchain} is also in effect, the topmost word of
23217 the save area is always used to store the backchain, and the return address
23218 register is always saved two words below the backchain.
23220 As long as the stack frame backchain is not used, code generated with
23221 @option{-mpacked-stack} is call-compatible with code generated with
23222 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23223 S/390 or zSeries generated code that uses the stack frame backchain at run
23224 time, not just for debugging purposes.  Such code is not call-compatible
23225 with code compiled with @option{-mpacked-stack}.  Also, note that the
23226 combination of @option{-mbackchain},
23227 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23228 to build a linux kernel use @option{-msoft-float}.
23230 The default is to not use the packed stack layout.
23232 @item -msmall-exec
23233 @itemx -mno-small-exec
23234 @opindex msmall-exec
23235 @opindex mno-small-exec
23236 Generate (or do not generate) code using the @code{bras} instruction
23237 to do subroutine calls.
23238 This only works reliably if the total executable size does not
23239 exceed 64k.  The default is to use the @code{basr} instruction instead,
23240 which does not have this limitation.
23242 @item -m64
23243 @itemx -m31
23244 @opindex m64
23245 @opindex m31
23246 When @option{-m31} is specified, generate code compliant to the
23247 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23248 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23249 particular to generate 64-bit instructions.  For the @samp{s390}
23250 targets, the default is @option{-m31}, while the @samp{s390x}
23251 targets default to @option{-m64}.
23253 @item -mzarch
23254 @itemx -mesa
23255 @opindex mzarch
23256 @opindex mesa
23257 When @option{-mzarch} is specified, generate code using the
23258 instructions available on z/Architecture.
23259 When @option{-mesa} is specified, generate code using the
23260 instructions available on ESA/390.  Note that @option{-mesa} is
23261 not possible with @option{-m64}.
23262 When generating code compliant to the GNU/Linux for S/390 ABI,
23263 the default is @option{-mesa}.  When generating code compliant
23264 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23266 @item -mhtm
23267 @itemx -mno-htm
23268 @opindex mhtm
23269 @opindex mno-htm
23270 The @option{-mhtm} option enables a set of builtins making use of
23271 instructions available with the transactional execution facility
23272 introduced with the IBM zEnterprise EC12 machine generation
23273 @ref{S/390 System z Built-in Functions}.
23274 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23276 @item -mvx
23277 @itemx -mno-vx
23278 @opindex mvx
23279 @opindex mno-vx
23280 When @option{-mvx} is specified, generate code using the instructions
23281 available with the vector extension facility introduced with the IBM
23282 z13 machine generation.
23283 This option changes the ABI for some vector type values with regard to
23284 alignment and calling conventions.  In case vector type values are
23285 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23286 command will be added to mark the resulting binary with the ABI used.
23287 @option{-mvx} is enabled by default when using @option{-march=z13}.
23289 @item -mzvector
23290 @itemx -mno-zvector
23291 @opindex mzvector
23292 @opindex mno-zvector
23293 The @option{-mzvector} option enables vector language extensions and
23294 builtins using instructions available with the vector extension
23295 facility introduced with the IBM z13 machine generation.
23296 This option adds support for @samp{vector} to be used as a keyword to
23297 define vector type variables and arguments.  @samp{vector} is only
23298 available when GNU extensions are enabled.  It will not be expanded
23299 when requesting strict standard compliance e.g. with @option{-std=c99}.
23300 In addition to the GCC low-level builtins @option{-mzvector} enables
23301 a set of builtins added for compatibility with AltiVec-style
23302 implementations like Power and Cell.  In order to make use of these
23303 builtins the header file @file{vecintrin.h} needs to be included.
23304 @option{-mzvector} is disabled by default.
23306 @item -mmvcle
23307 @itemx -mno-mvcle
23308 @opindex mmvcle
23309 @opindex mno-mvcle
23310 Generate (or do not generate) code using the @code{mvcle} instruction
23311 to perform block moves.  When @option{-mno-mvcle} is specified,
23312 use a @code{mvc} loop instead.  This is the default unless optimizing for
23313 size.
23315 @item -mdebug
23316 @itemx -mno-debug
23317 @opindex mdebug
23318 @opindex mno-debug
23319 Print (or do not print) additional debug information when compiling.
23320 The default is to not print debug information.
23322 @item -march=@var{cpu-type}
23323 @opindex march
23324 Generate code that runs on @var{cpu-type}, which is the name of a
23325 system representing a certain processor type.  Possible values for
23326 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23327 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23328 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23329 @samp{native}.
23331 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23332 @samp{g6} are deprecated and will be removed with future releases.
23334 Specifying @samp{native} as cpu type can be used to select the best
23335 architecture option for the host processor.
23336 @option{-march=native} has no effect if GCC does not recognize the
23337 processor.
23339 @item -mtune=@var{cpu-type}
23340 @opindex mtune
23341 Tune to @var{cpu-type} everything applicable about the generated code,
23342 except for the ABI and the set of available instructions.
23343 The list of @var{cpu-type} values is the same as for @option{-march}.
23344 The default is the value used for @option{-march}.
23346 @item -mtpf-trace
23347 @itemx -mno-tpf-trace
23348 @opindex mtpf-trace
23349 @opindex mno-tpf-trace
23350 Generate code that adds (does not add) in TPF OS specific branches to trace
23351 routines in the operating system.  This option is off by default, even
23352 when compiling for the TPF OS@.
23354 @item -mfused-madd
23355 @itemx -mno-fused-madd
23356 @opindex mfused-madd
23357 @opindex mno-fused-madd
23358 Generate code that uses (does not use) the floating-point multiply and
23359 accumulate instructions.  These instructions are generated by default if
23360 hardware floating point is used.
23362 @item -mwarn-framesize=@var{framesize}
23363 @opindex mwarn-framesize
23364 Emit a warning if the current function exceeds the given frame size.  Because
23365 this is a compile-time check it doesn't need to be a real problem when the program
23366 runs.  It is intended to identify functions that most probably cause
23367 a stack overflow.  It is useful to be used in an environment with limited stack
23368 size e.g.@: the linux kernel.
23370 @item -mwarn-dynamicstack
23371 @opindex mwarn-dynamicstack
23372 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23373 arrays.  This is generally a bad idea with a limited stack size.
23375 @item -mstack-guard=@var{stack-guard}
23376 @itemx -mstack-size=@var{stack-size}
23377 @opindex mstack-guard
23378 @opindex mstack-size
23379 If these options are provided the S/390 back end emits additional instructions in
23380 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23381 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23382 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23383 the frame size of the compiled function is chosen.
23384 These options are intended to be used to help debugging stack overflow problems.
23385 The additionally emitted code causes only little overhead and hence can also be
23386 used in production-like systems without greater performance degradation.  The given
23387 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23388 @var{stack-guard} without exceeding 64k.
23389 In order to be efficient the extra code makes the assumption that the stack starts
23390 at an address aligned to the value given by @var{stack-size}.
23391 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23393 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23394 @opindex mhotpatch
23395 If the hotpatch option is enabled, a ``hot-patching'' function
23396 prologue is generated for all functions in the compilation unit.
23397 The funtion label is prepended with the given number of two-byte
23398 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23399 the label, 2 * @var{post-halfwords} bytes are appended, using the
23400 largest NOP like instructions the architecture allows (maximum
23401 1000000).
23403 If both arguments are zero, hotpatching is disabled.
23405 This option can be overridden for individual functions with the
23406 @code{hotpatch} attribute.
23407 @end table
23409 @node Score Options
23410 @subsection Score Options
23411 @cindex Score Options
23413 These options are defined for Score implementations:
23415 @table @gcctabopt
23416 @item -meb
23417 @opindex meb
23418 Compile code for big-endian mode.  This is the default.
23420 @item -mel
23421 @opindex mel
23422 Compile code for little-endian mode.
23424 @item -mnhwloop
23425 @opindex mnhwloop
23426 Disable generation of @code{bcnz} instructions.
23428 @item -muls
23429 @opindex muls
23430 Enable generation of unaligned load and store instructions.
23432 @item -mmac
23433 @opindex mmac
23434 Enable the use of multiply-accumulate instructions. Disabled by default.
23436 @item -mscore5
23437 @opindex mscore5
23438 Specify the SCORE5 as the target architecture.
23440 @item -mscore5u
23441 @opindex mscore5u
23442 Specify the SCORE5U of the target architecture.
23444 @item -mscore7
23445 @opindex mscore7
23446 Specify the SCORE7 as the target architecture. This is the default.
23448 @item -mscore7d
23449 @opindex mscore7d
23450 Specify the SCORE7D as the target architecture.
23451 @end table
23453 @node SH Options
23454 @subsection SH Options
23456 These @samp{-m} options are defined for the SH implementations:
23458 @table @gcctabopt
23459 @item -m1
23460 @opindex m1
23461 Generate code for the SH1.
23463 @item -m2
23464 @opindex m2
23465 Generate code for the SH2.
23467 @item -m2e
23468 Generate code for the SH2e.
23470 @item -m2a-nofpu
23471 @opindex m2a-nofpu
23472 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23473 that the floating-point unit is not used.
23475 @item -m2a-single-only
23476 @opindex m2a-single-only
23477 Generate code for the SH2a-FPU, in such a way that no double-precision
23478 floating-point operations are used.
23480 @item -m2a-single
23481 @opindex m2a-single
23482 Generate code for the SH2a-FPU assuming the floating-point unit is in
23483 single-precision mode by default.
23485 @item -m2a
23486 @opindex m2a
23487 Generate code for the SH2a-FPU assuming the floating-point unit is in
23488 double-precision mode by default.
23490 @item -m3
23491 @opindex m3
23492 Generate code for the SH3.
23494 @item -m3e
23495 @opindex m3e
23496 Generate code for the SH3e.
23498 @item -m4-nofpu
23499 @opindex m4-nofpu
23500 Generate code for the SH4 without a floating-point unit.
23502 @item -m4-single-only
23503 @opindex m4-single-only
23504 Generate code for the SH4 with a floating-point unit that only
23505 supports single-precision arithmetic.
23507 @item -m4-single
23508 @opindex m4-single
23509 Generate code for the SH4 assuming the floating-point unit is in
23510 single-precision mode by default.
23512 @item -m4
23513 @opindex m4
23514 Generate code for the SH4.
23516 @item -m4-100
23517 @opindex m4-100
23518 Generate code for SH4-100.
23520 @item -m4-100-nofpu
23521 @opindex m4-100-nofpu
23522 Generate code for SH4-100 in such a way that the
23523 floating-point unit is not used.
23525 @item -m4-100-single
23526 @opindex m4-100-single
23527 Generate code for SH4-100 assuming the floating-point unit is in
23528 single-precision mode by default.
23530 @item -m4-100-single-only
23531 @opindex m4-100-single-only
23532 Generate code for SH4-100 in such a way that no double-precision
23533 floating-point operations are used.
23535 @item -m4-200
23536 @opindex m4-200
23537 Generate code for SH4-200.
23539 @item -m4-200-nofpu
23540 @opindex m4-200-nofpu
23541 Generate code for SH4-200 without in such a way that the
23542 floating-point unit is not used.
23544 @item -m4-200-single
23545 @opindex m4-200-single
23546 Generate code for SH4-200 assuming the floating-point unit is in
23547 single-precision mode by default.
23549 @item -m4-200-single-only
23550 @opindex m4-200-single-only
23551 Generate code for SH4-200 in such a way that no double-precision
23552 floating-point operations are used.
23554 @item -m4-300
23555 @opindex m4-300
23556 Generate code for SH4-300.
23558 @item -m4-300-nofpu
23559 @opindex m4-300-nofpu
23560 Generate code for SH4-300 without in such a way that the
23561 floating-point unit is not used.
23563 @item -m4-300-single
23564 @opindex m4-300-single
23565 Generate code for SH4-300 in such a way that no double-precision
23566 floating-point operations are used.
23568 @item -m4-300-single-only
23569 @opindex m4-300-single-only
23570 Generate code for SH4-300 in such a way that no double-precision
23571 floating-point operations are used.
23573 @item -m4-340
23574 @opindex m4-340
23575 Generate code for SH4-340 (no MMU, no FPU).
23577 @item -m4-500
23578 @opindex m4-500
23579 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23580 assembler.
23582 @item -m4a-nofpu
23583 @opindex m4a-nofpu
23584 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23585 floating-point unit is not used.
23587 @item -m4a-single-only
23588 @opindex m4a-single-only
23589 Generate code for the SH4a, in such a way that no double-precision
23590 floating-point operations are used.
23592 @item -m4a-single
23593 @opindex m4a-single
23594 Generate code for the SH4a assuming the floating-point unit is in
23595 single-precision mode by default.
23597 @item -m4a
23598 @opindex m4a
23599 Generate code for the SH4a.
23601 @item -m4al
23602 @opindex m4al
23603 Same as @option{-m4a-nofpu}, except that it implicitly passes
23604 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23605 instructions at the moment.
23607 @item -mb
23608 @opindex mb
23609 Compile code for the processor in big-endian mode.
23611 @item -ml
23612 @opindex ml
23613 Compile code for the processor in little-endian mode.
23615 @item -mdalign
23616 @opindex mdalign
23617 Align doubles at 64-bit boundaries.  Note that this changes the calling
23618 conventions, and thus some functions from the standard C library do
23619 not work unless you recompile it first with @option{-mdalign}.
23621 @item -mrelax
23622 @opindex mrelax
23623 Shorten some address references at link time, when possible; uses the
23624 linker option @option{-relax}.
23626 @item -mbigtable
23627 @opindex mbigtable
23628 Use 32-bit offsets in @code{switch} tables.  The default is to use
23629 16-bit offsets.
23631 @item -mbitops
23632 @opindex mbitops
23633 Enable the use of bit manipulation instructions on SH2A.
23635 @item -mfmovd
23636 @opindex mfmovd
23637 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23638 alignment constraints.
23640 @item -mrenesas
23641 @opindex mrenesas
23642 Comply with the calling conventions defined by Renesas.
23644 @item -mno-renesas
23645 @opindex mno-renesas
23646 Comply with the calling conventions defined for GCC before the Renesas
23647 conventions were available.  This option is the default for all
23648 targets of the SH toolchain.
23650 @item -mnomacsave
23651 @opindex mnomacsave
23652 Mark the @code{MAC} register as call-clobbered, even if
23653 @option{-mrenesas} is given.
23655 @item -mieee
23656 @itemx -mno-ieee
23657 @opindex mieee
23658 @opindex mno-ieee
23659 Control the IEEE compliance of floating-point comparisons, which affects the
23660 handling of cases where the result of a comparison is unordered.  By default
23661 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23662 enabled @option{-mno-ieee} is implicitly set, which results in faster
23663 floating-point greater-equal and less-equal comparisons.  The implicit settings
23664 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23666 @item -minline-ic_invalidate
23667 @opindex minline-ic_invalidate
23668 Inline code to invalidate instruction cache entries after setting up
23669 nested function trampolines.
23670 This option has no effect if @option{-musermode} is in effect and the selected
23671 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23672 instruction.
23673 If the selected code generation option does not allow the use of the @code{icbi}
23674 instruction, and @option{-musermode} is not in effect, the inlined code
23675 manipulates the instruction cache address array directly with an associative
23676 write.  This not only requires privileged mode at run time, but it also
23677 fails if the cache line had been mapped via the TLB and has become unmapped.
23679 @item -misize
23680 @opindex misize
23681 Dump instruction size and location in the assembly code.
23683 @item -mpadstruct
23684 @opindex mpadstruct
23685 This option is deprecated.  It pads structures to multiple of 4 bytes,
23686 which is incompatible with the SH ABI@.
23688 @item -matomic-model=@var{model}
23689 @opindex matomic-model=@var{model}
23690 Sets the model of atomic operations and additional parameters as a comma
23691 separated list.  For details on the atomic built-in functions see
23692 @ref{__atomic Builtins}.  The following models and parameters are supported:
23694 @table @samp
23696 @item none
23697 Disable compiler generated atomic sequences and emit library calls for atomic
23698 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23700 @item soft-gusa
23701 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23702 built-in functions.  The generated atomic sequences require additional support
23703 from the interrupt/exception handling code of the system and are only suitable
23704 for SH3* and SH4* single-core systems.  This option is enabled by default when
23705 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23706 this option also partially utilizes the hardware atomic instructions
23707 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23708 @samp{strict} is specified.  
23710 @item soft-tcb
23711 Generate software atomic sequences that use a variable in the thread control
23712 block.  This is a variation of the gUSA sequences which can also be used on
23713 SH1* and SH2* targets.  The generated atomic sequences require additional
23714 support from the interrupt/exception handling code of the system and are only
23715 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23716 parameter has to be specified as well.
23718 @item soft-imask
23719 Generate software atomic sequences that temporarily disable interrupts by
23720 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23721 in privileged mode and is only suitable for single-core systems.  Additional
23722 support from the interrupt/exception handling code of the system is not
23723 required.  This model is enabled by default when the target is
23724 @code{sh*-*-linux*} and SH1* or SH2*.
23726 @item hard-llcs
23727 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23728 instructions only.  This is only available on SH4A and is suitable for
23729 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23730 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23731 Code compiled with this option is also compatible with other software
23732 atomic model interrupt/exception handling systems if executed on an SH4A
23733 system.  Additional support from the interrupt/exception handling code of the
23734 system is not required for this model.
23736 @item gbr-offset=
23737 This parameter specifies the offset in bytes of the variable in the thread
23738 control block structure that should be used by the generated atomic sequences
23739 when the @samp{soft-tcb} model has been selected.  For other models this
23740 parameter is ignored.  The specified value must be an integer multiple of four
23741 and in the range 0-1020.
23743 @item strict
23744 This parameter prevents mixed usage of multiple atomic models, even if they
23745 are compatible, and makes the compiler generate atomic sequences of the
23746 specified model only.
23748 @end table
23750 @item -mtas
23751 @opindex mtas
23752 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
23753 Notice that depending on the particular hardware and software configuration
23754 this can degrade overall performance due to the operand cache line flushes
23755 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
23756 processors the @code{tas.b} instruction must be used with caution since it
23757 can result in data corruption for certain cache configurations.
23759 @item -mprefergot
23760 @opindex mprefergot
23761 When generating position-independent code, emit function calls using
23762 the Global Offset Table instead of the Procedure Linkage Table.
23764 @item -musermode
23765 @itemx -mno-usermode
23766 @opindex musermode
23767 @opindex mno-usermode
23768 Don't allow (allow) the compiler generating privileged mode code.  Specifying
23769 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
23770 inlined code would not work in user mode.  @option{-musermode} is the default
23771 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
23772 @option{-musermode} has no effect, since there is no user mode.
23774 @item -multcost=@var{number}
23775 @opindex multcost=@var{number}
23776 Set the cost to assume for a multiply insn.
23778 @item -mdiv=@var{strategy}
23779 @opindex mdiv=@var{strategy}
23780 Set the division strategy to be used for integer division operations.
23781 @var{strategy} can be one of: 
23783 @table @samp
23785 @item call-div1
23786 Calls a library function that uses the single-step division instruction
23787 @code{div1} to perform the operation.  Division by zero calculates an
23788 unspecified result and does not trap.  This is the default except for SH4,
23789 SH2A and SHcompact.
23791 @item call-fp
23792 Calls a library function that performs the operation in double precision
23793 floating point.  Division by zero causes a floating-point exception.  This is
23794 the default for SHcompact with FPU.  Specifying this for targets that do not
23795 have a double precision FPU defaults to @code{call-div1}.
23797 @item call-table
23798 Calls a library function that uses a lookup table for small divisors and
23799 the @code{div1} instruction with case distinction for larger divisors.  Division
23800 by zero calculates an unspecified result and does not trap.  This is the default
23801 for SH4.  Specifying this for targets that do not have dynamic shift
23802 instructions defaults to @code{call-div1}.
23804 @end table
23806 When a division strategy has not been specified the default strategy is
23807 selected based on the current target.  For SH2A the default strategy is to
23808 use the @code{divs} and @code{divu} instructions instead of library function
23809 calls.
23811 @item -maccumulate-outgoing-args
23812 @opindex maccumulate-outgoing-args
23813 Reserve space once for outgoing arguments in the function prologue rather
23814 than around each call.  Generally beneficial for performance and size.  Also
23815 needed for unwinding to avoid changing the stack frame around conditional code.
23817 @item -mdivsi3_libfunc=@var{name}
23818 @opindex mdivsi3_libfunc=@var{name}
23819 Set the name of the library function used for 32-bit signed division to
23820 @var{name}.
23821 This only affects the name used in the @samp{call} division strategies, and
23822 the compiler still expects the same sets of input/output/clobbered registers as
23823 if this option were not present.
23825 @item -mfixed-range=@var{register-range}
23826 @opindex mfixed-range
23827 Generate code treating the given register range as fixed registers.
23828 A fixed register is one that the register allocator can not use.  This is
23829 useful when compiling kernel code.  A register range is specified as
23830 two registers separated by a dash.  Multiple register ranges can be
23831 specified separated by a comma.
23833 @item -mbranch-cost=@var{num}
23834 @opindex mbranch-cost=@var{num}
23835 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23836 make the compiler try to generate more branch-free code if possible.  
23837 If not specified the value is selected depending on the processor type that
23838 is being compiled for.
23840 @item -mzdcbranch
23841 @itemx -mno-zdcbranch
23842 @opindex mzdcbranch
23843 @opindex mno-zdcbranch
23844 Assume (do not assume) that zero displacement conditional branch instructions
23845 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23846 compiler prefers zero displacement branch code sequences.  This is
23847 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23848 disabled by specifying @option{-mno-zdcbranch}.
23850 @item -mcbranch-force-delay-slot
23851 @opindex mcbranch-force-delay-slot
23852 Force the usage of delay slots for conditional branches, which stuffs the delay
23853 slot with a @code{nop} if a suitable instruction cannot be found.  By default
23854 this option is disabled.  It can be enabled to work around hardware bugs as
23855 found in the original SH7055.
23857 @item -mfused-madd
23858 @itemx -mno-fused-madd
23859 @opindex mfused-madd
23860 @opindex mno-fused-madd
23861 Generate code that uses (does not use) the floating-point multiply and
23862 accumulate instructions.  These instructions are generated by default
23863 if hardware floating point is used.  The machine-dependent
23864 @option{-mfused-madd} option is now mapped to the machine-independent
23865 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23866 mapped to @option{-ffp-contract=off}.
23868 @item -mfsca
23869 @itemx -mno-fsca
23870 @opindex mfsca
23871 @opindex mno-fsca
23872 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23873 and cosine approximations.  The option @option{-mfsca} must be used in
23874 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23875 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23876 approximations even if @option{-funsafe-math-optimizations} is in effect.
23878 @item -mfsrra
23879 @itemx -mno-fsrra
23880 @opindex mfsrra
23881 @opindex mno-fsrra
23882 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23883 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23884 in combination with @option{-funsafe-math-optimizations} and
23885 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23886 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23887 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23888 in effect.
23890 @item -mpretend-cmove
23891 @opindex mpretend-cmove
23892 Prefer zero-displacement conditional branches for conditional move instruction
23893 patterns.  This can result in faster code on the SH4 processor.
23895 @item -mfdpic
23896 @opindex fdpic
23897 Generate code using the FDPIC ABI.
23899 @end table
23901 @node Solaris 2 Options
23902 @subsection Solaris 2 Options
23903 @cindex Solaris 2 options
23905 These @samp{-m} options are supported on Solaris 2:
23907 @table @gcctabopt
23908 @item -mclear-hwcap
23909 @opindex mclear-hwcap
23910 @option{-mclear-hwcap} tells the compiler to remove the hardware
23911 capabilities generated by the Solaris assembler.  This is only necessary
23912 when object files use ISA extensions not supported by the current
23913 machine, but check at runtime whether or not to use them.
23915 @item -mimpure-text
23916 @opindex mimpure-text
23917 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23918 the compiler to not pass @option{-z text} to the linker when linking a
23919 shared object.  Using this option, you can link position-dependent
23920 code into a shared object.
23922 @option{-mimpure-text} suppresses the ``relocations remain against
23923 allocatable but non-writable sections'' linker error message.
23924 However, the necessary relocations trigger copy-on-write, and the
23925 shared object is not actually shared across processes.  Instead of
23926 using @option{-mimpure-text}, you should compile all source code with
23927 @option{-fpic} or @option{-fPIC}.
23929 @end table
23931 These switches are supported in addition to the above on Solaris 2:
23933 @table @gcctabopt
23934 @item -pthreads
23935 @opindex pthreads
23936 This is a synonym for @option{-pthread}.
23937 @end table
23939 @node SPARC Options
23940 @subsection SPARC Options
23941 @cindex SPARC options
23943 These @samp{-m} options are supported on the SPARC:
23945 @table @gcctabopt
23946 @item -mno-app-regs
23947 @itemx -mapp-regs
23948 @opindex mno-app-regs
23949 @opindex mapp-regs
23950 Specify @option{-mapp-regs} to generate output using the global registers
23951 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
23952 global register 1, each global register 2 through 4 is then treated as an
23953 allocable register that is clobbered by function calls.  This is the default.
23955 To be fully SVR4 ABI-compliant at the cost of some performance loss,
23956 specify @option{-mno-app-regs}.  You should compile libraries and system
23957 software with this option.
23959 @item -mflat
23960 @itemx -mno-flat
23961 @opindex mflat
23962 @opindex mno-flat
23963 With @option{-mflat}, the compiler does not generate save/restore instructions
23964 and uses a ``flat'' or single register window model.  This model is compatible
23965 with the regular register window model.  The local registers and the input
23966 registers (0--5) are still treated as ``call-saved'' registers and are
23967 saved on the stack as needed.
23969 With @option{-mno-flat} (the default), the compiler generates save/restore
23970 instructions (except for leaf functions).  This is the normal operating mode.
23972 @item -mfpu
23973 @itemx -mhard-float
23974 @opindex mfpu
23975 @opindex mhard-float
23976 Generate output containing floating-point instructions.  This is the
23977 default.
23979 @item -mno-fpu
23980 @itemx -msoft-float
23981 @opindex mno-fpu
23982 @opindex msoft-float
23983 Generate output containing library calls for floating point.
23984 @strong{Warning:} the requisite libraries are not available for all SPARC
23985 targets.  Normally the facilities of the machine's usual C compiler are
23986 used, but this cannot be done directly in cross-compilation.  You must make
23987 your own arrangements to provide suitable library functions for
23988 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
23989 @samp{sparclite-*-*} do provide software floating-point support.
23991 @option{-msoft-float} changes the calling convention in the output file;
23992 therefore, it is only useful if you compile @emph{all} of a program with
23993 this option.  In particular, you need to compile @file{libgcc.a}, the
23994 library that comes with GCC, with @option{-msoft-float} in order for
23995 this to work.
23997 @item -mhard-quad-float
23998 @opindex mhard-quad-float
23999 Generate output containing quad-word (long double) floating-point
24000 instructions.
24002 @item -msoft-quad-float
24003 @opindex msoft-quad-float
24004 Generate output containing library calls for quad-word (long double)
24005 floating-point instructions.  The functions called are those specified
24006 in the SPARC ABI@.  This is the default.
24008 As of this writing, there are no SPARC implementations that have hardware
24009 support for the quad-word floating-point instructions.  They all invoke
24010 a trap handler for one of these instructions, and then the trap handler
24011 emulates the effect of the instruction.  Because of the trap handler overhead,
24012 this is much slower than calling the ABI library routines.  Thus the
24013 @option{-msoft-quad-float} option is the default.
24015 @item -mno-unaligned-doubles
24016 @itemx -munaligned-doubles
24017 @opindex mno-unaligned-doubles
24018 @opindex munaligned-doubles
24019 Assume that doubles have 8-byte alignment.  This is the default.
24021 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
24022 alignment only if they are contained in another type, or if they have an
24023 absolute address.  Otherwise, it assumes they have 4-byte alignment.
24024 Specifying this option avoids some rare compatibility problems with code
24025 generated by other compilers.  It is not the default because it results
24026 in a performance loss, especially for floating-point code.
24028 @item -muser-mode
24029 @itemx -mno-user-mode
24030 @opindex muser-mode
24031 @opindex mno-user-mode
24032 Do not generate code that can only run in supervisor mode.  This is relevant
24033 only for the @code{casa} instruction emitted for the LEON3 processor.  This
24034 is the default.
24036 @item -mfaster-structs
24037 @itemx -mno-faster-structs
24038 @opindex mfaster-structs
24039 @opindex mno-faster-structs
24040 With @option{-mfaster-structs}, the compiler assumes that structures
24041 should have 8-byte alignment.  This enables the use of pairs of
24042 @code{ldd} and @code{std} instructions for copies in structure
24043 assignment, in place of twice as many @code{ld} and @code{st} pairs.
24044 However, the use of this changed alignment directly violates the SPARC
24045 ABI@.  Thus, it's intended only for use on targets where the developer
24046 acknowledges that their resulting code is not directly in line with
24047 the rules of the ABI@.
24049 @item -mstd-struct-return
24050 @itemx -mno-std-struct-return
24051 @opindex mstd-struct-return
24052 @opindex mno-std-struct-return
24053 With @option{-mstd-struct-return}, the compiler generates checking code
24054 in functions returning structures or unions to detect size mismatches
24055 between the two sides of function calls, as per the 32-bit ABI@.
24057 The default is @option{-mno-std-struct-return}.  This option has no effect
24058 in 64-bit mode.
24060 @item -mlra
24061 @itemx -mno-lra
24062 @opindex mlra
24063 @opindex mno-lra
24064 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
24065 so @option{-mno-lra} needs to be passed to get old Reload.
24067 @item -mcpu=@var{cpu_type}
24068 @opindex mcpu
24069 Set the instruction set, register set, and instruction scheduling parameters
24070 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24071 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
24072 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
24073 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
24074 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
24075 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
24077 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
24078 which selects the best architecture option for the host processor.
24079 @option{-mcpu=native} has no effect if GCC does not recognize
24080 the processor.
24082 Default instruction scheduling parameters are used for values that select
24083 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
24084 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
24086 Here is a list of each supported architecture and their supported
24087 implementations.
24089 @table @asis
24090 @item v7
24091 cypress, leon3v7
24093 @item v8
24094 supersparc, hypersparc, leon, leon3
24096 @item sparclite
24097 f930, f934, sparclite86x
24099 @item sparclet
24100 tsc701
24102 @item v9
24103 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
24104 niagara7, m8
24105 @end table
24107 By default (unless configured otherwise), GCC generates code for the V7
24108 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
24109 additionally optimizes it for the Cypress CY7C602 chip, as used in the
24110 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
24111 SPARCStation 1, 2, IPX etc.
24113 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
24114 architecture.  The only difference from V7 code is that the compiler emits
24115 the integer multiply and integer divide instructions which exist in SPARC-V8
24116 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
24117 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
24118 2000 series.
24120 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
24121 the SPARC architecture.  This adds the integer multiply, integer divide step
24122 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
24123 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
24124 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
24125 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
24126 MB86934 chip, which is the more recent SPARClite with FPU@.
24128 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
24129 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
24130 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
24131 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
24132 optimizes it for the TEMIC SPARClet chip.
24134 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
24135 architecture.  This adds 64-bit integer and floating-point move instructions,
24136 3 additional floating-point condition code registers and conditional move
24137 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
24138 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
24139 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
24140 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
24141 @option{-mcpu=niagara}, the compiler additionally optimizes it for
24142 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
24143 additionally optimizes it for Sun UltraSPARC T2 chips. With
24144 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
24145 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
24146 additionally optimizes it for Sun UltraSPARC T4 chips.  With
24147 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
24148 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
24149 additionally optimizes it for Oracle M8 chips.
24151 @item -mtune=@var{cpu_type}
24152 @opindex mtune
24153 Set the instruction scheduling parameters for machine type
24154 @var{cpu_type}, but do not set the instruction set or register set that the
24155 option @option{-mcpu=@var{cpu_type}} does.
24157 The same values for @option{-mcpu=@var{cpu_type}} can be used for
24158 @option{-mtune=@var{cpu_type}}, but the only useful values are those
24159 that select a particular CPU implementation.  Those are
24160 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
24161 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
24162 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
24163 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
24164 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
24165 and GNU/Linux toolchains, @samp{native} can also be used.
24167 @item -mv8plus
24168 @itemx -mno-v8plus
24169 @opindex mv8plus
24170 @opindex mno-v8plus
24171 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
24172 difference from the V8 ABI is that the global and out registers are
24173 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
24174 mode for all SPARC-V9 processors.
24176 @item -mvis
24177 @itemx -mno-vis
24178 @opindex mvis
24179 @opindex mno-vis
24180 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
24181 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
24183 @item -mvis2
24184 @itemx -mno-vis2
24185 @opindex mvis2
24186 @opindex mno-vis2
24187 With @option{-mvis2}, GCC generates code that takes advantage of
24188 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
24189 default is @option{-mvis2} when targeting a cpu that supports such
24190 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
24191 also sets @option{-mvis}.
24193 @item -mvis3
24194 @itemx -mno-vis3
24195 @opindex mvis3
24196 @opindex mno-vis3
24197 With @option{-mvis3}, GCC generates code that takes advantage of
24198 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24199 default is @option{-mvis3} when targeting a cpu that supports such
24200 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24201 also sets @option{-mvis2} and @option{-mvis}.
24203 @item -mvis4
24204 @itemx -mno-vis4
24205 @opindex mvis4
24206 @opindex mno-vis4
24207 With @option{-mvis4}, GCC generates code that takes advantage of
24208 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24209 default is @option{-mvis4} when targeting a cpu that supports such
24210 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24211 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24213 @item -mvis4b
24214 @itemx -mno-vis4b
24215 @opindex mvis4b
24216 @opindex mno-vis4b
24217 With @option{-mvis4b}, GCC generates code that takes advantage of
24218 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
24219 the additional VIS instructions introduced in the Oracle SPARC
24220 Architecture 2017.  The default is @option{-mvis4b} when targeting a
24221 cpu that supports such instructions, such as m8 and later.  Setting
24222 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
24223 @option{-mvis2} and @option{-mvis}.
24225 @item -mcbcond
24226 @itemx -mno-cbcond
24227 @opindex mcbcond
24228 @opindex mno-cbcond
24229 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24230 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24231 when targeting a CPU that supports such instructions, such as Niagara-4 and
24232 later.
24234 @item -mfmaf
24235 @itemx -mno-fmaf
24236 @opindex mfmaf
24237 @opindex mno-fmaf
24238 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24239 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24240 when targeting a CPU that supports such instructions, such as Niagara-3 and
24241 later.
24243 @item -mfsmuld
24244 @itemx -mno-fsmuld
24245 @opindex mfsmuld
24246 @opindex mno-fsmuld
24247 With @option{-mfsmuld}, GCC generates code that takes advantage of the
24248 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
24249 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
24250 or V9 with FPU except @option{-mcpu=leon}.
24252 @item -mpopc
24253 @itemx -mno-popc
24254 @opindex mpopc
24255 @opindex mno-popc
24256 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24257 Population Count instruction.  The default is @option{-mpopc}
24258 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24259 later.
24261 @item -msubxc
24262 @itemx -mno-subxc
24263 @opindex msubxc
24264 @opindex mno-subxc
24265 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24266 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24267 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24268 later.
24270 @item -mfix-at697f
24271 @opindex mfix-at697f
24272 Enable the documented workaround for the single erratum of the Atmel AT697F
24273 processor (which corresponds to erratum #13 of the AT697E processor).
24275 @item -mfix-ut699
24276 @opindex mfix-ut699
24277 Enable the documented workarounds for the floating-point errata and the data
24278 cache nullify errata of the UT699 processor.
24280 @item -mfix-ut700
24281 @opindex mfix-ut700
24282 Enable the documented workaround for the back-to-back store errata of
24283 the UT699E/UT700 processor.
24285 @item -mfix-gr712rc
24286 @opindex mfix-gr712rc
24287 Enable the documented workaround for the back-to-back store errata of
24288 the GR712RC processor.
24289 @end table
24291 These @samp{-m} options are supported in addition to the above
24292 on SPARC-V9 processors in 64-bit environments:
24294 @table @gcctabopt
24295 @item -m32
24296 @itemx -m64
24297 @opindex m32
24298 @opindex m64
24299 Generate code for a 32-bit or 64-bit environment.
24300 The 32-bit environment sets int, long and pointer to 32 bits.
24301 The 64-bit environment sets int to 32 bits and long and pointer
24302 to 64 bits.
24304 @item -mcmodel=@var{which}
24305 @opindex mcmodel
24306 Set the code model to one of
24308 @table @samp
24309 @item medlow
24310 The Medium/Low code model: 64-bit addresses, programs
24311 must be linked in the low 32 bits of memory.  Programs can be statically
24312 or dynamically linked.
24314 @item medmid
24315 The Medium/Middle code model: 64-bit addresses, programs
24316 must be linked in the low 44 bits of memory, the text and data segments must
24317 be less than 2GB in size and the data segment must be located within 2GB of
24318 the text segment.
24320 @item medany
24321 The Medium/Anywhere code model: 64-bit addresses, programs
24322 may be linked anywhere in memory, the text and data segments must be less
24323 than 2GB in size and the data segment must be located within 2GB of the
24324 text segment.
24326 @item embmedany
24327 The Medium/Anywhere code model for embedded systems:
24328 64-bit addresses, the text and data segments must be less than 2GB in
24329 size, both starting anywhere in memory (determined at link time).  The
24330 global register %g4 points to the base of the data segment.  Programs
24331 are statically linked and PIC is not supported.
24332 @end table
24334 @item -mmemory-model=@var{mem-model}
24335 @opindex mmemory-model
24336 Set the memory model in force on the processor to one of
24338 @table @samp
24339 @item default
24340 The default memory model for the processor and operating system.
24342 @item rmo
24343 Relaxed Memory Order
24345 @item pso
24346 Partial Store Order
24348 @item tso
24349 Total Store Order
24351 @item sc
24352 Sequential Consistency
24353 @end table
24355 These memory models are formally defined in Appendix D of the SPARC-V9
24356 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24358 @item -mstack-bias
24359 @itemx -mno-stack-bias
24360 @opindex mstack-bias
24361 @opindex mno-stack-bias
24362 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24363 frame pointer if present, are offset by @minus{}2047 which must be added back
24364 when making stack frame references.  This is the default in 64-bit mode.
24365 Otherwise, assume no such offset is present.
24366 @end table
24368 @node SPU Options
24369 @subsection SPU Options
24370 @cindex SPU options
24372 These @samp{-m} options are supported on the SPU:
24374 @table @gcctabopt
24375 @item -mwarn-reloc
24376 @itemx -merror-reloc
24377 @opindex mwarn-reloc
24378 @opindex merror-reloc
24380 The loader for SPU does not handle dynamic relocations.  By default, GCC
24381 gives an error when it generates code that requires a dynamic
24382 relocation.  @option{-mno-error-reloc} disables the error,
24383 @option{-mwarn-reloc} generates a warning instead.
24385 @item -msafe-dma
24386 @itemx -munsafe-dma
24387 @opindex msafe-dma
24388 @opindex munsafe-dma
24390 Instructions that initiate or test completion of DMA must not be
24391 reordered with respect to loads and stores of the memory that is being
24392 accessed.
24393 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24394 memory accesses, but that can lead to inefficient code in places where the
24395 memory is known to not change.  Rather than mark the memory as volatile,
24396 you can use @option{-msafe-dma} to tell the compiler to treat
24397 the DMA instructions as potentially affecting all memory.  
24399 @item -mbranch-hints
24400 @opindex mbranch-hints
24402 By default, GCC generates a branch hint instruction to avoid
24403 pipeline stalls for always-taken or probably-taken branches.  A hint
24404 is not generated closer than 8 instructions away from its branch.
24405 There is little reason to disable them, except for debugging purposes,
24406 or to make an object a little bit smaller.
24408 @item -msmall-mem
24409 @itemx -mlarge-mem
24410 @opindex msmall-mem
24411 @opindex mlarge-mem
24413 By default, GCC generates code assuming that addresses are never larger
24414 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24415 a full 32-bit address.
24417 @item -mstdmain
24418 @opindex mstdmain
24420 By default, GCC links against startup code that assumes the SPU-style
24421 main function interface (which has an unconventional parameter list).
24422 With @option{-mstdmain}, GCC links your program against startup
24423 code that assumes a C99-style interface to @code{main}, including a
24424 local copy of @code{argv} strings.
24426 @item -mfixed-range=@var{register-range}
24427 @opindex mfixed-range
24428 Generate code treating the given register range as fixed registers.
24429 A fixed register is one that the register allocator cannot use.  This is
24430 useful when compiling kernel code.  A register range is specified as
24431 two registers separated by a dash.  Multiple register ranges can be
24432 specified separated by a comma.
24434 @item -mea32
24435 @itemx -mea64
24436 @opindex mea32
24437 @opindex mea64
24438 Compile code assuming that pointers to the PPU address space accessed
24439 via the @code{__ea} named address space qualifier are either 32 or 64
24440 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24441 all object code in an executable must be compiled with the same setting.
24443 @item -maddress-space-conversion
24444 @itemx -mno-address-space-conversion
24445 @opindex maddress-space-conversion
24446 @opindex mno-address-space-conversion
24447 Allow/disallow treating the @code{__ea} address space as superset
24448 of the generic address space.  This enables explicit type casts
24449 between @code{__ea} and generic pointer as well as implicit
24450 conversions of generic pointers to @code{__ea} pointers.  The
24451 default is to allow address space pointer conversions.
24453 @item -mcache-size=@var{cache-size}
24454 @opindex mcache-size
24455 This option controls the version of libgcc that the compiler links to an
24456 executable and selects a software-managed cache for accessing variables
24457 in the @code{__ea} address space with a particular cache size.  Possible
24458 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24459 and @samp{128}.  The default cache size is 64KB.
24461 @item -matomic-updates
24462 @itemx -mno-atomic-updates
24463 @opindex matomic-updates
24464 @opindex mno-atomic-updates
24465 This option controls the version of libgcc that the compiler links to an
24466 executable and selects whether atomic updates to the software-managed
24467 cache of PPU-side variables are used.  If you use atomic updates, changes
24468 to a PPU variable from SPU code using the @code{__ea} named address space
24469 qualifier do not interfere with changes to other PPU variables residing
24470 in the same cache line from PPU code.  If you do not use atomic updates,
24471 such interference may occur; however, writing back cache lines is
24472 more efficient.  The default behavior is to use atomic updates.
24474 @item -mdual-nops
24475 @itemx -mdual-nops=@var{n}
24476 @opindex mdual-nops
24477 By default, GCC inserts NOPs to increase dual issue when it expects
24478 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24479 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24480 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24482 @item -mhint-max-nops=@var{n}
24483 @opindex mhint-max-nops
24484 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24485 be at least 8 instructions away from the branch it is affecting.  GCC
24486 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24487 generate the branch hint.
24489 @item -mhint-max-distance=@var{n}
24490 @opindex mhint-max-distance
24491 The encoding of the branch hint instruction limits the hint to be within
24492 256 instructions of the branch it is affecting.  By default, GCC makes
24493 sure it is within 125.
24495 @item -msafe-hints
24496 @opindex msafe-hints
24497 Work around a hardware bug that causes the SPU to stall indefinitely.
24498 By default, GCC inserts the @code{hbrp} instruction to make sure
24499 this stall won't happen.
24501 @end table
24503 @node System V Options
24504 @subsection Options for System V
24506 These additional options are available on System V Release 4 for
24507 compatibility with other compilers on those systems:
24509 @table @gcctabopt
24510 @item -G
24511 @opindex G
24512 Create a shared object.
24513 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24515 @item -Qy
24516 @opindex Qy
24517 Identify the versions of each tool used by the compiler, in a
24518 @code{.ident} assembler directive in the output.
24520 @item -Qn
24521 @opindex Qn
24522 Refrain from adding @code{.ident} directives to the output file (this is
24523 the default).
24525 @item -YP,@var{dirs}
24526 @opindex YP
24527 Search the directories @var{dirs}, and no others, for libraries
24528 specified with @option{-l}.
24530 @item -Ym,@var{dir}
24531 @opindex Ym
24532 Look in the directory @var{dir} to find the M4 preprocessor.
24533 The assembler uses this option.
24534 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24535 @c the generic assembler that comes with Solaris takes just -Ym.
24536 @end table
24538 @node TILE-Gx Options
24539 @subsection TILE-Gx Options
24540 @cindex TILE-Gx options
24542 These @samp{-m} options are supported on the TILE-Gx:
24544 @table @gcctabopt
24545 @item -mcmodel=small
24546 @opindex mcmodel=small
24547 Generate code for the small model.  The distance for direct calls is
24548 limited to 500M in either direction.  PC-relative addresses are 32
24549 bits.  Absolute addresses support the full address range.
24551 @item -mcmodel=large
24552 @opindex mcmodel=large
24553 Generate code for the large model.  There is no limitation on call
24554 distance, pc-relative addresses, or absolute addresses.
24556 @item -mcpu=@var{name}
24557 @opindex mcpu
24558 Selects the type of CPU to be targeted.  Currently the only supported
24559 type is @samp{tilegx}.
24561 @item -m32
24562 @itemx -m64
24563 @opindex m32
24564 @opindex m64
24565 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24566 environment sets int, long, and pointer to 32 bits.  The 64-bit
24567 environment sets int to 32 bits and long and pointer to 64 bits.
24569 @item -mbig-endian
24570 @itemx -mlittle-endian
24571 @opindex mbig-endian
24572 @opindex mlittle-endian
24573 Generate code in big/little endian mode, respectively.
24574 @end table
24576 @node TILEPro Options
24577 @subsection TILEPro Options
24578 @cindex TILEPro options
24580 These @samp{-m} options are supported on the TILEPro:
24582 @table @gcctabopt
24583 @item -mcpu=@var{name}
24584 @opindex mcpu
24585 Selects the type of CPU to be targeted.  Currently the only supported
24586 type is @samp{tilepro}.
24588 @item -m32
24589 @opindex m32
24590 Generate code for a 32-bit environment, which sets int, long, and
24591 pointer to 32 bits.  This is the only supported behavior so the flag
24592 is essentially ignored.
24593 @end table
24595 @node V850 Options
24596 @subsection V850 Options
24597 @cindex V850 Options
24599 These @samp{-m} options are defined for V850 implementations:
24601 @table @gcctabopt
24602 @item -mlong-calls
24603 @itemx -mno-long-calls
24604 @opindex mlong-calls
24605 @opindex mno-long-calls
24606 Treat all calls as being far away (near).  If calls are assumed to be
24607 far away, the compiler always loads the function's address into a
24608 register, and calls indirect through the pointer.
24610 @item -mno-ep
24611 @itemx -mep
24612 @opindex mno-ep
24613 @opindex mep
24614 Do not optimize (do optimize) basic blocks that use the same index
24615 pointer 4 or more times to copy pointer into the @code{ep} register, and
24616 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24617 option is on by default if you optimize.
24619 @item -mno-prolog-function
24620 @itemx -mprolog-function
24621 @opindex mno-prolog-function
24622 @opindex mprolog-function
24623 Do not use (do use) external functions to save and restore registers
24624 at the prologue and epilogue of a function.  The external functions
24625 are slower, but use less code space if more than one function saves
24626 the same number of registers.  The @option{-mprolog-function} option
24627 is on by default if you optimize.
24629 @item -mspace
24630 @opindex mspace
24631 Try to make the code as small as possible.  At present, this just turns
24632 on the @option{-mep} and @option{-mprolog-function} options.
24634 @item -mtda=@var{n}
24635 @opindex mtda
24636 Put static or global variables whose size is @var{n} bytes or less into
24637 the tiny data area that register @code{ep} points to.  The tiny data
24638 area can hold up to 256 bytes in total (128 bytes for byte references).
24640 @item -msda=@var{n}
24641 @opindex msda
24642 Put static or global variables whose size is @var{n} bytes or less into
24643 the small data area that register @code{gp} points to.  The small data
24644 area can hold up to 64 kilobytes.
24646 @item -mzda=@var{n}
24647 @opindex mzda
24648 Put static or global variables whose size is @var{n} bytes or less into
24649 the first 32 kilobytes of memory.
24651 @item -mv850
24652 @opindex mv850
24653 Specify that the target processor is the V850.
24655 @item -mv850e3v5
24656 @opindex mv850e3v5
24657 Specify that the target processor is the V850E3V5.  The preprocessor
24658 constant @code{__v850e3v5__} is defined if this option is used.
24660 @item -mv850e2v4
24661 @opindex mv850e2v4
24662 Specify that the target processor is the V850E3V5.  This is an alias for
24663 the @option{-mv850e3v5} option.
24665 @item -mv850e2v3
24666 @opindex mv850e2v3
24667 Specify that the target processor is the V850E2V3.  The preprocessor
24668 constant @code{__v850e2v3__} is defined if this option is used.
24670 @item -mv850e2
24671 @opindex mv850e2
24672 Specify that the target processor is the V850E2.  The preprocessor
24673 constant @code{__v850e2__} is defined if this option is used.
24675 @item -mv850e1
24676 @opindex mv850e1
24677 Specify that the target processor is the V850E1.  The preprocessor
24678 constants @code{__v850e1__} and @code{__v850e__} are defined if
24679 this option is used.
24681 @item -mv850es
24682 @opindex mv850es
24683 Specify that the target processor is the V850ES.  This is an alias for
24684 the @option{-mv850e1} option.
24686 @item -mv850e
24687 @opindex mv850e
24688 Specify that the target processor is the V850E@.  The preprocessor
24689 constant @code{__v850e__} is defined if this option is used.
24691 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
24692 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
24693 are defined then a default target processor is chosen and the
24694 relevant @samp{__v850*__} preprocessor constant is defined.
24696 The preprocessor constants @code{__v850} and @code{__v851__} are always
24697 defined, regardless of which processor variant is the target.
24699 @item -mdisable-callt
24700 @itemx -mno-disable-callt
24701 @opindex mdisable-callt
24702 @opindex mno-disable-callt
24703 This option suppresses generation of the @code{CALLT} instruction for the
24704 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24705 architecture.
24707 This option is enabled by default when the RH850 ABI is
24708 in use (see @option{-mrh850-abi}), and disabled by default when the
24709 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24710 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
24712 @item -mrelax
24713 @itemx -mno-relax
24714 @opindex mrelax
24715 @opindex mno-relax
24716 Pass on (or do not pass on) the @option{-mrelax} command-line option
24717 to the assembler.
24719 @item -mlong-jumps
24720 @itemx -mno-long-jumps
24721 @opindex mlong-jumps
24722 @opindex mno-long-jumps
24723 Disable (or re-enable) the generation of PC-relative jump instructions.
24725 @item -msoft-float
24726 @itemx -mhard-float
24727 @opindex msoft-float
24728 @opindex mhard-float
24729 Disable (or re-enable) the generation of hardware floating point
24730 instructions.  This option is only significant when the target
24731 architecture is @samp{V850E2V3} or higher.  If hardware floating point
24732 instructions are being generated then the C preprocessor symbol
24733 @code{__FPU_OK__} is defined, otherwise the symbol
24734 @code{__NO_FPU__} is defined.
24736 @item -mloop
24737 @opindex mloop
24738 Enables the use of the e3v5 LOOP instruction.  The use of this
24739 instruction is not enabled by default when the e3v5 architecture is
24740 selected because its use is still experimental.
24742 @item -mrh850-abi
24743 @itemx -mghs
24744 @opindex mrh850-abi
24745 @opindex mghs
24746 Enables support for the RH850 version of the V850 ABI.  This is the
24747 default.  With this version of the ABI the following rules apply:
24749 @itemize
24750 @item
24751 Integer sized structures and unions are returned via a memory pointer
24752 rather than a register.
24754 @item
24755 Large structures and unions (more than 8 bytes in size) are passed by
24756 value.
24758 @item
24759 Functions are aligned to 16-bit boundaries.
24761 @item
24762 The @option{-m8byte-align} command-line option is supported.
24764 @item
24765 The @option{-mdisable-callt} command-line option is enabled by
24766 default.  The @option{-mno-disable-callt} command-line option is not
24767 supported.
24768 @end itemize
24770 When this version of the ABI is enabled the C preprocessor symbol
24771 @code{__V850_RH850_ABI__} is defined.
24773 @item -mgcc-abi
24774 @opindex mgcc-abi
24775 Enables support for the old GCC version of the V850 ABI.  With this
24776 version of the ABI the following rules apply:
24778 @itemize
24779 @item
24780 Integer sized structures and unions are returned in register @code{r10}.
24782 @item
24783 Large structures and unions (more than 8 bytes in size) are passed by
24784 reference.
24786 @item
24787 Functions are aligned to 32-bit boundaries, unless optimizing for
24788 size.
24790 @item
24791 The @option{-m8byte-align} command-line option is not supported.
24793 @item
24794 The @option{-mdisable-callt} command-line option is supported but not
24795 enabled by default.
24796 @end itemize
24798 When this version of the ABI is enabled the C preprocessor symbol
24799 @code{__V850_GCC_ABI__} is defined.
24801 @item -m8byte-align
24802 @itemx -mno-8byte-align
24803 @opindex m8byte-align
24804 @opindex mno-8byte-align
24805 Enables support for @code{double} and @code{long long} types to be
24806 aligned on 8-byte boundaries.  The default is to restrict the
24807 alignment of all objects to at most 4-bytes.  When
24808 @option{-m8byte-align} is in effect the C preprocessor symbol
24809 @code{__V850_8BYTE_ALIGN__} is defined.
24811 @item -mbig-switch
24812 @opindex mbig-switch
24813 Generate code suitable for big switch tables.  Use this option only if
24814 the assembler/linker complain about out of range branches within a switch
24815 table.
24817 @item -mapp-regs
24818 @opindex mapp-regs
24819 This option causes r2 and r5 to be used in the code generated by
24820 the compiler.  This setting is the default.
24822 @item -mno-app-regs
24823 @opindex mno-app-regs
24824 This option causes r2 and r5 to be treated as fixed registers.
24826 @end table
24828 @node VAX Options
24829 @subsection VAX Options
24830 @cindex VAX options
24832 These @samp{-m} options are defined for the VAX:
24834 @table @gcctabopt
24835 @item -munix
24836 @opindex munix
24837 Do not output certain jump instructions (@code{aobleq} and so on)
24838 that the Unix assembler for the VAX cannot handle across long
24839 ranges.
24841 @item -mgnu
24842 @opindex mgnu
24843 Do output those jump instructions, on the assumption that the
24844 GNU assembler is being used.
24846 @item -mg
24847 @opindex mg
24848 Output code for G-format floating-point numbers instead of D-format.
24849 @end table
24851 @node Visium Options
24852 @subsection Visium Options
24853 @cindex Visium options
24855 @table @gcctabopt
24857 @item -mdebug
24858 @opindex mdebug
24859 A program which performs file I/O and is destined to run on an MCM target
24860 should be linked with this option.  It causes the libraries libc.a and
24861 libdebug.a to be linked.  The program should be run on the target under
24862 the control of the GDB remote debugging stub.
24864 @item -msim
24865 @opindex msim
24866 A program which performs file I/O and is destined to run on the simulator
24867 should be linked with option.  This causes libraries libc.a and libsim.a to
24868 be linked.
24870 @item -mfpu
24871 @itemx -mhard-float
24872 @opindex mfpu
24873 @opindex mhard-float
24874 Generate code containing floating-point instructions.  This is the
24875 default.
24877 @item -mno-fpu
24878 @itemx -msoft-float
24879 @opindex mno-fpu
24880 @opindex msoft-float
24881 Generate code containing library calls for floating-point.
24883 @option{-msoft-float} changes the calling convention in the output file;
24884 therefore, it is only useful if you compile @emph{all} of a program with
24885 this option.  In particular, you need to compile @file{libgcc.a}, the
24886 library that comes with GCC, with @option{-msoft-float} in order for
24887 this to work.
24889 @item -mcpu=@var{cpu_type}
24890 @opindex mcpu
24891 Set the instruction set, register set, and instruction scheduling parameters
24892 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24893 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24895 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24897 By default (unless configured otherwise), GCC generates code for the GR5
24898 variant of the Visium architecture.  
24900 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24901 architecture.  The only difference from GR5 code is that the compiler will
24902 generate block move instructions.
24904 @item -mtune=@var{cpu_type}
24905 @opindex mtune
24906 Set the instruction scheduling parameters for machine type @var{cpu_type},
24907 but do not set the instruction set or register set that the option
24908 @option{-mcpu=@var{cpu_type}} would.
24910 @item -msv-mode
24911 @opindex msv-mode
24912 Generate code for the supervisor mode, where there are no restrictions on
24913 the access to general registers.  This is the default.
24915 @item -muser-mode
24916 @opindex muser-mode
24917 Generate code for the user mode, where the access to some general registers
24918 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24919 mode; on the GR6, only registers r29 to r31 are affected.
24920 @end table
24922 @node VMS Options
24923 @subsection VMS Options
24925 These @samp{-m} options are defined for the VMS implementations:
24927 @table @gcctabopt
24928 @item -mvms-return-codes
24929 @opindex mvms-return-codes
24930 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24931 condition (e.g.@ error) codes.
24933 @item -mdebug-main=@var{prefix}
24934 @opindex mdebug-main=@var{prefix}
24935 Flag the first routine whose name starts with @var{prefix} as the main
24936 routine for the debugger.
24938 @item -mmalloc64
24939 @opindex mmalloc64
24940 Default to 64-bit memory allocation routines.
24942 @item -mpointer-size=@var{size}
24943 @opindex mpointer-size=@var{size}
24944 Set the default size of pointers. Possible options for @var{size} are
24945 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24946 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24947 The later option disables @code{pragma pointer_size}.
24948 @end table
24950 @node VxWorks Options
24951 @subsection VxWorks Options
24952 @cindex VxWorks Options
24954 The options in this section are defined for all VxWorks targets.
24955 Options specific to the target hardware are listed with the other
24956 options for that target.
24958 @table @gcctabopt
24959 @item -mrtp
24960 @opindex mrtp
24961 GCC can generate code for both VxWorks kernels and real time processes
24962 (RTPs).  This option switches from the former to the latter.  It also
24963 defines the preprocessor macro @code{__RTP__}.
24965 @item -non-static
24966 @opindex non-static
24967 Link an RTP executable against shared libraries rather than static
24968 libraries.  The options @option{-static} and @option{-shared} can
24969 also be used for RTPs (@pxref{Link Options}); @option{-static}
24970 is the default.
24972 @item -Bstatic
24973 @itemx -Bdynamic
24974 @opindex Bstatic
24975 @opindex Bdynamic
24976 These options are passed down to the linker.  They are defined for
24977 compatibility with Diab.
24979 @item -Xbind-lazy
24980 @opindex Xbind-lazy
24981 Enable lazy binding of function calls.  This option is equivalent to
24982 @option{-Wl,-z,now} and is defined for compatibility with Diab.
24984 @item -Xbind-now
24985 @opindex Xbind-now
24986 Disable lazy binding of function calls.  This option is the default and
24987 is defined for compatibility with Diab.
24988 @end table
24990 @node x86 Options
24991 @subsection x86 Options
24992 @cindex x86 Options
24994 These @samp{-m} options are defined for the x86 family of computers.
24996 @table @gcctabopt
24998 @item -march=@var{cpu-type}
24999 @opindex march
25000 Generate instructions for the machine type @var{cpu-type}.  In contrast to
25001 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
25002 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
25003 to generate code that may not run at all on processors other than the one
25004 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
25005 @option{-mtune=@var{cpu-type}}.
25007 The choices for @var{cpu-type} are:
25009 @table @samp
25010 @item native
25011 This selects the CPU to generate code for at compilation time by determining
25012 the processor type of the compiling machine.  Using @option{-march=native}
25013 enables all instruction subsets supported by the local machine (hence
25014 the result might not run on different machines).  Using @option{-mtune=native}
25015 produces code optimized for the local machine under the constraints
25016 of the selected instruction set.  
25018 @item i386
25019 Original Intel i386 CPU@.
25021 @item i486
25022 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
25024 @item i586
25025 @itemx pentium
25026 Intel Pentium CPU with no MMX support.
25028 @item lakemont
25029 Intel Lakemont MCU, based on Intel Pentium CPU.
25031 @item pentium-mmx
25032 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
25034 @item pentiumpro
25035 Intel Pentium Pro CPU@.
25037 @item i686
25038 When used with @option{-march}, the Pentium Pro
25039 instruction set is used, so the code runs on all i686 family chips.
25040 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
25042 @item pentium2
25043 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
25044 support.
25046 @item pentium3
25047 @itemx pentium3m
25048 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
25049 set support.
25051 @item pentium-m
25052 Intel Pentium M; low-power version of Intel Pentium III CPU
25053 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
25055 @item pentium4
25056 @itemx pentium4m
25057 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
25059 @item prescott
25060 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
25061 set support.
25063 @item nocona
25064 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
25065 SSE2 and SSE3 instruction set support.
25067 @item core2
25068 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
25069 instruction set support.
25071 @item nehalem
25072 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25073 SSE4.1, SSE4.2 and POPCNT instruction set support.
25075 @item westmere
25076 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25077 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
25079 @item sandybridge
25080 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25081 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
25083 @item ivybridge
25084 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25085 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
25086 instruction set support.
25088 @item haswell
25089 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25090 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25091 BMI, BMI2 and F16C instruction set support.
25093 @item broadwell
25094 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25095 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25096 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
25098 @item skylake
25099 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25100 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25101 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
25102 XSAVES instruction set support.
25104 @item bonnell
25105 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
25106 instruction set support.
25108 @item silvermont
25109 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25110 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
25112 @item knl
25113 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25114 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25115 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
25116 AVX512CD instruction set support.
25118 @item knm
25119 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25120 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25121 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25122 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
25124 @item skylake-avx512
25125 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25126 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25127 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
25128 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
25130 @item k6
25131 AMD K6 CPU with MMX instruction set support.
25133 @item k6-2
25134 @itemx k6-3
25135 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
25137 @item athlon
25138 @itemx athlon-tbird
25139 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
25140 support.
25142 @item athlon-4
25143 @itemx athlon-xp
25144 @itemx athlon-mp
25145 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
25146 instruction set support.
25148 @item k8
25149 @itemx opteron
25150 @itemx athlon64
25151 @itemx athlon-fx
25152 Processors based on the AMD K8 core with x86-64 instruction set support,
25153 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
25154 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
25155 instruction set extensions.)
25157 @item k8-sse3
25158 @itemx opteron-sse3
25159 @itemx athlon64-sse3
25160 Improved versions of AMD K8 cores with SSE3 instruction set support.
25162 @item amdfam10
25163 @itemx barcelona
25164 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
25165 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
25166 instruction set extensions.)
25168 @item bdver1
25169 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
25170 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
25171 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
25172 @item bdver2
25173 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25174 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
25175 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
25176 extensions.)
25177 @item bdver3
25178 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25179 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
25180 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
25181 64-bit instruction set extensions.
25182 @item bdver4
25183 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25184 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
25185 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
25186 SSE4.2, ABM and 64-bit instruction set extensions.
25188 @item znver1
25189 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
25190 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
25191 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
25192 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
25193 instruction set extensions.
25195 @item btver1
25196 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
25197 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
25198 instruction set extensions.)
25200 @item btver2
25201 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
25202 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
25203 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
25205 @item winchip-c6
25206 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
25207 set support.
25209 @item winchip2
25210 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
25211 instruction set support.
25213 @item c3
25214 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
25215 (No scheduling is implemented for this chip.)
25217 @item c3-2
25218 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
25219 (No scheduling is implemented for this chip.)
25221 @item c7
25222 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25223 (No scheduling is implemented for this chip.)
25225 @item samuel-2
25226 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
25227 (No scheduling is implemented for this chip.)
25229 @item nehemiah
25230 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
25231 (No scheduling is implemented for this chip.)
25233 @item esther
25234 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25235 (No scheduling is implemented for this chip.)
25237 @item eden-x2
25238 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25239 (No scheduling is implemented for this chip.)
25241 @item eden-x4
25242 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25243 AVX and AVX2 instruction set support.
25244 (No scheduling is implemented for this chip.)
25246 @item nano
25247 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25248 instruction set support.
25249 (No scheduling is implemented for this chip.)
25251 @item nano-1000
25252 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25253 instruction set support.
25254 (No scheduling is implemented for this chip.)
25256 @item nano-2000
25257 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25258 instruction set support.
25259 (No scheduling is implemented for this chip.)
25261 @item nano-3000
25262 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25263 instruction set support.
25264 (No scheduling is implemented for this chip.)
25266 @item nano-x2
25267 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25268 instruction set support.
25269 (No scheduling is implemented for this chip.)
25271 @item nano-x4
25272 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25273 instruction set support.
25274 (No scheduling is implemented for this chip.)
25276 @item geode
25277 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25278 @end table
25280 @item -mtune=@var{cpu-type}
25281 @opindex mtune
25282 Tune to @var{cpu-type} everything applicable about the generated code, except
25283 for the ABI and the set of available instructions.  
25284 While picking a specific @var{cpu-type} schedules things appropriately
25285 for that particular chip, the compiler does not generate any code that
25286 cannot run on the default machine type unless you use a
25287 @option{-march=@var{cpu-type}} option.
25288 For example, if GCC is configured for i686-pc-linux-gnu
25289 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25290 but still runs on i686 machines.
25292 The choices for @var{cpu-type} are the same as for @option{-march}.
25293 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25295 @table @samp
25296 @item generic
25297 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25298 If you know the CPU on which your code will run, then you should use
25299 the corresponding @option{-mtune} or @option{-march} option instead of
25300 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25301 of your application will have, then you should use this option.
25303 As new processors are deployed in the marketplace, the behavior of this
25304 option will change.  Therefore, if you upgrade to a newer version of
25305 GCC, code generation controlled by this option will change to reflect
25306 the processors
25307 that are most common at the time that version of GCC is released.
25309 There is no @option{-march=generic} option because @option{-march}
25310 indicates the instruction set the compiler can use, and there is no
25311 generic instruction set applicable to all processors.  In contrast,
25312 @option{-mtune} indicates the processor (or, in this case, collection of
25313 processors) for which the code is optimized.
25315 @item intel
25316 Produce code optimized for the most current Intel processors, which are
25317 Haswell and Silvermont for this version of GCC.  If you know the CPU
25318 on which your code will run, then you should use the corresponding
25319 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25320 But, if you want your application performs better on both Haswell and
25321 Silvermont, then you should use this option.
25323 As new Intel processors are deployed in the marketplace, the behavior of
25324 this option will change.  Therefore, if you upgrade to a newer version of
25325 GCC, code generation controlled by this option will change to reflect
25326 the most current Intel processors at the time that version of GCC is
25327 released.
25329 There is no @option{-march=intel} option because @option{-march} indicates
25330 the instruction set the compiler can use, and there is no common
25331 instruction set applicable to all processors.  In contrast,
25332 @option{-mtune} indicates the processor (or, in this case, collection of
25333 processors) for which the code is optimized.
25334 @end table
25336 @item -mcpu=@var{cpu-type}
25337 @opindex mcpu
25338 A deprecated synonym for @option{-mtune}.
25340 @item -mfpmath=@var{unit}
25341 @opindex mfpmath
25342 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25343 for @var{unit} are:
25345 @table @samp
25346 @item 387
25347 Use the standard 387 floating-point coprocessor present on the majority of chips and
25348 emulated otherwise.  Code compiled with this option runs almost everywhere.
25349 The temporary results are computed in 80-bit precision instead of the precision
25350 specified by the type, resulting in slightly different results compared to most
25351 of other chips.  See @option{-ffloat-store} for more detailed description.
25353 This is the default choice for non-Darwin x86-32 targets.
25355 @item sse
25356 Use scalar floating-point instructions present in the SSE instruction set.
25357 This instruction set is supported by Pentium III and newer chips,
25358 and in the AMD line
25359 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25360 instruction set supports only single-precision arithmetic, thus the double and
25361 extended-precision arithmetic are still done using 387.  A later version, present
25362 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25363 arithmetic too.
25365 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25366 or @option{-msse2} switches to enable SSE extensions and make this option
25367 effective.  For the x86-64 compiler, these extensions are enabled by default.
25369 The resulting code should be considerably faster in the majority of cases and avoid
25370 the numerical instability problems of 387 code, but may break some existing
25371 code that expects temporaries to be 80 bits.
25373 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25374 and the default choice for x86-32 targets with the SSE2 instruction set
25375 when @option{-ffast-math} is enabled.
25377 @item sse,387
25378 @itemx sse+387
25379 @itemx both
25380 Attempt to utilize both instruction sets at once.  This effectively doubles the
25381 amount of available registers, and on chips with separate execution units for
25382 387 and SSE the execution resources too.  Use this option with care, as it is
25383 still experimental, because the GCC register allocator does not model separate
25384 functional units well, resulting in unstable performance.
25385 @end table
25387 @item -masm=@var{dialect}
25388 @opindex masm=@var{dialect}
25389 Output assembly instructions using selected @var{dialect}.  Also affects
25390 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25391 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25392 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25393 not support @samp{intel}.
25395 @item -mieee-fp
25396 @itemx -mno-ieee-fp
25397 @opindex mieee-fp
25398 @opindex mno-ieee-fp
25399 Control whether or not the compiler uses IEEE floating-point
25400 comparisons.  These correctly handle the case where the result of a
25401 comparison is unordered.
25403 @item -m80387
25404 @item -mhard-float
25405 @opindex 80387
25406 @opindex mhard-float
25407 Generate output containing 80387 instructions for floating point.
25409 @item -mno-80387
25410 @item -msoft-float
25411 @opindex no-80387
25412 @opindex msoft-float
25413 Generate output containing library calls for floating point.
25415 @strong{Warning:} the requisite libraries are not part of GCC@.
25416 Normally the facilities of the machine's usual C compiler are used, but
25417 this cannot be done directly in cross-compilation.  You must make your
25418 own arrangements to provide suitable library functions for
25419 cross-compilation.
25421 On machines where a function returns floating-point results in the 80387
25422 register stack, some floating-point opcodes may be emitted even if
25423 @option{-msoft-float} is used.
25425 @item -mno-fp-ret-in-387
25426 @opindex mno-fp-ret-in-387
25427 Do not use the FPU registers for return values of functions.
25429 The usual calling convention has functions return values of types
25430 @code{float} and @code{double} in an FPU register, even if there
25431 is no FPU@.  The idea is that the operating system should emulate
25432 an FPU@.
25434 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25435 in ordinary CPU registers instead.
25437 @item -mno-fancy-math-387
25438 @opindex mno-fancy-math-387
25439 Some 387 emulators do not support the @code{sin}, @code{cos} and
25440 @code{sqrt} instructions for the 387.  Specify this option to avoid
25441 generating those instructions.  This option is the default on
25442 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25443 indicates that the target CPU always has an FPU and so the
25444 instruction does not need emulation.  These
25445 instructions are not generated unless you also use the
25446 @option{-funsafe-math-optimizations} switch.
25448 @item -malign-double
25449 @itemx -mno-align-double
25450 @opindex malign-double
25451 @opindex mno-align-double
25452 Control whether GCC aligns @code{double}, @code{long double}, and
25453 @code{long long} variables on a two-word boundary or a one-word
25454 boundary.  Aligning @code{double} variables on a two-word boundary
25455 produces code that runs somewhat faster on a Pentium at the
25456 expense of more memory.
25458 On x86-64, @option{-malign-double} is enabled by default.
25460 @strong{Warning:} if you use the @option{-malign-double} switch,
25461 structures containing the above types are aligned differently than
25462 the published application binary interface specifications for the x86-32
25463 and are not binary compatible with structures in code compiled
25464 without that switch.
25466 @item -m96bit-long-double
25467 @itemx -m128bit-long-double
25468 @opindex m96bit-long-double
25469 @opindex m128bit-long-double
25470 These switches control the size of @code{long double} type.  The x86-32
25471 application binary interface specifies the size to be 96 bits,
25472 so @option{-m96bit-long-double} is the default in 32-bit mode.
25474 Modern architectures (Pentium and newer) prefer @code{long double}
25475 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25476 conforming to the ABI, this is not possible.  So specifying
25477 @option{-m128bit-long-double} aligns @code{long double}
25478 to a 16-byte boundary by padding the @code{long double} with an additional
25479 32-bit zero.
25481 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25482 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25484 Notice that neither of these options enable any extra precision over the x87
25485 standard of 80 bits for a @code{long double}.
25487 @strong{Warning:} if you override the default value for your target ABI, this
25488 changes the size of 
25489 structures and arrays containing @code{long double} variables,
25490 as well as modifying the function calling convention for functions taking
25491 @code{long double}.  Hence they are not binary-compatible
25492 with code compiled without that switch.
25494 @item -mlong-double-64
25495 @itemx -mlong-double-80
25496 @itemx -mlong-double-128
25497 @opindex mlong-double-64
25498 @opindex mlong-double-80
25499 @opindex mlong-double-128
25500 These switches control the size of @code{long double} type. A size
25501 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25502 type. This is the default for 32-bit Bionic C library.  A size
25503 of 128 bits makes the @code{long double} type equivalent to the
25504 @code{__float128} type. This is the default for 64-bit Bionic C library.
25506 @strong{Warning:} if you override the default value for your target ABI, this
25507 changes the size of
25508 structures and arrays containing @code{long double} variables,
25509 as well as modifying the function calling convention for functions taking
25510 @code{long double}.  Hence they are not binary-compatible
25511 with code compiled without that switch.
25513 @item -malign-data=@var{type}
25514 @opindex malign-data
25515 Control how GCC aligns variables.  Supported values for @var{type} are
25516 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25517 and earlier, @samp{abi} uses alignment value as specified by the
25518 psABI, and @samp{cacheline} uses increased alignment value to match
25519 the cache line size.  @samp{compat} is the default.
25521 @item -mlarge-data-threshold=@var{threshold}
25522 @opindex mlarge-data-threshold
25523 When @option{-mcmodel=medium} is specified, data objects larger than
25524 @var{threshold} are placed in the large data section.  This value must be the
25525 same across all objects linked into the binary, and defaults to 65535.
25527 @item -mrtd
25528 @opindex mrtd
25529 Use a different function-calling convention, in which functions that
25530 take a fixed number of arguments return with the @code{ret @var{num}}
25531 instruction, which pops their arguments while returning.  This saves one
25532 instruction in the caller since there is no need to pop the arguments
25533 there.
25535 You can specify that an individual function is called with this calling
25536 sequence with the function attribute @code{stdcall}.  You can also
25537 override the @option{-mrtd} option by using the function attribute
25538 @code{cdecl}.  @xref{Function Attributes}.
25540 @strong{Warning:} this calling convention is incompatible with the one
25541 normally used on Unix, so you cannot use it if you need to call
25542 libraries compiled with the Unix compiler.
25544 Also, you must provide function prototypes for all functions that
25545 take variable numbers of arguments (including @code{printf});
25546 otherwise incorrect code is generated for calls to those
25547 functions.
25549 In addition, seriously incorrect code results if you call a
25550 function with too many arguments.  (Normally, extra arguments are
25551 harmlessly ignored.)
25553 @item -mregparm=@var{num}
25554 @opindex mregparm
25555 Control how many registers are used to pass integer arguments.  By
25556 default, no registers are used to pass arguments, and at most 3
25557 registers can be used.  You can control this behavior for a specific
25558 function by using the function attribute @code{regparm}.
25559 @xref{Function Attributes}.
25561 @strong{Warning:} if you use this switch, and
25562 @var{num} is nonzero, then you must build all modules with the same
25563 value, including any libraries.  This includes the system libraries and
25564 startup modules.
25566 @item -msseregparm
25567 @opindex msseregparm
25568 Use SSE register passing conventions for float and double arguments
25569 and return values.  You can control this behavior for a specific
25570 function by using the function attribute @code{sseregparm}.
25571 @xref{Function Attributes}.
25573 @strong{Warning:} if you use this switch then you must build all
25574 modules with the same value, including any libraries.  This includes
25575 the system libraries and startup modules.
25577 @item -mvect8-ret-in-mem
25578 @opindex mvect8-ret-in-mem
25579 Return 8-byte vectors in memory instead of MMX registers.  This is the
25580 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
25581 Studio compilers until version 12.  Later compiler versions (starting
25582 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
25583 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
25584 you need to remain compatible with existing code produced by those
25585 previous compiler versions or older versions of GCC@.
25587 @item -mpc32
25588 @itemx -mpc64
25589 @itemx -mpc80
25590 @opindex mpc32
25591 @opindex mpc64
25592 @opindex mpc80
25594 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
25595 is specified, the significands of results of floating-point operations are
25596 rounded to 24 bits (single precision); @option{-mpc64} rounds the
25597 significands of results of floating-point operations to 53 bits (double
25598 precision) and @option{-mpc80} rounds the significands of results of
25599 floating-point operations to 64 bits (extended double precision), which is
25600 the default.  When this option is used, floating-point operations in higher
25601 precisions are not available to the programmer without setting the FPU
25602 control word explicitly.
25604 Setting the rounding of floating-point operations to less than the default
25605 80 bits can speed some programs by 2% or more.  Note that some mathematical
25606 libraries assume that extended-precision (80-bit) floating-point operations
25607 are enabled by default; routines in such libraries could suffer significant
25608 loss of accuracy, typically through so-called ``catastrophic cancellation'',
25609 when this option is used to set the precision to less than extended precision.
25611 @item -mstackrealign
25612 @opindex mstackrealign
25613 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
25614 option generates an alternate prologue and epilogue that realigns the
25615 run-time stack if necessary.  This supports mixing legacy codes that keep
25616 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
25617 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
25618 applicable to individual functions.
25620 @item -mpreferred-stack-boundary=@var{num}
25621 @opindex mpreferred-stack-boundary
25622 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25623 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25624 the default is 4 (16 bytes or 128 bits).
25626 @strong{Warning:} When generating code for the x86-64 architecture with
25627 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25628 used to keep the stack boundary aligned to 8 byte boundary.  Since
25629 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25630 intended to be used in controlled environment where stack space is
25631 important limitation.  This option leads to wrong code when functions
25632 compiled with 16 byte stack alignment (such as functions from a standard
25633 library) are called with misaligned stack.  In this case, SSE
25634 instructions may lead to misaligned memory access traps.  In addition,
25635 variable arguments are handled incorrectly for 16 byte aligned
25636 objects (including x87 long double and __int128), leading to wrong
25637 results.  You must build all modules with
25638 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
25639 includes the system libraries and startup modules.
25641 @item -mincoming-stack-boundary=@var{num}
25642 @opindex mincoming-stack-boundary
25643 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
25644 boundary.  If @option{-mincoming-stack-boundary} is not specified,
25645 the one specified by @option{-mpreferred-stack-boundary} is used.
25647 On Pentium and Pentium Pro, @code{double} and @code{long double} values
25648 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
25649 suffer significant run time performance penalties.  On Pentium III, the
25650 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
25651 properly if it is not 16-byte aligned.
25653 To ensure proper alignment of this values on the stack, the stack boundary
25654 must be as aligned as that required by any value stored on the stack.
25655 Further, every function must be generated such that it keeps the stack
25656 aligned.  Thus calling a function compiled with a higher preferred
25657 stack boundary from a function compiled with a lower preferred stack
25658 boundary most likely misaligns the stack.  It is recommended that
25659 libraries that use callbacks always use the default setting.
25661 This extra alignment does consume extra stack space, and generally
25662 increases code size.  Code that is sensitive to stack space usage, such
25663 as embedded systems and operating system kernels, may want to reduce the
25664 preferred alignment to @option{-mpreferred-stack-boundary=2}.
25666 @need 200
25667 @item -mmmx
25668 @opindex mmmx
25669 @need 200
25670 @itemx -msse
25671 @opindex msse
25672 @need 200
25673 @itemx -msse2
25674 @opindex msse2
25675 @need 200
25676 @itemx -msse3
25677 @opindex msse3
25678 @need 200
25679 @itemx -mssse3
25680 @opindex mssse3
25681 @need 200
25682 @itemx -msse4
25683 @opindex msse4
25684 @need 200
25685 @itemx -msse4a
25686 @opindex msse4a
25687 @need 200
25688 @itemx -msse4.1
25689 @opindex msse4.1
25690 @need 200
25691 @itemx -msse4.2
25692 @opindex msse4.2
25693 @need 200
25694 @itemx -mavx
25695 @opindex mavx
25696 @need 200
25697 @itemx -mavx2
25698 @opindex mavx2
25699 @need 200
25700 @itemx -mavx512f
25701 @opindex mavx512f
25702 @need 200
25703 @itemx -mavx512pf
25704 @opindex mavx512pf
25705 @need 200
25706 @itemx -mavx512er
25707 @opindex mavx512er
25708 @need 200
25709 @itemx -mavx512cd
25710 @opindex mavx512cd
25711 @need 200
25712 @itemx -mavx512vl
25713 @opindex mavx512vl
25714 @need 200
25715 @itemx -mavx512bw
25716 @opindex mavx512bw
25717 @need 200
25718 @itemx -mavx512dq
25719 @opindex mavx512dq
25720 @need 200
25721 @itemx -mavx512ifma
25722 @opindex mavx512ifma
25723 @need 200
25724 @itemx -mavx512vbmi
25725 @opindex mavx512vbmi
25726 @need 200
25727 @itemx -msha
25728 @opindex msha
25729 @need 200
25730 @itemx -maes
25731 @opindex maes
25732 @need 200
25733 @itemx -mpclmul
25734 @opindex mpclmul
25735 @need 200
25736 @itemx -mclfushopt
25737 @opindex mclfushopt
25738 @need 200
25739 @itemx -mfsgsbase
25740 @opindex mfsgsbase
25741 @need 200
25742 @itemx -mrdrnd
25743 @opindex mrdrnd
25744 @need 200
25745 @itemx -mf16c
25746 @opindex mf16c
25747 @need 200
25748 @itemx -mfma
25749 @opindex mfma
25750 @need 200
25751 @itemx -mfma4
25752 @opindex mfma4
25753 @need 200
25754 @itemx -mprefetchwt1
25755 @opindex mprefetchwt1
25756 @need 200
25757 @itemx -mxop
25758 @opindex mxop
25759 @need 200
25760 @itemx -mlwp
25761 @opindex mlwp
25762 @need 200
25763 @itemx -m3dnow
25764 @opindex m3dnow
25765 @need 200
25766 @itemx -m3dnowa
25767 @opindex m3dnowa
25768 @need 200
25769 @itemx -mpopcnt
25770 @opindex mpopcnt
25771 @need 200
25772 @itemx -mabm
25773 @opindex mabm
25774 @need 200
25775 @itemx -mbmi
25776 @opindex mbmi
25777 @need 200
25778 @itemx -mbmi2
25779 @need 200
25780 @itemx -mlzcnt
25781 @opindex mlzcnt
25782 @need 200
25783 @itemx -mfxsr
25784 @opindex mfxsr
25785 @need 200
25786 @itemx -mxsave
25787 @opindex mxsave
25788 @need 200
25789 @itemx -mxsaveopt
25790 @opindex mxsaveopt
25791 @need 200
25792 @itemx -mxsavec
25793 @opindex mxsavec
25794 @need 200
25795 @itemx -mxsaves
25796 @opindex mxsaves
25797 @need 200
25798 @itemx -mrtm
25799 @opindex mrtm
25800 @need 200
25801 @itemx -mtbm
25802 @opindex mtbm
25803 @need 200
25804 @itemx -mmpx
25805 @opindex mmpx
25806 @need 200
25807 @itemx -mmwaitx
25808 @opindex mmwaitx
25809 @need 200
25810 @itemx -mclzero
25811 @opindex mclzero
25812 @itemx -mpku
25813 @opindex mpku
25814 These switches enable the use of instructions in the MMX, SSE,
25815 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25816 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
25817 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
25818 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, 3DNow!@: or enhanced 3DNow!@:
25819 extended instruction sets.  Each has a corresponding @option{-mno-} option
25820 to disable use of these instructions.
25822 These extensions are also available as built-in functions: see
25823 @ref{x86 Built-in Functions}, for details of the functions enabled and
25824 disabled by these switches.
25826 To generate SSE/SSE2 instructions automatically from floating-point
25827 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
25829 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
25830 generates new AVX instructions or AVX equivalence for all SSEx instructions
25831 when needed.
25833 These options enable GCC to use these extended instructions in
25834 generated code, even without @option{-mfpmath=sse}.  Applications that
25835 perform run-time CPU detection must compile separate files for each
25836 supported architecture, using the appropriate flags.  In particular,
25837 the file containing the CPU detection code should be compiled without
25838 these options.
25840 @item -mdump-tune-features
25841 @opindex mdump-tune-features
25842 This option instructs GCC to dump the names of the x86 performance 
25843 tuning features and default settings. The names can be used in 
25844 @option{-mtune-ctrl=@var{feature-list}}.
25846 @item -mtune-ctrl=@var{feature-list}
25847 @opindex mtune-ctrl=@var{feature-list}
25848 This option is used to do fine grain control of x86 code generation features.
25849 @var{feature-list} is a comma separated list of @var{feature} names. See also
25850 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25851 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25852 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25853 developers. Using it may lead to code paths not covered by testing and can
25854 potentially result in compiler ICEs or runtime errors.
25856 @item -mno-default
25857 @opindex mno-default
25858 This option instructs GCC to turn off all tunable features. See also 
25859 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25861 @item -mcld
25862 @opindex mcld
25863 This option instructs GCC to emit a @code{cld} instruction in the prologue
25864 of functions that use string instructions.  String instructions depend on
25865 the DF flag to select between autoincrement or autodecrement mode.  While the
25866 ABI specifies the DF flag to be cleared on function entry, some operating
25867 systems violate this specification by not clearing the DF flag in their
25868 exception dispatchers.  The exception handler can be invoked with the DF flag
25869 set, which leads to wrong direction mode when string instructions are used.
25870 This option can be enabled by default on 32-bit x86 targets by configuring
25871 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25872 instructions can be suppressed with the @option{-mno-cld} compiler option
25873 in this case.
25875 @item -mvzeroupper
25876 @opindex mvzeroupper
25877 This option instructs GCC to emit a @code{vzeroupper} instruction
25878 before a transfer of control flow out of the function to minimize
25879 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25880 intrinsics.
25882 @item -mprefer-avx128
25883 @opindex mprefer-avx128
25884 This option instructs GCC to use 128-bit AVX instructions instead of
25885 256-bit AVX instructions in the auto-vectorizer.
25887 @item -mprefer-avx256
25888 @opindex mprefer-avx256
25889 This option instructs GCC to use 256-bit AVX instructions instead of
25890 512-bit AVX instructions in the auto-vectorizer.
25892 @item -mcx16
25893 @opindex mcx16
25894 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
25895 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
25896 objects.  This is useful for atomic updates of data structures exceeding one
25897 machine word in size.  The compiler uses this instruction to implement
25898 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
25899 128-bit integers, a library call is always used.
25901 @item -msahf
25902 @opindex msahf
25903 This option enables generation of @code{SAHF} instructions in 64-bit code.
25904 Early Intel Pentium 4 CPUs with Intel 64 support,
25905 prior to the introduction of Pentium 4 G1 step in December 2005,
25906 lacked the @code{LAHF} and @code{SAHF} instructions
25907 which are supported by AMD64.
25908 These are load and store instructions, respectively, for certain status flags.
25909 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25910 @code{drem}, and @code{remainder} built-in functions;
25911 see @ref{Other Builtins} for details.
25913 @item -mmovbe
25914 @opindex mmovbe
25915 This option enables use of the @code{movbe} instruction to implement
25916 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25918 @item -mcrc32
25919 @opindex mcrc32
25920 This option enables built-in functions @code{__builtin_ia32_crc32qi},
25921 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
25922 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
25924 @item -mrecip
25925 @opindex mrecip
25926 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
25927 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
25928 with an additional Newton-Raphson step
25929 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
25930 (and their vectorized
25931 variants) for single-precision floating-point arguments.  These instructions
25932 are generated only when @option{-funsafe-math-optimizations} is enabled
25933 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
25934 Note that while the throughput of the sequence is higher than the throughput
25935 of the non-reciprocal instruction, the precision of the sequence can be
25936 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
25938 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
25939 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
25940 combination), and doesn't need @option{-mrecip}.
25942 Also note that GCC emits the above sequence with additional Newton-Raphson step
25943 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
25944 already with @option{-ffast-math} (or the above option combination), and
25945 doesn't need @option{-mrecip}.
25947 @item -mrecip=@var{opt}
25948 @opindex mrecip=opt
25949 This option controls which reciprocal estimate instructions
25950 may be used.  @var{opt} is a comma-separated list of options, which may
25951 be preceded by a @samp{!} to invert the option:
25953 @table @samp
25954 @item all
25955 Enable all estimate instructions.
25957 @item default
25958 Enable the default instructions, equivalent to @option{-mrecip}.
25960 @item none
25961 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25963 @item div
25964 Enable the approximation for scalar division.
25966 @item vec-div
25967 Enable the approximation for vectorized division.
25969 @item sqrt
25970 Enable the approximation for scalar square root.
25972 @item vec-sqrt
25973 Enable the approximation for vectorized square root.
25974 @end table
25976 So, for example, @option{-mrecip=all,!sqrt} enables
25977 all of the reciprocal approximations, except for square root.
25979 @item -mveclibabi=@var{type}
25980 @opindex mveclibabi
25981 Specifies the ABI type to use for vectorizing intrinsics using an
25982 external library.  Supported values for @var{type} are @samp{svml} 
25983 for the Intel short
25984 vector math library and @samp{acml} for the AMD math core library.
25985 To use this option, both @option{-ftree-vectorize} and
25986 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
25987 ABI-compatible library must be specified at link time.
25989 GCC currently emits calls to @code{vmldExp2},
25990 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
25991 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
25992 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
25993 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
25994 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
25995 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
25996 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
25997 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
25998 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
25999 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
26000 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
26001 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
26002 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
26003 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
26004 when @option{-mveclibabi=acml} is used.  
26006 @item -mabi=@var{name}
26007 @opindex mabi
26008 Generate code for the specified calling convention.  Permissible values
26009 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
26010 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
26011 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
26012 You can control this behavior for specific functions by
26013 using the function attributes @code{ms_abi} and @code{sysv_abi}.
26014 @xref{Function Attributes}.
26016 @item -mcall-ms2sysv-xlogues
26017 @opindex mcall-ms2sysv-xlogues
26018 @opindex mno-call-ms2sysv-xlogues
26019 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
26020 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
26021 default, the code for saving and restoring these registers is emitted inline,
26022 resulting in fairly lengthy prologues and epilogues.  Using
26023 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
26024 use stubs in the static portion of libgcc to perform these saves and restores,
26025 thus reducing function size at the cost of a few extra instructions.
26027 @item -mtls-dialect=@var{type}
26028 @opindex mtls-dialect
26029 Generate code to access thread-local storage using the @samp{gnu} or
26030 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
26031 @samp{gnu2} is more efficient, but it may add compile- and run-time
26032 requirements that cannot be satisfied on all systems.
26034 @item -mpush-args
26035 @itemx -mno-push-args
26036 @opindex mpush-args
26037 @opindex mno-push-args
26038 Use PUSH operations to store outgoing parameters.  This method is shorter
26039 and usually equally fast as method using SUB/MOV operations and is enabled
26040 by default.  In some cases disabling it may improve performance because of
26041 improved scheduling and reduced dependencies.
26043 @item -maccumulate-outgoing-args
26044 @opindex maccumulate-outgoing-args
26045 If enabled, the maximum amount of space required for outgoing arguments is
26046 computed in the function prologue.  This is faster on most modern CPUs
26047 because of reduced dependencies, improved scheduling and reduced stack usage
26048 when the preferred stack boundary is not equal to 2.  The drawback is a notable
26049 increase in code size.  This switch implies @option{-mno-push-args}.
26051 @item -mthreads
26052 @opindex mthreads
26053 Support thread-safe exception handling on MinGW.  Programs that rely
26054 on thread-safe exception handling must compile and link all code with the
26055 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
26056 @option{-D_MT}; when linking, it links in a special thread helper library
26057 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
26059 @item -mms-bitfields
26060 @itemx -mno-ms-bitfields
26061 @opindex mms-bitfields
26062 @opindex mno-ms-bitfields
26064 Enable/disable bit-field layout compatible with the native Microsoft
26065 Windows compiler.  
26067 If @code{packed} is used on a structure, or if bit-fields are used,
26068 it may be that the Microsoft ABI lays out the structure differently
26069 than the way GCC normally does.  Particularly when moving packed
26070 data between functions compiled with GCC and the native Microsoft compiler
26071 (either via function call or as data in a file), it may be necessary to access
26072 either format.
26074 This option is enabled by default for Microsoft Windows
26075 targets.  This behavior can also be controlled locally by use of variable
26076 or type attributes.  For more information, see @ref{x86 Variable Attributes}
26077 and @ref{x86 Type Attributes}.
26079 The Microsoft structure layout algorithm is fairly simple with the exception
26080 of the bit-field packing.  
26081 The padding and alignment of members of structures and whether a bit-field 
26082 can straddle a storage-unit boundary are determine by these rules:
26084 @enumerate
26085 @item Structure members are stored sequentially in the order in which they are
26086 declared: the first member has the lowest memory address and the last member
26087 the highest.
26089 @item Every data object has an alignment requirement.  The alignment requirement
26090 for all data except structures, unions, and arrays is either the size of the
26091 object or the current packing size (specified with either the
26092 @code{aligned} attribute or the @code{pack} pragma),
26093 whichever is less.  For structures, unions, and arrays,
26094 the alignment requirement is the largest alignment requirement of its members.
26095 Every object is allocated an offset so that:
26097 @smallexample
26098 offset % alignment_requirement == 0
26099 @end smallexample
26101 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
26102 unit if the integral types are the same size and if the next bit-field fits
26103 into the current allocation unit without crossing the boundary imposed by the
26104 common alignment requirements of the bit-fields.
26105 @end enumerate
26107 MSVC interprets zero-length bit-fields in the following ways:
26109 @enumerate
26110 @item If a zero-length bit-field is inserted between two bit-fields that
26111 are normally coalesced, the bit-fields are not coalesced.
26113 For example:
26115 @smallexample
26116 struct
26117  @{
26118    unsigned long bf_1 : 12;
26119    unsigned long : 0;
26120    unsigned long bf_2 : 12;
26121  @} t1;
26122 @end smallexample
26124 @noindent
26125 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
26126 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
26128 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
26129 alignment of the zero-length bit-field is greater than the member that follows it,
26130 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
26132 For example:
26134 @smallexample
26135 struct
26136  @{
26137    char foo : 4;
26138    short : 0;
26139    char bar;
26140  @} t2;
26142 struct
26143  @{
26144    char foo : 4;
26145    short : 0;
26146    double bar;
26147  @} t3;
26148 @end smallexample
26150 @noindent
26151 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
26152 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
26153 bit-field does not affect the alignment of @code{bar} or, as a result, the size
26154 of the structure.
26156 Taking this into account, it is important to note the following:
26158 @enumerate
26159 @item If a zero-length bit-field follows a normal bit-field, the type of the
26160 zero-length bit-field may affect the alignment of the structure as whole. For
26161 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
26162 normal bit-field, and is of type short.
26164 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
26165 still affect the alignment of the structure:
26167 @smallexample
26168 struct
26169  @{
26170    char foo : 6;
26171    long : 0;
26172  @} t4;
26173 @end smallexample
26175 @noindent
26176 Here, @code{t4} takes up 4 bytes.
26177 @end enumerate
26179 @item Zero-length bit-fields following non-bit-field members are ignored:
26181 @smallexample
26182 struct
26183  @{
26184    char foo;
26185    long : 0;
26186    char bar;
26187  @} t5;
26188 @end smallexample
26190 @noindent
26191 Here, @code{t5} takes up 2 bytes.
26192 @end enumerate
26195 @item -mno-align-stringops
26196 @opindex mno-align-stringops
26197 Do not align the destination of inlined string operations.  This switch reduces
26198 code size and improves performance in case the destination is already aligned,
26199 but GCC doesn't know about it.
26201 @item -minline-all-stringops
26202 @opindex minline-all-stringops
26203 By default GCC inlines string operations only when the destination is 
26204 known to be aligned to least a 4-byte boundary.  
26205 This enables more inlining and increases code
26206 size, but may improve performance of code that depends on fast
26207 @code{memcpy}, @code{strlen},
26208 and @code{memset} for short lengths.
26210 @item -minline-stringops-dynamically
26211 @opindex minline-stringops-dynamically
26212 For string operations of unknown size, use run-time checks with
26213 inline code for small blocks and a library call for large blocks.
26215 @item -mstringop-strategy=@var{alg}
26216 @opindex mstringop-strategy=@var{alg}
26217 Override the internal decision heuristic for the particular algorithm to use
26218 for inlining string operations.  The allowed values for @var{alg} are:
26220 @table @samp
26221 @item rep_byte
26222 @itemx rep_4byte
26223 @itemx rep_8byte
26224 Expand using i386 @code{rep} prefix of the specified size.
26226 @item byte_loop
26227 @itemx loop
26228 @itemx unrolled_loop
26229 Expand into an inline loop.
26231 @item libcall
26232 Always use a library call.
26233 @end table
26235 @item -mmemcpy-strategy=@var{strategy}
26236 @opindex mmemcpy-strategy=@var{strategy}
26237 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26238 should be inlined and what inline algorithm to use when the expected size
26239 of the copy operation is known. @var{strategy} 
26240 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26241 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26242 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26243 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26244 in the list must be specified in increasing order.  The minimal byte size for 
26245 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26246 preceding range.
26248 @item -mmemset-strategy=@var{strategy}
26249 @opindex mmemset-strategy=@var{strategy}
26250 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26251 @code{__builtin_memset} expansion.
26253 @item -momit-leaf-frame-pointer
26254 @opindex momit-leaf-frame-pointer
26255 Don't keep the frame pointer in a register for leaf functions.  This
26256 avoids the instructions to save, set up, and restore frame pointers and
26257 makes an extra register available in leaf functions.  The option
26258 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26259 which might make debugging harder.
26261 @item -mtls-direct-seg-refs
26262 @itemx -mno-tls-direct-seg-refs
26263 @opindex mtls-direct-seg-refs
26264 Controls whether TLS variables may be accessed with offsets from the
26265 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26266 or whether the thread base pointer must be added.  Whether or not this
26267 is valid depends on the operating system, and whether it maps the
26268 segment to cover the entire TLS area.
26270 For systems that use the GNU C Library, the default is on.
26272 @item -msse2avx
26273 @itemx -mno-sse2avx
26274 @opindex msse2avx
26275 Specify that the assembler should encode SSE instructions with VEX
26276 prefix.  The option @option{-mavx} turns this on by default.
26278 @item -mfentry
26279 @itemx -mno-fentry
26280 @opindex mfentry
26281 If profiling is active (@option{-pg}), put the profiling
26282 counter call before the prologue.
26283 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26284 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26286 @item -mrecord-mcount
26287 @itemx -mno-record-mcount
26288 @opindex mrecord-mcount
26289 If profiling is active (@option{-pg}), generate a __mcount_loc section
26290 that contains pointers to each profiling call. This is useful for
26291 automatically patching and out calls.
26293 @item -mnop-mcount
26294 @itemx -mno-nop-mcount
26295 @opindex mnop-mcount
26296 If profiling is active (@option{-pg}), generate the calls to
26297 the profiling functions as NOPs. This is useful when they
26298 should be patched in later dynamically. This is likely only
26299 useful together with @option{-mrecord-mcount}.
26301 @item -mskip-rax-setup
26302 @itemx -mno-skip-rax-setup
26303 @opindex mskip-rax-setup
26304 When generating code for the x86-64 architecture with SSE extensions
26305 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26306 register when there are no variable arguments passed in vector registers.
26308 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26309 saving vector registers on stack when passing variable arguments, the
26310 impacts of this option are callees may waste some stack space,
26311 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26312 those issues, regardless the RAX register value.
26314 @item -m8bit-idiv
26315 @itemx -mno-8bit-idiv
26316 @opindex m8bit-idiv
26317 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26318 much faster than 32-bit/64-bit integer divide.  This option generates a
26319 run-time check.  If both dividend and divisor are within range of 0
26320 to 255, 8-bit unsigned integer divide is used instead of
26321 32-bit/64-bit integer divide.
26323 @item -mavx256-split-unaligned-load
26324 @itemx -mavx256-split-unaligned-store
26325 @opindex mavx256-split-unaligned-load
26326 @opindex mavx256-split-unaligned-store
26327 Split 32-byte AVX unaligned load and store.
26329 @item -mstack-protector-guard=@var{guard}
26330 @itemx -mstack-protector-guard-reg=@var{reg}
26331 @itemx -mstack-protector-guard-offset=@var{offset}
26332 @opindex mstack-protector-guard
26333 @opindex mstack-protector-guard-reg
26334 @opindex mstack-protector-guard-offset
26335 Generate stack protection code using canary at @var{guard}.  Supported
26336 locations are @samp{global} for global canary or @samp{tls} for per-thread
26337 canary in the TLS block (the default).  This option has effect only when
26338 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26340 With the latter choice the options
26341 @option{-mstack-protector-guard-reg=@var{reg}} and
26342 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
26343 which segment register (@code{%fs} or @code{%gs}) to use as base register
26344 for reading the canary, and from what offset from that base register.
26345 The default for those is as specified in the relevant ABI.
26347 @item -mmitigate-rop
26348 @opindex mmitigate-rop
26349 Try to avoid generating code sequences that contain unintended return
26350 opcodes, to mitigate against certain forms of attack. At the moment,
26351 this option is limited in what it can do and should not be relied
26352 on to provide serious protection.
26354 @item -mgeneral-regs-only
26355 @opindex mgeneral-regs-only
26356 Generate code that uses only the general-purpose registers.  This
26357 prevents the compiler from using floating-point, vector, mask and bound
26358 registers.
26360 @end table
26362 These @samp{-m} switches are supported in addition to the above
26363 on x86-64 processors in 64-bit environments.
26365 @table @gcctabopt
26366 @item -m32
26367 @itemx -m64
26368 @itemx -mx32
26369 @itemx -m16
26370 @itemx -miamcu
26371 @opindex m32
26372 @opindex m64
26373 @opindex mx32
26374 @opindex m16
26375 @opindex miamcu
26376 Generate code for a 16-bit, 32-bit or 64-bit environment.
26377 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26378 to 32 bits, and
26379 generates code that runs on any i386 system.
26381 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26382 types to 64 bits, and generates code for the x86-64 architecture.
26383 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26384 and @option{-mdynamic-no-pic} options.
26386 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26387 to 32 bits, and
26388 generates code for the x86-64 architecture.
26390 The @option{-m16} option is the same as @option{-m32}, except for that
26391 it outputs the @code{.code16gcc} assembly directive at the beginning of
26392 the assembly output so that the binary can run in 16-bit mode.
26394 The @option{-miamcu} option generates code which conforms to Intel MCU
26395 psABI.  It requires the @option{-m32} option to be turned on.
26397 @item -mno-red-zone
26398 @opindex mno-red-zone
26399 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26400 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26401 stack pointer that is not modified by signal or interrupt handlers
26402 and therefore can be used for temporary data without adjusting the stack
26403 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26405 @item -mcmodel=small
26406 @opindex mcmodel=small
26407 Generate code for the small code model: the program and its symbols must
26408 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26409 Programs can be statically or dynamically linked.  This is the default
26410 code model.
26412 @item -mcmodel=kernel
26413 @opindex mcmodel=kernel
26414 Generate code for the kernel code model.  The kernel runs in the
26415 negative 2 GB of the address space.
26416 This model has to be used for Linux kernel code.
26418 @item -mcmodel=medium
26419 @opindex mcmodel=medium
26420 Generate code for the medium model: the program is linked in the lower 2
26421 GB of the address space.  Small symbols are also placed there.  Symbols
26422 with sizes larger than @option{-mlarge-data-threshold} are put into
26423 large data or BSS sections and can be located above 2GB.  Programs can
26424 be statically or dynamically linked.
26426 @item -mcmodel=large
26427 @opindex mcmodel=large
26428 Generate code for the large model.  This model makes no assumptions
26429 about addresses and sizes of sections.
26431 @item -maddress-mode=long
26432 @opindex maddress-mode=long
26433 Generate code for long address mode.  This is only supported for 64-bit
26434 and x32 environments.  It is the default address mode for 64-bit
26435 environments.
26437 @item -maddress-mode=short
26438 @opindex maddress-mode=short
26439 Generate code for short address mode.  This is only supported for 32-bit
26440 and x32 environments.  It is the default address mode for 32-bit and
26441 x32 environments.
26442 @end table
26444 @node x86 Windows Options
26445 @subsection x86 Windows Options
26446 @cindex x86 Windows Options
26447 @cindex Windows Options for x86
26449 These additional options are available for Microsoft Windows targets:
26451 @table @gcctabopt
26452 @item -mconsole
26453 @opindex mconsole
26454 This option
26455 specifies that a console application is to be generated, by
26456 instructing the linker to set the PE header subsystem type
26457 required for console applications.
26458 This option is available for Cygwin and MinGW targets and is
26459 enabled by default on those targets.
26461 @item -mdll
26462 @opindex mdll
26463 This option is available for Cygwin and MinGW targets.  It
26464 specifies that a DLL---a dynamic link library---is to be
26465 generated, enabling the selection of the required runtime
26466 startup object and entry point.
26468 @item -mnop-fun-dllimport
26469 @opindex mnop-fun-dllimport
26470 This option is available for Cygwin and MinGW targets.  It
26471 specifies that the @code{dllimport} attribute should be ignored.
26473 @item -mthread
26474 @opindex mthread
26475 This option is available for MinGW targets. It specifies
26476 that MinGW-specific thread support is to be used.
26478 @item -municode
26479 @opindex municode
26480 This option is available for MinGW-w64 targets.  It causes
26481 the @code{UNICODE} preprocessor macro to be predefined, and
26482 chooses Unicode-capable runtime startup code.
26484 @item -mwin32
26485 @opindex mwin32
26486 This option is available for Cygwin and MinGW targets.  It
26487 specifies that the typical Microsoft Windows predefined macros are to
26488 be set in the pre-processor, but does not influence the choice
26489 of runtime library/startup code.
26491 @item -mwindows
26492 @opindex mwindows
26493 This option is available for Cygwin and MinGW targets.  It
26494 specifies that a GUI application is to be generated by
26495 instructing the linker to set the PE header subsystem type
26496 appropriately.
26498 @item -fno-set-stack-executable
26499 @opindex fno-set-stack-executable
26500 This option is available for MinGW targets. It specifies that
26501 the executable flag for the stack used by nested functions isn't
26502 set. This is necessary for binaries running in kernel mode of
26503 Microsoft Windows, as there the User32 API, which is used to set executable
26504 privileges, isn't available.
26506 @item -fwritable-relocated-rdata
26507 @opindex fno-writable-relocated-rdata
26508 This option is available for MinGW and Cygwin targets.  It specifies
26509 that relocated-data in read-only section is put into the @code{.data}
26510 section.  This is a necessary for older runtimes not supporting
26511 modification of @code{.rdata} sections for pseudo-relocation.
26513 @item -mpe-aligned-commons
26514 @opindex mpe-aligned-commons
26515 This option is available for Cygwin and MinGW targets.  It
26516 specifies that the GNU extension to the PE file format that
26517 permits the correct alignment of COMMON variables should be
26518 used when generating code.  It is enabled by default if
26519 GCC detects that the target assembler found during configuration
26520 supports the feature.
26521 @end table
26523 See also under @ref{x86 Options} for standard options.
26525 @node Xstormy16 Options
26526 @subsection Xstormy16 Options
26527 @cindex Xstormy16 Options
26529 These options are defined for Xstormy16:
26531 @table @gcctabopt
26532 @item -msim
26533 @opindex msim
26534 Choose startup files and linker script suitable for the simulator.
26535 @end table
26537 @node Xtensa Options
26538 @subsection Xtensa Options
26539 @cindex Xtensa Options
26541 These options are supported for Xtensa targets:
26543 @table @gcctabopt
26544 @item -mconst16
26545 @itemx -mno-const16
26546 @opindex mconst16
26547 @opindex mno-const16
26548 Enable or disable use of @code{CONST16} instructions for loading
26549 constant values.  The @code{CONST16} instruction is currently not a
26550 standard option from Tensilica.  When enabled, @code{CONST16}
26551 instructions are always used in place of the standard @code{L32R}
26552 instructions.  The use of @code{CONST16} is enabled by default only if
26553 the @code{L32R} instruction is not available.
26555 @item -mfused-madd
26556 @itemx -mno-fused-madd
26557 @opindex mfused-madd
26558 @opindex mno-fused-madd
26559 Enable or disable use of fused multiply/add and multiply/subtract
26560 instructions in the floating-point option.  This has no effect if the
26561 floating-point option is not also enabled.  Disabling fused multiply/add
26562 and multiply/subtract instructions forces the compiler to use separate
26563 instructions for the multiply and add/subtract operations.  This may be
26564 desirable in some cases where strict IEEE 754-compliant results are
26565 required: the fused multiply add/subtract instructions do not round the
26566 intermediate result, thereby producing results with @emph{more} bits of
26567 precision than specified by the IEEE standard.  Disabling fused multiply
26568 add/subtract instructions also ensures that the program output is not
26569 sensitive to the compiler's ability to combine multiply and add/subtract
26570 operations.
26572 @item -mserialize-volatile
26573 @itemx -mno-serialize-volatile
26574 @opindex mserialize-volatile
26575 @opindex mno-serialize-volatile
26576 When this option is enabled, GCC inserts @code{MEMW} instructions before
26577 @code{volatile} memory references to guarantee sequential consistency.
26578 The default is @option{-mserialize-volatile}.  Use
26579 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
26581 @item -mforce-no-pic
26582 @opindex mforce-no-pic
26583 For targets, like GNU/Linux, where all user-mode Xtensa code must be
26584 position-independent code (PIC), this option disables PIC for compiling
26585 kernel code.
26587 @item -mtext-section-literals
26588 @itemx -mno-text-section-literals
26589 @opindex mtext-section-literals
26590 @opindex mno-text-section-literals
26591 These options control the treatment of literal pools.  The default is
26592 @option{-mno-text-section-literals}, which places literals in a separate
26593 section in the output file.  This allows the literal pool to be placed
26594 in a data RAM/ROM, and it also allows the linker to combine literal
26595 pools from separate object files to remove redundant literals and
26596 improve code size.  With @option{-mtext-section-literals}, the literals
26597 are interspersed in the text section in order to keep them as close as
26598 possible to their references.  This may be necessary for large assembly
26599 files.  Literals for each function are placed right before that function.
26601 @item -mauto-litpools
26602 @itemx -mno-auto-litpools
26603 @opindex mauto-litpools
26604 @opindex mno-auto-litpools
26605 These options control the treatment of literal pools.  The default is
26606 @option{-mno-auto-litpools}, which places literals in a separate
26607 section in the output file unless @option{-mtext-section-literals} is
26608 used.  With @option{-mauto-litpools} the literals are interspersed in
26609 the text section by the assembler.  Compiler does not produce explicit
26610 @code{.literal} directives and loads literals into registers with
26611 @code{MOVI} instructions instead of @code{L32R} to let the assembler
26612 do relaxation and place literals as necessary.  This option allows
26613 assembler to create several literal pools per function and assemble
26614 very big functions, which may not be possible with
26615 @option{-mtext-section-literals}.
26617 @item -mtarget-align
26618 @itemx -mno-target-align
26619 @opindex mtarget-align
26620 @opindex mno-target-align
26621 When this option is enabled, GCC instructs the assembler to
26622 automatically align instructions to reduce branch penalties at the
26623 expense of some code density.  The assembler attempts to widen density
26624 instructions to align branch targets and the instructions following call
26625 instructions.  If there are not enough preceding safe density
26626 instructions to align a target, no widening is performed.  The
26627 default is @option{-mtarget-align}.  These options do not affect the
26628 treatment of auto-aligned instructions like @code{LOOP}, which the
26629 assembler always aligns, either by widening density instructions or
26630 by inserting NOP instructions.
26632 @item -mlongcalls
26633 @itemx -mno-longcalls
26634 @opindex mlongcalls
26635 @opindex mno-longcalls
26636 When this option is enabled, GCC instructs the assembler to translate
26637 direct calls to indirect calls unless it can determine that the target
26638 of a direct call is in the range allowed by the call instruction.  This
26639 translation typically occurs for calls to functions in other source
26640 files.  Specifically, the assembler translates a direct @code{CALL}
26641 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
26642 The default is @option{-mno-longcalls}.  This option should be used in
26643 programs where the call target can potentially be out of range.  This
26644 option is implemented in the assembler, not the compiler, so the
26645 assembly code generated by GCC still shows direct call
26646 instructions---look at the disassembled object code to see the actual
26647 instructions.  Note that the assembler uses an indirect call for
26648 every cross-file call, not just those that really are out of range.
26649 @end table
26651 @node zSeries Options
26652 @subsection zSeries Options
26653 @cindex zSeries options
26655 These are listed under @xref{S/390 and zSeries Options}.
26658 @c man end
26660 @node Spec Files
26661 @section Specifying Subprocesses and the Switches to Pass to Them
26662 @cindex Spec Files
26664 @command{gcc} is a driver program.  It performs its job by invoking a
26665 sequence of other programs to do the work of compiling, assembling and
26666 linking.  GCC interprets its command-line parameters and uses these to
26667 deduce which programs it should invoke, and which command-line options
26668 it ought to place on their command lines.  This behavior is controlled
26669 by @dfn{spec strings}.  In most cases there is one spec string for each
26670 program that GCC can invoke, but a few programs have multiple spec
26671 strings to control their behavior.  The spec strings built into GCC can
26672 be overridden by using the @option{-specs=} command-line switch to specify
26673 a spec file.
26675 @dfn{Spec files} are plain-text files that are used to construct spec
26676 strings.  They consist of a sequence of directives separated by blank
26677 lines.  The type of directive is determined by the first non-whitespace
26678 character on the line, which can be one of the following:
26680 @table @code
26681 @item %@var{command}
26682 Issues a @var{command} to the spec file processor.  The commands that can
26683 appear here are:
26685 @table @code
26686 @item %include <@var{file}>
26687 @cindex @code{%include}
26688 Search for @var{file} and insert its text at the current point in the
26689 specs file.
26691 @item %include_noerr <@var{file}>
26692 @cindex @code{%include_noerr}
26693 Just like @samp{%include}, but do not generate an error message if the include
26694 file cannot be found.
26696 @item %rename @var{old_name} @var{new_name}
26697 @cindex @code{%rename}
26698 Rename the spec string @var{old_name} to @var{new_name}.
26700 @end table
26702 @item *[@var{spec_name}]:
26703 This tells the compiler to create, override or delete the named spec
26704 string.  All lines after this directive up to the next directive or
26705 blank line are considered to be the text for the spec string.  If this
26706 results in an empty string then the spec is deleted.  (Or, if the
26707 spec did not exist, then nothing happens.)  Otherwise, if the spec
26708 does not currently exist a new spec is created.  If the spec does
26709 exist then its contents are overridden by the text of this
26710 directive, unless the first character of that text is the @samp{+}
26711 character, in which case the text is appended to the spec.
26713 @item [@var{suffix}]:
26714 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
26715 and up to the next directive or blank line are considered to make up the
26716 spec string for the indicated suffix.  When the compiler encounters an
26717 input file with the named suffix, it processes the spec string in
26718 order to work out how to compile that file.  For example:
26720 @smallexample
26721 .ZZ:
26722 z-compile -input %i
26723 @end smallexample
26725 This says that any input file whose name ends in @samp{.ZZ} should be
26726 passed to the program @samp{z-compile}, which should be invoked with the
26727 command-line switch @option{-input} and with the result of performing the
26728 @samp{%i} substitution.  (See below.)
26730 As an alternative to providing a spec string, the text following a
26731 suffix directive can be one of the following:
26733 @table @code
26734 @item @@@var{language}
26735 This says that the suffix is an alias for a known @var{language}.  This is
26736 similar to using the @option{-x} command-line switch to GCC to specify a
26737 language explicitly.  For example:
26739 @smallexample
26740 .ZZ:
26741 @@c++
26742 @end smallexample
26744 Says that .ZZ files are, in fact, C++ source files.
26746 @item #@var{name}
26747 This causes an error messages saying:
26749 @smallexample
26750 @var{name} compiler not installed on this system.
26751 @end smallexample
26752 @end table
26754 GCC already has an extensive list of suffixes built into it.
26755 This directive adds an entry to the end of the list of suffixes, but
26756 since the list is searched from the end backwards, it is effectively
26757 possible to override earlier entries using this technique.
26759 @end table
26761 GCC has the following spec strings built into it.  Spec files can
26762 override these strings or create their own.  Note that individual
26763 targets can also add their own spec strings to this list.
26765 @smallexample
26766 asm          Options to pass to the assembler
26767 asm_final    Options to pass to the assembler post-processor
26768 cpp          Options to pass to the C preprocessor
26769 cc1          Options to pass to the C compiler
26770 cc1plus      Options to pass to the C++ compiler
26771 endfile      Object files to include at the end of the link
26772 link         Options to pass to the linker
26773 lib          Libraries to include on the command line to the linker
26774 libgcc       Decides which GCC support library to pass to the linker
26775 linker       Sets the name of the linker
26776 predefines   Defines to be passed to the C preprocessor
26777 signed_char  Defines to pass to CPP to say whether @code{char} is signed
26778              by default
26779 startfile    Object files to include at the start of the link
26780 @end smallexample
26782 Here is a small example of a spec file:
26784 @smallexample
26785 %rename lib                 old_lib
26787 *lib:
26788 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
26789 @end smallexample
26791 This example renames the spec called @samp{lib} to @samp{old_lib} and
26792 then overrides the previous definition of @samp{lib} with a new one.
26793 The new definition adds in some extra command-line options before
26794 including the text of the old definition.
26796 @dfn{Spec strings} are a list of command-line options to be passed to their
26797 corresponding program.  In addition, the spec strings can contain
26798 @samp{%}-prefixed sequences to substitute variable text or to
26799 conditionally insert text into the command line.  Using these constructs
26800 it is possible to generate quite complex command lines.
26802 Here is a table of all defined @samp{%}-sequences for spec
26803 strings.  Note that spaces are not generated automatically around the
26804 results of expanding these sequences.  Therefore you can concatenate them
26805 together or combine them with constant text in a single argument.
26807 @table @code
26808 @item %%
26809 Substitute one @samp{%} into the program name or argument.
26811 @item %i
26812 Substitute the name of the input file being processed.
26814 @item %b
26815 Substitute the basename of the input file being processed.
26816 This is the substring up to (and not including) the last period
26817 and not including the directory.
26819 @item %B
26820 This is the same as @samp{%b}, but include the file suffix (text after
26821 the last period).
26823 @item %d
26824 Marks the argument containing or following the @samp{%d} as a
26825 temporary file name, so that that file is deleted if GCC exits
26826 successfully.  Unlike @samp{%g}, this contributes no text to the
26827 argument.
26829 @item %g@var{suffix}
26830 Substitute a file name that has suffix @var{suffix} and is chosen
26831 once per compilation, and mark the argument in the same way as
26832 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
26833 name is now chosen in a way that is hard to predict even when previously
26834 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
26835 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
26836 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
26837 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
26838 was simply substituted with a file name chosen once per compilation,
26839 without regard to any appended suffix (which was therefore treated
26840 just like ordinary text), making such attacks more likely to succeed.
26842 @item %u@var{suffix}
26843 Like @samp{%g}, but generates a new temporary file name
26844 each time it appears instead of once per compilation.
26846 @item %U@var{suffix}
26847 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
26848 new one if there is no such last file name.  In the absence of any
26849 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
26850 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
26851 involves the generation of two distinct file names, one
26852 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
26853 simply substituted with a file name chosen for the previous @samp{%u},
26854 without regard to any appended suffix.
26856 @item %j@var{suffix}
26857 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
26858 writable, and if @option{-save-temps} is not used; 
26859 otherwise, substitute the name
26860 of a temporary file, just like @samp{%u}.  This temporary file is not
26861 meant for communication between processes, but rather as a junk
26862 disposal mechanism.
26864 @item %|@var{suffix}
26865 @itemx %m@var{suffix}
26866 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26867 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26868 all.  These are the two most common ways to instruct a program that it
26869 should read from standard input or write to standard output.  If you
26870 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26871 construct: see for example @file{f/lang-specs.h}.
26873 @item %.@var{SUFFIX}
26874 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26875 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26876 terminated by the next space or %.
26878 @item %w
26879 Marks the argument containing or following the @samp{%w} as the
26880 designated output file of this compilation.  This puts the argument
26881 into the sequence of arguments that @samp{%o} substitutes.
26883 @item %o
26884 Substitutes the names of all the output files, with spaces
26885 automatically placed around them.  You should write spaces
26886 around the @samp{%o} as well or the results are undefined.
26887 @samp{%o} is for use in the specs for running the linker.
26888 Input files whose names have no recognized suffix are not compiled
26889 at all, but they are included among the output files, so they are
26890 linked.
26892 @item %O
26893 Substitutes the suffix for object files.  Note that this is
26894 handled specially when it immediately follows @samp{%g, %u, or %U},
26895 because of the need for those to form complete file names.  The
26896 handling is such that @samp{%O} is treated exactly as if it had already
26897 been substituted, except that @samp{%g, %u, and %U} do not currently
26898 support additional @var{suffix} characters following @samp{%O} as they do
26899 following, for example, @samp{.o}.
26901 @item %p
26902 Substitutes the standard macro predefinitions for the
26903 current target machine.  Use this when running @command{cpp}.
26905 @item %P
26906 Like @samp{%p}, but puts @samp{__} before and after the name of each
26907 predefined macro, except for macros that start with @samp{__} or with
26908 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26911 @item %I
26912 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26913 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26914 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26915 and @option{-imultilib} as necessary.
26917 @item %s
26918 Current argument is the name of a library or startup file of some sort.
26919 Search for that file in a standard list of directories and substitute
26920 the full name found.  The current working directory is included in the
26921 list of directories scanned.
26923 @item %T
26924 Current argument is the name of a linker script.  Search for that file
26925 in the current list of directories to scan for libraries. If the file
26926 is located insert a @option{--script} option into the command line
26927 followed by the full path name found.  If the file is not found then
26928 generate an error message.  Note: the current working directory is not
26929 searched.
26931 @item %e@var{str}
26932 Print @var{str} as an error message.  @var{str} is terminated by a newline.
26933 Use this when inconsistent options are detected.
26935 @item %(@var{name})
26936 Substitute the contents of spec string @var{name} at this point.
26938 @item %x@{@var{option}@}
26939 Accumulate an option for @samp{%X}.
26941 @item %X
26942 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
26943 spec string.
26945 @item %Y
26946 Output the accumulated assembler options specified by @option{-Wa}.
26948 @item %Z
26949 Output the accumulated preprocessor options specified by @option{-Wp}.
26951 @item %a
26952 Process the @code{asm} spec.  This is used to compute the
26953 switches to be passed to the assembler.
26955 @item %A
26956 Process the @code{asm_final} spec.  This is a spec string for
26957 passing switches to an assembler post-processor, if such a program is
26958 needed.
26960 @item %l
26961 Process the @code{link} spec.  This is the spec for computing the
26962 command line passed to the linker.  Typically it makes use of the
26963 @samp{%L %G %S %D and %E} sequences.
26965 @item %D
26966 Dump out a @option{-L} option for each directory that GCC believes might
26967 contain startup files.  If the target supports multilibs then the
26968 current multilib directory is prepended to each of these paths.
26970 @item %L
26971 Process the @code{lib} spec.  This is a spec string for deciding which
26972 libraries are included on the command line to the linker.
26974 @item %G
26975 Process the @code{libgcc} spec.  This is a spec string for deciding
26976 which GCC support library is included on the command line to the linker.
26978 @item %S
26979 Process the @code{startfile} spec.  This is a spec for deciding which
26980 object files are the first ones passed to the linker.  Typically
26981 this might be a file named @file{crt0.o}.
26983 @item %E
26984 Process the @code{endfile} spec.  This is a spec string that specifies
26985 the last object files that are passed to the linker.
26987 @item %C
26988 Process the @code{cpp} spec.  This is used to construct the arguments
26989 to be passed to the C preprocessor.
26991 @item %1
26992 Process the @code{cc1} spec.  This is used to construct the options to be
26993 passed to the actual C compiler (@command{cc1}).
26995 @item %2
26996 Process the @code{cc1plus} spec.  This is used to construct the options to be
26997 passed to the actual C++ compiler (@command{cc1plus}).
26999 @item %*
27000 Substitute the variable part of a matched option.  See below.
27001 Note that each comma in the substituted string is replaced by
27002 a single space.
27004 @item %<S
27005 Remove all occurrences of @code{-S} from the command line.  Note---this
27006 command is position dependent.  @samp{%} commands in the spec string
27007 before this one see @code{-S}, @samp{%} commands in the spec string
27008 after this one do not.
27010 @item %:@var{function}(@var{args})
27011 Call the named function @var{function}, passing it @var{args}.
27012 @var{args} is first processed as a nested spec string, then split
27013 into an argument vector in the usual fashion.  The function returns
27014 a string which is processed as if it had appeared literally as part
27015 of the current spec.
27017 The following built-in spec functions are provided:
27019 @table @code
27020 @item @code{getenv}
27021 The @code{getenv} spec function takes two arguments: an environment
27022 variable name and a string.  If the environment variable is not
27023 defined, a fatal error is issued.  Otherwise, the return value is the
27024 value of the environment variable concatenated with the string.  For
27025 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
27027 @smallexample
27028 %:getenv(TOPDIR /include)
27029 @end smallexample
27031 expands to @file{/path/to/top/include}.
27033 @item @code{if-exists}
27034 The @code{if-exists} spec function takes one argument, an absolute
27035 pathname to a file.  If the file exists, @code{if-exists} returns the
27036 pathname.  Here is a small example of its usage:
27038 @smallexample
27039 *startfile:
27040 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
27041 @end smallexample
27043 @item @code{if-exists-else}
27044 The @code{if-exists-else} spec function is similar to the @code{if-exists}
27045 spec function, except that it takes two arguments.  The first argument is
27046 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
27047 returns the pathname.  If it does not exist, it returns the second argument.
27048 This way, @code{if-exists-else} can be used to select one file or another,
27049 based on the existence of the first.  Here is a small example of its usage:
27051 @smallexample
27052 *startfile:
27053 crt0%O%s %:if-exists(crti%O%s) \
27054 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
27055 @end smallexample
27057 @item @code{replace-outfile}
27058 The @code{replace-outfile} spec function takes two arguments.  It looks for the
27059 first argument in the outfiles array and replaces it with the second argument.  Here
27060 is a small example of its usage:
27062 @smallexample
27063 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
27064 @end smallexample
27066 @item @code{remove-outfile}
27067 The @code{remove-outfile} spec function takes one argument.  It looks for the
27068 first argument in the outfiles array and removes it.  Here is a small example
27069 its usage:
27071 @smallexample
27072 %:remove-outfile(-lm)
27073 @end smallexample
27075 @item @code{pass-through-libs}
27076 The @code{pass-through-libs} spec function takes any number of arguments.  It
27077 finds any @option{-l} options and any non-options ending in @file{.a} (which it
27078 assumes are the names of linker input library archive files) and returns a
27079 result containing all the found arguments each prepended by
27080 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
27081 intended to be passed to the LTO linker plugin.
27083 @smallexample
27084 %:pass-through-libs(%G %L %G)
27085 @end smallexample
27087 @item @code{print-asm-header}
27088 The @code{print-asm-header} function takes no arguments and simply
27089 prints a banner like:
27091 @smallexample
27092 Assembler options
27093 =================
27095 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
27096 @end smallexample
27098 It is used to separate compiler options from assembler options
27099 in the @option{--target-help} output.
27100 @end table
27102 @item %@{S@}
27103 Substitutes the @code{-S} switch, if that switch is given to GCC@.
27104 If that switch is not specified, this substitutes nothing.  Note that
27105 the leading dash is omitted when specifying this option, and it is
27106 automatically inserted if the substitution is performed.  Thus the spec
27107 string @samp{%@{foo@}} matches the command-line option @option{-foo}
27108 and outputs the command-line option @option{-foo}.
27110 @item %W@{S@}
27111 Like %@{@code{S}@} but mark last argument supplied within as a file to be
27112 deleted on failure.
27114 @item %@{S*@}
27115 Substitutes all the switches specified to GCC whose names start
27116 with @code{-S}, but which also take an argument.  This is used for
27117 switches like @option{-o}, @option{-D}, @option{-I}, etc.
27118 GCC considers @option{-o foo} as being
27119 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
27120 text, including the space.  Thus two arguments are generated.
27122 @item %@{S*&T*@}
27123 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
27124 (the order of @code{S} and @code{T} in the spec is not significant).
27125 There can be any number of ampersand-separated variables; for each the
27126 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
27128 @item %@{S:X@}
27129 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
27131 @item %@{!S:X@}
27132 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
27134 @item %@{S*:X@}
27135 Substitutes @code{X} if one or more switches whose names start with
27136 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
27137 once, no matter how many such switches appeared.  However, if @code{%*}
27138 appears somewhere in @code{X}, then @code{X} is substituted once
27139 for each matching switch, with the @code{%*} replaced by the part of
27140 that switch matching the @code{*}.
27142 If @code{%*} appears as the last part of a spec sequence then a space
27143 is added after the end of the last substitution.  If there is more
27144 text in the sequence, however, then a space is not generated.  This
27145 allows the @code{%*} substitution to be used as part of a larger
27146 string.  For example, a spec string like this:
27148 @smallexample
27149 %@{mcu=*:--script=%*/memory.ld@}
27150 @end smallexample
27152 @noindent
27153 when matching an option like @option{-mcu=newchip} produces:
27155 @smallexample
27156 --script=newchip/memory.ld
27157 @end smallexample
27159 @item %@{.S:X@}
27160 Substitutes @code{X}, if processing a file with suffix @code{S}.
27162 @item %@{!.S:X@}
27163 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
27165 @item %@{,S:X@}
27166 Substitutes @code{X}, if processing a file for language @code{S}.
27168 @item %@{!,S:X@}
27169 Substitutes @code{X}, if not processing a file for language @code{S}.
27171 @item %@{S|P:X@}
27172 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
27173 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
27174 @code{*} sequences as well, although they have a stronger binding than
27175 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
27176 alternatives must be starred, and only the first matching alternative
27177 is substituted.
27179 For example, a spec string like this:
27181 @smallexample
27182 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
27183 @end smallexample
27185 @noindent
27186 outputs the following command-line options from the following input
27187 command-line options:
27189 @smallexample
27190 fred.c        -foo -baz
27191 jim.d         -bar -boggle
27192 -d fred.c     -foo -baz -boggle
27193 -d jim.d      -bar -baz -boggle
27194 @end smallexample
27196 @item %@{S:X; T:Y; :D@}
27198 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
27199 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
27200 be as many clauses as you need.  This may be combined with @code{.},
27201 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
27204 @end table
27206 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
27207 or similar construct can use a backslash to ignore the special meaning
27208 of the character following it, thus allowing literal matching of a
27209 character that is otherwise specially treated.  For example,
27210 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
27211 @option{-std=iso9899:1999} option is given.
27213 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
27214 construct may contain other nested @samp{%} constructs or spaces, or
27215 even newlines.  They are processed as usual, as described above.
27216 Trailing white space in @code{X} is ignored.  White space may also
27217 appear anywhere on the left side of the colon in these constructs,
27218 except between @code{.} or @code{*} and the corresponding word.
27220 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
27221 handled specifically in these constructs.  If another value of
27222 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
27223 @option{-W} switch is found later in the command line, the earlier
27224 switch value is ignored, except with @{@code{S}*@} where @code{S} is
27225 just one letter, which passes all matching options.
27227 The character @samp{|} at the beginning of the predicate text is used to
27228 indicate that a command should be piped to the following command, but
27229 only if @option{-pipe} is specified.
27231 It is built into GCC which switches take arguments and which do not.
27232 (You might think it would be useful to generalize this to allow each
27233 compiler's spec to say which switches take arguments.  But this cannot
27234 be done in a consistent fashion.  GCC cannot even decide which input
27235 files have been specified without knowing which switches take arguments,
27236 and it must know which input files to compile in order to tell which
27237 compilers to run).
27239 GCC also knows implicitly that arguments starting in @option{-l} are to be
27240 treated as compiler output files, and passed to the linker in their
27241 proper position among the other output files.
27243 @node Environment Variables
27244 @section Environment Variables Affecting GCC
27245 @cindex environment variables
27247 @c man begin ENVIRONMENT
27248 This section describes several environment variables that affect how GCC
27249 operates.  Some of them work by specifying directories or prefixes to use
27250 when searching for various kinds of files.  Some are used to specify other
27251 aspects of the compilation environment.
27253 Note that you can also specify places to search using options such as
27254 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27255 take precedence over places specified using environment variables, which
27256 in turn take precedence over those specified by the configuration of GCC@.
27257 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27258 GNU Compiler Collection (GCC) Internals}.
27260 @table @env
27261 @item LANG
27262 @itemx LC_CTYPE
27263 @c @itemx LC_COLLATE
27264 @itemx LC_MESSAGES
27265 @c @itemx LC_MONETARY
27266 @c @itemx LC_NUMERIC
27267 @c @itemx LC_TIME
27268 @itemx LC_ALL
27269 @findex LANG
27270 @findex LC_CTYPE
27271 @c @findex LC_COLLATE
27272 @findex LC_MESSAGES
27273 @c @findex LC_MONETARY
27274 @c @findex LC_NUMERIC
27275 @c @findex LC_TIME
27276 @findex LC_ALL
27277 @cindex locale
27278 These environment variables control the way that GCC uses
27279 localization information which allows GCC to work with different
27280 national conventions.  GCC inspects the locale categories
27281 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27282 so.  These locale categories can be set to any value supported by your
27283 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27284 Kingdom encoded in UTF-8.
27286 The @env{LC_CTYPE} environment variable specifies character
27287 classification.  GCC uses it to determine the character boundaries in
27288 a string; this is needed for some multibyte encodings that contain quote
27289 and escape characters that are otherwise interpreted as a string
27290 end or escape.
27292 The @env{LC_MESSAGES} environment variable specifies the language to
27293 use in diagnostic messages.
27295 If the @env{LC_ALL} environment variable is set, it overrides the value
27296 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27297 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27298 environment variable.  If none of these variables are set, GCC
27299 defaults to traditional C English behavior.
27301 @item TMPDIR
27302 @findex TMPDIR
27303 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27304 files.  GCC uses temporary files to hold the output of one stage of
27305 compilation which is to be used as input to the next stage: for example,
27306 the output of the preprocessor, which is the input to the compiler
27307 proper.
27309 @item GCC_COMPARE_DEBUG
27310 @findex GCC_COMPARE_DEBUG
27311 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27312 @option{-fcompare-debug} to the compiler driver.  See the documentation
27313 of this option for more details.
27315 @item GCC_EXEC_PREFIX
27316 @findex GCC_EXEC_PREFIX
27317 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27318 names of the subprograms executed by the compiler.  No slash is added
27319 when this prefix is combined with the name of a subprogram, but you can
27320 specify a prefix that ends with a slash if you wish.
27322 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27323 an appropriate prefix to use based on the pathname it is invoked with.
27325 If GCC cannot find the subprogram using the specified prefix, it
27326 tries looking in the usual places for the subprogram.
27328 The default value of @env{GCC_EXEC_PREFIX} is
27329 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27330 the installed compiler. In many cases @var{prefix} is the value
27331 of @code{prefix} when you ran the @file{configure} script.
27333 Other prefixes specified with @option{-B} take precedence over this prefix.
27335 This prefix is also used for finding files such as @file{crt0.o} that are
27336 used for linking.
27338 In addition, the prefix is used in an unusual way in finding the
27339 directories to search for header files.  For each of the standard
27340 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27341 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27342 replacing that beginning with the specified prefix to produce an
27343 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27344 @file{foo/bar} just before it searches the standard directory 
27345 @file{/usr/local/lib/bar}.
27346 If a standard directory begins with the configured
27347 @var{prefix} then the value of @var{prefix} is replaced by
27348 @env{GCC_EXEC_PREFIX} when looking for header files.
27350 @item COMPILER_PATH
27351 @findex COMPILER_PATH
27352 The value of @env{COMPILER_PATH} is a colon-separated list of
27353 directories, much like @env{PATH}.  GCC tries the directories thus
27354 specified when searching for subprograms, if it cannot find the
27355 subprograms using @env{GCC_EXEC_PREFIX}.
27357 @item LIBRARY_PATH
27358 @findex LIBRARY_PATH
27359 The value of @env{LIBRARY_PATH} is a colon-separated list of
27360 directories, much like @env{PATH}.  When configured as a native compiler,
27361 GCC tries the directories thus specified when searching for special
27362 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27363 using GCC also uses these directories when searching for ordinary
27364 libraries for the @option{-l} option (but directories specified with
27365 @option{-L} come first).
27367 @item LANG
27368 @findex LANG
27369 @cindex locale definition
27370 This variable is used to pass locale information to the compiler.  One way in
27371 which this information is used is to determine the character set to be used
27372 when character literals, string literals and comments are parsed in C and C++.
27373 When the compiler is configured to allow multibyte characters,
27374 the following values for @env{LANG} are recognized:
27376 @table @samp
27377 @item C-JIS
27378 Recognize JIS characters.
27379 @item C-SJIS
27380 Recognize SJIS characters.
27381 @item C-EUCJP
27382 Recognize EUCJP characters.
27383 @end table
27385 If @env{LANG} is not defined, or if it has some other value, then the
27386 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27387 recognize and translate multibyte characters.
27388 @end table
27390 @noindent
27391 Some additional environment variables affect the behavior of the
27392 preprocessor.
27394 @include cppenv.texi
27396 @c man end
27398 @node Precompiled Headers
27399 @section Using Precompiled Headers
27400 @cindex precompiled headers
27401 @cindex speed of compilation
27403 Often large projects have many header files that are included in every
27404 source file.  The time the compiler takes to process these header files
27405 over and over again can account for nearly all of the time required to
27406 build the project.  To make builds faster, GCC allows you to
27407 @dfn{precompile} a header file.
27409 To create a precompiled header file, simply compile it as you would any
27410 other file, if necessary using the @option{-x} option to make the driver
27411 treat it as a C or C++ header file.  You may want to use a
27412 tool like @command{make} to keep the precompiled header up-to-date when
27413 the headers it contains change.
27415 A precompiled header file is searched for when @code{#include} is
27416 seen in the compilation.  As it searches for the included file
27417 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27418 compiler looks for a precompiled header in each directory just before it
27419 looks for the include file in that directory.  The name searched for is
27420 the name specified in the @code{#include} with @samp{.gch} appended.  If
27421 the precompiled header file cannot be used, it is ignored.
27423 For instance, if you have @code{#include "all.h"}, and you have
27424 @file{all.h.gch} in the same directory as @file{all.h}, then the
27425 precompiled header file is used if possible, and the original
27426 header is used otherwise.
27428 Alternatively, you might decide to put the precompiled header file in a
27429 directory and use @option{-I} to ensure that directory is searched
27430 before (or instead of) the directory containing the original header.
27431 Then, if you want to check that the precompiled header file is always
27432 used, you can put a file of the same name as the original header in this
27433 directory containing an @code{#error} command.
27435 This also works with @option{-include}.  So yet another way to use
27436 precompiled headers, good for projects not designed with precompiled
27437 header files in mind, is to simply take most of the header files used by
27438 a project, include them from another header file, precompile that header
27439 file, and @option{-include} the precompiled header.  If the header files
27440 have guards against multiple inclusion, they are skipped because
27441 they've already been included (in the precompiled header).
27443 If you need to precompile the same header file for different
27444 languages, targets, or compiler options, you can instead make a
27445 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27446 header in the directory, perhaps using @option{-o}.  It doesn't matter
27447 what you call the files in the directory; every precompiled header in
27448 the directory is considered.  The first precompiled header
27449 encountered in the directory that is valid for this compilation is
27450 used; they're searched in no particular order.
27452 There are many other possibilities, limited only by your imagination,
27453 good sense, and the constraints of your build system.
27455 A precompiled header file can be used only when these conditions apply:
27457 @itemize
27458 @item
27459 Only one precompiled header can be used in a particular compilation.
27461 @item
27462 A precompiled header cannot be used once the first C token is seen.  You
27463 can have preprocessor directives before a precompiled header; you cannot
27464 include a precompiled header from inside another header.
27466 @item
27467 The precompiled header file must be produced for the same language as
27468 the current compilation.  You cannot use a C precompiled header for a C++
27469 compilation.
27471 @item
27472 The precompiled header file must have been produced by the same compiler
27473 binary as the current compilation is using.
27475 @item
27476 Any macros defined before the precompiled header is included must
27477 either be defined in the same way as when the precompiled header was
27478 generated, or must not affect the precompiled header, which usually
27479 means that they don't appear in the precompiled header at all.
27481 The @option{-D} option is one way to define a macro before a
27482 precompiled header is included; using a @code{#define} can also do it.
27483 There are also some options that define macros implicitly, like
27484 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
27485 defined this way.
27487 @item If debugging information is output when using the precompiled
27488 header, using @option{-g} or similar, the same kind of debugging information
27489 must have been output when building the precompiled header.  However,
27490 a precompiled header built using @option{-g} can be used in a compilation
27491 when no debugging information is being output.
27493 @item The same @option{-m} options must generally be used when building
27494 and using the precompiled header.  @xref{Submodel Options},
27495 for any cases where this rule is relaxed.
27497 @item Each of the following options must be the same when building and using
27498 the precompiled header:
27500 @gccoptlist{-fexceptions}
27502 @item
27503 Some other command-line options starting with @option{-f},
27504 @option{-p}, or @option{-O} must be defined in the same way as when
27505 the precompiled header was generated.  At present, it's not clear
27506 which options are safe to change and which are not; the safest choice
27507 is to use exactly the same options when generating and using the
27508 precompiled header.  The following are known to be safe:
27510 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
27511 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
27512 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
27513 -pedantic-errors}
27515 @end itemize
27517 For all of these except the last, the compiler automatically
27518 ignores the precompiled header if the conditions aren't met.  If you
27519 find an option combination that doesn't work and doesn't cause the
27520 precompiled header to be ignored, please consider filing a bug report,
27521 see @ref{Bugs}.
27523 If you do use differing options when generating and using the
27524 precompiled header, the actual behavior is a mixture of the
27525 behavior for the options.  For instance, if you use @option{-g} to
27526 generate the precompiled header but not when using it, you may or may
27527 not get debugging information for routines in the precompiled header.