[AArch64] Avoid GET_MODE_NUNITS in v8.4 support
[official-gcc.git] / gcc / doc / invoke.texi
blobe4768b84b441a9afc4913fc31c2a2c3aaf7c7faf
1 @c Copyright (C) 1988-2018 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2018 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), dbx(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -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-function-type  -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} -Wstringop-truncation @gol
318 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}malloc@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}  -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 -gstatement-frontiers  -gno-statement-frontiers @gol
350 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
351 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
352 -fno-eliminate-unused-debug-types @gol
353 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
354 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
355 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
356 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
357 -fvar-tracking  -fvar-tracking-assignments}
359 @item Optimization Options
360 @xref{Optimize Options,,Options that Control Optimization}.
361 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
362 -falign-jumps[=@var{n}] @gol
363 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
364 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
365 -fauto-inc-dec  -fbranch-probabilities @gol
366 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
367 -fbtr-bb-exclusive  -fcaller-saves @gol
368 -fcombine-stack-adjustments  -fconserve-stack @gol
369 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
370 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
371 -fcx-limited-range @gol
372 -fdata-sections  -fdce  -fdelayed-branch @gol
373 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
374 -fdevirtualize-at-ltrans  -fdse @gol
375 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
376 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
377 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
378 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
379 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
380 -fif-conversion2  -findirect-inlining @gol
381 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
382 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
383 -fipa-bit-cp -fipa-vrp @gol
384 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
385 -fira-algorithm=@var{algorithm} @gol
386 -fira-region=@var{region}  -fira-hoist-pressure @gol
387 -fira-loop-pressure  -fno-ira-share-save-slots @gol
388 -fno-ira-share-spill-slots @gol
389 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
390 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
391 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
392 -floop-block  -floop-interchange  -floop-strip-mine @gol
393 -floop-unroll-and-jam  -floop-nest-optimize @gol
394 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
395 -flto-partition=@var{alg}  -fmerge-all-constants @gol
396 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
397 -fmove-loop-invariants  -fno-branch-count-reg @gol
398 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
399 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
400 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
401 -fno-sched-spec  -fno-signed-zeros @gol
402 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
403 -fomit-frame-pointer  -foptimize-sibling-calls @gol
404 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
405 -fprefetch-loop-arrays @gol
406 -fprofile-correction @gol
407 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
408 -fprofile-reorder-functions @gol
409 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
410 -freorder-blocks-algorithm=@var{algorithm} @gol
411 -freorder-blocks-and-partition  -freorder-functions @gol
412 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
413 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
414 -fsched-spec-load  -fsched-spec-load-dangerous @gol
415 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
416 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
417 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
418 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
419 -fschedule-fusion @gol
420 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
421 -fselective-scheduling  -fselective-scheduling2 @gol
422 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
423 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
424 -fsignaling-nans @gol
425 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
426 -fsplit-paths @gol
427 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
428 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
429 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
430 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
431 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
432 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
433 -ftree-loop-if-convert  -ftree-loop-im @gol
434 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
435 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
436 -ftree-loop-vectorize @gol
437 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
438 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
439 -ftree-switch-conversion  -ftree-tail-merge @gol
440 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
441 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
442 -funsafe-math-optimizations  -funswitch-loops @gol
443 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
444 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
445 --param @var{name}=@var{value}
446 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
448 @item Program Instrumentation Options
449 @xref{Instrumentation Options,,Program Instrumentation Options}.
450 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
451 -fprofile-abs-path @gol
452 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
453 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
454 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
455 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
456 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
457 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
458 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
459 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
460 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
461 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
462 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
463 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
464 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
465 -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]} @gol
466 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
467 -fstack-protector-explicit  -fstack-check @gol
468 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
469 -fno-stack-limit  -fsplit-stack @gol
470 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
471 -fvtv-counts  -fvtv-debug @gol
472 -finstrument-functions @gol
473 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
474 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
476 @item Preprocessor Options
477 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
478 @gccoptlist{-A@var{question}=@var{answer} @gol
479 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
480 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
481 -dD  -dI  -dM  -dN  -dU @gol
482 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
483 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
484 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
485 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
486 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
487 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
488 -H  -imacros @var{file}  -include @var{file} @gol
489 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
490 -no-integrated-cpp  -P  -pthread  -remap @gol
491 -traditional  -traditional-cpp  -trigraphs @gol
492 -U@var{macro}  -undef  @gol
493 -Wp,@var{option}  -Xpreprocessor @var{option}}
495 @item Assembler Options
496 @xref{Assembler Options,,Passing Options to the Assembler}.
497 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
499 @item Linker Options
500 @xref{Link Options,,Options for Linking}.
501 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
502 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
503 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
504 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
505 -static-libmpx  -static-libmpxwrappers @gol
506 -shared  -shared-libgcc  -symbolic @gol
507 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
508 -u @var{symbol}  -z @var{keyword}}
510 @item Directory Options
511 @xref{Directory Options,,Options for Directory Search}.
512 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
513 -idirafter @var{dir} @gol
514 -imacros @var{file}  -imultilib @var{dir} @gol
515 -iplugindir=@var{dir}  -iprefix @var{file} @gol
516 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
517 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
518 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
519 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
521 @item Code Generation Options
522 @xref{Code Gen Options,,Options for Code Generation Conventions}.
523 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
524 -ffixed-@var{reg}  -fexceptions @gol
525 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
526 -fasynchronous-unwind-tables @gol
527 -fno-gnu-unique @gol
528 -finhibit-size-directive  -fno-common  -fno-ident @gol
529 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
530 -fno-jump-tables @gol
531 -frecord-gcc-switches @gol
532 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
533 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
534 -fleading-underscore  -ftls-model=@var{model} @gol
535 -fstack-reuse=@var{reuse_level} @gol
536 -ftrampolines  -ftrapv  -fwrapv @gol
537 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
538 -fstrict-volatile-bitfields  -fsync-libcalls}
540 @item Developer Options
541 @xref{Developer Options,,GCC Developer Options}.
542 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
543 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
544 -fdbg-cnt=@var{counter-value-list} @gol
545 -fdisable-ipa-@var{pass_name} @gol
546 -fdisable-rtl-@var{pass_name} @gol
547 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
548 -fdisable-tree-@var{pass_name} @gol
549 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
550 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
551 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
552 -fdump-final-insns@r{[}=@var{file}@r{]} @gol
553 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
554 -fdump-lang-all @gol
555 -fdump-lang-@var{switch} @gol
556 -fdump-lang-@var{switch}-@var{options} @gol
557 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
558 -fdump-passes @gol
559 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
560 -fdump-statistics @gol
561 -fdump-tree-all @gol
562 -fdump-tree-@var{switch} @gol
563 -fdump-tree-@var{switch}-@var{options} @gol
564 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
565 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
566 -fenable-@var{kind}-@var{pass} @gol
567 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
568 -fira-verbose=@var{n} @gol
569 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
570 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
571 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
572 -fprofile-report @gol
573 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
574 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
575 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
576 -fvar-tracking-assignments-toggle  -gtoggle @gol
577 -print-file-name=@var{library}  -print-libgcc-file-name @gol
578 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
579 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
580 -print-sysroot  -print-sysroot-headers-suffix @gol
581 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
583 @item Machine-Dependent Options
584 @xref{Submodel Options,,Machine-Dependent Options}.
585 @c This list is ordered alphanumerically by subsection name.
586 @c Try and put the significant identifier (CPU or system) first,
587 @c so users have a clue at guessing where the ones they want will be.
589 @emph{AArch64 Options}
590 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
591 -mgeneral-regs-only @gol
592 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
593 -mstrict-align @gol
594 -momit-leaf-frame-pointer @gol
595 -mtls-dialect=desc  -mtls-dialect=traditional @gol
596 -mtls-size=@var{size} @gol
597 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
598 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
599 -mpc-relative-literal-loads @gol
600 -msign-return-address=@var{scope} @gol
601 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  @gol
602 -moverride=@var{string}  -mverbose-cost-dump}
604 @emph{Adapteva Epiphany Options}
605 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
606 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
607 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
608 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
609 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
610 -msplit-vecmove-early  -m1reg-@var{reg}}
612 @emph{ARC Options}
613 @gccoptlist{-mbarrel-shifter @gol
614 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
615 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
616 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
617 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
618 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
619 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
620 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
621 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
622 -mvolatile-cache  -mtp-regno=@var{regno} @gol
623 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
624 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
625 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
626 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
627 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
628 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
629 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
630 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
632 @emph{ARM Options}
633 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
634 -mabi=@var{name} @gol
635 -mapcs-stack-check  -mno-apcs-stack-check @gol
636 -mapcs-reentrant  -mno-apcs-reentrant @gol
637 -msched-prolog  -mno-sched-prolog @gol
638 -mlittle-endian  -mbig-endian @gol
639 -mbe8 -mbe32 @gol
640 -mfloat-abi=@var{name} @gol
641 -mfp16-format=@var{name}
642 -mthumb-interwork  -mno-thumb-interwork @gol
643 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
644 -mtune=@var{name}  -mprint-tune-info @gol
645 -mstructure-size-boundary=@var{n} @gol
646 -mabort-on-noreturn @gol
647 -mlong-calls  -mno-long-calls @gol
648 -msingle-pic-base  -mno-single-pic-base @gol
649 -mpic-register=@var{reg} @gol
650 -mnop-fun-dllimport @gol
651 -mpoke-function-name @gol
652 -mthumb  -marm  -mflip-thumb @gol
653 -mtpcs-frame  -mtpcs-leaf-frame @gol
654 -mcaller-super-interworking  -mcallee-super-interworking @gol
655 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
656 -mword-relocations @gol
657 -mfix-cortex-m3-ldrd @gol
658 -munaligned-access @gol
659 -mneon-for-64bits @gol
660 -mslow-flash-data @gol
661 -masm-syntax-unified @gol
662 -mrestrict-it @gol
663 -mverbose-cost-dump @gol
664 -mpure-code @gol
665 -mcmse}
667 @emph{AVR Options}
668 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
669 -mbranch-cost=@var{cost} @gol
670 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
671 -mn_flash=@var{size}  -mno-interrupts @gol
672 -mmain-is-OS_task -mrelax  -mrmw  -mstrict-X  -mtiny-stack @gol
673 -mfract-convert-truncate @gol
674 -mshort-calls  -nodevicelib @gol
675 -Waddr-space-convert  -Wmisspelled-isr}
677 @emph{Blackfin Options}
678 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
679 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
680 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
681 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
682 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
683 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
684 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
685 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
686 -micplb}
688 @emph{C6X Options}
689 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
690 -msim  -msdata=@var{sdata-type}}
692 @emph{CRIS Options}
693 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
694 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
695 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
696 -mstack-align  -mdata-align  -mconst-align @gol
697 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
698 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
699 -mmul-bug-workaround  -mno-mul-bug-workaround}
701 @emph{CR16 Options}
702 @gccoptlist{-mmac @gol
703 -mcr16cplus  -mcr16c @gol
704 -msim  -mint32  -mbit-ops
705 -mdata-model=@var{model}}
707 @emph{Darwin Options}
708 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
709 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
710 -client_name  -compatibility_version  -current_version @gol
711 -dead_strip @gol
712 -dependency-file  -dylib_file  -dylinker_install_name @gol
713 -dynamic  -dynamiclib  -exported_symbols_list @gol
714 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
715 -force_flat_namespace  -headerpad_max_install_names @gol
716 -iframework @gol
717 -image_base  -init  -install_name  -keep_private_externs @gol
718 -multi_module  -multiply_defined  -multiply_defined_unused @gol
719 -noall_load   -no_dead_strip_inits_and_terms @gol
720 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
721 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
722 -private_bundle  -read_only_relocs  -sectalign @gol
723 -sectobjectsymbols  -whyload  -seg1addr @gol
724 -sectcreate  -sectobjectsymbols  -sectorder @gol
725 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
726 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
727 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
728 -single_module  -static  -sub_library  -sub_umbrella @gol
729 -twolevel_namespace  -umbrella  -undefined @gol
730 -unexported_symbols_list  -weak_reference_mismatches @gol
731 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
732 -mkernel  -mone-byte-bool}
734 @emph{DEC Alpha Options}
735 @gccoptlist{-mno-fp-regs  -msoft-float @gol
736 -mieee  -mieee-with-inexact  -mieee-conformant @gol
737 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
738 -mtrap-precision=@var{mode}  -mbuild-constants @gol
739 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
740 -mbwx  -mmax  -mfix  -mcix @gol
741 -mfloat-vax  -mfloat-ieee @gol
742 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
743 -msmall-text  -mlarge-text @gol
744 -mmemory-latency=@var{time}}
746 @emph{FR30 Options}
747 @gccoptlist{-msmall-model  -mno-lsim}
749 @emph{FT32 Options}
750 @gccoptlist{-msim  -mlra  -mnodiv  -mft32b  -mcompress  -mnopm}
752 @emph{FRV Options}
753 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
754 -mhard-float  -msoft-float @gol
755 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
756 -mdouble  -mno-double @gol
757 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
758 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
759 -mlinked-fp  -mlong-calls  -malign-labels @gol
760 -mlibrary-pic  -macc-4  -macc-8 @gol
761 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
762 -moptimize-membar  -mno-optimize-membar @gol
763 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
764 -mvliw-branch  -mno-vliw-branch @gol
765 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
766 -mno-nested-cond-exec  -mtomcat-stats @gol
767 -mTLS  -mtls @gol
768 -mcpu=@var{cpu}}
770 @emph{GNU/Linux Options}
771 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
772 -tno-android-cc  -tno-android-ld}
774 @emph{H8/300 Options}
775 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
777 @emph{HPPA Options}
778 @gccoptlist{-march=@var{architecture-type} @gol
779 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
780 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
781 -mfixed-range=@var{register-range} @gol
782 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
783 -mlong-load-store  -mno-disable-fpregs @gol
784 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
785 -mno-jump-in-delay  -mno-long-load-store @gol
786 -mno-portable-runtime  -mno-soft-float @gol
787 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
788 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
789 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
790 -munix=@var{unix-std}  -nolibdld  -static  -threads}
792 @emph{IA-64 Options}
793 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
794 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
795 -mconstant-gp  -mauto-pic  -mfused-madd @gol
796 -minline-float-divide-min-latency @gol
797 -minline-float-divide-max-throughput @gol
798 -mno-inline-float-divide @gol
799 -minline-int-divide-min-latency @gol
800 -minline-int-divide-max-throughput  @gol
801 -mno-inline-int-divide @gol
802 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
803 -mno-inline-sqrt @gol
804 -mdwarf2-asm  -mearly-stop-bits @gol
805 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
806 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
807 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
808 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
809 -msched-spec-ldc  -msched-spec-control-ldc @gol
810 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
811 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
812 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
813 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
815 @emph{LM32 Options}
816 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
817 -msign-extend-enabled  -muser-enabled}
819 @emph{M32R/D Options}
820 @gccoptlist{-m32r2  -m32rx  -m32r @gol
821 -mdebug @gol
822 -malign-loops  -mno-align-loops @gol
823 -missue-rate=@var{number} @gol
824 -mbranch-cost=@var{number} @gol
825 -mmodel=@var{code-size-model-type} @gol
826 -msdata=@var{sdata-type} @gol
827 -mno-flush-func  -mflush-func=@var{name} @gol
828 -mno-flush-trap  -mflush-trap=@var{number} @gol
829 -G @var{num}}
831 @emph{M32C Options}
832 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
834 @emph{M680x0 Options}
835 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
836 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
837 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
838 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
839 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
840 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
841 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
842 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
843 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
845 @emph{MCore Options}
846 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
847 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
848 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
849 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
850 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
852 @emph{MeP Options}
853 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
854 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
855 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
856 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
857 -mtiny=@var{n}}
859 @emph{MicroBlaze Options}
860 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
861 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
862 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
863 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
864 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
866 @emph{MIPS Options}
867 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
868 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
869 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
870 -mips16  -mno-mips16  -mflip-mips16 @gol
871 -minterlink-compressed  -mno-interlink-compressed @gol
872 -minterlink-mips16  -mno-interlink-mips16 @gol
873 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
874 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
875 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
876 -mno-float  -msingle-float  -mdouble-float @gol
877 -modd-spreg  -mno-odd-spreg @gol
878 -mabs=@var{mode}  -mnan=@var{encoding} @gol
879 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
880 -mmcu  -mmno-mcu @gol
881 -meva  -mno-eva @gol
882 -mvirt  -mno-virt @gol
883 -mxpa  -mno-xpa @gol
884 -mmicromips  -mno-micromips @gol
885 -mmsa  -mno-msa @gol
886 -mfpu=@var{fpu-type} @gol
887 -msmartmips  -mno-smartmips @gol
888 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
889 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
890 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
891 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
892 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
893 -membedded-data  -mno-embedded-data @gol
894 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
895 -mcode-readable=@var{setting} @gol
896 -msplit-addresses  -mno-split-addresses @gol
897 -mexplicit-relocs  -mno-explicit-relocs @gol
898 -mcheck-zero-division  -mno-check-zero-division @gol
899 -mdivide-traps  -mdivide-breaks @gol
900 -mload-store-pairs  -mno-load-store-pairs @gol
901 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
902 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
903 -mfix-24k  -mno-fix-24k @gol
904 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
905 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
906 -mfix-vr4120  -mno-fix-vr4120 @gol
907 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
908 -mflush-func=@var{func}  -mno-flush-func @gol
909 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
910 -mcompact-branches=@var{policy} @gol
911 -mfp-exceptions  -mno-fp-exceptions @gol
912 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
913 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
914 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
915 -mframe-header-opt  -mno-frame-header-opt}
917 @emph{MMIX Options}
918 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
919 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
920 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
921 -mno-base-addresses  -msingle-exit  -mno-single-exit}
923 @emph{MN10300 Options}
924 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
925 -mno-am33  -mam33  -mam33-2  -mam34 @gol
926 -mtune=@var{cpu-type} @gol
927 -mreturn-pointer-on-d0 @gol
928 -mno-crt0  -mrelax  -mliw  -msetlb}
930 @emph{Moxie Options}
931 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
933 @emph{MSP430 Options}
934 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
935 -mwarn-mcu @gol
936 -mcode-region=  -mdata-region= @gol
937 -msilicon-errata=  -msilicon-errata-warn= @gol
938 -mhwmult=  -minrt}
940 @emph{NDS32 Options}
941 @gccoptlist{-mbig-endian  -mlittle-endian @gol
942 -mreduced-regs  -mfull-regs @gol
943 -mcmov  -mno-cmov @gol
944 -mperf-ext  -mno-perf-ext @gol
945 -mv3push  -mno-v3push @gol
946 -m16bit  -mno-16bit @gol
947 -misr-vector-size=@var{num} @gol
948 -mcache-block-size=@var{num} @gol
949 -march=@var{arch} @gol
950 -mcmodel=@var{code-model} @gol
951 -mctor-dtor  -mrelax}
953 @emph{Nios II Options}
954 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
955 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
956 -mel  -meb @gol
957 -mno-bypass-cache  -mbypass-cache @gol
958 -mno-cache-volatile  -mcache-volatile @gol
959 -mno-fast-sw-div  -mfast-sw-div @gol
960 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
961 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
962 -mcustom-fpu-cfg=@var{name} @gol
963 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
964 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
966 @emph{Nvidia PTX Options}
967 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
969 @emph{PDP-11 Options}
970 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
971 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
972 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
973 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
974 -mbranch-expensive  -mbranch-cheap @gol
975 -munix-asm  -mdec-asm}
977 @emph{picoChip Options}
978 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
979 -msymbol-as-address  -mno-inefficient-warnings}
981 @emph{PowerPC Options}
982 See RS/6000 and PowerPC Options.
984 @emph{RISC-V Options}
985 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
986 -mplt  -mno-plt @gol
987 -mabi=@var{ABI-string} @gol
988 -mfdiv  -mno-fdiv @gol
989 -mdiv  -mno-div @gol
990 -march=@var{ISA-string} @gol
991 -mtune=@var{processor-string} @gol
992 -msmall-data-limit=@var{N-bytes} @gol
993 -msave-restore  -mno-save-restore @gol
994 -mstrict-align -mno-strict-align @gol
995 -mcmodel=medlow -mcmodel=medany @gol
996 -mexplicit-relocs  -mno-explicit-relocs @gol}
998 @emph{RL78 Options}
999 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
1000 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
1001 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1003 @emph{RS/6000 and PowerPC Options}
1004 @gccoptlist{-mcpu=@var{cpu-type} @gol
1005 -mtune=@var{cpu-type} @gol
1006 -mcmodel=@var{code-model} @gol
1007 -mpowerpc64 @gol
1008 -maltivec  -mno-altivec @gol
1009 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1010 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1011 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1012 -mfprnd  -mno-fprnd @gol
1013 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1014 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1015 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1016 -malign-power  -malign-natural @gol
1017 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1018 -msingle-float  -mdouble-float  -msimple-fpu @gol
1019 -mstring  -mno-string  -mupdate  -mno-update @gol
1020 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1021 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1022 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1023 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1024 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1025 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1026 -mprioritize-restricted-insns=@var{priority} @gol
1027 -msched-costly-dep=@var{dependence_type} @gol
1028 -minsert-sched-nops=@var{scheme} @gol
1029 -mcall-sysv  -mcall-netbsd @gol
1030 -maix-struct-return  -msvr4-struct-return @gol
1031 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1032 -mblock-move-inline-limit=@var{num} @gol
1033 -misel  -mno-isel @gol
1034 -misel=yes  -misel=no @gol
1035 -mspe  -mno-spe @gol
1036 -mspe=yes  -mspe=no @gol
1037 -mpaired @gol
1038 -mvrsave  -mno-vrsave @gol
1039 -mmulhw  -mno-mulhw @gol
1040 -mdlmzb  -mno-dlmzb @gol
1041 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1042 -mprototype  -mno-prototype @gol
1043 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1044 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1045 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1046 -mno-recip-precision @gol
1047 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1048 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1049 -msave-toc-indirect  -mno-save-toc-indirect @gol
1050 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1051 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1052 -mquad-memory  -mno-quad-memory @gol
1053 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1054 -mcompat-align-parm  -mno-compat-align-parm @gol
1055 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1056 -mgnu-attribute  -mno-gnu-attribute @gol
1057 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1058 -mstack-protector-guard-offset=@var{offset}}
1060 @emph{RX Options}
1061 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1062 -mcpu=@gol
1063 -mbig-endian-data  -mlittle-endian-data @gol
1064 -msmall-data @gol
1065 -msim  -mno-sim@gol
1066 -mas100-syntax  -mno-as100-syntax@gol
1067 -mrelax@gol
1068 -mmax-constant-size=@gol
1069 -mint-register=@gol
1070 -mpid@gol
1071 -mallow-string-insns  -mno-allow-string-insns@gol
1072 -mjsr@gol
1073 -mno-warn-multiple-fast-interrupts@gol
1074 -msave-acc-in-interrupts}
1076 @emph{S/390 and zSeries Options}
1077 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1078 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1079 -mlong-double-64  -mlong-double-128 @gol
1080 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1081 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1082 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1083 -mhtm  -mvx  -mzvector @gol
1084 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1085 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1086 -mhotpatch=@var{halfwords},@var{halfwords}}
1088 @emph{Score Options}
1089 @gccoptlist{-meb  -mel @gol
1090 -mnhwloop @gol
1091 -muls @gol
1092 -mmac @gol
1093 -mscore5  -mscore5u  -mscore7  -mscore7d}
1095 @emph{SH Options}
1096 @gccoptlist{-m1  -m2  -m2e @gol
1097 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1098 -m3  -m3e @gol
1099 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1100 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1101 -mb  -ml  -mdalign  -mrelax @gol
1102 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1103 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1104 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1105 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1106 -maccumulate-outgoing-args @gol
1107 -matomic-model=@var{atomic-model} @gol
1108 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1109 -mcbranch-force-delay-slot @gol
1110 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1111 -mpretend-cmove  -mtas}
1113 @emph{Solaris 2 Options}
1114 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1115 -pthreads}
1117 @emph{SPARC Options}
1118 @gccoptlist{-mcpu=@var{cpu-type} @gol
1119 -mtune=@var{cpu-type} @gol
1120 -mcmodel=@var{code-model} @gol
1121 -mmemory-model=@var{mem-model} @gol
1122 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1123 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1124 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1125 -mhard-quad-float  -msoft-quad-float @gol
1126 -mstack-bias  -mno-stack-bias @gol
1127 -mstd-struct-return  -mno-std-struct-return @gol
1128 -munaligned-doubles  -mno-unaligned-doubles @gol
1129 -muser-mode  -mno-user-mode @gol
1130 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1131 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1132 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1133 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1134 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1135 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1136 -mlra  -mno-lra}
1138 @emph{SPU Options}
1139 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1140 -msafe-dma  -munsafe-dma @gol
1141 -mbranch-hints @gol
1142 -msmall-mem  -mlarge-mem  -mstdmain @gol
1143 -mfixed-range=@var{register-range} @gol
1144 -mea32  -mea64 @gol
1145 -maddress-space-conversion  -mno-address-space-conversion @gol
1146 -mcache-size=@var{cache-size} @gol
1147 -matomic-updates  -mno-atomic-updates}
1149 @emph{System V Options}
1150 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1152 @emph{TILE-Gx Options}
1153 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1154 -mcmodel=@var{code-model}}
1156 @emph{TILEPro Options}
1157 @gccoptlist{-mcpu=@var{cpu}  -m32}
1159 @emph{V850 Options}
1160 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1161 -mprolog-function  -mno-prolog-function  -mspace @gol
1162 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1163 -mapp-regs  -mno-app-regs @gol
1164 -mdisable-callt  -mno-disable-callt @gol
1165 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1166 -mv850e  -mv850  -mv850e3v5 @gol
1167 -mloop @gol
1168 -mrelax @gol
1169 -mlong-jumps @gol
1170 -msoft-float @gol
1171 -mhard-float @gol
1172 -mgcc-abi @gol
1173 -mrh850-abi @gol
1174 -mbig-switch}
1176 @emph{VAX Options}
1177 @gccoptlist{-mg  -mgnu  -munix}
1179 @emph{Visium Options}
1180 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1181 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1183 @emph{VMS Options}
1184 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1185 -mpointer-size=@var{size}}
1187 @emph{VxWorks Options}
1188 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1189 -Xbind-lazy  -Xbind-now}
1191 @emph{x86 Options}
1192 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1193 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1194 -mfpmath=@var{unit} @gol
1195 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1196 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1197 -mno-wide-multiply  -mrtd  -malign-double @gol
1198 -mpreferred-stack-boundary=@var{num} @gol
1199 -mincoming-stack-boundary=@var{num} @gol
1200 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1201 -mrecip  -mrecip=@var{opt} @gol
1202 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1203 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1204 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1205 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1206 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1207 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1208 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1209 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1210 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni  -mvaes  @gol
1211 -mcet -mibt -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1212 -mvpclmulqdq -mavx512bitalg -mavx512vpopcntdq @gol
1213 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1214 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1215 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1216 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1217 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1218 -mregparm=@var{num}  -msseregparm @gol
1219 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1220 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1221 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1222 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1223 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1224 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1225 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1226 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1227 -mstack-protector-guard-reg=@var{reg} @gol
1228 -mstack-protector-guard-offset=@var{offset} @gol
1229 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1230 -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1232 @emph{x86 Windows Options}
1233 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1234 -mnop-fun-dllimport  -mthread @gol
1235 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1237 @emph{Xstormy16 Options}
1238 @gccoptlist{-msim}
1240 @emph{Xtensa Options}
1241 @gccoptlist{-mconst16  -mno-const16 @gol
1242 -mfused-madd  -mno-fused-madd @gol
1243 -mforce-no-pic @gol
1244 -mserialize-volatile  -mno-serialize-volatile @gol
1245 -mtext-section-literals  -mno-text-section-literals @gol
1246 -mauto-litpools  -mno-auto-litpools @gol
1247 -mtarget-align  -mno-target-align @gol
1248 -mlongcalls  -mno-longcalls}
1250 @emph{zSeries Options}
1251 See S/390 and zSeries Options.
1252 @end table
1255 @node Overall Options
1256 @section Options Controlling the Kind of Output
1258 Compilation can involve up to four stages: preprocessing, compilation
1259 proper, assembly and linking, always in that order.  GCC is capable of
1260 preprocessing and compiling several files either into several
1261 assembler input files, or into one assembler input file; then each
1262 assembler input file produces an object file, and linking combines all
1263 the object files (those newly compiled, and those specified as input)
1264 into an executable file.
1266 @cindex file name suffix
1267 For any given input file, the file name suffix determines what kind of
1268 compilation is done:
1270 @table @gcctabopt
1271 @item @var{file}.c
1272 C source code that must be preprocessed.
1274 @item @var{file}.i
1275 C source code that should not be preprocessed.
1277 @item @var{file}.ii
1278 C++ source code that should not be preprocessed.
1280 @item @var{file}.m
1281 Objective-C source code.  Note that you must link with the @file{libobjc}
1282 library to make an Objective-C program work.
1284 @item @var{file}.mi
1285 Objective-C source code that should not be preprocessed.
1287 @item @var{file}.mm
1288 @itemx @var{file}.M
1289 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1290 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1291 to a literal capital M@.
1293 @item @var{file}.mii
1294 Objective-C++ source code that should not be preprocessed.
1296 @item @var{file}.h
1297 C, C++, Objective-C or Objective-C++ header file to be turned into a
1298 precompiled header (default), or C, C++ header file to be turned into an
1299 Ada spec (via the @option{-fdump-ada-spec} switch).
1301 @item @var{file}.cc
1302 @itemx @var{file}.cp
1303 @itemx @var{file}.cxx
1304 @itemx @var{file}.cpp
1305 @itemx @var{file}.CPP
1306 @itemx @var{file}.c++
1307 @itemx @var{file}.C
1308 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1309 the last two letters must both be literally @samp{x}.  Likewise,
1310 @samp{.C} refers to a literal capital C@.
1312 @item @var{file}.mm
1313 @itemx @var{file}.M
1314 Objective-C++ source code that must be preprocessed.
1316 @item @var{file}.mii
1317 Objective-C++ source code that should not be preprocessed.
1319 @item @var{file}.hh
1320 @itemx @var{file}.H
1321 @itemx @var{file}.hp
1322 @itemx @var{file}.hxx
1323 @itemx @var{file}.hpp
1324 @itemx @var{file}.HPP
1325 @itemx @var{file}.h++
1326 @itemx @var{file}.tcc
1327 C++ header file to be turned into a precompiled header or Ada spec.
1329 @item @var{file}.f
1330 @itemx @var{file}.for
1331 @itemx @var{file}.ftn
1332 Fixed form Fortran source code that should not be preprocessed.
1334 @item @var{file}.F
1335 @itemx @var{file}.FOR
1336 @itemx @var{file}.fpp
1337 @itemx @var{file}.FPP
1338 @itemx @var{file}.FTN
1339 Fixed form Fortran source code that must be preprocessed (with the traditional
1340 preprocessor).
1342 @item @var{file}.f90
1343 @itemx @var{file}.f95
1344 @itemx @var{file}.f03
1345 @itemx @var{file}.f08
1346 Free form Fortran source code that should not be preprocessed.
1348 @item @var{file}.F90
1349 @itemx @var{file}.F95
1350 @itemx @var{file}.F03
1351 @itemx @var{file}.F08
1352 Free form Fortran source code that must be preprocessed (with the
1353 traditional preprocessor).
1355 @item @var{file}.go
1356 Go source code.
1358 @item @var{file}.brig
1359 BRIG files (binary representation of HSAIL).
1361 @item @var{file}.ads
1362 Ada source code file that contains a library unit declaration (a
1363 declaration of a package, subprogram, or generic, or a generic
1364 instantiation), or a library unit renaming declaration (a package,
1365 generic, or subprogram renaming declaration).  Such files are also
1366 called @dfn{specs}.
1368 @item @var{file}.adb
1369 Ada source code file containing a library unit body (a subprogram or
1370 package body).  Such files are also called @dfn{bodies}.
1372 @c GCC also knows about some suffixes for languages not yet included:
1373 @c Pascal:
1374 @c @var{file}.p
1375 @c @var{file}.pas
1376 @c Ratfor:
1377 @c @var{file}.r
1379 @item @var{file}.s
1380 Assembler code.
1382 @item @var{file}.S
1383 @itemx @var{file}.sx
1384 Assembler code that must be preprocessed.
1386 @item @var{other}
1387 An object file to be fed straight into linking.
1388 Any file name with no recognized suffix is treated this way.
1389 @end table
1391 @opindex x
1392 You can specify the input language explicitly with the @option{-x} option:
1394 @table @gcctabopt
1395 @item -x @var{language}
1396 Specify explicitly the @var{language} for the following input files
1397 (rather than letting the compiler choose a default based on the file
1398 name suffix).  This option applies to all following input files until
1399 the next @option{-x} option.  Possible values for @var{language} are:
1400 @smallexample
1401 c  c-header  cpp-output
1402 c++  c++-header  c++-cpp-output
1403 objective-c  objective-c-header  objective-c-cpp-output
1404 objective-c++ objective-c++-header objective-c++-cpp-output
1405 assembler  assembler-with-cpp
1407 f77  f77-cpp-input f95  f95-cpp-input
1409 brig
1410 @end smallexample
1412 @item -x none
1413 Turn off any specification of a language, so that subsequent files are
1414 handled according to their file name suffixes (as they are if @option{-x}
1415 has not been used at all).
1416 @end table
1418 If you only want some of the stages of compilation, you can use
1419 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1420 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1421 @command{gcc} is to stop.  Note that some combinations (for example,
1422 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1424 @table @gcctabopt
1425 @item -c
1426 @opindex c
1427 Compile or assemble the source files, but do not link.  The linking
1428 stage simply is not done.  The ultimate output is in the form of an
1429 object file for each source file.
1431 By default, the object file name for a source file is made by replacing
1432 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1434 Unrecognized input files, not requiring compilation or assembly, are
1435 ignored.
1437 @item -S
1438 @opindex S
1439 Stop after the stage of compilation proper; do not assemble.  The output
1440 is in the form of an assembler code file for each non-assembler input
1441 file specified.
1443 By default, the assembler file name for a source file is made by
1444 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1446 Input files that don't require compilation are ignored.
1448 @item -E
1449 @opindex E
1450 Stop after the preprocessing stage; do not run the compiler proper.  The
1451 output is in the form of preprocessed source code, which is sent to the
1452 standard output.
1454 Input files that don't require preprocessing are ignored.
1456 @cindex output file option
1457 @item -o @var{file}
1458 @opindex o
1459 Place output in file @var{file}.  This applies to whatever
1460 sort of output is being produced, whether it be an executable file,
1461 an object file, an assembler file or preprocessed C code.
1463 If @option{-o} is not specified, the default is to put an executable
1464 file in @file{a.out}, the object file for
1465 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1466 assembler file in @file{@var{source}.s}, a precompiled header file in
1467 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1468 standard output.
1470 @item -v
1471 @opindex v
1472 Print (on standard error output) the commands executed to run the stages
1473 of compilation.  Also print the version number of the compiler driver
1474 program and of the preprocessor and the compiler proper.
1476 @item -###
1477 @opindex ###
1478 Like @option{-v} except the commands are not executed and arguments
1479 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1480 This is useful for shell scripts to capture the driver-generated command lines.
1482 @item --help
1483 @opindex help
1484 Print (on the standard output) a description of the command-line options
1485 understood by @command{gcc}.  If the @option{-v} option is also specified
1486 then @option{--help} is also passed on to the various processes
1487 invoked by @command{gcc}, so that they can display the command-line options
1488 they accept.  If the @option{-Wextra} option has also been specified
1489 (prior to the @option{--help} option), then command-line options that
1490 have no documentation associated with them are also displayed.
1492 @item --target-help
1493 @opindex target-help
1494 Print (on the standard output) a description of target-specific command-line
1495 options for each tool.  For some targets extra target-specific
1496 information may also be printed.
1498 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1499 Print (on the standard output) a description of the command-line
1500 options understood by the compiler that fit into all specified classes
1501 and qualifiers.  These are the supported classes:
1503 @table @asis
1504 @item @samp{optimizers}
1505 Display all of the optimization options supported by the
1506 compiler.
1508 @item @samp{warnings}
1509 Display all of the options controlling warning messages
1510 produced by the compiler.
1512 @item @samp{target}
1513 Display target-specific options.  Unlike the
1514 @option{--target-help} option however, target-specific options of the
1515 linker and assembler are not displayed.  This is because those
1516 tools do not currently support the extended @option{--help=} syntax.
1518 @item @samp{params}
1519 Display the values recognized by the @option{--param}
1520 option.
1522 @item @var{language}
1523 Display the options supported for @var{language}, where
1524 @var{language} is the name of one of the languages supported in this
1525 version of GCC@.
1527 @item @samp{common}
1528 Display the options that are common to all languages.
1529 @end table
1531 These are the supported qualifiers:
1533 @table @asis
1534 @item @samp{undocumented}
1535 Display only those options that are undocumented.
1537 @item @samp{joined}
1538 Display options taking an argument that appears after an equal
1539 sign in the same continuous piece of text, such as:
1540 @samp{--help=target}.
1542 @item @samp{separate}
1543 Display options taking an argument that appears as a separate word
1544 following the original option, such as: @samp{-o output-file}.
1545 @end table
1547 Thus for example to display all the undocumented target-specific
1548 switches supported by the compiler, use:
1550 @smallexample
1551 --help=target,undocumented
1552 @end smallexample
1554 The sense of a qualifier can be inverted by prefixing it with the
1555 @samp{^} character, so for example to display all binary warning
1556 options (i.e., ones that are either on or off and that do not take an
1557 argument) that have a description, use:
1559 @smallexample
1560 --help=warnings,^joined,^undocumented
1561 @end smallexample
1563 The argument to @option{--help=} should not consist solely of inverted
1564 qualifiers.
1566 Combining several classes is possible, although this usually
1567 restricts the output so much that there is nothing to display.  One
1568 case where it does work, however, is when one of the classes is
1569 @var{target}.  For example, to display all the target-specific
1570 optimization options, use:
1572 @smallexample
1573 --help=target,optimizers
1574 @end smallexample
1576 The @option{--help=} option can be repeated on the command line.  Each
1577 successive use displays its requested class of options, skipping
1578 those that have already been displayed.
1580 If the @option{-Q} option appears on the command line before the
1581 @option{--help=} option, then the descriptive text displayed by
1582 @option{--help=} is changed.  Instead of describing the displayed
1583 options, an indication is given as to whether the option is enabled,
1584 disabled or set to a specific value (assuming that the compiler
1585 knows this at the point where the @option{--help=} option is used).
1587 Here is a truncated example from the ARM port of @command{gcc}:
1589 @smallexample
1590   % gcc -Q -mabi=2 --help=target -c
1591   The following options are target specific:
1592   -mabi=                                2
1593   -mabort-on-noreturn                   [disabled]
1594   -mapcs                                [disabled]
1595 @end smallexample
1597 The output is sensitive to the effects of previous command-line
1598 options, so for example it is possible to find out which optimizations
1599 are enabled at @option{-O2} by using:
1601 @smallexample
1602 -Q -O2 --help=optimizers
1603 @end smallexample
1605 Alternatively you can discover which binary optimizations are enabled
1606 by @option{-O3} by using:
1608 @smallexample
1609 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1610 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1611 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1612 @end smallexample
1614 @item --version
1615 @opindex version
1616 Display the version number and copyrights of the invoked GCC@.
1618 @item -pass-exit-codes
1619 @opindex pass-exit-codes
1620 Normally the @command{gcc} program exits with the code of 1 if any
1621 phase of the compiler returns a non-success return code.  If you specify
1622 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1623 the numerically highest error produced by any phase returning an error
1624 indication.  The C, C++, and Fortran front ends return 4 if an internal
1625 compiler error is encountered.
1627 @item -pipe
1628 @opindex pipe
1629 Use pipes rather than temporary files for communication between the
1630 various stages of compilation.  This fails to work on some systems where
1631 the assembler is unable to read from a pipe; but the GNU assembler has
1632 no trouble.
1634 @item -specs=@var{file}
1635 @opindex specs
1636 Process @var{file} after the compiler reads in the standard @file{specs}
1637 file, in order to override the defaults which the @command{gcc} driver
1638 program uses when determining what switches to pass to @command{cc1},
1639 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1640 @option{-specs=@var{file}} can be specified on the command line, and they
1641 are processed in order, from left to right.  @xref{Spec Files}, for
1642 information about the format of the @var{file}.
1644 @item -wrapper
1645 @opindex wrapper
1646 Invoke all subcommands under a wrapper program.  The name of the
1647 wrapper program and its parameters are passed as a comma separated
1648 list.
1650 @smallexample
1651 gcc -c t.c -wrapper gdb,--args
1652 @end smallexample
1654 @noindent
1655 This invokes all subprograms of @command{gcc} under
1656 @samp{gdb --args}, thus the invocation of @command{cc1} is
1657 @samp{gdb --args cc1 @dots{}}.
1659 @item -fplugin=@var{name}.so
1660 @opindex fplugin
1661 Load the plugin code in file @var{name}.so, assumed to be a
1662 shared object to be dlopen'd by the compiler.  The base name of
1663 the shared object file is used to identify the plugin for the
1664 purposes of argument parsing (See
1665 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1666 Each plugin should define the callback functions specified in the
1667 Plugins API.
1669 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1670 @opindex fplugin-arg
1671 Define an argument called @var{key} with a value of @var{value}
1672 for the plugin called @var{name}.
1674 @item -fdump-ada-spec@r{[}-slim@r{]}
1675 @opindex fdump-ada-spec
1676 For C and C++ source and include files, generate corresponding Ada specs.
1677 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1678 GNAT User's Guide}, which provides detailed documentation on this feature.
1680 @item -fada-spec-parent=@var{unit}
1681 @opindex fada-spec-parent
1682 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1683 Ada specs as child units of parent @var{unit}.
1685 @item -fdump-go-spec=@var{file}
1686 @opindex fdump-go-spec
1687 For input files in any language, generate corresponding Go
1688 declarations in @var{file}.  This generates Go @code{const},
1689 @code{type}, @code{var}, and @code{func} declarations which may be a
1690 useful way to start writing a Go interface to code written in some
1691 other language.
1693 @include @value{srcdir}/../libiberty/at-file.texi
1694 @end table
1696 @node Invoking G++
1697 @section Compiling C++ Programs
1699 @cindex suffixes for C++ source
1700 @cindex C++ source file suffixes
1701 C++ source files conventionally use one of the suffixes @samp{.C},
1702 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1703 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1704 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1705 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1706 files with these names and compiles them as C++ programs even if you
1707 call the compiler the same way as for compiling C programs (usually
1708 with the name @command{gcc}).
1710 @findex g++
1711 @findex c++
1712 However, the use of @command{gcc} does not add the C++ library.
1713 @command{g++} is a program that calls GCC and automatically specifies linking
1714 against the C++ library.  It treats @samp{.c},
1715 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1716 files unless @option{-x} is used.  This program is also useful when
1717 precompiling a C header file with a @samp{.h} extension for use in C++
1718 compilations.  On many systems, @command{g++} is also installed with
1719 the name @command{c++}.
1721 @cindex invoking @command{g++}
1722 When you compile C++ programs, you may specify many of the same
1723 command-line options that you use for compiling programs in any
1724 language; or command-line options meaningful for C and related
1725 languages; or options that are meaningful only for C++ programs.
1726 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1727 explanations of options for languages related to C@.
1728 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1729 explanations of options that are meaningful only for C++ programs.
1731 @node C Dialect Options
1732 @section Options Controlling C Dialect
1733 @cindex dialect options
1734 @cindex language dialect options
1735 @cindex options, dialect
1737 The following options control the dialect of C (or languages derived
1738 from C, such as C++, Objective-C and Objective-C++) that the compiler
1739 accepts:
1741 @table @gcctabopt
1742 @cindex ANSI support
1743 @cindex ISO support
1744 @item -ansi
1745 @opindex ansi
1746 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1747 equivalent to @option{-std=c++98}.
1749 This turns off certain features of GCC that are incompatible with ISO
1750 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1751 such as the @code{asm} and @code{typeof} keywords, and
1752 predefined macros such as @code{unix} and @code{vax} that identify the
1753 type of system you are using.  It also enables the undesirable and
1754 rarely used ISO trigraph feature.  For the C compiler,
1755 it disables recognition of C++ style @samp{//} comments as well as
1756 the @code{inline} keyword.
1758 The alternate keywords @code{__asm__}, @code{__extension__},
1759 @code{__inline__} and @code{__typeof__} continue to work despite
1760 @option{-ansi}.  You would not want to use them in an ISO C program, of
1761 course, but it is useful to put them in header files that might be included
1762 in compilations done with @option{-ansi}.  Alternate predefined macros
1763 such as @code{__unix__} and @code{__vax__} are also available, with or
1764 without @option{-ansi}.
1766 The @option{-ansi} option does not cause non-ISO programs to be
1767 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1768 addition to @option{-ansi}.  @xref{Warning Options}.
1770 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1771 option is used.  Some header files may notice this macro and refrain
1772 from declaring certain functions or defining certain macros that the
1773 ISO standard doesn't call for; this is to avoid interfering with any
1774 programs that might use these names for other things.
1776 Functions that are normally built in but do not have semantics
1777 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1778 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1779 built-in functions provided by GCC}, for details of the functions
1780 affected.
1782 @item -std=
1783 @opindex std
1784 Determine the language standard. @xref{Standards,,Language Standards
1785 Supported by GCC}, for details of these standard versions.  This option
1786 is currently only supported when compiling C or C++.
1788 The compiler can accept several base standards, such as @samp{c90} or
1789 @samp{c++98}, and GNU dialects of those standards, such as
1790 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1791 compiler accepts all programs following that standard plus those
1792 using GNU extensions that do not contradict it.  For example,
1793 @option{-std=c90} turns off certain features of GCC that are
1794 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1795 keywords, but not other GNU extensions that do not have a meaning in
1796 ISO C90, such as omitting the middle term of a @code{?:}
1797 expression. On the other hand, when a GNU dialect of a standard is
1798 specified, all features supported by the compiler are enabled, even when
1799 those features change the meaning of the base standard.  As a result, some
1800 strict-conforming programs may be rejected.  The particular standard
1801 is used by @option{-Wpedantic} to identify which features are GNU
1802 extensions given that version of the standard. For example
1803 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1804 comments, while @option{-std=gnu99 -Wpedantic} does not.
1806 A value for this option must be provided; possible values are
1808 @table @samp
1809 @item c90
1810 @itemx c89
1811 @itemx iso9899:1990
1812 Support all ISO C90 programs (certain GNU extensions that conflict
1813 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1815 @item iso9899:199409
1816 ISO C90 as modified in amendment 1.
1818 @item c99
1819 @itemx c9x
1820 @itemx iso9899:1999
1821 @itemx iso9899:199x
1822 ISO C99.  This standard is substantially completely supported, modulo
1823 bugs and floating-point issues
1824 (mainly but not entirely relating to optional C99 features from
1825 Annexes F and G).  See
1826 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1827 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1829 @item c11
1830 @itemx c1x
1831 @itemx iso9899:2011
1832 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1833 substantially completely supported, modulo bugs, floating-point issues
1834 (mainly but not entirely relating to optional C11 features from
1835 Annexes F and G) and the optional Annexes K (Bounds-checking
1836 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1838 @item c17
1839 @itemx c18
1840 @itemx iso9899:2017
1841 @itemx iso9899:2018
1842 ISO C17, the 2017 revision of the ISO C standard (expected to be
1843 published in 2018).  This standard is
1844 same as C11 except for corrections of defects (all of which are also
1845 applied with @option{-std=c11}) and a new value of
1846 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1848 @item gnu90
1849 @itemx gnu89
1850 GNU dialect of ISO C90 (including some C99 features).
1852 @item gnu99
1853 @itemx gnu9x
1854 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1856 @item gnu11
1857 @itemx gnu1x
1858 GNU dialect of ISO C11.
1859 The name @samp{gnu1x} is deprecated.
1861 @item gnu17
1862 @itemx gnu18
1863 GNU dialect of ISO C17.  This is the default for C code.
1865 @item c++98
1866 @itemx c++03
1867 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1868 additional defect reports. Same as @option{-ansi} for C++ code.
1870 @item gnu++98
1871 @itemx gnu++03
1872 GNU dialect of @option{-std=c++98}.
1874 @item c++11
1875 @itemx c++0x
1876 The 2011 ISO C++ standard plus amendments.
1877 The name @samp{c++0x} is deprecated.
1879 @item gnu++11
1880 @itemx gnu++0x
1881 GNU dialect of @option{-std=c++11}.
1882 The name @samp{gnu++0x} is deprecated.
1884 @item c++14
1885 @itemx c++1y
1886 The 2014 ISO C++ standard plus amendments.
1887 The name @samp{c++1y} is deprecated.
1889 @item gnu++14
1890 @itemx gnu++1y
1891 GNU dialect of @option{-std=c++14}.
1892 This is the default for C++ code.
1893 The name @samp{gnu++1y} is deprecated.
1895 @item c++17
1896 @itemx c++1z
1897 The 2017 ISO C++ standard plus amendments.
1898 The name @samp{c++1z} is deprecated.
1900 @item gnu++17
1901 @itemx gnu++1z
1902 GNU dialect of @option{-std=c++17}.
1903 The name @samp{gnu++1z} is deprecated.
1905 @item c++2a
1906 The next revision of the ISO C++ standard, tentatively planned for
1907 2020.  Support is highly experimental, and will almost certainly
1908 change in incompatible ways in future releases.
1910 @item gnu++2a
1911 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1912 and will almost certainly change in incompatible ways in future
1913 releases.
1914 @end table
1916 @item -fgnu89-inline
1917 @opindex fgnu89-inline
1918 The option @option{-fgnu89-inline} tells GCC to use the traditional
1919 GNU semantics for @code{inline} functions when in C99 mode.
1920 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1921 Using this option is roughly equivalent to adding the
1922 @code{gnu_inline} function attribute to all inline functions
1923 (@pxref{Function Attributes}).
1925 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1926 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1927 specifies the default behavior).
1928 This option is not supported in @option{-std=c90} or
1929 @option{-std=gnu90} mode.
1931 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1932 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1933 in effect for @code{inline} functions.  @xref{Common Predefined
1934 Macros,,,cpp,The C Preprocessor}.
1936 @item -fpermitted-flt-eval-methods=@var{style}
1937 @opindex fpermitted-flt-eval-methods
1938 @opindex fpermitted-flt-eval-methods=c11
1939 @opindex fpermitted-flt-eval-methods=ts-18661-3
1940 ISO/IEC TS 18661-3 defines new permissible values for
1941 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1942 a semantic type that is an interchange or extended format should be
1943 evaluated to the precision and range of that type.  These new values are
1944 a superset of those permitted under C99/C11, which does not specify the
1945 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1946 conforming to C11 may not have been written expecting the possibility of
1947 the new values.
1949 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1950 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1951 or the extended set of values specified in ISO/IEC TS 18661-3.
1953 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1955 The default when in a standards compliant mode (@option{-std=c11} or similar)
1956 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1957 dialect (@option{-std=gnu11} or similar) is
1958 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1960 @item -aux-info @var{filename}
1961 @opindex aux-info
1962 Output to the given filename prototyped declarations for all functions
1963 declared and/or defined in a translation unit, including those in header
1964 files.  This option is silently ignored in any language other than C@.
1966 Besides declarations, the file indicates, in comments, the origin of
1967 each declaration (source file and line), whether the declaration was
1968 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1969 @samp{O} for old, respectively, in the first character after the line
1970 number and the colon), and whether it came from a declaration or a
1971 definition (@samp{C} or @samp{F}, respectively, in the following
1972 character).  In the case of function definitions, a K&R-style list of
1973 arguments followed by their declarations is also provided, inside
1974 comments, after the declaration.
1976 @item -fallow-parameterless-variadic-functions
1977 @opindex fallow-parameterless-variadic-functions
1978 Accept variadic functions without named parameters.
1980 Although it is possible to define such a function, this is not very
1981 useful as it is not possible to read the arguments.  This is only
1982 supported for C as this construct is allowed by C++.
1984 @item -fno-asm
1985 @opindex fno-asm
1986 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1987 keyword, so that code can use these words as identifiers.  You can use
1988 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1989 instead.  @option{-ansi} implies @option{-fno-asm}.
1991 In C++, this switch only affects the @code{typeof} keyword, since
1992 @code{asm} and @code{inline} are standard keywords.  You may want to
1993 use the @option{-fno-gnu-keywords} flag instead, which has the same
1994 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1995 switch only affects the @code{asm} and @code{typeof} keywords, since
1996 @code{inline} is a standard keyword in ISO C99.
1998 @item -fno-builtin
1999 @itemx -fno-builtin-@var{function}
2000 @opindex fno-builtin
2001 @cindex built-in functions
2002 Don't recognize built-in functions that do not begin with
2003 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2004 functions provided by GCC}, for details of the functions affected,
2005 including those which are not built-in functions when @option{-ansi} or
2006 @option{-std} options for strict ISO C conformance are used because they
2007 do not have an ISO standard meaning.
2009 GCC normally generates special code to handle certain built-in functions
2010 more efficiently; for instance, calls to @code{alloca} may become single
2011 instructions which adjust the stack directly, and calls to @code{memcpy}
2012 may become inline copy loops.  The resulting code is often both smaller
2013 and faster, but since the function calls no longer appear as such, you
2014 cannot set a breakpoint on those calls, nor can you change the behavior
2015 of the functions by linking with a different library.  In addition,
2016 when a function is recognized as a built-in function, GCC may use
2017 information about that function to warn about problems with calls to
2018 that function, or to generate more efficient code, even if the
2019 resulting code still contains calls to that function.  For example,
2020 warnings are given with @option{-Wformat} for bad calls to
2021 @code{printf} when @code{printf} is built in and @code{strlen} is
2022 known not to modify global memory.
2024 With the @option{-fno-builtin-@var{function}} option
2025 only the built-in function @var{function} is
2026 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2027 function is named that is not built-in in this version of GCC, this
2028 option is ignored.  There is no corresponding
2029 @option{-fbuiltin-@var{function}} option; if you wish to enable
2030 built-in functions selectively when using @option{-fno-builtin} or
2031 @option{-ffreestanding}, you may define macros such as:
2033 @smallexample
2034 #define abs(n)          __builtin_abs ((n))
2035 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2036 @end smallexample
2038 @item -fgimple
2039 @opindex fgimple
2041 Enable parsing of function definitions marked with @code{__GIMPLE}.
2042 This is an experimental feature that allows unit testing of GIMPLE
2043 passes.
2045 @item -fhosted
2046 @opindex fhosted
2047 @cindex hosted environment
2049 Assert that compilation targets a hosted environment.  This implies
2050 @option{-fbuiltin}.  A hosted environment is one in which the
2051 entire standard library is available, and in which @code{main} has a return
2052 type of @code{int}.  Examples are nearly everything except a kernel.
2053 This is equivalent to @option{-fno-freestanding}.
2055 @item -ffreestanding
2056 @opindex ffreestanding
2057 @cindex hosted environment
2059 Assert that compilation targets a freestanding environment.  This
2060 implies @option{-fno-builtin}.  A freestanding environment
2061 is one in which the standard library may not exist, and program startup may
2062 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2063 This is equivalent to @option{-fno-hosted}.
2065 @xref{Standards,,Language Standards Supported by GCC}, for details of
2066 freestanding and hosted environments.
2068 @item -fopenacc
2069 @opindex fopenacc
2070 @cindex OpenACC accelerator programming
2071 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2072 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2073 compiler generates accelerated code according to the OpenACC Application
2074 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2075 implies @option{-pthread}, and thus is only supported on targets that
2076 have support for @option{-pthread}.
2078 @item -fopenacc-dim=@var{geom}
2079 @opindex fopenacc-dim
2080 @cindex OpenACC accelerator programming
2081 Specify default compute dimensions for parallel offload regions that do
2082 not explicitly specify.  The @var{geom} value is a triple of
2083 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2084 can be omitted, to use a target-specific default value.
2086 @item -fopenmp
2087 @opindex fopenmp
2088 @cindex OpenMP parallel
2089 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2090 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2091 compiler generates parallel code according to the OpenMP Application
2092 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2093 implies @option{-pthread}, and thus is only supported on targets that
2094 have support for @option{-pthread}. @option{-fopenmp} implies
2095 @option{-fopenmp-simd}.
2097 @item -fopenmp-simd
2098 @opindex fopenmp-simd
2099 @cindex OpenMP SIMD
2100 @cindex SIMD
2101 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2102 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2103 are ignored.
2105 @item -fgnu-tm
2106 @opindex fgnu-tm
2107 When the option @option{-fgnu-tm} is specified, the compiler
2108 generates code for the Linux variant of Intel's current Transactional
2109 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2110 an experimental feature whose interface may change in future versions
2111 of GCC, as the official specification changes.  Please note that not
2112 all architectures are supported for this feature.
2114 For more information on GCC's support for transactional memory,
2115 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2116 Transactional Memory Library}.
2118 Note that the transactional memory feature is not supported with
2119 non-call exceptions (@option{-fnon-call-exceptions}).
2121 @item -fms-extensions
2122 @opindex fms-extensions
2123 Accept some non-standard constructs used in Microsoft header files.
2125 In C++ code, this allows member names in structures to be similar
2126 to previous types declarations.
2128 @smallexample
2129 typedef int UOW;
2130 struct ABC @{
2131   UOW UOW;
2133 @end smallexample
2135 Some cases of unnamed fields in structures and unions are only
2136 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2137 fields within structs/unions}, for details.
2139 Note that this option is off for all targets but x86 
2140 targets using ms-abi.
2142 @item -fplan9-extensions
2143 @opindex fplan9-extensions
2144 Accept some non-standard constructs used in Plan 9 code.
2146 This enables @option{-fms-extensions}, permits passing pointers to
2147 structures with anonymous fields to functions that expect pointers to
2148 elements of the type of the field, and permits referring to anonymous
2149 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2150 struct/union fields within structs/unions}, for details.  This is only
2151 supported for C, not C++.
2153 @item -fcond-mismatch
2154 @opindex fcond-mismatch
2155 Allow conditional expressions with mismatched types in the second and
2156 third arguments.  The value of such an expression is void.  This option
2157 is not supported for C++.
2159 @item -flax-vector-conversions
2160 @opindex flax-vector-conversions
2161 Allow implicit conversions between vectors with differing numbers of
2162 elements and/or incompatible element types.  This option should not be
2163 used for new code.
2165 @item -funsigned-char
2166 @opindex funsigned-char
2167 Let the type @code{char} be unsigned, like @code{unsigned char}.
2169 Each kind of machine has a default for what @code{char} should
2170 be.  It is either like @code{unsigned char} by default or like
2171 @code{signed char} by default.
2173 Ideally, a portable program should always use @code{signed char} or
2174 @code{unsigned char} when it depends on the signedness of an object.
2175 But many programs have been written to use plain @code{char} and
2176 expect it to be signed, or expect it to be unsigned, depending on the
2177 machines they were written for.  This option, and its inverse, let you
2178 make such a program work with the opposite default.
2180 The type @code{char} is always a distinct type from each of
2181 @code{signed char} or @code{unsigned char}, even though its behavior
2182 is always just like one of those two.
2184 @item -fsigned-char
2185 @opindex fsigned-char
2186 Let the type @code{char} be signed, like @code{signed char}.
2188 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2189 the negative form of @option{-funsigned-char}.  Likewise, the option
2190 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2192 @item -fsigned-bitfields
2193 @itemx -funsigned-bitfields
2194 @itemx -fno-signed-bitfields
2195 @itemx -fno-unsigned-bitfields
2196 @opindex fsigned-bitfields
2197 @opindex funsigned-bitfields
2198 @opindex fno-signed-bitfields
2199 @opindex fno-unsigned-bitfields
2200 These options control whether a bit-field is signed or unsigned, when the
2201 declaration does not use either @code{signed} or @code{unsigned}.  By
2202 default, such a bit-field is signed, because this is consistent: the
2203 basic integer types such as @code{int} are signed types.
2205 @item -fsso-struct=@var{endianness}
2206 @opindex fsso-struct
2207 Set the default scalar storage order of structures and unions to the
2208 specified endianness.  The accepted values are @samp{big-endian},
2209 @samp{little-endian} and @samp{native} for the native endianness of
2210 the target (the default).  This option is not supported for C++.
2212 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2213 code that is not binary compatible with code generated without it if the
2214 specified endianness is not the native endianness of the target.
2215 @end table
2217 @node C++ Dialect Options
2218 @section Options Controlling C++ Dialect
2220 @cindex compiler options, C++
2221 @cindex C++ options, command-line
2222 @cindex options, C++
2223 This section describes the command-line options that are only meaningful
2224 for C++ programs.  You can also use most of the GNU compiler options
2225 regardless of what language your program is in.  For example, you
2226 might compile a file @file{firstClass.C} like this:
2228 @smallexample
2229 g++ -g -fstrict-enums -O -c firstClass.C
2230 @end smallexample
2232 @noindent
2233 In this example, only @option{-fstrict-enums} is an option meant
2234 only for C++ programs; you can use the other options with any
2235 language supported by GCC@.
2237 Some options for compiling C programs, such as @option{-std}, are also
2238 relevant for C++ programs.
2239 @xref{C Dialect Options,,Options Controlling C Dialect}.
2241 Here is a list of options that are @emph{only} for compiling C++ programs:
2243 @table @gcctabopt
2245 @item -fabi-version=@var{n}
2246 @opindex fabi-version
2247 Use version @var{n} of the C++ ABI@.  The default is version 0.
2249 Version 0 refers to the version conforming most closely to
2250 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2251 will change in different versions of G++ as ABI bugs are fixed.
2253 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2255 Version 2 is the version of the C++ ABI that first appeared in G++
2256 3.4, and was the default through G++ 4.9.
2258 Version 3 corrects an error in mangling a constant address as a
2259 template argument.
2261 Version 4, which first appeared in G++ 4.5, implements a standard
2262 mangling for vector types.
2264 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2265 attribute const/volatile on function pointer types, decltype of a
2266 plain decl, and use of a function parameter in the declaration of
2267 another parameter.
2269 Version 6, which first appeared in G++ 4.7, corrects the promotion
2270 behavior of C++11 scoped enums and the mangling of template argument
2271 packs, const/static_cast, prefix ++ and --, and a class scope function
2272 used as a template argument.
2274 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2275 builtin type and corrects the mangling of lambdas in default argument
2276 scope.
2278 Version 8, which first appeared in G++ 4.9, corrects the substitution
2279 behavior of function types with function-cv-qualifiers.
2281 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2282 @code{nullptr_t}.
2284 Version 10, which first appeared in G++ 6.1, adds mangling of
2285 attributes that affect type identity, such as ia32 calling convention
2286 attributes (e.g. @samp{stdcall}).
2288 Version 11, which first appeared in G++ 7, corrects the mangling of
2289 sizeof... expressions and operator names.  For multiple entities with
2290 the same name within a function, that are declared in different scopes,
2291 the mangling now changes starting with the twelfth occurrence.  It also
2292 implies @option{-fnew-inheriting-ctors}.
2294 See also @option{-Wabi}.
2296 @item -fabi-compat-version=@var{n}
2297 @opindex fabi-compat-version
2298 On targets that support strong aliases, G++
2299 works around mangling changes by creating an alias with the correct
2300 mangled name when defining a symbol with an incorrect mangled name.
2301 This switch specifies which ABI version to use for the alias.
2303 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2304 compatibility).  If another ABI version is explicitly selected, this
2305 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2306 use @option{-fabi-compat-version=2}.
2308 If this option is not provided but @option{-Wabi=@var{n}} is, that
2309 version is used for compatibility aliases.  If this option is provided
2310 along with @option{-Wabi} (without the version), the version from this
2311 option is used for the warning.
2313 @item -fno-access-control
2314 @opindex fno-access-control
2315 Turn off all access checking.  This switch is mainly useful for working
2316 around bugs in the access control code.
2318 @item -faligned-new
2319 @opindex faligned-new
2320 Enable support for C++17 @code{new} of types that require more
2321 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2322 numeric argument such as @code{-faligned-new=32} can be used to
2323 specify how much alignment (in bytes) is provided by that function,
2324 but few users will need to override the default of
2325 @code{alignof(std::max_align_t)}.
2327 This flag is enabled by default for @option{-std=c++17}.
2329 @item -fcheck-new
2330 @opindex fcheck-new
2331 Check that the pointer returned by @code{operator new} is non-null
2332 before attempting to modify the storage allocated.  This check is
2333 normally unnecessary because the C++ standard specifies that
2334 @code{operator new} only returns @code{0} if it is declared
2335 @code{throw()}, in which case the compiler always checks the
2336 return value even without this option.  In all other cases, when
2337 @code{operator new} has a non-empty exception specification, memory
2338 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2339 @samp{new (nothrow)}.
2341 @item -fconcepts
2342 @opindex fconcepts
2343 Enable support for the C++ Extensions for Concepts Technical
2344 Specification, ISO 19217 (2015), which allows code like
2346 @smallexample
2347 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2348 template <Addable T> T add (T a, T b) @{ return a + b; @}
2349 @end smallexample
2351 @item -fconstexpr-depth=@var{n}
2352 @opindex fconstexpr-depth
2353 Set the maximum nested evaluation depth for C++11 constexpr functions
2354 to @var{n}.  A limit is needed to detect endless recursion during
2355 constant expression evaluation.  The minimum specified by the standard
2356 is 512.
2358 @item -fconstexpr-loop-limit=@var{n}
2359 @opindex fconstexpr-loop-limit
2360 Set the maximum number of iterations for a loop in C++14 constexpr functions
2361 to @var{n}.  A limit is needed to detect infinite loops during
2362 constant expression evaluation.  The default is 262144 (1<<18).
2364 @item -fdeduce-init-list
2365 @opindex fdeduce-init-list
2366 Enable deduction of a template type parameter as
2367 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2369 @smallexample
2370 template <class T> auto forward(T t) -> decltype (realfn (t))
2372   return realfn (t);
2375 void f()
2377   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2379 @end smallexample
2381 This deduction was implemented as a possible extension to the
2382 originally proposed semantics for the C++11 standard, but was not part
2383 of the final standard, so it is disabled by default.  This option is
2384 deprecated, and may be removed in a future version of G++.
2386 @item -ffriend-injection
2387 @opindex ffriend-injection
2388 Inject friend functions into the enclosing namespace, so that they are
2389 visible outside the scope of the class in which they are declared.
2390 Friend functions were documented to work this way in the old Annotated
2391 C++ Reference Manual.  
2392 However, in ISO C++ a friend function that is not declared
2393 in an enclosing scope can only be found using argument dependent
2394 lookup.  GCC defaults to the standard behavior.
2396 This option is for compatibility, and may be removed in a future
2397 release of G++.
2399 @item -fno-elide-constructors
2400 @opindex fno-elide-constructors
2401 The C++ standard allows an implementation to omit creating a temporary
2402 that is only used to initialize another object of the same type.
2403 Specifying this option disables that optimization, and forces G++ to
2404 call the copy constructor in all cases.  This option also causes G++
2405 to call trivial member functions which otherwise would be expanded inline.
2407 In C++17, the compiler is required to omit these temporaries, but this
2408 option still affects trivial member functions.
2410 @item -fno-enforce-eh-specs
2411 @opindex fno-enforce-eh-specs
2412 Don't generate code to check for violation of exception specifications
2413 at run time.  This option violates the C++ standard, but may be useful
2414 for reducing code size in production builds, much like defining
2415 @code{NDEBUG}.  This does not give user code permission to throw
2416 exceptions in violation of the exception specifications; the compiler
2417 still optimizes based on the specifications, so throwing an
2418 unexpected exception results in undefined behavior at run time.
2420 @item -fextern-tls-init
2421 @itemx -fno-extern-tls-init
2422 @opindex fextern-tls-init
2423 @opindex fno-extern-tls-init
2424 The C++11 and OpenMP standards allow @code{thread_local} and
2425 @code{threadprivate} variables to have dynamic (runtime)
2426 initialization.  To support this, any use of such a variable goes
2427 through a wrapper function that performs any necessary initialization.
2428 When the use and definition of the variable are in the same
2429 translation unit, this overhead can be optimized away, but when the
2430 use is in a different translation unit there is significant overhead
2431 even if the variable doesn't actually need dynamic initialization.  If
2432 the programmer can be sure that no use of the variable in a
2433 non-defining TU needs to trigger dynamic initialization (either
2434 because the variable is statically initialized, or a use of the
2435 variable in the defining TU will be executed before any uses in
2436 another TU), they can avoid this overhead with the
2437 @option{-fno-extern-tls-init} option.
2439 On targets that support symbol aliases, the default is
2440 @option{-fextern-tls-init}.  On targets that do not support symbol
2441 aliases, the default is @option{-fno-extern-tls-init}.
2443 @item -ffor-scope
2444 @itemx -fno-for-scope
2445 @opindex ffor-scope
2446 @opindex fno-for-scope
2447 If @option{-ffor-scope} is specified, the scope of variables declared in
2448 a @i{for-init-statement} is limited to the @code{for} loop itself,
2449 as specified by the C++ standard.
2450 If @option{-fno-for-scope} is specified, the scope of variables declared in
2451 a @i{for-init-statement} extends to the end of the enclosing scope,
2452 as was the case in old versions of G++, and other (traditional)
2453 implementations of C++.
2455 If neither flag is given, the default is to follow the standard,
2456 but to allow and give a warning for old-style code that would
2457 otherwise be invalid, or have different behavior.
2459 @item -fno-gnu-keywords
2460 @opindex fno-gnu-keywords
2461 Do not recognize @code{typeof} as a keyword, so that code can use this
2462 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2463 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2464 @option{-std=c++98}, @option{-std=c++11}, etc.
2466 @item -fno-implicit-templates
2467 @opindex fno-implicit-templates
2468 Never emit code for non-inline templates that are instantiated
2469 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2470 @xref{Template Instantiation}, for more information.
2472 @item -fno-implicit-inline-templates
2473 @opindex fno-implicit-inline-templates
2474 Don't emit code for implicit instantiations of inline templates, either.
2475 The default is to handle inlines differently so that compiles with and
2476 without optimization need the same set of explicit instantiations.
2478 @item -fno-implement-inlines
2479 @opindex fno-implement-inlines
2480 To save space, do not emit out-of-line copies of inline functions
2481 controlled by @code{#pragma implementation}.  This causes linker
2482 errors if these functions are not inlined everywhere they are called.
2484 @item -fms-extensions
2485 @opindex fms-extensions
2486 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2487 int and getting a pointer to member function via non-standard syntax.
2489 @item -fnew-inheriting-ctors
2490 @opindex fnew-inheriting-ctors
2491 Enable the P0136 adjustment to the semantics of C++11 constructor
2492 inheritance.  This is part of C++17 but also considered to be a Defect
2493 Report against C++11 and C++14.  This flag is enabled by default
2494 unless @option{-fabi-version=10} or lower is specified.
2496 @item -fnew-ttp-matching
2497 @opindex fnew-ttp-matching
2498 Enable the P0522 resolution to Core issue 150, template template
2499 parameters and default arguments: this allows a template with default
2500 template arguments as an argument for a template template parameter
2501 with fewer template parameters.  This flag is enabled by default for
2502 @option{-std=c++17}.
2504 @item -fno-nonansi-builtins
2505 @opindex fno-nonansi-builtins
2506 Disable built-in declarations of functions that are not mandated by
2507 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2508 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2510 @item -fnothrow-opt
2511 @opindex fnothrow-opt
2512 Treat a @code{throw()} exception specification as if it were a
2513 @code{noexcept} specification to reduce or eliminate the text size
2514 overhead relative to a function with no exception specification.  If
2515 the function has local variables of types with non-trivial
2516 destructors, the exception specification actually makes the
2517 function smaller because the EH cleanups for those variables can be
2518 optimized away.  The semantic effect is that an exception thrown out of
2519 a function with such an exception specification results in a call
2520 to @code{terminate} rather than @code{unexpected}.
2522 @item -fno-operator-names
2523 @opindex fno-operator-names
2524 Do not treat the operator name keywords @code{and}, @code{bitand},
2525 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2526 synonyms as keywords.
2528 @item -fno-optional-diags
2529 @opindex fno-optional-diags
2530 Disable diagnostics that the standard says a compiler does not need to
2531 issue.  Currently, the only such diagnostic issued by G++ is the one for
2532 a name having multiple meanings within a class.
2534 @item -fpermissive
2535 @opindex fpermissive
2536 Downgrade some diagnostics about nonconformant code from errors to
2537 warnings.  Thus, using @option{-fpermissive} allows some
2538 nonconforming code to compile.
2540 @item -fno-pretty-templates
2541 @opindex fno-pretty-templates
2542 When an error message refers to a specialization of a function
2543 template, the compiler normally prints the signature of the
2544 template followed by the template arguments and any typedefs or
2545 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2546 rather than @code{void f(int)}) so that it's clear which template is
2547 involved.  When an error message refers to a specialization of a class
2548 template, the compiler omits any template arguments that match
2549 the default template arguments for that template.  If either of these
2550 behaviors make it harder to understand the error message rather than
2551 easier, you can use @option{-fno-pretty-templates} to disable them.
2553 @item -frepo
2554 @opindex frepo
2555 Enable automatic template instantiation at link time.  This option also
2556 implies @option{-fno-implicit-templates}.  @xref{Template
2557 Instantiation}, for more information.
2559 @item -fno-rtti
2560 @opindex fno-rtti
2561 Disable generation of information about every class with virtual
2562 functions for use by the C++ run-time type identification features
2563 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2564 of the language, you can save some space by using this flag.  Note that
2565 exception handling uses the same information, but G++ generates it as
2566 needed. The @code{dynamic_cast} operator can still be used for casts that
2567 do not require run-time type information, i.e.@: casts to @code{void *} or to
2568 unambiguous base classes.
2570 @item -fsized-deallocation
2571 @opindex fsized-deallocation
2572 Enable the built-in global declarations
2573 @smallexample
2574 void operator delete (void *, std::size_t) noexcept;
2575 void operator delete[] (void *, std::size_t) noexcept;
2576 @end smallexample
2577 as introduced in C++14.  This is useful for user-defined replacement
2578 deallocation functions that, for example, use the size of the object
2579 to make deallocation faster.  Enabled by default under
2580 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2581 warns about places that might want to add a definition.
2583 @item -fstrict-enums
2584 @opindex fstrict-enums
2585 Allow the compiler to optimize using the assumption that a value of
2586 enumerated type can only be one of the values of the enumeration (as
2587 defined in the C++ standard; basically, a value that can be
2588 represented in the minimum number of bits needed to represent all the
2589 enumerators).  This assumption may not be valid if the program uses a
2590 cast to convert an arbitrary integer value to the enumerated type.
2592 @item -fstrong-eval-order
2593 @opindex fstrong-eval-order
2594 Evaluate member access, array subscripting, and shift expressions in
2595 left-to-right order, and evaluate assignment in right-to-left order,
2596 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2597 @option{-fstrong-eval-order=some} enables just the ordering of member
2598 access and shift expressions, and is the default without
2599 @option{-std=c++17}.
2601 @item -ftemplate-backtrace-limit=@var{n}
2602 @opindex ftemplate-backtrace-limit
2603 Set the maximum number of template instantiation notes for a single
2604 warning or error to @var{n}.  The default value is 10.
2606 @item -ftemplate-depth=@var{n}
2607 @opindex ftemplate-depth
2608 Set the maximum instantiation depth for template classes to @var{n}.
2609 A limit on the template instantiation depth is needed to detect
2610 endless recursions during template class instantiation.  ANSI/ISO C++
2611 conforming programs must not rely on a maximum depth greater than 17
2612 (changed to 1024 in C++11).  The default value is 900, as the compiler
2613 can run out of stack space before hitting 1024 in some situations.
2615 @item -fno-threadsafe-statics
2616 @opindex fno-threadsafe-statics
2617 Do not emit the extra code to use the routines specified in the C++
2618 ABI for thread-safe initialization of local statics.  You can use this
2619 option to reduce code size slightly in code that doesn't need to be
2620 thread-safe.
2622 @item -fuse-cxa-atexit
2623 @opindex fuse-cxa-atexit
2624 Register destructors for objects with static storage duration with the
2625 @code{__cxa_atexit} function rather than the @code{atexit} function.
2626 This option is required for fully standards-compliant handling of static
2627 destructors, but only works if your C library supports
2628 @code{__cxa_atexit}.
2630 @item -fno-use-cxa-get-exception-ptr
2631 @opindex fno-use-cxa-get-exception-ptr
2632 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2633 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2634 if the runtime routine is not available.
2636 @item -fvisibility-inlines-hidden
2637 @opindex fvisibility-inlines-hidden
2638 This switch declares that the user does not attempt to compare
2639 pointers to inline functions or methods where the addresses of the two functions
2640 are taken in different shared objects.
2642 The effect of this is that GCC may, effectively, mark inline methods with
2643 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2644 appear in the export table of a DSO and do not require a PLT indirection
2645 when used within the DSO@.  Enabling this option can have a dramatic effect
2646 on load and link times of a DSO as it massively reduces the size of the
2647 dynamic export table when the library makes heavy use of templates.
2649 The behavior of this switch is not quite the same as marking the
2650 methods as hidden directly, because it does not affect static variables
2651 local to the function or cause the compiler to deduce that
2652 the function is defined in only one shared object.
2654 You may mark a method as having a visibility explicitly to negate the
2655 effect of the switch for that method.  For example, if you do want to
2656 compare pointers to a particular inline method, you might mark it as
2657 having default visibility.  Marking the enclosing class with explicit
2658 visibility has no effect.
2660 Explicitly instantiated inline methods are unaffected by this option
2661 as their linkage might otherwise cross a shared library boundary.
2662 @xref{Template Instantiation}.
2664 @item -fvisibility-ms-compat
2665 @opindex fvisibility-ms-compat
2666 This flag attempts to use visibility settings to make GCC's C++
2667 linkage model compatible with that of Microsoft Visual Studio.
2669 The flag makes these changes to GCC's linkage model:
2671 @enumerate
2672 @item
2673 It sets the default visibility to @code{hidden}, like
2674 @option{-fvisibility=hidden}.
2676 @item
2677 Types, but not their members, are not hidden by default.
2679 @item
2680 The One Definition Rule is relaxed for types without explicit
2681 visibility specifications that are defined in more than one
2682 shared object: those declarations are permitted if they are
2683 permitted when this option is not used.
2684 @end enumerate
2686 In new code it is better to use @option{-fvisibility=hidden} and
2687 export those classes that are intended to be externally visible.
2688 Unfortunately it is possible for code to rely, perhaps accidentally,
2689 on the Visual Studio behavior.
2691 Among the consequences of these changes are that static data members
2692 of the same type with the same name but defined in different shared
2693 objects are different, so changing one does not change the other;
2694 and that pointers to function members defined in different shared
2695 objects may not compare equal.  When this flag is given, it is a
2696 violation of the ODR to define types with the same name differently.
2698 @item -fno-weak
2699 @opindex fno-weak
2700 Do not use weak symbol support, even if it is provided by the linker.
2701 By default, G++ uses weak symbols if they are available.  This
2702 option exists only for testing, and should not be used by end-users;
2703 it results in inferior code and has no benefits.  This option may
2704 be removed in a future release of G++.
2706 @item -nostdinc++
2707 @opindex nostdinc++
2708 Do not search for header files in the standard directories specific to
2709 C++, but do still search the other standard directories.  (This option
2710 is used when building the C++ library.)
2711 @end table
2713 In addition, these optimization, warning, and code generation options
2714 have meanings only for C++ programs:
2716 @table @gcctabopt
2717 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2718 @opindex Wabi
2719 @opindex Wno-abi
2720 Warn when G++ it generates code that is probably not compatible with
2721 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2722 ABI with each major release, normally @option{-Wabi} will warn only if
2723 there is a check added later in a release series for an ABI issue
2724 discovered since the initial release.  @option{-Wabi} will warn about
2725 more things if an older ABI version is selected (with
2726 @option{-fabi-version=@var{n}}).
2728 @option{-Wabi} can also be used with an explicit version number to
2729 warn about compatibility with a particular @option{-fabi-version}
2730 level, e.g. @option{-Wabi=2} to warn about changes relative to
2731 @option{-fabi-version=2}.
2733 If an explicit version number is provided and
2734 @option{-fabi-compat-version} is not specified, the version number
2735 from this option is used for compatibility aliases.  If no explicit
2736 version number is provided with this option, but
2737 @option{-fabi-compat-version} is specified, that version number is
2738 used for ABI warnings.
2740 Although an effort has been made to warn about
2741 all such cases, there are probably some cases that are not warned about,
2742 even though G++ is generating incompatible code.  There may also be
2743 cases where warnings are emitted even though the code that is generated
2744 is compatible.
2746 You should rewrite your code to avoid these warnings if you are
2747 concerned about the fact that code generated by G++ may not be binary
2748 compatible with code generated by other compilers.
2750 Known incompatibilities in @option{-fabi-version=2} (which was the
2751 default from GCC 3.4 to 4.9) include:
2753 @itemize @bullet
2755 @item
2756 A template with a non-type template parameter of reference type was
2757 mangled incorrectly:
2758 @smallexample
2759 extern int N;
2760 template <int &> struct S @{@};
2761 void n (S<N>) @{2@}
2762 @end smallexample
2764 This was fixed in @option{-fabi-version=3}.
2766 @item
2767 SIMD vector types declared using @code{__attribute ((vector_size))} were
2768 mangled in a non-standard way that does not allow for overloading of
2769 functions taking vectors of different sizes.
2771 The mangling was changed in @option{-fabi-version=4}.
2773 @item
2774 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2775 qualifiers, and @code{decltype} of a plain declaration was folded away.
2777 These mangling issues were fixed in @option{-fabi-version=5}.
2779 @item
2780 Scoped enumerators passed as arguments to a variadic function are
2781 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2782 On most targets this does not actually affect the parameter passing
2783 ABI, as there is no way to pass an argument smaller than @code{int}.
2785 Also, the ABI changed the mangling of template argument packs,
2786 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2787 a class scope function used as a template argument.
2789 These issues were corrected in @option{-fabi-version=6}.
2791 @item
2792 Lambdas in default argument scope were mangled incorrectly, and the
2793 ABI changed the mangling of @code{nullptr_t}.
2795 These issues were corrected in @option{-fabi-version=7}.
2797 @item
2798 When mangling a function type with function-cv-qualifiers, the
2799 un-qualified function type was incorrectly treated as a substitution
2800 candidate.
2802 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2804 @item
2805 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2806 unaligned accesses.  Note that this did not affect the ABI of a
2807 function with a @code{nullptr_t} parameter, as parameters have a
2808 minimum alignment.
2810 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2812 @item
2813 Target-specific attributes that affect the identity of a type, such as
2814 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2815 did not affect the mangled name, leading to name collisions when
2816 function pointers were used as template arguments.
2818 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2820 @end itemize
2822 It also warns about psABI-related changes.  The known psABI changes at this
2823 point include:
2825 @itemize @bullet
2827 @item
2828 For SysV/x86-64, unions with @code{long double} members are 
2829 passed in memory as specified in psABI.  For example:
2831 @smallexample
2832 union U @{
2833   long double ld;
2834   int i;
2836 @end smallexample
2838 @noindent
2839 @code{union U} is always passed in memory.
2841 @end itemize
2843 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2844 @opindex Wabi-tag
2845 @opindex -Wabi-tag
2846 Warn when a type with an ABI tag is used in a context that does not
2847 have that ABI tag.  See @ref{C++ Attributes} for more information
2848 about ABI tags.
2850 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2851 @opindex Wctor-dtor-privacy
2852 @opindex Wno-ctor-dtor-privacy
2853 Warn when a class seems unusable because all the constructors or
2854 destructors in that class are private, and it has neither friends nor
2855 public static member functions.  Also warn if there are no non-private
2856 methods, and there's at least one private member function that isn't
2857 a constructor or destructor.
2859 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2860 @opindex Wdelete-non-virtual-dtor
2861 @opindex Wno-delete-non-virtual-dtor
2862 Warn when @code{delete} is used to destroy an instance of a class that
2863 has virtual functions and non-virtual destructor. It is unsafe to delete
2864 an instance of a derived class through a pointer to a base class if the
2865 base class does not have a virtual destructor.  This warning is enabled
2866 by @option{-Wall}.
2868 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2869 @opindex Wliteral-suffix
2870 @opindex Wno-literal-suffix
2871 Warn when a string or character literal is followed by a ud-suffix which does
2872 not begin with an underscore.  As a conforming extension, GCC treats such
2873 suffixes as separate preprocessing tokens in order to maintain backwards
2874 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2875 For example:
2877 @smallexample
2878 #define __STDC_FORMAT_MACROS
2879 #include <inttypes.h>
2880 #include <stdio.h>
2882 int main() @{
2883   int64_t i64 = 123;
2884   printf("My int64: %" PRId64"\n", i64);
2886 @end smallexample
2888 In this case, @code{PRId64} is treated as a separate preprocessing token.
2890 Additionally, warn when a user-defined literal operator is declared with
2891 a literal suffix identifier that doesn't begin with an underscore. Literal
2892 suffix identifiers that don't begin with an underscore are reserved for
2893 future standardization.
2895 This warning is enabled by default.
2897 @item -Wlto-type-mismatch
2898 @opindex Wlto-type-mismatch
2899 @opindex Wno-lto-type-mismatch
2901 During the link-time optimization warn about type mismatches in
2902 global declarations from different compilation units.
2903 Requires @option{-flto} to be enabled.  Enabled by default.
2905 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2906 @opindex Wnarrowing
2907 @opindex Wno-narrowing
2908 For C++11 and later standards, narrowing conversions are diagnosed by default,
2909 as required by the standard.  A narrowing conversion from a constant produces
2910 an error, and a narrowing conversion from a non-constant produces a warning,
2911 but @option{-Wno-narrowing} suppresses the diagnostic.
2912 Note that this does not affect the meaning of well-formed code;
2913 narrowing conversions are still considered ill-formed in SFINAE contexts.
2915 With @option{-Wnarrowing} in C++98, warn when a narrowing
2916 conversion prohibited by C++11 occurs within
2917 @samp{@{ @}}, e.g.
2919 @smallexample
2920 int i = @{ 2.2 @}; // error: narrowing from double to int
2921 @end smallexample
2923 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2925 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2926 @opindex Wnoexcept
2927 @opindex Wno-noexcept
2928 Warn when a noexcept-expression evaluates to false because of a call
2929 to a function that does not have a non-throwing exception
2930 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2931 the compiler to never throw an exception.
2933 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2934 @opindex Wnoexcept-type
2935 @opindex Wno-noexcept-type
2936 Warn if the C++17 feature making @code{noexcept} part of a function
2937 type changes the mangled name of a symbol relative to C++14.  Enabled
2938 by @option{-Wabi} and @option{-Wc++17-compat}.
2940 As an example:
2942 @smallexample
2943 template <class T> void f(T t) @{ t(); @};
2944 void g() noexcept;
2945 void h() @{ f(g); @} 
2946 @end smallexample
2948 @noindent
2949 In C++14, @code{f} calls calls @code{f<void(*)()>}, but in
2950 C++17 it calls @code{f<void(*)()noexcept>}.
2952 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2953 @opindex Wclass-memaccess
2954 Warn when the destination of a call to a raw memory function such as
2955 @code{memset} or @code{memcpy} is an object of class type writing into which
2956 might bypass the class non-trivial or deleted constructor or copy assignment,
2957 violate const-correctness or encapsulation, or corrupt the virtual table.
2958 Modifying the representation of such objects may violate invariants maintained
2959 by member functions of the class.  For example, the call to @code{memset}
2960 below is undefined because it modifies a non-trivial class object and is,
2961 therefore, diagnosed.  The safe way to either initialize or clear the storage
2962 of objects of such types is by using the appropriate constructor or assignment
2963 operator, if one is available.
2964 @smallexample
2965 std::string str = "abc";
2966 memset (&str, 0, 3);
2967 @end smallexample
2968 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2970 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2971 @opindex Wnon-virtual-dtor
2972 @opindex Wno-non-virtual-dtor
2973 Warn when a class has virtual functions and an accessible non-virtual
2974 destructor itself or in an accessible polymorphic base class, in which
2975 case it is possible but unsafe to delete an instance of a derived
2976 class through a pointer to the class itself or base class.  This
2977 warning is automatically enabled if @option{-Weffc++} is specified.
2979 @item -Wregister @r{(C++ and Objective-C++ only)}
2980 @opindex Wregister
2981 @opindex Wno-register
2982 Warn on uses of the @code{register} storage class specifier, except
2983 when it is part of the GNU @ref{Explicit Register Variables} extension.
2984 The use of the @code{register} keyword as storage class specifier has
2985 been deprecated in C++11 and removed in C++17.
2986 Enabled by default with @option{-std=c++17}.
2988 @item -Wreorder @r{(C++ and Objective-C++ only)}
2989 @opindex Wreorder
2990 @opindex Wno-reorder
2991 @cindex reordering, warning
2992 @cindex warning for reordering of member initializers
2993 Warn when the order of member initializers given in the code does not
2994 match the order in which they must be executed.  For instance:
2996 @smallexample
2997 struct A @{
2998   int i;
2999   int j;
3000   A(): j (0), i (1) @{ @}
3002 @end smallexample
3004 @noindent
3005 The compiler rearranges the member initializers for @code{i}
3006 and @code{j} to match the declaration order of the members, emitting
3007 a warning to that effect.  This warning is enabled by @option{-Wall}.
3009 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3010 @opindex fext-numeric-literals
3011 @opindex fno-ext-numeric-literals
3012 Accept imaginary, fixed-point, or machine-defined
3013 literal number suffixes as GNU extensions.
3014 When this option is turned off these suffixes are treated
3015 as C++11 user-defined literal numeric suffixes.
3016 This is on by default for all pre-C++11 dialects and all GNU dialects:
3017 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3018 @option{-std=gnu++14}.
3019 This option is off by default
3020 for ISO C++11 onwards (@option{-std=c++11}, ...).
3021 @end table
3023 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3025 @table @gcctabopt
3026 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3027 @opindex Weffc++
3028 @opindex Wno-effc++
3029 Warn about violations of the following style guidelines from Scott Meyers'
3030 @cite{Effective C++} series of books:
3032 @itemize @bullet
3033 @item
3034 Define a copy constructor and an assignment operator for classes
3035 with dynamically-allocated memory.
3037 @item
3038 Prefer initialization to assignment in constructors.
3040 @item
3041 Have @code{operator=} return a reference to @code{*this}.
3043 @item
3044 Don't try to return a reference when you must return an object.
3046 @item
3047 Distinguish between prefix and postfix forms of increment and
3048 decrement operators.
3050 @item
3051 Never overload @code{&&}, @code{||}, or @code{,}.
3053 @end itemize
3055 This option also enables @option{-Wnon-virtual-dtor}, which is also
3056 one of the effective C++ recommendations.  However, the check is
3057 extended to warn about the lack of virtual destructor in accessible
3058 non-polymorphic bases classes too.
3060 When selecting this option, be aware that the standard library
3061 headers do not obey all of these guidelines; use @samp{grep -v}
3062 to filter out those warnings.
3064 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3065 @opindex Wstrict-null-sentinel
3066 @opindex Wno-strict-null-sentinel
3067 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3068 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3069 to @code{__null}.  Although it is a null pointer constant rather than a
3070 null pointer, it is guaranteed to be of the same size as a pointer.
3071 But this use is not portable across different compilers.
3073 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3074 @opindex Wno-non-template-friend
3075 @opindex Wnon-template-friend
3076 Disable warnings when non-template friend functions are declared
3077 within a template.  In very old versions of GCC that predate implementation
3078 of the ISO standard, declarations such as 
3079 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3080 could be interpreted as a particular specialization of a template
3081 function; the warning exists to diagnose compatibility problems, 
3082 and is enabled by default.
3084 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3085 @opindex Wold-style-cast
3086 @opindex Wno-old-style-cast
3087 Warn if an old-style (C-style) cast to a non-void type is used within
3088 a C++ program.  The new-style casts (@code{dynamic_cast},
3089 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3090 less vulnerable to unintended effects and much easier to search for.
3092 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3093 @opindex Woverloaded-virtual
3094 @opindex Wno-overloaded-virtual
3095 @cindex overloaded virtual function, warning
3096 @cindex warning for overloaded virtual function
3097 Warn when a function declaration hides virtual functions from a
3098 base class.  For example, in:
3100 @smallexample
3101 struct A @{
3102   virtual void f();
3105 struct B: public A @{
3106   void f(int);
3108 @end smallexample
3110 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3111 like:
3113 @smallexample
3114 B* b;
3115 b->f();
3116 @end smallexample
3118 @noindent
3119 fails to compile.
3121 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3122 @opindex Wno-pmf-conversions
3123 @opindex Wpmf-conversions
3124 Disable the diagnostic for converting a bound pointer to member function
3125 to a plain pointer.
3127 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3128 @opindex Wsign-promo
3129 @opindex Wno-sign-promo
3130 Warn when overload resolution chooses a promotion from unsigned or
3131 enumerated type to a signed type, over a conversion to an unsigned type of
3132 the same size.  Previous versions of G++ tried to preserve
3133 unsignedness, but the standard mandates the current behavior.
3135 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3136 @opindex Wtemplates
3137 Warn when a primary template declaration is encountered.  Some coding
3138 rules disallow templates, and this may be used to enforce that rule.
3139 The warning is inactive inside a system header file, such as the STL, so
3140 one can still use the STL.  One may also instantiate or specialize
3141 templates.
3143 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3144 @opindex Wmultiple-inheritance
3145 Warn when a class is defined with multiple direct base classes.  Some
3146 coding rules disallow multiple inheritance, and this may be used to
3147 enforce that rule.  The warning is inactive inside a system header file,
3148 such as the STL, so one can still use the STL.  One may also define
3149 classes that indirectly use multiple inheritance.
3151 @item -Wvirtual-inheritance
3152 @opindex Wvirtual-inheritance
3153 Warn when a class is defined with a virtual direct base class.  Some
3154 coding rules disallow multiple inheritance, and this may be used to
3155 enforce that rule.  The warning is inactive inside a system header file,
3156 such as the STL, so one can still use the STL.  One may also define
3157 classes that indirectly use virtual inheritance.
3159 @item -Wnamespaces
3160 @opindex Wnamespaces
3161 Warn when a namespace definition is opened.  Some coding rules disallow
3162 namespaces, and this may be used to enforce that rule.  The warning is
3163 inactive inside a system header file, such as the STL, so one can still
3164 use the STL.  One may also use using directives and qualified names.
3166 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3167 @opindex Wterminate
3168 @opindex Wno-terminate
3169 Disable the warning about a throw-expression that will immediately
3170 result in a call to @code{terminate}.
3171 @end table
3173 @node Objective-C and Objective-C++ Dialect Options
3174 @section Options Controlling Objective-C and Objective-C++ Dialects
3176 @cindex compiler options, Objective-C and Objective-C++
3177 @cindex Objective-C and Objective-C++ options, command-line
3178 @cindex options, Objective-C and Objective-C++
3179 (NOTE: This manual does not describe the Objective-C and Objective-C++
3180 languages themselves.  @xref{Standards,,Language Standards
3181 Supported by GCC}, for references.)
3183 This section describes the command-line options that are only meaningful
3184 for Objective-C and Objective-C++ programs.  You can also use most of
3185 the language-independent GNU compiler options.
3186 For example, you might compile a file @file{some_class.m} like this:
3188 @smallexample
3189 gcc -g -fgnu-runtime -O -c some_class.m
3190 @end smallexample
3192 @noindent
3193 In this example, @option{-fgnu-runtime} is an option meant only for
3194 Objective-C and Objective-C++ programs; you can use the other options with
3195 any language supported by GCC@.
3197 Note that since Objective-C is an extension of the C language, Objective-C
3198 compilations may also use options specific to the C front-end (e.g.,
3199 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3200 C++-specific options (e.g., @option{-Wabi}).
3202 Here is a list of options that are @emph{only} for compiling Objective-C
3203 and Objective-C++ programs:
3205 @table @gcctabopt
3206 @item -fconstant-string-class=@var{class-name}
3207 @opindex fconstant-string-class
3208 Use @var{class-name} as the name of the class to instantiate for each
3209 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3210 class name is @code{NXConstantString} if the GNU runtime is being used, and
3211 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3212 @option{-fconstant-cfstrings} option, if also present, overrides the
3213 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3214 to be laid out as constant CoreFoundation strings.
3216 @item -fgnu-runtime
3217 @opindex fgnu-runtime
3218 Generate object code compatible with the standard GNU Objective-C
3219 runtime.  This is the default for most types of systems.
3221 @item -fnext-runtime
3222 @opindex fnext-runtime
3223 Generate output compatible with the NeXT runtime.  This is the default
3224 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3225 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3226 used.
3228 @item -fno-nil-receivers
3229 @opindex fno-nil-receivers
3230 Assume that all Objective-C message dispatches (@code{[receiver
3231 message:arg]}) in this translation unit ensure that the receiver is
3232 not @code{nil}.  This allows for more efficient entry points in the
3233 runtime to be used.  This option is only available in conjunction with
3234 the NeXT runtime and ABI version 0 or 1.
3236 @item -fobjc-abi-version=@var{n}
3237 @opindex fobjc-abi-version
3238 Use version @var{n} of the Objective-C ABI for the selected runtime.
3239 This option is currently supported only for the NeXT runtime.  In that
3240 case, Version 0 is the traditional (32-bit) ABI without support for
3241 properties and other Objective-C 2.0 additions.  Version 1 is the
3242 traditional (32-bit) ABI with support for properties and other
3243 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3244 nothing is specified, the default is Version 0 on 32-bit target
3245 machines, and Version 2 on 64-bit target machines.
3247 @item -fobjc-call-cxx-cdtors
3248 @opindex fobjc-call-cxx-cdtors
3249 For each Objective-C class, check if any of its instance variables is a
3250 C++ object with a non-trivial default constructor.  If so, synthesize a
3251 special @code{- (id) .cxx_construct} instance method which runs
3252 non-trivial default constructors on any such instance variables, in order,
3253 and then return @code{self}.  Similarly, check if any instance variable
3254 is a C++ object with a non-trivial destructor, and if so, synthesize a
3255 special @code{- (void) .cxx_destruct} method which runs
3256 all such default destructors, in reverse order.
3258 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3259 methods thusly generated only operate on instance variables
3260 declared in the current Objective-C class, and not those inherited
3261 from superclasses.  It is the responsibility of the Objective-C
3262 runtime to invoke all such methods in an object's inheritance
3263 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3264 by the runtime immediately after a new object instance is allocated;
3265 the @code{- (void) .cxx_destruct} methods are invoked immediately
3266 before the runtime deallocates an object instance.
3268 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3269 support for invoking the @code{- (id) .cxx_construct} and
3270 @code{- (void) .cxx_destruct} methods.
3272 @item -fobjc-direct-dispatch
3273 @opindex fobjc-direct-dispatch
3274 Allow fast jumps to the message dispatcher.  On Darwin this is
3275 accomplished via the comm page.
3277 @item -fobjc-exceptions
3278 @opindex fobjc-exceptions
3279 Enable syntactic support for structured exception handling in
3280 Objective-C, similar to what is offered by C++.  This option
3281 is required to use the Objective-C keywords @code{@@try},
3282 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3283 @code{@@synchronized}.  This option is available with both the GNU
3284 runtime and the NeXT runtime (but not available in conjunction with
3285 the NeXT runtime on Mac OS X 10.2 and earlier).
3287 @item -fobjc-gc
3288 @opindex fobjc-gc
3289 Enable garbage collection (GC) in Objective-C and Objective-C++
3290 programs.  This option is only available with the NeXT runtime; the
3291 GNU runtime has a different garbage collection implementation that
3292 does not require special compiler flags.
3294 @item -fobjc-nilcheck
3295 @opindex fobjc-nilcheck
3296 For the NeXT runtime with version 2 of the ABI, check for a nil
3297 receiver in method invocations before doing the actual method call.
3298 This is the default and can be disabled using
3299 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3300 checked for nil in this way no matter what this flag is set to.
3301 Currently this flag does nothing when the GNU runtime, or an older
3302 version of the NeXT runtime ABI, is used.
3304 @item -fobjc-std=objc1
3305 @opindex fobjc-std
3306 Conform to the language syntax of Objective-C 1.0, the language
3307 recognized by GCC 4.0.  This only affects the Objective-C additions to
3308 the C/C++ language; it does not affect conformance to C/C++ standards,
3309 which is controlled by the separate C/C++ dialect option flags.  When
3310 this option is used with the Objective-C or Objective-C++ compiler,
3311 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3312 This is useful if you need to make sure that your Objective-C code can
3313 be compiled with older versions of GCC@.
3315 @item -freplace-objc-classes
3316 @opindex freplace-objc-classes
3317 Emit a special marker instructing @command{ld(1)} not to statically link in
3318 the resulting object file, and allow @command{dyld(1)} to load it in at
3319 run time instead.  This is used in conjunction with the Fix-and-Continue
3320 debugging mode, where the object file in question may be recompiled and
3321 dynamically reloaded in the course of program execution, without the need
3322 to restart the program itself.  Currently, Fix-and-Continue functionality
3323 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3324 and later.
3326 @item -fzero-link
3327 @opindex fzero-link
3328 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3329 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3330 compile time) with static class references that get initialized at load time,
3331 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3332 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3333 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3334 for individual class implementations to be modified during program execution.
3335 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3336 regardless of command-line options.
3338 @item -fno-local-ivars
3339 @opindex fno-local-ivars
3340 @opindex flocal-ivars
3341 By default instance variables in Objective-C can be accessed as if
3342 they were local variables from within the methods of the class they're
3343 declared in.  This can lead to shadowing between instance variables
3344 and other variables declared either locally inside a class method or
3345 globally with the same name.  Specifying the @option{-fno-local-ivars}
3346 flag disables this behavior thus avoiding variable shadowing issues.
3348 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3349 @opindex fivar-visibility
3350 Set the default instance variable visibility to the specified option
3351 so that instance variables declared outside the scope of any access
3352 modifier directives default to the specified visibility.
3354 @item -gen-decls
3355 @opindex gen-decls
3356 Dump interface declarations for all classes seen in the source file to a
3357 file named @file{@var{sourcename}.decl}.
3359 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3360 @opindex Wassign-intercept
3361 @opindex Wno-assign-intercept
3362 Warn whenever an Objective-C assignment is being intercepted by the
3363 garbage collector.
3365 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3366 @opindex Wno-protocol
3367 @opindex Wprotocol
3368 If a class is declared to implement a protocol, a warning is issued for
3369 every method in the protocol that is not implemented by the class.  The
3370 default behavior is to issue a warning for every method not explicitly
3371 implemented in the class, even if a method implementation is inherited
3372 from the superclass.  If you use the @option{-Wno-protocol} option, then
3373 methods inherited from the superclass are considered to be implemented,
3374 and no warning is issued for them.
3376 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3377 @opindex Wselector
3378 @opindex Wno-selector
3379 Warn if multiple methods of different types for the same selector are
3380 found during compilation.  The check is performed on the list of methods
3381 in the final stage of compilation.  Additionally, a check is performed
3382 for each selector appearing in a @code{@@selector(@dots{})}
3383 expression, and a corresponding method for that selector has been found
3384 during compilation.  Because these checks scan the method table only at
3385 the end of compilation, these warnings are not produced if the final
3386 stage of compilation is not reached, for example because an error is
3387 found during compilation, or because the @option{-fsyntax-only} option is
3388 being used.
3390 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3391 @opindex Wstrict-selector-match
3392 @opindex Wno-strict-selector-match
3393 Warn if multiple methods with differing argument and/or return types are
3394 found for a given selector when attempting to send a message using this
3395 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3396 is off (which is the default behavior), the compiler omits such warnings
3397 if any differences found are confined to types that share the same size
3398 and alignment.
3400 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3401 @opindex Wundeclared-selector
3402 @opindex Wno-undeclared-selector
3403 Warn if a @code{@@selector(@dots{})} expression referring to an
3404 undeclared selector is found.  A selector is considered undeclared if no
3405 method with that name has been declared before the
3406 @code{@@selector(@dots{})} expression, either explicitly in an
3407 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3408 an @code{@@implementation} section.  This option always performs its
3409 checks as soon as a @code{@@selector(@dots{})} expression is found,
3410 while @option{-Wselector} only performs its checks in the final stage of
3411 compilation.  This also enforces the coding style convention
3412 that methods and selectors must be declared before being used.
3414 @item -print-objc-runtime-info
3415 @opindex print-objc-runtime-info
3416 Generate C header describing the largest structure that is passed by
3417 value, if any.
3419 @end table
3421 @node Diagnostic Message Formatting Options
3422 @section Options to Control Diagnostic Messages Formatting
3423 @cindex options to control diagnostics formatting
3424 @cindex diagnostic messages
3425 @cindex message formatting
3427 Traditionally, diagnostic messages have been formatted irrespective of
3428 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3429 options described below
3430 to control the formatting algorithm for diagnostic messages, 
3431 e.g.@: how many characters per line, how often source location
3432 information should be reported.  Note that some language front ends may not
3433 honor these options.
3435 @table @gcctabopt
3436 @item -fmessage-length=@var{n}
3437 @opindex fmessage-length
3438 Try to format error messages so that they fit on lines of about
3439 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3440 done; each error message appears on a single line.  This is the
3441 default for all front ends.
3443 @item -fdiagnostics-show-location=once
3444 @opindex fdiagnostics-show-location
3445 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3446 reporter to emit source location information @emph{once}; that is, in
3447 case the message is too long to fit on a single physical line and has to
3448 be wrapped, the source location won't be emitted (as prefix) again,
3449 over and over, in subsequent continuation lines.  This is the default
3450 behavior.
3452 @item -fdiagnostics-show-location=every-line
3453 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3454 messages reporter to emit the same source location information (as
3455 prefix) for physical lines that result from the process of breaking
3456 a message which is too long to fit on a single line.
3458 @item -fdiagnostics-color[=@var{WHEN}]
3459 @itemx -fno-diagnostics-color
3460 @opindex fdiagnostics-color
3461 @cindex highlight, color
3462 @vindex GCC_COLORS @r{environment variable}
3463 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3464 or @samp{auto}.  The default depends on how the compiler has been configured,
3465 it can be any of the above @var{WHEN} options or also @samp{never}
3466 if @env{GCC_COLORS} environment variable isn't present in the environment,
3467 and @samp{auto} otherwise.
3468 @samp{auto} means to use color only when the standard error is a terminal.
3469 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3470 aliases for @option{-fdiagnostics-color=always} and
3471 @option{-fdiagnostics-color=never}, respectively.
3473 The colors are defined by the environment variable @env{GCC_COLORS}.
3474 Its value is a colon-separated list of capabilities and Select Graphic
3475 Rendition (SGR) substrings. SGR commands are interpreted by the
3476 terminal or terminal emulator.  (See the section in the documentation
3477 of your text terminal for permitted values and their meanings as
3478 character attributes.)  These substring values are integers in decimal
3479 representation and can be concatenated with semicolons.
3480 Common values to concatenate include
3481 @samp{1} for bold,
3482 @samp{4} for underline,
3483 @samp{5} for blink,
3484 @samp{7} for inverse,
3485 @samp{39} for default foreground color,
3486 @samp{30} to @samp{37} for foreground colors,
3487 @samp{90} to @samp{97} for 16-color mode foreground colors,
3488 @samp{38;5;0} to @samp{38;5;255}
3489 for 88-color and 256-color modes foreground colors,
3490 @samp{49} for default background color,
3491 @samp{40} to @samp{47} for background colors,
3492 @samp{100} to @samp{107} for 16-color mode background colors,
3493 and @samp{48;5;0} to @samp{48;5;255}
3494 for 88-color and 256-color modes background colors.
3496 The default @env{GCC_COLORS} is
3497 @smallexample
3498 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3499 quote=01:fixit-insert=32:fixit-delete=31:\
3500 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3501 type-diff=01;32
3502 @end smallexample
3503 @noindent
3504 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3505 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3506 @samp{01} is bold, and @samp{31} is red.
3507 Setting @env{GCC_COLORS} to the empty string disables colors.
3508 Supported capabilities are as follows.
3510 @table @code
3511 @item error=
3512 @vindex error GCC_COLORS @r{capability}
3513 SGR substring for error: markers.
3515 @item warning=
3516 @vindex warning GCC_COLORS @r{capability}
3517 SGR substring for warning: markers.
3519 @item note=
3520 @vindex note GCC_COLORS @r{capability}
3521 SGR substring for note: markers.
3523 @item range1=
3524 @vindex range1 GCC_COLORS @r{capability}
3525 SGR substring for first additional range.
3527 @item range2=
3528 @vindex range2 GCC_COLORS @r{capability}
3529 SGR substring for second additional range.
3531 @item locus=
3532 @vindex locus GCC_COLORS @r{capability}
3533 SGR substring for location information, @samp{file:line} or
3534 @samp{file:line:column} etc.
3536 @item quote=
3537 @vindex quote GCC_COLORS @r{capability}
3538 SGR substring for information printed within quotes.
3540 @item fixit-insert=
3541 @vindex fixit-insert GCC_COLORS @r{capability}
3542 SGR substring for fix-it hints suggesting text to
3543 be inserted or replaced.
3545 @item fixit-delete=
3546 @vindex fixit-delete GCC_COLORS @r{capability}
3547 SGR substring for fix-it hints suggesting text to
3548 be deleted.
3550 @item diff-filename=
3551 @vindex diff-filename GCC_COLORS @r{capability}
3552 SGR substring for filename headers within generated patches.
3554 @item diff-hunk=
3555 @vindex diff-hunk GCC_COLORS @r{capability}
3556 SGR substring for the starts of hunks within generated patches.
3558 @item diff-delete=
3559 @vindex diff-delete GCC_COLORS @r{capability}
3560 SGR substring for deleted lines within generated patches.
3562 @item diff-insert=
3563 @vindex diff-insert GCC_COLORS @r{capability}
3564 SGR substring for inserted lines within generated patches.
3566 @item type-diff=
3567 @vindex type-diff GCC_COLORS @r{capability}
3568 SGR substring for highlighting mismatching types within template
3569 arguments in the C++ frontend.
3570 @end table
3572 @item -fno-diagnostics-show-option
3573 @opindex fno-diagnostics-show-option
3574 @opindex fdiagnostics-show-option
3575 By default, each diagnostic emitted includes text indicating the
3576 command-line option that directly controls the diagnostic (if such an
3577 option is known to the diagnostic machinery).  Specifying the
3578 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3580 @item -fno-diagnostics-show-caret
3581 @opindex fno-diagnostics-show-caret
3582 @opindex fdiagnostics-show-caret
3583 By default, each diagnostic emitted includes the original source line
3584 and a caret @samp{^} indicating the column.  This option suppresses this
3585 information.  The source line is truncated to @var{n} characters, if
3586 the @option{-fmessage-length=n} option is given.  When the output is done
3587 to the terminal, the width is limited to the width given by the
3588 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3590 @item -fdiagnostics-parseable-fixits
3591 @opindex fdiagnostics-parseable-fixits
3592 Emit fix-it hints in a machine-parseable format, suitable for consumption
3593 by IDEs.  For each fix-it, a line will be printed after the relevant
3594 diagnostic, starting with the string ``fix-it:''.  For example:
3596 @smallexample
3597 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3598 @end smallexample
3600 The location is expressed as a half-open range, expressed as a count of
3601 bytes, starting at byte 1 for the initial column.  In the above example,
3602 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3603 given string:
3605 @smallexample
3606 00000000011111111112222222222
3607 12345678901234567890123456789
3608   gtk_widget_showall (dlg);
3609   ^^^^^^^^^^^^^^^^^^
3610   gtk_widget_show_all
3611 @end smallexample
3613 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3614 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3615 (e.g. vertical tab as ``\013'').
3617 An empty replacement string indicates that the given range is to be removed.
3618 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3619 be inserted at the given position.
3621 @item -fdiagnostics-generate-patch
3622 @opindex fdiagnostics-generate-patch
3623 Print fix-it hints to stderr in unified diff format, after any diagnostics
3624 are printed.  For example:
3626 @smallexample
3627 --- test.c
3628 +++ test.c
3629 @@ -42,5 +42,5 @@
3631  void show_cb(GtkDialog *dlg)
3632  @{
3633 -  gtk_widget_showall(dlg);
3634 +  gtk_widget_show_all(dlg);
3635  @}
3637 @end smallexample
3639 The diff may or may not be colorized, following the same rules
3640 as for diagnostics (see @option{-fdiagnostics-color}).
3642 @item -fdiagnostics-show-template-tree
3643 @opindex fdiagnostics-show-template-tree
3645 In the C++ frontend, when printing diagnostics showing mismatching
3646 template types, such as:
3648 @smallexample
3649   could not convert 'std::map<int, std::vector<double> >()'
3650     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3651 @end smallexample
3653 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3654 tree-like structure showing the common and differing parts of the types,
3655 such as:
3657 @smallexample
3658   map<
3659     [...],
3660     vector<
3661       [double != float]>>
3662 @end smallexample
3664 The parts that differ are highlighted with color (``double'' and
3665 ``float'' in this case).
3667 @item -fno-elide-type
3668 @opindex fno-elide-type
3669 @opindex felide-type
3670 By default when the C++ frontend prints diagnostics showing mismatching
3671 template types, common parts of the types are printed as ``[...]'' to
3672 simplify the error message.  For example:
3674 @smallexample
3675   could not convert 'std::map<int, std::vector<double> >()'
3676     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3677 @end smallexample
3679 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3680 This flag also affects the output of the
3681 @option{-fdiagnostics-show-template-tree} flag.
3683 @item -fno-show-column
3684 @opindex fno-show-column
3685 Do not print column numbers in diagnostics.  This may be necessary if
3686 diagnostics are being scanned by a program that does not understand the
3687 column numbers, such as @command{dejagnu}.
3689 @end table
3691 @node Warning Options
3692 @section Options to Request or Suppress Warnings
3693 @cindex options to control warnings
3694 @cindex warning messages
3695 @cindex messages, warning
3696 @cindex suppressing warnings
3698 Warnings are diagnostic messages that report constructions that
3699 are not inherently erroneous but that are risky or suggest there
3700 may have been an error.
3702 The following language-independent options do not enable specific
3703 warnings but control the kinds of diagnostics produced by GCC@.
3705 @table @gcctabopt
3706 @cindex syntax checking
3707 @item -fsyntax-only
3708 @opindex fsyntax-only
3709 Check the code for syntax errors, but don't do anything beyond that.
3711 @item -fmax-errors=@var{n}
3712 @opindex fmax-errors
3713 Limits the maximum number of error messages to @var{n}, at which point
3714 GCC bails out rather than attempting to continue processing the source
3715 code.  If @var{n} is 0 (the default), there is no limit on the number
3716 of error messages produced.  If @option{-Wfatal-errors} is also
3717 specified, then @option{-Wfatal-errors} takes precedence over this
3718 option.
3720 @item -w
3721 @opindex w
3722 Inhibit all warning messages.
3724 @item -Werror
3725 @opindex Werror
3726 @opindex Wno-error
3727 Make all warnings into errors.
3729 @item -Werror=
3730 @opindex Werror=
3731 @opindex Wno-error=
3732 Make the specified warning into an error.  The specifier for a warning
3733 is appended; for example @option{-Werror=switch} turns the warnings
3734 controlled by @option{-Wswitch} into errors.  This switch takes a
3735 negative form, to be used to negate @option{-Werror} for specific
3736 warnings; for example @option{-Wno-error=switch} makes
3737 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3738 is in effect.
3740 The warning message for each controllable warning includes the
3741 option that controls the warning.  That option can then be used with
3742 @option{-Werror=} and @option{-Wno-error=} as described above.
3743 (Printing of the option in the warning message can be disabled using the
3744 @option{-fno-diagnostics-show-option} flag.)
3746 Note that specifying @option{-Werror=}@var{foo} automatically implies
3747 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3748 imply anything.
3750 @item -Wfatal-errors
3751 @opindex Wfatal-errors
3752 @opindex Wno-fatal-errors
3753 This option causes the compiler to abort compilation on the first error
3754 occurred rather than trying to keep going and printing further error
3755 messages.
3757 @end table
3759 You can request many specific warnings with options beginning with
3760 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3761 implicit declarations.  Each of these specific warning options also
3762 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3763 example, @option{-Wno-implicit}.  This manual lists only one of the
3764 two forms, whichever is not the default.  For further
3765 language-specific options also refer to @ref{C++ Dialect Options} and
3766 @ref{Objective-C and Objective-C++ Dialect Options}.
3768 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3769 options, such as @option{-Wunused}, which may turn on further options,
3770 such as @option{-Wunused-value}. The combined effect of positive and
3771 negative forms is that more specific options have priority over less
3772 specific ones, independently of their position in the command-line. For
3773 options of the same specificity, the last one takes effect. Options
3774 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3775 as if they appeared at the end of the command-line.
3777 When an unrecognized warning option is requested (e.g.,
3778 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3779 that the option is not recognized.  However, if the @option{-Wno-} form
3780 is used, the behavior is slightly different: no diagnostic is
3781 produced for @option{-Wno-unknown-warning} unless other diagnostics
3782 are being produced.  This allows the use of new @option{-Wno-} options
3783 with old compilers, but if something goes wrong, the compiler
3784 warns that an unrecognized option is present.
3786 @table @gcctabopt
3787 @item -Wpedantic
3788 @itemx -pedantic
3789 @opindex pedantic
3790 @opindex Wpedantic
3791 Issue all the warnings demanded by strict ISO C and ISO C++;
3792 reject all programs that use forbidden extensions, and some other
3793 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3794 version of the ISO C standard specified by any @option{-std} option used.
3796 Valid ISO C and ISO C++ programs should compile properly with or without
3797 this option (though a rare few require @option{-ansi} or a
3798 @option{-std} option specifying the required version of ISO C)@.  However,
3799 without this option, certain GNU extensions and traditional C and C++
3800 features are supported as well.  With this option, they are rejected.
3802 @option{-Wpedantic} does not cause warning messages for use of the
3803 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3804 warnings are also disabled in the expression that follows
3805 @code{__extension__}.  However, only system header files should use
3806 these escape routes; application programs should avoid them.
3807 @xref{Alternate Keywords}.
3809 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3810 C conformance.  They soon find that it does not do quite what they want:
3811 it finds some non-ISO practices, but not all---only those for which
3812 ISO C @emph{requires} a diagnostic, and some others for which
3813 diagnostics have been added.
3815 A feature to report any failure to conform to ISO C might be useful in
3816 some instances, but would require considerable additional work and would
3817 be quite different from @option{-Wpedantic}.  We don't have plans to
3818 support such a feature in the near future.
3820 Where the standard specified with @option{-std} represents a GNU
3821 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3822 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3823 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3824 where they are required by the base standard.  (It does not make sense
3825 for such warnings to be given only for features not in the specified GNU
3826 C dialect, since by definition the GNU dialects of C include all
3827 features the compiler supports with the given option, and there would be
3828 nothing to warn about.)
3830 @item -pedantic-errors
3831 @opindex pedantic-errors
3832 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3833 requires a diagnostic, in some cases where there is undefined behavior
3834 at compile-time and in some other cases that do not prevent compilation
3835 of programs that are valid according to the standard. This is not
3836 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3837 by this option and not enabled by the latter and vice versa.
3839 @item -Wall
3840 @opindex Wall
3841 @opindex Wno-all
3842 This enables all the warnings about constructions that some users
3843 consider questionable, and that are easy to avoid (or modify to
3844 prevent the warning), even in conjunction with macros.  This also
3845 enables some language-specific warnings described in @ref{C++ Dialect
3846 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3848 @option{-Wall} turns on the following warning flags:
3850 @gccoptlist{-Waddress   @gol
3851 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3852 -Wbool-compare  @gol
3853 -Wbool-operation  @gol
3854 -Wc++11-compat  -Wc++14-compat  @gol
3855 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3856 -Wchar-subscripts  @gol
3857 -Wcomment  @gol
3858 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3859 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3860 -Wformat   @gol
3861 -Wint-in-bool-context  @gol
3862 -Wimplicit @r{(C and Objective-C only)} @gol
3863 -Wimplicit-int @r{(C and Objective-C only)} @gol
3864 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3865 -Winit-self @r{(only for C++)} @gol
3866 -Wlogical-not-parentheses @gol
3867 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3868 -Wmaybe-uninitialized @gol
3869 -Wmemset-elt-size @gol
3870 -Wmemset-transposed-args @gol
3871 -Wmisleading-indentation @r{(only for C/C++)} @gol
3872 -Wmissing-braces @r{(only for C/ObjC)} @gol
3873 -Wmultistatement-macros  @gol
3874 -Wnarrowing @r{(only for C++)}  @gol
3875 -Wnonnull  @gol
3876 -Wnonnull-compare  @gol
3877 -Wopenmp-simd @gol
3878 -Wparentheses  @gol
3879 -Wpointer-sign  @gol
3880 -Wreorder   @gol
3881 -Wrestrict   @gol
3882 -Wreturn-type  @gol
3883 -Wsequence-point  @gol
3884 -Wsign-compare @r{(only in C++)}  @gol
3885 -Wsizeof-pointer-div @gol
3886 -Wsizeof-pointer-memaccess @gol
3887 -Wstrict-aliasing  @gol
3888 -Wstrict-overflow=1  @gol
3889 -Wswitch  @gol
3890 -Wtautological-compare  @gol
3891 -Wtrigraphs  @gol
3892 -Wuninitialized  @gol
3893 -Wunknown-pragmas  @gol
3894 -Wunused-function  @gol
3895 -Wunused-label     @gol
3896 -Wunused-value     @gol
3897 -Wunused-variable  @gol
3898 -Wvolatile-register-var @gol
3901 Note that some warning flags are not implied by @option{-Wall}.  Some of
3902 them warn about constructions that users generally do not consider
3903 questionable, but which occasionally you might wish to check for;
3904 others warn about constructions that are necessary or hard to avoid in
3905 some cases, and there is no simple way to modify the code to suppress
3906 the warning. Some of them are enabled by @option{-Wextra} but many of
3907 them must be enabled individually.
3909 @item -Wextra
3910 @opindex W
3911 @opindex Wextra
3912 @opindex Wno-extra
3913 This enables some extra warning flags that are not enabled by
3914 @option{-Wall}. (This option used to be called @option{-W}.  The older
3915 name is still supported, but the newer name is more descriptive.)
3917 @gccoptlist{-Wclobbered  @gol
3918 -Wcast-function-type  @gol
3919 -Wempty-body  @gol
3920 -Wignored-qualifiers @gol
3921 -Wimplicit-fallthrough=3 @gol
3922 -Wmissing-field-initializers  @gol
3923 -Wmissing-parameter-type @r{(C only)}  @gol
3924 -Wold-style-declaration @r{(C only)}  @gol
3925 -Woverride-init  @gol
3926 -Wsign-compare @r{(C only)} @gol
3927 -Wtype-limits  @gol
3928 -Wuninitialized  @gol
3929 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3930 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3931 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3934 The option @option{-Wextra} also prints warning messages for the
3935 following cases:
3937 @itemize @bullet
3939 @item
3940 A pointer is compared against integer zero with @code{<}, @code{<=},
3941 @code{>}, or @code{>=}.
3943 @item
3944 (C++ only) An enumerator and a non-enumerator both appear in a
3945 conditional expression.
3947 @item
3948 (C++ only) Ambiguous virtual bases.
3950 @item
3951 (C++ only) Subscripting an array that has been declared @code{register}.
3953 @item
3954 (C++ only) Taking the address of a variable that has been declared
3955 @code{register}.
3957 @item
3958 (C++ only) A base class is not initialized in the copy constructor
3959 of a derived class.
3961 @end itemize
3963 @item -Wchar-subscripts
3964 @opindex Wchar-subscripts
3965 @opindex Wno-char-subscripts
3966 Warn if an array subscript has type @code{char}.  This is a common cause
3967 of error, as programmers often forget that this type is signed on some
3968 machines.
3969 This warning is enabled by @option{-Wall}.
3971 @item -Wchkp
3972 @opindex Wchkp
3973 Warn about an invalid memory access that is found by Pointer Bounds Checker
3974 (@option{-fcheck-pointer-bounds}).
3976 @item -Wno-coverage-mismatch
3977 @opindex Wno-coverage-mismatch
3978 Warn if feedback profiles do not match when using the
3979 @option{-fprofile-use} option.
3980 If a source file is changed between compiling with @option{-fprofile-gen} and
3981 with @option{-fprofile-use}, the files with the profile feedback can fail
3982 to match the source file and GCC cannot use the profile feedback
3983 information.  By default, this warning is enabled and is treated as an
3984 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3985 warning or @option{-Wno-error=coverage-mismatch} can be used to
3986 disable the error.  Disabling the error for this warning can result in
3987 poorly optimized code and is useful only in the
3988 case of very minor changes such as bug fixes to an existing code-base.
3989 Completely disabling the warning is not recommended.
3991 @item -Wno-cpp
3992 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3994 Suppress warning messages emitted by @code{#warning} directives.
3996 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3997 @opindex Wdouble-promotion
3998 @opindex Wno-double-promotion
3999 Give a warning when a value of type @code{float} is implicitly
4000 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
4001 floating-point unit implement @code{float} in hardware, but emulate
4002 @code{double} in software.  On such a machine, doing computations
4003 using @code{double} values is much more expensive because of the
4004 overhead required for software emulation.
4006 It is easy to accidentally do computations with @code{double} because
4007 floating-point literals are implicitly of type @code{double}.  For
4008 example, in:
4009 @smallexample
4010 @group
4011 float area(float radius)
4013    return 3.14159 * radius * radius;
4015 @end group
4016 @end smallexample
4017 the compiler performs the entire computation with @code{double}
4018 because the floating-point literal is a @code{double}.
4020 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4021 @opindex Wduplicate-decl-specifier
4022 @opindex Wno-duplicate-decl-specifier
4023 Warn if a declaration has duplicate @code{const}, @code{volatile},
4024 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4025 @option{-Wall}.
4027 @item -Wformat
4028 @itemx -Wformat=@var{n}
4029 @opindex Wformat
4030 @opindex Wno-format
4031 @opindex ffreestanding
4032 @opindex fno-builtin
4033 @opindex Wformat=
4034 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4035 the arguments supplied have types appropriate to the format string
4036 specified, and that the conversions specified in the format string make
4037 sense.  This includes standard functions, and others specified by format
4038 attributes (@pxref{Function Attributes}), in the @code{printf},
4039 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4040 not in the C standard) families (or other target-specific families).
4041 Which functions are checked without format attributes having been
4042 specified depends on the standard version selected, and such checks of
4043 functions without the attribute specified are disabled by
4044 @option{-ffreestanding} or @option{-fno-builtin}.
4046 The formats are checked against the format features supported by GNU
4047 libc version 2.2.  These include all ISO C90 and C99 features, as well
4048 as features from the Single Unix Specification and some BSD and GNU
4049 extensions.  Other library implementations may not support all these
4050 features; GCC does not support warning about features that go beyond a
4051 particular library's limitations.  However, if @option{-Wpedantic} is used
4052 with @option{-Wformat}, warnings are given about format features not
4053 in the selected standard version (but not for @code{strfmon} formats,
4054 since those are not in any version of the C standard).  @xref{C Dialect
4055 Options,,Options Controlling C Dialect}.
4057 @table @gcctabopt
4058 @item -Wformat=1
4059 @itemx -Wformat
4060 @opindex Wformat
4061 @opindex Wformat=1
4062 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4063 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4064 @option{-Wformat} also checks for null format arguments for several
4065 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4066 aspects of this level of format checking can be disabled by the
4067 options: @option{-Wno-format-contains-nul},
4068 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4069 @option{-Wformat} is enabled by @option{-Wall}.
4071 @item -Wno-format-contains-nul
4072 @opindex Wno-format-contains-nul
4073 @opindex Wformat-contains-nul
4074 If @option{-Wformat} is specified, do not warn about format strings that
4075 contain NUL bytes.
4077 @item -Wno-format-extra-args
4078 @opindex Wno-format-extra-args
4079 @opindex Wformat-extra-args
4080 If @option{-Wformat} is specified, do not warn about excess arguments to a
4081 @code{printf} or @code{scanf} format function.  The C standard specifies
4082 that such arguments are ignored.
4084 Where the unused arguments lie between used arguments that are
4085 specified with @samp{$} operand number specifications, normally
4086 warnings are still given, since the implementation could not know what
4087 type to pass to @code{va_arg} to skip the unused arguments.  However,
4088 in the case of @code{scanf} formats, this option suppresses the
4089 warning if the unused arguments are all pointers, since the Single
4090 Unix Specification says that such unused arguments are allowed.
4092 @item -Wformat-overflow
4093 @itemx -Wformat-overflow=@var{level}
4094 @opindex Wformat-overflow
4095 @opindex Wno-format-overflow
4096 Warn about calls to formatted input/output functions such as @code{sprintf}
4097 and @code{vsprintf} that might overflow the destination buffer.  When the
4098 exact number of bytes written by a format directive cannot be determined
4099 at compile-time it is estimated based on heuristics that depend on the
4100 @var{level} argument and on optimization.  While enabling optimization
4101 will in most cases improve the accuracy of the warning, it may also
4102 result in false positives.
4104 @table @gcctabopt
4105 @item -Wformat-overflow
4106 @item -Wformat-overflow=1
4107 @opindex Wformat-overflow
4108 @opindex Wno-format-overflow
4109 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4110 employs a conservative approach that warns only about calls that most
4111 likely overflow the buffer.  At this level, numeric arguments to format
4112 directives with unknown values are assumed to have the value of one, and
4113 strings of unknown length to be empty.  Numeric arguments that are known
4114 to be bounded to a subrange of their type, or string arguments whose output
4115 is bounded either by their directive's precision or by a finite set of
4116 string literals, are assumed to take on the value within the range that
4117 results in the most bytes on output.  For example, the call to @code{sprintf}
4118 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4119 the terminating NUL character (@code{'\0'}) appended by the function
4120 to the destination buffer will be written past its end.  Increasing
4121 the size of the buffer by a single byte is sufficient to avoid the
4122 warning, though it may not be sufficient to avoid the overflow.
4124 @smallexample
4125 void f (int a, int b)
4127   char buf [12];
4128   sprintf (buf, "a = %i, b = %i\n", a, b);
4130 @end smallexample
4132 @item -Wformat-overflow=2
4133 Level @var{2} warns also about calls that might overflow the destination
4134 buffer given an argument of sufficient length or magnitude.  At level
4135 @var{2}, unknown numeric arguments are assumed to have the minimum
4136 representable value for signed types with a precision greater than 1, and
4137 the maximum representable value otherwise.  Unknown string arguments whose
4138 length cannot be assumed to be bounded either by the directive's precision,
4139 or by a finite set of string literals they may evaluate to, or the character
4140 array they may point to, are assumed to be 1 character long.
4142 At level @var{2}, the call in the example above is again diagnosed, but
4143 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4144 @code{%i} directive will write some of its digits beyond the end of
4145 the destination buffer.  To make the call safe regardless of the values
4146 of the two variables, the size of the destination buffer must be increased
4147 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4148 an informational note following the warning.
4150 An alternative to increasing the size of the destination buffer is to
4151 constrain the range of formatted values.  The maximum length of string
4152 arguments can be bounded by specifying the precision in the format
4153 directive.  When numeric arguments of format directives can be assumed
4154 to be bounded by less than the precision of their type, choosing
4155 an appropriate length modifier to the format specifier will reduce
4156 the required buffer size.  For example, if @var{a} and @var{b} in the
4157 example above can be assumed to be within the precision of
4158 the @code{short int} type then using either the @code{%hi} format
4159 directive or casting the argument to @code{short} reduces the maximum
4160 required size of the buffer to 24 bytes.
4162 @smallexample
4163 void f (int a, int b)
4165   char buf [23];
4166   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4168 @end smallexample
4169 @end table
4171 @item -Wno-format-zero-length
4172 @opindex Wno-format-zero-length
4173 @opindex Wformat-zero-length
4174 If @option{-Wformat} is specified, do not warn about zero-length formats.
4175 The C standard specifies that zero-length formats are allowed.
4178 @item -Wformat=2
4179 @opindex Wformat=2
4180 Enable @option{-Wformat} plus additional format checks.  Currently
4181 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4182 -Wformat-y2k}.
4184 @item -Wformat-nonliteral
4185 @opindex Wformat-nonliteral
4186 @opindex Wno-format-nonliteral
4187 If @option{-Wformat} is specified, also warn if the format string is not a
4188 string literal and so cannot be checked, unless the format function
4189 takes its format arguments as a @code{va_list}.
4191 @item -Wformat-security
4192 @opindex Wformat-security
4193 @opindex Wno-format-security
4194 If @option{-Wformat} is specified, also warn about uses of format
4195 functions that represent possible security problems.  At present, this
4196 warns about calls to @code{printf} and @code{scanf} functions where the
4197 format string is not a string literal and there are no format arguments,
4198 as in @code{printf (foo);}.  This may be a security hole if the format
4199 string came from untrusted input and contains @samp{%n}.  (This is
4200 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4201 in future warnings may be added to @option{-Wformat-security} that are not
4202 included in @option{-Wformat-nonliteral}.)
4204 @item -Wformat-signedness
4205 @opindex Wformat-signedness
4206 @opindex Wno-format-signedness
4207 If @option{-Wformat} is specified, also warn if the format string
4208 requires an unsigned argument and the argument is signed and vice versa.
4210 @item -Wformat-truncation
4211 @itemx -Wformat-truncation=@var{level}
4212 @opindex Wformat-truncation
4213 @opindex Wno-format-truncation
4214 Warn about calls to formatted input/output functions such as @code{snprintf}
4215 and @code{vsnprintf} that might result in output truncation.  When the exact
4216 number of bytes written by a format directive cannot be determined at
4217 compile-time it is estimated based on heuristics that depend on
4218 the @var{level} argument and on optimization.  While enabling optimization
4219 will in most cases improve the accuracy of the warning, it may also result
4220 in false positives.  Except as noted otherwise, the option uses the same
4221 logic @option{-Wformat-overflow}.
4223 @table @gcctabopt
4224 @item -Wformat-truncation
4225 @item -Wformat-truncation=1
4226 @opindex Wformat-truncation
4227 @opindex Wno-format-overflow
4228 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4229 employs a conservative approach that warns only about calls to bounded
4230 functions whose return value is unused and that will most likely result
4231 in output truncation.
4233 @item -Wformat-truncation=2
4234 Level @var{2} warns also about calls to bounded functions whose return
4235 value is used and that might result in truncation given an argument of
4236 sufficient length or magnitude.
4237 @end table
4239 @item -Wformat-y2k
4240 @opindex Wformat-y2k
4241 @opindex Wno-format-y2k
4242 If @option{-Wformat} is specified, also warn about @code{strftime}
4243 formats that may yield only a two-digit year.
4244 @end table
4246 @item -Wnonnull
4247 @opindex Wnonnull
4248 @opindex Wno-nonnull
4249 Warn about passing a null pointer for arguments marked as
4250 requiring a non-null value by the @code{nonnull} function attribute.
4252 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4253 can be disabled with the @option{-Wno-nonnull} option.
4255 @item -Wnonnull-compare
4256 @opindex Wnonnull-compare
4257 @opindex Wno-nonnull-compare
4258 Warn when comparing an argument marked with the @code{nonnull}
4259 function attribute against null inside the function.
4261 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4262 can be disabled with the @option{-Wno-nonnull-compare} option.
4264 @item -Wnull-dereference
4265 @opindex Wnull-dereference
4266 @opindex Wno-null-dereference
4267 Warn if the compiler detects paths that trigger erroneous or
4268 undefined behavior due to dereferencing a null pointer.  This option
4269 is only active when @option{-fdelete-null-pointer-checks} is active,
4270 which is enabled by optimizations in most targets.  The precision of
4271 the warnings depends on the optimization options used.
4273 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4274 @opindex Winit-self
4275 @opindex Wno-init-self
4276 Warn about uninitialized variables that are initialized with themselves.
4277 Note this option can only be used with the @option{-Wuninitialized} option.
4279 For example, GCC warns about @code{i} being uninitialized in the
4280 following snippet only when @option{-Winit-self} has been specified:
4281 @smallexample
4282 @group
4283 int f()
4285   int i = i;
4286   return i;
4288 @end group
4289 @end smallexample
4291 This warning is enabled by @option{-Wall} in C++.
4293 @item -Wimplicit-int @r{(C and Objective-C only)}
4294 @opindex Wimplicit-int
4295 @opindex Wno-implicit-int
4296 Warn when a declaration does not specify a type.
4297 This warning is enabled by @option{-Wall}.
4299 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4300 @opindex Wimplicit-function-declaration
4301 @opindex Wno-implicit-function-declaration
4302 Give a warning whenever a function is used before being declared. In
4303 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4304 enabled by default and it is made into an error by
4305 @option{-pedantic-errors}. This warning is also enabled by
4306 @option{-Wall}.
4308 @item -Wimplicit @r{(C and Objective-C only)}
4309 @opindex Wimplicit
4310 @opindex Wno-implicit
4311 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4312 This warning is enabled by @option{-Wall}.
4314 @item -Wimplicit-fallthrough
4315 @opindex Wimplicit-fallthrough
4316 @opindex Wno-implicit-fallthrough
4317 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4318 and @option{-Wno-implicit-fallthrough} is the same as
4319 @option{-Wimplicit-fallthrough=0}.
4321 @item -Wimplicit-fallthrough=@var{n}
4322 @opindex Wimplicit-fallthrough=
4323 Warn when a switch case falls through.  For example:
4325 @smallexample
4326 @group
4327 switch (cond)
4328   @{
4329   case 1:
4330     a = 1;
4331     break;
4332   case 2:
4333     a = 2;
4334   case 3:
4335     a = 3;
4336     break;
4337   @}
4338 @end group
4339 @end smallexample
4341 This warning does not warn when the last statement of a case cannot
4342 fall through, e.g. when there is a return statement or a call to function
4343 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4344 also takes into account control flow statements, such as ifs, and only
4345 warns when appropriate.  E.g.@:
4347 @smallexample
4348 @group
4349 switch (cond)
4350   @{
4351   case 1:
4352     if (i > 3) @{
4353       bar (5);
4354       break;
4355     @} else if (i < 1) @{
4356       bar (0);
4357     @} else
4358       return;
4359   default:
4360     @dots{}
4361   @}
4362 @end group
4363 @end smallexample
4365 Since there are occasions where a switch case fall through is desirable,
4366 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4367 to be used along with a null statement to suppress this warning that
4368 would normally occur:
4370 @smallexample
4371 @group
4372 switch (cond)
4373   @{
4374   case 1:
4375     bar (0);
4376     __attribute__ ((fallthrough));
4377   default:
4378     @dots{}
4379   @}
4380 @end group
4381 @end smallexample
4383 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4384 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4385 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4386 Instead of these attributes, it is also possible to add a fallthrough comment
4387 to silence the warning.  The whole body of the C or C++ style comment should
4388 match the given regular expressions listed below.  The option argument @var{n}
4389 specifies what kind of comments are accepted:
4391 @itemize @bullet
4393 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4395 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4396 expression, any comment is used as fallthrough comment.
4398 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4399 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4401 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4402 following regular expressions:
4404 @itemize @bullet
4406 @item @code{-fallthrough}
4408 @item @code{@@fallthrough@@}
4410 @item @code{lint -fallthrough[ \t]*}
4412 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4414 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4416 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4418 @end itemize
4420 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4421 following regular expressions:
4423 @itemize @bullet
4425 @item @code{-fallthrough}
4427 @item @code{@@fallthrough@@}
4429 @item @code{lint -fallthrough[ \t]*}
4431 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4433 @end itemize
4435 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4436 fallthrough comments, only attributes disable the warning.
4438 @end itemize
4440 The comment needs to be followed after optional whitespace and other comments
4441 by @code{case} or @code{default} keywords or by a user label that precedes some
4442 @code{case} or @code{default} label.
4444 @smallexample
4445 @group
4446 switch (cond)
4447   @{
4448   case 1:
4449     bar (0);
4450     /* FALLTHRU */
4451   default:
4452     @dots{}
4453   @}
4454 @end group
4455 @end smallexample
4457 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4459 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4460 @opindex Wif-not-aligned
4461 @opindex Wno-if-not-aligned
4462 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4463 should be issued.  This is is enabled by default.
4464 Use @option{-Wno-if-not-aligned} to disable it.
4466 @item -Wignored-qualifiers @r{(C and C++ only)}
4467 @opindex Wignored-qualifiers
4468 @opindex Wno-ignored-qualifiers
4469 Warn if the return type of a function has a type qualifier
4470 such as @code{const}.  For ISO C such a type qualifier has no effect,
4471 since the value returned by a function is not an lvalue.
4472 For C++, the warning is only emitted for scalar types or @code{void}.
4473 ISO C prohibits qualified @code{void} return types on function
4474 definitions, so such return types always receive a warning
4475 even without this option.
4477 This warning is also enabled by @option{-Wextra}.
4479 @item -Wignored-attributes @r{(C and C++ only)}
4480 @opindex Wignored-attributes
4481 @opindex Wno-ignored-attributes
4482 Warn when an attribute is ignored.  This is different from the
4483 @option{-Wattributes} option in that it warns whenever the compiler decides
4484 to drop an attribute, not that the attribute is either unknown, used in a
4485 wrong place, etc.  This warning is enabled by default.
4487 @item -Wmain
4488 @opindex Wmain
4489 @opindex Wno-main
4490 Warn if the type of @code{main} is suspicious.  @code{main} should be
4491 a function with external linkage, returning int, taking either zero
4492 arguments, two, or three arguments of appropriate types.  This warning
4493 is enabled by default in C++ and is enabled by either @option{-Wall}
4494 or @option{-Wpedantic}.
4496 @item -Wmisleading-indentation @r{(C and C++ only)}
4497 @opindex Wmisleading-indentation
4498 @opindex Wno-misleading-indentation
4499 Warn when the indentation of the code does not reflect the block structure.
4500 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4501 @code{for} clauses with a guarded statement that does not use braces,
4502 followed by an unguarded statement with the same indentation.
4504 In the following example, the call to ``bar'' is misleadingly indented as
4505 if it were guarded by the ``if'' conditional.
4507 @smallexample
4508   if (some_condition ())
4509     foo ();
4510     bar ();  /* Gotcha: this is not guarded by the "if".  */
4511 @end smallexample
4513 In the case of mixed tabs and spaces, the warning uses the
4514 @option{-ftabstop=} option to determine if the statements line up
4515 (defaulting to 8).
4517 The warning is not issued for code involving multiline preprocessor logic
4518 such as the following example.
4520 @smallexample
4521   if (flagA)
4522     foo (0);
4523 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4524   if (flagB)
4525 #endif
4526     foo (1);
4527 @end smallexample
4529 The warning is not issued after a @code{#line} directive, since this
4530 typically indicates autogenerated code, and no assumptions can be made
4531 about the layout of the file that the directive references.
4533 This warning is enabled by @option{-Wall} in C and C++.
4535 @item -Wmissing-braces
4536 @opindex Wmissing-braces
4537 @opindex Wno-missing-braces
4538 Warn if an aggregate or union initializer is not fully bracketed.  In
4539 the following example, the initializer for @code{a} is not fully
4540 bracketed, but that for @code{b} is fully bracketed.  This warning is
4541 enabled by @option{-Wall} in C.
4543 @smallexample
4544 int a[2][2] = @{ 0, 1, 2, 3 @};
4545 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4546 @end smallexample
4548 This warning is enabled by @option{-Wall}.
4550 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4551 @opindex Wmissing-include-dirs
4552 @opindex Wno-missing-include-dirs
4553 Warn if a user-supplied include directory does not exist.
4555 @item -Wmultistatement-macros
4556 @opindex Wmultistatement-macros
4557 @opindex Wno-multistatement-macros
4558 Warn about unsafe multiple statement macros that appear to be guarded
4559 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4560 @code{while}, in which only the first statement is actually guarded after
4561 the macro is expanded.
4563 For example:
4565 @smallexample
4566 #define DOIT x++; y++
4567 if (c)
4568   DOIT;
4569 @end smallexample
4571 will increment @code{y} unconditionally, not just when @code{c} holds.
4572 The can usually be fixed by wrapping the macro in a do-while loop:
4573 @smallexample
4574 #define DOIT do @{ x++; y++; @} while (0)
4575 if (c)
4576   DOIT;
4577 @end smallexample
4579 This warning is enabled by @option{-Wall} in C and C++.
4581 @item -Wparentheses
4582 @opindex Wparentheses
4583 @opindex Wno-parentheses
4584 Warn if parentheses are omitted in certain contexts, such
4585 as when there is an assignment in a context where a truth value
4586 is expected, or when operators are nested whose precedence people
4587 often get confused about.
4589 Also warn if a comparison like @code{x<=y<=z} appears; this is
4590 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4591 interpretation from that of ordinary mathematical notation.
4593 Also warn for dangerous uses of the GNU extension to
4594 @code{?:} with omitted middle operand. When the condition
4595 in the @code{?}: operator is a boolean expression, the omitted value is
4596 always 1.  Often programmers expect it to be a value computed
4597 inside the conditional expression instead.
4599 For C++ this also warns for some cases of unnecessary parentheses in
4600 declarations, which can indicate an attempt at a function call instead
4601 of a declaration:
4602 @smallexample
4604   // Declares a local variable called mymutex.
4605   std::unique_lock<std::mutex> (mymutex);
4606   // User meant std::unique_lock<std::mutex> lock (mymutex);
4608 @end smallexample
4610 This warning is enabled by @option{-Wall}.
4612 @item -Wsequence-point
4613 @opindex Wsequence-point
4614 @opindex Wno-sequence-point
4615 Warn about code that may have undefined semantics because of violations
4616 of sequence point rules in the C and C++ standards.
4618 The C and C++ standards define the order in which expressions in a C/C++
4619 program are evaluated in terms of @dfn{sequence points}, which represent
4620 a partial ordering between the execution of parts of the program: those
4621 executed before the sequence point, and those executed after it.  These
4622 occur after the evaluation of a full expression (one which is not part
4623 of a larger expression), after the evaluation of the first operand of a
4624 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4625 function is called (but after the evaluation of its arguments and the
4626 expression denoting the called function), and in certain other places.
4627 Other than as expressed by the sequence point rules, the order of
4628 evaluation of subexpressions of an expression is not specified.  All
4629 these rules describe only a partial order rather than a total order,
4630 since, for example, if two functions are called within one expression
4631 with no sequence point between them, the order in which the functions
4632 are called is not specified.  However, the standards committee have
4633 ruled that function calls do not overlap.
4635 It is not specified when between sequence points modifications to the
4636 values of objects take effect.  Programs whose behavior depends on this
4637 have undefined behavior; the C and C++ standards specify that ``Between
4638 the previous and next sequence point an object shall have its stored
4639 value modified at most once by the evaluation of an expression.
4640 Furthermore, the prior value shall be read only to determine the value
4641 to be stored.''.  If a program breaks these rules, the results on any
4642 particular implementation are entirely unpredictable.
4644 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4645 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4646 diagnosed by this option, and it may give an occasional false positive
4647 result, but in general it has been found fairly effective at detecting
4648 this sort of problem in programs.
4650 The C++17 standard will define the order of evaluation of operands in
4651 more cases: in particular it requires that the right-hand side of an
4652 assignment be evaluated before the left-hand side, so the above
4653 examples are no longer undefined.  But this warning will still warn
4654 about them, to help people avoid writing code that is undefined in C
4655 and earlier revisions of C++.
4657 The standard is worded confusingly, therefore there is some debate
4658 over the precise meaning of the sequence point rules in subtle cases.
4659 Links to discussions of the problem, including proposed formal
4660 definitions, may be found on the GCC readings page, at
4661 @uref{http://gcc.gnu.org/@/readings.html}.
4663 This warning is enabled by @option{-Wall} for C and C++.
4665 @item -Wno-return-local-addr
4666 @opindex Wno-return-local-addr
4667 @opindex Wreturn-local-addr
4668 Do not warn about returning a pointer (or in C++, a reference) to a
4669 variable that goes out of scope after the function returns.
4671 @item -Wreturn-type
4672 @opindex Wreturn-type
4673 @opindex Wno-return-type
4674 Warn whenever a function is defined with a return type that defaults
4675 to @code{int}.  Also warn about any @code{return} statement with no
4676 return value in a function whose return type is not @code{void}
4677 (falling off the end of the function body is considered returning
4678 without a value).
4680 For C only, warn about a @code{return} statement with an expression in a
4681 function whose return type is @code{void}, unless the expression type is
4682 also @code{void}.  As a GNU extension, the latter case is accepted
4683 without a warning unless @option{-Wpedantic} is used.
4685 For C++, a function without return type always produces a diagnostic
4686 message, even when @option{-Wno-return-type} is specified.  The only
4687 exceptions are @code{main} and functions defined in system headers.
4689 This warning is enabled by @option{-Wall}.
4691 @item -Wshift-count-negative
4692 @opindex Wshift-count-negative
4693 @opindex Wno-shift-count-negative
4694 Warn if shift count is negative. This warning is enabled by default.
4696 @item -Wshift-count-overflow
4697 @opindex Wshift-count-overflow
4698 @opindex Wno-shift-count-overflow
4699 Warn if shift count >= width of type. This warning is enabled by default.
4701 @item -Wshift-negative-value
4702 @opindex Wshift-negative-value
4703 @opindex Wno-shift-negative-value
4704 Warn if left shifting a negative value.  This warning is enabled by
4705 @option{-Wextra} in C99 and C++11 modes (and newer).
4707 @item -Wshift-overflow
4708 @itemx -Wshift-overflow=@var{n}
4709 @opindex Wshift-overflow
4710 @opindex Wno-shift-overflow
4711 Warn about left shift overflows.  This warning is enabled by
4712 default in C99 and C++11 modes (and newer).
4714 @table @gcctabopt
4715 @item -Wshift-overflow=1
4716 This is the warning level of @option{-Wshift-overflow} and is enabled
4717 by default in C99 and C++11 modes (and newer).  This warning level does
4718 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4719 an overflow is still rejected in contexts where an integer constant expression
4720 is required.)
4722 @item -Wshift-overflow=2
4723 This warning level also warns about left-shifting 1 into the sign bit,
4724 unless C++14 mode is active.
4725 @end table
4727 @item -Wswitch
4728 @opindex Wswitch
4729 @opindex Wno-switch
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.  (The presence of a @code{default} label prevents this
4733 warning.)  @code{case} labels outside the enumeration range also
4734 provoke warnings when this option is used (even if there is a
4735 @code{default} label).
4736 This warning is enabled by @option{-Wall}.
4738 @item -Wswitch-default
4739 @opindex Wswitch-default
4740 @opindex Wno-switch-default
4741 Warn whenever a @code{switch} statement does not have a @code{default}
4742 case.
4744 @item -Wswitch-enum
4745 @opindex Wswitch-enum
4746 @opindex Wno-switch-enum
4747 Warn whenever a @code{switch} statement has an index of enumerated type
4748 and lacks a @code{case} for one or more of the named codes of that
4749 enumeration.  @code{case} labels outside the enumeration range also
4750 provoke warnings when this option is used.  The only difference
4751 between @option{-Wswitch} and this option is that this option gives a
4752 warning about an omitted enumeration code even if there is a
4753 @code{default} label.
4755 @item -Wswitch-bool
4756 @opindex Wswitch-bool
4757 @opindex Wno-switch-bool
4758 Warn whenever a @code{switch} statement has an index of boolean type
4759 and the case values are outside the range of a boolean type.
4760 It is possible to suppress this warning by casting the controlling
4761 expression to a type other than @code{bool}.  For example:
4762 @smallexample
4763 @group
4764 switch ((int) (a == 4))
4765   @{
4766   @dots{}
4767   @}
4768 @end group
4769 @end smallexample
4770 This warning is enabled by default for C and C++ programs.
4772 @item -Wswitch-unreachable
4773 @opindex Wswitch-unreachable
4774 @opindex Wno-switch-unreachable
4775 Warn whenever a @code{switch} statement contains statements between the
4776 controlling expression and the first case label, which will never be
4777 executed.  For example:
4778 @smallexample
4779 @group
4780 switch (cond)
4781   @{
4782    i = 15;
4783   @dots{}
4784    case 5:
4785   @dots{}
4786   @}
4787 @end group
4788 @end smallexample
4789 @option{-Wswitch-unreachable} does not warn if the statement between the
4790 controlling expression and the first case label is just a declaration:
4791 @smallexample
4792 @group
4793 switch (cond)
4794   @{
4795    int i;
4796   @dots{}
4797    case 5:
4798    i = 5;
4799   @dots{}
4800   @}
4801 @end group
4802 @end smallexample
4803 This warning is enabled by default for C and C++ programs.
4805 @item -Wsync-nand @r{(C and C++ only)}
4806 @opindex Wsync-nand
4807 @opindex Wno-sync-nand
4808 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4809 built-in functions are used.  These functions changed semantics in GCC 4.4.
4811 @item -Wunused-but-set-parameter
4812 @opindex Wunused-but-set-parameter
4813 @opindex Wno-unused-but-set-parameter
4814 Warn whenever a function parameter is assigned to, but otherwise unused
4815 (aside from its declaration).
4817 To suppress this warning use the @code{unused} attribute
4818 (@pxref{Variable Attributes}).
4820 This warning is also enabled by @option{-Wunused} together with
4821 @option{-Wextra}.
4823 @item -Wunused-but-set-variable
4824 @opindex Wunused-but-set-variable
4825 @opindex Wno-unused-but-set-variable
4826 Warn whenever a local variable is assigned to, but otherwise unused
4827 (aside from its declaration).
4828 This warning is enabled by @option{-Wall}.
4830 To suppress this warning use the @code{unused} attribute
4831 (@pxref{Variable Attributes}).
4833 This warning is also enabled by @option{-Wunused}, which is enabled
4834 by @option{-Wall}.
4836 @item -Wunused-function
4837 @opindex Wunused-function
4838 @opindex Wno-unused-function
4839 Warn whenever a static function is declared but not defined or a
4840 non-inline static function is unused.
4841 This warning is enabled by @option{-Wall}.
4843 @item -Wunused-label
4844 @opindex Wunused-label
4845 @opindex Wno-unused-label
4846 Warn whenever a label is declared but not used.
4847 This warning is enabled by @option{-Wall}.
4849 To suppress this warning use the @code{unused} attribute
4850 (@pxref{Variable Attributes}).
4852 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4853 @opindex Wunused-local-typedefs
4854 Warn when a typedef locally defined in a function is not used.
4855 This warning is enabled by @option{-Wall}.
4857 @item -Wunused-parameter
4858 @opindex Wunused-parameter
4859 @opindex Wno-unused-parameter
4860 Warn whenever a function parameter is unused aside from its declaration.
4862 To suppress this warning use the @code{unused} attribute
4863 (@pxref{Variable Attributes}).
4865 @item -Wno-unused-result
4866 @opindex Wunused-result
4867 @opindex Wno-unused-result
4868 Do not warn if a caller of a function marked with attribute
4869 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4870 its return value. The default is @option{-Wunused-result}.
4872 @item -Wunused-variable
4873 @opindex Wunused-variable
4874 @opindex Wno-unused-variable
4875 Warn whenever a local or static variable is unused aside from its
4876 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4877 but not for C++. This warning is enabled by @option{-Wall}.
4879 To suppress this warning use the @code{unused} attribute
4880 (@pxref{Variable Attributes}).
4882 @item -Wunused-const-variable
4883 @itemx -Wunused-const-variable=@var{n}
4884 @opindex Wunused-const-variable
4885 @opindex Wno-unused-const-variable
4886 Warn whenever a constant static variable is unused aside from its declaration.
4887 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4888 for C, but not for C++. In C this declares variable storage, but in C++ this
4889 is not an error since const variables take the place of @code{#define}s.
4891 To suppress this warning use the @code{unused} attribute
4892 (@pxref{Variable Attributes}).
4894 @table @gcctabopt
4895 @item -Wunused-const-variable=1
4896 This is the warning level that is enabled by @option{-Wunused-variable} for
4897 C.  It warns only about unused static const variables defined in the main
4898 compilation unit, but not about static const variables declared in any
4899 header included.
4901 @item -Wunused-const-variable=2
4902 This warning level also warns for unused constant static variables in
4903 headers (excluding system headers).  This is the warning level of
4904 @option{-Wunused-const-variable} and must be explicitly requested since
4905 in C++ this isn't an error and in C it might be harder to clean up all
4906 headers included.
4907 @end table
4909 @item -Wunused-value
4910 @opindex Wunused-value
4911 @opindex Wno-unused-value
4912 Warn whenever a statement computes a result that is explicitly not
4913 used. To suppress this warning cast the unused expression to
4914 @code{void}. This includes an expression-statement or the left-hand
4915 side of a comma expression that contains no side effects. For example,
4916 an expression such as @code{x[i,j]} causes a warning, while
4917 @code{x[(void)i,j]} does not.
4919 This warning is enabled by @option{-Wall}.
4921 @item -Wunused
4922 @opindex Wunused
4923 @opindex Wno-unused
4924 All the above @option{-Wunused} options combined.
4926 In order to get a warning about an unused function parameter, you must
4927 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4928 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4930 @item -Wuninitialized
4931 @opindex Wuninitialized
4932 @opindex Wno-uninitialized
4933 Warn if an automatic variable is used without first being initialized
4934 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4935 warn if a non-static reference or non-static @code{const} member
4936 appears in a class without constructors.
4938 If you want to warn about code that uses the uninitialized value of the
4939 variable in its own initializer, use the @option{-Winit-self} option.
4941 These warnings occur for individual uninitialized or clobbered
4942 elements of structure, union or array variables as well as for
4943 variables that are uninitialized or clobbered as a whole.  They do
4944 not occur for variables or elements declared @code{volatile}.  Because
4945 these warnings depend on optimization, the exact variables or elements
4946 for which there are warnings depends on the precise optimization
4947 options and version of GCC used.
4949 Note that there may be no warning about a variable that is used only
4950 to compute a value that itself is never used, because such
4951 computations may be deleted by data flow analysis before the warnings
4952 are printed.
4954 @item -Winvalid-memory-model
4955 @opindex Winvalid-memory-model
4956 @opindex Wno-invalid-memory-model
4957 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4958 and the C11 atomic generic functions with a memory consistency argument
4959 that is either invalid for the operation or outside the range of values
4960 of the @code{memory_order} enumeration.  For example, since the
4961 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4962 defined for the relaxed, release, and sequentially consistent memory
4963 orders the following code is diagnosed:
4965 @smallexample
4966 void store (int *i)
4968   __atomic_store_n (i, 0, memory_order_consume);
4970 @end smallexample
4972 @option{-Winvalid-memory-model} is enabled by default.
4974 @item -Wmaybe-uninitialized
4975 @opindex Wmaybe-uninitialized
4976 @opindex Wno-maybe-uninitialized
4977 For an automatic (i.e.@ local) variable, if there exists a path from the
4978 function entry to a use of the variable that is initialized, but there exist
4979 some other paths for which the variable is not initialized, the compiler
4980 emits a warning if it cannot prove the uninitialized paths are not
4981 executed at run time.
4983 These warnings are only possible in optimizing compilation, because otherwise
4984 GCC does not keep track of the state of variables.
4986 These warnings are made optional because GCC may not be able to determine when
4987 the code is correct in spite of appearing to have an error.  Here is one
4988 example of how this can happen:
4990 @smallexample
4991 @group
4993   int x;
4994   switch (y)
4995     @{
4996     case 1: x = 1;
4997       break;
4998     case 2: x = 4;
4999       break;
5000     case 3: x = 5;
5001     @}
5002   foo (x);
5004 @end group
5005 @end smallexample
5007 @noindent
5008 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
5009 always initialized, but GCC doesn't know this. To suppress the
5010 warning, you need to provide a default case with assert(0) or
5011 similar code.
5013 @cindex @code{longjmp} warnings
5014 This option also warns when a non-volatile automatic variable might be
5015 changed by a call to @code{longjmp}.
5016 The compiler sees only the calls to @code{setjmp}.  It cannot know
5017 where @code{longjmp} will be called; in fact, a signal handler could
5018 call it at any point in the code.  As a result, you may get a warning
5019 even when there is in fact no problem because @code{longjmp} cannot
5020 in fact be called at the place that would cause a problem.
5022 Some spurious warnings can be avoided if you declare all the functions
5023 you use that never return as @code{noreturn}.  @xref{Function
5024 Attributes}.
5026 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5028 @item -Wunknown-pragmas
5029 @opindex Wunknown-pragmas
5030 @opindex Wno-unknown-pragmas
5031 @cindex warning for unknown pragmas
5032 @cindex unknown pragmas, warning
5033 @cindex pragmas, warning of unknown
5034 Warn when a @code{#pragma} directive is encountered that is not understood by 
5035 GCC@.  If this command-line option is used, warnings are even issued
5036 for unknown pragmas in system header files.  This is not the case if
5037 the warnings are only enabled by the @option{-Wall} command-line option.
5039 @item -Wno-pragmas
5040 @opindex Wno-pragmas
5041 @opindex Wpragmas
5042 Do not warn about misuses of pragmas, such as incorrect parameters,
5043 invalid syntax, or conflicts between pragmas.  See also
5044 @option{-Wunknown-pragmas}.
5046 @item -Wstrict-aliasing
5047 @opindex Wstrict-aliasing
5048 @opindex Wno-strict-aliasing
5049 This option is only active when @option{-fstrict-aliasing} is active.
5050 It warns about code that might break the strict aliasing rules that the
5051 compiler is using for optimization.  The warning does not catch all
5052 cases, but does attempt to catch the more common pitfalls.  It is
5053 included in @option{-Wall}.
5054 It is equivalent to @option{-Wstrict-aliasing=3}
5056 @item -Wstrict-aliasing=n
5057 @opindex Wstrict-aliasing=n
5058 This option is only active when @option{-fstrict-aliasing} is active.
5059 It warns about code that might break the strict aliasing rules that the
5060 compiler is using for optimization.
5061 Higher levels correspond to higher accuracy (fewer false positives).
5062 Higher levels also correspond to more effort, similar to the way @option{-O} 
5063 works.
5064 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5066 Level 1: Most aggressive, quick, least accurate.
5067 Possibly useful when higher levels
5068 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5069 false negatives.  However, it has many false positives.
5070 Warns for all pointer conversions between possibly incompatible types,
5071 even if never dereferenced.  Runs in the front end only.
5073 Level 2: Aggressive, quick, not too precise.
5074 May still have many false positives (not as many as level 1 though),
5075 and few false negatives (but possibly more than level 1).
5076 Unlike level 1, it only warns when an address is taken.  Warns about
5077 incomplete types.  Runs in the front end only.
5079 Level 3 (default for @option{-Wstrict-aliasing}):
5080 Should have very few false positives and few false
5081 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5082 Takes care of the common pun+dereference pattern in the front end:
5083 @code{*(int*)&some_float}.
5084 If optimization is enabled, it also runs in the back end, where it deals
5085 with multiple statement cases using flow-sensitive points-to information.
5086 Only warns when the converted pointer is dereferenced.
5087 Does not warn about incomplete types.
5089 @item -Wstrict-overflow
5090 @itemx -Wstrict-overflow=@var{n}
5091 @opindex Wstrict-overflow
5092 @opindex Wno-strict-overflow
5093 This option is only active when signed overflow is undefined.
5094 It warns about cases where the compiler optimizes based on the
5095 assumption that signed overflow does not occur.  Note that it does not
5096 warn about all cases where the code might overflow: it only warns
5097 about cases where the compiler implements some optimization.  Thus
5098 this warning depends on the optimization level.
5100 An optimization that assumes that signed overflow does not occur is
5101 perfectly safe if the values of the variables involved are such that
5102 overflow never does, in fact, occur.  Therefore this warning can
5103 easily give a false positive: a warning about code that is not
5104 actually a problem.  To help focus on important issues, several
5105 warning levels are defined.  No warnings are issued for the use of
5106 undefined signed overflow when estimating how many iterations a loop
5107 requires, in particular when determining whether a loop will be
5108 executed at all.
5110 @table @gcctabopt
5111 @item -Wstrict-overflow=1
5112 Warn about cases that are both questionable and easy to avoid.  For
5113 example the compiler simplifies
5114 @code{x + 1 > x} to @code{1}.  This level of
5115 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5116 are not, and must be explicitly requested.
5118 @item -Wstrict-overflow=2
5119 Also warn about other cases where a comparison is simplified to a
5120 constant.  For example: @code{abs (x) >= 0}.  This can only be
5121 simplified when signed integer overflow is undefined, because
5122 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5123 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5124 @option{-Wstrict-overflow=2}.
5126 @item -Wstrict-overflow=3
5127 Also warn about other cases where a comparison is simplified.  For
5128 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5130 @item -Wstrict-overflow=4
5131 Also warn about other simplifications not covered by the above cases.
5132 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5134 @item -Wstrict-overflow=5
5135 Also warn about cases where the compiler reduces the magnitude of a
5136 constant involved in a comparison.  For example: @code{x + 2 > y} is
5137 simplified to @code{x + 1 >= y}.  This is reported only at the
5138 highest warning level because this simplification applies to many
5139 comparisons, so this warning level gives a very large number of
5140 false positives.
5141 @end table
5143 @item -Wstringop-overflow
5144 @itemx -Wstringop-overflow=@var{type}
5145 @opindex Wstringop-overflow
5146 @opindex Wno-stringop-overflow
5147 Warn for calls to string manipulation functions such as @code{memcpy} and
5148 @code{strcpy} that are determined to overflow the destination buffer.  The
5149 optional argument is one greater than the type of Object Size Checking to
5150 perform to determine the size of the destination.  @xref{Object Size Checking}.
5151 The argument is meaningful only for functions that operate on character arrays
5152 but not for raw memory functions like @code{memcpy} which always make use
5153 of Object Size type-0.  The option also warns for calls that specify a size
5154 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5155 The option produces the best results with optimization enabled but can detect
5156 a small subset of simple buffer overflows even without optimization in
5157 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5158 correspond to the standard functions.  In any case, the option warns about
5159 just a subset of buffer overflows detected by the corresponding overflow
5160 checking built-ins.  For example, the option will issue a warning for
5161 the @code{strcpy} call below because it copies at least 5 characters
5162 (the string @code{"blue"} including the terminating NUL) into the buffer
5163 of size 4.
5165 @smallexample
5166 enum Color @{ blue, purple, yellow @};
5167 const char* f (enum Color clr)
5169   static char buf [4];
5170   const char *str;
5171   switch (clr)
5172     @{
5173       case blue: str = "blue"; break;
5174       case purple: str = "purple"; break;
5175       case yellow: str = "yellow"; break;
5176     @}
5178   return strcpy (buf, str);   // warning here
5180 @end smallexample
5182 Option @option{-Wstringop-overflow=2} is enabled by default.
5184 @table @gcctabopt
5185 @item -Wstringop-overflow
5186 @item -Wstringop-overflow=1
5187 @opindex Wstringop-overflow
5188 @opindex Wno-stringop-overflow
5189 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5190 to determine the sizes of destination objects.  This is the default setting
5191 of the option.  At this setting the option will not warn for writes past
5192 the end of subobjects of larger objects accessed by pointers unless the
5193 size of the largest surrounding object is known.  When the destination may
5194 be one of several objects it is assumed to be the largest one of them.  On
5195 Linux systems, when optimization is enabled at this setting the option warns
5196 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5197 a non-zero value.
5199 @item -Wstringop-overflow=2
5200 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5201 to determine the sizes of destination objects.  At this setting the option
5202 will warn about overflows when writing to members of the largest complete
5203 objects whose exact size is known.  It will, however, not warn for excessive
5204 writes to the same members of unknown objects referenced by pointers since
5205 they may point to arrays containing unknown numbers of elements.
5207 @item -Wstringop-overflow=3
5208 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5209 to determine the sizes of destination objects.  At this setting the option
5210 warns about overflowing the smallest object or data member.  This is the
5211 most restrictive setting of the option that may result in warnings for safe
5212 code.
5214 @item -Wstringop-overflow=4
5215 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5216 to determine the sizes of destination objects.  At this setting the option
5217 will warn about overflowing any data members, and when the destination is
5218 one of several objects it uses the size of the largest of them to decide
5219 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5220 setting of the option may result in warnings for benign code.
5221 @end table
5223 @item -Wstringop-truncation
5224 @opindex Wstringop-truncation
5225 @opindex Wno-stringop-truncation
5226 Warn for calls to bounded string manipulation functions such as @code{strncat},
5227 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5228 or leave the destination unchanged.
5230 In the following example, the call to @code{strncat} specifies a bound that
5231 is less than the length of the source string.  As a result, the copy of
5232 the source will be truncated and so the call is diagnosed.  To avoid the
5233 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5235 @smallexample
5236 void append (char *buf, size_t bufsize)
5238   strncat (buf, ".txt", 3);
5240 @end smallexample
5242 As another example, the following call to @code{strncpy} results in copying
5243 to @code{d} just the characters preceding the terminating NUL, without
5244 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5245 necessarily a NUL-terminated string is a common mistake, and so the call
5246 is diagnosed.  To avoid the warning when the result is not expected to be
5247 NUL-terminated, call @code{memcpy} instead.
5249 @smallexample
5250 void copy (char *d, const char *s)
5252   strncpy (d, s, strlen (s));
5254 @end smallexample
5256 In the following example, the call to @code{strncpy} specifies the size
5257 of the destination buffer as the bound.  If the length of the source
5258 string is equal to or greater than this size the result of the copy will
5259 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5260 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5261 element of the buffer to @code{NUL}.
5263 @smallexample
5264 void copy (const char *s)
5266   char buf[80];
5267   strncpy (buf, s, sizeof buf);
5268   @dots{}
5270 @end smallexample
5272 In situations where a character array is intended to store a sequence
5273 of bytes with no terminating @code{NUL} such an array may be annotated
5274 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5275 however, are not suitable arguments to functions that expect
5276 @code{NUL}-terminated strings.  To help detect accidental misuses of
5277 such arrays GCC issues warnings unless it can prove that the use is
5278 safe.  @xref{Common Variable Attributes}.
5280 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5281 @opindex Wsuggest-attribute=
5282 @opindex Wno-suggest-attribute=
5283 Warn for cases where adding an attribute may be beneficial. The
5284 attributes currently supported are listed below.
5286 @table @gcctabopt
5287 @item -Wsuggest-attribute=pure
5288 @itemx -Wsuggest-attribute=const
5289 @itemx -Wsuggest-attribute=noreturn
5290 @itemx -Wsuggest-attribute=malloc
5291 @opindex Wsuggest-attribute=pure
5292 @opindex Wno-suggest-attribute=pure
5293 @opindex Wsuggest-attribute=const
5294 @opindex Wno-suggest-attribute=const
5295 @opindex Wsuggest-attribute=noreturn
5296 @opindex Wno-suggest-attribute=noreturn
5297 @opindex Wsuggest-attribute=malloc
5298 @opindex Wno-suggest-attribute=malloc
5300 Warn about functions that might be candidates for attributes
5301 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5302 only warns for functions visible in other compilation units or (in the case of
5303 @code{pure} and @code{const}) if it cannot prove that the function returns
5304 normally. A function returns normally if it doesn't contain an infinite loop or
5305 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5306 requires option @option{-fipa-pure-const}, which is enabled by default at
5307 @option{-O} and higher.  Higher optimization levels improve the accuracy
5308 of the analysis.
5310 @item -Wsuggest-attribute=format
5311 @itemx -Wmissing-format-attribute
5312 @opindex Wsuggest-attribute=format
5313 @opindex Wmissing-format-attribute
5314 @opindex Wno-suggest-attribute=format
5315 @opindex Wno-missing-format-attribute
5316 @opindex Wformat
5317 @opindex Wno-format
5319 Warn about function pointers that might be candidates for @code{format}
5320 attributes.  Note these are only possible candidates, not absolute ones.
5321 GCC guesses that function pointers with @code{format} attributes that
5322 are used in assignment, initialization, parameter passing or return
5323 statements should have a corresponding @code{format} attribute in the
5324 resulting type.  I.e.@: the left-hand side of the assignment or
5325 initialization, the type of the parameter variable, or the return type
5326 of the containing function respectively should also have a @code{format}
5327 attribute to avoid the warning.
5329 GCC also warns about function definitions that might be
5330 candidates for @code{format} attributes.  Again, these are only
5331 possible candidates.  GCC guesses that @code{format} attributes
5332 might be appropriate for any function that calls a function like
5333 @code{vprintf} or @code{vscanf}, but this might not always be the
5334 case, and some functions for which @code{format} attributes are
5335 appropriate may not be detected.
5337 @item -Wsuggest-attribute=cold
5338 @opindex Wsuggest-attribute=cold
5339 @opindex Wno-suggest-attribute=cold
5341 Warn about functions that might be candidates for @code{cold} attribute.  This
5342 is based on static detection and generally will only warn about functions which
5343 always leads to a call to another @code{cold} function such as wrappers of
5344 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5345 @end table
5347 @item -Wsuggest-final-types
5348 @opindex Wno-suggest-final-types
5349 @opindex Wsuggest-final-types
5350 Warn about types with virtual methods where code quality would be improved
5351 if the type were declared with the C++11 @code{final} specifier, 
5352 or, if possible,
5353 declared in an anonymous namespace. This allows GCC to more aggressively
5354 devirtualize the polymorphic calls. This warning is more effective with link
5355 time optimization, where the information about the class hierarchy graph is
5356 more complete.
5358 @item -Wsuggest-final-methods
5359 @opindex Wno-suggest-final-methods
5360 @opindex Wsuggest-final-methods
5361 Warn about virtual methods where code quality would be improved if the method
5362 were declared with the C++11 @code{final} specifier, 
5363 or, if possible, its type were
5364 declared in an anonymous namespace or with the @code{final} specifier.
5365 This warning is
5366 more effective with link-time optimization, where the information about the
5367 class hierarchy graph is more complete. It is recommended to first consider
5368 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5369 annotations.
5371 @item -Wsuggest-override
5372 Warn about overriding virtual functions that are not marked with the override
5373 keyword.
5375 @item -Walloc-zero
5376 @opindex Wno-alloc-zero
5377 @opindex Walloc-zero
5378 Warn about calls to allocation functions decorated with attribute
5379 @code{alloc_size} that specify zero bytes, including those to the built-in
5380 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5381 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5382 when called with a zero size differs among implementations (and in the case
5383 of @code{realloc} has been deprecated) relying on it may result in subtle
5384 portability bugs and should be avoided.
5386 @item -Walloc-size-larger-than=@var{n}
5387 Warn about calls to functions decorated with attribute @code{alloc_size}
5388 that attempt to allocate objects larger than the specified number of bytes,
5389 or where the result of the size computation in an integer type with infinite
5390 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5391 may end in one of the standard suffixes designating a multiple of bytes
5392 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5393 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5394 @xref{Function Attributes}.
5396 @item -Walloca
5397 @opindex Wno-alloca
5398 @opindex Walloca
5399 This option warns on all uses of @code{alloca} in the source.
5401 @item -Walloca-larger-than=@var{n}
5402 This option warns on calls to @code{alloca} that are not bounded by a
5403 controlling predicate limiting its argument of integer type to at most
5404 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5405 Arguments of non-integer types are considered unbounded even if they
5406 appear to be constrained to the expected range.
5408 For example, a bounded case of @code{alloca} could be:
5410 @smallexample
5411 void func (size_t n)
5413   void *p;
5414   if (n <= 1000)
5415     p = alloca (n);
5416   else
5417     p = malloc (n);
5418   f (p);
5420 @end smallexample
5422 In the above example, passing @code{-Walloca-larger-than=1000} would not
5423 issue a warning because the call to @code{alloca} is known to be at most
5424 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5425 the compiler would emit a warning.
5427 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5428 controlling predicate constraining its integer argument.  For example:
5430 @smallexample
5431 void func ()
5433   void *p = alloca (n);
5434   f (p);
5436 @end smallexample
5438 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5439 a warning, but this time because of the lack of bounds checking.
5441 Note, that even seemingly correct code involving signed integers could
5442 cause a warning:
5444 @smallexample
5445 void func (signed int n)
5447   if (n < 500)
5448     @{
5449       p = alloca (n);
5450       f (p);
5451     @}
5453 @end smallexample
5455 In the above example, @var{n} could be negative, causing a larger than
5456 expected argument to be implicitly cast into the @code{alloca} call.
5458 This option also warns when @code{alloca} is used in a loop.
5460 This warning is not enabled by @option{-Wall}, and is only active when
5461 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5463 See also @option{-Wvla-larger-than=@var{n}}.
5465 @item -Warray-bounds
5466 @itemx -Warray-bounds=@var{n}
5467 @opindex Wno-array-bounds
5468 @opindex Warray-bounds
5469 This option is only active when @option{-ftree-vrp} is active
5470 (default for @option{-O2} and above). It warns about subscripts to arrays
5471 that are always out of bounds. This warning is enabled by @option{-Wall}.
5473 @table @gcctabopt
5474 @item -Warray-bounds=1
5475 This is the warning level of @option{-Warray-bounds} and is enabled
5476 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5478 @item -Warray-bounds=2
5479 This warning level also warns about out of bounds access for
5480 arrays at the end of a struct and for arrays accessed through
5481 pointers. This warning level may give a larger number of
5482 false positives and is deactivated by default.
5483 @end table
5485 @item -Wattribute-alias
5486 Warn about declarations using the @code{alias} and similar attributes whose
5487 target is incompatible with the type of the alias.  @xref{Function Attributes,
5488 ,Declaring Attributes of Functions}.
5490 @item -Wbool-compare
5491 @opindex Wno-bool-compare
5492 @opindex Wbool-compare
5493 Warn about boolean expression compared with an integer value different from
5494 @code{true}/@code{false}.  For instance, the following comparison is
5495 always false:
5496 @smallexample
5497 int n = 5;
5498 @dots{}
5499 if ((n > 1) == 2) @{ @dots{} @}
5500 @end smallexample
5501 This warning is enabled by @option{-Wall}.
5503 @item -Wbool-operation
5504 @opindex Wno-bool-operation
5505 @opindex Wbool-operation
5506 Warn about suspicious operations on expressions of a boolean type.  For
5507 instance, bitwise negation of a boolean is very likely a bug in the program.
5508 For C, this warning also warns about incrementing or decrementing a boolean,
5509 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5510 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5512 This warning is enabled by @option{-Wall}.
5514 @item -Wduplicated-branches
5515 @opindex Wno-duplicated-branches
5516 @opindex Wduplicated-branches
5517 Warn when an if-else has identical branches.  This warning detects cases like
5518 @smallexample
5519 if (p != NULL)
5520   return 0;
5521 else
5522   return 0;
5523 @end smallexample
5524 It doesn't warn when both branches contain just a null statement.  This warning
5525 also warn for conditional operators:
5526 @smallexample
5527   int i = x ? *p : *p;
5528 @end smallexample
5530 @item -Wduplicated-cond
5531 @opindex Wno-duplicated-cond
5532 @opindex Wduplicated-cond
5533 Warn about duplicated conditions in an if-else-if chain.  For instance,
5534 warn for the following code:
5535 @smallexample
5536 if (p->q != NULL) @{ @dots{} @}
5537 else if (p->q != NULL) @{ @dots{} @}
5538 @end smallexample
5540 @item -Wframe-address
5541 @opindex Wno-frame-address
5542 @opindex Wframe-address
5543 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5544 is called with an argument greater than 0.  Such calls may return indeterminate
5545 values or crash the program.  The warning is included in @option{-Wall}.
5547 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5548 @opindex Wno-discarded-qualifiers
5549 @opindex Wdiscarded-qualifiers
5550 Do not warn if type qualifiers on pointers are being discarded.
5551 Typically, the compiler warns if a @code{const char *} variable is
5552 passed to a function that takes a @code{char *} parameter.  This option
5553 can be used to suppress such a warning.
5555 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5556 @opindex Wno-discarded-array-qualifiers
5557 @opindex Wdiscarded-array-qualifiers
5558 Do not warn if type qualifiers on arrays which are pointer targets
5559 are being discarded. Typically, the compiler warns if a
5560 @code{const int (*)[]} variable is passed to a function that
5561 takes a @code{int (*)[]} parameter.  This option can be used to
5562 suppress such a warning.
5564 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5565 @opindex Wno-incompatible-pointer-types
5566 @opindex Wincompatible-pointer-types
5567 Do not warn when there is a conversion between pointers that have incompatible
5568 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5569 which warns for pointer argument passing or assignment with different
5570 signedness.
5572 @item -Wno-int-conversion @r{(C and Objective-C only)}
5573 @opindex Wno-int-conversion
5574 @opindex Wint-conversion
5575 Do not warn about incompatible integer to pointer and pointer to integer
5576 conversions.  This warning is about implicit conversions; for explicit
5577 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5578 @option{-Wno-pointer-to-int-cast} may be used.
5580 @item -Wno-div-by-zero
5581 @opindex Wno-div-by-zero
5582 @opindex Wdiv-by-zero
5583 Do not warn about compile-time integer division by zero.  Floating-point
5584 division by zero is not warned about, as it can be a legitimate way of
5585 obtaining infinities and NaNs.
5587 @item -Wsystem-headers
5588 @opindex Wsystem-headers
5589 @opindex Wno-system-headers
5590 @cindex warnings from system headers
5591 @cindex system headers, warnings from
5592 Print warning messages for constructs found in system header files.
5593 Warnings from system headers are normally suppressed, on the assumption
5594 that they usually do not indicate real problems and would only make the
5595 compiler output harder to read.  Using this command-line option tells
5596 GCC to emit warnings from system headers as if they occurred in user
5597 code.  However, note that using @option{-Wall} in conjunction with this
5598 option does @emph{not} warn about unknown pragmas in system
5599 headers---for that, @option{-Wunknown-pragmas} must also be used.
5601 @item -Wtautological-compare
5602 @opindex Wtautological-compare
5603 @opindex Wno-tautological-compare
5604 Warn if a self-comparison always evaluates to true or false.  This
5605 warning detects various mistakes such as:
5606 @smallexample
5607 int i = 1;
5608 @dots{}
5609 if (i > i) @{ @dots{} @}
5610 @end smallexample
5612 This warning also warns about bitwise comparisons that always evaluate
5613 to true or false, for instance:
5614 @smallexample
5615 if ((a & 16) == 10) @{ @dots{} @}
5616 @end smallexample
5617 will always be false.
5619 This warning is enabled by @option{-Wall}.
5621 @item -Wtrampolines
5622 @opindex Wtrampolines
5623 @opindex Wno-trampolines
5624 Warn about trampolines generated for pointers to nested functions.
5625 A trampoline is a small piece of data or code that is created at run
5626 time on the stack when the address of a nested function is taken, and is
5627 used to call the nested function indirectly.  For some targets, it is
5628 made up of data only and thus requires no special treatment.  But, for
5629 most targets, it is made up of code and thus requires the stack to be
5630 made executable in order for the program to work properly.
5632 @item -Wfloat-equal
5633 @opindex Wfloat-equal
5634 @opindex Wno-float-equal
5635 Warn if floating-point values are used in equality comparisons.
5637 The idea behind this is that sometimes it is convenient (for the
5638 programmer) to consider floating-point values as approximations to
5639 infinitely precise real numbers.  If you are doing this, then you need
5640 to compute (by analyzing the code, or in some other way) the maximum or
5641 likely maximum error that the computation introduces, and allow for it
5642 when performing comparisons (and when producing output, but that's a
5643 different problem).  In particular, instead of testing for equality, you
5644 should check to see whether the two values have ranges that overlap; and
5645 this is done with the relational operators, so equality comparisons are
5646 probably mistaken.
5648 @item -Wtraditional @r{(C and Objective-C only)}
5649 @opindex Wtraditional
5650 @opindex Wno-traditional
5651 Warn about certain constructs that behave differently in traditional and
5652 ISO C@.  Also warn about ISO C constructs that have no traditional C
5653 equivalent, and/or problematic constructs that should be avoided.
5655 @itemize @bullet
5656 @item
5657 Macro parameters that appear within string literals in the macro body.
5658 In traditional C macro replacement takes place within string literals,
5659 but in ISO C it does not.
5661 @item
5662 In traditional C, some preprocessor directives did not exist.
5663 Traditional preprocessors only considered a line to be a directive
5664 if the @samp{#} appeared in column 1 on the line.  Therefore
5665 @option{-Wtraditional} warns about directives that traditional C
5666 understands but ignores because the @samp{#} does not appear as the
5667 first character on the line.  It also suggests you hide directives like
5668 @code{#pragma} not understood by traditional C by indenting them.  Some
5669 traditional implementations do not recognize @code{#elif}, so this option
5670 suggests avoiding it altogether.
5672 @item
5673 A function-like macro that appears without arguments.
5675 @item
5676 The unary plus operator.
5678 @item
5679 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5680 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5681 constants.)  Note, these suffixes appear in macros defined in the system
5682 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5683 Use of these macros in user code might normally lead to spurious
5684 warnings, however GCC's integrated preprocessor has enough context to
5685 avoid warning in these cases.
5687 @item
5688 A function declared external in one block and then used after the end of
5689 the block.
5691 @item
5692 A @code{switch} statement has an operand of type @code{long}.
5694 @item
5695 A non-@code{static} function declaration follows a @code{static} one.
5696 This construct is not accepted by some traditional C compilers.
5698 @item
5699 The ISO type of an integer constant has a different width or
5700 signedness from its traditional type.  This warning is only issued if
5701 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5702 typically represent bit patterns, are not warned about.
5704 @item
5705 Usage of ISO string concatenation is detected.
5707 @item
5708 Initialization of automatic aggregates.
5710 @item
5711 Identifier conflicts with labels.  Traditional C lacks a separate
5712 namespace for labels.
5714 @item
5715 Initialization of unions.  If the initializer is zero, the warning is
5716 omitted.  This is done under the assumption that the zero initializer in
5717 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5718 initializer warnings and relies on default initialization to zero in the
5719 traditional C case.
5721 @item
5722 Conversions by prototypes between fixed/floating-point values and vice
5723 versa.  The absence of these prototypes when compiling with traditional
5724 C causes serious problems.  This is a subset of the possible
5725 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5727 @item
5728 Use of ISO C style function definitions.  This warning intentionally is
5729 @emph{not} issued for prototype declarations or variadic functions
5730 because these ISO C features appear in your code when using
5731 libiberty's traditional C compatibility macros, @code{PARAMS} and
5732 @code{VPARAMS}.  This warning is also bypassed for nested functions
5733 because that feature is already a GCC extension and thus not relevant to
5734 traditional C compatibility.
5735 @end itemize
5737 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5738 @opindex Wtraditional-conversion
5739 @opindex Wno-traditional-conversion
5740 Warn if a prototype causes a type conversion that is different from what
5741 would happen to the same argument in the absence of a prototype.  This
5742 includes conversions of fixed point to floating and vice versa, and
5743 conversions changing the width or signedness of a fixed-point argument
5744 except when the same as the default promotion.
5746 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5747 @opindex Wdeclaration-after-statement
5748 @opindex Wno-declaration-after-statement
5749 Warn when a declaration is found after a statement in a block.  This
5750 construct, known from C++, was introduced with ISO C99 and is by default
5751 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5753 @item -Wshadow
5754 @opindex Wshadow
5755 @opindex Wno-shadow
5756 Warn whenever a local variable or type declaration shadows another
5757 variable, parameter, type, class member (in C++), or instance variable
5758 (in Objective-C) or whenever a built-in function is shadowed. Note
5759 that in C++, the compiler warns if a local variable shadows an
5760 explicit typedef, but not if it shadows a struct/class/enum.
5761 Same as @option{-Wshadow=global}.
5763 @item -Wno-shadow-ivar @r{(Objective-C only)}
5764 @opindex Wno-shadow-ivar
5765 @opindex Wshadow-ivar
5766 Do not warn whenever a local variable shadows an instance variable in an
5767 Objective-C method.
5769 @item -Wshadow=global
5770 @opindex Wshadow=local
5771 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5773 @item -Wshadow=local
5774 @opindex Wshadow=local
5775 Warn when a local variable shadows another local variable or parameter.
5776 This warning is enabled by @option{-Wshadow=global}.
5778 @item -Wshadow=compatible-local
5779 @opindex Wshadow=compatible-local
5780 Warn when a local variable shadows another local variable or parameter
5781 whose type is compatible with that of the shadowing variable. In C++,
5782 type compatibility here means the type of the shadowing variable can be
5783 converted to that of the shadowed variable. The creation of this flag
5784 (in addition to @option{-Wshadow=local}) is based on the idea that when
5785 a local variable shadows another one of incompatible type, it is most
5786 likely intentional, not a bug or typo, as shown in the following example:
5788 @smallexample
5789 @group
5790 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5792   for (int i = 0; i < N; ++i)
5793   @{
5794     ...
5795   @}
5796   ...
5798 @end group
5799 @end smallexample
5801 Since the two variable @code{i} in the example above have incompatible types,
5802 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5803 Because their types are incompatible, if a programmer accidentally uses one
5804 in place of the other, type checking will catch that and emit an error or
5805 warning. So not warning (about shadowing) in this case will not lead to
5806 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5807 possibly reduce the number of warnings triggered by intentional shadowing.
5809 This warning is enabled by @option{-Wshadow=local}.
5811 @item -Wlarger-than=@var{len}
5812 @opindex Wlarger-than=@var{len}
5813 @opindex Wlarger-than-@var{len}
5814 Warn whenever an object of larger than @var{len} bytes is defined.
5816 @item -Wframe-larger-than=@var{len}
5817 @opindex Wframe-larger-than
5818 Warn if the size of a function frame is larger than @var{len} bytes.
5819 The computation done to determine the stack frame size is approximate
5820 and not conservative.
5821 The actual requirements may be somewhat greater than @var{len}
5822 even if you do not get a warning.  In addition, any space allocated
5823 via @code{alloca}, variable-length arrays, or related constructs
5824 is not included by the compiler when determining
5825 whether or not to issue a warning.
5827 @item -Wno-free-nonheap-object
5828 @opindex Wno-free-nonheap-object
5829 @opindex Wfree-nonheap-object
5830 Do not warn when attempting to free an object that was not allocated
5831 on the heap.
5833 @item -Wstack-usage=@var{len}
5834 @opindex Wstack-usage
5835 Warn if the stack usage of a function might be larger than @var{len} bytes.
5836 The computation done to determine the stack usage is conservative.
5837 Any space allocated via @code{alloca}, variable-length arrays, or related
5838 constructs is included by the compiler when determining whether or not to
5839 issue a warning.
5841 The message is in keeping with the output of @option{-fstack-usage}.
5843 @itemize
5844 @item
5845 If the stack usage is fully static but exceeds the specified amount, it's:
5847 @smallexample
5848   warning: stack usage is 1120 bytes
5849 @end smallexample
5850 @item
5851 If the stack usage is (partly) dynamic but bounded, it's:
5853 @smallexample
5854   warning: stack usage might be 1648 bytes
5855 @end smallexample
5856 @item
5857 If the stack usage is (partly) dynamic and not bounded, it's:
5859 @smallexample
5860   warning: stack usage might be unbounded
5861 @end smallexample
5862 @end itemize
5864 @item -Wunsafe-loop-optimizations
5865 @opindex Wunsafe-loop-optimizations
5866 @opindex Wno-unsafe-loop-optimizations
5867 Warn if the loop cannot be optimized because the compiler cannot
5868 assume anything on the bounds of the loop indices.  With
5869 @option{-funsafe-loop-optimizations} warn if the compiler makes
5870 such assumptions.
5872 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5873 @opindex Wno-pedantic-ms-format
5874 @opindex Wpedantic-ms-format
5875 When used in combination with @option{-Wformat}
5876 and @option{-pedantic} without GNU extensions, this option
5877 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5878 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5879 which depend on the MS runtime.
5881 @item -Waligned-new
5882 @opindex Waligned-new
5883 @opindex Wno-aligned-new
5884 Warn about a new-expression of a type that requires greater alignment
5885 than the @code{alignof(std::max_align_t)} but uses an allocation
5886 function without an explicit alignment parameter. This option is
5887 enabled by @option{-Wall}.
5889 Normally this only warns about global allocation functions, but
5890 @option{-Waligned-new=all} also warns about class member allocation
5891 functions.
5893 @item -Wplacement-new
5894 @itemx -Wplacement-new=@var{n}
5895 @opindex Wplacement-new
5896 @opindex Wno-placement-new
5897 Warn about placement new expressions with undefined behavior, such as
5898 constructing an object in a buffer that is smaller than the type of
5899 the object.  For example, the placement new expression below is diagnosed
5900 because it attempts to construct an array of 64 integers in a buffer only
5901 64 bytes large.
5902 @smallexample
5903 char buf [64];
5904 new (buf) int[64];
5905 @end smallexample
5906 This warning is enabled by default.
5908 @table @gcctabopt
5909 @item -Wplacement-new=1
5910 This is the default warning level of @option{-Wplacement-new}.  At this
5911 level the warning is not issued for some strictly undefined constructs that
5912 GCC allows as extensions for compatibility with legacy code.  For example,
5913 the following @code{new} expression is not diagnosed at this level even
5914 though it has undefined behavior according to the C++ standard because
5915 it writes past the end of the one-element array.
5916 @smallexample
5917 struct S @{ int n, a[1]; @};
5918 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5919 new (s->a)int [32]();
5920 @end smallexample
5922 @item -Wplacement-new=2
5923 At this level, in addition to diagnosing all the same constructs as at level
5924 1, a diagnostic is also issued for placement new expressions that construct
5925 an object in the last member of structure whose type is an array of a single
5926 element and whose size is less than the size of the object being constructed.
5927 While the previous example would be diagnosed, the following construct makes
5928 use of the flexible member array extension to avoid the warning at level 2.
5929 @smallexample
5930 struct S @{ int n, a[]; @};
5931 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5932 new (s->a)int [32]();
5933 @end smallexample
5935 @end table
5937 @item -Wpointer-arith
5938 @opindex Wpointer-arith
5939 @opindex Wno-pointer-arith
5940 Warn about anything that depends on the ``size of'' a function type or
5941 of @code{void}.  GNU C assigns these types a size of 1, for
5942 convenience in calculations with @code{void *} pointers and pointers
5943 to functions.  In C++, warn also when an arithmetic operation involves
5944 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5946 @item -Wpointer-compare
5947 @opindex Wpointer-compare
5948 @opindex Wno-pointer-compare
5949 Warn if a pointer is compared with a zero character constant.  This usually
5950 means that the pointer was meant to be dereferenced.  For example:
5952 @smallexample
5953 const char *p = foo ();
5954 if (p == '\0')
5955   return 42;
5956 @end smallexample
5958 Note that the code above is invalid in C++11.
5960 This warning is enabled by default.
5962 @item -Wtype-limits
5963 @opindex Wtype-limits
5964 @opindex Wno-type-limits
5965 Warn if a comparison is always true or always false due to the limited
5966 range of the data type, but do not warn for constant expressions.  For
5967 example, warn if an unsigned variable is compared against zero with
5968 @code{<} or @code{>=}.  This warning is also enabled by
5969 @option{-Wextra}.
5971 @include cppwarnopts.texi
5973 @item -Wbad-function-cast @r{(C and Objective-C only)}
5974 @opindex Wbad-function-cast
5975 @opindex Wno-bad-function-cast
5976 Warn when a function call is cast to a non-matching type.
5977 For example, warn if a call to a function returning an integer type 
5978 is cast to a pointer type.
5980 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5981 @opindex Wc90-c99-compat
5982 @opindex Wno-c90-c99-compat
5983 Warn about features not present in ISO C90, but present in ISO C99.
5984 For instance, warn about use of variable length arrays, @code{long long}
5985 type, @code{bool} type, compound literals, designated initializers, and so
5986 on.  This option is independent of the standards mode.  Warnings are disabled
5987 in the expression that follows @code{__extension__}.
5989 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5990 @opindex Wc99-c11-compat
5991 @opindex Wno-c99-c11-compat
5992 Warn about features not present in ISO C99, but present in ISO C11.
5993 For instance, warn about use of anonymous structures and unions,
5994 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5995 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5996 and so on.  This option is independent of the standards mode.  Warnings are
5997 disabled in the expression that follows @code{__extension__}.
5999 @item -Wc++-compat @r{(C and Objective-C only)}
6000 @opindex Wc++-compat
6001 Warn about ISO C constructs that are outside of the common subset of
6002 ISO C and ISO C++, e.g.@: request for implicit conversion from
6003 @code{void *} to a pointer to non-@code{void} type.
6005 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
6006 @opindex Wc++11-compat
6007 Warn about C++ constructs whose meaning differs between ISO C++ 1998
6008 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
6009 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
6010 enabled by @option{-Wall}.
6012 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6013 @opindex Wc++14-compat
6014 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6015 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6017 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6018 @opindex Wc++17-compat
6019 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6020 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6022 @item -Wcast-qual
6023 @opindex Wcast-qual
6024 @opindex Wno-cast-qual
6025 Warn whenever a pointer is cast so as to remove a type qualifier from
6026 the target type.  For example, warn if a @code{const char *} is cast
6027 to an ordinary @code{char *}.
6029 Also warn when making a cast that introduces a type qualifier in an
6030 unsafe way.  For example, casting @code{char **} to @code{const char **}
6031 is unsafe, as in this example:
6033 @smallexample
6034   /* p is char ** value.  */
6035   const char **q = (const char **) p;
6036   /* Assignment of readonly string to const char * is OK.  */
6037   *q = "string";
6038   /* Now char** pointer points to read-only memory.  */
6039   **p = 'b';
6040 @end smallexample
6042 @item -Wcast-align
6043 @opindex Wcast-align
6044 @opindex Wno-cast-align
6045 Warn whenever a pointer is cast such that the required alignment of the
6046 target is increased.  For example, warn if a @code{char *} is cast to
6047 an @code{int *} on machines where integers can only be accessed at
6048 two- or four-byte boundaries.
6050 @item -Wcast-align=strict
6051 @opindex Wcast-align=strict
6052 Warn whenever a pointer is cast such that the required alignment of the
6053 target is increased.  For example, warn if a @code{char *} is cast to
6054 an @code{int *} regardless of the target machine.
6056 @item -Wcast-function-type
6057 @opindex Wcast-function-type
6058 @opindex Wno-cast-function-type
6059 Warn when a function pointer is cast to an incompatible function pointer.
6060 In a cast involving function types with a variable argument list only
6061 the types of initial arguments that are provided are considered.
6062 Any parameter of pointer-type matches any other pointer-type.  Any benign
6063 differences in integral types are ignored, like @code{int} vs. @code{long}
6064 on ILP32 targets.  Likewise type qualifiers are ignored.  The function
6065 type @code{void (*) (void)} is special and matches everything, which can
6066 be used to suppress this warning.
6067 In a cast involving pointer to member types this warning warns whenever
6068 the type cast is changing the pointer to member type.
6069 This warning is enabled by @option{-Wextra}.
6071 @item -Wwrite-strings
6072 @opindex Wwrite-strings
6073 @opindex Wno-write-strings
6074 When compiling C, give string constants the type @code{const
6075 char[@var{length}]} so that copying the address of one into a
6076 non-@code{const} @code{char *} pointer produces a warning.  These
6077 warnings help you find at compile time code that can try to write
6078 into a string constant, but only if you have been very careful about
6079 using @code{const} in declarations and prototypes.  Otherwise, it is
6080 just a nuisance. This is why we did not make @option{-Wall} request
6081 these warnings.
6083 When compiling C++, warn about the deprecated conversion from string
6084 literals to @code{char *}.  This warning is enabled by default for C++
6085 programs.
6087 @item -Wcatch-value
6088 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6089 @opindex Wcatch-value
6090 @opindex Wno-catch-value
6091 Warn about catch handlers that do not catch via reference.
6092 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6093 warn about polymorphic class types that are caught by value.
6094 With @option{-Wcatch-value=2} warn about all class types that are caught
6095 by value. With @option{-Wcatch-value=3} warn about all types that are
6096 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6098 @item -Wclobbered
6099 @opindex Wclobbered
6100 @opindex Wno-clobbered
6101 Warn for variables that might be changed by @code{longjmp} or
6102 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6104 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6105 @opindex Wconditionally-supported
6106 @opindex Wno-conditionally-supported
6107 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6109 @item -Wconversion
6110 @opindex Wconversion
6111 @opindex Wno-conversion
6112 Warn for implicit conversions that may alter a value. This includes
6113 conversions between real and integer, like @code{abs (x)} when
6114 @code{x} is @code{double}; conversions between signed and unsigned,
6115 like @code{unsigned ui = -1}; and conversions to smaller types, like
6116 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6117 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6118 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6119 conversions between signed and unsigned integers can be disabled by
6120 using @option{-Wno-sign-conversion}.
6122 For C++, also warn for confusing overload resolution for user-defined
6123 conversions; and conversions that never use a type conversion
6124 operator: conversions to @code{void}, the same type, a base class or a
6125 reference to them. Warnings about conversions between signed and
6126 unsigned integers are disabled by default in C++ unless
6127 @option{-Wsign-conversion} is explicitly enabled.
6129 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6130 @opindex Wconversion-null
6131 @opindex Wno-conversion-null
6132 Do not warn for conversions between @code{NULL} and non-pointer
6133 types. @option{-Wconversion-null} is enabled by default.
6135 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6136 @opindex Wzero-as-null-pointer-constant
6137 @opindex Wno-zero-as-null-pointer-constant
6138 Warn when a literal @samp{0} is used as null pointer constant.  This can
6139 be useful to facilitate the conversion to @code{nullptr} in C++11.
6141 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6142 @opindex Wsubobject-linkage
6143 @opindex Wno-subobject-linkage
6144 Warn if a class type has a base or a field whose type uses the anonymous
6145 namespace or depends on a type with no linkage.  If a type A depends on
6146 a type B with no or internal linkage, defining it in multiple
6147 translation units would be an ODR violation because the meaning of B
6148 is different in each translation unit.  If A only appears in a single
6149 translation unit, the best way to silence the warning is to give it
6150 internal linkage by putting it in an anonymous namespace as well.  The
6151 compiler doesn't give this warning for types defined in the main .C
6152 file, as those are unlikely to have multiple definitions.
6153 @option{-Wsubobject-linkage} is enabled by default.
6155 @item -Wdangling-else
6156 @opindex Wdangling-else
6157 @opindex Wno-dangling-else
6158 Warn about constructions where there may be confusion to which
6159 @code{if} statement an @code{else} branch belongs.  Here is an example of
6160 such a case:
6162 @smallexample
6163 @group
6165   if (a)
6166     if (b)
6167       foo ();
6168   else
6169     bar ();
6171 @end group
6172 @end smallexample
6174 In C/C++, every @code{else} branch belongs to the innermost possible
6175 @code{if} statement, which in this example is @code{if (b)}.  This is
6176 often not what the programmer expected, as illustrated in the above
6177 example by indentation the programmer chose.  When there is the
6178 potential for this confusion, GCC issues a warning when this flag
6179 is specified.  To eliminate the warning, add explicit braces around
6180 the innermost @code{if} statement so there is no way the @code{else}
6181 can belong to the enclosing @code{if}.  The resulting code
6182 looks like this:
6184 @smallexample
6185 @group
6187   if (a)
6188     @{
6189       if (b)
6190         foo ();
6191       else
6192         bar ();
6193     @}
6195 @end group
6196 @end smallexample
6198 This warning is enabled by @option{-Wparentheses}.
6200 @item -Wdate-time
6201 @opindex Wdate-time
6202 @opindex Wno-date-time
6203 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6204 are encountered as they might prevent bit-wise-identical reproducible
6205 compilations.
6207 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6208 @opindex Wdelete-incomplete
6209 @opindex Wno-delete-incomplete
6210 Warn when deleting a pointer to incomplete type, which may cause
6211 undefined behavior at runtime.  This warning is enabled by default.
6213 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6214 @opindex Wuseless-cast
6215 @opindex Wno-useless-cast
6216 Warn when an expression is casted to its own type.
6218 @item -Wempty-body
6219 @opindex Wempty-body
6220 @opindex Wno-empty-body
6221 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6222 while} statement.  This warning is also enabled by @option{-Wextra}.
6224 @item -Wenum-compare
6225 @opindex Wenum-compare
6226 @opindex Wno-enum-compare
6227 Warn about a comparison between values of different enumerated types.
6228 In C++ enumerated type mismatches in conditional expressions are also
6229 diagnosed and the warning is enabled by default.  In C this warning is 
6230 enabled by @option{-Wall}.
6232 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6233 @opindex Wextra-semi
6234 @opindex Wno-extra-semi
6235 Warn about redundant semicolon after in-class function definition.
6237 @item -Wjump-misses-init @r{(C, Objective-C only)}
6238 @opindex Wjump-misses-init
6239 @opindex Wno-jump-misses-init
6240 Warn if a @code{goto} statement or a @code{switch} statement jumps
6241 forward across the initialization of a variable, or jumps backward to a
6242 label after the variable has been initialized.  This only warns about
6243 variables that are initialized when they are declared.  This warning is
6244 only supported for C and Objective-C; in C++ this sort of branch is an
6245 error in any case.
6247 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6248 can be disabled with the @option{-Wno-jump-misses-init} option.
6250 @item -Wsign-compare
6251 @opindex Wsign-compare
6252 @opindex Wno-sign-compare
6253 @cindex warning for comparison of signed and unsigned values
6254 @cindex comparison of signed and unsigned values, warning
6255 @cindex signed and unsigned values, comparison warning
6256 Warn when a comparison between signed and unsigned values could produce
6257 an incorrect result when the signed value is converted to unsigned.
6258 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6259 also enabled by @option{-Wextra}.
6261 @item -Wsign-conversion
6262 @opindex Wsign-conversion
6263 @opindex Wno-sign-conversion
6264 Warn for implicit conversions that may change the sign of an integer
6265 value, like assigning a signed integer expression to an unsigned
6266 integer variable. An explicit cast silences the warning. In C, this
6267 option is enabled also by @option{-Wconversion}.
6269 @item -Wfloat-conversion
6270 @opindex Wfloat-conversion
6271 @opindex Wno-float-conversion
6272 Warn for implicit conversions that reduce the precision of a real value.
6273 This includes conversions from real to integer, and from higher precision
6274 real to lower precision real values.  This option is also enabled by
6275 @option{-Wconversion}.
6277 @item -Wno-scalar-storage-order
6278 @opindex -Wno-scalar-storage-order
6279 @opindex -Wscalar-storage-order
6280 Do not warn on suspicious constructs involving reverse scalar storage order.
6282 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6283 @opindex Wsized-deallocation
6284 @opindex Wno-sized-deallocation
6285 Warn about a definition of an unsized deallocation function
6286 @smallexample
6287 void operator delete (void *) noexcept;
6288 void operator delete[] (void *) noexcept;
6289 @end smallexample
6290 without a definition of the corresponding sized deallocation function
6291 @smallexample
6292 void operator delete (void *, std::size_t) noexcept;
6293 void operator delete[] (void *, std::size_t) noexcept;
6294 @end smallexample
6295 or vice versa.  Enabled by @option{-Wextra} along with
6296 @option{-fsized-deallocation}.
6298 @item -Wsizeof-pointer-div
6299 @opindex Wsizeof-pointer-div
6300 @opindex Wno-sizeof-pointer-div
6301 Warn for suspicious divisions of two sizeof expressions that divide
6302 the pointer size by the element size, which is the usual way to compute
6303 the array size but won't work out correctly with pointers.  This warning
6304 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6305 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6307 @item -Wsizeof-pointer-memaccess
6308 @opindex Wsizeof-pointer-memaccess
6309 @opindex Wno-sizeof-pointer-memaccess
6310 Warn for suspicious length parameters to certain string and memory built-in
6311 functions if the argument uses @code{sizeof}.  This warning triggers for
6312 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6313 an array, but a pointer, and suggests a possible fix, or about
6314 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6315 also warns about calls to bounded string copy functions like @code{strncat}
6316 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6317 the source array.  For example, in the following function the call to
6318 @code{strncat} specifies the size of the source string as the bound.  That
6319 is almost certainly a mistake and so the call is diagnosed.
6320 @smallexample
6321 void make_file (const char *name)
6323   char path[PATH_MAX];
6324   strncpy (path, name, sizeof path - 1);
6325   strncat (path, ".text", sizeof ".text");
6326   @dots{}
6328 @end smallexample
6330 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6332 @item -Wsizeof-array-argument
6333 @opindex Wsizeof-array-argument
6334 @opindex Wno-sizeof-array-argument
6335 Warn when the @code{sizeof} operator is applied to a parameter that is
6336 declared as an array in a function definition.  This warning is enabled by
6337 default for C and C++ programs.
6339 @item -Wmemset-elt-size
6340 @opindex Wmemset-elt-size
6341 @opindex Wno-memset-elt-size
6342 Warn for suspicious calls to the @code{memset} built-in function, if the
6343 first argument references an array, and the third argument is a number
6344 equal to the number of elements, but not equal to the size of the array
6345 in memory.  This indicates that the user has omitted a multiplication by
6346 the element size.  This warning is enabled by @option{-Wall}.
6348 @item -Wmemset-transposed-args
6349 @opindex Wmemset-transposed-args
6350 @opindex Wno-memset-transposed-args
6351 Warn for suspicious calls to the @code{memset} built-in function, if the
6352 second argument is not zero and the third argument is zero.  This warns e.g.@
6353 about @code{memset (buf, sizeof buf, 0)} where most probably
6354 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6355 is only emitted if the third argument is literal zero.  If it is some
6356 expression that is folded to zero, a cast of zero to some type, etc., 
6357 it is far less likely that the user has mistakenly exchanged the arguments 
6358 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6360 @item -Waddress
6361 @opindex Waddress
6362 @opindex Wno-address
6363 Warn about suspicious uses of memory addresses. These include using
6364 the address of a function in a conditional expression, such as
6365 @code{void func(void); if (func)}, and comparisons against the memory
6366 address of a string literal, such as @code{if (x == "abc")}.  Such
6367 uses typically indicate a programmer error: the address of a function
6368 always evaluates to true, so their use in a conditional usually
6369 indicate that the programmer forgot the parentheses in a function
6370 call; and comparisons against string literals result in unspecified
6371 behavior and are not portable in C, so they usually indicate that the
6372 programmer intended to use @code{strcmp}.  This warning is enabled by
6373 @option{-Wall}.
6375 @item -Wlogical-op
6376 @opindex Wlogical-op
6377 @opindex Wno-logical-op
6378 Warn about suspicious uses of logical operators in expressions.
6379 This includes using logical operators in contexts where a
6380 bit-wise operator is likely to be expected.  Also warns when
6381 the operands of a logical operator are the same:
6382 @smallexample
6383 extern int a;
6384 if (a < 0 && a < 0) @{ @dots{} @}
6385 @end smallexample
6387 @item -Wlogical-not-parentheses
6388 @opindex Wlogical-not-parentheses
6389 @opindex Wno-logical-not-parentheses
6390 Warn about logical not used on the left hand side operand of a comparison.
6391 This option does not warn if the right operand is considered to be a boolean
6392 expression.  Its purpose is to detect suspicious code like the following:
6393 @smallexample
6394 int a;
6395 @dots{}
6396 if (!a > 1) @{ @dots{} @}
6397 @end smallexample
6399 It is possible to suppress the warning by wrapping the LHS into
6400 parentheses:
6401 @smallexample
6402 if ((!a) > 1) @{ @dots{} @}
6403 @end smallexample
6405 This warning is enabled by @option{-Wall}.
6407 @item -Waggregate-return
6408 @opindex Waggregate-return
6409 @opindex Wno-aggregate-return
6410 Warn if any functions that return structures or unions are defined or
6411 called.  (In languages where you can return an array, this also elicits
6412 a warning.)
6414 @item -Wno-aggressive-loop-optimizations
6415 @opindex Wno-aggressive-loop-optimizations
6416 @opindex Waggressive-loop-optimizations
6417 Warn if in a loop with constant number of iterations the compiler detects
6418 undefined behavior in some statement during one or more of the iterations.
6420 @item -Wno-attributes
6421 @opindex Wno-attributes
6422 @opindex Wattributes
6423 Do not warn if an unexpected @code{__attribute__} is used, such as
6424 unrecognized attributes, function attributes applied to variables,
6425 etc.  This does not stop errors for incorrect use of supported
6426 attributes.
6428 @item -Wno-builtin-declaration-mismatch
6429 @opindex Wno-builtin-declaration-mismatch
6430 @opindex Wbuiltin-declaration-mismatch
6431 Warn if a built-in function is declared with the wrong signature or 
6432 as non-function.
6433 This warning is enabled by default.
6435 @item -Wno-builtin-macro-redefined
6436 @opindex Wno-builtin-macro-redefined
6437 @opindex Wbuiltin-macro-redefined
6438 Do not warn if certain built-in macros are redefined.  This suppresses
6439 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6440 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6442 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6443 @opindex Wstrict-prototypes
6444 @opindex Wno-strict-prototypes
6445 Warn if a function is declared or defined without specifying the
6446 argument types.  (An old-style function definition is permitted without
6447 a warning if preceded by a declaration that specifies the argument
6448 types.)
6450 @item -Wold-style-declaration @r{(C and Objective-C only)}
6451 @opindex Wold-style-declaration
6452 @opindex Wno-old-style-declaration
6453 Warn for obsolescent usages, according to the C Standard, in a
6454 declaration. For example, warn if storage-class specifiers like
6455 @code{static} are not the first things in a declaration.  This warning
6456 is also enabled by @option{-Wextra}.
6458 @item -Wold-style-definition @r{(C and Objective-C only)}
6459 @opindex Wold-style-definition
6460 @opindex Wno-old-style-definition
6461 Warn if an old-style function definition is used.  A warning is given
6462 even if there is a previous prototype.
6464 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6465 @opindex Wmissing-parameter-type
6466 @opindex Wno-missing-parameter-type
6467 A function parameter is declared without a type specifier in K&R-style
6468 functions:
6470 @smallexample
6471 void foo(bar) @{ @}
6472 @end smallexample
6474 This warning is also enabled by @option{-Wextra}.
6476 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6477 @opindex Wmissing-prototypes
6478 @opindex Wno-missing-prototypes
6479 Warn if a global function is defined without a previous prototype
6480 declaration.  This warning is issued even if the definition itself
6481 provides a prototype.  Use this option to detect global functions
6482 that do not have a matching prototype declaration in a header file.
6483 This option is not valid for C++ because all function declarations
6484 provide prototypes and a non-matching declaration declares an
6485 overload rather than conflict with an earlier declaration.
6486 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6488 @item -Wmissing-declarations
6489 @opindex Wmissing-declarations
6490 @opindex Wno-missing-declarations
6491 Warn if a global function is defined without a previous declaration.
6492 Do so even if the definition itself provides a prototype.
6493 Use this option to detect global functions that are not declared in
6494 header files.  In C, no warnings are issued for functions with previous
6495 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6496 missing prototypes.  In C++, no warnings are issued for function templates,
6497 or for inline functions, or for functions in anonymous namespaces.
6499 @item -Wmissing-field-initializers
6500 @opindex Wmissing-field-initializers
6501 @opindex Wno-missing-field-initializers
6502 @opindex W
6503 @opindex Wextra
6504 @opindex Wno-extra
6505 Warn if a structure's initializer has some fields missing.  For
6506 example, the following code causes such a warning, because
6507 @code{x.h} is implicitly zero:
6509 @smallexample
6510 struct s @{ int f, g, h; @};
6511 struct s x = @{ 3, 4 @};
6512 @end smallexample
6514 This option does not warn about designated initializers, so the following
6515 modification does not trigger a warning:
6517 @smallexample
6518 struct s @{ int f, g, h; @};
6519 struct s x = @{ .f = 3, .g = 4 @};
6520 @end smallexample
6522 In C this option does not warn about the universal zero initializer
6523 @samp{@{ 0 @}}:
6525 @smallexample
6526 struct s @{ int f, g, h; @};
6527 struct s x = @{ 0 @};
6528 @end smallexample
6530 Likewise, in C++ this option does not warn about the empty @{ @}
6531 initializer, for example:
6533 @smallexample
6534 struct s @{ int f, g, h; @};
6535 s x = @{ @};
6536 @end smallexample
6538 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6539 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6541 @item -Wno-multichar
6542 @opindex Wno-multichar
6543 @opindex Wmultichar
6544 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6545 Usually they indicate a typo in the user's code, as they have
6546 implementation-defined values, and should not be used in portable code.
6548 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6549 @opindex Wnormalized=
6550 @opindex Wnormalized
6551 @opindex Wno-normalized
6552 @cindex NFC
6553 @cindex NFKC
6554 @cindex character set, input normalization
6555 In ISO C and ISO C++, two identifiers are different if they are
6556 different sequences of characters.  However, sometimes when characters
6557 outside the basic ASCII character set are used, you can have two
6558 different character sequences that look the same.  To avoid confusion,
6559 the ISO 10646 standard sets out some @dfn{normalization rules} which
6560 when applied ensure that two sequences that look the same are turned into
6561 the same sequence.  GCC can warn you if you are using identifiers that
6562 have not been normalized; this option controls that warning.
6564 There are four levels of warning supported by GCC@.  The default is
6565 @option{-Wnormalized=nfc}, which warns about any identifier that is
6566 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6567 recommended form for most uses.  It is equivalent to
6568 @option{-Wnormalized}.
6570 Unfortunately, there are some characters allowed in identifiers by
6571 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6572 identifiers.  That is, there's no way to use these symbols in portable
6573 ISO C or C++ and have all your identifiers in NFC@.
6574 @option{-Wnormalized=id} suppresses the warning for these characters.
6575 It is hoped that future versions of the standards involved will correct
6576 this, which is why this option is not the default.
6578 You can switch the warning off for all characters by writing
6579 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6580 only do this if you are using some other normalization scheme (like
6581 ``D''), because otherwise you can easily create bugs that are
6582 literally impossible to see.
6584 Some characters in ISO 10646 have distinct meanings but look identical
6585 in some fonts or display methodologies, especially once formatting has
6586 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6587 LETTER N'', displays just like a regular @code{n} that has been
6588 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6589 normalization scheme to convert all these into a standard form as
6590 well, and GCC warns if your code is not in NFKC if you use
6591 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6592 about every identifier that contains the letter O because it might be
6593 confused with the digit 0, and so is not the default, but may be
6594 useful as a local coding convention if the programming environment 
6595 cannot be fixed to display these characters distinctly.
6597 @item -Wno-deprecated
6598 @opindex Wno-deprecated
6599 @opindex Wdeprecated
6600 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6602 @item -Wno-deprecated-declarations
6603 @opindex Wno-deprecated-declarations
6604 @opindex Wdeprecated-declarations
6605 Do not warn about uses of functions (@pxref{Function Attributes}),
6606 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6607 Attributes}) marked as deprecated by using the @code{deprecated}
6608 attribute.
6610 @item -Wno-overflow
6611 @opindex Wno-overflow
6612 @opindex Woverflow
6613 Do not warn about compile-time overflow in constant expressions.
6615 @item -Wno-odr
6616 @opindex Wno-odr
6617 @opindex Wodr
6618 Warn about One Definition Rule violations during link-time optimization.
6619 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6621 @item -Wopenmp-simd
6622 @opindex Wopenm-simd
6623 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6624 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6625 option can be used to relax the cost model.
6627 @item -Woverride-init @r{(C and Objective-C only)}
6628 @opindex Woverride-init
6629 @opindex Wno-override-init
6630 @opindex W
6631 @opindex Wextra
6632 @opindex Wno-extra
6633 Warn if an initialized field without side effects is overridden when
6634 using designated initializers (@pxref{Designated Inits, , Designated
6635 Initializers}).
6637 This warning is included in @option{-Wextra}.  To get other
6638 @option{-Wextra} warnings without this one, use @option{-Wextra
6639 -Wno-override-init}.
6641 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6642 @opindex Woverride-init-side-effects
6643 @opindex Wno-override-init-side-effects
6644 Warn if an initialized field with side effects is overridden when
6645 using designated initializers (@pxref{Designated Inits, , Designated
6646 Initializers}).  This warning is enabled by default.
6648 @item -Wpacked
6649 @opindex Wpacked
6650 @opindex Wno-packed
6651 Warn if a structure is given the packed attribute, but the packed
6652 attribute has no effect on the layout or size of the structure.
6653 Such structures may be mis-aligned for little benefit.  For
6654 instance, in this code, the variable @code{f.x} in @code{struct bar}
6655 is misaligned even though @code{struct bar} does not itself
6656 have the packed attribute:
6658 @smallexample
6659 @group
6660 struct foo @{
6661   int x;
6662   char a, b, c, d;
6663 @} __attribute__((packed));
6664 struct bar @{
6665   char z;
6666   struct foo f;
6668 @end group
6669 @end smallexample
6671 @item -Wpacked-bitfield-compat
6672 @opindex Wpacked-bitfield-compat
6673 @opindex Wno-packed-bitfield-compat
6674 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6675 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6676 the change can lead to differences in the structure layout.  GCC
6677 informs you when the offset of such a field has changed in GCC 4.4.
6678 For example there is no longer a 4-bit padding between field @code{a}
6679 and @code{b} in this structure:
6681 @smallexample
6682 struct foo
6684   char a:4;
6685   char b:8;
6686 @} __attribute__ ((packed));
6687 @end smallexample
6689 This warning is enabled by default.  Use
6690 @option{-Wno-packed-bitfield-compat} to disable this warning.
6692 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6693 @opindex Wpacked-not-aligned
6694 @opindex Wno-packed-not-aligned
6695 Warn if a structure field with explicitly specified alignment in a
6696 packed struct or union is misaligned.  For example, a warning will
6697 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6698 'struct S' is less than 8}, in this code:
6700 @smallexample
6701 @group
6702 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6703 struct __attribute__ ((packed)) S @{
6704   struct S8 s8;
6706 @end group
6707 @end smallexample
6709 This warning is enabled by @option{-Wall}.
6711 @item -Wpadded
6712 @opindex Wpadded
6713 @opindex Wno-padded
6714 Warn if padding is included in a structure, either to align an element
6715 of the structure or to align the whole structure.  Sometimes when this
6716 happens it is possible to rearrange the fields of the structure to
6717 reduce the padding and so make the structure smaller.
6719 @item -Wredundant-decls
6720 @opindex Wredundant-decls
6721 @opindex Wno-redundant-decls
6722 Warn if anything is declared more than once in the same scope, even in
6723 cases where multiple declaration is valid and changes nothing.
6725 @item -Wno-restrict
6726 @opindex Wrestrict
6727 @opindex Wno-restrict
6728 Warn when an object referenced by a @code{restrict}-qualified parameter
6729 (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
6730 argument, or when copies between such objects overlap.  For example,
6731 the call to the @code{strcpy} function below attempts to truncate the string
6732 by replacing its initial characters with the last four.  However, because
6733 the call writes the terminating NUL into @code{a[4]}, the copies overlap and
6734 the call is diagnosed.
6736 @smallexample
6737 struct foo
6739   char a[] = "abcd1234";
6740   strcpy (a, a + 4);
6742 @end smallexample
6743 The @option{-Wrestrict} is included in @option{-Wall}.
6745 @item -Wnested-externs @r{(C and Objective-C only)}
6746 @opindex Wnested-externs
6747 @opindex Wno-nested-externs
6748 Warn if an @code{extern} declaration is encountered within a function.
6750 @item -Wno-inherited-variadic-ctor
6751 @opindex Winherited-variadic-ctor
6752 @opindex Wno-inherited-variadic-ctor
6753 Suppress warnings about use of C++11 inheriting constructors when the
6754 base class inherited from has a C variadic constructor; the warning is
6755 on by default because the ellipsis is not inherited.
6757 @item -Winline
6758 @opindex Winline
6759 @opindex Wno-inline
6760 Warn if a function that is declared as inline cannot be inlined.
6761 Even with this option, the compiler does not warn about failures to
6762 inline functions declared in system headers.
6764 The compiler uses a variety of heuristics to determine whether or not
6765 to inline a function.  For example, the compiler takes into account
6766 the size of the function being inlined and the amount of inlining
6767 that has already been done in the current function.  Therefore,
6768 seemingly insignificant changes in the source program can cause the
6769 warnings produced by @option{-Winline} to appear or disappear.
6771 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6772 @opindex Wno-invalid-offsetof
6773 @opindex Winvalid-offsetof
6774 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6775 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6776 to a non-standard-layout type is undefined.  In existing C++ implementations,
6777 however, @code{offsetof} typically gives meaningful results.
6778 This flag is for users who are aware that they are
6779 writing nonportable code and who have deliberately chosen to ignore the
6780 warning about it.
6782 The restrictions on @code{offsetof} may be relaxed in a future version
6783 of the C++ standard.
6785 @item -Wint-in-bool-context
6786 @opindex Wint-in-bool-context
6787 @opindex Wno-int-in-bool-context
6788 Warn for suspicious use of integer values where boolean values are expected,
6789 such as conditional expressions (?:) using non-boolean integer constants in
6790 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6791 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6792 for all kinds of multiplications regardless of the data type.
6793 This warning is enabled by @option{-Wall}.
6795 @item -Wno-int-to-pointer-cast
6796 @opindex Wno-int-to-pointer-cast
6797 @opindex Wint-to-pointer-cast
6798 Suppress warnings from casts to pointer type of an integer of a
6799 different size. In C++, casting to a pointer type of smaller size is
6800 an error. @option{Wint-to-pointer-cast} is enabled by default.
6803 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6804 @opindex Wno-pointer-to-int-cast
6805 @opindex Wpointer-to-int-cast
6806 Suppress warnings from casts from a pointer to an integer type of a
6807 different size.
6809 @item -Winvalid-pch
6810 @opindex Winvalid-pch
6811 @opindex Wno-invalid-pch
6812 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6813 the search path but cannot be used.
6815 @item -Wlong-long
6816 @opindex Wlong-long
6817 @opindex Wno-long-long
6818 Warn if @code{long long} type is used.  This is enabled by either
6819 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6820 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6822 @item -Wvariadic-macros
6823 @opindex Wvariadic-macros
6824 @opindex Wno-variadic-macros
6825 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6826 alternate syntax is used in ISO C99 mode.  This is enabled by either
6827 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6828 messages, use @option{-Wno-variadic-macros}.
6830 @item -Wvarargs
6831 @opindex Wvarargs
6832 @opindex Wno-varargs
6833 Warn upon questionable usage of the macros used to handle variable
6834 arguments like @code{va_start}.  This is default.  To inhibit the
6835 warning messages, use @option{-Wno-varargs}.
6837 @item -Wvector-operation-performance
6838 @opindex Wvector-operation-performance
6839 @opindex Wno-vector-operation-performance
6840 Warn if vector operation is not implemented via SIMD capabilities of the
6841 architecture.  Mainly useful for the performance tuning.
6842 Vector operation can be implemented @code{piecewise}, which means that the
6843 scalar operation is performed on every vector element; 
6844 @code{in parallel}, which means that the vector operation is implemented
6845 using scalars of wider type, which normally is more performance efficient;
6846 and @code{as a single scalar}, which means that vector fits into a
6847 scalar type.
6849 @item -Wno-virtual-move-assign
6850 @opindex Wvirtual-move-assign
6851 @opindex Wno-virtual-move-assign
6852 Suppress warnings about inheriting from a virtual base with a
6853 non-trivial C++11 move assignment operator.  This is dangerous because
6854 if the virtual base is reachable along more than one path, it is
6855 moved multiple times, which can mean both objects end up in the
6856 moved-from state.  If the move assignment operator is written to avoid
6857 moving from a moved-from object, this warning can be disabled.
6859 @item -Wvla
6860 @opindex Wvla
6861 @opindex Wno-vla
6862 Warn if a variable-length array is used in the code.
6863 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6864 the variable-length array.
6866 @item -Wvla-larger-than=@var{n}
6867 If this option is used, the compiler will warn on uses of
6868 variable-length arrays where the size is either unbounded, or bounded
6869 by an argument that can be larger than @var{n} bytes.  This is similar
6870 to how @option{-Walloca-larger-than=@var{n}} works, but with
6871 variable-length arrays.
6873 Note that GCC may optimize small variable-length arrays of a known
6874 value into plain arrays, so this warning may not get triggered for
6875 such arrays.
6877 This warning is not enabled by @option{-Wall}, and is only active when
6878 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6880 See also @option{-Walloca-larger-than=@var{n}}.
6882 @item -Wvolatile-register-var
6883 @opindex Wvolatile-register-var
6884 @opindex Wno-volatile-register-var
6885 Warn if a register variable is declared volatile.  The volatile
6886 modifier does not inhibit all optimizations that may eliminate reads
6887 and/or writes to register variables.  This warning is enabled by
6888 @option{-Wall}.
6890 @item -Wdisabled-optimization
6891 @opindex Wdisabled-optimization
6892 @opindex Wno-disabled-optimization
6893 Warn if a requested optimization pass is disabled.  This warning does
6894 not generally indicate that there is anything wrong with your code; it
6895 merely indicates that GCC's optimizers are unable to handle the code
6896 effectively.  Often, the problem is that your code is too big or too
6897 complex; GCC refuses to optimize programs when the optimization
6898 itself is likely to take inordinate amounts of time.
6900 @item -Wpointer-sign @r{(C and Objective-C only)}
6901 @opindex Wpointer-sign
6902 @opindex Wno-pointer-sign
6903 Warn for pointer argument passing or assignment with different signedness.
6904 This option is only supported for C and Objective-C@.  It is implied by
6905 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6906 @option{-Wno-pointer-sign}.
6908 @item -Wstack-protector
6909 @opindex Wstack-protector
6910 @opindex Wno-stack-protector
6911 This option is only active when @option{-fstack-protector} is active.  It
6912 warns about functions that are not protected against stack smashing.
6914 @item -Woverlength-strings
6915 @opindex Woverlength-strings
6916 @opindex Wno-overlength-strings
6917 Warn about string constants that are longer than the ``minimum
6918 maximum'' length specified in the C standard.  Modern compilers
6919 generally allow string constants that are much longer than the
6920 standard's minimum limit, but very portable programs should avoid
6921 using longer strings.
6923 The limit applies @emph{after} string constant concatenation, and does
6924 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6925 C99, it was raised to 4095.  C++98 does not specify a normative
6926 minimum maximum, so we do not diagnose overlength strings in C++@.
6928 This option is implied by @option{-Wpedantic}, and can be disabled with
6929 @option{-Wno-overlength-strings}.
6931 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6932 @opindex Wunsuffixed-float-constants
6934 Issue a warning for any floating constant that does not have
6935 a suffix.  When used together with @option{-Wsystem-headers} it
6936 warns about such constants in system header files.  This can be useful
6937 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6938 from the decimal floating-point extension to C99.
6940 @item -Wno-designated-init @r{(C and Objective-C only)}
6941 Suppress warnings when a positional initializer is used to initialize
6942 a structure that has been marked with the @code{designated_init}
6943 attribute.
6945 @item -Whsa
6946 Issue a warning when HSAIL cannot be emitted for the compiled function or
6947 OpenMP construct.
6949 @end table
6951 @node Debugging Options
6952 @section Options for Debugging Your Program
6953 @cindex options, debugging
6954 @cindex debugging information options
6956 To tell GCC to emit extra information for use by a debugger, in almost 
6957 all cases you need only to add @option{-g} to your other options.
6959 GCC allows you to use @option{-g} with
6960 @option{-O}.  The shortcuts taken by optimized code may occasionally
6961 be surprising: some variables you declared may not exist
6962 at all; flow of control may briefly move where you did not expect it;
6963 some statements may not be executed because they compute constant
6964 results or their values are already at hand; some statements may
6965 execute in different places because they have been moved out of loops.
6966 Nevertheless it is possible to debug optimized output.  This makes
6967 it reasonable to use the optimizer for programs that might have bugs.
6969 If you are not using some other optimization option, consider
6970 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6971 With no @option{-O} option at all, some compiler passes that collect
6972 information useful for debugging do not run at all, so that
6973 @option{-Og} may result in a better debugging experience.
6975 @table @gcctabopt
6976 @item -g
6977 @opindex g
6978 Produce debugging information in the operating system's native format
6979 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6980 information.
6982 On most systems that use stabs format, @option{-g} enables use of extra
6983 debugging information that only GDB can use; this extra information
6984 makes debugging work better in GDB but probably makes other debuggers
6985 crash or
6986 refuse to read the program.  If you want to control for certain whether
6987 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6988 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6990 @item -ggdb
6991 @opindex ggdb
6992 Produce debugging information for use by GDB@.  This means to use the
6993 most expressive format available (DWARF, stabs, or the native format
6994 if neither of those are supported), including GDB extensions if at all
6995 possible.
6997 @item -gdwarf
6998 @itemx -gdwarf-@var{version}
6999 @opindex gdwarf
7000 Produce debugging information in DWARF format (if that is supported).
7001 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7002 for most targets is 4.  DWARF Version 5 is only experimental.
7004 Note that with DWARF Version 2, some ports require and always
7005 use some non-conflicting DWARF 3 extensions in the unwind tables.
7007 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7008 for maximum benefit.
7010 GCC no longer supports DWARF Version 1, which is substantially
7011 different than Version 2 and later.  For historical reasons, some
7012 other DWARF-related options such as
7013 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7014 in their names, but apply to all currently-supported versions of DWARF.
7016 @item -gstabs
7017 @opindex gstabs
7018 Produce debugging information in stabs format (if that is supported),
7019 without GDB extensions.  This is the format used by DBX on most BSD
7020 systems.  On MIPS, Alpha and System V Release 4 systems this option
7021 produces stabs debugging output that is not understood by DBX@.
7022 On System V Release 4 systems this option requires the GNU assembler.
7024 @item -gstabs+
7025 @opindex gstabs+
7026 Produce debugging information in stabs format (if that is supported),
7027 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7028 use of these extensions is likely to make other debuggers crash or
7029 refuse to read the program.
7031 @item -gxcoff
7032 @opindex gxcoff
7033 Produce debugging information in XCOFF format (if that is supported).
7034 This is the format used by the DBX debugger on IBM RS/6000 systems.
7036 @item -gxcoff+
7037 @opindex gxcoff+
7038 Produce debugging information in XCOFF format (if that is supported),
7039 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7040 use of these extensions is likely to make other debuggers crash or
7041 refuse to read the program, and may cause assemblers other than the GNU
7042 assembler (GAS) to fail with an error.
7044 @item -gvms
7045 @opindex gvms
7046 Produce debugging information in Alpha/VMS debug format (if that is
7047 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7049 @item -g@var{level}
7050 @itemx -ggdb@var{level}
7051 @itemx -gstabs@var{level}
7052 @itemx -gxcoff@var{level}
7053 @itemx -gvms@var{level}
7054 Request debugging information and also use @var{level} to specify how
7055 much information.  The default level is 2.
7057 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7058 @option{-g}.
7060 Level 1 produces minimal information, enough for making backtraces in
7061 parts of the program that you don't plan to debug.  This includes
7062 descriptions of functions and external variables, and line number
7063 tables, but no information about local variables.
7065 Level 3 includes extra information, such as all the macro definitions
7066 present in the program.  Some debuggers support macro expansion when
7067 you use @option{-g3}.
7069 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7070 confusion with @option{-gdwarf-@var{level}}.
7071 Instead use an additional @option{-g@var{level}} option to change the
7072 debug level for DWARF.
7074 @item -feliminate-unused-debug-symbols
7075 @opindex feliminate-unused-debug-symbols
7076 Produce debugging information in stabs format (if that is supported),
7077 for only symbols that are actually used.
7079 @item -femit-class-debug-always
7080 @opindex femit-class-debug-always
7081 Instead of emitting debugging information for a C++ class in only one
7082 object file, emit it in all object files using the class.  This option
7083 should be used only with debuggers that are unable to handle the way GCC
7084 normally emits debugging information for classes because using this
7085 option increases the size of debugging information by as much as a
7086 factor of two.
7088 @item -fno-merge-debug-strings
7089 @opindex fmerge-debug-strings
7090 @opindex fno-merge-debug-strings
7091 Direct the linker to not merge together strings in the debugging
7092 information that are identical in different object files.  Merging is
7093 not supported by all assemblers or linkers.  Merging decreases the size
7094 of the debug information in the output file at the cost of increasing
7095 link processing time.  Merging is enabled by default.
7097 @item -fdebug-prefix-map=@var{old}=@var{new}
7098 @opindex fdebug-prefix-map
7099 When compiling files in directory @file{@var{old}}, record debugging
7100 information describing them as in @file{@var{new}} instead.  This can be
7101 used to replace a build-time path with an install-time path in the debug info.
7102 It can also be used to change an absolute path to a relative path by using
7103 @file{.} for @var{new}.  This can give more reproducible builds, which are
7104 location independent, but may require an extra command to tell GDB where to
7105 find the source files.
7107 @item -fvar-tracking
7108 @opindex fvar-tracking
7109 Run variable tracking pass.  It computes where variables are stored at each
7110 position in code.  Better debugging information is then generated
7111 (if the debugging information format supports this information).
7113 It is enabled by default when compiling with optimization (@option{-Os},
7114 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7115 the debug info format supports it.
7117 @item -fvar-tracking-assignments
7118 @opindex fvar-tracking-assignments
7119 @opindex fno-var-tracking-assignments
7120 Annotate assignments to user variables early in the compilation and
7121 attempt to carry the annotations over throughout the compilation all the
7122 way to the end, in an attempt to improve debug information while
7123 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7125 It can be enabled even if var-tracking is disabled, in which case
7126 annotations are created and maintained, but discarded at the end.
7127 By default, this flag is enabled together with @option{-fvar-tracking},
7128 except when selective scheduling is enabled.
7130 @item -gsplit-dwarf
7131 @opindex gsplit-dwarf
7132 Separate as much DWARF debugging information as possible into a
7133 separate output file with the extension @file{.dwo}.  This option allows
7134 the build system to avoid linking files with debug information.  To
7135 be useful, this option requires a debugger capable of reading @file{.dwo}
7136 files.
7138 @item -gpubnames
7139 @opindex gpubnames
7140 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7142 @item -ggnu-pubnames
7143 @opindex ggnu-pubnames
7144 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7145 suitable for conversion into a GDB@ index.  This option is only useful
7146 with a linker that can produce GDB@ index version 7.
7148 @item -fdebug-types-section
7149 @opindex fdebug-types-section
7150 @opindex fno-debug-types-section
7151 When using DWARF Version 4 or higher, type DIEs can be put into
7152 their own @code{.debug_types} section instead of making them part of the
7153 @code{.debug_info} section.  It is more efficient to put them in a separate
7154 comdat sections since the linker can then remove duplicates.
7155 But not all DWARF consumers support @code{.debug_types} sections yet
7156 and on some objects @code{.debug_types} produces larger instead of smaller
7157 debugging information.
7159 @item -grecord-gcc-switches
7160 @item -gno-record-gcc-switches
7161 @opindex grecord-gcc-switches
7162 @opindex gno-record-gcc-switches
7163 This switch causes the command-line options used to invoke the
7164 compiler that may affect code generation to be appended to the
7165 DW_AT_producer attribute in DWARF debugging information.  The options
7166 are concatenated with spaces separating them from each other and from
7167 the compiler version.  
7168 It is enabled by default.
7169 See also @option{-frecord-gcc-switches} for another
7170 way of storing compiler options into the object file.  
7172 @item -gstrict-dwarf
7173 @opindex gstrict-dwarf
7174 Disallow using extensions of later DWARF standard version than selected
7175 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7176 DWARF extensions from later standard versions is allowed.
7178 @item -gno-strict-dwarf
7179 @opindex gno-strict-dwarf
7180 Allow using extensions of later DWARF standard version than selected with
7181 @option{-gdwarf-@var{version}}.
7183 @item -gcolumn-info
7184 @item -gno-column-info
7185 @opindex gcolumn-info
7186 @opindex gno-column-info
7187 Emit location column information into DWARF debugging information, rather
7188 than just file and line.
7189 This option is enabled by default.
7191 @item -gstatement-frontiers
7192 @item -gno-statement-frontiers
7193 @opindex gstatement-frontiers
7194 @opindex gno-statement-frontiers
7195 This option causes GCC to create markers in the internal representation
7196 at the beginning of statements, and to keep them roughly in place
7197 throughout compilation, using them to guide the output of @code{is_stmt}
7198 markers in the line number table.  This is enabled by default when
7199 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7200 @dots{}), and outputting DWARF 2 debug information at the normal level.
7202 @item -gz@r{[}=@var{type}@r{]}
7203 @opindex gz
7204 Produce compressed debug sections in DWARF format, if that is supported.
7205 If @var{type} is not given, the default type depends on the capabilities
7206 of the assembler and linker used.  @var{type} may be one of
7207 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7208 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7209 compression in traditional GNU format).  If the linker doesn't support
7210 writing compressed debug sections, the option is rejected.  Otherwise,
7211 if the assembler does not support them, @option{-gz} is silently ignored
7212 when producing object files.
7214 @item -femit-struct-debug-baseonly
7215 @opindex femit-struct-debug-baseonly
7216 Emit debug information for struct-like types
7217 only when the base name of the compilation source file
7218 matches the base name of file in which the struct is defined.
7220 This option substantially reduces the size of debugging information,
7221 but at significant potential loss in type information to the debugger.
7222 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7223 See @option{-femit-struct-debug-detailed} for more detailed control.
7225 This option works only with DWARF debug output.
7227 @item -femit-struct-debug-reduced
7228 @opindex femit-struct-debug-reduced
7229 Emit debug information for struct-like types
7230 only when the base name of the compilation source file
7231 matches the base name of file in which the type is defined,
7232 unless the struct is a template or defined in a system header.
7234 This option significantly reduces the size of debugging information,
7235 with some potential loss in type information to the debugger.
7236 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7237 See @option{-femit-struct-debug-detailed} for more detailed control.
7239 This option works only with DWARF debug output.
7241 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7242 @opindex femit-struct-debug-detailed
7243 Specify the struct-like types
7244 for which the compiler generates debug information.
7245 The intent is to reduce duplicate struct debug information
7246 between different object files within the same program.
7248 This option is a detailed version of
7249 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7250 which serves for most needs.
7252 A specification has the syntax@*
7253 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7255 The optional first word limits the specification to
7256 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7257 A struct type is used directly when it is the type of a variable, member.
7258 Indirect uses arise through pointers to structs.
7259 That is, when use of an incomplete struct is valid, the use is indirect.
7260 An example is
7261 @samp{struct one direct; struct two * indirect;}.
7263 The optional second word limits the specification to
7264 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7265 Generic structs are a bit complicated to explain.
7266 For C++, these are non-explicit specializations of template classes,
7267 or non-template classes within the above.
7268 Other programming languages have generics,
7269 but @option{-femit-struct-debug-detailed} does not yet implement them.
7271 The third word specifies the source files for those
7272 structs for which the compiler should emit debug information.
7273 The values @samp{none} and @samp{any} have the normal meaning.
7274 The value @samp{base} means that
7275 the base of name of the file in which the type declaration appears
7276 must match the base of the name of the main compilation file.
7277 In practice, this means that when compiling @file{foo.c}, debug information
7278 is generated for types declared in that file and @file{foo.h},
7279 but not other header files.
7280 The value @samp{sys} means those types satisfying @samp{base}
7281 or declared in system or compiler headers.
7283 You may need to experiment to determine the best settings for your application.
7285 The default is @option{-femit-struct-debug-detailed=all}.
7287 This option works only with DWARF debug output.
7289 @item -fno-dwarf2-cfi-asm
7290 @opindex fdwarf2-cfi-asm
7291 @opindex fno-dwarf2-cfi-asm
7292 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7293 instead of using GAS @code{.cfi_*} directives.
7295 @item -fno-eliminate-unused-debug-types
7296 @opindex feliminate-unused-debug-types
7297 @opindex fno-eliminate-unused-debug-types
7298 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7299 output for types that are nowhere used in the source file being compiled.
7300 Sometimes it is useful to have GCC emit debugging
7301 information for all types declared in a compilation
7302 unit, regardless of whether or not they are actually used
7303 in that compilation unit, for example 
7304 if, in the debugger, you want to cast a value to a type that is
7305 not actually used in your program (but is declared).  More often,
7306 however, this results in a significant amount of wasted space.
7307 @end table
7309 @node Optimize Options
7310 @section Options That Control Optimization
7311 @cindex optimize options
7312 @cindex options, optimization
7314 These options control various sorts of optimizations.
7316 Without any optimization option, the compiler's goal is to reduce the
7317 cost of compilation and to make debugging produce the expected
7318 results.  Statements are independent: if you stop the program with a
7319 breakpoint between statements, you can then assign a new value to any
7320 variable or change the program counter to any other statement in the
7321 function and get exactly the results you expect from the source
7322 code.
7324 Turning on optimization flags makes the compiler attempt to improve
7325 the performance and/or code size at the expense of compilation time
7326 and possibly the ability to debug the program.
7328 The compiler performs optimization based on the knowledge it has of the
7329 program.  Compiling multiple files at once to a single output file mode allows
7330 the compiler to use information gained from all of the files when compiling
7331 each of them.
7333 Not all optimizations are controlled directly by a flag.  Only
7334 optimizations that have a flag are listed in this section.
7336 Most optimizations are only enabled if an @option{-O} level is set on
7337 the command line.  Otherwise they are disabled, even if individual
7338 optimization flags are specified.
7340 Depending on the target and how GCC was configured, a slightly different
7341 set of optimizations may be enabled at each @option{-O} level than
7342 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7343 to find out the exact set of optimizations that are enabled at each level.
7344 @xref{Overall Options}, for examples.
7346 @table @gcctabopt
7347 @item -O
7348 @itemx -O1
7349 @opindex O
7350 @opindex O1
7351 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7352 more memory for a large function.
7354 With @option{-O}, the compiler tries to reduce code size and execution
7355 time, without performing any optimizations that take a great deal of
7356 compilation time.
7358 @option{-O} turns on the following optimization flags:
7359 @gccoptlist{
7360 -fauto-inc-dec @gol
7361 -fbranch-count-reg @gol
7362 -fcombine-stack-adjustments @gol
7363 -fcompare-elim @gol
7364 -fcprop-registers @gol
7365 -fdce @gol
7366 -fdefer-pop @gol
7367 -fdelayed-branch @gol
7368 -fdse @gol
7369 -fforward-propagate @gol
7370 -fguess-branch-probability @gol
7371 -fif-conversion2 @gol
7372 -fif-conversion @gol
7373 -finline-functions-called-once @gol
7374 -fipa-pure-const @gol
7375 -fipa-profile @gol
7376 -fipa-reference @gol
7377 -fmerge-constants @gol
7378 -fmove-loop-invariants @gol
7379 -fomit-frame-pointer @gol
7380 -freorder-blocks @gol
7381 -fshrink-wrap @gol
7382 -fshrink-wrap-separate @gol
7383 -fsplit-wide-types @gol
7384 -fssa-backprop @gol
7385 -fssa-phiopt @gol
7386 -ftree-bit-ccp @gol
7387 -ftree-ccp @gol
7388 -ftree-ch @gol
7389 -ftree-coalesce-vars @gol
7390 -ftree-copy-prop @gol
7391 -ftree-dce @gol
7392 -ftree-dominator-opts @gol
7393 -ftree-dse @gol
7394 -ftree-forwprop @gol
7395 -ftree-fre @gol
7396 -ftree-phiprop @gol
7397 -ftree-sink @gol
7398 -ftree-slsr @gol
7399 -ftree-sra @gol
7400 -ftree-pta @gol
7401 -ftree-ter @gol
7402 -funit-at-a-time}
7404 @item -O2
7405 @opindex O2
7406 Optimize even more.  GCC performs nearly all supported optimizations
7407 that do not involve a space-speed tradeoff.
7408 As compared to @option{-O}, this option increases both compilation time
7409 and the performance of the generated code.
7411 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7412 also turns on the following optimization flags:
7413 @gccoptlist{-fthread-jumps @gol
7414 -falign-functions  -falign-jumps @gol
7415 -falign-loops  -falign-labels @gol
7416 -fcaller-saves @gol
7417 -fcrossjumping @gol
7418 -fcse-follow-jumps  -fcse-skip-blocks @gol
7419 -fdelete-null-pointer-checks @gol
7420 -fdevirtualize -fdevirtualize-speculatively @gol
7421 -fexpensive-optimizations @gol
7422 -fgcse  -fgcse-lm  @gol
7423 -fhoist-adjacent-loads @gol
7424 -finline-small-functions @gol
7425 -findirect-inlining @gol
7426 -fipa-cp @gol
7427 -fipa-bit-cp @gol
7428 -fipa-vrp @gol
7429 -fipa-sra @gol
7430 -fipa-icf @gol
7431 -fisolate-erroneous-paths-dereference @gol
7432 -flra-remat @gol
7433 -foptimize-sibling-calls @gol
7434 -foptimize-strlen @gol
7435 -fpartial-inlining @gol
7436 -fpeephole2 @gol
7437 -freorder-blocks-algorithm=stc @gol
7438 -freorder-blocks-and-partition -freorder-functions @gol
7439 -frerun-cse-after-loop  @gol
7440 -fsched-interblock  -fsched-spec @gol
7441 -fschedule-insns  -fschedule-insns2 @gol
7442 -fstore-merging @gol
7443 -fstrict-aliasing @gol
7444 -ftree-builtin-call-dce @gol
7445 -ftree-switch-conversion -ftree-tail-merge @gol
7446 -fcode-hoisting @gol
7447 -ftree-pre @gol
7448 -ftree-vrp @gol
7449 -fipa-ra}
7451 Please note the warning under @option{-fgcse} about
7452 invoking @option{-O2} on programs that use computed gotos.
7454 @item -O3
7455 @opindex O3
7456 Optimize yet more.  @option{-O3} turns on all optimizations specified
7457 by @option{-O2} and also turns on the following optimization flags:
7458 @gccoptlist{-finline-functions @gol
7459 -funswitch-loops @gol
7460 -fpredictive-commoning @gol
7461 -fgcse-after-reload @gol
7462 -ftree-loop-vectorize @gol
7463 -ftree-loop-distribution @gol
7464 -ftree-loop-distribute-patterns @gol
7465 -floop-interchange @gol
7466 -fsplit-paths @gol
7467 -ftree-slp-vectorize @gol
7468 -fvect-cost-model @gol
7469 -ftree-partial-pre @gol
7470 -fpeel-loops @gol
7471 -fipa-cp-clone}
7473 @item -O0
7474 @opindex O0
7475 Reduce compilation time and make debugging produce the expected
7476 results.  This is the default.
7478 @item -Os
7479 @opindex Os
7480 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7481 do not typically increase code size.  It also performs further
7482 optimizations designed to reduce code size.
7484 @option{-Os} disables the following optimization flags:
7485 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7486 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7487 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7489 @item -Ofast
7490 @opindex Ofast
7491 Disregard strict standards compliance.  @option{-Ofast} enables all
7492 @option{-O3} optimizations.  It also enables optimizations that are not
7493 valid for all standard-compliant programs.
7494 It turns on @option{-ffast-math} and the Fortran-specific
7495 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7496 specified, and @option{-fno-protect-parens}.
7498 @item -Og
7499 @opindex Og
7500 Optimize debugging experience.  @option{-Og} enables optimizations
7501 that do not interfere with debugging. It should be the optimization
7502 level of choice for the standard edit-compile-debug cycle, offering
7503 a reasonable level of optimization while maintaining fast compilation
7504 and a good debugging experience.
7505 @end table
7507 If you use multiple @option{-O} options, with or without level numbers,
7508 the last such option is the one that is effective.
7510 Options of the form @option{-f@var{flag}} specify machine-independent
7511 flags.  Most flags have both positive and negative forms; the negative
7512 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7513 below, only one of the forms is listed---the one you typically 
7514 use.  You can figure out the other form by either removing @samp{no-}
7515 or adding it.
7517 The following options control specific optimizations.  They are either
7518 activated by @option{-O} options or are related to ones that are.  You
7519 can use the following flags in the rare cases when ``fine-tuning'' of
7520 optimizations to be performed is desired.
7522 @table @gcctabopt
7523 @item -fno-defer-pop
7524 @opindex fno-defer-pop
7525 Always pop the arguments to each function call as soon as that function
7526 returns.  For machines that must pop arguments after a function call,
7527 the compiler normally lets arguments accumulate on the stack for several
7528 function calls and pops them all at once.
7530 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7532 @item -fforward-propagate
7533 @opindex fforward-propagate
7534 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7535 instructions and checks if the result can be simplified.  If loop unrolling
7536 is active, two passes are performed and the second is scheduled after
7537 loop unrolling.
7539 This option is enabled by default at optimization levels @option{-O},
7540 @option{-O2}, @option{-O3}, @option{-Os}.
7542 @item -ffp-contract=@var{style}
7543 @opindex ffp-contract
7544 @option{-ffp-contract=off} disables floating-point expression contraction.
7545 @option{-ffp-contract=fast} enables floating-point expression contraction
7546 such as forming of fused multiply-add operations if the target has
7547 native support for them.
7548 @option{-ffp-contract=on} enables floating-point expression contraction
7549 if allowed by the language standard.  This is currently not implemented
7550 and treated equal to @option{-ffp-contract=off}.
7552 The default is @option{-ffp-contract=fast}.
7554 @item -fomit-frame-pointer
7555 @opindex fomit-frame-pointer
7556 Omit the frame pointer in functions that don't need one.  This avoids the
7557 instructions to save, set up and restore the frame pointer; on many targets
7558 it also makes an extra register available.
7560 On some targets this flag has no effect because the standard calling sequence
7561 always uses a frame pointer, so it cannot be omitted.
7563 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7564 is used in all functions.  Several targets always omit the frame pointer in
7565 leaf functions.
7567 Enabled by default at @option{-O} and higher.
7569 @item -foptimize-sibling-calls
7570 @opindex foptimize-sibling-calls
7571 Optimize sibling and tail recursive calls.
7573 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7575 @item -foptimize-strlen
7576 @opindex foptimize-strlen
7577 Optimize various standard C string functions (e.g. @code{strlen},
7578 @code{strchr} or @code{strcpy}) and
7579 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7581 Enabled at levels @option{-O2}, @option{-O3}.
7583 @item -fno-inline
7584 @opindex fno-inline
7585 Do not expand any functions inline apart from those marked with
7586 the @code{always_inline} attribute.  This is the default when not
7587 optimizing.
7589 Single functions can be exempted from inlining by marking them
7590 with the @code{noinline} attribute.
7592 @item -finline-small-functions
7593 @opindex finline-small-functions
7594 Integrate functions into their callers when their body is smaller than expected
7595 function call code (so overall size of program gets smaller).  The compiler
7596 heuristically decides which functions are simple enough to be worth integrating
7597 in this way.  This inlining applies to all functions, even those not declared
7598 inline.
7600 Enabled at level @option{-O2}.
7602 @item -findirect-inlining
7603 @opindex findirect-inlining
7604 Inline also indirect calls that are discovered to be known at compile
7605 time thanks to previous inlining.  This option has any effect only
7606 when inlining itself is turned on by the @option{-finline-functions}
7607 or @option{-finline-small-functions} options.
7609 Enabled at level @option{-O2}.
7611 @item -finline-functions
7612 @opindex finline-functions
7613 Consider all functions for inlining, even if they are not declared inline.
7614 The compiler heuristically decides which functions are worth integrating
7615 in this way.
7617 If all calls to a given function are integrated, and the function is
7618 declared @code{static}, then the function is normally not output as
7619 assembler code in its own right.
7621 Enabled at level @option{-O3}.
7623 @item -finline-functions-called-once
7624 @opindex finline-functions-called-once
7625 Consider all @code{static} functions called once for inlining into their
7626 caller even if they are not marked @code{inline}.  If a call to a given
7627 function is integrated, then the function is not output as assembler code
7628 in its own right.
7630 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7632 @item -fearly-inlining
7633 @opindex fearly-inlining
7634 Inline functions marked by @code{always_inline} and functions whose body seems
7635 smaller than the function call overhead early before doing
7636 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7637 makes profiling significantly cheaper and usually inlining faster on programs
7638 having large chains of nested wrapper functions.
7640 Enabled by default.
7642 @item -fipa-sra
7643 @opindex fipa-sra
7644 Perform interprocedural scalar replacement of aggregates, removal of
7645 unused parameters and replacement of parameters passed by reference
7646 by parameters passed by value.
7648 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7650 @item -finline-limit=@var{n}
7651 @opindex finline-limit
7652 By default, GCC limits the size of functions that can be inlined.  This flag
7653 allows coarse control of this limit.  @var{n} is the size of functions that
7654 can be inlined in number of pseudo instructions.
7656 Inlining is actually controlled by a number of parameters, which may be
7657 specified individually by using @option{--param @var{name}=@var{value}}.
7658 The @option{-finline-limit=@var{n}} option sets some of these parameters
7659 as follows:
7661 @table @gcctabopt
7662 @item max-inline-insns-single
7663 is set to @var{n}/2.
7664 @item max-inline-insns-auto
7665 is set to @var{n}/2.
7666 @end table
7668 See below for a documentation of the individual
7669 parameters controlling inlining and for the defaults of these parameters.
7671 @emph{Note:} there may be no value to @option{-finline-limit} that results
7672 in default behavior.
7674 @emph{Note:} pseudo instruction represents, in this particular context, an
7675 abstract measurement of function's size.  In no way does it represent a count
7676 of assembly instructions and as such its exact meaning might change from one
7677 release to an another.
7679 @item -fno-keep-inline-dllexport
7680 @opindex fno-keep-inline-dllexport
7681 This is a more fine-grained version of @option{-fkeep-inline-functions},
7682 which applies only to functions that are declared using the @code{dllexport}
7683 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7684 Functions}.
7686 @item -fkeep-inline-functions
7687 @opindex fkeep-inline-functions
7688 In C, emit @code{static} functions that are declared @code{inline}
7689 into the object file, even if the function has been inlined into all
7690 of its callers.  This switch does not affect functions using the
7691 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7692 inline functions into the object file.
7694 @item -fkeep-static-functions
7695 @opindex fkeep-static-functions
7696 Emit @code{static} functions into the object file, even if the function
7697 is never used.
7699 @item -fkeep-static-consts
7700 @opindex fkeep-static-consts
7701 Emit variables declared @code{static const} when optimization isn't turned
7702 on, even if the variables aren't referenced.
7704 GCC enables this option by default.  If you want to force the compiler to
7705 check if a variable is referenced, regardless of whether or not
7706 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7708 @item -fmerge-constants
7709 @opindex fmerge-constants
7710 Attempt to merge identical constants (string constants and floating-point
7711 constants) across compilation units.
7713 This option is the default for optimized compilation if the assembler and
7714 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7715 behavior.
7717 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7719 @item -fmerge-all-constants
7720 @opindex fmerge-all-constants
7721 Attempt to merge identical constants and identical variables.
7723 This option implies @option{-fmerge-constants}.  In addition to
7724 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7725 arrays or initialized constant variables with integral or floating-point
7726 types.  Languages like C or C++ require each variable, including multiple
7727 instances of the same variable in recursive calls, to have distinct locations,
7728 so using this option results in non-conforming
7729 behavior.
7731 @item -fmodulo-sched
7732 @opindex fmodulo-sched
7733 Perform swing modulo scheduling immediately before the first scheduling
7734 pass.  This pass looks at innermost loops and reorders their
7735 instructions by overlapping different iterations.
7737 @item -fmodulo-sched-allow-regmoves
7738 @opindex fmodulo-sched-allow-regmoves
7739 Perform more aggressive SMS-based modulo scheduling with register moves
7740 allowed.  By setting this flag certain anti-dependences edges are
7741 deleted, which triggers the generation of reg-moves based on the
7742 life-range analysis.  This option is effective only with
7743 @option{-fmodulo-sched} enabled.
7745 @item -fno-branch-count-reg
7746 @opindex fno-branch-count-reg
7747 Avoid running a pass scanning for opportunities to use ``decrement and
7748 branch'' instructions on a count register instead of generating sequences
7749 of instructions that decrement a register, compare it against zero, and
7750 then branch based upon the result.  This option is only meaningful on
7751 architectures that support such instructions, which include x86, PowerPC,
7752 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7753 doesn't remove the decrement and branch instructions from the generated
7754 instruction stream introduced by other optimization passes.
7756 Enabled by default at @option{-O1} and higher.
7758 The default is @option{-fbranch-count-reg}.
7760 @item -fno-function-cse
7761 @opindex fno-function-cse
7762 Do not put function addresses in registers; make each instruction that
7763 calls a constant function contain the function's address explicitly.
7765 This option results in less efficient code, but some strange hacks
7766 that alter the assembler output may be confused by the optimizations
7767 performed when this option is not used.
7769 The default is @option{-ffunction-cse}
7771 @item -fno-zero-initialized-in-bss
7772 @opindex fno-zero-initialized-in-bss
7773 If the target supports a BSS section, GCC by default puts variables that
7774 are initialized to zero into BSS@.  This can save space in the resulting
7775 code.
7777 This option turns off this behavior because some programs explicitly
7778 rely on variables going to the data section---e.g., so that the
7779 resulting executable can find the beginning of that section and/or make
7780 assumptions based on that.
7782 The default is @option{-fzero-initialized-in-bss}.
7784 @item -fthread-jumps
7785 @opindex fthread-jumps
7786 Perform optimizations that check to see if a jump branches to a
7787 location where another comparison subsumed by the first is found.  If
7788 so, the first branch is redirected to either the destination of the
7789 second branch or a point immediately following it, depending on whether
7790 the condition is known to be true or false.
7792 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7794 @item -fsplit-wide-types
7795 @opindex fsplit-wide-types
7796 When using a type that occupies multiple registers, such as @code{long
7797 long} on a 32-bit system, split the registers apart and allocate them
7798 independently.  This normally generates better code for those types,
7799 but may make debugging more difficult.
7801 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7802 @option{-Os}.
7804 @item -fcse-follow-jumps
7805 @opindex fcse-follow-jumps
7806 In common subexpression elimination (CSE), scan through jump instructions
7807 when the target of the jump is not reached by any other path.  For
7808 example, when CSE encounters an @code{if} statement with an
7809 @code{else} clause, CSE follows the jump when the condition
7810 tested is false.
7812 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7814 @item -fcse-skip-blocks
7815 @opindex fcse-skip-blocks
7816 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7817 follow jumps that conditionally skip over blocks.  When CSE
7818 encounters a simple @code{if} statement with no else clause,
7819 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7820 body of the @code{if}.
7822 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7824 @item -frerun-cse-after-loop
7825 @opindex frerun-cse-after-loop
7826 Re-run common subexpression elimination after loop optimizations are
7827 performed.
7829 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7831 @item -fgcse
7832 @opindex fgcse
7833 Perform a global common subexpression elimination pass.
7834 This pass also performs global constant and copy propagation.
7836 @emph{Note:} When compiling a program using computed gotos, a GCC
7837 extension, you may get better run-time performance if you disable
7838 the global common subexpression elimination pass by adding
7839 @option{-fno-gcse} to the command line.
7841 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7843 @item -fgcse-lm
7844 @opindex fgcse-lm
7845 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7846 attempts to move loads that are only killed by stores into themselves.  This
7847 allows a loop containing a load/store sequence to be changed to a load outside
7848 the loop, and a copy/store within the loop.
7850 Enabled by default when @option{-fgcse} is enabled.
7852 @item -fgcse-sm
7853 @opindex fgcse-sm
7854 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7855 global common subexpression elimination.  This pass attempts to move
7856 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7857 loops containing a load/store sequence can be changed to a load before
7858 the loop and a store after the loop.
7860 Not enabled at any optimization level.
7862 @item -fgcse-las
7863 @opindex fgcse-las
7864 When @option{-fgcse-las} is enabled, the global common subexpression
7865 elimination pass eliminates redundant loads that come after stores to the
7866 same memory location (both partial and full redundancies).
7868 Not enabled at any optimization level.
7870 @item -fgcse-after-reload
7871 @opindex fgcse-after-reload
7872 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7873 pass is performed after reload.  The purpose of this pass is to clean up
7874 redundant spilling.
7876 @item -faggressive-loop-optimizations
7877 @opindex faggressive-loop-optimizations
7878 This option tells the loop optimizer to use language constraints to
7879 derive bounds for the number of iterations of a loop.  This assumes that
7880 loop code does not invoke undefined behavior by for example causing signed
7881 integer overflows or out-of-bound array accesses.  The bounds for the
7882 number of iterations of a loop are used to guide loop unrolling and peeling
7883 and loop exit test optimizations.
7884 This option is enabled by default.
7886 @item -funconstrained-commons
7887 @opindex funconstrained-commons
7888 This option tells the compiler that variables declared in common blocks
7889 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7890 prevents certain optimizations that depend on knowing the array bounds.
7892 @item -fcrossjumping
7893 @opindex fcrossjumping
7894 Perform cross-jumping transformation.
7895 This transformation unifies equivalent code and saves code size.  The
7896 resulting code may or may not perform better than without cross-jumping.
7898 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7900 @item -fauto-inc-dec
7901 @opindex fauto-inc-dec
7902 Combine increments or decrements of addresses with memory accesses.
7903 This pass is always skipped on architectures that do not have
7904 instructions to support this.  Enabled by default at @option{-O} and
7905 higher on architectures that support this.
7907 @item -fdce
7908 @opindex fdce
7909 Perform dead code elimination (DCE) on RTL@.
7910 Enabled by default at @option{-O} and higher.
7912 @item -fdse
7913 @opindex fdse
7914 Perform dead store elimination (DSE) on RTL@.
7915 Enabled by default at @option{-O} and higher.
7917 @item -fif-conversion
7918 @opindex fif-conversion
7919 Attempt to transform conditional jumps into branch-less equivalents.  This
7920 includes use of conditional moves, min, max, set flags and abs instructions, and
7921 some tricks doable by standard arithmetics.  The use of conditional execution
7922 on chips where it is available is controlled by @option{-fif-conversion2}.
7924 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7926 @item -fif-conversion2
7927 @opindex fif-conversion2
7928 Use conditional execution (where available) to transform conditional jumps into
7929 branch-less equivalents.
7931 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7933 @item -fdeclone-ctor-dtor
7934 @opindex fdeclone-ctor-dtor
7935 The C++ ABI requires multiple entry points for constructors and
7936 destructors: one for a base subobject, one for a complete object, and
7937 one for a virtual destructor that calls operator delete afterwards.
7938 For a hierarchy with virtual bases, the base and complete variants are
7939 clones, which means two copies of the function.  With this option, the
7940 base and complete variants are changed to be thunks that call a common
7941 implementation.
7943 Enabled by @option{-Os}.
7945 @item -fdelete-null-pointer-checks
7946 @opindex fdelete-null-pointer-checks
7947 Assume that programs cannot safely dereference null pointers, and that
7948 no code or data element resides at address zero.
7949 This option enables simple constant
7950 folding optimizations at all optimization levels.  In addition, other
7951 optimization passes in GCC use this flag to control global dataflow
7952 analyses that eliminate useless checks for null pointers; these assume
7953 that a memory access to address zero always results in a trap, so
7954 that if a pointer is checked after it has already been dereferenced,
7955 it cannot be null.
7957 Note however that in some environments this assumption is not true.
7958 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7959 for programs that depend on that behavior.
7961 This option is enabled by default on most targets.  On Nios II ELF, it
7962 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
7964 Passes that use the dataflow information
7965 are enabled independently at different optimization levels.
7967 @item -fdevirtualize
7968 @opindex fdevirtualize
7969 Attempt to convert calls to virtual functions to direct calls.  This
7970 is done both within a procedure and interprocedurally as part of
7971 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7972 propagation (@option{-fipa-cp}).
7973 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7975 @item -fdevirtualize-speculatively
7976 @opindex fdevirtualize-speculatively
7977 Attempt to convert calls to virtual functions to speculative direct calls.
7978 Based on the analysis of the type inheritance graph, determine for a given call
7979 the set of likely targets. If the set is small, preferably of size 1, change
7980 the call into a conditional deciding between direct and indirect calls.  The
7981 speculative calls enable more optimizations, such as inlining.  When they seem
7982 useless after further optimization, they are converted back into original form.
7984 @item -fdevirtualize-at-ltrans
7985 @opindex fdevirtualize-at-ltrans
7986 Stream extra information needed for aggressive devirtualization when running
7987 the link-time optimizer in local transformation mode.  
7988 This option enables more devirtualization but
7989 significantly increases the size of streamed data. For this reason it is
7990 disabled by default.
7992 @item -fexpensive-optimizations
7993 @opindex fexpensive-optimizations
7994 Perform a number of minor optimizations that are relatively expensive.
7996 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7998 @item -free
7999 @opindex free
8000 Attempt to remove redundant extension instructions.  This is especially
8001 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8002 registers after writing to their lower 32-bit half.
8004 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8005 @option{-O3}, @option{-Os}.
8007 @item -fno-lifetime-dse
8008 @opindex fno-lifetime-dse
8009 In C++ the value of an object is only affected by changes within its
8010 lifetime: when the constructor begins, the object has an indeterminate
8011 value, and any changes during the lifetime of the object are dead when
8012 the object is destroyed.  Normally dead store elimination will take
8013 advantage of this; if your code relies on the value of the object
8014 storage persisting beyond the lifetime of the object, you can use this
8015 flag to disable this optimization.  To preserve stores before the
8016 constructor starts (e.g. because your operator new clears the object
8017 storage) but still treat the object as dead after the destructor you,
8018 can use @option{-flifetime-dse=1}.  The default behavior can be
8019 explicitly selected with @option{-flifetime-dse=2}.
8020 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8022 @item -flive-range-shrinkage
8023 @opindex flive-range-shrinkage
8024 Attempt to decrease register pressure through register live range
8025 shrinkage.  This is helpful for fast processors with small or moderate
8026 size register sets.
8028 @item -fira-algorithm=@var{algorithm}
8029 @opindex fira-algorithm
8030 Use the specified coloring algorithm for the integrated register
8031 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8032 specifies Chow's priority coloring, or @samp{CB}, which specifies
8033 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8034 for all architectures, but for those targets that do support it, it is
8035 the default because it generates better code.
8037 @item -fira-region=@var{region}
8038 @opindex fira-region
8039 Use specified regions for the integrated register allocator.  The
8040 @var{region} argument should be one of the following:
8042 @table @samp
8044 @item all
8045 Use all loops as register allocation regions.
8046 This can give the best results for machines with a small and/or
8047 irregular register set.
8049 @item mixed
8050 Use all loops except for loops with small register pressure 
8051 as the regions.  This value usually gives
8052 the best results in most cases and for most architectures,
8053 and is enabled by default when compiling with optimization for speed
8054 (@option{-O}, @option{-O2}, @dots{}).
8056 @item one
8057 Use all functions as a single region.  
8058 This typically results in the smallest code size, and is enabled by default for
8059 @option{-Os} or @option{-O0}.
8061 @end table
8063 @item -fira-hoist-pressure
8064 @opindex fira-hoist-pressure
8065 Use IRA to evaluate register pressure in the code hoisting pass for
8066 decisions to hoist expressions.  This option usually results in smaller
8067 code, but it can slow the compiler down.
8069 This option is enabled at level @option{-Os} for all targets.
8071 @item -fira-loop-pressure
8072 @opindex fira-loop-pressure
8073 Use IRA to evaluate register pressure in loops for decisions to move
8074 loop invariants.  This option usually results in generation
8075 of faster and smaller code on machines with large register files (>= 32
8076 registers), but it can slow the compiler down.
8078 This option is enabled at level @option{-O3} for some targets.
8080 @item -fno-ira-share-save-slots
8081 @opindex fno-ira-share-save-slots
8082 Disable sharing of stack slots used for saving call-used hard
8083 registers living through a call.  Each hard register gets a
8084 separate stack slot, and as a result function stack frames are
8085 larger.
8087 @item -fno-ira-share-spill-slots
8088 @opindex fno-ira-share-spill-slots
8089 Disable sharing of stack slots allocated for pseudo-registers.  Each
8090 pseudo-register that does not get a hard register gets a separate
8091 stack slot, and as a result function stack frames are larger.
8093 @item -flra-remat
8094 @opindex flra-remat
8095 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8096 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8097 values if it is profitable.
8099 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8101 @item -fdelayed-branch
8102 @opindex fdelayed-branch
8103 If supported for the target machine, attempt to reorder instructions
8104 to exploit instruction slots available after delayed branch
8105 instructions.
8107 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8109 @item -fschedule-insns
8110 @opindex fschedule-insns
8111 If supported for the target machine, attempt to reorder instructions to
8112 eliminate execution stalls due to required data being unavailable.  This
8113 helps machines that have slow floating point or memory load instructions
8114 by allowing other instructions to be issued until the result of the load
8115 or floating-point instruction is required.
8117 Enabled at levels @option{-O2}, @option{-O3}.
8119 @item -fschedule-insns2
8120 @opindex fschedule-insns2
8121 Similar to @option{-fschedule-insns}, but requests an additional pass of
8122 instruction scheduling after register allocation has been done.  This is
8123 especially useful on machines with a relatively small number of
8124 registers and where memory load instructions take more than one cycle.
8126 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8128 @item -fno-sched-interblock
8129 @opindex fno-sched-interblock
8130 Don't schedule instructions across basic blocks.  This is normally
8131 enabled by default when scheduling before register allocation, i.e.@:
8132 with @option{-fschedule-insns} or at @option{-O2} or higher.
8134 @item -fno-sched-spec
8135 @opindex fno-sched-spec
8136 Don't allow speculative motion of non-load instructions.  This is normally
8137 enabled by default when scheduling before register allocation, i.e.@:
8138 with @option{-fschedule-insns} or at @option{-O2} or higher.
8140 @item -fsched-pressure
8141 @opindex fsched-pressure
8142 Enable register pressure sensitive insn scheduling before register
8143 allocation.  This only makes sense when scheduling before register
8144 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8145 @option{-O2} or higher.  Usage of this option can improve the
8146 generated code and decrease its size by preventing register pressure
8147 increase above the number of available hard registers and subsequent
8148 spills in register allocation.
8150 @item -fsched-spec-load
8151 @opindex fsched-spec-load
8152 Allow speculative motion of some load instructions.  This only makes
8153 sense when scheduling before register allocation, i.e.@: with
8154 @option{-fschedule-insns} or at @option{-O2} or higher.
8156 @item -fsched-spec-load-dangerous
8157 @opindex fsched-spec-load-dangerous
8158 Allow speculative motion of more load instructions.  This only makes
8159 sense when scheduling before register allocation, i.e.@: with
8160 @option{-fschedule-insns} or at @option{-O2} or higher.
8162 @item -fsched-stalled-insns
8163 @itemx -fsched-stalled-insns=@var{n}
8164 @opindex fsched-stalled-insns
8165 Define how many insns (if any) can be moved prematurely from the queue
8166 of stalled insns into the ready list during the second scheduling pass.
8167 @option{-fno-sched-stalled-insns} means that no insns are moved
8168 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8169 on how many queued insns can be moved prematurely.
8170 @option{-fsched-stalled-insns} without a value is equivalent to
8171 @option{-fsched-stalled-insns=1}.
8173 @item -fsched-stalled-insns-dep
8174 @itemx -fsched-stalled-insns-dep=@var{n}
8175 @opindex fsched-stalled-insns-dep
8176 Define how many insn groups (cycles) are examined for a dependency
8177 on a stalled insn that is a candidate for premature removal from the queue
8178 of stalled insns.  This has an effect only during the second scheduling pass,
8179 and only if @option{-fsched-stalled-insns} is used.
8180 @option{-fno-sched-stalled-insns-dep} is equivalent to
8181 @option{-fsched-stalled-insns-dep=0}.
8182 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8183 @option{-fsched-stalled-insns-dep=1}.
8185 @item -fsched2-use-superblocks
8186 @opindex fsched2-use-superblocks
8187 When scheduling after register allocation, use superblock scheduling.
8188 This allows motion across basic block boundaries,
8189 resulting in faster schedules.  This option is experimental, as not all machine
8190 descriptions used by GCC model the CPU closely enough to avoid unreliable
8191 results from the algorithm.
8193 This only makes sense when scheduling after register allocation, i.e.@: with
8194 @option{-fschedule-insns2} or at @option{-O2} or higher.
8196 @item -fsched-group-heuristic
8197 @opindex fsched-group-heuristic
8198 Enable the group heuristic in the scheduler.  This heuristic favors
8199 the instruction that belongs to a schedule group.  This is enabled
8200 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8201 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8203 @item -fsched-critical-path-heuristic
8204 @opindex fsched-critical-path-heuristic
8205 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8206 instructions on the critical path.  This is enabled by default when
8207 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8208 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8210 @item -fsched-spec-insn-heuristic
8211 @opindex fsched-spec-insn-heuristic
8212 Enable the speculative instruction heuristic in the scheduler.  This
8213 heuristic favors speculative instructions with greater dependency weakness.
8214 This is enabled by default when scheduling is enabled, i.e.@:
8215 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8216 or at @option{-O2} or higher.
8218 @item -fsched-rank-heuristic
8219 @opindex fsched-rank-heuristic
8220 Enable the rank heuristic in the scheduler.  This heuristic favors
8221 the instruction belonging to a basic block with greater size or frequency.
8222 This is enabled by default when scheduling is enabled, i.e.@:
8223 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8224 at @option{-O2} or higher.
8226 @item -fsched-last-insn-heuristic
8227 @opindex fsched-last-insn-heuristic
8228 Enable the last-instruction heuristic in the scheduler.  This heuristic
8229 favors the instruction that is less dependent on the last instruction
8230 scheduled.  This is enabled by default when scheduling is enabled,
8231 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8232 at @option{-O2} or higher.
8234 @item -fsched-dep-count-heuristic
8235 @opindex fsched-dep-count-heuristic
8236 Enable the dependent-count heuristic in the scheduler.  This heuristic
8237 favors the instruction that has more instructions depending on it.
8238 This is enabled by default when scheduling is enabled, i.e.@:
8239 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8240 at @option{-O2} or higher.
8242 @item -freschedule-modulo-scheduled-loops
8243 @opindex freschedule-modulo-scheduled-loops
8244 Modulo scheduling is performed before traditional scheduling.  If a loop
8245 is modulo scheduled, later scheduling passes may change its schedule.  
8246 Use this option to control that behavior.
8248 @item -fselective-scheduling
8249 @opindex fselective-scheduling
8250 Schedule instructions using selective scheduling algorithm.  Selective
8251 scheduling runs instead of the first scheduler pass.
8253 @item -fselective-scheduling2
8254 @opindex fselective-scheduling2
8255 Schedule instructions using selective scheduling algorithm.  Selective
8256 scheduling runs instead of the second scheduler pass.
8258 @item -fsel-sched-pipelining
8259 @opindex fsel-sched-pipelining
8260 Enable software pipelining of innermost loops during selective scheduling.
8261 This option has no effect unless one of @option{-fselective-scheduling} or
8262 @option{-fselective-scheduling2} is turned on.
8264 @item -fsel-sched-pipelining-outer-loops
8265 @opindex fsel-sched-pipelining-outer-loops
8266 When pipelining loops during selective scheduling, also pipeline outer loops.
8267 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8269 @item -fsemantic-interposition
8270 @opindex fsemantic-interposition
8271 Some object formats, like ELF, allow interposing of symbols by the 
8272 dynamic linker.
8273 This means that for symbols exported from the DSO, the compiler cannot perform
8274 interprocedural propagation, inlining and other optimizations in anticipation
8275 that the function or variable in question may change. While this feature is
8276 useful, for example, to rewrite memory allocation functions by a debugging
8277 implementation, it is expensive in the terms of code quality.
8278 With @option{-fno-semantic-interposition} the compiler assumes that 
8279 if interposition happens for functions the overwriting function will have 
8280 precisely the same semantics (and side effects). 
8281 Similarly if interposition happens
8282 for variables, the constructor of the variable will be the same. The flag
8283 has no effect for functions explicitly declared inline 
8284 (where it is never allowed for interposition to change semantics) 
8285 and for symbols explicitly declared weak.
8287 @item -fshrink-wrap
8288 @opindex fshrink-wrap
8289 Emit function prologues only before parts of the function that need it,
8290 rather than at the top of the function.  This flag is enabled by default at
8291 @option{-O} and higher.
8293 @item -fshrink-wrap-separate
8294 @opindex fshrink-wrap-separate
8295 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8296 those parts are only executed when needed.
8297 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8298 is also turned on and the target supports this.
8300 @item -fcaller-saves
8301 @opindex fcaller-saves
8302 Enable allocation of values to registers that are clobbered by
8303 function calls, by emitting extra instructions to save and restore the
8304 registers around such calls.  Such allocation is done only when it
8305 seems to result in better code.
8307 This option is always enabled by default on certain machines, usually
8308 those which have no call-preserved registers to use instead.
8310 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8312 @item -fcombine-stack-adjustments
8313 @opindex fcombine-stack-adjustments
8314 Tracks stack adjustments (pushes and pops) and stack memory references
8315 and then tries to find ways to combine them.
8317 Enabled by default at @option{-O1} and higher.
8319 @item -fipa-ra
8320 @opindex fipa-ra
8321 Use caller save registers for allocation if those registers are not used by
8322 any called function.  In that case it is not necessary to save and restore
8323 them around calls.  This is only possible if called functions are part of
8324 same compilation unit as current function and they are compiled before it.
8326 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8327 is disabled if generated code will be instrumented for profiling
8328 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8329 exactly (this happens on targets that do not expose prologues
8330 and epilogues in RTL).
8332 @item -fconserve-stack
8333 @opindex fconserve-stack
8334 Attempt to minimize stack usage.  The compiler attempts to use less
8335 stack space, even if that makes the program slower.  This option
8336 implies setting the @option{large-stack-frame} parameter to 100
8337 and the @option{large-stack-frame-growth} parameter to 400.
8339 @item -ftree-reassoc
8340 @opindex ftree-reassoc
8341 Perform reassociation on trees.  This flag is enabled by default
8342 at @option{-O} and higher.
8344 @item -fcode-hoisting
8345 @opindex fcode-hoisting
8346 Perform code hoisting.  Code hoisting tries to move the
8347 evaluation of expressions executed on all paths to the function exit
8348 as early as possible.  This is especially useful as a code size
8349 optimization, but it often helps for code speed as well.
8350 This flag is enabled by default at @option{-O2} and higher.
8352 @item -ftree-pre
8353 @opindex ftree-pre
8354 Perform partial redundancy elimination (PRE) on trees.  This flag is
8355 enabled by default at @option{-O2} and @option{-O3}.
8357 @item -ftree-partial-pre
8358 @opindex ftree-partial-pre
8359 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8360 enabled by default at @option{-O3}.
8362 @item -ftree-forwprop
8363 @opindex ftree-forwprop
8364 Perform forward propagation on trees.  This flag is enabled by default
8365 at @option{-O} and higher.
8367 @item -ftree-fre
8368 @opindex ftree-fre
8369 Perform full redundancy elimination (FRE) on trees.  The difference
8370 between FRE and PRE is that FRE only considers expressions
8371 that are computed on all paths leading to the redundant computation.
8372 This analysis is faster than PRE, though it exposes fewer redundancies.
8373 This flag is enabled by default at @option{-O} and higher.
8375 @item -ftree-phiprop
8376 @opindex ftree-phiprop
8377 Perform hoisting of loads from conditional pointers on trees.  This
8378 pass is enabled by default at @option{-O} and higher.
8380 @item -fhoist-adjacent-loads
8381 @opindex fhoist-adjacent-loads
8382 Speculatively hoist loads from both branches of an if-then-else if the
8383 loads are from adjacent locations in the same structure and the target
8384 architecture has a conditional move instruction.  This flag is enabled
8385 by default at @option{-O2} and higher.
8387 @item -ftree-copy-prop
8388 @opindex ftree-copy-prop
8389 Perform copy propagation on trees.  This pass eliminates unnecessary
8390 copy operations.  This flag is enabled by default at @option{-O} and
8391 higher.
8393 @item -fipa-pure-const
8394 @opindex fipa-pure-const
8395 Discover which functions are pure or constant.
8396 Enabled by default at @option{-O} and higher.
8398 @item -fipa-reference
8399 @opindex fipa-reference
8400 Discover which static variables do not escape the
8401 compilation unit.
8402 Enabled by default at @option{-O} and higher.
8404 @item -fipa-pta
8405 @opindex fipa-pta
8406 Perform interprocedural pointer analysis and interprocedural modification
8407 and reference analysis.  This option can cause excessive memory and
8408 compile-time usage on large compilation units.  It is not enabled by
8409 default at any optimization level.
8411 @item -fipa-profile
8412 @opindex fipa-profile
8413 Perform interprocedural profile propagation.  The functions called only from
8414 cold functions are marked as cold. Also functions executed once (such as
8415 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8416 functions and loop less parts of functions executed once are then optimized for
8417 size.
8418 Enabled by default at @option{-O} and higher.
8420 @item -fipa-cp
8421 @opindex fipa-cp
8422 Perform interprocedural constant propagation.
8423 This optimization analyzes the program to determine when values passed
8424 to functions are constants and then optimizes accordingly.
8425 This optimization can substantially increase performance
8426 if the application has constants passed to functions.
8427 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8429 @item -fipa-cp-clone
8430 @opindex fipa-cp-clone
8431 Perform function cloning to make interprocedural constant propagation stronger.
8432 When enabled, interprocedural constant propagation performs function cloning
8433 when externally visible function can be called with constant arguments.
8434 Because this optimization can create multiple copies of functions,
8435 it may significantly increase code size
8436 (see @option{--param ipcp-unit-growth=@var{value}}).
8437 This flag is enabled by default at @option{-O3}.
8439 @item -fipa-bit-cp
8440 @opindex -fipa-bit-cp
8441 When enabled, perform interprocedural bitwise constant
8442 propagation. This flag is enabled by default at @option{-O2}. It
8443 requires that @option{-fipa-cp} is enabled.
8445 @item -fipa-vrp
8446 @opindex -fipa-vrp
8447 When enabled, perform interprocedural propagation of value
8448 ranges. This flag is enabled by default at @option{-O2}. It requires
8449 that @option{-fipa-cp} is enabled.
8451 @item -fipa-icf
8452 @opindex fipa-icf
8453 Perform Identical Code Folding for functions and read-only variables.
8454 The optimization reduces code size and may disturb unwind stacks by replacing
8455 a function by equivalent one with a different name. The optimization works
8456 more effectively with link-time optimization enabled.
8458 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8459 works on different levels and thus the optimizations are not same - there are
8460 equivalences that are found only by GCC and equivalences found only by Gold.
8462 This flag is enabled by default at @option{-O2} and @option{-Os}.
8464 @item -fisolate-erroneous-paths-dereference
8465 @opindex fisolate-erroneous-paths-dereference
8466 Detect paths that trigger erroneous or undefined behavior due to
8467 dereferencing a null pointer.  Isolate those paths from the main control
8468 flow and turn the statement with erroneous or undefined behavior into a trap.
8469 This flag is enabled by default at @option{-O2} and higher and depends on
8470 @option{-fdelete-null-pointer-checks} also being enabled.
8472 @item -fisolate-erroneous-paths-attribute
8473 @opindex fisolate-erroneous-paths-attribute
8474 Detect paths that trigger erroneous or undefined behavior due a null value
8475 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8476 attribute.  Isolate those paths from the main control flow and turn the
8477 statement with erroneous or undefined behavior into a trap.  This is not
8478 currently enabled, but may be enabled by @option{-O2} in the future.
8480 @item -ftree-sink
8481 @opindex ftree-sink
8482 Perform forward store motion on trees.  This flag is
8483 enabled by default at @option{-O} and higher.
8485 @item -ftree-bit-ccp
8486 @opindex ftree-bit-ccp
8487 Perform sparse conditional bit constant propagation on trees and propagate
8488 pointer alignment information.
8489 This pass only operates on local scalar variables and is enabled by default
8490 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8492 @item -ftree-ccp
8493 @opindex ftree-ccp
8494 Perform sparse conditional constant propagation (CCP) on trees.  This
8495 pass only operates on local scalar variables and is enabled by default
8496 at @option{-O} and higher.
8498 @item -fssa-backprop
8499 @opindex fssa-backprop
8500 Propagate information about uses of a value up the definition chain
8501 in order to simplify the definitions.  For example, this pass strips
8502 sign operations if the sign of a value never matters.  The flag is
8503 enabled by default at @option{-O} and higher.
8505 @item -fssa-phiopt
8506 @opindex fssa-phiopt
8507 Perform pattern matching on SSA PHI nodes to optimize conditional
8508 code.  This pass is enabled by default at @option{-O} and higher.
8510 @item -ftree-switch-conversion
8511 @opindex ftree-switch-conversion
8512 Perform conversion of simple initializations in a switch to
8513 initializations from a scalar array.  This flag is enabled by default
8514 at @option{-O2} and higher.
8516 @item -ftree-tail-merge
8517 @opindex ftree-tail-merge
8518 Look for identical code sequences.  When found, replace one with a jump to the
8519 other.  This optimization is known as tail merging or cross jumping.  This flag
8520 is enabled by default at @option{-O2} and higher.  The compilation time
8521 in this pass can
8522 be limited using @option{max-tail-merge-comparisons} parameter and
8523 @option{max-tail-merge-iterations} parameter.
8525 @item -ftree-dce
8526 @opindex ftree-dce
8527 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8528 default at @option{-O} and higher.
8530 @item -ftree-builtin-call-dce
8531 @opindex ftree-builtin-call-dce
8532 Perform conditional dead code elimination (DCE) for calls to built-in functions
8533 that may set @code{errno} but are otherwise side-effect free.  This flag is
8534 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8535 specified.
8537 @item -ftree-dominator-opts
8538 @opindex ftree-dominator-opts
8539 Perform a variety of simple scalar cleanups (constant/copy
8540 propagation, redundancy elimination, range propagation and expression
8541 simplification) based on a dominator tree traversal.  This also
8542 performs jump threading (to reduce jumps to jumps). This flag is
8543 enabled by default at @option{-O} and higher.
8545 @item -ftree-dse
8546 @opindex ftree-dse
8547 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8548 a memory location that is later overwritten by another store without
8549 any intervening loads.  In this case the earlier store can be deleted.  This
8550 flag is enabled by default at @option{-O} and higher.
8552 @item -ftree-ch
8553 @opindex ftree-ch
8554 Perform loop header copying on trees.  This is beneficial since it increases
8555 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8556 is enabled by default at @option{-O} and higher.  It is not enabled
8557 for @option{-Os}, since it usually increases code size.
8559 @item -ftree-loop-optimize
8560 @opindex ftree-loop-optimize
8561 Perform loop optimizations on trees.  This flag is enabled by default
8562 at @option{-O} and higher.
8564 @item -ftree-loop-linear
8565 @itemx -floop-strip-mine
8566 @itemx -floop-block
8567 @opindex ftree-loop-linear
8568 @opindex floop-strip-mine
8569 @opindex floop-block
8570 Perform loop nest optimizations.  Same as
8571 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8572 to be configured with @option{--with-isl} to enable the Graphite loop
8573 transformation infrastructure.
8575 @item -fgraphite-identity
8576 @opindex fgraphite-identity
8577 Enable the identity transformation for graphite.  For every SCoP we generate
8578 the polyhedral representation and transform it back to gimple.  Using
8579 @option{-fgraphite-identity} we can check the costs or benefits of the
8580 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8581 are also performed by the code generator isl, like index splitting and
8582 dead code elimination in loops.
8584 @item -floop-nest-optimize
8585 @opindex floop-nest-optimize
8586 Enable the isl based loop nest optimizer.  This is a generic loop nest
8587 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8588 structure optimized for data-locality and parallelism.  This option
8589 is experimental.
8591 @item -floop-parallelize-all
8592 @opindex floop-parallelize-all
8593 Use the Graphite data dependence analysis to identify loops that can
8594 be parallelized.  Parallelize all the loops that can be analyzed to
8595 not contain loop carried dependences without checking that it is
8596 profitable to parallelize the loops.
8598 @item -ftree-coalesce-vars
8599 @opindex ftree-coalesce-vars
8600 While transforming the program out of the SSA representation, attempt to
8601 reduce copying by coalescing versions of different user-defined
8602 variables, instead of just compiler temporaries.  This may severely
8603 limit the ability to debug an optimized program compiled with
8604 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8605 prevents SSA coalescing of user variables.  This option is enabled by
8606 default if optimization is enabled, and it does very little otherwise.
8608 @item -ftree-loop-if-convert
8609 @opindex ftree-loop-if-convert
8610 Attempt to transform conditional jumps in the innermost loops to
8611 branch-less equivalents.  The intent is to remove control-flow from
8612 the innermost loops in order to improve the ability of the
8613 vectorization pass to handle these loops.  This is enabled by default
8614 if vectorization is enabled.
8616 @item -ftree-loop-distribution
8617 @opindex ftree-loop-distribution
8618 Perform loop distribution.  This flag can improve cache performance on
8619 big loop bodies and allow further loop optimizations, like
8620 parallelization or vectorization, to take place.  For example, the loop
8621 @smallexample
8622 DO I = 1, N
8623   A(I) = B(I) + C
8624   D(I) = E(I) * F
8625 ENDDO
8626 @end smallexample
8627 is transformed to
8628 @smallexample
8629 DO I = 1, N
8630    A(I) = B(I) + C
8631 ENDDO
8632 DO I = 1, N
8633    D(I) = E(I) * F
8634 ENDDO
8635 @end smallexample
8637 @item -ftree-loop-distribute-patterns
8638 @opindex ftree-loop-distribute-patterns
8639 Perform loop distribution of patterns that can be code generated with
8640 calls to a library.  This flag is enabled by default at @option{-O3}.
8642 This pass distributes the initialization loops and generates a call to
8643 memset zero.  For example, the loop
8644 @smallexample
8645 DO I = 1, N
8646   A(I) = 0
8647   B(I) = A(I) + I
8648 ENDDO
8649 @end smallexample
8650 is transformed to
8651 @smallexample
8652 DO I = 1, N
8653    A(I) = 0
8654 ENDDO
8655 DO I = 1, N
8656    B(I) = A(I) + I
8657 ENDDO
8658 @end smallexample
8659 and the initialization loop is transformed into a call to memset zero.
8661 @item -floop-interchange
8662 @opindex floop-interchange
8663 Perform loop interchange outside of graphite.  This flag can improve cache
8664 performance on loop nest and allow further loop optimizations, like
8665 vectorization, to take place.  For example, the loop
8666 @smallexample
8667 for (int i = 0; i < N; i++)
8668   for (int j = 0; j < N; j++)
8669     for (int k = 0; k < N; k++)
8670       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8671 @end smallexample
8672 is transformed to
8673 @smallexample
8674 for (int i = 0; i < N; i++)
8675   for (int k = 0; k < N; k++)
8676     for (int j = 0; j < N; j++)
8677       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8678 @end smallexample
8680 @item -ftree-loop-im
8681 @opindex ftree-loop-im
8682 Perform loop invariant motion on trees.  This pass moves only invariants that
8683 are hard to handle at RTL level (function calls, operations that expand to
8684 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8685 operands of conditions that are invariant out of the loop, so that we can use
8686 just trivial invariantness analysis in loop unswitching.  The pass also includes
8687 store motion.
8689 @item -ftree-loop-ivcanon
8690 @opindex ftree-loop-ivcanon
8691 Create a canonical counter for number of iterations in loops for which
8692 determining number of iterations requires complicated analysis.  Later
8693 optimizations then may determine the number easily.  Useful especially
8694 in connection with unrolling.
8696 @item -fivopts
8697 @opindex fivopts
8698 Perform induction variable optimizations (strength reduction, induction
8699 variable merging and induction variable elimination) on trees.
8701 @item -ftree-parallelize-loops=n
8702 @opindex ftree-parallelize-loops
8703 Parallelize loops, i.e., split their iteration space to run in n threads.
8704 This is only possible for loops whose iterations are independent
8705 and can be arbitrarily reordered.  The optimization is only
8706 profitable on multiprocessor machines, for loops that are CPU-intensive,
8707 rather than constrained e.g.@: by memory bandwidth.  This option
8708 implies @option{-pthread}, and thus is only supported on targets
8709 that have support for @option{-pthread}.
8711 @item -ftree-pta
8712 @opindex ftree-pta
8713 Perform function-local points-to analysis on trees.  This flag is
8714 enabled by default at @option{-O} and higher.
8716 @item -ftree-sra
8717 @opindex ftree-sra
8718 Perform scalar replacement of aggregates.  This pass replaces structure
8719 references with scalars to prevent committing structures to memory too
8720 early.  This flag is enabled by default at @option{-O} and higher.
8722 @item -fstore-merging
8723 @opindex fstore-merging
8724 Perform merging of narrow stores to consecutive memory addresses.  This pass
8725 merges contiguous stores of immediate values narrower than a word into fewer
8726 wider stores to reduce the number of instructions.  This is enabled by default
8727 at @option{-O2} and higher as well as @option{-Os}.
8729 @item -ftree-ter
8730 @opindex ftree-ter
8731 Perform temporary expression replacement during the SSA->normal phase.  Single
8732 use/single def temporaries are replaced at their use location with their
8733 defining expression.  This results in non-GIMPLE code, but gives the expanders
8734 much more complex trees to work on resulting in better RTL generation.  This is
8735 enabled by default at @option{-O} and higher.
8737 @item -ftree-slsr
8738 @opindex ftree-slsr
8739 Perform straight-line strength reduction on trees.  This recognizes related
8740 expressions involving multiplications and replaces them by less expensive
8741 calculations when possible.  This is enabled by default at @option{-O} and
8742 higher.
8744 @item -ftree-vectorize
8745 @opindex ftree-vectorize
8746 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8747 and @option{-ftree-slp-vectorize} if not explicitly specified.
8749 @item -ftree-loop-vectorize
8750 @opindex ftree-loop-vectorize
8751 Perform loop vectorization on trees. This flag is enabled by default at
8752 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8754 @item -ftree-slp-vectorize
8755 @opindex ftree-slp-vectorize
8756 Perform basic block vectorization on trees. This flag is enabled by default at
8757 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8759 @item -fvect-cost-model=@var{model}
8760 @opindex fvect-cost-model
8761 Alter the cost model used for vectorization.  The @var{model} argument
8762 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8763 With the @samp{unlimited} model the vectorized code-path is assumed
8764 to be profitable while with the @samp{dynamic} model a runtime check
8765 guards the vectorized code-path to enable it only for iteration
8766 counts that will likely execute faster than when executing the original
8767 scalar loop.  The @samp{cheap} model disables vectorization of
8768 loops where doing so would be cost prohibitive for example due to
8769 required runtime checks for data dependence or alignment but otherwise
8770 is equal to the @samp{dynamic} model.
8771 The default cost model depends on other optimization flags and is
8772 either @samp{dynamic} or @samp{cheap}.
8774 @item -fsimd-cost-model=@var{model}
8775 @opindex fsimd-cost-model
8776 Alter the cost model used for vectorization of loops marked with the OpenMP
8777 or Cilk Plus simd directive.  The @var{model} argument should be one of
8778 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8779 have the same meaning as described in @option{-fvect-cost-model} and by
8780 default a cost model defined with @option{-fvect-cost-model} is used.
8782 @item -ftree-vrp
8783 @opindex ftree-vrp
8784 Perform Value Range Propagation on trees.  This is similar to the
8785 constant propagation pass, but instead of values, ranges of values are
8786 propagated.  This allows the optimizers to remove unnecessary range
8787 checks like array bound checks and null pointer checks.  This is
8788 enabled by default at @option{-O2} and higher.  Null pointer check
8789 elimination is only done if @option{-fdelete-null-pointer-checks} is
8790 enabled.
8792 @item -fsplit-paths
8793 @opindex fsplit-paths
8794 Split paths leading to loop backedges.  This can improve dead code
8795 elimination and common subexpression elimination.  This is enabled by
8796 default at @option{-O2} and above.
8798 @item -fsplit-ivs-in-unroller
8799 @opindex fsplit-ivs-in-unroller
8800 Enables expression of values of induction variables in later iterations
8801 of the unrolled loop using the value in the first iteration.  This breaks
8802 long dependency chains, thus improving efficiency of the scheduling passes.
8804 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8805 same effect.  However, that is not reliable in cases where the loop body
8806 is more complicated than a single basic block.  It also does not work at all
8807 on some architectures due to restrictions in the CSE pass.
8809 This optimization is enabled by default.
8811 @item -fvariable-expansion-in-unroller
8812 @opindex fvariable-expansion-in-unroller
8813 With this option, the compiler creates multiple copies of some
8814 local variables when unrolling a loop, which can result in superior code.
8816 @item -fpartial-inlining
8817 @opindex fpartial-inlining
8818 Inline parts of functions.  This option has any effect only
8819 when inlining itself is turned on by the @option{-finline-functions}
8820 or @option{-finline-small-functions} options.
8822 Enabled at level @option{-O2}.
8824 @item -fpredictive-commoning
8825 @opindex fpredictive-commoning
8826 Perform predictive commoning optimization, i.e., reusing computations
8827 (especially memory loads and stores) performed in previous
8828 iterations of loops.
8830 This option is enabled at level @option{-O3}.
8832 @item -fprefetch-loop-arrays
8833 @opindex fprefetch-loop-arrays
8834 If supported by the target machine, generate instructions to prefetch
8835 memory to improve the performance of loops that access large arrays.
8837 This option may generate better or worse code; results are highly
8838 dependent on the structure of loops within the source code.
8840 Disabled at level @option{-Os}.
8842 @item -fno-printf-return-value
8843 @opindex fno-printf-return-value
8844 Do not substitute constants for known return value of formatted output
8845 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8846 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8847 transformation allows GCC to optimize or even eliminate branches based
8848 on the known return value of these functions called with arguments that
8849 are either constant, or whose values are known to be in a range that
8850 makes determining the exact return value possible.  For example, when
8851 @option{-fprintf-return-value} is in effect, both the branch and the
8852 body of the @code{if} statement (but not the call to @code{snprint})
8853 can be optimized away when @code{i} is a 32-bit or smaller integer
8854 because the return value is guaranteed to be at most 8.
8856 @smallexample
8857 char buf[9];
8858 if (snprintf (buf, "%08x", i) >= sizeof buf)
8859   @dots{}
8860 @end smallexample
8862 The @option{-fprintf-return-value} option relies on other optimizations
8863 and yields best results with @option{-O2}.  It works in tandem with the
8864 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8865 The @option{-fprintf-return-value} option is enabled by default.
8867 @item -fno-peephole
8868 @itemx -fno-peephole2
8869 @opindex fno-peephole
8870 @opindex fno-peephole2
8871 Disable any machine-specific peephole optimizations.  The difference
8872 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8873 are implemented in the compiler; some targets use one, some use the
8874 other, a few use both.
8876 @option{-fpeephole} is enabled by default.
8877 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8879 @item -fno-guess-branch-probability
8880 @opindex fno-guess-branch-probability
8881 Do not guess branch probabilities using heuristics.
8883 GCC uses heuristics to guess branch probabilities if they are
8884 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8885 heuristics are based on the control flow graph.  If some branch probabilities
8886 are specified by @code{__builtin_expect}, then the heuristics are
8887 used to guess branch probabilities for the rest of the control flow graph,
8888 taking the @code{__builtin_expect} info into account.  The interactions
8889 between the heuristics and @code{__builtin_expect} can be complex, and in
8890 some cases, it may be useful to disable the heuristics so that the effects
8891 of @code{__builtin_expect} are easier to understand.
8893 The default is @option{-fguess-branch-probability} at levels
8894 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8896 @item -freorder-blocks
8897 @opindex freorder-blocks
8898 Reorder basic blocks in the compiled function in order to reduce number of
8899 taken branches and improve code locality.
8901 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8903 @item -freorder-blocks-algorithm=@var{algorithm}
8904 @opindex freorder-blocks-algorithm
8905 Use the specified algorithm for basic block reordering.  The
8906 @var{algorithm} argument can be @samp{simple}, which does not increase
8907 code size (except sometimes due to secondary effects like alignment),
8908 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8909 put all often executed code together, minimizing the number of branches
8910 executed by making extra copies of code.
8912 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8913 @samp{stc} at levels @option{-O2}, @option{-O3}.
8915 @item -freorder-blocks-and-partition
8916 @opindex freorder-blocks-and-partition
8917 In addition to reordering basic blocks in the compiled function, in order
8918 to reduce number of taken branches, partitions hot and cold basic blocks
8919 into separate sections of the assembly and @file{.o} files, to improve
8920 paging and cache locality performance.
8922 This optimization is automatically turned off in the presence of
8923 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8924 section attribute and on any architecture that does not support named
8925 sections.  When @option{-fsplit-stack} is used this option is not
8926 enabled by default (to avoid linker errors), but may be enabled
8927 explicitly (if using a working linker).
8929 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8931 @item -freorder-functions
8932 @opindex freorder-functions
8933 Reorder functions in the object file in order to
8934 improve code locality.  This is implemented by using special
8935 subsections @code{.text.hot} for most frequently executed functions and
8936 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8937 the linker so object file format must support named sections and linker must
8938 place them in a reasonable way.
8940 Also profile feedback must be available to make this option effective.  See
8941 @option{-fprofile-arcs} for details.
8943 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8945 @item -fstrict-aliasing
8946 @opindex fstrict-aliasing
8947 Allow the compiler to assume the strictest aliasing rules applicable to
8948 the language being compiled.  For C (and C++), this activates
8949 optimizations based on the type of expressions.  In particular, an
8950 object of one type is assumed never to reside at the same address as an
8951 object of a different type, unless the types are almost the same.  For
8952 example, an @code{unsigned int} can alias an @code{int}, but not a
8953 @code{void*} or a @code{double}.  A character type may alias any other
8954 type.
8956 @anchor{Type-punning}Pay special attention to code like this:
8957 @smallexample
8958 union a_union @{
8959   int i;
8960   double d;
8963 int f() @{
8964   union a_union t;
8965   t.d = 3.0;
8966   return t.i;
8968 @end smallexample
8969 The practice of reading from a different union member than the one most
8970 recently written to (called ``type-punning'') is common.  Even with
8971 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8972 is accessed through the union type.  So, the code above works as
8973 expected.  @xref{Structures unions enumerations and bit-fields
8974 implementation}.  However, this code might not:
8975 @smallexample
8976 int f() @{
8977   union a_union t;
8978   int* ip;
8979   t.d = 3.0;
8980   ip = &t.i;
8981   return *ip;
8983 @end smallexample
8985 Similarly, access by taking the address, casting the resulting pointer
8986 and dereferencing the result has undefined behavior, even if the cast
8987 uses a union type, e.g.:
8988 @smallexample
8989 int f() @{
8990   double d = 3.0;
8991   return ((union a_union *) &d)->i;
8993 @end smallexample
8995 The @option{-fstrict-aliasing} option is enabled at levels
8996 @option{-O2}, @option{-O3}, @option{-Os}.
8998 @item -falign-functions
8999 @itemx -falign-functions=@var{n}
9000 @opindex falign-functions
9001 Align the start of functions to the next power-of-two greater than
9002 @var{n}, skipping up to @var{n} bytes.  For instance,
9003 @option{-falign-functions=32} aligns functions to the next 32-byte
9004 boundary, but @option{-falign-functions=24} aligns to the next
9005 32-byte boundary only if this can be done by skipping 23 bytes or less.
9007 @option{-fno-align-functions} and @option{-falign-functions=1} are
9008 equivalent and mean that functions are not aligned.
9010 Some assemblers only support this flag when @var{n} is a power of two;
9011 in that case, it is rounded up.
9013 If @var{n} is not specified or is zero, use a machine-dependent default.
9015 Enabled at levels @option{-O2}, @option{-O3}.
9017 @item -flimit-function-alignment
9018 If this option is enabled, the compiler tries to avoid unnecessarily
9019 overaligning functions. It attempts to instruct the assembler to align
9020 by the amount specified by @option{-falign-functions}, but not to
9021 skip more bytes than the size of the function.
9023 @item -falign-labels
9024 @itemx -falign-labels=@var{n}
9025 @opindex falign-labels
9026 Align all branch targets to a power-of-two boundary, skipping up to
9027 @var{n} bytes like @option{-falign-functions}.  This option can easily
9028 make code slower, because it must insert dummy operations for when the
9029 branch target is reached in the usual flow of the code.
9031 @option{-fno-align-labels} and @option{-falign-labels=1} are
9032 equivalent and mean that labels are not aligned.
9034 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9035 are greater than this value, then their values are used instead.
9037 If @var{n} is not specified or is zero, use a machine-dependent default
9038 which is very likely to be @samp{1}, meaning no alignment.
9040 Enabled at levels @option{-O2}, @option{-O3}.
9042 @item -falign-loops
9043 @itemx -falign-loops=@var{n}
9044 @opindex falign-loops
9045 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9046 like @option{-falign-functions}.  If the loops are
9047 executed many times, this makes up for any execution of the dummy
9048 operations.
9050 @option{-fno-align-loops} and @option{-falign-loops=1} are
9051 equivalent and mean that loops are not aligned.
9053 If @var{n} is not specified or is zero, use a machine-dependent default.
9055 Enabled at levels @option{-O2}, @option{-O3}.
9057 @item -falign-jumps
9058 @itemx -falign-jumps=@var{n}
9059 @opindex falign-jumps
9060 Align branch targets to a power-of-two boundary, for branch targets
9061 where the targets can only be reached by jumping, skipping up to @var{n}
9062 bytes like @option{-falign-functions}.  In this case, no dummy operations
9063 need be executed.
9065 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9066 equivalent and mean that loops are not aligned.
9068 If @var{n} is not specified or is zero, use a machine-dependent default.
9070 Enabled at levels @option{-O2}, @option{-O3}.
9072 @item -funit-at-a-time
9073 @opindex funit-at-a-time
9074 This option is left for compatibility reasons. @option{-funit-at-a-time}
9075 has no effect, while @option{-fno-unit-at-a-time} implies
9076 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9078 Enabled by default.
9080 @item -fno-toplevel-reorder
9081 @opindex fno-toplevel-reorder
9082 Do not reorder top-level functions, variables, and @code{asm}
9083 statements.  Output them in the same order that they appear in the
9084 input file.  When this option is used, unreferenced static variables
9085 are not removed.  This option is intended to support existing code
9086 that relies on a particular ordering.  For new code, it is better to
9087 use attributes when possible.
9089 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9090 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9091 targets.
9093 @item -fweb
9094 @opindex fweb
9095 Constructs webs as commonly used for register allocation purposes and assign
9096 each web individual pseudo register.  This allows the register allocation pass
9097 to operate on pseudos directly, but also strengthens several other optimization
9098 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9099 however, make debugging impossible, since variables no longer stay in a
9100 ``home register''.
9102 Enabled by default with @option{-funroll-loops}.
9104 @item -fwhole-program
9105 @opindex fwhole-program
9106 Assume that the current compilation unit represents the whole program being
9107 compiled.  All public functions and variables with the exception of @code{main}
9108 and those merged by attribute @code{externally_visible} become static functions
9109 and in effect are optimized more aggressively by interprocedural optimizers.
9111 This option should not be used in combination with @option{-flto}.
9112 Instead relying on a linker plugin should provide safer and more precise
9113 information.
9115 @item -flto[=@var{n}]
9116 @opindex flto
9117 This option runs the standard link-time optimizer.  When invoked
9118 with source code, it generates GIMPLE (one of GCC's internal
9119 representations) and writes it to special ELF sections in the object
9120 file.  When the object files are linked together, all the function
9121 bodies are read from these ELF sections and instantiated as if they
9122 had been part of the same translation unit.
9124 To use the link-time optimizer, @option{-flto} and optimization
9125 options should be specified at compile time and during the final link.
9126 It is recommended that you compile all the files participating in the
9127 same link with the same options and also specify those options at
9128 link time.  
9129 For example:
9131 @smallexample
9132 gcc -c -O2 -flto foo.c
9133 gcc -c -O2 -flto bar.c
9134 gcc -o myprog -flto -O2 foo.o bar.o
9135 @end smallexample
9137 The first two invocations to GCC save a bytecode representation
9138 of GIMPLE into special ELF sections inside @file{foo.o} and
9139 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9140 @file{foo.o} and @file{bar.o}, merges the two files into a single
9141 internal image, and compiles the result as usual.  Since both
9142 @file{foo.o} and @file{bar.o} are merged into a single image, this
9143 causes all the interprocedural analyses and optimizations in GCC to
9144 work across the two files as if they were a single one.  This means,
9145 for example, that the inliner is able to inline functions in
9146 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9148 Another (simpler) way to enable link-time optimization is:
9150 @smallexample
9151 gcc -o myprog -flto -O2 foo.c bar.c
9152 @end smallexample
9154 The above generates bytecode for @file{foo.c} and @file{bar.c},
9155 merges them together into a single GIMPLE representation and optimizes
9156 them as usual to produce @file{myprog}.
9158 The only important thing to keep in mind is that to enable link-time
9159 optimizations you need to use the GCC driver to perform the link step.
9160 GCC then automatically performs link-time optimization if any of the
9161 objects involved were compiled with the @option{-flto} command-line option.  
9162 You generally
9163 should specify the optimization options to be used for link-time
9164 optimization though GCC tries to be clever at guessing an
9165 optimization level to use from the options used at compile time
9166 if you fail to specify one at link time.  You can always override
9167 the automatic decision to do link-time optimization
9168 by passing @option{-fno-lto} to the link command.
9170 To make whole program optimization effective, it is necessary to make
9171 certain whole program assumptions.  The compiler needs to know
9172 what functions and variables can be accessed by libraries and runtime
9173 outside of the link-time optimized unit.  When supported by the linker,
9174 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9175 to the compiler about used and externally visible symbols.  When
9176 the linker plugin is not available, @option{-fwhole-program} should be
9177 used to allow the compiler to make these assumptions, which leads
9178 to more aggressive optimization decisions.
9180 When @option{-fuse-linker-plugin} is not enabled, when a file is
9181 compiled with @option{-flto}, the generated object file is larger than
9182 a regular object file because it contains GIMPLE bytecodes and the usual
9183 final code (see @option{-ffat-lto-objects}.  This means that
9184 object files with LTO information can be linked as normal object
9185 files; if @option{-fno-lto} is passed to the linker, no
9186 interprocedural optimizations are applied.  Note that when
9187 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9188 but you cannot perform a regular, non-LTO link on them.
9190 Additionally, the optimization flags used to compile individual files
9191 are not necessarily related to those used at link time.  For instance,
9193 @smallexample
9194 gcc -c -O0 -ffat-lto-objects -flto foo.c
9195 gcc -c -O0 -ffat-lto-objects -flto bar.c
9196 gcc -o myprog -O3 foo.o bar.o
9197 @end smallexample
9199 This produces individual object files with unoptimized assembler
9200 code, but the resulting binary @file{myprog} is optimized at
9201 @option{-O3}.  If, instead, the final binary is generated with
9202 @option{-fno-lto}, then @file{myprog} is not optimized.
9204 When producing the final binary, GCC only
9205 applies link-time optimizations to those files that contain bytecode.
9206 Therefore, you can mix and match object files and libraries with
9207 GIMPLE bytecodes and final object code.  GCC automatically selects
9208 which files to optimize in LTO mode and which files to link without
9209 further processing.
9211 There are some code generation flags preserved by GCC when
9212 generating bytecodes, as they need to be used during the final link
9213 stage.  Generally options specified at link time override those
9214 specified at compile time.
9216 If you do not specify an optimization level option @option{-O} at
9217 link time, then GCC uses the highest optimization level 
9218 used when compiling the object files.
9220 Currently, the following options and their settings are taken from
9221 the first object file that explicitly specifies them: 
9222 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9223 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9224 and all the @option{-m} target flags.
9226 Certain ABI-changing flags are required to match in all compilation units,
9227 and trying to override this at link time with a conflicting value
9228 is ignored.  This includes options such as @option{-freg-struct-return}
9229 and @option{-fpcc-struct-return}. 
9231 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9232 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9233 are passed through to the link stage and merged conservatively for
9234 conflicting translation units.  Specifically
9235 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9236 precedence; and for example @option{-ffp-contract=off} takes precedence
9237 over @option{-ffp-contract=fast}.  You can override them at link time.
9239 If LTO encounters objects with C linkage declared with incompatible
9240 types in separate translation units to be linked together (undefined
9241 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9242 issued.  The behavior is still undefined at run time.  Similar
9243 diagnostics may be raised for other languages.
9245 Another feature of LTO is that it is possible to apply interprocedural
9246 optimizations on files written in different languages:
9248 @smallexample
9249 gcc -c -flto foo.c
9250 g++ -c -flto bar.cc
9251 gfortran -c -flto baz.f90
9252 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9253 @end smallexample
9255 Notice that the final link is done with @command{g++} to get the C++
9256 runtime libraries and @option{-lgfortran} is added to get the Fortran
9257 runtime libraries.  In general, when mixing languages in LTO mode, you
9258 should use the same link command options as when mixing languages in a
9259 regular (non-LTO) compilation.
9261 If object files containing GIMPLE bytecode are stored in a library archive, say
9262 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9263 are using a linker with plugin support.  To create static libraries suitable
9264 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9265 and @command{ranlib}; 
9266 to show the symbols of object files with GIMPLE bytecode, use
9267 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9268 and @command{nm} have been compiled with plugin support.  At link time, use the the
9269 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9270 the LTO optimization process:
9272 @smallexample
9273 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9274 @end smallexample
9276 With the linker plugin enabled, the linker extracts the needed
9277 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9278 to make them part of the aggregated GIMPLE image to be optimized.
9280 If you are not using a linker with plugin support and/or do not
9281 enable the linker plugin, then the objects inside @file{libfoo.a}
9282 are extracted and linked as usual, but they do not participate
9283 in the LTO optimization process.  In order to make a static library suitable
9284 for both LTO optimization and usual linkage, compile its object files with
9285 @option{-flto} @option{-ffat-lto-objects}.
9287 Link-time optimizations do not require the presence of the whole program to
9288 operate.  If the program does not require any symbols to be exported, it is
9289 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9290 the interprocedural optimizers to use more aggressive assumptions which may
9291 lead to improved optimization opportunities.
9292 Use of @option{-fwhole-program} is not needed when linker plugin is
9293 active (see @option{-fuse-linker-plugin}).
9295 The current implementation of LTO makes no
9296 attempt to generate bytecode that is portable between different
9297 types of hosts.  The bytecode files are versioned and there is a
9298 strict version check, so bytecode files generated in one version of
9299 GCC do not work with an older or newer version of GCC.
9301 Link-time optimization does not work well with generation of debugging
9302 information.  Combining @option{-flto} with
9303 @option{-g} is currently experimental and expected to produce unexpected
9304 results.
9306 If you specify the optional @var{n}, the optimization and code
9307 generation done at link time is executed in parallel using @var{n}
9308 parallel jobs by utilizing an installed @command{make} program.  The
9309 environment variable @env{MAKE} may be used to override the program
9310 used.  The default value for @var{n} is 1.
9312 You can also specify @option{-flto=jobserver} to use GNU make's
9313 job server mode to determine the number of parallel jobs. This
9314 is useful when the Makefile calling GCC is already executing in parallel.
9315 You must prepend a @samp{+} to the command recipe in the parent Makefile
9316 for this to work.  This option likely only works if @env{MAKE} is
9317 GNU make.
9319 @item -flto-partition=@var{alg}
9320 @opindex flto-partition
9321 Specify the partitioning algorithm used by the link-time optimizer.
9322 The value is either @samp{1to1} to specify a partitioning mirroring
9323 the original source files or @samp{balanced} to specify partitioning
9324 into equally sized chunks (whenever possible) or @samp{max} to create
9325 new partition for every symbol where possible.  Specifying @samp{none}
9326 as an algorithm disables partitioning and streaming completely. 
9327 The default value is @samp{balanced}. While @samp{1to1} can be used
9328 as an workaround for various code ordering issues, the @samp{max}
9329 partitioning is intended for internal testing only.
9330 The value @samp{one} specifies that exactly one partition should be
9331 used while the value @samp{none} bypasses partitioning and executes
9332 the link-time optimization step directly from the WPA phase.
9334 @item -flto-odr-type-merging
9335 @opindex flto-odr-type-merging
9336 Enable streaming of mangled types names of C++ types and their unification
9337 at link time.  This increases size of LTO object files, but enables
9338 diagnostics about One Definition Rule violations.
9340 @item -flto-compression-level=@var{n}
9341 @opindex flto-compression-level
9342 This option specifies the level of compression used for intermediate
9343 language written to LTO object files, and is only meaningful in
9344 conjunction with LTO mode (@option{-flto}).  Valid
9345 values are 0 (no compression) to 9 (maximum compression).  Values
9346 outside this range are clamped to either 0 or 9.  If the option is not
9347 given, a default balanced compression setting is used.
9349 @item -fuse-linker-plugin
9350 @opindex fuse-linker-plugin
9351 Enables the use of a linker plugin during link-time optimization.  This
9352 option relies on plugin support in the linker, which is available in gold
9353 or in GNU ld 2.21 or newer.
9355 This option enables the extraction of object files with GIMPLE bytecode out
9356 of library archives. This improves the quality of optimization by exposing
9357 more code to the link-time optimizer.  This information specifies what
9358 symbols can be accessed externally (by non-LTO object or during dynamic
9359 linking).  Resulting code quality improvements on binaries (and shared
9360 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9361 See @option{-flto} for a description of the effect of this flag and how to
9362 use it.
9364 This option is enabled by default when LTO support in GCC is enabled
9365 and GCC was configured for use with
9366 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9368 @item -ffat-lto-objects
9369 @opindex ffat-lto-objects
9370 Fat LTO objects are object files that contain both the intermediate language
9371 and the object code. This makes them usable for both LTO linking and normal
9372 linking. This option is effective only when compiling with @option{-flto}
9373 and is ignored at link time.
9375 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9376 requires the complete toolchain to be aware of LTO. It requires a linker with
9377 linker plugin support for basic functionality.  Additionally,
9378 @command{nm}, @command{ar} and @command{ranlib}
9379 need to support linker plugins to allow a full-featured build environment
9380 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9381 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9382 to these tools. With non fat LTO makefiles need to be modified to use them.
9384 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9385 support.
9387 @item -fcompare-elim
9388 @opindex fcompare-elim
9389 After register allocation and post-register allocation instruction splitting,
9390 identify arithmetic instructions that compute processor flags similar to a
9391 comparison operation based on that arithmetic.  If possible, eliminate the
9392 explicit comparison operation.
9394 This pass only applies to certain targets that cannot explicitly represent
9395 the comparison operation before register allocation is complete.
9397 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9399 @item -fcprop-registers
9400 @opindex fcprop-registers
9401 After register allocation and post-register allocation instruction splitting,
9402 perform a copy-propagation pass to try to reduce scheduling dependencies
9403 and occasionally eliminate the copy.
9405 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9407 @item -fprofile-correction
9408 @opindex fprofile-correction
9409 Profiles collected using an instrumented binary for multi-threaded programs may
9410 be inconsistent due to missed counter updates. When this option is specified,
9411 GCC uses heuristics to correct or smooth out such inconsistencies. By
9412 default, GCC emits an error message when an inconsistent profile is detected.
9414 @item -fprofile-use
9415 @itemx -fprofile-use=@var{path}
9416 @opindex fprofile-use
9417 Enable profile feedback-directed optimizations, 
9418 and the following optimizations
9419 which are generally profitable only with profile feedback available:
9420 @option{-fbranch-probabilities}, @option{-fvpt},
9421 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9422 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9424 Before you can use this option, you must first generate profiling information.
9425 @xref{Instrumentation Options}, for information about the
9426 @option{-fprofile-generate} option.
9428 By default, GCC emits an error message if the feedback profiles do not
9429 match the source code.  This error can be turned into a warning by using
9430 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9431 code.
9433 If @var{path} is specified, GCC looks at the @var{path} to find
9434 the profile feedback data files. See @option{-fprofile-dir}.
9436 @item -fauto-profile
9437 @itemx -fauto-profile=@var{path}
9438 @opindex fauto-profile
9439 Enable sampling-based feedback-directed optimizations, 
9440 and the following optimizations
9441 which are generally profitable only with profile feedback available:
9442 @option{-fbranch-probabilities}, @option{-fvpt},
9443 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9444 @option{-ftree-vectorize},
9445 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9446 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9447 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9449 @var{path} is the name of a file containing AutoFDO profile information.
9450 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9452 Producing an AutoFDO profile data file requires running your program
9453 with the @command{perf} utility on a supported GNU/Linux target system.
9454 For more information, see @uref{https://perf.wiki.kernel.org/}.
9456 E.g.
9457 @smallexample
9458 perf record -e br_inst_retired:near_taken -b -o perf.data \
9459     -- your_program
9460 @end smallexample
9462 Then use the @command{create_gcov} tool to convert the raw profile data
9463 to a format that can be used by GCC.@  You must also supply the 
9464 unstripped binary for your program to this tool.  
9465 See @uref{https://github.com/google/autofdo}.
9467 E.g.
9468 @smallexample
9469 create_gcov --binary=your_program.unstripped --profile=perf.data \
9470     --gcov=profile.afdo
9471 @end smallexample
9472 @end table
9474 The following options control compiler behavior regarding floating-point 
9475 arithmetic.  These options trade off between speed and
9476 correctness.  All must be specifically enabled.
9478 @table @gcctabopt
9479 @item -ffloat-store
9480 @opindex ffloat-store
9481 Do not store floating-point variables in registers, and inhibit other
9482 options that might change whether a floating-point value is taken from a
9483 register or memory.
9485 @cindex floating-point precision
9486 This option prevents undesirable excess precision on machines such as
9487 the 68000 where the floating registers (of the 68881) keep more
9488 precision than a @code{double} is supposed to have.  Similarly for the
9489 x86 architecture.  For most programs, the excess precision does only
9490 good, but a few programs rely on the precise definition of IEEE floating
9491 point.  Use @option{-ffloat-store} for such programs, after modifying
9492 them to store all pertinent intermediate computations into variables.
9494 @item -fexcess-precision=@var{style}
9495 @opindex fexcess-precision
9496 This option allows further control over excess precision on machines
9497 where floating-point operations occur in a format with more precision or
9498 range than the IEEE standard and interchange floating-point types.  By
9499 default, @option{-fexcess-precision=fast} is in effect; this means that
9500 operations may be carried out in a wider precision than the types specified
9501 in the source if that would result in faster code, and it is unpredictable
9502 when rounding to the types specified in the source code takes place.
9503 When compiling C, if @option{-fexcess-precision=standard} is specified then
9504 excess precision follows the rules specified in ISO C99; in particular,
9505 both casts and assignments cause values to be rounded to their
9506 semantic types (whereas @option{-ffloat-store} only affects
9507 assignments).  This option is enabled by default for C if a strict
9508 conformance option such as @option{-std=c99} is used.
9509 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9510 regardless of whether a strict conformance option is used.
9512 @opindex mfpmath
9513 @option{-fexcess-precision=standard} is not implemented for languages
9514 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9515 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9516 semantics apply without excess precision, and in the latter, rounding
9517 is unpredictable.
9519 @item -ffast-math
9520 @opindex ffast-math
9521 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9522 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9523 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9524 @option{-fexcess-precision=fast}.
9526 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9528 This option is not turned on by any @option{-O} option besides
9529 @option{-Ofast} since it can result in incorrect output for programs
9530 that depend on an exact implementation of IEEE or ISO rules/specifications
9531 for math functions. It may, however, yield faster code for programs
9532 that do not require the guarantees of these specifications.
9534 @item -fno-math-errno
9535 @opindex fno-math-errno
9536 Do not set @code{errno} after calling math functions that are executed
9537 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9538 IEEE exceptions for math error handling may want to use this flag
9539 for speed while maintaining IEEE arithmetic compatibility.
9541 This option is not turned on by any @option{-O} option since
9542 it can result in incorrect output for programs that depend on
9543 an exact implementation of IEEE or ISO rules/specifications for
9544 math functions. It may, however, yield faster code for programs
9545 that do not require the guarantees of these specifications.
9547 The default is @option{-fmath-errno}.
9549 On Darwin systems, the math library never sets @code{errno}.  There is
9550 therefore no reason for the compiler to consider the possibility that
9551 it might, and @option{-fno-math-errno} is the default.
9553 @item -funsafe-math-optimizations
9554 @opindex funsafe-math-optimizations
9556 Allow optimizations for floating-point arithmetic that (a) assume
9557 that arguments and results are valid and (b) may violate IEEE or
9558 ANSI standards.  When used at link time, it may include libraries
9559 or startup files that change the default FPU control word or other
9560 similar optimizations.
9562 This option is not turned on by any @option{-O} option since
9563 it can result in incorrect output for programs that depend on
9564 an exact implementation of IEEE or ISO rules/specifications for
9565 math functions. It may, however, yield faster code for programs
9566 that do not require the guarantees of these specifications.
9567 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9568 @option{-fassociative-math} and @option{-freciprocal-math}.
9570 The default is @option{-fno-unsafe-math-optimizations}.
9572 @item -fassociative-math
9573 @opindex fassociative-math
9575 Allow re-association of operands in series of floating-point operations.
9576 This violates the ISO C and C++ language standard by possibly changing
9577 computation result.  NOTE: re-ordering may change the sign of zero as
9578 well as ignore NaNs and inhibit or create underflow or overflow (and
9579 thus cannot be used on code that relies on rounding behavior like
9580 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9581 and thus may not be used when ordered comparisons are required.
9582 This option requires that both @option{-fno-signed-zeros} and
9583 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9584 much sense with @option{-frounding-math}. For Fortran the option
9585 is automatically enabled when both @option{-fno-signed-zeros} and
9586 @option{-fno-trapping-math} are in effect.
9588 The default is @option{-fno-associative-math}.
9590 @item -freciprocal-math
9591 @opindex freciprocal-math
9593 Allow the reciprocal of a value to be used instead of dividing by
9594 the value if this enables optimizations.  For example @code{x / y}
9595 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9596 is subject to common subexpression elimination.  Note that this loses
9597 precision and increases the number of flops operating on the value.
9599 The default is @option{-fno-reciprocal-math}.
9601 @item -ffinite-math-only
9602 @opindex ffinite-math-only
9603 Allow optimizations for floating-point arithmetic that assume
9604 that arguments and results are not NaNs or +-Infs.
9606 This option is not turned on by any @option{-O} option since
9607 it can result in incorrect output for programs that depend on
9608 an exact implementation of IEEE or ISO rules/specifications for
9609 math functions. It may, however, yield faster code for programs
9610 that do not require the guarantees of these specifications.
9612 The default is @option{-fno-finite-math-only}.
9614 @item -fno-signed-zeros
9615 @opindex fno-signed-zeros
9616 Allow optimizations for floating-point arithmetic that ignore the
9617 signedness of zero.  IEEE arithmetic specifies the behavior of
9618 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9619 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9620 This option implies that the sign of a zero result isn't significant.
9622 The default is @option{-fsigned-zeros}.
9624 @item -fno-trapping-math
9625 @opindex fno-trapping-math
9626 Compile code assuming that floating-point operations cannot generate
9627 user-visible traps.  These traps include division by zero, overflow,
9628 underflow, inexact result and invalid operation.  This option requires
9629 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9630 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9632 This option should never be turned on by any @option{-O} option since
9633 it can result in incorrect output for programs that depend on
9634 an exact implementation of IEEE or ISO rules/specifications for
9635 math functions.
9637 The default is @option{-ftrapping-math}.
9639 @item -frounding-math
9640 @opindex frounding-math
9641 Disable transformations and optimizations that assume default floating-point
9642 rounding behavior.  This is round-to-zero for all floating point
9643 to integer conversions, and round-to-nearest for all other arithmetic
9644 truncations.  This option should be specified for programs that change
9645 the FP rounding mode dynamically, or that may be executed with a
9646 non-default rounding mode.  This option disables constant folding of
9647 floating-point expressions at compile time (which may be affected by
9648 rounding mode) and arithmetic transformations that are unsafe in the
9649 presence of sign-dependent rounding modes.
9651 The default is @option{-fno-rounding-math}.
9653 This option is experimental and does not currently guarantee to
9654 disable all GCC optimizations that are affected by rounding mode.
9655 Future versions of GCC may provide finer control of this setting
9656 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9657 will be used to specify the default state for @code{FENV_ACCESS}.
9659 @item -fsignaling-nans
9660 @opindex fsignaling-nans
9661 Compile code assuming that IEEE signaling NaNs may generate user-visible
9662 traps during floating-point operations.  Setting this option disables
9663 optimizations that may change the number of exceptions visible with
9664 signaling NaNs.  This option implies @option{-ftrapping-math}.
9666 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9667 be defined.
9669 The default is @option{-fno-signaling-nans}.
9671 This option is experimental and does not currently guarantee to
9672 disable all GCC optimizations that affect signaling NaN behavior.
9674 @item -fno-fp-int-builtin-inexact
9675 @opindex fno-fp-int-builtin-inexact
9676 Do not allow the built-in functions @code{ceil}, @code{floor},
9677 @code{round} and @code{trunc}, and their @code{float} and @code{long
9678 double} variants, to generate code that raises the ``inexact''
9679 floating-point exception for noninteger arguments.  ISO C99 and C11
9680 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9681 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9682 functions to do so.
9684 The default is @option{-ffp-int-builtin-inexact}, allowing the
9685 exception to be raised.  This option does nothing unless
9686 @option{-ftrapping-math} is in effect.
9688 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9689 generate a call to a library function then the ``inexact'' exception
9690 may be raised if the library implementation does not follow TS 18661.
9692 @item -fsingle-precision-constant
9693 @opindex fsingle-precision-constant
9694 Treat floating-point constants as single precision instead of
9695 implicitly converting them to double-precision constants.
9697 @item -fcx-limited-range
9698 @opindex fcx-limited-range
9699 When enabled, this option states that a range reduction step is not
9700 needed when performing complex division.  Also, there is no checking
9701 whether the result of a complex multiplication or division is @code{NaN
9702 + I*NaN}, with an attempt to rescue the situation in that case.  The
9703 default is @option{-fno-cx-limited-range}, but is enabled by
9704 @option{-ffast-math}.
9706 This option controls the default setting of the ISO C99
9707 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9708 all languages.
9710 @item -fcx-fortran-rules
9711 @opindex fcx-fortran-rules
9712 Complex multiplication and division follow Fortran rules.  Range
9713 reduction is done as part of complex division, but there is no checking
9714 whether the result of a complex multiplication or division is @code{NaN
9715 + I*NaN}, with an attempt to rescue the situation in that case.
9717 The default is @option{-fno-cx-fortran-rules}.
9719 @end table
9721 The following options control optimizations that may improve
9722 performance, but are not enabled by any @option{-O} options.  This
9723 section includes experimental options that may produce broken code.
9725 @table @gcctabopt
9726 @item -fbranch-probabilities
9727 @opindex fbranch-probabilities
9728 After running a program compiled with @option{-fprofile-arcs}
9729 (@pxref{Instrumentation Options}),
9730 you can compile it a second time using
9731 @option{-fbranch-probabilities}, to improve optimizations based on
9732 the number of times each branch was taken.  When a program
9733 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9734 counts to a file called @file{@var{sourcename}.gcda} for each source
9735 file.  The information in this data file is very dependent on the
9736 structure of the generated code, so you must use the same source code
9737 and the same optimization options for both compilations.
9739 With @option{-fbranch-probabilities}, GCC puts a
9740 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9741 These can be used to improve optimization.  Currently, they are only
9742 used in one place: in @file{reorg.c}, instead of guessing which path a
9743 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9744 exactly determine which path is taken more often.
9746 @item -fprofile-values
9747 @opindex fprofile-values
9748 If combined with @option{-fprofile-arcs}, it adds code so that some
9749 data about values of expressions in the program is gathered.
9751 With @option{-fbranch-probabilities}, it reads back the data gathered
9752 from profiling values of expressions for usage in optimizations.
9754 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9756 @item -fprofile-reorder-functions
9757 @opindex fprofile-reorder-functions
9758 Function reordering based on profile instrumentation collects
9759 first time of execution of a function and orders these functions
9760 in ascending order.
9762 Enabled with @option{-fprofile-use}.
9764 @item -fvpt
9765 @opindex fvpt
9766 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9767 to add code to gather information about values of expressions.
9769 With @option{-fbranch-probabilities}, it reads back the data gathered
9770 and actually performs the optimizations based on them.
9771 Currently the optimizations include specialization of division operations
9772 using the knowledge about the value of the denominator.
9774 @item -frename-registers
9775 @opindex frename-registers
9776 Attempt to avoid false dependencies in scheduled code by making use
9777 of registers left over after register allocation.  This optimization
9778 most benefits processors with lots of registers.  Depending on the
9779 debug information format adopted by the target, however, it can
9780 make debugging impossible, since variables no longer stay in
9781 a ``home register''.
9783 Enabled by default with @option{-funroll-loops}.
9785 @item -fschedule-fusion
9786 @opindex fschedule-fusion
9787 Performs a target dependent pass over the instruction stream to schedule
9788 instructions of same type together because target machine can execute them
9789 more efficiently if they are adjacent to each other in the instruction flow.
9791 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9793 @item -ftracer
9794 @opindex ftracer
9795 Perform tail duplication to enlarge superblock size.  This transformation
9796 simplifies the control flow of the function allowing other optimizations to do
9797 a better job.
9799 Enabled with @option{-fprofile-use}.
9801 @item -funroll-loops
9802 @opindex funroll-loops
9803 Unroll loops whose number of iterations can be determined at compile time or
9804 upon entry to the loop.  @option{-funroll-loops} implies
9805 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9806 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9807 a small constant number of iterations).  This option makes code larger, and may
9808 or may not make it run faster.
9810 Enabled with @option{-fprofile-use}.
9812 @item -funroll-all-loops
9813 @opindex funroll-all-loops
9814 Unroll all loops, even if their number of iterations is uncertain when
9815 the loop is entered.  This usually makes programs run more slowly.
9816 @option{-funroll-all-loops} implies the same options as
9817 @option{-funroll-loops}.
9819 @item -fpeel-loops
9820 @opindex fpeel-loops
9821 Peels loops for which there is enough information that they do not
9822 roll much (from profile feedback or static analysis).  It also turns on
9823 complete loop peeling (i.e.@: complete removal of loops with small constant
9824 number of iterations).
9826 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9828 @item -fmove-loop-invariants
9829 @opindex fmove-loop-invariants
9830 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9831 at level @option{-O1}
9833 @item -fsplit-loops
9834 @opindex fsplit-loops
9835 Split a loop into two if it contains a condition that's always true
9836 for one side of the iteration space and false for the other.
9838 @item -funswitch-loops
9839 @opindex funswitch-loops
9840 Move branches with loop invariant conditions out of the loop, with duplicates
9841 of the loop on both branches (modified according to result of the condition).
9843 @item -floop-unroll-and-jam
9844 @opindex floop-unroll-and-jam
9845 Apply unroll and jam transformations on feasible loops.  In a loop
9846 nest this unrolls the outer loop by some factor and fuses the resulting
9847 multiple inner loops.
9849 @item -ffunction-sections
9850 @itemx -fdata-sections
9851 @opindex ffunction-sections
9852 @opindex fdata-sections
9853 Place each function or data item into its own section in the output
9854 file if the target supports arbitrary sections.  The name of the
9855 function or the name of the data item determines the section's name
9856 in the output file.
9858 Use these options on systems where the linker can perform optimizations to
9859 improve locality of reference in the instruction space.  Most systems using the
9860 ELF object format have linkers with such optimizations.  On AIX, the linker
9861 rearranges sections (CSECTs) based on the call graph.  The performance impact
9862 varies.
9864 Together with a linker garbage collection (linker @option{--gc-sections}
9865 option) these options may lead to smaller statically-linked executables (after
9866 stripping).
9868 On ELF/DWARF systems these options do not degenerate the quality of the debug
9869 information.  There could be issues with other object files/debug info formats.
9871 Only use these options when there are significant benefits from doing so.  When
9872 you specify these options, the assembler and linker create larger object and
9873 executable files and are also slower.  These options affect code generation.
9874 They prevent optimizations by the compiler and assembler using relative
9875 locations inside a translation unit since the locations are unknown until
9876 link time.  An example of such an optimization is relaxing calls to short call
9877 instructions.
9879 @item -fbranch-target-load-optimize
9880 @opindex fbranch-target-load-optimize
9881 Perform branch target register load optimization before prologue / epilogue
9882 threading.
9883 The use of target registers can typically be exposed only during reload,
9884 thus hoisting loads out of loops and doing inter-block scheduling needs
9885 a separate optimization pass.
9887 @item -fbranch-target-load-optimize2
9888 @opindex fbranch-target-load-optimize2
9889 Perform branch target register load optimization after prologue / epilogue
9890 threading.
9892 @item -fbtr-bb-exclusive
9893 @opindex fbtr-bb-exclusive
9894 When performing branch target register load optimization, don't reuse
9895 branch target registers within any basic block.
9897 @item -fstdarg-opt
9898 @opindex fstdarg-opt
9899 Optimize the prologue of variadic argument functions with respect to usage of
9900 those arguments.
9902 @item -fsection-anchors
9903 @opindex fsection-anchors
9904 Try to reduce the number of symbolic address calculations by using
9905 shared ``anchor'' symbols to address nearby objects.  This transformation
9906 can help to reduce the number of GOT entries and GOT accesses on some
9907 targets.
9909 For example, the implementation of the following function @code{foo}:
9911 @smallexample
9912 static int a, b, c;
9913 int foo (void) @{ return a + b + c; @}
9914 @end smallexample
9916 @noindent
9917 usually calculates the addresses of all three variables, but if you
9918 compile it with @option{-fsection-anchors}, it accesses the variables
9919 from a common anchor point instead.  The effect is similar to the
9920 following pseudocode (which isn't valid C):
9922 @smallexample
9923 int foo (void)
9925   register int *xr = &x;
9926   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9928 @end smallexample
9930 Not all targets support this option.
9932 @item --param @var{name}=@var{value}
9933 @opindex param
9934 In some places, GCC uses various constants to control the amount of
9935 optimization that is done.  For example, GCC does not inline functions
9936 that contain more than a certain number of instructions.  You can
9937 control some of these constants on the command line using the
9938 @option{--param} option.
9940 The names of specific parameters, and the meaning of the values, are
9941 tied to the internals of the compiler, and are subject to change
9942 without notice in future releases.
9944 In each case, the @var{value} is an integer.  The allowable choices for
9945 @var{name} are:
9947 @table @gcctabopt
9948 @item predictable-branch-outcome
9949 When branch is predicted to be taken with probability lower than this threshold
9950 (in percent), then it is considered well predictable. The default is 10.
9952 @item max-rtl-if-conversion-insns
9953 RTL if-conversion tries to remove conditional branches around a block and
9954 replace them with conditionally executed instructions.  This parameter
9955 gives the maximum number of instructions in a block which should be
9956 considered for if-conversion.  The default is 10, though the compiler will
9957 also use other heuristics to decide whether if-conversion is likely to be
9958 profitable.
9960 @item max-rtl-if-conversion-predictable-cost
9961 @item max-rtl-if-conversion-unpredictable-cost
9962 RTL if-conversion will try to remove conditional branches around a block
9963 and replace them with conditionally executed instructions.  These parameters
9964 give the maximum permissible cost for the sequence that would be generated
9965 by if-conversion depending on whether the branch is statically determined
9966 to be predictable or not.  The units for this parameter are the same as
9967 those for the GCC internal seq_cost metric.  The compiler will try to
9968 provide a reasonable default for this parameter using the BRANCH_COST
9969 target macro.
9971 @item max-crossjump-edges
9972 The maximum number of incoming edges to consider for cross-jumping.
9973 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9974 the number of edges incoming to each block.  Increasing values mean
9975 more aggressive optimization, making the compilation time increase with
9976 probably small improvement in executable size.
9978 @item min-crossjump-insns
9979 The minimum number of instructions that must be matched at the end
9980 of two blocks before cross-jumping is performed on them.  This
9981 value is ignored in the case where all instructions in the block being
9982 cross-jumped from are matched.  The default value is 5.
9984 @item max-grow-copy-bb-insns
9985 The maximum code size expansion factor when copying basic blocks
9986 instead of jumping.  The expansion is relative to a jump instruction.
9987 The default value is 8.
9989 @item max-goto-duplication-insns
9990 The maximum number of instructions to duplicate to a block that jumps
9991 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9992 passes, GCC factors computed gotos early in the compilation process,
9993 and unfactors them as late as possible.  Only computed jumps at the
9994 end of a basic blocks with no more than max-goto-duplication-insns are
9995 unfactored.  The default value is 8.
9997 @item max-delay-slot-insn-search
9998 The maximum number of instructions to consider when looking for an
9999 instruction to fill a delay slot.  If more than this arbitrary number of
10000 instructions are searched, the time savings from filling the delay slot
10001 are minimal, so stop searching.  Increasing values mean more
10002 aggressive optimization, making the compilation time increase with probably
10003 small improvement in execution time.
10005 @item max-delay-slot-live-search
10006 When trying to fill delay slots, the maximum number of instructions to
10007 consider when searching for a block with valid live register
10008 information.  Increasing this arbitrarily chosen value means more
10009 aggressive optimization, increasing the compilation time.  This parameter
10010 should be removed when the delay slot code is rewritten to maintain the
10011 control-flow graph.
10013 @item max-gcse-memory
10014 The approximate maximum amount of memory that can be allocated in
10015 order to perform the global common subexpression elimination
10016 optimization.  If more memory than specified is required, the
10017 optimization is not done.
10019 @item max-gcse-insertion-ratio
10020 If the ratio of expression insertions to deletions is larger than this value
10021 for any expression, then RTL PRE inserts or removes the expression and thus
10022 leaves partially redundant computations in the instruction stream.  The default value is 20.
10024 @item max-pending-list-length
10025 The maximum number of pending dependencies scheduling allows
10026 before flushing the current state and starting over.  Large functions
10027 with few branches or calls can create excessively large lists which
10028 needlessly consume memory and resources.
10030 @item max-modulo-backtrack-attempts
10031 The maximum number of backtrack attempts the scheduler should make
10032 when modulo scheduling a loop.  Larger values can exponentially increase
10033 compilation time.
10035 @item max-inline-insns-single
10036 Several parameters control the tree inliner used in GCC@.
10037 This number sets the maximum number of instructions (counted in GCC's
10038 internal representation) in a single function that the tree inliner
10039 considers for inlining.  This only affects functions declared
10040 inline and methods implemented in a class declaration (C++).
10041 The default value is 400.
10043 @item max-inline-insns-auto
10044 When you use @option{-finline-functions} (included in @option{-O3}),
10045 a lot of functions that would otherwise not be considered for inlining
10046 by the compiler are investigated.  To those functions, a different
10047 (more restrictive) limit compared to functions declared inline can
10048 be applied.
10049 The default value is 40.
10051 @item inline-min-speedup
10052 When estimated performance improvement of caller + callee runtime exceeds this
10053 threshold (in percent), the function can be inlined regardless of the limit on
10054 @option{--param max-inline-insns-single} and @option{--param
10055 max-inline-insns-auto}.
10057 @item large-function-insns
10058 The limit specifying really large functions.  For functions larger than this
10059 limit after inlining, inlining is constrained by
10060 @option{--param large-function-growth}.  This parameter is useful primarily
10061 to avoid extreme compilation time caused by non-linear algorithms used by the
10062 back end.
10063 The default value is 2700.
10065 @item large-function-growth
10066 Specifies maximal growth of large function caused by inlining in percents.
10067 The default value is 100 which limits large function growth to 2.0 times
10068 the original size.
10070 @item large-unit-insns
10071 The limit specifying large translation unit.  Growth caused by inlining of
10072 units larger than this limit is limited by @option{--param inline-unit-growth}.
10073 For small units this might be too tight.
10074 For example, consider a unit consisting of function A
10075 that is inline and B that just calls A three times.  If B is small relative to
10076 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10077 large units consisting of small inlineable functions, however, the overall unit
10078 growth limit is needed to avoid exponential explosion of code size.  Thus for
10079 smaller units, the size is increased to @option{--param large-unit-insns}
10080 before applying @option{--param inline-unit-growth}.  The default is 10000.
10082 @item inline-unit-growth
10083 Specifies maximal overall growth of the compilation unit caused by inlining.
10084 The default value is 20 which limits unit growth to 1.2 times the original
10085 size. Cold functions (either marked cold via an attribute or by profile
10086 feedback) are not accounted into the unit size.
10088 @item ipcp-unit-growth
10089 Specifies maximal overall growth of the compilation unit caused by
10090 interprocedural constant propagation.  The default value is 10 which limits
10091 unit growth to 1.1 times the original size.
10093 @item large-stack-frame
10094 The limit specifying large stack frames.  While inlining the algorithm is trying
10095 to not grow past this limit too much.  The default value is 256 bytes.
10097 @item large-stack-frame-growth
10098 Specifies maximal growth of large stack frames caused by inlining in percents.
10099 The default value is 1000 which limits large stack frame growth to 11 times
10100 the original size.
10102 @item max-inline-insns-recursive
10103 @itemx max-inline-insns-recursive-auto
10104 Specifies the maximum number of instructions an out-of-line copy of a
10105 self-recursive inline
10106 function can grow into by performing recursive inlining.
10108 @option{--param max-inline-insns-recursive} applies to functions
10109 declared inline.
10110 For functions not declared inline, recursive inlining
10111 happens only when @option{-finline-functions} (included in @option{-O3}) is
10112 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10113 default value is 450.
10115 @item max-inline-recursive-depth
10116 @itemx max-inline-recursive-depth-auto
10117 Specifies the maximum recursion depth used for recursive inlining.
10119 @option{--param max-inline-recursive-depth} applies to functions
10120 declared inline.  For functions not declared inline, recursive inlining
10121 happens only when @option{-finline-functions} (included in @option{-O3}) is
10122 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10123 default value is 8.
10125 @item min-inline-recursive-probability
10126 Recursive inlining is profitable only for function having deep recursion
10127 in average and can hurt for function having little recursion depth by
10128 increasing the prologue size or complexity of function body to other
10129 optimizers.
10131 When profile feedback is available (see @option{-fprofile-generate}) the actual
10132 recursion depth can be guessed from the probability that function recurses
10133 via a given call expression.  This parameter limits inlining only to call
10134 expressions whose probability exceeds the given threshold (in percents).
10135 The default value is 10.
10137 @item early-inlining-insns
10138 Specify growth that the early inliner can make.  In effect it increases
10139 the amount of inlining for code having a large abstraction penalty.
10140 The default value is 14.
10142 @item max-early-inliner-iterations
10143 Limit of iterations of the early inliner.  This basically bounds
10144 the number of nested indirect calls the early inliner can resolve.
10145 Deeper chains are still handled by late inlining.
10147 @item comdat-sharing-probability
10148 Probability (in percent) that C++ inline function with comdat visibility
10149 are shared across multiple compilation units.  The default value is 20.
10151 @item profile-func-internal-id
10152 A parameter to control whether to use function internal id in profile
10153 database lookup. If the value is 0, the compiler uses an id that
10154 is based on function assembler name and filename, which makes old profile
10155 data more tolerant to source changes such as function reordering etc.
10156 The default value is 0.
10158 @item min-vect-loop-bound
10159 The minimum number of iterations under which loops are not vectorized
10160 when @option{-ftree-vectorize} is used.  The number of iterations after
10161 vectorization needs to be greater than the value specified by this option
10162 to allow vectorization.  The default value is 0.
10164 @item gcse-cost-distance-ratio
10165 Scaling factor in calculation of maximum distance an expression
10166 can be moved by GCSE optimizations.  This is currently supported only in the
10167 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10168 is with simple expressions, i.e., the expressions that have cost
10169 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10170 hoisting of simple expressions.  The default value is 10.
10172 @item gcse-unrestricted-cost
10173 Cost, roughly measured as the cost of a single typical machine
10174 instruction, at which GCSE optimizations do not constrain
10175 the distance an expression can travel.  This is currently
10176 supported only in the code hoisting pass.  The lesser the cost,
10177 the more aggressive code hoisting is.  Specifying 0 
10178 allows all expressions to travel unrestricted distances.
10179 The default value is 3.
10181 @item max-hoist-depth
10182 The depth of search in the dominator tree for expressions to hoist.
10183 This is used to avoid quadratic behavior in hoisting algorithm.
10184 The value of 0 does not limit on the search, but may slow down compilation
10185 of huge functions.  The default value is 30.
10187 @item max-tail-merge-comparisons
10188 The maximum amount of similar bbs to compare a bb with.  This is used to
10189 avoid quadratic behavior in tree tail merging.  The default value is 10.
10191 @item max-tail-merge-iterations
10192 The maximum amount of iterations of the pass over the function.  This is used to
10193 limit compilation time in tree tail merging.  The default value is 2.
10195 @item store-merging-allow-unaligned
10196 Allow the store merging pass to introduce unaligned stores if it is legal to
10197 do so.  The default value is 1.
10199 @item max-stores-to-merge
10200 The maximum number of stores to attempt to merge into wider stores in the store
10201 merging pass.  The minimum value is 2 and the default is 64.
10203 @item max-unrolled-insns
10204 The maximum number of instructions that a loop may have to be unrolled.
10205 If a loop is unrolled, this parameter also determines how many times
10206 the loop code is unrolled.
10208 @item max-average-unrolled-insns
10209 The maximum number of instructions biased by probabilities of their execution
10210 that a loop may have to be unrolled.  If a loop is unrolled,
10211 this parameter also determines how many times the loop code is unrolled.
10213 @item max-unroll-times
10214 The maximum number of unrollings of a single loop.
10216 @item max-peeled-insns
10217 The maximum number of instructions that a loop may have to be peeled.
10218 If a loop is peeled, this parameter also determines how many times
10219 the loop code is peeled.
10221 @item max-peel-times
10222 The maximum number of peelings of a single loop.
10224 @item max-peel-branches
10225 The maximum number of branches on the hot path through the peeled sequence.
10227 @item max-completely-peeled-insns
10228 The maximum number of insns of a completely peeled loop.
10230 @item max-completely-peel-times
10231 The maximum number of iterations of a loop to be suitable for complete peeling.
10233 @item max-completely-peel-loop-nest-depth
10234 The maximum depth of a loop nest suitable for complete peeling.
10236 @item max-unswitch-insns
10237 The maximum number of insns of an unswitched loop.
10239 @item max-unswitch-level
10240 The maximum number of branches unswitched in a single loop.
10242 @item max-loop-headers-insns
10243 The maximum number of insns in loop header duplicated by the copy loop headers
10244 pass.
10246 @item lim-expensive
10247 The minimum cost of an expensive expression in the loop invariant motion.
10249 @item iv-consider-all-candidates-bound
10250 Bound on number of candidates for induction variables, below which
10251 all candidates are considered for each use in induction variable
10252 optimizations.  If there are more candidates than this,
10253 only the most relevant ones are considered to avoid quadratic time complexity.
10255 @item iv-max-considered-uses
10256 The induction variable optimizations give up on loops that contain more
10257 induction variable uses.
10259 @item iv-always-prune-cand-set-bound
10260 If the number of candidates in the set is smaller than this value,
10261 always try to remove unnecessary ivs from the set
10262 when adding a new one.
10264 @item avg-loop-niter
10265 Average number of iterations of a loop.
10267 @item dse-max-object-size
10268 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10269 Larger values may result in larger compilation times.
10271 @item scev-max-expr-size
10272 Bound on size of expressions used in the scalar evolutions analyzer.
10273 Large expressions slow the analyzer.
10275 @item scev-max-expr-complexity
10276 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10277 Complex expressions slow the analyzer.
10279 @item max-tree-if-conversion-phi-args
10280 Maximum number of arguments in a PHI supported by TREE if conversion
10281 unless the loop is marked with simd pragma.
10283 @item vect-max-version-for-alignment-checks
10284 The maximum number of run-time checks that can be performed when
10285 doing loop versioning for alignment in the vectorizer.
10287 @item vect-max-version-for-alias-checks
10288 The maximum number of run-time checks that can be performed when
10289 doing loop versioning for alias in the vectorizer.
10291 @item vect-max-peeling-for-alignment
10292 The maximum number of loop peels to enhance access alignment
10293 for vectorizer. Value -1 means no limit.
10295 @item max-iterations-to-track
10296 The maximum number of iterations of a loop the brute-force algorithm
10297 for analysis of the number of iterations of the loop tries to evaluate.
10299 @item hot-bb-count-ws-permille
10300 A basic block profile count is considered hot if it contributes to 
10301 the given permillage (i.e. 0...1000) of the entire profiled execution.
10303 @item hot-bb-frequency-fraction
10304 Select fraction of the entry block frequency of executions of basic block in
10305 function given basic block needs to have to be considered hot.
10307 @item max-predicted-iterations
10308 The maximum number of loop iterations we predict statically.  This is useful
10309 in cases where a function contains a single loop with known bound and
10310 another loop with unknown bound.
10311 The known number of iterations is predicted correctly, while
10312 the unknown number of iterations average to roughly 10.  This means that the
10313 loop without bounds appears artificially cold relative to the other one.
10315 @item builtin-expect-probability
10316 Control the probability of the expression having the specified value. This
10317 parameter takes a percentage (i.e. 0 ... 100) as input.
10318 The default probability of 90 is obtained empirically.
10320 @item align-threshold
10322 Select fraction of the maximal frequency of executions of a basic block in
10323 a function to align the basic block.
10325 @item align-loop-iterations
10327 A loop expected to iterate at least the selected number of iterations is
10328 aligned.
10330 @item tracer-dynamic-coverage
10331 @itemx tracer-dynamic-coverage-feedback
10333 This value is used to limit superblock formation once the given percentage of
10334 executed instructions is covered.  This limits unnecessary code size
10335 expansion.
10337 The @option{tracer-dynamic-coverage-feedback} parameter
10338 is used only when profile
10339 feedback is available.  The real profiles (as opposed to statically estimated
10340 ones) are much less balanced allowing the threshold to be larger value.
10342 @item tracer-max-code-growth
10343 Stop tail duplication once code growth has reached given percentage.  This is
10344 a rather artificial limit, as most of the duplicates are eliminated later in
10345 cross jumping, so it may be set to much higher values than is the desired code
10346 growth.
10348 @item tracer-min-branch-ratio
10350 Stop reverse growth when the reverse probability of best edge is less than this
10351 threshold (in percent).
10353 @item tracer-min-branch-probability
10354 @itemx tracer-min-branch-probability-feedback
10356 Stop forward growth if the best edge has probability lower than this
10357 threshold.
10359 Similarly to @option{tracer-dynamic-coverage} two parameters are
10360 provided.  @option{tracer-min-branch-probability-feedback} is used for
10361 compilation with profile feedback and @option{tracer-min-branch-probability}
10362 compilation without.  The value for compilation with profile feedback
10363 needs to be more conservative (higher) in order to make tracer
10364 effective.
10366 @item stack-clash-protection-guard-size
10367 Specify the size of the operating system provided stack guard as
10368 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10369 Acceptable values are between 12 and 30.  Higher values may reduce the
10370 number of explicit probes, but a value larger than the operating system
10371 provided guard will leave code vulnerable to stack clash style attacks.
10373 @item stack-clash-protection-probe-interval
10374 Stack clash protection involves probing stack space as it is allocated.  This
10375 param controls the maximum distance between probes into the stack as 2 raised
10376 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10377 12.  Higher values may reduce the number of explicit probes, but a value
10378 larger than the operating system provided guard will leave code vulnerable to
10379 stack clash style attacks.
10381 @item max-cse-path-length
10383 The maximum number of basic blocks on path that CSE considers.
10384 The default is 10.
10386 @item max-cse-insns
10387 The maximum number of instructions CSE processes before flushing.
10388 The default is 1000.
10390 @item ggc-min-expand
10392 GCC uses a garbage collector to manage its own memory allocation.  This
10393 parameter specifies the minimum percentage by which the garbage
10394 collector's heap should be allowed to expand between collections.
10395 Tuning this may improve compilation speed; it has no effect on code
10396 generation.
10398 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10399 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10400 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10401 GCC is not able to calculate RAM on a particular platform, the lower
10402 bound of 30% is used.  Setting this parameter and
10403 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10404 every opportunity.  This is extremely slow, but can be useful for
10405 debugging.
10407 @item ggc-min-heapsize
10409 Minimum size of the garbage collector's heap before it begins bothering
10410 to collect garbage.  The first collection occurs after the heap expands
10411 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10412 tuning this may improve compilation speed, and has no effect on code
10413 generation.
10415 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10416 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10417 with a lower bound of 4096 (four megabytes) and an upper bound of
10418 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10419 particular platform, the lower bound is used.  Setting this parameter
10420 very large effectively disables garbage collection.  Setting this
10421 parameter and @option{ggc-min-expand} to zero causes a full collection
10422 to occur at every opportunity.
10424 @item max-reload-search-insns
10425 The maximum number of instruction reload should look backward for equivalent
10426 register.  Increasing values mean more aggressive optimization, making the
10427 compilation time increase with probably slightly better performance.
10428 The default value is 100.
10430 @item max-cselib-memory-locations
10431 The maximum number of memory locations cselib should take into account.
10432 Increasing values mean more aggressive optimization, making the compilation time
10433 increase with probably slightly better performance.  The default value is 500.
10435 @item max-sched-ready-insns
10436 The maximum number of instructions ready to be issued the scheduler should
10437 consider at any given time during the first scheduling pass.  Increasing
10438 values mean more thorough searches, making the compilation time increase
10439 with probably little benefit.  The default value is 100.
10441 @item max-sched-region-blocks
10442 The maximum number of blocks in a region to be considered for
10443 interblock scheduling.  The default value is 10.
10445 @item max-pipeline-region-blocks
10446 The maximum number of blocks in a region to be considered for
10447 pipelining in the selective scheduler.  The default value is 15.
10449 @item max-sched-region-insns
10450 The maximum number of insns in a region to be considered for
10451 interblock scheduling.  The default value is 100.
10453 @item max-pipeline-region-insns
10454 The maximum number of insns in a region to be considered for
10455 pipelining in the selective scheduler.  The default value is 200.
10457 @item min-spec-prob
10458 The minimum probability (in percents) of reaching a source block
10459 for interblock speculative scheduling.  The default value is 40.
10461 @item max-sched-extend-regions-iters
10462 The maximum number of iterations through CFG to extend regions.
10463 A value of 0 (the default) disables region extensions.
10465 @item max-sched-insn-conflict-delay
10466 The maximum conflict delay for an insn to be considered for speculative motion.
10467 The default value is 3.
10469 @item sched-spec-prob-cutoff
10470 The minimal probability of speculation success (in percents), so that
10471 speculative insns are scheduled.
10472 The default value is 40.
10474 @item sched-state-edge-prob-cutoff
10475 The minimum probability an edge must have for the scheduler to save its
10476 state across it.
10477 The default value is 10.
10479 @item sched-mem-true-dep-cost
10480 Minimal distance (in CPU cycles) between store and load targeting same
10481 memory locations.  The default value is 1.
10483 @item selsched-max-lookahead
10484 The maximum size of the lookahead window of selective scheduling.  It is a
10485 depth of search for available instructions.
10486 The default value is 50.
10488 @item selsched-max-sched-times
10489 The maximum number of times that an instruction is scheduled during
10490 selective scheduling.  This is the limit on the number of iterations
10491 through which the instruction may be pipelined.  The default value is 2.
10493 @item selsched-insns-to-rename
10494 The maximum number of best instructions in the ready list that are considered
10495 for renaming in the selective scheduler.  The default value is 2.
10497 @item sms-min-sc
10498 The minimum value of stage count that swing modulo scheduler
10499 generates.  The default value is 2.
10501 @item max-last-value-rtl
10502 The maximum size measured as number of RTLs that can be recorded in an expression
10503 in combiner for a pseudo register as last known value of that register.  The default
10504 is 10000.
10506 @item max-combine-insns
10507 The maximum number of instructions the RTL combiner tries to combine.
10508 The default value is 2 at @option{-Og} and 4 otherwise.
10510 @item integer-share-limit
10511 Small integer constants can use a shared data structure, reducing the
10512 compiler's memory usage and increasing its speed.  This sets the maximum
10513 value of a shared integer constant.  The default value is 256.
10515 @item ssp-buffer-size
10516 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10517 protection when @option{-fstack-protection} is used.
10519 @item min-size-for-stack-sharing
10520 The minimum size of variables taking part in stack slot sharing when not
10521 optimizing. The default value is 32.
10523 @item max-jump-thread-duplication-stmts
10524 Maximum number of statements allowed in a block that needs to be
10525 duplicated when threading jumps.
10527 @item max-fields-for-field-sensitive
10528 Maximum number of fields in a structure treated in
10529 a field sensitive manner during pointer analysis.  The default is zero
10530 for @option{-O0} and @option{-O1},
10531 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10533 @item prefetch-latency
10534 Estimate on average number of instructions that are executed before
10535 prefetch finishes.  The distance prefetched ahead is proportional
10536 to this constant.  Increasing this number may also lead to less
10537 streams being prefetched (see @option{simultaneous-prefetches}).
10539 @item simultaneous-prefetches
10540 Maximum number of prefetches that can run at the same time.
10542 @item l1-cache-line-size
10543 The size of cache line in L1 cache, in bytes.
10545 @item l1-cache-size
10546 The size of L1 cache, in kilobytes.
10548 @item l2-cache-size
10549 The size of L2 cache, in kilobytes.
10551 @item loop-interchange-max-num-stmts
10552 The maximum number of stmts in a loop to be interchanged.
10554 @item loop-interchange-stride-ratio
10555 The minimum ratio between stride of two loops for interchange to be profitable.
10557 @item min-insn-to-prefetch-ratio
10558 The minimum ratio between the number of instructions and the
10559 number of prefetches to enable prefetching in a loop.
10561 @item prefetch-min-insn-to-mem-ratio
10562 The minimum ratio between the number of instructions and the
10563 number of memory references to enable prefetching in a loop.
10565 @item use-canonical-types
10566 Whether the compiler should use the ``canonical'' type system.  By
10567 default, this should always be 1, which uses a more efficient internal
10568 mechanism for comparing types in C++ and Objective-C++.  However, if
10569 bugs in the canonical type system are causing compilation failures,
10570 set this value to 0 to disable canonical types.
10572 @item switch-conversion-max-branch-ratio
10573 Switch initialization conversion refuses to create arrays that are
10574 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10575 branches in the switch.
10577 @item max-partial-antic-length
10578 Maximum length of the partial antic set computed during the tree
10579 partial redundancy elimination optimization (@option{-ftree-pre}) when
10580 optimizing at @option{-O3} and above.  For some sorts of source code
10581 the enhanced partial redundancy elimination optimization can run away,
10582 consuming all of the memory available on the host machine.  This
10583 parameter sets a limit on the length of the sets that are computed,
10584 which prevents the runaway behavior.  Setting a value of 0 for
10585 this parameter allows an unlimited set length.
10587 @item sccvn-max-scc-size
10588 Maximum size of a strongly connected component (SCC) during SCCVN
10589 processing.  If this limit is hit, SCCVN processing for the whole
10590 function is not done and optimizations depending on it are
10591 disabled.  The default maximum SCC size is 10000.
10593 @item sccvn-max-alias-queries-per-access
10594 Maximum number of alias-oracle queries we perform when looking for
10595 redundancies for loads and stores.  If this limit is hit the search
10596 is aborted and the load or store is not considered redundant.  The
10597 number of queries is algorithmically limited to the number of
10598 stores on all paths from the load to the function entry.
10599 The default maximum number of queries is 1000.
10601 @item ira-max-loops-num
10602 IRA uses regional register allocation by default.  If a function
10603 contains more loops than the number given by this parameter, only at most
10604 the given number of the most frequently-executed loops form regions
10605 for regional register allocation.  The default value of the
10606 parameter is 100.
10608 @item ira-max-conflict-table-size 
10609 Although IRA uses a sophisticated algorithm to compress the conflict
10610 table, the table can still require excessive amounts of memory for
10611 huge functions.  If the conflict table for a function could be more
10612 than the size in MB given by this parameter, the register allocator
10613 instead uses a faster, simpler, and lower-quality
10614 algorithm that does not require building a pseudo-register conflict table.  
10615 The default value of the parameter is 2000.
10617 @item ira-loop-reserved-regs
10618 IRA can be used to evaluate more accurate register pressure in loops
10619 for decisions to move loop invariants (see @option{-O3}).  The number
10620 of available registers reserved for some other purposes is given
10621 by this parameter.  The default value of the parameter is 2, which is
10622 the minimal number of registers needed by typical instructions.
10623 This value is the best found from numerous experiments.
10625 @item lra-inheritance-ebb-probability-cutoff
10626 LRA tries to reuse values reloaded in registers in subsequent insns.
10627 This optimization is called inheritance.  EBB is used as a region to
10628 do this optimization.  The parameter defines a minimal fall-through
10629 edge probability in percentage used to add BB to inheritance EBB in
10630 LRA.  The default value of the parameter is 40.  The value was chosen
10631 from numerous runs of SPEC2000 on x86-64.
10633 @item loop-invariant-max-bbs-in-loop
10634 Loop invariant motion can be very expensive, both in compilation time and
10635 in amount of needed compile-time memory, with very large loops.  Loops
10636 with more basic blocks than this parameter won't have loop invariant
10637 motion optimization performed on them.  The default value of the
10638 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10640 @item loop-max-datarefs-for-datadeps
10641 Building data dependencies is expensive for very large loops.  This
10642 parameter limits the number of data references in loops that are
10643 considered for data dependence analysis.  These large loops are no
10644 handled by the optimizations using loop data dependencies.
10645 The default value is 1000.
10647 @item max-vartrack-size
10648 Sets a maximum number of hash table slots to use during variable
10649 tracking dataflow analysis of any function.  If this limit is exceeded
10650 with variable tracking at assignments enabled, analysis for that
10651 function is retried without it, after removing all debug insns from
10652 the function.  If the limit is exceeded even without debug insns, var
10653 tracking analysis is completely disabled for the function.  Setting
10654 the parameter to zero makes it unlimited.
10656 @item max-vartrack-expr-depth
10657 Sets a maximum number of recursion levels when attempting to map
10658 variable names or debug temporaries to value expressions.  This trades
10659 compilation time for more complete debug information.  If this is set too
10660 low, value expressions that are available and could be represented in
10661 debug information may end up not being used; setting this higher may
10662 enable the compiler to find more complex debug expressions, but compile
10663 time and memory use may grow.  The default is 12.
10665 @item max-debug-marker-count
10666 Sets a threshold on the number of debug markers (e.g. begin stmt
10667 markers) to avoid complexity explosion at inlining or expanding to RTL.
10668 If a function has more such gimple stmts than the set limit, such stmts
10669 will be dropped from the inlined copy of a function, and from its RTL
10670 expansion.  The default is 100000.
10672 @item min-nondebug-insn-uid
10673 Use uids starting at this parameter for nondebug insns.  The range below
10674 the parameter is reserved exclusively for debug insns created by
10675 @option{-fvar-tracking-assignments}, but debug insns may get
10676 (non-overlapping) uids above it if the reserved range is exhausted.
10678 @item ipa-sra-ptr-growth-factor
10679 IPA-SRA replaces a pointer to an aggregate with one or more new
10680 parameters only when their cumulative size is less or equal to
10681 @option{ipa-sra-ptr-growth-factor} times the size of the original
10682 pointer parameter.
10684 @item sra-max-scalarization-size-Ospeed
10685 @item sra-max-scalarization-size-Osize
10686 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10687 replace scalar parts of aggregates with uses of independent scalar
10688 variables.  These parameters control the maximum size, in storage units,
10689 of aggregate which is considered for replacement when compiling for
10690 speed
10691 (@option{sra-max-scalarization-size-Ospeed}) or size
10692 (@option{sra-max-scalarization-size-Osize}) respectively.
10694 @item tm-max-aggregate-size
10695 When making copies of thread-local variables in a transaction, this
10696 parameter specifies the size in bytes after which variables are
10697 saved with the logging functions as opposed to save/restore code
10698 sequence pairs.  This option only applies when using
10699 @option{-fgnu-tm}.
10701 @item graphite-max-nb-scop-params
10702 To avoid exponential effects in the Graphite loop transforms, the
10703 number of parameters in a Static Control Part (SCoP) is bounded.  The
10704 default value is 10 parameters, a value of zero can be used to lift
10705 the bound.  A variable whose value is unknown at compilation time and
10706 defined outside a SCoP is a parameter of the SCoP.
10708 @item loop-block-tile-size
10709 Loop blocking or strip mining transforms, enabled with
10710 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10711 loop in the loop nest by a given number of iterations.  The strip
10712 length can be changed using the @option{loop-block-tile-size}
10713 parameter.  The default value is 51 iterations.
10715 @item loop-unroll-jam-size
10716 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10717 default value is 4.
10719 @item loop-unroll-jam-depth
10720 Specify the dimension to be unrolled (counting from the most inner loop)
10721 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10723 @item ipa-cp-value-list-size
10724 IPA-CP attempts to track all possible values and types passed to a function's
10725 parameter in order to propagate them and perform devirtualization.
10726 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10727 stores per one formal parameter of a function.
10729 @item ipa-cp-eval-threshold
10730 IPA-CP calculates its own score of cloning profitability heuristics
10731 and performs those cloning opportunities with scores that exceed
10732 @option{ipa-cp-eval-threshold}.
10734 @item ipa-cp-recursion-penalty
10735 Percentage penalty the recursive functions will receive when they
10736 are evaluated for cloning.
10738 @item ipa-cp-single-call-penalty
10739 Percentage penalty functions containing a single call to another
10740 function will receive when they are evaluated for cloning.
10743 @item ipa-max-agg-items
10744 IPA-CP is also capable to propagate a number of scalar values passed
10745 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10746 number of such values per one parameter.
10748 @item ipa-cp-loop-hint-bonus
10749 When IPA-CP determines that a cloning candidate would make the number
10750 of iterations of a loop known, it adds a bonus of
10751 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10752 the candidate.
10754 @item ipa-cp-array-index-hint-bonus
10755 When IPA-CP determines that a cloning candidate would make the index of
10756 an array access known, it adds a bonus of
10757 @option{ipa-cp-array-index-hint-bonus} to the profitability
10758 score of the candidate.
10760 @item ipa-max-aa-steps
10761 During its analysis of function bodies, IPA-CP employs alias analysis
10762 in order to track values pointed to by function parameters.  In order
10763 not spend too much time analyzing huge functions, it gives up and
10764 consider all memory clobbered after examining
10765 @option{ipa-max-aa-steps} statements modifying memory.
10767 @item lto-partitions
10768 Specify desired number of partitions produced during WHOPR compilation.
10769 The number of partitions should exceed the number of CPUs used for compilation.
10770 The default value is 32.
10772 @item lto-min-partition
10773 Size of minimal partition for WHOPR (in estimated instructions).
10774 This prevents expenses of splitting very small programs into too many
10775 partitions.
10777 @item lto-max-partition
10778 Size of max partition for WHOPR (in estimated instructions).
10779 to provide an upper bound for individual size of partition.
10780 Meant to be used only with balanced partitioning.
10782 @item cxx-max-namespaces-for-diagnostic-help
10783 The maximum number of namespaces to consult for suggestions when C++
10784 name lookup fails for an identifier.  The default is 1000.
10786 @item sink-frequency-threshold
10787 The maximum relative execution frequency (in percents) of the target block
10788 relative to a statement's original block to allow statement sinking of a
10789 statement.  Larger numbers result in more aggressive statement sinking.
10790 The default value is 75.  A small positive adjustment is applied for
10791 statements with memory operands as those are even more profitable so sink.
10793 @item max-stores-to-sink
10794 The maximum number of conditional store pairs that can be sunk.  Set to 0
10795 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10796 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10798 @item allow-store-data-races
10799 Allow optimizers to introduce new data races on stores.
10800 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10801 at optimization level @option{-Ofast}.
10803 @item case-values-threshold
10804 The smallest number of different values for which it is best to use a
10805 jump-table instead of a tree of conditional branches.  If the value is
10806 0, use the default for the machine.  The default is 0.
10808 @item tree-reassoc-width
10809 Set the maximum number of instructions executed in parallel in
10810 reassociated tree. This parameter overrides target dependent
10811 heuristics used by default if has non zero value.
10813 @item sched-pressure-algorithm
10814 Choose between the two available implementations of
10815 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10816 and is the more likely to prevent instructions from being reordered.
10817 Algorithm 2 was designed to be a compromise between the relatively
10818 conservative approach taken by algorithm 1 and the rather aggressive
10819 approach taken by the default scheduler.  It relies more heavily on
10820 having a regular register file and accurate register pressure classes.
10821 See @file{haifa-sched.c} in the GCC sources for more details.
10823 The default choice depends on the target.
10825 @item max-slsr-cand-scan
10826 Set the maximum number of existing candidates that are considered when
10827 seeking a basis for a new straight-line strength reduction candidate.
10829 @item asan-globals
10830 Enable buffer overflow detection for global objects.  This kind
10831 of protection is enabled by default if you are using
10832 @option{-fsanitize=address} option.
10833 To disable global objects protection use @option{--param asan-globals=0}.
10835 @item asan-stack
10836 Enable buffer overflow detection for stack objects.  This kind of
10837 protection is enabled by default when using @option{-fsanitize=address}.
10838 To disable stack protection use @option{--param asan-stack=0} option.
10840 @item asan-instrument-reads
10841 Enable buffer overflow detection for memory reads.  This kind of
10842 protection is enabled by default when using @option{-fsanitize=address}.
10843 To disable memory reads protection use
10844 @option{--param asan-instrument-reads=0}.
10846 @item asan-instrument-writes
10847 Enable buffer overflow detection for memory writes.  This kind of
10848 protection is enabled by default when using @option{-fsanitize=address}.
10849 To disable memory writes protection use
10850 @option{--param asan-instrument-writes=0} option.
10852 @item asan-memintrin
10853 Enable detection for built-in functions.  This kind of protection
10854 is enabled by default when using @option{-fsanitize=address}.
10855 To disable built-in functions protection use
10856 @option{--param asan-memintrin=0}.
10858 @item asan-use-after-return
10859 Enable detection of use-after-return.  This kind of protection
10860 is enabled by default when using the @option{-fsanitize=address} option.
10861 To disable it use @option{--param asan-use-after-return=0}.
10863 Note: By default the check is disabled at run time.  To enable it,
10864 add @code{detect_stack_use_after_return=1} to the environment variable
10865 @env{ASAN_OPTIONS}.
10867 @item asan-instrumentation-with-call-threshold
10868 If number of memory accesses in function being instrumented
10869 is greater or equal to this number, use callbacks instead of inline checks.
10870 E.g. to disable inline code use
10871 @option{--param asan-instrumentation-with-call-threshold=0}.
10873 @item use-after-scope-direct-emission-threshold
10874 If the size of a local variable in bytes is smaller or equal to this
10875 number, directly poison (or unpoison) shadow memory instead of using
10876 run-time callbacks.  The default value is 256.
10878 @item chkp-max-ctor-size
10879 Static constructors generated by Pointer Bounds Checker may become very
10880 large and significantly increase compile time at optimization level
10881 @option{-O1} and higher.  This parameter is a maximum number of statements
10882 in a single generated constructor.  Default value is 5000.
10884 @item max-fsm-thread-path-insns
10885 Maximum number of instructions to copy when duplicating blocks on a
10886 finite state automaton jump thread path.  The default is 100.
10888 @item max-fsm-thread-length
10889 Maximum number of basic blocks on a finite state automaton jump thread
10890 path.  The default is 10.
10892 @item max-fsm-thread-paths
10893 Maximum number of new jump thread paths to create for a finite state
10894 automaton.  The default is 50.
10896 @item parloops-chunk-size
10897 Chunk size of omp schedule for loops parallelized by parloops.  The default
10898 is 0.
10900 @item parloops-schedule
10901 Schedule type of omp schedule for loops parallelized by parloops (static,
10902 dynamic, guided, auto, runtime).  The default is static.
10904 @item parloops-min-per-thread
10905 The minimum number of iterations per thread of an innermost parallelized
10906 loop for which the parallelized variant is prefered over the single threaded
10907 one.  The default is 100.  Note that for a parallelized loop nest the
10908 minimum number of iterations of the outermost loop per thread is two.
10910 @item max-ssa-name-query-depth
10911 Maximum depth of recursion when querying properties of SSA names in things
10912 like fold routines.  One level of recursion corresponds to following a
10913 use-def chain.
10915 @item hsa-gen-debug-stores
10916 Enable emission of special debug stores within HSA kernels which are
10917 then read and reported by libgomp plugin.  Generation of these stores
10918 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10919 enable it.
10921 @item max-speculative-devirt-maydefs
10922 The maximum number of may-defs we analyze when looking for a must-def
10923 specifying the dynamic type of an object that invokes a virtual call
10924 we may be able to devirtualize speculatively.
10926 @item max-vrp-switch-assertions
10927 The maximum number of assertions to add along the default edge of a switch
10928 statement during VRP.  The default is 10.
10930 @item unroll-jam-min-percent
10931 The minimum percentage of memory references that must be optimized
10932 away for the unroll-and-jam transformation to be considered profitable.
10934 @item unroll-jam-max-unroll
10935 The maximum number of times the outer loop should be unrolled by
10936 the unroll-and-jam transformation.
10937 @end table
10938 @end table
10940 @node Instrumentation Options
10941 @section Program Instrumentation Options
10942 @cindex instrumentation options
10943 @cindex program instrumentation options
10944 @cindex run-time error checking options
10945 @cindex profiling options
10946 @cindex options, program instrumentation
10947 @cindex options, run-time error checking
10948 @cindex options, profiling
10950 GCC supports a number of command-line options that control adding
10951 run-time instrumentation to the code it normally generates.  
10952 For example, one purpose of instrumentation is collect profiling
10953 statistics for use in finding program hot spots, code coverage
10954 analysis, or profile-guided optimizations.
10955 Another class of program instrumentation is adding run-time checking 
10956 to detect programming errors like invalid pointer
10957 dereferences or out-of-bounds array accesses, as well as deliberately
10958 hostile attacks such as stack smashing or C++ vtable hijacking.
10959 There is also a general hook which can be used to implement other
10960 forms of tracing or function-level instrumentation for debug or
10961 program analysis purposes.
10963 @table @gcctabopt
10964 @cindex @command{prof}
10965 @item -p
10966 @opindex p
10967 Generate extra code to write profile information suitable for the
10968 analysis program @command{prof}.  You must use this option when compiling
10969 the source files you want data about, and you must also use it when
10970 linking.
10972 @cindex @command{gprof}
10973 @item -pg
10974 @opindex pg
10975 Generate extra code to write profile information suitable for the
10976 analysis program @command{gprof}.  You must use this option when compiling
10977 the source files you want data about, and you must also use it when
10978 linking.
10980 @item -fprofile-arcs
10981 @opindex fprofile-arcs
10982 Add code so that program flow @dfn{arcs} are instrumented.  During
10983 execution the program records how many times each branch and call is
10984 executed and how many times it is taken or returns.  On targets that support
10985 constructors with priority support, profiling properly handles constructors,
10986 destructors and C++ constructors (and destructors) of classes which are used
10987 as a type of a global variable.
10989 When the compiled
10990 program exits it saves this data to a file called
10991 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10992 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10993 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10994 @var{auxname} is generated from the name of the output file, if
10995 explicitly specified and it is not the final executable, otherwise it is
10996 the basename of the source file.  In both cases any suffix is removed
10997 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10998 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10999 @xref{Cross-profiling}.
11001 @cindex @command{gcov}
11002 @item --coverage
11003 @opindex coverage
11005 This option is used to compile and link code instrumented for coverage
11006 analysis.  The option is a synonym for @option{-fprofile-arcs}
11007 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11008 linking).  See the documentation for those options for more details.
11010 @itemize
11012 @item
11013 Compile the source files with @option{-fprofile-arcs} plus optimization
11014 and code generation options.  For test coverage analysis, use the
11015 additional @option{-ftest-coverage} option.  You do not need to profile
11016 every source file in a program.
11018 @item
11019 Compile the source files additionally with @option{-fprofile-abs-path}
11020 to create absolute path names in the @file{.gcno} files.  This allows
11021 @command{gcov} to find the correct sources in projects where compilations
11022 occur with different working directories.
11024 @item
11025 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11026 (the latter implies the former).
11028 @item
11029 Run the program on a representative workload to generate the arc profile
11030 information.  This may be repeated any number of times.  You can run
11031 concurrent instances of your program, and provided that the file system
11032 supports locking, the data files will be correctly updated.  Unless
11033 a strict ISO C dialect option is in effect, @code{fork} calls are
11034 detected and correctly handled without double counting.
11036 @item
11037 For profile-directed optimizations, compile the source files again with
11038 the same optimization and code generation options plus
11039 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11040 Control Optimization}).
11042 @item
11043 For test coverage analysis, use @command{gcov} to produce human readable
11044 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11045 @command{gcov} documentation for further information.
11047 @end itemize
11049 With @option{-fprofile-arcs}, for each function of your program GCC
11050 creates a program flow graph, then finds a spanning tree for the graph.
11051 Only arcs that are not on the spanning tree have to be instrumented: the
11052 compiler adds code to count the number of times that these arcs are
11053 executed.  When an arc is the only exit or only entrance to a block, the
11054 instrumentation code can be added to the block; otherwise, a new basic
11055 block must be created to hold the instrumentation code.
11057 @need 2000
11058 @item -ftest-coverage
11059 @opindex ftest-coverage
11060 Produce a notes file that the @command{gcov} code-coverage utility
11061 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11062 show program coverage.  Each source file's note file is called
11063 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11064 above for a description of @var{auxname} and instructions on how to
11065 generate test coverage data.  Coverage data matches the source files
11066 more closely if you do not optimize.
11068 @item -fprofile-abs-path
11069 @opindex fprofile-abs-path
11070 Automatically convert relative source file names to absolute path names
11071 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11072 sources in projects where compilations occur with different working
11073 directories.
11075 @item -fprofile-dir=@var{path}
11076 @opindex fprofile-dir
11078 Set the directory to search for the profile data files in to @var{path}.
11079 This option affects only the profile data generated by
11080 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11081 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11082 and its related options.  Both absolute and relative paths can be used.
11083 By default, GCC uses the current directory as @var{path}, thus the
11084 profile data file appears in the same directory as the object file.
11086 @item -fprofile-generate
11087 @itemx -fprofile-generate=@var{path}
11088 @opindex fprofile-generate
11090 Enable options usually used for instrumenting application to produce
11091 profile useful for later recompilation with profile feedback based
11092 optimization.  You must use @option{-fprofile-generate} both when
11093 compiling and when linking your program.
11095 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11097 If @var{path} is specified, GCC looks at the @var{path} to find
11098 the profile feedback data files. See @option{-fprofile-dir}.
11100 To optimize the program based on the collected profile information, use
11101 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11103 @item -fprofile-update=@var{method}
11104 @opindex fprofile-update
11106 Alter the update method for an application instrumented for profile
11107 feedback based optimization.  The @var{method} argument should be one of
11108 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11109 The first one is useful for single-threaded applications,
11110 while the second one prevents profile corruption by emitting thread-safe code.
11112 @strong{Warning:} When an application does not properly join all threads
11113 (or creates an detached thread), a profile file can be still corrupted.
11115 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11116 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11117 automatically selects @samp{prefer-atomic} when @option{-pthread}
11118 is present in the command line.
11120 @item -fsanitize=address
11121 @opindex fsanitize=address
11122 Enable AddressSanitizer, a fast memory error detector.
11123 Memory access instructions are instrumented to detect
11124 out-of-bounds and use-after-free bugs.
11125 The option enables @option{-fsanitize-address-use-after-scope}.
11126 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11127 more details.  The run-time behavior can be influenced using the
11128 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11129 the available options are shown at startup of the instrumented program.  See
11130 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11131 for a list of supported options.
11132 The option cannot be combined with @option{-fsanitize=thread}
11133 and/or @option{-fcheck-pointer-bounds}.
11135 @item -fsanitize=kernel-address
11136 @opindex fsanitize=kernel-address
11137 Enable AddressSanitizer for Linux kernel.
11138 See @uref{https://github.com/google/kasan/wiki} for more details.
11139 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11141 @item -fsanitize=pointer-compare
11142 @opindex fsanitize=pointer-compare
11143 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11144 The option must be combined with either @option{-fsanitize=kernel-address} or
11145 @option{-fsanitize=address}
11146 The option cannot be combined with @option{-fsanitize=thread}
11147 and/or @option{-fcheck-pointer-bounds}.
11148 Note: By default the check is disabled at run time.  To enable it,
11149 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11150 @env{ASAN_OPTIONS}.
11152 @item -fsanitize=pointer-subtract
11153 @opindex fsanitize=pointer-subtract
11154 Instrument subtraction with pointer operands.
11155 The option must be combined with either @option{-fsanitize=kernel-address} or
11156 @option{-fsanitize=address}
11157 The option cannot be combined with @option{-fsanitize=thread}
11158 and/or @option{-fcheck-pointer-bounds}.
11159 Note: By default the check is disabled at run time.  To enable it,
11160 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11161 @env{ASAN_OPTIONS}.
11163 @item -fsanitize=thread
11164 @opindex fsanitize=thread
11165 Enable ThreadSanitizer, a fast data race detector.
11166 Memory access instructions are instrumented to detect
11167 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11168 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11169 environment variable; see
11170 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11171 supported options.
11172 The option cannot be combined with @option{-fsanitize=address},
11173 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11175 Note that sanitized atomic builtins cannot throw exceptions when
11176 operating on invalid memory addresses with non-call exceptions
11177 (@option{-fnon-call-exceptions}).
11179 @item -fsanitize=leak
11180 @opindex fsanitize=leak
11181 Enable LeakSanitizer, a memory leak detector.
11182 This option only matters for linking of executables and
11183 the executable is linked against a library that overrides @code{malloc}
11184 and other allocator functions.  See
11185 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11186 details.  The run-time behavior can be influenced using the
11187 @env{LSAN_OPTIONS} environment variable.
11188 The option cannot be combined with @option{-fsanitize=thread}.
11190 @item -fsanitize=undefined
11191 @opindex fsanitize=undefined
11192 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11193 Various computations are instrumented to detect undefined behavior
11194 at runtime.  Current suboptions are:
11196 @table @gcctabopt
11198 @item -fsanitize=shift
11199 @opindex fsanitize=shift
11200 This option enables checking that the result of a shift operation is
11201 not undefined.  Note that what exactly is considered undefined differs
11202 slightly between C and C++, as well as between ISO C90 and C99, etc.
11203 This option has two suboptions, @option{-fsanitize=shift-base} and
11204 @option{-fsanitize=shift-exponent}.
11206 @item -fsanitize=shift-exponent
11207 @opindex fsanitize=shift-exponent
11208 This option enables checking that the second argument of a shift operation
11209 is not negative and is smaller than the precision of the promoted first
11210 argument.
11212 @item -fsanitize=shift-base
11213 @opindex fsanitize=shift-base
11214 If the second argument of a shift operation is within range, check that the
11215 result of a shift operation is not undefined.  Note that what exactly is
11216 considered undefined differs slightly between C and C++, as well as between
11217 ISO C90 and C99, etc.
11219 @item -fsanitize=integer-divide-by-zero
11220 @opindex fsanitize=integer-divide-by-zero
11221 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11223 @item -fsanitize=unreachable
11224 @opindex fsanitize=unreachable
11225 With this option, the compiler turns the @code{__builtin_unreachable}
11226 call into a diagnostics message call instead.  When reaching the
11227 @code{__builtin_unreachable} call, the behavior is undefined.
11229 @item -fsanitize=vla-bound
11230 @opindex fsanitize=vla-bound
11231 This option instructs the compiler to check that the size of a variable
11232 length array is positive.
11234 @item -fsanitize=null
11235 @opindex fsanitize=null
11236 This option enables pointer checking.  Particularly, the application
11237 built with this option turned on will issue an error message when it
11238 tries to dereference a NULL pointer, or if a reference (possibly an
11239 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11240 on an object pointed by a NULL pointer.
11242 @item -fsanitize=return
11243 @opindex fsanitize=return
11244 This option enables return statement checking.  Programs
11245 built with this option turned on will issue an error message
11246 when the end of a non-void function is reached without actually
11247 returning a value.  This option works in C++ only.
11249 @item -fsanitize=signed-integer-overflow
11250 @opindex fsanitize=signed-integer-overflow
11251 This option enables signed integer overflow checking.  We check that
11252 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11253 does not overflow in the signed arithmetics.  Note, integer promotion
11254 rules must be taken into account.  That is, the following is not an
11255 overflow:
11256 @smallexample
11257 signed char a = SCHAR_MAX;
11258 a++;
11259 @end smallexample
11261 @item -fsanitize=bounds
11262 @opindex fsanitize=bounds
11263 This option enables instrumentation of array bounds.  Various out of bounds
11264 accesses are detected.  Flexible array members, flexible array member-like
11265 arrays, and initializers of variables with static storage are not instrumented.
11266 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11268 @item -fsanitize=bounds-strict
11269 @opindex fsanitize=bounds-strict
11270 This option enables strict instrumentation of array bounds.  Most out of bounds
11271 accesses are detected, including flexible array members and flexible array
11272 member-like arrays.  Initializers of variables with static storage are not
11273 instrumented.  The option cannot be combined
11274 with @option{-fcheck-pointer-bounds}.
11276 @item -fsanitize=alignment
11277 @opindex fsanitize=alignment
11279 This option enables checking of alignment of pointers when they are
11280 dereferenced, or when a reference is bound to insufficiently aligned target,
11281 or when a method or constructor is invoked on insufficiently aligned object.
11283 @item -fsanitize=object-size
11284 @opindex fsanitize=object-size
11285 This option enables instrumentation of memory references using the
11286 @code{__builtin_object_size} function.  Various out of bounds pointer
11287 accesses are detected.
11289 @item -fsanitize=float-divide-by-zero
11290 @opindex fsanitize=float-divide-by-zero
11291 Detect floating-point division by zero.  Unlike other similar options,
11292 @option{-fsanitize=float-divide-by-zero} is not enabled by
11293 @option{-fsanitize=undefined}, since floating-point division by zero can
11294 be a legitimate way of obtaining infinities and NaNs.
11296 @item -fsanitize=float-cast-overflow
11297 @opindex fsanitize=float-cast-overflow
11298 This option enables floating-point type to integer conversion checking.
11299 We check that the result of the conversion does not overflow.
11300 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11301 not enabled by @option{-fsanitize=undefined}.
11302 This option does not work well with @code{FE_INVALID} exceptions enabled.
11304 @item -fsanitize=nonnull-attribute
11305 @opindex fsanitize=nonnull-attribute
11307 This option enables instrumentation of calls, checking whether null values
11308 are not passed to arguments marked as requiring a non-null value by the
11309 @code{nonnull} function attribute.
11311 @item -fsanitize=returns-nonnull-attribute
11312 @opindex fsanitize=returns-nonnull-attribute
11314 This option enables instrumentation of return statements in functions
11315 marked with @code{returns_nonnull} function attribute, to detect returning
11316 of null values from such functions.
11318 @item -fsanitize=bool
11319 @opindex fsanitize=bool
11321 This option enables instrumentation of loads from bool.  If a value other
11322 than 0/1 is loaded, a run-time error is issued.
11324 @item -fsanitize=enum
11325 @opindex fsanitize=enum
11327 This option enables instrumentation of loads from an enum type.  If
11328 a value outside the range of values for the enum type is loaded,
11329 a run-time error is issued.
11331 @item -fsanitize=vptr
11332 @opindex fsanitize=vptr
11334 This option enables instrumentation of C++ member function calls, member
11335 accesses and some conversions between pointers to base and derived classes,
11336 to verify the referenced object has the correct dynamic type.
11338 @item -fsanitize=pointer-overflow
11339 @opindex fsanitize=pointer-overflow
11341 This option enables instrumentation of pointer arithmetics.  If the pointer
11342 arithmetics overflows, a run-time error is issued.
11344 @item -fsanitize=builtin
11345 @opindex fsanitize=builtin
11347 This option enables instrumentation of arguments to selected builtin
11348 functions.  If an invalid value is passed to such arguments, a run-time
11349 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11350 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11351 by this option.
11353 @end table
11355 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11356 @option{-fsanitize=undefined} gives a diagnostic message.
11357 This currently works only for the C family of languages.
11359 @item -fno-sanitize=all
11360 @opindex fno-sanitize=all
11362 This option disables all previously enabled sanitizers.
11363 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11364 together.
11366 @item -fasan-shadow-offset=@var{number}
11367 @opindex fasan-shadow-offset
11368 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11369 It is useful for experimenting with different shadow memory layouts in
11370 Kernel AddressSanitizer.
11372 @item -fsanitize-sections=@var{s1},@var{s2},...
11373 @opindex fsanitize-sections
11374 Sanitize global variables in selected user-defined sections.  @var{si} may
11375 contain wildcards.
11377 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11378 @opindex fsanitize-recover
11379 @opindex fno-sanitize-recover
11380 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11381 mentioned in comma-separated list of @var{opts}.  Enabling this option
11382 for a sanitizer component causes it to attempt to continue
11383 running the program as if no error happened.  This means multiple
11384 runtime errors can be reported in a single program run, and the exit
11385 code of the program may indicate success even when errors
11386 have been reported.  The @option{-fno-sanitize-recover=} option
11387 can be used to alter
11388 this behavior: only the first detected error is reported
11389 and program then exits with a non-zero exit code.
11391 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11392 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11393 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11394 @option{-fsanitize=bounds-strict},
11395 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11396 For these sanitizers error recovery is turned on by default,
11397 except @option{-fsanitize=address}, for which this feature is experimental.
11398 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11399 accepted, the former enables recovery for all sanitizers that support it,
11400 the latter disables recovery for all sanitizers that support it.
11402 Even if a recovery mode is turned on the compiler side, it needs to be also
11403 enabled on the runtime library side, otherwise the failures are still fatal.
11404 The runtime library defaults to @code{halt_on_error=0} for
11405 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11406 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11407 setting the @code{halt_on_error} flag in the corresponding environment variable.
11409 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11410 equivalent to specifying an @var{opts} list of:
11412 @smallexample
11413 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11414 @end smallexample
11416 @item -fsanitize-address-use-after-scope
11417 @opindex fsanitize-address-use-after-scope
11418 Enable sanitization of local variables to detect use-after-scope bugs.
11419 The option sets @option{-fstack-reuse} to @samp{none}.
11421 @item -fsanitize-undefined-trap-on-error
11422 @opindex fsanitize-undefined-trap-on-error
11423 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11424 report undefined behavior using @code{__builtin_trap} rather than
11425 a @code{libubsan} library routine.  The advantage of this is that the
11426 @code{libubsan} library is not needed and is not linked in, so this
11427 is usable even in freestanding environments.
11429 @item -fsanitize-coverage=trace-pc
11430 @opindex fsanitize-coverage=trace-pc
11431 Enable coverage-guided fuzzing code instrumentation.
11432 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11434 @item -fsanitize-coverage=trace-cmp
11435 @opindex fsanitize-coverage=trace-cmp
11436 Enable dataflow guided fuzzing code instrumentation.
11437 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11438 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11439 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11440 variable or @code{__sanitizer_cov_trace_const_cmp1},
11441 @code{__sanitizer_cov_trace_const_cmp2},
11442 @code{__sanitizer_cov_trace_const_cmp4} or
11443 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11444 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11445 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11446 @code{__sanitizer_cov_trace_switch} for switch statements.
11448 @item -fbounds-check
11449 @opindex fbounds-check
11450 For front ends that support it, generate additional code to check that
11451 indices used to access arrays are within the declared range.  This is
11452 currently only supported by the Fortran front end, where this option
11453 defaults to false.
11455 @item -fcheck-pointer-bounds
11456 @opindex fcheck-pointer-bounds
11457 @opindex fno-check-pointer-bounds
11458 @cindex Pointer Bounds Checker options
11459 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11460 is instrumented with checks of the pointer used for memory access against
11461 bounds associated with that pointer.  
11463 Currently there
11464 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11465 and @option{-mmpx} are required to enable this feature.  
11466 MPX-based instrumentation requires
11467 a runtime library to enable MPX in hardware and handle bounds
11468 violation signals.  By default when @option{-fcheck-pointer-bounds}
11469 and @option{-mmpx} options are used to link a program, the GCC driver
11470 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11471 Bounds checking on calls to dynamic libraries requires a linker
11472 with @option{-z bndplt} support; if GCC was configured with a linker
11473 without support for this option (including the Gold linker and older
11474 versions of ld), a warning is given if you link with @option{-mmpx}
11475 without also specifying @option{-static}, since the overall effectiveness
11476 of the bounds checking protection is reduced.
11477 See also @option{-static-libmpxwrappers}.
11479 MPX-based instrumentation
11480 may be used for debugging and also may be included in production code
11481 to increase program security.  Depending on usage, you may
11482 have different requirements for the runtime library.  The current version
11483 of the MPX runtime library is more oriented for use as a debugging
11484 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11485 also @option{-static-libmpx}.  The runtime library  behavior can be
11486 influenced using various @env{CHKP_RT_*} environment variables.  See
11487 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11488 for more details.
11490 Generated instrumentation may be controlled by various
11491 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11492 structure field attribute (@pxref{Type Attributes}) and
11493 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11494 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11495 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11496 Bounds Checker builtins}, for more information.
11498 @item -fchkp-check-incomplete-type
11499 @opindex fchkp-check-incomplete-type
11500 @opindex fno-chkp-check-incomplete-type
11501 Generate pointer bounds checks for variables with incomplete type.
11502 Enabled by default.
11504 @item -fchkp-narrow-bounds
11505 @opindex fchkp-narrow-bounds
11506 @opindex fno-chkp-narrow-bounds
11507 Controls bounds used by Pointer Bounds Checker for pointers to object
11508 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11509 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11510 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11512 @item -fchkp-first-field-has-own-bounds
11513 @opindex fchkp-first-field-has-own-bounds
11514 @opindex fno-chkp-first-field-has-own-bounds
11515 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11516 first field in the structure.  By default a pointer to the first field has
11517 the same bounds as a pointer to the whole structure.
11519 @item -fchkp-flexible-struct-trailing-arrays
11520 @opindex fchkp-flexible-struct-trailing-arrays
11521 @opindex fno-chkp-flexible-struct-trailing-arrays
11522 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11523 possibly flexible.  By default only array fields with zero length or that are
11524 marked with attribute bnd_variable_size are treated as flexible.
11526 @item -fchkp-narrow-to-innermost-array
11527 @opindex fchkp-narrow-to-innermost-array
11528 @opindex fno-chkp-narrow-to-innermost-array
11529 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11530 case of nested static array access.  By default this option is disabled and
11531 bounds of the outermost array are used.
11533 @item -fchkp-optimize
11534 @opindex fchkp-optimize
11535 @opindex fno-chkp-optimize
11536 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11537 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11539 @item -fchkp-use-fast-string-functions
11540 @opindex fchkp-use-fast-string-functions
11541 @opindex fno-chkp-use-fast-string-functions
11542 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11543 by Pointer Bounds Checker.  Disabled by default.
11545 @item -fchkp-use-nochk-string-functions
11546 @opindex fchkp-use-nochk-string-functions
11547 @opindex fno-chkp-use-nochk-string-functions
11548 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11549 by Pointer Bounds Checker.  Disabled by default.
11551 @item -fchkp-use-static-bounds
11552 @opindex fchkp-use-static-bounds
11553 @opindex fno-chkp-use-static-bounds
11554 Allow Pointer Bounds Checker to generate static bounds holding
11555 bounds of static variables.  Enabled by default.
11557 @item -fchkp-use-static-const-bounds
11558 @opindex fchkp-use-static-const-bounds
11559 @opindex fno-chkp-use-static-const-bounds
11560 Use statically-initialized bounds for constant bounds instead of
11561 generating them each time they are required.  By default enabled when
11562 @option{-fchkp-use-static-bounds} is enabled.
11564 @item -fchkp-treat-zero-dynamic-size-as-infinite
11565 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11566 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11567 With this option, objects with incomplete type whose
11568 dynamically-obtained size is zero are treated as having infinite size
11569 instead by Pointer Bounds
11570 Checker.  This option may be helpful if a program is linked with a library
11571 missing size information for some symbols.  Disabled by default.
11573 @item -fchkp-check-read
11574 @opindex fchkp-check-read
11575 @opindex fno-chkp-check-read
11576 Instructs Pointer Bounds Checker to generate checks for all read
11577 accesses to memory.  Enabled by default.
11579 @item -fchkp-check-write
11580 @opindex fchkp-check-write
11581 @opindex fno-chkp-check-write
11582 Instructs Pointer Bounds Checker to generate checks for all write
11583 accesses to memory.  Enabled by default.
11585 @item -fchkp-store-bounds
11586 @opindex fchkp-store-bounds
11587 @opindex fno-chkp-store-bounds
11588 Instructs Pointer Bounds Checker to generate bounds stores for
11589 pointer writes.  Enabled by default.
11591 @item -fchkp-instrument-calls
11592 @opindex fchkp-instrument-calls
11593 @opindex fno-chkp-instrument-calls
11594 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11595 Enabled by default.
11597 @item -fchkp-instrument-marked-only
11598 @opindex fchkp-instrument-marked-only
11599 @opindex fno-chkp-instrument-marked-only
11600 Instructs Pointer Bounds Checker to instrument only functions
11601 marked with the @code{bnd_instrument} attribute
11602 (@pxref{Function Attributes}).  Disabled by default.
11604 @item -fchkp-use-wrappers
11605 @opindex fchkp-use-wrappers
11606 @opindex fno-chkp-use-wrappers
11607 Allows Pointer Bounds Checker to replace calls to built-in functions
11608 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11609 is used to link a program, the GCC driver automatically links
11610 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11611 Enabled by default.
11613 @item -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11614 @opindex fcf-protection
11615 Enable code instrumentation of control-flow transfers to increase
11616 program security by checking that target addresses of control-flow
11617 transfer instructions (such as indirect function call, function return,
11618 indirect jump) are valid.  This prevents diverting the flow of control
11619 to an unexpected target.  This is intended to protect against such
11620 threats as Return-oriented Programming (ROP), and similarly
11621 call/jmp-oriented programming (COP/JOP).
11623 The value @code{branch} tells the compiler to implement checking of
11624 validity of control-flow transfer at the point of indirect branch
11625 instructions, i.e. call/jmp instructions.  The value @code{return}
11626 implements checking of validity at the point of returning from a
11627 function.  The value @code{full} is an alias for specifying both
11628 @code{branch} and @code{return}. The value @code{none} turns off
11629 instrumentation.
11631 You can also use the @code{nocf_check} attribute to identify
11632 which functions and calls should be skipped from instrumentation
11633 (@pxref{Function Attributes}).
11635 Currently the x86 GNU/Linux target provides an implementation based
11636 on Intel Control-flow Enforcement Technology (CET).  Instrumentation
11637 for x86 is controlled by target-specific options @option{-mcet},
11638 @option{-mibt} and @option{-mshstk} (@pxref{x86 Options}).
11640 @item -fstack-protector
11641 @opindex fstack-protector
11642 Emit extra code to check for buffer overflows, such as stack smashing
11643 attacks.  This is done by adding a guard variable to functions with
11644 vulnerable objects.  This includes functions that call @code{alloca}, and
11645 functions with buffers larger than 8 bytes.  The guards are initialized
11646 when a function is entered and then checked when the function exits.
11647 If a guard check fails, an error message is printed and the program exits.
11649 @item -fstack-protector-all
11650 @opindex fstack-protector-all
11651 Like @option{-fstack-protector} except that all functions are protected.
11653 @item -fstack-protector-strong
11654 @opindex fstack-protector-strong
11655 Like @option{-fstack-protector} but includes additional functions to
11656 be protected --- those that have local array definitions, or have
11657 references to local frame addresses.
11659 @item -fstack-protector-explicit
11660 @opindex fstack-protector-explicit
11661 Like @option{-fstack-protector} but only protects those functions which
11662 have the @code{stack_protect} attribute.
11664 @item -fstack-check
11665 @opindex fstack-check
11666 Generate code to verify that you do not go beyond the boundary of the
11667 stack.  You should specify this flag if you are running in an
11668 environment with multiple threads, but you only rarely need to specify it in
11669 a single-threaded environment since stack overflow is automatically
11670 detected on nearly all systems if there is only one stack.
11672 Note that this switch does not actually cause checking to be done; the
11673 operating system or the language runtime must do that.  The switch causes
11674 generation of code to ensure that they see the stack being extended.
11676 You can additionally specify a string parameter: @samp{no} means no
11677 checking, @samp{generic} means force the use of old-style checking,
11678 @samp{specific} means use the best checking method and is equivalent
11679 to bare @option{-fstack-check}.
11681 Old-style checking is a generic mechanism that requires no specific
11682 target support in the compiler but comes with the following drawbacks:
11684 @enumerate
11685 @item
11686 Modified allocation strategy for large objects: they are always
11687 allocated dynamically if their size exceeds a fixed threshold.  Note this
11688 may change the semantics of some code.
11690 @item
11691 Fixed limit on the size of the static frame of functions: when it is
11692 topped by a particular function, stack checking is not reliable and
11693 a warning is issued by the compiler.
11695 @item
11696 Inefficiency: because of both the modified allocation strategy and the
11697 generic implementation, code performance is hampered.
11698 @end enumerate
11700 Note that old-style stack checking is also the fallback method for
11701 @samp{specific} if no target support has been added in the compiler.
11703 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11704 and stack overflows.  @samp{specific} is an excellent choice when compiling
11705 Ada code.  It is not generally sufficient to protect against stack-clash
11706 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11708 @item -fstack-clash-protection
11709 @opindex fstack-clash-protection
11710 Generate code to prevent stack clash style attacks.  When this option is
11711 enabled, the compiler will only allocate one page of stack space at a time
11712 and each page is accessed immediately after allocation.  Thus, it prevents
11713 allocations from jumping over any stack guard page provided by the
11714 operating system.
11716 Most targets do not fully support stack clash protection.  However, on
11717 those targets @option{-fstack-clash-protection} will protect dynamic stack
11718 allocations.  @option{-fstack-clash-protection} may also provide limited
11719 protection for static stack allocations if the target supports
11720 @option{-fstack-check=specific}.
11722 @item -fstack-limit-register=@var{reg}
11723 @itemx -fstack-limit-symbol=@var{sym}
11724 @itemx -fno-stack-limit
11725 @opindex fstack-limit-register
11726 @opindex fstack-limit-symbol
11727 @opindex fno-stack-limit
11728 Generate code to ensure that the stack does not grow beyond a certain value,
11729 either the value of a register or the address of a symbol.  If a larger
11730 stack is required, a signal is raised at run time.  For most targets,
11731 the signal is raised before the stack overruns the boundary, so
11732 it is possible to catch the signal without taking special precautions.
11734 For instance, if the stack starts at absolute address @samp{0x80000000}
11735 and grows downwards, you can use the flags
11736 @option{-fstack-limit-symbol=__stack_limit} and
11737 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11738 of 128KB@.  Note that this may only work with the GNU linker.
11740 You can locally override stack limit checking by using the
11741 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11743 @item -fsplit-stack
11744 @opindex fsplit-stack
11745 Generate code to automatically split the stack before it overflows.
11746 The resulting program has a discontiguous stack which can only
11747 overflow if the program is unable to allocate any more memory.  This
11748 is most useful when running threaded programs, as it is no longer
11749 necessary to calculate a good stack size to use for each thread.  This
11750 is currently only implemented for the x86 targets running
11751 GNU/Linux.
11753 When code compiled with @option{-fsplit-stack} calls code compiled
11754 without @option{-fsplit-stack}, there may not be much stack space
11755 available for the latter code to run.  If compiling all code,
11756 including library code, with @option{-fsplit-stack} is not an option,
11757 then the linker can fix up these calls so that the code compiled
11758 without @option{-fsplit-stack} always has a large stack.  Support for
11759 this is implemented in the gold linker in GNU binutils release 2.21
11760 and later.
11762 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11763 @opindex fvtable-verify
11764 This option is only available when compiling C++ code.
11765 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11766 feature that verifies at run time, for every virtual call, that
11767 the vtable pointer through which the call is made is valid for the type of
11768 the object, and has not been corrupted or overwritten.  If an invalid vtable
11769 pointer is detected at run time, an error is reported and execution of the
11770 program is immediately halted.
11772 This option causes run-time data structures to be built at program startup,
11773 which are used for verifying the vtable pointers.  
11774 The options @samp{std} and @samp{preinit}
11775 control the timing of when these data structures are built.  In both cases the
11776 data structures are built before execution reaches @code{main}.  Using
11777 @option{-fvtable-verify=std} causes the data structures to be built after
11778 shared libraries have been loaded and initialized.
11779 @option{-fvtable-verify=preinit} causes them to be built before shared
11780 libraries have been loaded and initialized.
11782 If this option appears multiple times in the command line with different
11783 values specified, @samp{none} takes highest priority over both @samp{std} and
11784 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11786 @item -fvtv-debug
11787 @opindex fvtv-debug
11788 When used in conjunction with @option{-fvtable-verify=std} or 
11789 @option{-fvtable-verify=preinit}, causes debug versions of the 
11790 runtime functions for the vtable verification feature to be called.  
11791 This flag also causes the compiler to log information about which 
11792 vtable pointers it finds for each class.
11793 This information is written to a file named @file{vtv_set_ptr_data.log} 
11794 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11795 if that is defined or the current working directory otherwise.
11797 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11798 file, be sure to delete any existing one.
11800 @item -fvtv-counts
11801 @opindex fvtv-counts
11802 This is a debugging flag.  When used in conjunction with
11803 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11804 causes the compiler to keep track of the total number of virtual calls
11805 it encounters and the number of verifications it inserts.  It also
11806 counts the number of calls to certain run-time library functions
11807 that it inserts and logs this information for each compilation unit.
11808 The compiler writes this information to a file named
11809 @file{vtv_count_data.log} in the directory named by the environment
11810 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11811 directory otherwise.  It also counts the size of the vtable pointer sets
11812 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11813 in the same directory.
11815 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11816 files, be sure to delete any existing ones.
11818 @item -finstrument-functions
11819 @opindex finstrument-functions
11820 Generate instrumentation calls for entry and exit to functions.  Just
11821 after function entry and just before function exit, the following
11822 profiling functions are called with the address of the current
11823 function and its call site.  (On some platforms,
11824 @code{__builtin_return_address} does not work beyond the current
11825 function, so the call site information may not be available to the
11826 profiling functions otherwise.)
11828 @smallexample
11829 void __cyg_profile_func_enter (void *this_fn,
11830                                void *call_site);
11831 void __cyg_profile_func_exit  (void *this_fn,
11832                                void *call_site);
11833 @end smallexample
11835 The first argument is the address of the start of the current function,
11836 which may be looked up exactly in the symbol table.
11838 This instrumentation is also done for functions expanded inline in other
11839 functions.  The profiling calls indicate where, conceptually, the
11840 inline function is entered and exited.  This means that addressable
11841 versions of such functions must be available.  If all your uses of a
11842 function are expanded inline, this may mean an additional expansion of
11843 code size.  If you use @code{extern inline} in your C code, an
11844 addressable version of such functions must be provided.  (This is
11845 normally the case anyway, but if you get lucky and the optimizer always
11846 expands the functions inline, you might have gotten away without
11847 providing static copies.)
11849 A function may be given the attribute @code{no_instrument_function}, in
11850 which case this instrumentation is not done.  This can be used, for
11851 example, for the profiling functions listed above, high-priority
11852 interrupt routines, and any functions from which the profiling functions
11853 cannot safely be called (perhaps signal handlers, if the profiling
11854 routines generate output or allocate memory).
11856 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11857 @opindex finstrument-functions-exclude-file-list
11859 Set the list of functions that are excluded from instrumentation (see
11860 the description of @option{-finstrument-functions}).  If the file that
11861 contains a function definition matches with one of @var{file}, then
11862 that function is not instrumented.  The match is done on substrings:
11863 if the @var{file} parameter is a substring of the file name, it is
11864 considered to be a match.
11866 For example:
11868 @smallexample
11869 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11870 @end smallexample
11872 @noindent
11873 excludes any inline function defined in files whose pathnames
11874 contain @file{/bits/stl} or @file{include/sys}.
11876 If, for some reason, you want to include letter @samp{,} in one of
11877 @var{sym}, write @samp{\,}. For example,
11878 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11879 (note the single quote surrounding the option).
11881 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11882 @opindex finstrument-functions-exclude-function-list
11884 This is similar to @option{-finstrument-functions-exclude-file-list},
11885 but this option sets the list of function names to be excluded from
11886 instrumentation.  The function name to be matched is its user-visible
11887 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11888 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11889 match is done on substrings: if the @var{sym} parameter is a substring
11890 of the function name, it is considered to be a match.  For C99 and C++
11891 extended identifiers, the function name must be given in UTF-8, not
11892 using universal character names.
11894 @item -fpatchable-function-entry=@var{N}[,@var{M}]
11895 @opindex fpatchable-function-entry
11896 Generate @var{N} NOPs right at the beginning
11897 of each function, with the function entry point before the @var{M}th NOP.
11898 If @var{M} is omitted, it defaults to @code{0} so the
11899 function entry points to the address just at the first NOP.
11900 The NOP instructions reserve extra space which can be used to patch in
11901 any desired instrumentation at run time, provided that the code segment
11902 is writable.  The amount of space is controllable indirectly via
11903 the number of NOPs; the NOP instruction used corresponds to the instruction
11904 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
11905 is target-specific and may also depend on the architecture variant and/or
11906 other compilation options.
11908 For run-time identification, the starting addresses of these areas,
11909 which correspond to their respective function entries minus @var{M},
11910 are additionally collected in the @code{__patchable_function_entries}
11911 section of the resulting binary.
11913 Note that the value of @code{__attribute__ ((patchable_function_entry
11914 (N,M)))} takes precedence over command-line option
11915 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
11916 the area size or to remove it completely on a single function.
11917 If @code{N=0}, no pad location is recorded.
11919 The NOP instructions are inserted at---and maybe before, depending on
11920 @var{M}---the function entry address, even before the prologue.
11922 @end table
11925 @node Preprocessor Options
11926 @section Options Controlling the Preprocessor
11927 @cindex preprocessor options
11928 @cindex options, preprocessor
11930 These options control the C preprocessor, which is run on each C source
11931 file before actual compilation.
11933 If you use the @option{-E} option, nothing is done except preprocessing.
11934 Some of these options make sense only together with @option{-E} because
11935 they cause the preprocessor output to be unsuitable for actual
11936 compilation.
11938 In addition to the options listed here, there are a number of options 
11939 to control search paths for include files documented in 
11940 @ref{Directory Options}.  
11941 Options to control preprocessor diagnostics are listed in 
11942 @ref{Warning Options}.
11944 @table @gcctabopt
11945 @include cppopts.texi
11947 @item -Wp,@var{option}
11948 @opindex Wp
11949 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11950 and pass @var{option} directly through to the preprocessor.  If
11951 @var{option} contains commas, it is split into multiple options at the
11952 commas.  However, many options are modified, translated or interpreted
11953 by the compiler driver before being passed to the preprocessor, and
11954 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11955 interface is undocumented and subject to change, so whenever possible
11956 you should avoid using @option{-Wp} and let the driver handle the
11957 options instead.
11959 @item -Xpreprocessor @var{option}
11960 @opindex Xpreprocessor
11961 Pass @var{option} as an option to the preprocessor.  You can use this to
11962 supply system-specific preprocessor options that GCC does not 
11963 recognize.
11965 If you want to pass an option that takes an argument, you must use
11966 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11968 @item -no-integrated-cpp
11969 @opindex no-integrated-cpp
11970 Perform preprocessing as a separate pass before compilation.
11971 By default, GCC performs preprocessing as an integrated part of
11972 input tokenization and parsing.
11973 If this option is provided, the appropriate language front end
11974 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11975 and Objective-C, respectively) is instead invoked twice,
11976 once for preprocessing only and once for actual compilation
11977 of the preprocessed input.
11978 This option may be useful in conjunction with the @option{-B} or
11979 @option{-wrapper} options to specify an alternate preprocessor or
11980 perform additional processing of the program source between
11981 normal preprocessing and compilation.
11983 @end table
11985 @node Assembler Options
11986 @section Passing Options to the Assembler
11988 @c prevent bad page break with this line
11989 You can pass options to the assembler.
11991 @table @gcctabopt
11992 @item -Wa,@var{option}
11993 @opindex Wa
11994 Pass @var{option} as an option to the assembler.  If @var{option}
11995 contains commas, it is split into multiple options at the commas.
11997 @item -Xassembler @var{option}
11998 @opindex Xassembler
11999 Pass @var{option} as an option to the assembler.  You can use this to
12000 supply system-specific assembler options that GCC does not
12001 recognize.
12003 If you want to pass an option that takes an argument, you must use
12004 @option{-Xassembler} twice, once for the option and once for the argument.
12006 @end table
12008 @node Link Options
12009 @section Options for Linking
12010 @cindex link options
12011 @cindex options, linking
12013 These options come into play when the compiler links object files into
12014 an executable output file.  They are meaningless if the compiler is
12015 not doing a link step.
12017 @table @gcctabopt
12018 @cindex file names
12019 @item @var{object-file-name}
12020 A file name that does not end in a special recognized suffix is
12021 considered to name an object file or library.  (Object files are
12022 distinguished from libraries by the linker according to the file
12023 contents.)  If linking is done, these object files are used as input
12024 to the linker.
12026 @item -c
12027 @itemx -S
12028 @itemx -E
12029 @opindex c
12030 @opindex S
12031 @opindex E
12032 If any of these options is used, then the linker is not run, and
12033 object file names should not be used as arguments.  @xref{Overall
12034 Options}.
12036 @item -fuse-ld=bfd
12037 @opindex fuse-ld=bfd
12038 Use the @command{bfd} linker instead of the default linker.
12040 @item -fuse-ld=gold
12041 @opindex fuse-ld=gold
12042 Use the @command{gold} linker instead of the default linker.
12044 @cindex Libraries
12045 @item -l@var{library}
12046 @itemx -l @var{library}
12047 @opindex l
12048 Search the library named @var{library} when linking.  (The second
12049 alternative with the library as a separate argument is only for
12050 POSIX compliance and is not recommended.)
12052 It makes a difference where in the command you write this option; the
12053 linker searches and processes libraries and object files in the order they
12054 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12055 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12056 to functions in @samp{z}, those functions may not be loaded.
12058 The linker searches a standard list of directories for the library,
12059 which is actually a file named @file{lib@var{library}.a}.  The linker
12060 then uses this file as if it had been specified precisely by name.
12062 The directories searched include several standard system directories
12063 plus any that you specify with @option{-L}.
12065 Normally the files found this way are library files---archive files
12066 whose members are object files.  The linker handles an archive file by
12067 scanning through it for members which define symbols that have so far
12068 been referenced but not defined.  But if the file that is found is an
12069 ordinary object file, it is linked in the usual fashion.  The only
12070 difference between using an @option{-l} option and specifying a file name
12071 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12072 and searches several directories.
12074 @item -lobjc
12075 @opindex lobjc
12076 You need this special case of the @option{-l} option in order to
12077 link an Objective-C or Objective-C++ program.
12079 @item -nostartfiles
12080 @opindex nostartfiles
12081 Do not use the standard system startup files when linking.
12082 The standard system libraries are used normally, unless @option{-nostdlib}
12083 or @option{-nodefaultlibs} is used.
12085 @item -nodefaultlibs
12086 @opindex nodefaultlibs
12087 Do not use the standard system libraries when linking.
12088 Only the libraries you specify are passed to the linker, and options
12089 specifying linkage of the system libraries, such as @option{-static-libgcc}
12090 or @option{-shared-libgcc}, are ignored.  
12091 The standard startup files are used normally, unless @option{-nostartfiles}
12092 is used.  
12094 The compiler may generate calls to @code{memcmp},
12095 @code{memset}, @code{memcpy} and @code{memmove}.
12096 These entries are usually resolved by entries in
12097 libc.  These entry points should be supplied through some other
12098 mechanism when this option is specified.
12100 @item -nostdlib
12101 @opindex nostdlib
12102 Do not use the standard system startup files or libraries when linking.
12103 No startup files and only the libraries you specify are passed to
12104 the linker, and options specifying linkage of the system libraries, such as
12105 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12107 The compiler may generate calls to @code{memcmp}, @code{memset},
12108 @code{memcpy} and @code{memmove}.
12109 These entries are usually resolved by entries in
12110 libc.  These entry points should be supplied through some other
12111 mechanism when this option is specified.
12113 @cindex @option{-lgcc}, use with @option{-nostdlib}
12114 @cindex @option{-nostdlib} and unresolved references
12115 @cindex unresolved references and @option{-nostdlib}
12116 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12117 @cindex @option{-nodefaultlibs} and unresolved references
12118 @cindex unresolved references and @option{-nodefaultlibs}
12119 One of the standard libraries bypassed by @option{-nostdlib} and
12120 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12121 which GCC uses to overcome shortcomings of particular machines, or special
12122 needs for some languages.
12123 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12124 Collection (GCC) Internals},
12125 for more discussion of @file{libgcc.a}.)
12126 In most cases, you need @file{libgcc.a} even when you want to avoid
12127 other standard libraries.  In other words, when you specify @option{-nostdlib}
12128 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12129 This ensures that you have no unresolved references to internal GCC
12130 library subroutines.
12131 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12132 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12133 GNU Compiler Collection (GCC) Internals}.)
12135 @item -pie
12136 @opindex pie
12137 Produce a dynamically linked position independent executable on targets
12138 that support it.  For predictable results, you must also specify the same
12139 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12140 or model suboptions) when you specify this linker option.
12142 @item -no-pie
12143 @opindex no-pie
12144 Don't produce a dynamically linked position independent executable.
12146 @item -static-pie
12147 @opindex static-pie
12148 Produce a static position independent executable on targets that support
12149 it.  A static position independent executable is similar to a static
12150 executable, but can be loaded at any address without a dynamic linker.
12151 For predictable results, you must also specify the same set of options
12152 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12153 suboptions) when you specify this linker option.
12155 @item -pthread
12156 @opindex pthread
12157 Link with the POSIX threads library.  This option is supported on 
12158 GNU/Linux targets, most other Unix derivatives, and also on 
12159 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12160 flags for the preprocessor, so it should be used consistently for both
12161 compilation and linking.
12163 @item -rdynamic
12164 @opindex rdynamic
12165 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12166 that support it. This instructs the linker to add all symbols, not
12167 only used ones, to the dynamic symbol table. This option is needed
12168 for some uses of @code{dlopen} or to allow obtaining backtraces
12169 from within a program.
12171 @item -s
12172 @opindex s
12173 Remove all symbol table and relocation information from the executable.
12175 @item -static
12176 @opindex static
12177 On systems that support dynamic linking, this overrides @option{-pie}
12178 and prevents linking with the shared libraries.  On other systems, this
12179 option has no effect.
12181 @item -shared
12182 @opindex shared
12183 Produce a shared object which can then be linked with other objects to
12184 form an executable.  Not all systems support this option.  For predictable
12185 results, you must also specify the same set of options used for compilation
12186 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12187 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12188 needs to build supplementary stub code for constructors to work.  On
12189 multi-libbed systems, @samp{gcc -shared} must select the correct support
12190 libraries to link against.  Failing to supply the correct flags may lead
12191 to subtle defects.  Supplying them in cases where they are not necessary
12192 is innocuous.}
12194 @item -shared-libgcc
12195 @itemx -static-libgcc
12196 @opindex shared-libgcc
12197 @opindex static-libgcc
12198 On systems that provide @file{libgcc} as a shared library, these options
12199 force the use of either the shared or static version, respectively.
12200 If no shared version of @file{libgcc} was built when the compiler was
12201 configured, these options have no effect.
12203 There are several situations in which an application should use the
12204 shared @file{libgcc} instead of the static version.  The most common
12205 of these is when the application wishes to throw and catch exceptions
12206 across different shared libraries.  In that case, each of the libraries
12207 as well as the application itself should use the shared @file{libgcc}.
12209 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12210  whenever you build a shared library or a main executable, because C++
12211  programs typically use exceptions, so this is the right thing to do.
12213 If, instead, you use the GCC driver to create shared libraries, you may
12214 find that they are not always linked with the shared @file{libgcc}.
12215 If GCC finds, at its configuration time, that you have a non-GNU linker
12216 or a GNU linker that does not support option @option{--eh-frame-hdr},
12217 it links the shared version of @file{libgcc} into shared libraries
12218 by default.  Otherwise, it takes advantage of the linker and optimizes
12219 away the linking with the shared version of @file{libgcc}, linking with
12220 the static version of libgcc by default.  This allows exceptions to
12221 propagate through such shared libraries, without incurring relocation
12222 costs at library load time.
12224 However, if a library or main executable is supposed to throw or catch
12225 exceptions, you must link it using the G++ driver, as appropriate
12226 for the languages used in the program, or using the option
12227 @option{-shared-libgcc}, such that it is linked with the shared
12228 @file{libgcc}.
12230 @item -static-libasan
12231 @opindex static-libasan
12232 When the @option{-fsanitize=address} option is used to link a program,
12233 the GCC driver automatically links against @option{libasan}.  If
12234 @file{libasan} is available as a shared library, and the @option{-static}
12235 option is not used, then this links against the shared version of
12236 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12237 driver to link @file{libasan} statically, without necessarily linking
12238 other libraries statically.
12240 @item -static-libtsan
12241 @opindex static-libtsan
12242 When the @option{-fsanitize=thread} option is used to link a program,
12243 the GCC driver automatically links against @option{libtsan}.  If
12244 @file{libtsan} is available as a shared library, and the @option{-static}
12245 option is not used, then this links against the shared version of
12246 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12247 driver to link @file{libtsan} statically, without necessarily linking
12248 other libraries statically.
12250 @item -static-liblsan
12251 @opindex static-liblsan
12252 When the @option{-fsanitize=leak} option is used to link a program,
12253 the GCC driver automatically links against @option{liblsan}.  If
12254 @file{liblsan} is available as a shared library, and the @option{-static}
12255 option is not used, then this links against the shared version of
12256 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12257 driver to link @file{liblsan} statically, without necessarily linking
12258 other libraries statically.
12260 @item -static-libubsan
12261 @opindex static-libubsan
12262 When the @option{-fsanitize=undefined} option is used to link a program,
12263 the GCC driver automatically links against @option{libubsan}.  If
12264 @file{libubsan} is available as a shared library, and the @option{-static}
12265 option is not used, then this links against the shared version of
12266 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12267 driver to link @file{libubsan} statically, without necessarily linking
12268 other libraries statically.
12270 @item -static-libmpx
12271 @opindex static-libmpx
12272 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12273 used to link a program, the GCC driver automatically links against
12274 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12275 and the @option{-static} option is not used, then this links against
12276 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12277 option directs the GCC driver to link @file{libmpx} statically,
12278 without necessarily linking other libraries statically.
12280 @item -static-libmpxwrappers
12281 @opindex static-libmpxwrappers
12282 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12283 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12284 GCC driver automatically links against @file{libmpxwrappers}.  If
12285 @file{libmpxwrappers} is available as a shared library, and the
12286 @option{-static} option is not used, then this links against the shared
12287 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12288 option directs the GCC driver to link @file{libmpxwrappers} statically,
12289 without necessarily linking other libraries statically.
12291 @item -static-libstdc++
12292 @opindex static-libstdc++
12293 When the @command{g++} program is used to link a C++ program, it
12294 normally automatically links against @option{libstdc++}.  If
12295 @file{libstdc++} is available as a shared library, and the
12296 @option{-static} option is not used, then this links against the
12297 shared version of @file{libstdc++}.  That is normally fine.  However, it
12298 is sometimes useful to freeze the version of @file{libstdc++} used by
12299 the program without going all the way to a fully static link.  The
12300 @option{-static-libstdc++} option directs the @command{g++} driver to
12301 link @file{libstdc++} statically, without necessarily linking other
12302 libraries statically.
12304 @item -symbolic
12305 @opindex symbolic
12306 Bind references to global symbols when building a shared object.  Warn
12307 about any unresolved references (unless overridden by the link editor
12308 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12309 this option.
12311 @item -T @var{script}
12312 @opindex T
12313 @cindex linker script
12314 Use @var{script} as the linker script.  This option is supported by most
12315 systems using the GNU linker.  On some targets, such as bare-board
12316 targets without an operating system, the @option{-T} option may be required
12317 when linking to avoid references to undefined symbols.
12319 @item -Xlinker @var{option}
12320 @opindex Xlinker
12321 Pass @var{option} as an option to the linker.  You can use this to
12322 supply system-specific linker options that GCC does not recognize.
12324 If you want to pass an option that takes a separate argument, you must use
12325 @option{-Xlinker} twice, once for the option and once for the argument.
12326 For example, to pass @option{-assert definitions}, you must write
12327 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12328 @option{-Xlinker "-assert definitions"}, because this passes the entire
12329 string as a single argument, which is not what the linker expects.
12331 When using the GNU linker, it is usually more convenient to pass
12332 arguments to linker options using the @option{@var{option}=@var{value}}
12333 syntax than as separate arguments.  For example, you can specify
12334 @option{-Xlinker -Map=output.map} rather than
12335 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12336 this syntax for command-line options.
12338 @item -Wl,@var{option}
12339 @opindex Wl
12340 Pass @var{option} as an option to the linker.  If @var{option} contains
12341 commas, it is split into multiple options at the commas.  You can use this
12342 syntax to pass an argument to the option.
12343 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12344 linker.  When using the GNU linker, you can also get the same effect with
12345 @option{-Wl,-Map=output.map}.
12347 @item -u @var{symbol}
12348 @opindex u
12349 Pretend the symbol @var{symbol} is undefined, to force linking of
12350 library modules to define it.  You can use @option{-u} multiple times with
12351 different symbols to force loading of additional library modules.
12353 @item -z @var{keyword}
12354 @opindex z
12355 @option{-z} is passed directly on to the linker along with the keyword
12356 @var{keyword}. See the section in the documentation of your linker for
12357 permitted values and their meanings.
12358 @end table
12360 @node Directory Options
12361 @section Options for Directory Search
12362 @cindex directory options
12363 @cindex options, directory search
12364 @cindex search path
12366 These options specify directories to search for header files, for
12367 libraries and for parts of the compiler:
12369 @table @gcctabopt
12370 @include cppdiropts.texi
12372 @item -iplugindir=@var{dir}
12373 @opindex iplugindir=
12374 Set the directory to search for plugins that are passed
12375 by @option{-fplugin=@var{name}} instead of
12376 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12377 to be used by the user, but only passed by the driver.
12379 @item -L@var{dir}
12380 @opindex L
12381 Add directory @var{dir} to the list of directories to be searched
12382 for @option{-l}.
12384 @item -B@var{prefix}
12385 @opindex B
12386 This option specifies where to find the executables, libraries,
12387 include files, and data files of the compiler itself.
12389 The compiler driver program runs one or more of the subprograms
12390 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12391 @var{prefix} as a prefix for each program it tries to run, both with and
12392 without @samp{@var{machine}/@var{version}/} for the corresponding target
12393 machine and compiler version.
12395 For each subprogram to be run, the compiler driver first tries the
12396 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12397 is not specified, the driver tries two standard prefixes, 
12398 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12399 those results in a file name that is found, the unmodified program
12400 name is searched for using the directories specified in your
12401 @env{PATH} environment variable.
12403 The compiler checks to see if the path provided by @option{-B}
12404 refers to a directory, and if necessary it adds a directory
12405 separator character at the end of the path.
12407 @option{-B} prefixes that effectively specify directory names also apply
12408 to libraries in the linker, because the compiler translates these
12409 options into @option{-L} options for the linker.  They also apply to
12410 include files in the preprocessor, because the compiler translates these
12411 options into @option{-isystem} options for the preprocessor.  In this case,
12412 the compiler appends @samp{include} to the prefix.
12414 The runtime support file @file{libgcc.a} can also be searched for using
12415 the @option{-B} prefix, if needed.  If it is not found there, the two
12416 standard prefixes above are tried, and that is all.  The file is left
12417 out of the link if it is not found by those means.
12419 Another way to specify a prefix much like the @option{-B} prefix is to use
12420 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12421 Variables}.
12423 As a special kludge, if the path provided by @option{-B} is
12424 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12425 9, then it is replaced by @file{[dir/]include}.  This is to help
12426 with boot-strapping the compiler.
12428 @item -no-canonical-prefixes
12429 @opindex no-canonical-prefixes
12430 Do not expand any symbolic links, resolve references to @samp{/../}
12431 or @samp{/./}, or make the path absolute when generating a relative
12432 prefix.
12434 @item --sysroot=@var{dir}
12435 @opindex sysroot
12436 Use @var{dir} as the logical root directory for headers and libraries.
12437 For example, if the compiler normally searches for headers in
12438 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12439 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12441 If you use both this option and the @option{-isysroot} option, then
12442 the @option{--sysroot} option applies to libraries, but the
12443 @option{-isysroot} option applies to header files.
12445 The GNU linker (beginning with version 2.16) has the necessary support
12446 for this option.  If your linker does not support this option, the
12447 header file aspect of @option{--sysroot} still works, but the
12448 library aspect does not.
12450 @item --no-sysroot-suffix
12451 @opindex no-sysroot-suffix
12452 For some targets, a suffix is added to the root directory specified
12453 with @option{--sysroot}, depending on the other options used, so that
12454 headers may for example be found in
12455 @file{@var{dir}/@var{suffix}/usr/include} instead of
12456 @file{@var{dir}/usr/include}.  This option disables the addition of
12457 such a suffix.
12459 @end table
12461 @node Code Gen Options
12462 @section Options for Code Generation Conventions
12463 @cindex code generation conventions
12464 @cindex options, code generation
12465 @cindex run-time options
12467 These machine-independent options control the interface conventions
12468 used in code generation.
12470 Most of them have both positive and negative forms; the negative form
12471 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12472 one of the forms is listed---the one that is not the default.  You
12473 can figure out the other form by either removing @samp{no-} or adding
12476 @table @gcctabopt
12477 @item -fstack-reuse=@var{reuse-level}
12478 @opindex fstack_reuse
12479 This option controls stack space reuse for user declared local/auto variables
12480 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12481 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12482 local variables and temporaries, @samp{named_vars} enables the reuse only for
12483 user defined local variables with names, and @samp{none} disables stack reuse
12484 completely. The default value is @samp{all}. The option is needed when the
12485 program extends the lifetime of a scoped local variable or a compiler generated
12486 temporary beyond the end point defined by the language.  When a lifetime of
12487 a variable ends, and if the variable lives in memory, the optimizing compiler
12488 has the freedom to reuse its stack space with other temporaries or scoped
12489 local variables whose live range does not overlap with it. Legacy code extending
12490 local lifetime is likely to break with the stack reuse optimization.
12492 For example,
12494 @smallexample
12495    int *p;
12496    @{
12497      int local1;
12499      p = &local1;
12500      local1 = 10;
12501      ....
12502    @}
12503    @{
12504       int local2;
12505       local2 = 20;
12506       ...
12507    @}
12509    if (*p == 10)  // out of scope use of local1
12510      @{
12512      @}
12513 @end smallexample
12515 Another example:
12516 @smallexample
12518    struct A
12519    @{
12520        A(int k) : i(k), j(k) @{ @}
12521        int i;
12522        int j;
12523    @};
12525    A *ap;
12527    void foo(const A& ar)
12528    @{
12529       ap = &ar;
12530    @}
12532    void bar()
12533    @{
12534       foo(A(10)); // temp object's lifetime ends when foo returns
12536       @{
12537         A a(20);
12538         ....
12539       @}
12540       ap->i+= 10;  // ap references out of scope temp whose space
12541                    // is reused with a. What is the value of ap->i?
12542    @}
12544 @end smallexample
12546 The lifetime of a compiler generated temporary is well defined by the C++
12547 standard. When a lifetime of a temporary ends, and if the temporary lives
12548 in memory, the optimizing compiler has the freedom to reuse its stack
12549 space with other temporaries or scoped local variables whose live range
12550 does not overlap with it. However some of the legacy code relies on
12551 the behavior of older compilers in which temporaries' stack space is
12552 not reused, the aggressive stack reuse can lead to runtime errors. This
12553 option is used to control the temporary stack reuse optimization.
12555 @item -ftrapv
12556 @opindex ftrapv
12557 This option generates traps for signed overflow on addition, subtraction,
12558 multiplication operations.
12559 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12560 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12561 @option{-fwrapv} being effective.  Note that only active options override, so
12562 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12563 results in @option{-ftrapv} being effective.
12565 @item -fwrapv
12566 @opindex fwrapv
12567 This option instructs the compiler to assume that signed arithmetic
12568 overflow of addition, subtraction and multiplication wraps around
12569 using twos-complement representation.  This flag enables some optimizations
12570 and disables others.
12571 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12572 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12573 @option{-fwrapv} being effective.  Note that only active options override, so
12574 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12575 results in @option{-ftrapv} being effective.
12577 @item -fexceptions
12578 @opindex fexceptions
12579 Enable exception handling.  Generates extra code needed to propagate
12580 exceptions.  For some targets, this implies GCC generates frame
12581 unwind information for all functions, which can produce significant data
12582 size overhead, although it does not affect execution.  If you do not
12583 specify this option, GCC enables it by default for languages like
12584 C++ that normally require exception handling, and disables it for
12585 languages like C that do not normally require it.  However, you may need
12586 to enable this option when compiling C code that needs to interoperate
12587 properly with exception handlers written in C++.  You may also wish to
12588 disable this option if you are compiling older C++ programs that don't
12589 use exception handling.
12591 @item -fnon-call-exceptions
12592 @opindex fnon-call-exceptions
12593 Generate code that allows trapping instructions to throw exceptions.
12594 Note that this requires platform-specific runtime support that does
12595 not exist everywhere.  Moreover, it only allows @emph{trapping}
12596 instructions to throw exceptions, i.e.@: memory references or floating-point
12597 instructions.  It does not allow exceptions to be thrown from
12598 arbitrary signal handlers such as @code{SIGALRM}.
12600 @item -fdelete-dead-exceptions
12601 @opindex fdelete-dead-exceptions
12602 Consider that instructions that may throw exceptions but don't otherwise
12603 contribute to the execution of the program can be optimized away.
12604 This option is enabled by default for the Ada front end, as permitted by
12605 the Ada language specification.
12606 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12608 @item -funwind-tables
12609 @opindex funwind-tables
12610 Similar to @option{-fexceptions}, except that it just generates any needed
12611 static data, but does not affect the generated code in any other way.
12612 You normally do not need to enable this option; instead, a language processor
12613 that needs this handling enables it on your behalf.
12615 @item -fasynchronous-unwind-tables
12616 @opindex fasynchronous-unwind-tables
12617 Generate unwind table in DWARF format, if supported by target machine.  The
12618 table is exact at each instruction boundary, so it can be used for stack
12619 unwinding from asynchronous events (such as debugger or garbage collector).
12621 @item -fno-gnu-unique
12622 @opindex fno-gnu-unique
12623 On systems with recent GNU assembler and C library, the C++ compiler
12624 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12625 of template static data members and static local variables in inline
12626 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12627 is necessary to avoid problems with a library used by two different
12628 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12629 therefore disagreeing with the other one about the binding of the
12630 symbol.  But this causes @code{dlclose} to be ignored for affected
12631 DSOs; if your program relies on reinitialization of a DSO via
12632 @code{dlclose} and @code{dlopen}, you can use
12633 @option{-fno-gnu-unique}.
12635 @item -fpcc-struct-return
12636 @opindex fpcc-struct-return
12637 Return ``short'' @code{struct} and @code{union} values in memory like
12638 longer ones, rather than in registers.  This convention is less
12639 efficient, but it has the advantage of allowing intercallability between
12640 GCC-compiled files and files compiled with other compilers, particularly
12641 the Portable C Compiler (pcc).
12643 The precise convention for returning structures in memory depends
12644 on the target configuration macros.
12646 Short structures and unions are those whose size and alignment match
12647 that of some integer type.
12649 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12650 switch is not binary compatible with code compiled with the
12651 @option{-freg-struct-return} switch.
12652 Use it to conform to a non-default application binary interface.
12654 @item -freg-struct-return
12655 @opindex freg-struct-return
12656 Return @code{struct} and @code{union} values in registers when possible.
12657 This is more efficient for small structures than
12658 @option{-fpcc-struct-return}.
12660 If you specify neither @option{-fpcc-struct-return} nor
12661 @option{-freg-struct-return}, GCC defaults to whichever convention is
12662 standard for the target.  If there is no standard convention, GCC
12663 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12664 the principal compiler.  In those cases, we can choose the standard, and
12665 we chose the more efficient register return alternative.
12667 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12668 switch is not binary compatible with code compiled with the
12669 @option{-fpcc-struct-return} switch.
12670 Use it to conform to a non-default application binary interface.
12672 @item -fshort-enums
12673 @opindex fshort-enums
12674 Allocate to an @code{enum} type only as many bytes as it needs for the
12675 declared range of possible values.  Specifically, the @code{enum} type
12676 is equivalent to the smallest integer type that has enough room.
12678 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12679 code that is not binary compatible with code generated without that switch.
12680 Use it to conform to a non-default application binary interface.
12682 @item -fshort-wchar
12683 @opindex fshort-wchar
12684 Override the underlying type for @code{wchar_t} to be @code{short
12685 unsigned int} instead of the default for the target.  This option is
12686 useful for building programs to run under WINE@.
12688 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12689 code that is not binary compatible with code generated without that switch.
12690 Use it to conform to a non-default application binary interface.
12692 @item -fno-common
12693 @opindex fno-common
12694 @cindex tentative definitions
12695 In C code, this option controls the placement of global variables 
12696 defined without an initializer, known as @dfn{tentative definitions} 
12697 in the C standard.  Tentative definitions are distinct from declarations 
12698 of a variable with the @code{extern} keyword, which do not allocate storage.
12700 Unix C compilers have traditionally allocated storage for
12701 uninitialized global variables in a common block.  This allows the
12702 linker to resolve all tentative definitions of the same variable
12703 in different compilation units to the same object, or to a non-tentative
12704 definition.  
12705 This is the behavior specified by @option{-fcommon}, and is the default for 
12706 GCC on most targets.  
12707 On the other hand, this behavior is not required by ISO
12708 C, and on some targets may carry a speed or code size penalty on
12709 variable references.
12711 The @option{-fno-common} option specifies that the compiler should instead
12712 place uninitialized global variables in the data section of the object file.
12713 This inhibits the merging of tentative definitions by the linker so
12714 you get a multiple-definition error if the same 
12715 variable is defined in more than one compilation unit.
12716 Compiling with @option{-fno-common} is useful on targets for which
12717 it provides better performance, or if you wish to verify that the
12718 program will work on other systems that always treat uninitialized
12719 variable definitions this way.
12721 @item -fno-ident
12722 @opindex fno-ident
12723 Ignore the @code{#ident} directive.
12725 @item -finhibit-size-directive
12726 @opindex finhibit-size-directive
12727 Don't output a @code{.size} assembler directive, or anything else that
12728 would cause trouble if the function is split in the middle, and the
12729 two halves are placed at locations far apart in memory.  This option is
12730 used when compiling @file{crtstuff.c}; you should not need to use it
12731 for anything else.
12733 @item -fverbose-asm
12734 @opindex fverbose-asm
12735 Put extra commentary information in the generated assembly code to
12736 make it more readable.  This option is generally only of use to those
12737 who actually need to read the generated assembly code (perhaps while
12738 debugging the compiler itself).
12740 @option{-fno-verbose-asm}, the default, causes the
12741 extra information to be omitted and is useful when comparing two assembler
12742 files.
12744 The added comments include:
12746 @itemize @bullet
12748 @item
12749 information on the compiler version and command-line options,
12751 @item
12752 the source code lines associated with the assembly instructions,
12753 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12755 @item
12756 hints on which high-level expressions correspond to
12757 the various assembly instruction operands.
12759 @end itemize
12761 For example, given this C source file:
12763 @smallexample
12764 int test (int n)
12766   int i;
12767   int total = 0;
12769   for (i = 0; i < n; i++)
12770     total += i * i;
12772   return total;
12774 @end smallexample
12776 compiling to (x86_64) assembly via @option{-S} and emitting the result
12777 direct to stdout via @option{-o} @option{-}
12779 @smallexample
12780 gcc -S test.c -fverbose-asm -Os -o -
12781 @end smallexample
12783 gives output similar to this:
12785 @smallexample
12786         .file   "test.c"
12787 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12788   [...snip...]
12789 # options passed:
12790   [...snip...]
12792         .text
12793         .globl  test
12794         .type   test, @@function
12795 test:
12796 .LFB0:
12797         .cfi_startproc
12798 # test.c:4:   int total = 0;
12799         xorl    %eax, %eax      # <retval>
12800 # test.c:6:   for (i = 0; i < n; i++)
12801         xorl    %edx, %edx      # i
12802 .L2:
12803 # test.c:6:   for (i = 0; i < n; i++)
12804         cmpl    %edi, %edx      # n, i
12805         jge     .L5     #,
12806 # test.c:7:     total += i * i;
12807         movl    %edx, %ecx      # i, tmp92
12808         imull   %edx, %ecx      # i, tmp92
12809 # test.c:6:   for (i = 0; i < n; i++)
12810         incl    %edx    # i
12811 # test.c:7:     total += i * i;
12812         addl    %ecx, %eax      # tmp92, <retval>
12813         jmp     .L2     #
12814 .L5:
12815 # test.c:10: @}
12816         ret
12817         .cfi_endproc
12818 .LFE0:
12819         .size   test, .-test
12820         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12821         .section        .note.GNU-stack,"",@@progbits
12822 @end smallexample
12824 The comments are intended for humans rather than machines and hence the
12825 precise format of the comments is subject to change.
12827 @item -frecord-gcc-switches
12828 @opindex frecord-gcc-switches
12829 This switch causes the command line used to invoke the
12830 compiler to be recorded into the object file that is being created.
12831 This switch is only implemented on some targets and the exact format
12832 of the recording is target and binary file format dependent, but it
12833 usually takes the form of a section containing ASCII text.  This
12834 switch is related to the @option{-fverbose-asm} switch, but that
12835 switch only records information in the assembler output file as
12836 comments, so it never reaches the object file.
12837 See also @option{-grecord-gcc-switches} for another
12838 way of storing compiler options into the object file.
12840 @item -fpic
12841 @opindex fpic
12842 @cindex global offset table
12843 @cindex PIC
12844 Generate position-independent code (PIC) suitable for use in a shared
12845 library, if supported for the target machine.  Such code accesses all
12846 constant addresses through a global offset table (GOT)@.  The dynamic
12847 loader resolves the GOT entries when the program starts (the dynamic
12848 loader is not part of GCC; it is part of the operating system).  If
12849 the GOT size for the linked executable exceeds a machine-specific
12850 maximum size, you get an error message from the linker indicating that
12851 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12852 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12853 on the m68k and RS/6000.  The x86 has no such limit.)
12855 Position-independent code requires special support, and therefore works
12856 only on certain machines.  For the x86, GCC supports PIC for System V
12857 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12858 position-independent.
12860 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12861 are defined to 1.
12863 @item -fPIC
12864 @opindex fPIC
12865 If supported for the target machine, emit position-independent code,
12866 suitable for dynamic linking and avoiding any limit on the size of the
12867 global offset table.  This option makes a difference on AArch64, m68k,
12868 PowerPC and SPARC@.
12870 Position-independent code requires special support, and therefore works
12871 only on certain machines.
12873 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12874 are defined to 2.
12876 @item -fpie
12877 @itemx -fPIE
12878 @opindex fpie
12879 @opindex fPIE
12880 These options are similar to @option{-fpic} and @option{-fPIC}, but
12881 generated position independent code can be only linked into executables.
12882 Usually these options are used when @option{-pie} GCC option is
12883 used during linking.
12885 @option{-fpie} and @option{-fPIE} both define the macros
12886 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12887 for @option{-fpie} and 2 for @option{-fPIE}.
12889 @item -fno-plt
12890 @opindex fno-plt
12891 Do not use the PLT for external function calls in position-independent code.
12892 Instead, load the callee address at call sites from the GOT and branch to it.
12893 This leads to more efficient code by eliminating PLT stubs and exposing
12894 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12895 PLT stubs expect the GOT pointer in a specific register, this gives more
12896 register allocation freedom to the compiler.
12897 Lazy binding requires use of the PLT; 
12898 with @option{-fno-plt} all external symbols are resolved at load time.
12900 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12901 through the PLT for specific external functions.
12903 In position-dependent code, a few targets also convert calls to
12904 functions that are marked to not use the PLT to use the GOT instead.
12906 @item -fno-jump-tables
12907 @opindex fno-jump-tables
12908 Do not use jump tables for switch statements even where it would be
12909 more efficient than other code generation strategies.  This option is
12910 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12911 building code that forms part of a dynamic linker and cannot
12912 reference the address of a jump table.  On some targets, jump tables
12913 do not require a GOT and this option is not needed.
12915 @item -ffixed-@var{reg}
12916 @opindex ffixed
12917 Treat the register named @var{reg} as a fixed register; generated code
12918 should never refer to it (except perhaps as a stack pointer, frame
12919 pointer or in some other fixed role).
12921 @var{reg} must be the name of a register.  The register names accepted
12922 are machine-specific and are defined in the @code{REGISTER_NAMES}
12923 macro in the machine description macro file.
12925 This flag does not have a negative form, because it specifies a
12926 three-way choice.
12928 @item -fcall-used-@var{reg}
12929 @opindex fcall-used
12930 Treat the register named @var{reg} as an allocable register that is
12931 clobbered by function calls.  It may be allocated for temporaries or
12932 variables that do not live across a call.  Functions compiled this way
12933 do not save and restore the register @var{reg}.
12935 It is an error to use this flag with the frame pointer or stack pointer.
12936 Use of this flag for other registers that have fixed pervasive roles in
12937 the machine's execution model produces disastrous results.
12939 This flag does not have a negative form, because it specifies a
12940 three-way choice.
12942 @item -fcall-saved-@var{reg}
12943 @opindex fcall-saved
12944 Treat the register named @var{reg} as an allocable register saved by
12945 functions.  It may be allocated even for temporaries or variables that
12946 live across a call.  Functions compiled this way save and restore
12947 the register @var{reg} if they use it.
12949 It is an error to use this flag with the frame pointer or stack pointer.
12950 Use of this flag for other registers that have fixed pervasive roles in
12951 the machine's execution model produces disastrous results.
12953 A different sort of disaster results from the use of this flag for
12954 a register in which function values may be returned.
12956 This flag does not have a negative form, because it specifies a
12957 three-way choice.
12959 @item -fpack-struct[=@var{n}]
12960 @opindex fpack-struct
12961 Without a value specified, pack all structure members together without
12962 holes.  When a value is specified (which must be a small power of two), pack
12963 structure members according to this value, representing the maximum
12964 alignment (that is, objects with default alignment requirements larger than
12965 this are output potentially unaligned at the next fitting location.
12967 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12968 code that is not binary compatible with code generated without that switch.
12969 Additionally, it makes the code suboptimal.
12970 Use it to conform to a non-default application binary interface.
12972 @item -fleading-underscore
12973 @opindex fleading-underscore
12974 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12975 change the way C symbols are represented in the object file.  One use
12976 is to help link with legacy assembly code.
12978 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12979 generate code that is not binary compatible with code generated without that
12980 switch.  Use it to conform to a non-default application binary interface.
12981 Not all targets provide complete support for this switch.
12983 @item -ftls-model=@var{model}
12984 @opindex ftls-model
12985 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12986 The @var{model} argument should be one of @samp{global-dynamic},
12987 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12988 Note that the choice is subject to optimization: the compiler may use
12989 a more efficient model for symbols not visible outside of the translation
12990 unit, or if @option{-fpic} is not given on the command line.
12992 The default without @option{-fpic} is @samp{initial-exec}; with
12993 @option{-fpic} the default is @samp{global-dynamic}.
12995 @item -ftrampolines
12996 @opindex ftrampolines
12997 For targets that normally need trampolines for nested functions, always
12998 generate them instead of using descriptors.  Otherwise, for targets that
12999 do not need them, like for example HP-PA or IA-64, do nothing.
13001 A trampoline is a small piece of code that is created at run time on the
13002 stack when the address of a nested function is taken, and is used to call
13003 the nested function indirectly.  Therefore, it requires the stack to be
13004 made executable in order for the program to work properly.
13006 @option{-fno-trampolines} is enabled by default on a language by language
13007 basis to let the compiler avoid generating them, if it computes that this
13008 is safe, and replace them with descriptors.  Descriptors are made up of data
13009 only, but the generated code must be prepared to deal with them.  As of this
13010 writing, @option{-fno-trampolines} is enabled by default only for Ada.
13012 Moreover, code compiled with @option{-ftrampolines} and code compiled with
13013 @option{-fno-trampolines} are not binary compatible if nested functions are
13014 present.  This option must therefore be used on a program-wide basis and be
13015 manipulated with extreme care.
13017 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
13018 @opindex fvisibility
13019 Set the default ELF image symbol visibility to the specified option---all
13020 symbols are marked with this unless overridden within the code.
13021 Using this feature can very substantially improve linking and
13022 load times of shared object libraries, produce more optimized
13023 code, provide near-perfect API export and prevent symbol clashes.
13024 It is @strong{strongly} recommended that you use this in any shared objects
13025 you distribute.
13027 Despite the nomenclature, @samp{default} always means public; i.e.,
13028 available to be linked against from outside the shared object.
13029 @samp{protected} and @samp{internal} are pretty useless in real-world
13030 usage so the only other commonly used option is @samp{hidden}.
13031 The default if @option{-fvisibility} isn't specified is
13032 @samp{default}, i.e., make every symbol public.
13034 A good explanation of the benefits offered by ensuring ELF
13035 symbols have the correct visibility is given by ``How To Write
13036 Shared Libraries'' by Ulrich Drepper (which can be found at
13037 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13038 solution made possible by this option to marking things hidden when
13039 the default is public is to make the default hidden and mark things
13040 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13041 and @code{__attribute__ ((visibility("default")))} instead of
13042 @code{__declspec(dllexport)} you get almost identical semantics with
13043 identical syntax.  This is a great boon to those working with
13044 cross-platform projects.
13046 For those adding visibility support to existing code, you may find
13047 @code{#pragma GCC visibility} of use.  This works by you enclosing
13048 the declarations you wish to set visibility for with (for example)
13049 @code{#pragma GCC visibility push(hidden)} and
13050 @code{#pragma GCC visibility pop}.
13051 Bear in mind that symbol visibility should be viewed @strong{as
13052 part of the API interface contract} and thus all new code should
13053 always specify visibility when it is not the default; i.e., declarations
13054 only for use within the local DSO should @strong{always} be marked explicitly
13055 as hidden as so to avoid PLT indirection overheads---making this
13056 abundantly clear also aids readability and self-documentation of the code.
13057 Note that due to ISO C++ specification requirements, @code{operator new} and
13058 @code{operator delete} must always be of default visibility.
13060 Be aware that headers from outside your project, in particular system
13061 headers and headers from any other library you use, may not be
13062 expecting to be compiled with visibility other than the default.  You
13063 may need to explicitly say @code{#pragma GCC visibility push(default)}
13064 before including any such headers.
13066 @code{extern} declarations are not affected by @option{-fvisibility}, so
13067 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13068 no modifications.  However, this means that calls to @code{extern}
13069 functions with no explicit visibility use the PLT, so it is more
13070 effective to use @code{__attribute ((visibility))} and/or
13071 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13072 declarations should be treated as hidden.
13074 Note that @option{-fvisibility} does affect C++ vague linkage
13075 entities. This means that, for instance, an exception class that is
13076 be thrown between DSOs must be explicitly marked with default
13077 visibility so that the @samp{type_info} nodes are unified between
13078 the DSOs.
13080 An overview of these techniques, their benefits and how to use them
13081 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13083 @item -fstrict-volatile-bitfields
13084 @opindex fstrict-volatile-bitfields
13085 This option should be used if accesses to volatile bit-fields (or other
13086 structure fields, although the compiler usually honors those types
13087 anyway) should use a single access of the width of the
13088 field's type, aligned to a natural alignment if possible.  For
13089 example, targets with memory-mapped peripheral registers might require
13090 all such accesses to be 16 bits wide; with this flag you can
13091 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13092 is 16 bits on these targets) to force GCC to use 16-bit accesses
13093 instead of, perhaps, a more efficient 32-bit access.
13095 If this option is disabled, the compiler uses the most efficient
13096 instruction.  In the previous example, that might be a 32-bit load
13097 instruction, even though that accesses bytes that do not contain
13098 any portion of the bit-field, or memory-mapped registers unrelated to
13099 the one being updated.
13101 In some cases, such as when the @code{packed} attribute is applied to a 
13102 structure field, it may not be possible to access the field with a single
13103 read or write that is correctly aligned for the target machine.  In this
13104 case GCC falls back to generating multiple accesses rather than code that 
13105 will fault or truncate the result at run time.
13107 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13108 not allowed to touch non bit-field members.  It is therefore recommended
13109 to define all bits of the field's type as bit-field members.
13111 The default value of this option is determined by the application binary
13112 interface for the target processor.
13114 @item -fsync-libcalls
13115 @opindex fsync-libcalls
13116 This option controls whether any out-of-line instance of the @code{__sync}
13117 family of functions may be used to implement the C++11 @code{__atomic}
13118 family of functions.
13120 The default value of this option is enabled, thus the only useful form
13121 of the option is @option{-fno-sync-libcalls}.  This option is used in
13122 the implementation of the @file{libatomic} runtime library.
13124 @end table
13126 @node Developer Options
13127 @section GCC Developer Options
13128 @cindex developer options
13129 @cindex debugging GCC
13130 @cindex debug dump options
13131 @cindex dump options
13132 @cindex compilation statistics
13134 This section describes command-line options that are primarily of
13135 interest to GCC developers, including options to support compiler
13136 testing and investigation of compiler bugs and compile-time
13137 performance problems.  This includes options that produce debug dumps
13138 at various points in the compilation; that print statistics such as
13139 memory use and execution time; and that print information about GCC's
13140 configuration, such as where it searches for libraries.  You should
13141 rarely need to use any of these options for ordinary compilation and
13142 linking tasks.
13144 @table @gcctabopt
13146 @item -d@var{letters}
13147 @itemx -fdump-rtl-@var{pass}
13148 @itemx -fdump-rtl-@var{pass}=@var{filename}
13149 @opindex d
13150 @opindex fdump-rtl-@var{pass}
13151 Says to make debugging dumps during compilation at times specified by
13152 @var{letters}.  This is used for debugging the RTL-based passes of the
13153 compiler.  The file names for most of the dumps are made by appending
13154 a pass number and a word to the @var{dumpname}, and the files are
13155 created in the directory of the output file.  In case of
13156 @option{=@var{filename}} option, the dump is output on the given file
13157 instead of the pass numbered dump files.  Note that the pass number is
13158 assigned as passes are registered into the pass manager.  Most passes
13159 are registered in the order that they will execute and for these passes
13160 the number corresponds to the pass execution order.  However, passes
13161 registered by plugins, passes specific to compilation targets, or
13162 passes that are otherwise registered after all the other passes are
13163 numbered higher than a pass named "final", even if they are executed
13164 earlier.  @var{dumpname} is generated from the name of the output
13165 file if explicitly specified and not an executable, otherwise it is
13166 the basename of the source file.  
13168 Some @option{-d@var{letters}} switches have different meaning when
13169 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13170 for information about preprocessor-specific dump options.
13172 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13173 @option{-d} option @var{letters}.  Here are the possible
13174 letters for use in @var{pass} and @var{letters}, and their meanings:
13176 @table @gcctabopt
13178 @item -fdump-rtl-alignments
13179 @opindex fdump-rtl-alignments
13180 Dump after branch alignments have been computed.
13182 @item -fdump-rtl-asmcons
13183 @opindex fdump-rtl-asmcons
13184 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13186 @item -fdump-rtl-auto_inc_dec
13187 @opindex fdump-rtl-auto_inc_dec
13188 Dump after auto-inc-dec discovery.  This pass is only run on
13189 architectures that have auto inc or auto dec instructions.
13191 @item -fdump-rtl-barriers
13192 @opindex fdump-rtl-barriers
13193 Dump after cleaning up the barrier instructions.
13195 @item -fdump-rtl-bbpart
13196 @opindex fdump-rtl-bbpart
13197 Dump after partitioning hot and cold basic blocks.
13199 @item -fdump-rtl-bbro
13200 @opindex fdump-rtl-bbro
13201 Dump after block reordering.
13203 @item -fdump-rtl-btl1
13204 @itemx -fdump-rtl-btl2
13205 @opindex fdump-rtl-btl2
13206 @opindex fdump-rtl-btl2
13207 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13208 after the two branch
13209 target load optimization passes.
13211 @item -fdump-rtl-bypass
13212 @opindex fdump-rtl-bypass
13213 Dump after jump bypassing and control flow optimizations.
13215 @item -fdump-rtl-combine
13216 @opindex fdump-rtl-combine
13217 Dump after the RTL instruction combination pass.
13219 @item -fdump-rtl-compgotos
13220 @opindex fdump-rtl-compgotos
13221 Dump after duplicating the computed gotos.
13223 @item -fdump-rtl-ce1
13224 @itemx -fdump-rtl-ce2
13225 @itemx -fdump-rtl-ce3
13226 @opindex fdump-rtl-ce1
13227 @opindex fdump-rtl-ce2
13228 @opindex fdump-rtl-ce3
13229 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13230 @option{-fdump-rtl-ce3} enable dumping after the three
13231 if conversion passes.
13233 @item -fdump-rtl-cprop_hardreg
13234 @opindex fdump-rtl-cprop_hardreg
13235 Dump after hard register copy propagation.
13237 @item -fdump-rtl-csa
13238 @opindex fdump-rtl-csa
13239 Dump after combining stack adjustments.
13241 @item -fdump-rtl-cse1
13242 @itemx -fdump-rtl-cse2
13243 @opindex fdump-rtl-cse1
13244 @opindex fdump-rtl-cse2
13245 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13246 the two common subexpression elimination passes.
13248 @item -fdump-rtl-dce
13249 @opindex fdump-rtl-dce
13250 Dump after the standalone dead code elimination passes.
13252 @item -fdump-rtl-dbr
13253 @opindex fdump-rtl-dbr
13254 Dump after delayed branch scheduling.
13256 @item -fdump-rtl-dce1
13257 @itemx -fdump-rtl-dce2
13258 @opindex fdump-rtl-dce1
13259 @opindex fdump-rtl-dce2
13260 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13261 the two dead store elimination passes.
13263 @item -fdump-rtl-eh
13264 @opindex fdump-rtl-eh
13265 Dump after finalization of EH handling code.
13267 @item -fdump-rtl-eh_ranges
13268 @opindex fdump-rtl-eh_ranges
13269 Dump after conversion of EH handling range regions.
13271 @item -fdump-rtl-expand
13272 @opindex fdump-rtl-expand
13273 Dump after RTL generation.
13275 @item -fdump-rtl-fwprop1
13276 @itemx -fdump-rtl-fwprop2
13277 @opindex fdump-rtl-fwprop1
13278 @opindex fdump-rtl-fwprop2
13279 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13280 dumping after the two forward propagation passes.
13282 @item -fdump-rtl-gcse1
13283 @itemx -fdump-rtl-gcse2
13284 @opindex fdump-rtl-gcse1
13285 @opindex fdump-rtl-gcse2
13286 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13287 after global common subexpression elimination.
13289 @item -fdump-rtl-init-regs
13290 @opindex fdump-rtl-init-regs
13291 Dump after the initialization of the registers.
13293 @item -fdump-rtl-initvals
13294 @opindex fdump-rtl-initvals
13295 Dump after the computation of the initial value sets.
13297 @item -fdump-rtl-into_cfglayout
13298 @opindex fdump-rtl-into_cfglayout
13299 Dump after converting to cfglayout mode.
13301 @item -fdump-rtl-ira
13302 @opindex fdump-rtl-ira
13303 Dump after iterated register allocation.
13305 @item -fdump-rtl-jump
13306 @opindex fdump-rtl-jump
13307 Dump after the second jump optimization.
13309 @item -fdump-rtl-loop2
13310 @opindex fdump-rtl-loop2
13311 @option{-fdump-rtl-loop2} enables dumping after the rtl
13312 loop optimization passes.
13314 @item -fdump-rtl-mach
13315 @opindex fdump-rtl-mach
13316 Dump after performing the machine dependent reorganization pass, if that
13317 pass exists.
13319 @item -fdump-rtl-mode_sw
13320 @opindex fdump-rtl-mode_sw
13321 Dump after removing redundant mode switches.
13323 @item -fdump-rtl-rnreg
13324 @opindex fdump-rtl-rnreg
13325 Dump after register renumbering.
13327 @item -fdump-rtl-outof_cfglayout
13328 @opindex fdump-rtl-outof_cfglayout
13329 Dump after converting from cfglayout mode.
13331 @item -fdump-rtl-peephole2
13332 @opindex fdump-rtl-peephole2
13333 Dump after the peephole pass.
13335 @item -fdump-rtl-postreload
13336 @opindex fdump-rtl-postreload
13337 Dump after post-reload optimizations.
13339 @item -fdump-rtl-pro_and_epilogue
13340 @opindex fdump-rtl-pro_and_epilogue
13341 Dump after generating the function prologues and epilogues.
13343 @item -fdump-rtl-sched1
13344 @itemx -fdump-rtl-sched2
13345 @opindex fdump-rtl-sched1
13346 @opindex fdump-rtl-sched2
13347 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13348 after the basic block scheduling passes.
13350 @item -fdump-rtl-ree
13351 @opindex fdump-rtl-ree
13352 Dump after sign/zero extension elimination.
13354 @item -fdump-rtl-seqabstr
13355 @opindex fdump-rtl-seqabstr
13356 Dump after common sequence discovery.
13358 @item -fdump-rtl-shorten
13359 @opindex fdump-rtl-shorten
13360 Dump after shortening branches.
13362 @item -fdump-rtl-sibling
13363 @opindex fdump-rtl-sibling
13364 Dump after sibling call optimizations.
13366 @item -fdump-rtl-split1
13367 @itemx -fdump-rtl-split2
13368 @itemx -fdump-rtl-split3
13369 @itemx -fdump-rtl-split4
13370 @itemx -fdump-rtl-split5
13371 @opindex fdump-rtl-split1
13372 @opindex fdump-rtl-split2
13373 @opindex fdump-rtl-split3
13374 @opindex fdump-rtl-split4
13375 @opindex fdump-rtl-split5
13376 These options enable dumping after five rounds of
13377 instruction splitting.
13379 @item -fdump-rtl-sms
13380 @opindex fdump-rtl-sms
13381 Dump after modulo scheduling.  This pass is only run on some
13382 architectures.
13384 @item -fdump-rtl-stack
13385 @opindex fdump-rtl-stack
13386 Dump after conversion from GCC's ``flat register file'' registers to the
13387 x87's stack-like registers.  This pass is only run on x86 variants.
13389 @item -fdump-rtl-subreg1
13390 @itemx -fdump-rtl-subreg2
13391 @opindex fdump-rtl-subreg1
13392 @opindex fdump-rtl-subreg2
13393 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13394 the two subreg expansion passes.
13396 @item -fdump-rtl-unshare
13397 @opindex fdump-rtl-unshare
13398 Dump after all rtl has been unshared.
13400 @item -fdump-rtl-vartrack
13401 @opindex fdump-rtl-vartrack
13402 Dump after variable tracking.
13404 @item -fdump-rtl-vregs
13405 @opindex fdump-rtl-vregs
13406 Dump after converting virtual registers to hard registers.
13408 @item -fdump-rtl-web
13409 @opindex fdump-rtl-web
13410 Dump after live range splitting.
13412 @item -fdump-rtl-regclass
13413 @itemx -fdump-rtl-subregs_of_mode_init
13414 @itemx -fdump-rtl-subregs_of_mode_finish
13415 @itemx -fdump-rtl-dfinit
13416 @itemx -fdump-rtl-dfinish
13417 @opindex fdump-rtl-regclass
13418 @opindex fdump-rtl-subregs_of_mode_init
13419 @opindex fdump-rtl-subregs_of_mode_finish
13420 @opindex fdump-rtl-dfinit
13421 @opindex fdump-rtl-dfinish
13422 These dumps are defined but always produce empty files.
13424 @item -da
13425 @itemx -fdump-rtl-all
13426 @opindex da
13427 @opindex fdump-rtl-all
13428 Produce all the dumps listed above.
13430 @item -dA
13431 @opindex dA
13432 Annotate the assembler output with miscellaneous debugging information.
13434 @item -dD
13435 @opindex dD
13436 Dump all macro definitions, at the end of preprocessing, in addition to
13437 normal output.
13439 @item -dH
13440 @opindex dH
13441 Produce a core dump whenever an error occurs.
13443 @item -dp
13444 @opindex dp
13445 Annotate the assembler output with a comment indicating which
13446 pattern and alternative is used.  The length and cost of each instruction are
13447 also printed.
13449 @item -dP
13450 @opindex dP
13451 Dump the RTL in the assembler output as a comment before each instruction.
13452 Also turns on @option{-dp} annotation.
13454 @item -dx
13455 @opindex dx
13456 Just generate RTL for a function instead of compiling it.  Usually used
13457 with @option{-fdump-rtl-expand}.
13458 @end table
13460 @item -fdump-noaddr
13461 @opindex fdump-noaddr
13462 When doing debugging dumps, suppress address output.  This makes it more
13463 feasible to use diff on debugging dumps for compiler invocations with
13464 different compiler binaries and/or different
13465 text / bss / data / heap / stack / dso start locations.
13467 @item -freport-bug
13468 @opindex freport-bug
13469 Collect and dump debug information into a temporary file if an
13470 internal compiler error (ICE) occurs.
13472 @item -fdump-unnumbered
13473 @opindex fdump-unnumbered
13474 When doing debugging dumps, suppress instruction numbers and address output.
13475 This makes it more feasible to use diff on debugging dumps for compiler
13476 invocations with different options, in particular with and without
13477 @option{-g}.
13479 @item -fdump-unnumbered-links
13480 @opindex fdump-unnumbered-links
13481 When doing debugging dumps (see @option{-d} option above), suppress
13482 instruction numbers for the links to the previous and next instructions
13483 in a sequence.
13485 @item -fdump-ipa-@var{switch}
13486 @opindex fdump-ipa
13487 Control the dumping at various stages of inter-procedural analysis
13488 language tree to a file.  The file name is generated by appending a
13489 switch specific suffix to the source file name, and the file is created
13490 in the same directory as the output file.  The following dumps are
13491 possible:
13493 @table @samp
13494 @item all
13495 Enables all inter-procedural analysis dumps.
13497 @item cgraph
13498 Dumps information about call-graph optimization, unused function removal,
13499 and inlining decisions.
13501 @item inline
13502 Dump after function inlining.
13504 @end table
13506 @item -fdump-lang-all
13507 @itemx -fdump-lang-@var{switch}
13508 @itemx -fdump-lang-@var{switch}-@var{options}
13509 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13510 @opindex fdump-lang-all
13511 @opindex fdump-lang
13512 Control the dumping of language-specific information.  The @var{options}
13513 and @var{filename} portions behave as described in the
13514 @option{-fdump-tree} option.  The following @var{switch} values are
13515 accepted:
13517 @table @samp
13518 @item all
13520 Enable all language-specific dumps.
13522 @item class
13523 Dump class hierarchy information.  Virtual table information is emitted
13524 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13526 @item raw
13527 Dump the raw internal tree data.  This option is applicable to C++ only.
13529 @end table
13531 @item -fdump-passes
13532 @opindex fdump-passes
13533 Print on @file{stderr} the list of optimization passes that are turned
13534 on and off by the current command-line options.
13536 @item -fdump-statistics-@var{option}
13537 @opindex fdump-statistics
13538 Enable and control dumping of pass statistics in a separate file.  The
13539 file name is generated by appending a suffix ending in
13540 @samp{.statistics} to the source file name, and the file is created in
13541 the same directory as the output file.  If the @samp{-@var{option}}
13542 form is used, @samp{-stats} causes counters to be summed over the
13543 whole compilation unit while @samp{-details} dumps every event as
13544 the passes generate them.  The default with no option is to sum
13545 counters for each function compiled.
13547 @item -fdump-tree-all
13548 @itemx -fdump-tree-@var{switch}
13549 @itemx -fdump-tree-@var{switch}-@var{options}
13550 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13551 @opindex fdump-tree-all
13552 @opindex fdump-tree
13553 Control the dumping at various stages of processing the intermediate
13554 language tree to a file.  The file name is generated by appending a
13555 switch-specific suffix to the source file name, and the file is
13556 created in the same directory as the output file. In case of
13557 @option{=@var{filename}} option, the dump is output on the given file
13558 instead of the auto named dump files.  If the @samp{-@var{options}}
13559 form is used, @var{options} is a list of @samp{-} separated options
13560 which control the details of the dump.  Not all options are applicable
13561 to all dumps; those that are not meaningful are ignored.  The
13562 following options are available
13564 @table @samp
13565 @item address
13566 Print the address of each node.  Usually this is not meaningful as it
13567 changes according to the environment and source file.  Its primary use
13568 is for tying up a dump file with a debug environment.
13569 @item asmname
13570 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13571 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13572 use working backward from mangled names in the assembly file.
13573 @item slim
13574 When dumping front-end intermediate representations, inhibit dumping
13575 of members of a scope or body of a function merely because that scope
13576 has been reached.  Only dump such items when they are directly reachable
13577 by some other path.
13579 When dumping pretty-printed trees, this option inhibits dumping the
13580 bodies of control structures.
13582 When dumping RTL, print the RTL in slim (condensed) form instead of
13583 the default LISP-like representation.
13584 @item raw
13585 Print a raw representation of the tree.  By default, trees are
13586 pretty-printed into a C-like representation.
13587 @item details
13588 Enable more detailed dumps (not honored by every dump option). Also
13589 include information from the optimization passes.
13590 @item stats
13591 Enable dumping various statistics about the pass (not honored by every dump
13592 option).
13593 @item blocks
13594 Enable showing basic block boundaries (disabled in raw dumps).
13595 @item graph
13596 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13597 dump a representation of the control flow graph suitable for viewing with
13598 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13599 the file is pretty-printed as a subgraph, so that GraphViz can render them
13600 all in a single plot.
13602 This option currently only works for RTL dumps, and the RTL is always
13603 dumped in slim form.
13604 @item vops
13605 Enable showing virtual operands for every statement.
13606 @item lineno
13607 Enable showing line numbers for statements.
13608 @item uid
13609 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13610 @item verbose
13611 Enable showing the tree dump for each statement.
13612 @item eh
13613 Enable showing the EH region number holding each statement.
13614 @item scev
13615 Enable showing scalar evolution analysis details.
13616 @item optimized
13617 Enable showing optimization information (only available in certain
13618 passes).
13619 @item missed
13620 Enable showing missed optimization information (only available in certain
13621 passes).
13622 @item note
13623 Enable other detailed optimization information (only available in
13624 certain passes).
13625 @item =@var{filename}
13626 Instead of an auto named dump file, output into the given file
13627 name. The file names @file{stdout} and @file{stderr} are treated
13628 specially and are considered already open standard streams. For
13629 example,
13631 @smallexample
13632 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13633      -fdump-tree-pre=/dev/stderr file.c
13634 @end smallexample
13636 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13637 output on to @file{stderr}. If two conflicting dump filenames are
13638 given for the same pass, then the latter option overrides the earlier
13639 one.
13641 @item all
13642 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13643 and @option{lineno}.
13645 @item optall
13646 Turn on all optimization options, i.e., @option{optimized},
13647 @option{missed}, and @option{note}.
13648 @end table
13650 To determine what tree dumps are available or find the dump for a pass
13651 of interest follow the steps below.
13653 @enumerate
13654 @item
13655 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13656 look for a code that corresponds to the pass you are interested in.
13657 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13658 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13659 The number at the end distinguishes distinct invocations of the same pass.
13660 @item
13661 To enable the creation of the dump file, append the pass code to
13662 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13663 to enable the dump from the Early Value Range Propagation pass, invoke
13664 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13665 specify the name of the dump file.  If you don't specify one, GCC
13666 creates as described below.
13667 @item
13668 Find the pass dump in a file whose name is composed of three components
13669 separated by a period: the name of the source file GCC was invoked to
13670 compile, a numeric suffix indicating the pass number followed by the
13671 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13672 and finally the pass code.  For example, the Early VRP pass dump might
13673 be in a file named @file{myfile.c.038t.evrp} in the current working
13674 directory.  Note that the numeric codes are not stable and may change
13675 from one version of GCC to another.
13676 @end enumerate
13678 @item -fopt-info
13679 @itemx -fopt-info-@var{options}
13680 @itemx -fopt-info-@var{options}=@var{filename}
13681 @opindex fopt-info
13682 Controls optimization dumps from various optimization passes. If the
13683 @samp{-@var{options}} form is used, @var{options} is a list of
13684 @samp{-} separated option keywords to select the dump details and
13685 optimizations.  
13687 The @var{options} can be divided into two groups: options describing the
13688 verbosity of the dump, and options describing which optimizations
13689 should be included. The options from both the groups can be freely
13690 mixed as they are non-overlapping. However, in case of any conflicts,
13691 the later options override the earlier options on the command
13692 line. 
13694 The following options control the dump verbosity:
13696 @table @samp
13697 @item optimized
13698 Print information when an optimization is successfully applied. It is
13699 up to a pass to decide which information is relevant. For example, the
13700 vectorizer passes print the source location of loops which are
13701 successfully vectorized.
13702 @item missed
13703 Print information about missed optimizations. Individual passes
13704 control which information to include in the output. 
13705 @item note
13706 Print verbose information about optimizations, such as certain
13707 transformations, more detailed messages about decisions etc.
13708 @item all
13709 Print detailed optimization information. This includes
13710 @samp{optimized}, @samp{missed}, and @samp{note}.
13711 @end table
13713 One or more of the following option keywords can be used to describe a
13714 group of optimizations:
13716 @table @samp
13717 @item ipa
13718 Enable dumps from all interprocedural optimizations.
13719 @item loop
13720 Enable dumps from all loop optimizations.
13721 @item inline
13722 Enable dumps from all inlining optimizations.
13723 @item omp
13724 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13725 @item vec
13726 Enable dumps from all vectorization optimizations.
13727 @item optall
13728 Enable dumps from all optimizations. This is a superset of
13729 the optimization groups listed above.
13730 @end table
13732 If @var{options} is
13733 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13734 info about successful optimizations from all the passes.  
13736 If the @var{filename} is provided, then the dumps from all the
13737 applicable optimizations are concatenated into the @var{filename}.
13738 Otherwise the dump is output onto @file{stderr}. Though multiple
13739 @option{-fopt-info} options are accepted, only one of them can include
13740 a @var{filename}. If other filenames are provided then all but the
13741 first such option are ignored.
13743 Note that the output @var{filename} is overwritten
13744 in case of multiple translation units. If a combined output from
13745 multiple translation units is desired, @file{stderr} should be used
13746 instead.
13748 In the following example, the optimization info is output to
13749 @file{stderr}:
13751 @smallexample
13752 gcc -O3 -fopt-info
13753 @end smallexample
13755 This example:
13756 @smallexample
13757 gcc -O3 -fopt-info-missed=missed.all
13758 @end smallexample
13760 @noindent
13761 outputs missed optimization report from all the passes into
13762 @file{missed.all}, and this one:
13764 @smallexample
13765 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13766 @end smallexample
13768 @noindent
13769 prints information about missed optimization opportunities from
13770 vectorization passes on @file{stderr}.  
13771 Note that @option{-fopt-info-vec-missed} is equivalent to 
13772 @option{-fopt-info-missed-vec}.  The order of the optimization group
13773 names and message types listed after @option{-fopt-info} does not matter.
13775 As another example,
13776 @smallexample
13777 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13778 @end smallexample
13780 @noindent
13781 outputs information about missed optimizations as well as
13782 optimized locations from all the inlining passes into
13783 @file{inline.txt}.
13785 Finally, consider:
13787 @smallexample
13788 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13789 @end smallexample
13791 @noindent
13792 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13793 in conflict since only one output file is allowed. In this case, only
13794 the first option takes effect and the subsequent options are
13795 ignored. Thus only @file{vec.miss} is produced which contains
13796 dumps from the vectorizer about missed opportunities.
13798 @item -fsched-verbose=@var{n}
13799 @opindex fsched-verbose
13800 On targets that use instruction scheduling, this option controls the
13801 amount of debugging output the scheduler prints to the dump files.
13803 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13804 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13805 For @var{n} greater than one, it also output basic block probabilities,
13806 detailed ready list information and unit/insn info.  For @var{n} greater
13807 than two, it includes RTL at abort point, control-flow and regions info.
13808 And for @var{n} over four, @option{-fsched-verbose} also includes
13809 dependence info.
13813 @item -fenable-@var{kind}-@var{pass}
13814 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13815 @opindex fdisable-
13816 @opindex fenable-
13818 This is a set of options that are used to explicitly disable/enable
13819 optimization passes.  These options are intended for use for debugging GCC.
13820 Compiler users should use regular options for enabling/disabling
13821 passes instead.
13823 @table @gcctabopt
13825 @item -fdisable-ipa-@var{pass}
13826 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13827 statically invoked in the compiler multiple times, the pass name should be
13828 appended with a sequential number starting from 1.
13830 @item -fdisable-rtl-@var{pass}
13831 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13832 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13833 statically invoked in the compiler multiple times, the pass name should be
13834 appended with a sequential number starting from 1.  @var{range-list} is a 
13835 comma-separated list of function ranges or assembler names.  Each range is a number
13836 pair separated by a colon.  The range is inclusive in both ends.  If the range
13837 is trivial, the number pair can be simplified as a single number.  If the
13838 function's call graph node's @var{uid} falls within one of the specified ranges,
13839 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13840 function header of a dump file, and the pass names can be dumped by using
13841 option @option{-fdump-passes}.
13843 @item -fdisable-tree-@var{pass}
13844 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13845 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13846 option arguments.
13848 @item -fenable-ipa-@var{pass}
13849 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13850 statically invoked in the compiler multiple times, the pass name should be
13851 appended with a sequential number starting from 1.
13853 @item -fenable-rtl-@var{pass}
13854 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13855 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13856 description and examples.
13858 @item -fenable-tree-@var{pass}
13859 @itemx -fenable-tree-@var{pass}=@var{range-list}
13860 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13861 of option arguments.
13863 @end table
13865 Here are some examples showing uses of these options.
13867 @smallexample
13869 # disable ccp1 for all functions
13870    -fdisable-tree-ccp1
13871 # disable complete unroll for function whose cgraph node uid is 1
13872    -fenable-tree-cunroll=1
13873 # disable gcse2 for functions at the following ranges [1,1],
13874 # [300,400], and [400,1000]
13875 # disable gcse2 for functions foo and foo2
13876    -fdisable-rtl-gcse2=foo,foo2
13877 # disable early inlining
13878    -fdisable-tree-einline
13879 # disable ipa inlining
13880    -fdisable-ipa-inline
13881 # enable tree full unroll
13882    -fenable-tree-unroll
13884 @end smallexample
13886 @item -fchecking
13887 @itemx -fchecking=@var{n}
13888 @opindex fchecking
13889 @opindex fno-checking
13890 Enable internal consistency checking.  The default depends on
13891 the compiler configuration.  @option{-fchecking=2} enables further
13892 internal consistency checking that might affect code generation.
13894 @item -frandom-seed=@var{string}
13895 @opindex frandom-seed
13896 This option provides a seed that GCC uses in place of
13897 random numbers in generating certain symbol names
13898 that have to be different in every compiled file.  It is also used to
13899 place unique stamps in coverage data files and the object files that
13900 produce them.  You can use the @option{-frandom-seed} option to produce
13901 reproducibly identical object files.
13903 The @var{string} can either be a number (decimal, octal or hex) or an
13904 arbitrary string (in which case it's converted to a number by
13905 computing CRC32).
13907 The @var{string} should be different for every file you compile.
13909 @item -save-temps
13910 @itemx -save-temps=cwd
13911 @opindex save-temps
13912 Store the usual ``temporary'' intermediate files permanently; place them
13913 in the current directory and name them based on the source file.  Thus,
13914 compiling @file{foo.c} with @option{-c -save-temps} produces files
13915 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13916 preprocessed @file{foo.i} output file even though the compiler now
13917 normally uses an integrated preprocessor.
13919 When used in combination with the @option{-x} command-line option,
13920 @option{-save-temps} is sensible enough to avoid over writing an
13921 input source file with the same extension as an intermediate file.
13922 The corresponding intermediate file may be obtained by renaming the
13923 source file before using @option{-save-temps}.
13925 If you invoke GCC in parallel, compiling several different source
13926 files that share a common base name in different subdirectories or the
13927 same source file compiled for multiple output destinations, it is
13928 likely that the different parallel compilers will interfere with each
13929 other, and overwrite the temporary files.  For instance:
13931 @smallexample
13932 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13933 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13934 @end smallexample
13936 may result in @file{foo.i} and @file{foo.o} being written to
13937 simultaneously by both compilers.
13939 @item -save-temps=obj
13940 @opindex save-temps=obj
13941 Store the usual ``temporary'' intermediate files permanently.  If the
13942 @option{-o} option is used, the temporary files are based on the
13943 object file.  If the @option{-o} option is not used, the
13944 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13946 For example:
13948 @smallexample
13949 gcc -save-temps=obj -c foo.c
13950 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13951 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13952 @end smallexample
13954 @noindent
13955 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13956 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13957 @file{dir2/yfoobar.o}.
13959 @item -time@r{[}=@var{file}@r{]}
13960 @opindex time
13961 Report the CPU time taken by each subprocess in the compilation
13962 sequence.  For C source files, this is the compiler proper and assembler
13963 (plus the linker if linking is done).
13965 Without the specification of an output file, the output looks like this:
13967 @smallexample
13968 # cc1 0.12 0.01
13969 # as 0.00 0.01
13970 @end smallexample
13972 The first number on each line is the ``user time'', that is time spent
13973 executing the program itself.  The second number is ``system time'',
13974 time spent executing operating system routines on behalf of the program.
13975 Both numbers are in seconds.
13977 With the specification of an output file, the output is appended to the
13978 named file, and it looks like this:
13980 @smallexample
13981 0.12 0.01 cc1 @var{options}
13982 0.00 0.01 as @var{options}
13983 @end smallexample
13985 The ``user time'' and the ``system time'' are moved before the program
13986 name, and the options passed to the program are displayed, so that one
13987 can later tell what file was being compiled, and with which options.
13989 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13990 @opindex fdump-final-insns
13991 Dump the final internal representation (RTL) to @var{file}.  If the
13992 optional argument is omitted (or if @var{file} is @code{.}), the name
13993 of the dump file is determined by appending @code{.gkd} to the
13994 compilation output file name.
13996 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13997 @opindex fcompare-debug
13998 @opindex fno-compare-debug
13999 If no error occurs during compilation, run the compiler a second time,
14000 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14001 passed to the second compilation.  Dump the final internal
14002 representation in both compilations, and print an error if they differ.
14004 If the equal sign is omitted, the default @option{-gtoggle} is used.
14006 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14007 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14008 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14009 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14010 is used.
14012 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14013 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14014 of the final representation and the second compilation, preventing even
14015 @env{GCC_COMPARE_DEBUG} from taking effect.
14017 To verify full coverage during @option{-fcompare-debug} testing, set
14018 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14019 which GCC rejects as an invalid option in any actual compilation
14020 (rather than preprocessing, assembly or linking).  To get just a
14021 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14022 not overridden} will do.
14024 @item -fcompare-debug-second
14025 @opindex fcompare-debug-second
14026 This option is implicitly passed to the compiler for the second
14027 compilation requested by @option{-fcompare-debug}, along with options to
14028 silence warnings, and omitting other options that would cause
14029 side-effect compiler outputs to files or to the standard output.  Dump
14030 files and preserved temporary files are renamed so as to contain the
14031 @code{.gk} additional extension during the second compilation, to avoid
14032 overwriting those generated by the first.
14034 When this option is passed to the compiler driver, it causes the
14035 @emph{first} compilation to be skipped, which makes it useful for little
14036 other than debugging the compiler proper.
14038 @item -gtoggle
14039 @opindex gtoggle
14040 Turn off generation of debug info, if leaving out this option
14041 generates it, or turn it on at level 2 otherwise.  The position of this
14042 argument in the command line does not matter; it takes effect after all
14043 other options are processed, and it does so only once, no matter how
14044 many times it is given.  This is mainly intended to be used with
14045 @option{-fcompare-debug}.
14047 @item -fvar-tracking-assignments-toggle
14048 @opindex fvar-tracking-assignments-toggle
14049 @opindex fno-var-tracking-assignments-toggle
14050 Toggle @option{-fvar-tracking-assignments}, in the same way that
14051 @option{-gtoggle} toggles @option{-g}.
14053 @item -Q
14054 @opindex Q
14055 Makes the compiler print out each function name as it is compiled, and
14056 print some statistics about each pass when it finishes.
14058 @item -ftime-report
14059 @opindex ftime-report
14060 Makes the compiler print some statistics about the time consumed by each
14061 pass when it finishes.
14063 @item -ftime-report-details
14064 @opindex ftime-report-details
14065 Record the time consumed by infrastructure parts separately for each pass.
14067 @item -fira-verbose=@var{n}
14068 @opindex fira-verbose
14069 Control the verbosity of the dump file for the integrated register allocator.
14070 The default value is 5.  If the value @var{n} is greater or equal to 10,
14071 the dump output is sent to stderr using the same format as @var{n} minus 10.
14073 @item -flto-report
14074 @opindex flto-report
14075 Prints a report with internal details on the workings of the link-time
14076 optimizer.  The contents of this report vary from version to version.
14077 It is meant to be useful to GCC developers when processing object
14078 files in LTO mode (via @option{-flto}).
14080 Disabled by default.
14082 @item -flto-report-wpa
14083 @opindex flto-report-wpa
14084 Like @option{-flto-report}, but only print for the WPA phase of Link
14085 Time Optimization.
14087 @item -fmem-report
14088 @opindex fmem-report
14089 Makes the compiler print some statistics about permanent memory
14090 allocation when it finishes.
14092 @item -fmem-report-wpa
14093 @opindex fmem-report-wpa
14094 Makes the compiler print some statistics about permanent memory
14095 allocation for the WPA phase only.
14097 @item -fpre-ipa-mem-report
14098 @opindex fpre-ipa-mem-report
14099 @item -fpost-ipa-mem-report
14100 @opindex fpost-ipa-mem-report
14101 Makes the compiler print some statistics about permanent memory
14102 allocation before or after interprocedural optimization.
14104 @item -fprofile-report
14105 @opindex fprofile-report
14106 Makes the compiler print some statistics about consistency of the
14107 (estimated) profile and effect of individual passes.
14109 @item -fstack-usage
14110 @opindex fstack-usage
14111 Makes the compiler output stack usage information for the program, on a
14112 per-function basis.  The filename for the dump is made by appending
14113 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14114 the output file, if explicitly specified and it is not an executable,
14115 otherwise it is the basename of the source file.  An entry is made up
14116 of three fields:
14118 @itemize
14119 @item
14120 The name of the function.
14121 @item
14122 A number of bytes.
14123 @item
14124 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14125 @end itemize
14127 The qualifier @code{static} means that the function manipulates the stack
14128 statically: a fixed number of bytes are allocated for the frame on function
14129 entry and released on function exit; no stack adjustments are otherwise made
14130 in the function.  The second field is this fixed number of bytes.
14132 The qualifier @code{dynamic} means that the function manipulates the stack
14133 dynamically: in addition to the static allocation described above, stack
14134 adjustments are made in the body of the function, for example to push/pop
14135 arguments around function calls.  If the qualifier @code{bounded} is also
14136 present, the amount of these adjustments is bounded at compile time and
14137 the second field is an upper bound of the total amount of stack used by
14138 the function.  If it is not present, the amount of these adjustments is
14139 not bounded at compile time and the second field only represents the
14140 bounded part.
14142 @item -fstats
14143 @opindex fstats
14144 Emit statistics about front-end processing at the end of the compilation.
14145 This option is supported only by the C++ front end, and
14146 the information is generally only useful to the G++ development team.
14148 @item -fdbg-cnt-list
14149 @opindex fdbg-cnt-list
14150 Print the name and the counter upper bound for all debug counters.
14153 @item -fdbg-cnt=@var{counter-value-list}
14154 @opindex fdbg-cnt
14155 Set the internal debug counter upper bound.  @var{counter-value-list}
14156 is a comma-separated list of @var{name}:@var{value} pairs
14157 which sets the upper bound of each debug counter @var{name} to @var{value}.
14158 All debug counters have the initial upper bound of @code{UINT_MAX};
14159 thus @code{dbg_cnt} returns true always unless the upper bound
14160 is set by this option.
14161 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
14162 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
14164 @item -print-file-name=@var{library}
14165 @opindex print-file-name
14166 Print the full absolute name of the library file @var{library} that
14167 would be used when linking---and don't do anything else.  With this
14168 option, GCC does not compile or link anything; it just prints the
14169 file name.
14171 @item -print-multi-directory
14172 @opindex print-multi-directory
14173 Print the directory name corresponding to the multilib selected by any
14174 other switches present in the command line.  This directory is supposed
14175 to exist in @env{GCC_EXEC_PREFIX}.
14177 @item -print-multi-lib
14178 @opindex print-multi-lib
14179 Print the mapping from multilib directory names to compiler switches
14180 that enable them.  The directory name is separated from the switches by
14181 @samp{;}, and each switch starts with an @samp{@@} instead of the
14182 @samp{-}, without spaces between multiple switches.  This is supposed to
14183 ease shell processing.
14185 @item -print-multi-os-directory
14186 @opindex print-multi-os-directory
14187 Print the path to OS libraries for the selected
14188 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14189 present in the @file{lib} subdirectory and no multilibs are used, this is
14190 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14191 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14192 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14193 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14195 @item -print-multiarch
14196 @opindex print-multiarch
14197 Print the path to OS libraries for the selected multiarch,
14198 relative to some @file{lib} subdirectory.
14200 @item -print-prog-name=@var{program}
14201 @opindex print-prog-name
14202 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14204 @item -print-libgcc-file-name
14205 @opindex print-libgcc-file-name
14206 Same as @option{-print-file-name=libgcc.a}.
14208 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14209 but you do want to link with @file{libgcc.a}.  You can do:
14211 @smallexample
14212 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14213 @end smallexample
14215 @item -print-search-dirs
14216 @opindex print-search-dirs
14217 Print the name of the configured installation directory and a list of
14218 program and library directories @command{gcc} searches---and don't do anything else.
14220 This is useful when @command{gcc} prints the error message
14221 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14222 To resolve this you either need to put @file{cpp0} and the other compiler
14223 components where @command{gcc} expects to find them, or you can set the environment
14224 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14225 Don't forget the trailing @samp{/}.
14226 @xref{Environment Variables}.
14228 @item -print-sysroot
14229 @opindex print-sysroot
14230 Print the target sysroot directory that is used during
14231 compilation.  This is the target sysroot specified either at configure
14232 time or using the @option{--sysroot} option, possibly with an extra
14233 suffix that depends on compilation options.  If no target sysroot is
14234 specified, the option prints nothing.
14236 @item -print-sysroot-headers-suffix
14237 @opindex print-sysroot-headers-suffix
14238 Print the suffix added to the target sysroot when searching for
14239 headers, or give an error if the compiler is not configured with such
14240 a suffix---and don't do anything else.
14242 @item -dumpmachine
14243 @opindex dumpmachine
14244 Print the compiler's target machine (for example,
14245 @samp{i686-pc-linux-gnu})---and don't do anything else.
14247 @item -dumpversion
14248 @opindex dumpversion
14249 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14250 anything else.  This is the compiler version used in filesystem paths,
14251 specs, can be depending on how the compiler has been configured just
14252 a single number (major version), two numbers separated by dot (major and
14253 minor version) or three numbers separated by dots (major, minor and patchlevel
14254 version).
14256 @item -dumpfullversion
14257 @opindex dumpfullversion
14258 Print the full compiler version, always 3 numbers separated by dots,
14259 major, minor and patchlevel version.
14261 @item -dumpspecs
14262 @opindex dumpspecs
14263 Print the compiler's built-in specs---and don't do anything else.  (This
14264 is used when GCC itself is being built.)  @xref{Spec Files}.
14265 @end table
14267 @node Submodel Options
14268 @section Machine-Dependent Options
14269 @cindex submodel options
14270 @cindex specifying hardware config
14271 @cindex hardware models and configurations, specifying
14272 @cindex target-dependent options
14273 @cindex machine-dependent options
14275 Each target machine supported by GCC can have its own options---for
14276 example, to allow you to compile for a particular processor variant or
14277 ABI, or to control optimizations specific to that machine.  By
14278 convention, the names of machine-specific options start with
14279 @samp{-m}.
14281 Some configurations of the compiler also support additional target-specific
14282 options, usually for compatibility with other compilers on the same
14283 platform.
14285 @c This list is ordered alphanumerically by subsection name.
14286 @c It should be the same order and spelling as these options are listed
14287 @c in Machine Dependent Options
14289 @menu
14290 * AArch64 Options::
14291 * Adapteva Epiphany Options::
14292 * ARC Options::
14293 * ARM Options::
14294 * AVR Options::
14295 * Blackfin Options::
14296 * C6X Options::
14297 * CRIS Options::
14298 * CR16 Options::
14299 * Darwin Options::
14300 * DEC Alpha Options::
14301 * FR30 Options::
14302 * FT32 Options::
14303 * FRV Options::
14304 * GNU/Linux Options::
14305 * H8/300 Options::
14306 * HPPA Options::
14307 * IA-64 Options::
14308 * LM32 Options::
14309 * M32C Options::
14310 * M32R/D Options::
14311 * M680x0 Options::
14312 * MCore Options::
14313 * MeP Options::
14314 * MicroBlaze Options::
14315 * MIPS Options::
14316 * MMIX Options::
14317 * MN10300 Options::
14318 * Moxie Options::
14319 * MSP430 Options::
14320 * NDS32 Options::
14321 * Nios II Options::
14322 * Nvidia PTX Options::
14323 * PDP-11 Options::
14324 * picoChip Options::
14325 * PowerPC Options::
14326 * RISC-V Options::
14327 * RL78 Options::
14328 * RS/6000 and PowerPC Options::
14329 * RX Options::
14330 * S/390 and zSeries Options::
14331 * Score Options::
14332 * SH Options::
14333 * Solaris 2 Options::
14334 * SPARC Options::
14335 * SPU Options::
14336 * System V Options::
14337 * TILE-Gx Options::
14338 * TILEPro Options::
14339 * V850 Options::
14340 * VAX Options::
14341 * Visium Options::
14342 * VMS Options::
14343 * VxWorks Options::
14344 * x86 Options::
14345 * x86 Windows Options::
14346 * Xstormy16 Options::
14347 * Xtensa Options::
14348 * zSeries Options::
14349 @end menu
14351 @node AArch64 Options
14352 @subsection AArch64 Options
14353 @cindex AArch64 Options
14355 These options are defined for AArch64 implementations:
14357 @table @gcctabopt
14359 @item -mabi=@var{name}
14360 @opindex mabi
14361 Generate code for the specified data model.  Permissible values
14362 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14363 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14364 but long int and pointers are 64 bits.
14366 The default depends on the specific target configuration.  Note that
14367 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14368 entire program with the same ABI, and link with a compatible set of libraries.
14370 @item -mbig-endian
14371 @opindex mbig-endian
14372 Generate big-endian code.  This is the default when GCC is configured for an
14373 @samp{aarch64_be-*-*} target.
14375 @item -mgeneral-regs-only
14376 @opindex mgeneral-regs-only
14377 Generate code which uses only the general-purpose registers.  This will prevent
14378 the compiler from using floating-point and Advanced SIMD registers but will not
14379 impose any restrictions on the assembler.
14381 @item -mlittle-endian
14382 @opindex mlittle-endian
14383 Generate little-endian code.  This is the default when GCC is configured for an
14384 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14386 @item -mcmodel=tiny
14387 @opindex mcmodel=tiny
14388 Generate code for the tiny code model.  The program and its statically defined
14389 symbols must be within 1MB of each other.  Programs can be statically or
14390 dynamically linked.
14392 @item -mcmodel=small
14393 @opindex mcmodel=small
14394 Generate code for the small code model.  The program and its statically defined
14395 symbols must be within 4GB of each other.  Programs can be statically or
14396 dynamically linked.  This is the default code model.
14398 @item -mcmodel=large
14399 @opindex mcmodel=large
14400 Generate code for the large code model.  This makes no assumptions about
14401 addresses and sizes of sections.  Programs can be statically linked only.
14403 @item -mstrict-align
14404 @opindex mstrict-align
14405 Avoid generating memory accesses that may not be aligned on a natural object
14406 boundary as described in the architecture specification.
14408 @item -momit-leaf-frame-pointer
14409 @itemx -mno-omit-leaf-frame-pointer
14410 @opindex momit-leaf-frame-pointer
14411 @opindex mno-omit-leaf-frame-pointer
14412 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14413 default.
14415 @item -mtls-dialect=desc
14416 @opindex mtls-dialect=desc
14417 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14418 of TLS variables.  This is the default.
14420 @item -mtls-dialect=traditional
14421 @opindex mtls-dialect=traditional
14422 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14423 of TLS variables.
14425 @item -mtls-size=@var{size}
14426 @opindex mtls-size
14427 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14428 This option requires binutils 2.26 or newer.
14430 @item -mfix-cortex-a53-835769
14431 @itemx -mno-fix-cortex-a53-835769
14432 @opindex mfix-cortex-a53-835769
14433 @opindex mno-fix-cortex-a53-835769
14434 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14435 This involves inserting a NOP instruction between memory instructions and
14436 64-bit integer multiply-accumulate instructions.
14438 @item -mfix-cortex-a53-843419
14439 @itemx -mno-fix-cortex-a53-843419
14440 @opindex mfix-cortex-a53-843419
14441 @opindex mno-fix-cortex-a53-843419
14442 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14443 This erratum workaround is made at link time and this will only pass the
14444 corresponding flag to the linker.
14446 @item -mlow-precision-recip-sqrt
14447 @item -mno-low-precision-recip-sqrt
14448 @opindex mlow-precision-recip-sqrt
14449 @opindex mno-low-precision-recip-sqrt
14450 Enable or disable the reciprocal square root approximation.
14451 This option only has an effect if @option{-ffast-math} or
14452 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14453 precision of reciprocal square root results to about 16 bits for
14454 single precision and to 32 bits for double precision.
14456 @item -mlow-precision-sqrt
14457 @item -mno-low-precision-sqrt
14458 @opindex -mlow-precision-sqrt
14459 @opindex -mno-low-precision-sqrt
14460 Enable or disable the square root approximation.
14461 This option only has an effect if @option{-ffast-math} or
14462 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14463 precision of square root results to about 16 bits for
14464 single precision and to 32 bits for double precision.
14465 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14467 @item -mlow-precision-div
14468 @item -mno-low-precision-div
14469 @opindex -mlow-precision-div
14470 @opindex -mno-low-precision-div
14471 Enable or disable the division approximation.
14472 This option only has an effect if @option{-ffast-math} or
14473 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14474 precision of division results to about 16 bits for
14475 single precision and to 32 bits for double precision.
14477 @item -march=@var{name}
14478 @opindex march
14479 Specify the name of the target architecture and, optionally, one or
14480 more feature modifiers.  This option has the form
14481 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14483 The permissible values for @var{arch} are @samp{armv8-a},
14484 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @samp{armv8.4-a}
14485 or @var{native}.
14487 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
14488 support for the ARMv8.4-A architecture extensions.
14490 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14491 support for the ARMv8.3-A architecture extensions.
14493 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14494 support for the ARMv8.2-A architecture extensions.
14496 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14497 support for the ARMv8.1-A architecture extension.  In particular, it
14498 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14500 The value @samp{native} is available on native AArch64 GNU/Linux and
14501 causes the compiler to pick the architecture of the host system.  This
14502 option has no effect if the compiler is unable to recognize the
14503 architecture of the host system,
14505 The permissible values for @var{feature} are listed in the sub-section
14506 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14507 Feature Modifiers}.  Where conflicting feature modifiers are
14508 specified, the right-most feature is used.
14510 GCC uses @var{name} to determine what kind of instructions it can emit
14511 when generating assembly code.  If @option{-march} is specified
14512 without either of @option{-mtune} or @option{-mcpu} also being
14513 specified, the code is tuned to perform well across a range of target
14514 processors implementing the target architecture.
14516 @item -mtune=@var{name}
14517 @opindex mtune
14518 Specify the name of the target processor for which GCC should tune the
14519 performance of the code.  Permissible values for this option are:
14520 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14521 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14522 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14523 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14524 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14525 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14526 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14527 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14528 @samp{native}.
14530 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14531 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14532 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14533 big.LITTLE system.
14535 Additionally on native AArch64 GNU/Linux systems the value
14536 @samp{native} tunes performance to the host system.  This option has no effect
14537 if the compiler is unable to recognize the processor of the host system.
14539 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14540 are specified, the code is tuned to perform well across a range
14541 of target processors.
14543 This option cannot be suffixed by feature modifiers.
14545 @item -mcpu=@var{name}
14546 @opindex mcpu
14547 Specify the name of the target processor, optionally suffixed by one
14548 or more feature modifiers.  This option has the form
14549 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14550 the permissible values for @var{cpu} are the same as those available
14551 for @option{-mtune}.  The permissible values for @var{feature} are
14552 documented in the sub-section on
14553 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14554 Feature Modifiers}.  Where conflicting feature modifiers are
14555 specified, the right-most feature is used.
14557 GCC uses @var{name} to determine what kind of instructions it can emit when
14558 generating assembly code (as if by @option{-march}) and to determine
14559 the target processor for which to tune for performance (as if
14560 by @option{-mtune}).  Where this option is used in conjunction
14561 with @option{-march} or @option{-mtune}, those options take precedence
14562 over the appropriate part of this option.
14564 @item -moverride=@var{string}
14565 @opindex moverride
14566 Override tuning decisions made by the back-end in response to a
14567 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14568 for @var{string} in this option are not guaranteed to be consistent
14569 across releases.
14571 This option is only intended to be useful when developing GCC.
14573 @item -mverbose-cost-dump
14574 @opindex mverbose-cost-dump
14575 Enable verbose cost model dumping in the debug dump files.  This option is
14576 provided for use in debugging the compiler.
14578 @item -mpc-relative-literal-loads
14579 @itemx -mno-pc-relative-literal-loads
14580 @opindex mpc-relative-literal-loads
14581 @opindex mno-pc-relative-literal-loads
14582 Enable or disable PC-relative literal loads.  With this option literal pools are
14583 accessed using a single instruction and emitted after each function.  This
14584 limits the maximum size of functions to 1MB.  This is enabled by default for
14585 @option{-mcmodel=tiny}.
14587 @item -msign-return-address=@var{scope}
14588 @opindex msign-return-address
14589 Select the function scope on which return address signing will be applied.
14590 Permissible values are @samp{none}, which disables return address signing,
14591 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14592 functions, and @samp{all}, which enables pointer signing for all functions.  The
14593 default value is @samp{none}.
14595 @end table
14597 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14598 @anchor{aarch64-feature-modifiers}
14599 @cindex @option{-march} feature modifiers
14600 @cindex @option{-mcpu} feature modifiers
14601 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14602 the following and their inverses @option{no@var{feature}}:
14604 @table @samp
14605 @item crc
14606 Enable CRC extension.  This is on by default for
14607 @option{-march=armv8.1-a}.
14608 @item crypto
14609 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14610 instructions.
14611 @item fp
14612 Enable floating-point instructions.  This is on by default for all possible
14613 values for options @option{-march} and @option{-mcpu}.
14614 @item simd
14615 Enable Advanced SIMD instructions.  This also enables floating-point
14616 instructions.  This is on by default for all possible values for options
14617 @option{-march} and @option{-mcpu}.
14618 @item lse
14619 Enable Large System Extension instructions.  This is on by default for
14620 @option{-march=armv8.1-a}.
14621 @item rdma
14622 Enable Round Double Multiply Accumulate instructions.  This is on by default
14623 for @option{-march=armv8.1-a}.
14624 @item fp16
14625 Enable FP16 extension.  This also enables floating-point instructions.
14626 @item fp16fml
14627 Enable FP16 fmla extension.  This also enables FP16 extensions and
14628 floating-point instructions. This option is enabled by default for @option{-march=armv8.4-a}. Use of this option with architectures prior to Armv8.2-A is not supported.
14630 @item rcpc
14631 Enable the RcPc extension.  This does not change code generation from GCC,
14632 but is passed on to the assembler, enabling inline asm statements to use
14633 instructions from the RcPc extension.
14634 @item dotprod
14635 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14636 @item aes
14637 Enable the Armv8-a aes and pmull crypto extension.  This also enables Advanced
14638 SIMD instructions.
14639 @item sha2
14640 Enable the Armv8-a sha2 crypto extension.  This also enables Advanced SIMD instructions.
14641 @item sha3
14642 Enable the sha512 and sha3 crypto extension.  This also enables Advanced SIMD
14643 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
14644 @item sm4
14645 Enable the sm3 and sm4 crypto extension.  This also enables Advanced SIMD instructions.
14646 Use of this option with architectures prior to Armv8.2-A is not supported.
14648 @end table
14650 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
14651 which implies @option{fp}.
14652 Conversely, @option{nofp} implies @option{nosimd}, which implies
14653 @option{nocrypto}, @option{noaes} and @option{nosha2}.
14655 @node Adapteva Epiphany Options
14656 @subsection Adapteva Epiphany Options
14658 These @samp{-m} options are defined for Adapteva Epiphany:
14660 @table @gcctabopt
14661 @item -mhalf-reg-file
14662 @opindex mhalf-reg-file
14663 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14664 That allows code to run on hardware variants that lack these registers.
14666 @item -mprefer-short-insn-regs
14667 @opindex mprefer-short-insn-regs
14668 Preferentially allocate registers that allow short instruction generation.
14669 This can result in increased instruction count, so this may either reduce or
14670 increase overall code size.
14672 @item -mbranch-cost=@var{num}
14673 @opindex mbranch-cost
14674 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14675 This cost is only a heuristic and is not guaranteed to produce
14676 consistent results across releases.
14678 @item -mcmove
14679 @opindex mcmove
14680 Enable the generation of conditional moves.
14682 @item -mnops=@var{num}
14683 @opindex mnops
14684 Emit @var{num} NOPs before every other generated instruction.
14686 @item -mno-soft-cmpsf
14687 @opindex mno-soft-cmpsf
14688 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14689 and test the flags.  This is faster than a software comparison, but can
14690 get incorrect results in the presence of NaNs, or when two different small
14691 numbers are compared such that their difference is calculated as zero.
14692 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14693 software comparisons.
14695 @item -mstack-offset=@var{num}
14696 @opindex mstack-offset
14697 Set the offset between the top of the stack and the stack pointer.
14698 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14699 can be used by leaf functions without stack allocation.
14700 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14701 Note also that this option changes the ABI; compiling a program with a
14702 different stack offset than the libraries have been compiled with
14703 generally does not work.
14704 This option can be useful if you want to evaluate if a different stack
14705 offset would give you better code, but to actually use a different stack
14706 offset to build working programs, it is recommended to configure the
14707 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14709 @item -mno-round-nearest
14710 @opindex mno-round-nearest
14711 Make the scheduler assume that the rounding mode has been set to
14712 truncating.  The default is @option{-mround-nearest}.
14714 @item -mlong-calls
14715 @opindex mlong-calls
14716 If not otherwise specified by an attribute, assume all calls might be beyond
14717 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14718 function address into a register before performing a (otherwise direct) call.
14719 This is the default.
14721 @item -mshort-calls
14722 @opindex short-calls
14723 If not otherwise specified by an attribute, assume all direct calls are
14724 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14725 for direct calls.  The default is @option{-mlong-calls}.
14727 @item -msmall16
14728 @opindex msmall16
14729 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14730 apply to function addresses for which @option{-mlong-calls} semantics
14731 are in effect.
14733 @item -mfp-mode=@var{mode}
14734 @opindex mfp-mode
14735 Set the prevailing mode of the floating-point unit.
14736 This determines the floating-point mode that is provided and expected
14737 at function call and return time.  Making this mode match the mode you
14738 predominantly need at function start can make your programs smaller and
14739 faster by avoiding unnecessary mode switches.
14741 @var{mode} can be set to one the following values:
14743 @table @samp
14744 @item caller
14745 Any mode at function entry is valid, and retained or restored when
14746 the function returns, and when it calls other functions.
14747 This mode is useful for compiling libraries or other compilation units
14748 you might want to incorporate into different programs with different
14749 prevailing FPU modes, and the convenience of being able to use a single
14750 object file outweighs the size and speed overhead for any extra
14751 mode switching that might be needed, compared with what would be needed
14752 with a more specific choice of prevailing FPU mode.
14754 @item truncate
14755 This is the mode used for floating-point calculations with
14756 truncating (i.e.@: round towards zero) rounding mode.  That includes
14757 conversion from floating point to integer.
14759 @item round-nearest
14760 This is the mode used for floating-point calculations with
14761 round-to-nearest-or-even rounding mode.
14763 @item int
14764 This is the mode used to perform integer calculations in the FPU, e.g.@:
14765 integer multiply, or integer multiply-and-accumulate.
14766 @end table
14768 The default is @option{-mfp-mode=caller}
14770 @item -mnosplit-lohi
14771 @itemx -mno-postinc
14772 @itemx -mno-postmodify
14773 @opindex mnosplit-lohi
14774 @opindex mno-postinc
14775 @opindex mno-postmodify
14776 Code generation tweaks that disable, respectively, splitting of 32-bit
14777 loads, generation of post-increment addresses, and generation of
14778 post-modify addresses.  The defaults are @option{msplit-lohi},
14779 @option{-mpost-inc}, and @option{-mpost-modify}.
14781 @item -mnovect-double
14782 @opindex mno-vect-double
14783 Change the preferred SIMD mode to SImode.  The default is
14784 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14786 @item -max-vect-align=@var{num}
14787 @opindex max-vect-align
14788 The maximum alignment for SIMD vector mode types.
14789 @var{num} may be 4 or 8.  The default is 8.
14790 Note that this is an ABI change, even though many library function
14791 interfaces are unaffected if they don't use SIMD vector modes
14792 in places that affect size and/or alignment of relevant types.
14794 @item -msplit-vecmove-early
14795 @opindex msplit-vecmove-early
14796 Split vector moves into single word moves before reload.  In theory this
14797 can give better register allocation, but so far the reverse seems to be
14798 generally the case.
14800 @item -m1reg-@var{reg}
14801 @opindex m1reg-
14802 Specify a register to hold the constant @minus{}1, which makes loading small negative
14803 constants and certain bitmasks faster.
14804 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14805 which specify use of that register as a fixed register,
14806 and @samp{none}, which means that no register is used for this
14807 purpose.  The default is @option{-m1reg-none}.
14809 @end table
14811 @node ARC Options
14812 @subsection ARC Options
14813 @cindex ARC options
14815 The following options control the architecture variant for which code
14816 is being compiled:
14818 @c architecture variants
14819 @table @gcctabopt
14821 @item -mbarrel-shifter
14822 @opindex mbarrel-shifter
14823 Generate instructions supported by barrel shifter.  This is the default
14824 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14826 @item -mcpu=@var{cpu}
14827 @opindex mcpu
14828 Set architecture type, register usage, and instruction scheduling
14829 parameters for @var{cpu}.  There are also shortcut alias options
14830 available for backward compatibility and convenience.  Supported
14831 values for @var{cpu} are
14833 @table @samp
14834 @opindex mA6
14835 @opindex mARC600
14836 @item arc600
14837 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14839 @item arc601
14840 @opindex mARC601
14841 Compile for ARC601.  Alias: @option{-mARC601}.
14843 @item arc700
14844 @opindex mA7
14845 @opindex mARC700
14846 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14847 This is the default when configured with @option{--with-cpu=arc700}@.
14849 @item arcem
14850 Compile for ARC EM.
14852 @item archs
14853 Compile for ARC HS.
14855 @item em
14856 Compile for ARC EM CPU with no hardware extensions.
14858 @item em4
14859 Compile for ARC EM4 CPU.
14861 @item em4_dmips
14862 Compile for ARC EM4 DMIPS CPU.
14864 @item em4_fpus
14865 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14866 extension.
14868 @item em4_fpuda
14869 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14870 double assist instructions.
14872 @item hs
14873 Compile for ARC HS CPU with no hardware extensions except the atomic
14874 instructions.
14876 @item hs34
14877 Compile for ARC HS34 CPU.
14879 @item hs38
14880 Compile for ARC HS38 CPU.
14882 @item hs38_linux
14883 Compile for ARC HS38 CPU with all hardware extensions on.
14885 @item arc600_norm
14886 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14888 @item arc600_mul32x16
14889 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14890 instructions enabled.
14892 @item arc600_mul64
14893 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14894 instructions enabled.
14896 @item arc601_norm
14897 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14899 @item arc601_mul32x16
14900 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14901 instructions enabled.
14903 @item arc601_mul64
14904 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14905 instructions enabled.
14907 @item nps400
14908 Compile for ARC 700 on NPS400 chip.
14910 @end table
14912 @item -mdpfp
14913 @opindex mdpfp
14914 @itemx -mdpfp-compact
14915 @opindex mdpfp-compact
14916 Generate double-precision FPX instructions, tuned for the compact
14917 implementation.
14919 @item -mdpfp-fast
14920 @opindex mdpfp-fast
14921 Generate double-precision FPX instructions, tuned for the fast
14922 implementation.
14924 @item -mno-dpfp-lrsr
14925 @opindex mno-dpfp-lrsr
14926 Disable @code{lr} and @code{sr} instructions from using FPX extension
14927 aux registers.
14929 @item -mea
14930 @opindex mea
14931 Generate extended arithmetic instructions.  Currently only
14932 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14933 supported.  This is always enabled for @option{-mcpu=ARC700}.
14935 @item -mno-mpy
14936 @opindex mno-mpy
14937 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14938 deprecated.
14940 @item -mmul32x16
14941 @opindex mmul32x16
14942 Generate 32x16-bit multiply and multiply-accumulate instructions.
14944 @item -mmul64
14945 @opindex mmul64
14946 Generate @code{mul64} and @code{mulu64} instructions.  
14947 Only valid for @option{-mcpu=ARC600}.
14949 @item -mnorm
14950 @opindex mnorm
14951 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14952 is in effect.
14954 @item -mspfp
14955 @opindex mspfp
14956 @itemx -mspfp-compact
14957 @opindex mspfp-compact
14958 Generate single-precision FPX instructions, tuned for the compact
14959 implementation.
14961 @item -mspfp-fast
14962 @opindex mspfp-fast
14963 Generate single-precision FPX instructions, tuned for the fast
14964 implementation.
14966 @item -msimd
14967 @opindex msimd
14968 Enable generation of ARC SIMD instructions via target-specific
14969 builtins.  Only valid for @option{-mcpu=ARC700}.
14971 @item -msoft-float
14972 @opindex msoft-float
14973 This option ignored; it is provided for compatibility purposes only.
14974 Software floating-point code is emitted by default, and this default
14975 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14976 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14977 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14979 @item -mswap
14980 @opindex mswap
14981 Generate @code{swap} instructions.
14983 @item -matomic
14984 @opindex matomic
14985 This enables use of the locked load/store conditional extension to implement
14986 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14987 EM cores.
14989 @item -mdiv-rem
14990 @opindex mdiv-rem
14991 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14993 @item -mcode-density
14994 @opindex mcode-density
14995 Enable code density instructions for ARC EM.  
14996 This option is on by default for ARC HS.
14998 @item -mll64
14999 @opindex mll64
15000 Enable double load/store operations for ARC HS cores.
15002 @item -mtp-regno=@var{regno}
15003 @opindex mtp-regno
15004 Specify thread pointer register number.
15006 @item -mmpy-option=@var{multo}
15007 @opindex mmpy-option
15008 Compile ARCv2 code with a multiplier design option.  You can specify 
15009 the option using either a string or numeric value for @var{multo}.  
15010 @samp{wlh1} is the default value.  The recognized values are:
15012 @table @samp
15013 @item 0
15014 @itemx none
15015 No multiplier available.
15017 @item 1
15018 @itemx w
15019 16x16 multiplier, fully pipelined.
15020 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15022 @item 2
15023 @itemx wlh1
15024 32x32 multiplier, fully
15025 pipelined (1 stage).  The following instructions are additionally
15026 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15028 @item 3
15029 @itemx wlh2
15030 32x32 multiplier, fully pipelined
15031 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15032 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15034 @item 4
15035 @itemx wlh3
15036 Two 16x16 multipliers, blocking,
15037 sequential.  The following instructions are additionally enabled: @code{mpy},
15038 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15040 @item 5
15041 @itemx wlh4
15042 One 16x16 multiplier, blocking,
15043 sequential.  The following instructions are additionally enabled: @code{mpy},
15044 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15046 @item 6
15047 @itemx wlh5
15048 One 32x4 multiplier, blocking,
15049 sequential.  The following instructions are additionally enabled: @code{mpy},
15050 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15052 @item 7
15053 @itemx plus_dmpy
15054 ARC HS SIMD support.
15056 @item 8
15057 @itemx plus_macd
15058 ARC HS SIMD support.
15060 @item 9
15061 @itemx plus_qmacw
15062 ARC HS SIMD support.
15064 @end table
15066 This option is only available for ARCv2 cores@.
15068 @item -mfpu=@var{fpu}
15069 @opindex mfpu
15070 Enables support for specific floating-point hardware extensions for ARCv2
15071 cores.  Supported values for @var{fpu} are:
15073 @table @samp
15075 @item fpus
15076 Enables support for single-precision floating-point hardware
15077 extensions@.
15079 @item fpud
15080 Enables support for double-precision floating-point hardware
15081 extensions.  The single-precision floating-point extension is also
15082 enabled.  Not available for ARC EM@.
15084 @item fpuda
15085 Enables support for double-precision floating-point hardware
15086 extensions using double-precision assist instructions.  The single-precision
15087 floating-point extension is also enabled.  This option is
15088 only available for ARC EM@.
15090 @item fpuda_div
15091 Enables support for double-precision floating-point hardware
15092 extensions using double-precision assist instructions.
15093 The single-precision floating-point, square-root, and divide 
15094 extensions are also enabled.  This option is
15095 only available for ARC EM@.
15097 @item fpuda_fma
15098 Enables support for double-precision floating-point hardware
15099 extensions using double-precision assist instructions.
15100 The single-precision floating-point and fused multiply and add 
15101 hardware extensions are also enabled.  This option is
15102 only available for ARC EM@.
15104 @item fpuda_all
15105 Enables support for double-precision floating-point hardware
15106 extensions using double-precision assist instructions.
15107 All single-precision floating-point hardware extensions are also
15108 enabled.  This option is only available for ARC EM@.
15110 @item fpus_div
15111 Enables support for single-precision floating-point, square-root and divide 
15112 hardware extensions@.
15114 @item fpud_div
15115 Enables support for double-precision floating-point, square-root and divide 
15116 hardware extensions.  This option
15117 includes option @samp{fpus_div}. Not available for ARC EM@.
15119 @item fpus_fma
15120 Enables support for single-precision floating-point and 
15121 fused multiply and add hardware extensions@.
15123 @item fpud_fma
15124 Enables support for double-precision floating-point and 
15125 fused multiply and add hardware extensions.  This option
15126 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15128 @item fpus_all
15129 Enables support for all single-precision floating-point hardware
15130 extensions@.
15132 @item fpud_all
15133 Enables support for all single- and double-precision floating-point
15134 hardware extensions.  Not available for ARC EM@.
15136 @end table
15138 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15139 @opindex mirq-ctrl-saved
15140 Specifies general-purposes registers that the processor automatically
15141 saves/restores on interrupt entry and exit.  @var{register-range} is
15142 specified as two registers separated by a dash.  The register range
15143 always starts with @code{r0}, the upper limit is @code{fp} register.
15144 @var{blink} and @var{lp_count} are optional.  This option is only
15145 valid for ARC EM and ARC HS cores.
15147 @item -mrgf-banked-regs=@var{number}
15148 @opindex mrgf-banked-regs
15149 Specifies the number of registers replicated in second register bank
15150 on entry to fast interrupt.  Fast interrupts are interrupts with the
15151 highest priority level P0.  These interrupts save only PC and STATUS32
15152 registers to avoid memory transactions during interrupt entry and exit
15153 sequences.  Use this option when you are using fast interrupts in an
15154 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15156 @item -mlpc-width=@var{width}
15157 @opindex mlpc-width
15158 Specify the width of the @code{lp_count} register.  Valid values for
15159 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15160 fixed to 32 bits.  If the width is less than 32, the compiler does not
15161 attempt to transform loops in your program to use the zero-delay loop
15162 mechanism unless it is known that the @code{lp_count} register can
15163 hold the required loop-counter value.  Depending on the width
15164 specified, the compiler and run-time library might continue to use the
15165 loop mechanism for various needs.  This option defines macro
15166 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15168 @end table
15170 The following options are passed through to the assembler, and also
15171 define preprocessor macro symbols.
15173 @c Flags used by the assembler, but for which we define preprocessor
15174 @c macro symbols as well.
15175 @table @gcctabopt
15176 @item -mdsp-packa
15177 @opindex mdsp-packa
15178 Passed down to the assembler to enable the DSP Pack A extensions.
15179 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15180 deprecated.
15182 @item -mdvbf
15183 @opindex mdvbf
15184 Passed down to the assembler to enable the dual Viterbi butterfly
15185 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15186 option is deprecated.
15188 @c ARC700 4.10 extension instruction
15189 @item -mlock
15190 @opindex mlock
15191 Passed down to the assembler to enable the locked load/store
15192 conditional extension.  Also sets the preprocessor symbol
15193 @code{__Xlock}.
15195 @item -mmac-d16
15196 @opindex mmac-d16
15197 Passed down to the assembler.  Also sets the preprocessor symbol
15198 @code{__Xxmac_d16}.  This option is deprecated.
15200 @item -mmac-24
15201 @opindex mmac-24
15202 Passed down to the assembler.  Also sets the preprocessor symbol
15203 @code{__Xxmac_24}.  This option is deprecated.
15205 @c ARC700 4.10 extension instruction
15206 @item -mrtsc
15207 @opindex mrtsc
15208 Passed down to the assembler to enable the 64-bit time-stamp counter
15209 extension instruction.  Also sets the preprocessor symbol
15210 @code{__Xrtsc}.  This option is deprecated.
15212 @c ARC700 4.10 extension instruction
15213 @item -mswape
15214 @opindex mswape
15215 Passed down to the assembler to enable the swap byte ordering
15216 extension instruction.  Also sets the preprocessor symbol
15217 @code{__Xswape}.
15219 @item -mtelephony
15220 @opindex mtelephony
15221 Passed down to the assembler to enable dual- and single-operand
15222 instructions for telephony.  Also sets the preprocessor symbol
15223 @code{__Xtelephony}.  This option is deprecated.
15225 @item -mxy
15226 @opindex mxy
15227 Passed down to the assembler to enable the XY memory extension.  Also
15228 sets the preprocessor symbol @code{__Xxy}.
15230 @end table
15232 The following options control how the assembly code is annotated:
15234 @c Assembly annotation options
15235 @table @gcctabopt
15236 @item -misize
15237 @opindex misize
15238 Annotate assembler instructions with estimated addresses.
15240 @item -mannotate-align
15241 @opindex mannotate-align
15242 Explain what alignment considerations lead to the decision to make an
15243 instruction short or long.
15245 @end table
15247 The following options are passed through to the linker:
15249 @c options passed through to the linker
15250 @table @gcctabopt
15251 @item -marclinux
15252 @opindex marclinux
15253 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15254 This option is enabled by default in tool chains built for
15255 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15256 when profiling is not requested.
15258 @item -marclinux_prof
15259 @opindex marclinux_prof
15260 Passed through to the linker, to specify use of the
15261 @code{arclinux_prof} emulation.  This option is enabled by default in
15262 tool chains built for @w{@code{arc-linux-uclibc}} and
15263 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15265 @end table
15267 The following options control the semantics of generated code:
15269 @c semantically relevant code generation options
15270 @table @gcctabopt
15271 @item -mlong-calls
15272 @opindex mlong-calls
15273 Generate calls as register indirect calls, thus providing access
15274 to the full 32-bit address range.
15276 @item -mmedium-calls
15277 @opindex mmedium-calls
15278 Don't use less than 25-bit addressing range for calls, which is the
15279 offset available for an unconditional branch-and-link
15280 instruction.  Conditional execution of function calls is suppressed, to
15281 allow use of the 25-bit range, rather than the 21-bit range with
15282 conditional branch-and-link.  This is the default for tool chains built
15283 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15285 @item -G @var{num}
15286 @opindex G
15287 Put definitions of externally-visible data in a small data section if
15288 that data is no bigger than @var{num} bytes.  The default value of
15289 @var{num} is 4 for any ARC configuration, or 8 when we have double
15290 load/store operations.
15292 @item -mno-sdata
15293 @opindex mno-sdata
15294 Do not generate sdata references.  This is the default for tool chains
15295 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15296 targets.
15298 @item -mvolatile-cache
15299 @opindex mvolatile-cache
15300 Use ordinarily cached memory accesses for volatile references.  This is the
15301 default.
15303 @item -mno-volatile-cache
15304 @opindex mno-volatile-cache
15305 Enable cache bypass for volatile references.
15307 @end table
15309 The following options fine tune code generation:
15310 @c code generation tuning options
15311 @table @gcctabopt
15312 @item -malign-call
15313 @opindex malign-call
15314 Do alignment optimizations for call instructions.
15316 @item -mauto-modify-reg
15317 @opindex mauto-modify-reg
15318 Enable the use of pre/post modify with register displacement.
15320 @item -mbbit-peephole
15321 @opindex mbbit-peephole
15322 Enable bbit peephole2.
15324 @item -mno-brcc
15325 @opindex mno-brcc
15326 This option disables a target-specific pass in @file{arc_reorg} to
15327 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15328 It has no effect on
15329 generation of these instructions driven by the combiner pass.
15331 @item -mcase-vector-pcrel
15332 @opindex mcase-vector-pcrel
15333 Use PC-relative switch case tables to enable case table shortening.
15334 This is the default for @option{-Os}.
15336 @item -mcompact-casesi
15337 @opindex mcompact-casesi
15338 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15339 and only available for ARCv1 cores.
15341 @item -mno-cond-exec
15342 @opindex mno-cond-exec
15343 Disable the ARCompact-specific pass to generate conditional 
15344 execution instructions.
15346 Due to delay slot scheduling and interactions between operand numbers,
15347 literal sizes, instruction lengths, and the support for conditional execution,
15348 the target-independent pass to generate conditional execution is often lacking,
15349 so the ARC port has kept a special pass around that tries to find more
15350 conditional execution generation opportunities after register allocation,
15351 branch shortening, and delay slot scheduling have been done.  This pass
15352 generally, but not always, improves performance and code size, at the cost of
15353 extra compilation time, which is why there is an option to switch it off.
15354 If you have a problem with call instructions exceeding their allowable
15355 offset range because they are conditionalized, you should consider using
15356 @option{-mmedium-calls} instead.
15358 @item -mearly-cbranchsi
15359 @opindex mearly-cbranchsi
15360 Enable pre-reload use of the @code{cbranchsi} pattern.
15362 @item -mexpand-adddi
15363 @opindex mexpand-adddi
15364 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15365 @code{add.f}, @code{adc} etc.  This option is deprecated.
15367 @item -mindexed-loads
15368 @opindex mindexed-loads
15369 Enable the use of indexed loads.  This can be problematic because some
15370 optimizers then assume that indexed stores exist, which is not
15371 the case.
15373 @item -mlra
15374 @opindex mlra
15375 Enable Local Register Allocation.  This is still experimental for ARC,
15376 so by default the compiler uses standard reload
15377 (i.e. @option{-mno-lra}).
15379 @item -mlra-priority-none
15380 @opindex mlra-priority-none
15381 Don't indicate any priority for target registers.
15383 @item -mlra-priority-compact
15384 @opindex mlra-priority-compact
15385 Indicate target register priority for r0..r3 / r12..r15.
15387 @item -mlra-priority-noncompact
15388 @opindex mlra-priority-noncompact
15389 Reduce target register priority for r0..r3 / r12..r15.
15391 @item -mno-millicode
15392 @opindex mno-millicode
15393 When optimizing for size (using @option{-Os}), prologues and epilogues
15394 that have to save or restore a large number of registers are often
15395 shortened by using call to a special function in libgcc; this is
15396 referred to as a @emph{millicode} call.  As these calls can pose
15397 performance issues, and/or cause linking issues when linking in a
15398 nonstandard way, this option is provided to turn off millicode call
15399 generation.
15401 @item -mmixed-code
15402 @opindex mmixed-code
15403 Tweak register allocation to help 16-bit instruction generation.
15404 This generally has the effect of decreasing the average instruction size
15405 while increasing the instruction count.
15407 @item -mq-class
15408 @opindex mq-class
15409 Enable @samp{q} instruction alternatives.
15410 This is the default for @option{-Os}.
15412 @item -mRcq
15413 @opindex mRcq
15414 Enable @samp{Rcq} constraint handling.  
15415 Most short code generation depends on this.
15416 This is the default.
15418 @item -mRcw
15419 @opindex mRcw
15420 Enable @samp{Rcw} constraint handling.  
15421 Most ccfsm condexec mostly depends on this.
15422 This is the default.
15424 @item -msize-level=@var{level}
15425 @opindex msize-level
15426 Fine-tune size optimization with regards to instruction lengths and alignment.
15427 The recognized values for @var{level} are:
15428 @table @samp
15429 @item 0
15430 No size optimization.  This level is deprecated and treated like @samp{1}.
15432 @item 1
15433 Short instructions are used opportunistically.
15435 @item 2
15436 In addition, alignment of loops and of code after barriers are dropped.
15438 @item 3
15439 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15441 @end table
15443 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15444 the behavior when this is not set is equivalent to level @samp{1}.
15446 @item -mtune=@var{cpu}
15447 @opindex mtune
15448 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15449 by @option{-mcpu=}.
15451 Supported values for @var{cpu} are
15453 @table @samp
15454 @item ARC600
15455 Tune for ARC600 CPU.
15457 @item ARC601
15458 Tune for ARC601 CPU.
15460 @item ARC700
15461 Tune for ARC700 CPU with standard multiplier block.
15463 @item ARC700-xmac
15464 Tune for ARC700 CPU with XMAC block.
15466 @item ARC725D
15467 Tune for ARC725D CPU.
15469 @item ARC750D
15470 Tune for ARC750D CPU.
15472 @end table
15474 @item -mmultcost=@var{num}
15475 @opindex mmultcost
15476 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15477 normal instruction.
15479 @item -munalign-prob-threshold=@var{probability}
15480 @opindex munalign-prob-threshold
15481 Set probability threshold for unaligning branches.
15482 When tuning for @samp{ARC700} and optimizing for speed, branches without
15483 filled delay slot are preferably emitted unaligned and long, unless
15484 profiling indicates that the probability for the branch to be taken
15485 is below @var{probability}.  @xref{Cross-profiling}.
15486 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15488 @end table
15490 The following options are maintained for backward compatibility, but
15491 are now deprecated and will be removed in a future release:
15493 @c Deprecated options
15494 @table @gcctabopt
15496 @item -margonaut
15497 @opindex margonaut
15498 Obsolete FPX.
15500 @item -mbig-endian
15501 @opindex mbig-endian
15502 @itemx -EB
15503 @opindex EB
15504 Compile code for big-endian targets.  Use of these options is now
15505 deprecated.  Big-endian code is supported by configuring GCC to build
15506 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15507 for which big endian is the default.
15509 @item -mlittle-endian
15510 @opindex mlittle-endian
15511 @itemx -EL
15512 @opindex EL
15513 Compile code for little-endian targets.  Use of these options is now
15514 deprecated.  Little-endian code is supported by configuring GCC to build 
15515 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15516 for which little endian is the default.
15518 @item -mbarrel_shifter
15519 @opindex mbarrel_shifter
15520 Replaced by @option{-mbarrel-shifter}.
15522 @item -mdpfp_compact
15523 @opindex mdpfp_compact
15524 Replaced by @option{-mdpfp-compact}.
15526 @item -mdpfp_fast
15527 @opindex mdpfp_fast
15528 Replaced by @option{-mdpfp-fast}.
15530 @item -mdsp_packa
15531 @opindex mdsp_packa
15532 Replaced by @option{-mdsp-packa}.
15534 @item -mEA
15535 @opindex mEA
15536 Replaced by @option{-mea}.
15538 @item -mmac_24
15539 @opindex mmac_24
15540 Replaced by @option{-mmac-24}.
15542 @item -mmac_d16
15543 @opindex mmac_d16
15544 Replaced by @option{-mmac-d16}.
15546 @item -mspfp_compact
15547 @opindex mspfp_compact
15548 Replaced by @option{-mspfp-compact}.
15550 @item -mspfp_fast
15551 @opindex mspfp_fast
15552 Replaced by @option{-mspfp-fast}.
15554 @item -mtune=@var{cpu}
15555 @opindex mtune
15556 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15557 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15558 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15560 @item -multcost=@var{num}
15561 @opindex multcost
15562 Replaced by @option{-mmultcost}.
15564 @end table
15566 @node ARM Options
15567 @subsection ARM Options
15568 @cindex ARM options
15570 These @samp{-m} options are defined for the ARM port:
15572 @table @gcctabopt
15573 @item -mabi=@var{name}
15574 @opindex mabi
15575 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15576 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15578 @item -mapcs-frame
15579 @opindex mapcs-frame
15580 Generate a stack frame that is compliant with the ARM Procedure Call
15581 Standard for all functions, even if this is not strictly necessary for
15582 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15583 with this option causes the stack frames not to be generated for
15584 leaf functions.  The default is @option{-mno-apcs-frame}.
15585 This option is deprecated.
15587 @item -mapcs
15588 @opindex mapcs
15589 This is a synonym for @option{-mapcs-frame} and is deprecated.
15591 @ignore
15592 @c not currently implemented
15593 @item -mapcs-stack-check
15594 @opindex mapcs-stack-check
15595 Generate code to check the amount of stack space available upon entry to
15596 every function (that actually uses some stack space).  If there is
15597 insufficient space available then either the function
15598 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15599 called, depending upon the amount of stack space required.  The runtime
15600 system is required to provide these functions.  The default is
15601 @option{-mno-apcs-stack-check}, since this produces smaller code.
15603 @c not currently implemented
15604 @item -mapcs-reentrant
15605 @opindex mapcs-reentrant
15606 Generate reentrant, position-independent code.  The default is
15607 @option{-mno-apcs-reentrant}.
15608 @end ignore
15610 @item -mthumb-interwork
15611 @opindex mthumb-interwork
15612 Generate code that supports calling between the ARM and Thumb
15613 instruction sets.  Without this option, on pre-v5 architectures, the
15614 two instruction sets cannot be reliably used inside one program.  The
15615 default is @option{-mno-thumb-interwork}, since slightly larger code
15616 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15617 configurations this option is meaningless.
15619 @item -mno-sched-prolog
15620 @opindex mno-sched-prolog
15621 Prevent the reordering of instructions in the function prologue, or the
15622 merging of those instruction with the instructions in the function's
15623 body.  This means that all functions start with a recognizable set
15624 of instructions (or in fact one of a choice from a small set of
15625 different function prologues), and this information can be used to
15626 locate the start of functions inside an executable piece of code.  The
15627 default is @option{-msched-prolog}.
15629 @item -mfloat-abi=@var{name}
15630 @opindex mfloat-abi
15631 Specifies which floating-point ABI to use.  Permissible values
15632 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15634 Specifying @samp{soft} causes GCC to generate output containing
15635 library calls for floating-point operations.
15636 @samp{softfp} allows the generation of code using hardware floating-point
15637 instructions, but still uses the soft-float calling conventions.
15638 @samp{hard} allows generation of floating-point instructions
15639 and uses FPU-specific calling conventions.
15641 The default depends on the specific target configuration.  Note that
15642 the hard-float and soft-float ABIs are not link-compatible; you must
15643 compile your entire program with the same ABI, and link with a
15644 compatible set of libraries.
15646 @item -mlittle-endian
15647 @opindex mlittle-endian
15648 Generate code for a processor running in little-endian mode.  This is
15649 the default for all standard configurations.
15651 @item -mbig-endian
15652 @opindex mbig-endian
15653 Generate code for a processor running in big-endian mode; the default is
15654 to compile code for a little-endian processor.
15656 @item -mbe8
15657 @itemx -mbe32
15658 @opindex mbe8
15659 When linking a big-endian image select between BE8 and BE32 formats.
15660 The option has no effect for little-endian images and is ignored.  The
15661 default is dependent on the selected target architecture.  For ARMv6
15662 and later architectures the default is BE8, for older architectures
15663 the default is BE32.  BE32 format has been deprecated by ARM.
15665 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15666 @opindex march
15667 This specifies the name of the target ARM architecture.  GCC uses this
15668 name to determine what kind of instructions it can emit when generating
15669 assembly code.  This option can be used in conjunction with or instead
15670 of the @option{-mcpu=} option.
15672 Permissible names are:
15673 @samp{armv4t},
15674 @samp{armv5t}, @samp{armv5te},
15675 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15676 @samp{armv6z}, @samp{armv6zk},
15677 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15678 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15679 @samp{armv7-r},
15680 @samp{armv8-r},
15681 @samp{armv6-m}, @samp{armv6s-m},
15682 @samp{armv7-m}, @samp{armv7e-m},
15683 @samp{armv8-m.base}, @samp{armv8-m.main},
15684 @samp{iwmmxt} and @samp{iwmmxt2}.
15686 Additionally, the following architectures, which lack support for the
15687 Thumb execution state, are recognized but support is deprecated:
15688 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15689 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15691 Many of the architectures support extensions.  These can be added by
15692 appending @samp{+@var{extension}} to the architecture name.  Extension
15693 options are processed in order and capabilities accumulate.  An extension
15694 will also enable any necessary base extensions
15695 upon which it depends.  For example, the @samp{+crypto} extension
15696 will always enable the @samp{+simd} extension.  The exception to the
15697 additive construction is for extensions that are prefixed with
15698 @samp{+no@dots{}}: these extensions disable the specified option and
15699 any other extensions that may depend on the presence of that
15700 extension.
15702 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15703 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15704 entirely disabled by the @samp{+nofp} option that follows it.
15706 Most extension names are generically named, but have an effect that is
15707 dependent upon the architecture to which it is applied.  For example,
15708 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15709 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15710 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15711 variant for @samp{armv8-a}.
15713 The table below lists the supported extensions for each architecture.
15714 Architectures not mentioned do not support any extensions.
15716 @table @samp
15717 @item  armv5e
15718 @itemx armv5te
15719 @itemx armv6
15720 @itemx armv6j
15721 @itemx armv6k
15722 @itemx armv6kz
15723 @itemx armv6t2
15724 @itemx armv6z
15725 @itemx armv6zk
15726 @table @samp
15727 @item +fp
15728 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15729 used as an alias for this extension.
15731 @item +nofp
15732 Disable the floating-point instructions.
15733 @end table
15735 @item armv7
15736 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15737 @table @samp
15738 @item +fp
15739 The VFPv3 floating-point instructions, with 16 double-precision
15740 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15741 for this extension.  Note that floating-point is not supported by the
15742 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15743 ARMv7-R architectures.
15745 @item +nofp
15746 Disable the floating-point instructions.
15747 @end table
15749 @item armv7-a
15750 @table @samp
15751 @item +fp
15752 The VFPv3 floating-point instructions, with 16 double-precision
15753 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15754 for this extension.
15756 @item +simd
15757 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15758 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15759 for this extension.
15761 @item +vfpv3
15762 The VFPv3 floating-point instructions, with 32 double-precision
15763 registers.
15765 @item +vfpv3-d16-fp16
15766 The VFPv3 floating-point instructions, with 16 double-precision
15767 registers and the half-precision floating-point conversion operations.
15769 @item +vfpv3-fp16
15770 The VFPv3 floating-point instructions, with 32 double-precision
15771 registers and the half-precision floating-point conversion operations.
15773 @item +vfpv4-d16
15774 The VFPv4 floating-point instructions, with 16 double-precision
15775 registers.
15777 @item +vfpv4
15778 The VFPv4 floating-point instructions, with 32 double-precision
15779 registers.
15781 @item +neon-fp16
15782 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15783 the half-precision floating-point conversion operations.
15785 @item +neon-vfpv4
15786 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15788 @item +nosimd
15789 Disable the Advanced SIMD instructions (does not disable floating point).
15791 @item +nofp
15792 Disable the floating-point and Advanced SIMD instructions.
15793 @end table
15795 @item armv7ve
15796 The extended version of the ARMv7-A architecture with support for
15797 virtualization.
15798 @table @samp
15799 @item +fp
15800 The VFPv4 floating-point instructions, with 16 double-precision registers.
15801 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15803 @item +simd
15804 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15805 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15807 @item +vfpv3-d16
15808 The VFPv3 floating-point instructions, with 16 double-precision
15809 registers.
15811 @item +vfpv3
15812 The VFPv3 floating-point instructions, with 32 double-precision
15813 registers.
15815 @item +vfpv3-d16-fp16
15816 The VFPv3 floating-point instructions, with 16 double-precision
15817 registers and the half-precision floating-point conversion operations.
15819 @item +vfpv3-fp16
15820 The VFPv3 floating-point instructions, with 32 double-precision
15821 registers and the half-precision floating-point conversion operations.
15823 @item +vfpv4-d16
15824 The VFPv4 floating-point instructions, with 16 double-precision
15825 registers.
15827 @item +vfpv4
15828 The VFPv4 floating-point instructions, with 32 double-precision
15829 registers.
15831 @item +neon
15832 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15833 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15835 @item +neon-fp16
15836 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15837 the half-precision floating-point conversion operations.
15839 @item +nosimd
15840 Disable the Advanced SIMD instructions (does not disable floating point).
15842 @item +nofp
15843 Disable the floating-point and Advanced SIMD instructions.
15844 @end table
15846 @item armv8-a
15847 @table @samp
15848 @item +crc
15849 The Cyclic Redundancy Check (CRC) instructions.
15850 @item +simd
15851 The ARMv8-A Advanced SIMD and floating-point instructions.
15852 @item +crypto
15853 The cryptographic instructions.
15854 @item +nocrypto
15855 Disable the cryptographic instructions.
15856 @item +nofp
15857 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15858 @end table
15860 @item armv8.1-a
15861 @table @samp
15862 @item +simd
15863 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15865 @item +crypto
15866 The cryptographic instructions.  This also enables the Advanced SIMD and
15867 floating-point instructions.
15869 @item +nocrypto
15870 Disable the cryptographic instructions.
15872 @item +nofp
15873 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15874 @end table
15876 @item armv8.2-a
15877 @itemx armv8.3-a
15878 @table @samp
15879 @item +fp16
15880 The half-precision floating-point data processing instructions.
15881 This also enables the Advanced SIMD and floating-point instructions.
15883 @item +simd
15884 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15886 @item +crypto
15887 The cryptographic instructions.  This also enables the Advanced SIMD and
15888 floating-point instructions.
15890 @item +dotprod
15891 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
15893 @item +nocrypto
15894 Disable the cryptographic extension.
15896 @item +nofp
15897 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15898 @end table
15900 @item armv7-r
15901 @table @samp
15902 @item +fp.sp
15903 The single-precision VFPv3 floating-point instructions.  The extension
15904 @samp{+vfpv3xd} can be used as an alias for this extension.
15906 @item +fp
15907 The VFPv3 floating-point instructions with 16 double-precision registers.
15908 The extension +vfpv3-d16 can be used as an alias for this extension.
15910 @item +nofp
15911 Disable the floating-point extension.
15913 @item +idiv
15914 The ARM-state integer division instructions.
15916 @item +noidiv
15917 Disable the ARM-state integer division extension.
15918 @end table
15920 @item armv7e-m
15921 @table @samp
15922 @item +fp
15923 The single-precision VFPv4 floating-point instructions.
15925 @item +fpv5
15926 The single-precision FPv5 floating-point instructions.
15928 @item +fp.dp
15929 The single- and double-precision FPv5 floating-point instructions.
15931 @item +nofp
15932 Disable the floating-point extensions.
15933 @end table
15935 @item  armv8-m.main
15936 @table @samp
15937 @item +dsp
15938 The DSP instructions.
15940 @item +nodsp
15941 Disable the DSP extension.
15943 @item +fp
15944 The single-precision floating-point instructions.
15946 @item +fp.dp
15947 The single- and double-precision floating-point instructions.
15949 @item +nofp
15950 Disable the floating-point extension.
15951 @end table
15953 @item armv8-r
15954 @table @samp
15955 @item +crc
15956 The Cyclic Redundancy Check (CRC) instructions.
15957 @item +fp.sp
15958 The single-precision FPv5 floating-point instructions.
15959 @item +simd
15960 The ARMv8-A Advanced SIMD and floating-point instructions.
15961 @item +crypto
15962 The cryptographic instructions.
15963 @item +nocrypto
15964 Disable the cryptographic instructions.
15965 @item +nofp
15966 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15967 @end table
15969 @end table
15971 @option{-march=native} causes the compiler to auto-detect the architecture
15972 of the build computer.  At present, this feature is only supported on
15973 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15974 is unsuccessful the option has no effect.
15976 @item -mtune=@var{name}
15977 @opindex mtune
15978 This option specifies the name of the target ARM processor for
15979 which GCC should tune the performance of the code.
15980 For some ARM implementations better performance can be obtained by using
15981 this option.
15982 Permissible names are: @samp{arm2}, @samp{arm250},
15983 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15984 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15985 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15986 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15987 @samp{arm720},
15988 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15989 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15990 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15991 @samp{strongarm1110},
15992 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15993 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15994 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15995 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15996 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15997 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15998 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15999 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
16000 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
16001 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
16002 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
16003 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
16004 @samp{cortex-r8}, @samp{cortex-r52},
16005 @samp{cortex-m33},
16006 @samp{cortex-m23},
16007 @samp{cortex-m7},
16008 @samp{cortex-m4},
16009 @samp{cortex-m3},
16010 @samp{cortex-m1},
16011 @samp{cortex-m0},
16012 @samp{cortex-m0plus},
16013 @samp{cortex-m1.small-multiply},
16014 @samp{cortex-m0.small-multiply},
16015 @samp{cortex-m0plus.small-multiply},
16016 @samp{exynos-m1},
16017 @samp{marvell-pj4},
16018 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
16019 @samp{fa526}, @samp{fa626},
16020 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16021 @samp{xgene1}.
16023 Additionally, this option can specify that GCC should tune the performance
16024 of the code for a big.LITTLE system.  Permissible names are:
16025 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16026 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16027 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16028 @samp{cortex-a75.cortex-a55}.
16030 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16031 performance for a blend of processors within architecture @var{arch}.
16032 The aim is to generate code that run well on the current most popular
16033 processors, balancing between optimizations that benefit some CPUs in the
16034 range, and avoiding performance pitfalls of other CPUs.  The effects of
16035 this option may change in future GCC versions as CPU models come and go.
16037 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16038 the extension options do not affect the tuning of the generated code.
16040 @option{-mtune=native} causes the compiler to auto-detect the CPU
16041 of the build computer.  At present, this feature is only supported on
16042 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16043 unsuccessful the option has no effect.
16045 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16046 @opindex mcpu
16047 This specifies the name of the target ARM processor.  GCC uses this name
16048 to derive the name of the target ARM architecture (as if specified
16049 by @option{-march}) and the ARM processor type for which to tune for
16050 performance (as if specified by @option{-mtune}).  Where this option
16051 is used in conjunction with @option{-march} or @option{-mtune},
16052 those options take precedence over the appropriate part of this option.
16054 Many of the supported CPUs implement optional architectural
16055 extensions.  Where this is so the architectural extensions are
16056 normally enabled by default.  If implementations that lack the
16057 extension exist, then the extension syntax can be used to disable
16058 those extensions that have been omitted.  For floating-point and
16059 Advanced SIMD (Neon) instructions, the settings of the options
16060 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16061 floating-point and Advanced SIMD instructions will only be used if
16062 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16063 @option{-mfpu} other than @samp{auto} will override the available
16064 floating-point and SIMD extension instructions.
16066 For example, @samp{cortex-a9} can be found in three major
16067 configurations: integer only, with just a floating-point unit or with
16068 floating-point and Advanced SIMD.  The default is to enable all the
16069 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16070 be used to disable just the SIMD or both the SIMD and floating-point
16071 instructions respectively.
16073 Permissible names for this option are the same as those for
16074 @option{-mtune}.
16076 The following extension options are common to the listed CPUs:
16078 @table @samp
16079 @item +nodsp
16080 Disable the DSP instructions on @samp{cortex-m33}.
16082 @item  +nofp
16083 Disables the floating-point instructions on @samp{arm9e},
16084 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16085 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16086 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16087 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16088 Disables the floating-point and SIMD instructions on
16089 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16090 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16091 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16092 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16093 @samp{cortex-a53} and @samp{cortex-a55}.
16095 @item +nofp.dp
16096 Disables the double-precision component of the floating-point instructions
16097 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16099 @item +nosimd
16100 Disables the SIMD (but not floating-point) instructions on
16101 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16102 and @samp{cortex-a9}.
16104 @item +crypto
16105 Enables the cryptographic instructions on @samp{cortex-a32},
16106 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16107 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16108 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16109 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16110 @samp{cortex-a75.cortex-a55}.
16111 @end table
16113 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16114 VFPv3 with 16 double-precision registers.  It supports the following
16115 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16116 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16117 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16118 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16119 @option{-march=armv7-a}.
16121 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16122 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16123 See @option{-mtune} for more information.
16125 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16126 of the build computer.  At present, this feature is only supported on
16127 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16128 is unsuccessful the option has no effect.
16130 @item -mfpu=@var{name}
16131 @opindex mfpu
16132 This specifies what floating-point hardware (or hardware emulation) is
16133 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16134 @samp{vfpv3},
16135 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16136 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16137 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16138 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16139 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16140 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16141 is an alias for @samp{vfpv2}.
16143 The setting @samp{auto} is the default and is special.  It causes the
16144 compiler to select the floating-point and Advanced SIMD instructions
16145 based on the settings of @option{-mcpu} and @option{-march}.
16147 If the selected floating-point hardware includes the NEON extension
16148 (e.g. @option{-mfpu=neon}), note that floating-point
16149 operations are not generated by GCC's auto-vectorization pass unless
16150 @option{-funsafe-math-optimizations} is also specified.  This is
16151 because NEON hardware does not fully implement the IEEE 754 standard for
16152 floating-point arithmetic (in particular denormal values are treated as
16153 zero), so the use of NEON instructions may lead to a loss of precision.
16155 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}).
16157 @item -mfp16-format=@var{name}
16158 @opindex mfp16-format
16159 Specify the format of the @code{__fp16} half-precision floating-point type.
16160 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16161 the default is @samp{none}, in which case the @code{__fp16} type is not
16162 defined.  @xref{Half-Precision}, for more information.
16164 @item -mstructure-size-boundary=@var{n}
16165 @opindex mstructure-size-boundary
16166 The sizes of all structures and unions are rounded up to a multiple
16167 of the number of bits set by this option.  Permissible values are 8, 32
16168 and 64.  The default value varies for different toolchains.  For the COFF
16169 targeted toolchain the default value is 8.  A value of 64 is only allowed
16170 if the underlying ABI supports it.
16172 Specifying a larger number can produce faster, more efficient code, but
16173 can also increase the size of the program.  Different values are potentially
16174 incompatible.  Code compiled with one value cannot necessarily expect to
16175 work with code or libraries compiled with another value, if they exchange
16176 information using structures or unions.
16178 This option is deprecated.
16180 @item -mabort-on-noreturn
16181 @opindex mabort-on-noreturn
16182 Generate a call to the function @code{abort} at the end of a
16183 @code{noreturn} function.  It is executed if the function tries to
16184 return.
16186 @item -mlong-calls
16187 @itemx -mno-long-calls
16188 @opindex mlong-calls
16189 @opindex mno-long-calls
16190 Tells the compiler to perform function calls by first loading the
16191 address of the function into a register and then performing a subroutine
16192 call on this register.  This switch is needed if the target function
16193 lies outside of the 64-megabyte addressing range of the offset-based
16194 version of subroutine call instruction.
16196 Even if this switch is enabled, not all function calls are turned
16197 into long calls.  The heuristic is that static functions, functions
16198 that have the @code{short_call} attribute, functions that are inside
16199 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16200 definitions have already been compiled within the current compilation
16201 unit are not turned into long calls.  The exceptions to this rule are
16202 that weak function definitions, functions with the @code{long_call}
16203 attribute or the @code{section} attribute, and functions that are within
16204 the scope of a @code{#pragma long_calls} directive are always
16205 turned into long calls.
16207 This feature is not enabled by default.  Specifying
16208 @option{-mno-long-calls} restores the default behavior, as does
16209 placing the function calls within the scope of a @code{#pragma
16210 long_calls_off} directive.  Note these switches have no effect on how
16211 the compiler generates code to handle function calls via function
16212 pointers.
16214 @item -msingle-pic-base
16215 @opindex msingle-pic-base
16216 Treat the register used for PIC addressing as read-only, rather than
16217 loading it in the prologue for each function.  The runtime system is
16218 responsible for initializing this register with an appropriate value
16219 before execution begins.
16221 @item -mpic-register=@var{reg}
16222 @opindex mpic-register
16223 Specify the register to be used for PIC addressing.
16224 For standard PIC base case, the default is any suitable register
16225 determined by compiler.  For single PIC base case, the default is
16226 @samp{R9} if target is EABI based or stack-checking is enabled,
16227 otherwise the default is @samp{R10}.
16229 @item -mpic-data-is-text-relative
16230 @opindex mpic-data-is-text-relative
16231 Assume that the displacement between the text and data segments is fixed
16232 at static link time.  This permits using PC-relative addressing
16233 operations to access data known to be in the data segment.  For
16234 non-VxWorks RTP targets, this option is enabled by default.  When
16235 disabled on such targets, it will enable @option{-msingle-pic-base} by
16236 default.
16238 @item -mpoke-function-name
16239 @opindex mpoke-function-name
16240 Write the name of each function into the text section, directly
16241 preceding the function prologue.  The generated code is similar to this:
16243 @smallexample
16244      t0
16245          .ascii "arm_poke_function_name", 0
16246          .align
16247      t1
16248          .word 0xff000000 + (t1 - t0)
16249      arm_poke_function_name
16250          mov     ip, sp
16251          stmfd   sp!, @{fp, ip, lr, pc@}
16252          sub     fp, ip, #4
16253 @end smallexample
16255 When performing a stack backtrace, code can inspect the value of
16256 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16257 location @code{pc - 12} and the top 8 bits are set, then we know that
16258 there is a function name embedded immediately preceding this location
16259 and has length @code{((pc[-3]) & 0xff000000)}.
16261 @item -mthumb
16262 @itemx -marm
16263 @opindex marm
16264 @opindex mthumb
16266 Select between generating code that executes in ARM and Thumb
16267 states.  The default for most configurations is to generate code
16268 that executes in ARM state, but the default can be changed by
16269 configuring GCC with the @option{--with-mode=}@var{state}
16270 configure option.
16272 You can also override the ARM and Thumb mode for each function
16273 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16274 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16276 @item -mflip-thumb 
16277 @opindex mflip-thumb
16278 Switch ARM/Thumb modes on alternating functions.
16279 This option is provided for regression testing of mixed Thumb/ARM code
16280 generation, and is not intended for ordinary use in compiling code.
16282 @item -mtpcs-frame
16283 @opindex mtpcs-frame
16284 Generate a stack frame that is compliant with the Thumb Procedure Call
16285 Standard for all non-leaf functions.  (A leaf function is one that does
16286 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16288 @item -mtpcs-leaf-frame
16289 @opindex mtpcs-leaf-frame
16290 Generate a stack frame that is compliant with the Thumb Procedure Call
16291 Standard for all leaf functions.  (A leaf function is one that does
16292 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16294 @item -mcallee-super-interworking
16295 @opindex mcallee-super-interworking
16296 Gives all externally visible functions in the file being compiled an ARM
16297 instruction set header which switches to Thumb mode before executing the
16298 rest of the function.  This allows these functions to be called from
16299 non-interworking code.  This option is not valid in AAPCS configurations
16300 because interworking is enabled by default.
16302 @item -mcaller-super-interworking
16303 @opindex mcaller-super-interworking
16304 Allows calls via function pointers (including virtual functions) to
16305 execute correctly regardless of whether the target code has been
16306 compiled for interworking or not.  There is a small overhead in the cost
16307 of executing a function pointer if this option is enabled.  This option
16308 is not valid in AAPCS configurations because interworking is enabled
16309 by default.
16311 @item -mtp=@var{name}
16312 @opindex mtp
16313 Specify the access model for the thread local storage pointer.  The valid
16314 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16315 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16316 (supported in the arm6k architecture), and @samp{auto}, which uses the
16317 best available method for the selected processor.  The default setting is
16318 @samp{auto}.
16320 @item -mtls-dialect=@var{dialect}
16321 @opindex mtls-dialect
16322 Specify the dialect to use for accessing thread local storage.  Two
16323 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16324 @samp{gnu} dialect selects the original GNU scheme for supporting
16325 local and global dynamic TLS models.  The @samp{gnu2} dialect
16326 selects the GNU descriptor scheme, which provides better performance
16327 for shared libraries.  The GNU descriptor scheme is compatible with
16328 the original scheme, but does require new assembler, linker and
16329 library support.  Initial and local exec TLS models are unaffected by
16330 this option and always use the original scheme.
16332 @item -mword-relocations
16333 @opindex mword-relocations
16334 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16335 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16336 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16337 is specified.
16339 @item -mfix-cortex-m3-ldrd
16340 @opindex mfix-cortex-m3-ldrd
16341 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16342 with overlapping destination and base registers are used.  This option avoids
16343 generating these instructions.  This option is enabled by default when
16344 @option{-mcpu=cortex-m3} is specified.
16346 @item -munaligned-access
16347 @itemx -mno-unaligned-access
16348 @opindex munaligned-access
16349 @opindex mno-unaligned-access
16350 Enables (or disables) reading and writing of 16- and 32- bit values
16351 from addresses that are not 16- or 32- bit aligned.  By default
16352 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16353 ARMv8-M Baseline architectures, and enabled for all other
16354 architectures.  If unaligned access is not enabled then words in packed
16355 data structures are accessed a byte at a time.
16357 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16358 generated object file to either true or false, depending upon the
16359 setting of this option.  If unaligned access is enabled then the
16360 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16361 defined.
16363 @item -mneon-for-64bits
16364 @opindex mneon-for-64bits
16365 Enables using Neon to handle scalar 64-bits operations. This is
16366 disabled by default since the cost of moving data from core registers
16367 to Neon is high.
16369 @item -mslow-flash-data
16370 @opindex mslow-flash-data
16371 Assume loading data from flash is slower than fetching instruction.
16372 Therefore literal load is minimized for better performance.
16373 This option is only supported when compiling for ARMv7 M-profile and
16374 off by default.
16376 @item -masm-syntax-unified
16377 @opindex masm-syntax-unified
16378 Assume inline assembler is using unified asm syntax.  The default is
16379 currently off which implies divided syntax.  This option has no impact
16380 on Thumb2. However, this may change in future releases of GCC.
16381 Divided syntax should be considered deprecated.
16383 @item -mrestrict-it
16384 @opindex mrestrict-it
16385 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16386 IT blocks can only contain a single 16-bit instruction from a select
16387 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16389 @item -mprint-tune-info
16390 @opindex mprint-tune-info
16391 Print CPU tuning information as comment in assembler file.  This is
16392 an option used only for regression testing of the compiler and not
16393 intended for ordinary use in compiling code.  This option is disabled
16394 by default.
16396 @item -mverbose-cost-dump
16397 @opindex mverbose-cost-dump
16398 Enable verbose cost model dumping in the debug dump files.  This option is
16399 provided for use in debugging the compiler.
16401 @item -mpure-code
16402 @opindex mpure-code
16403 Do not allow constant data to be placed in code sections.
16404 Additionally, when compiling for ELF object format give all text sections the
16405 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16406 is only available when generating non-pic code for M-profile targets with the
16407 MOVT instruction.
16409 @item -mcmse
16410 @opindex mcmse
16411 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16412 Development Tools Engineering Specification", which can be found on
16413 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16414 @end table
16416 @node AVR Options
16417 @subsection AVR Options
16418 @cindex AVR Options
16420 These options are defined for AVR implementations:
16422 @table @gcctabopt
16423 @item -mmcu=@var{mcu}
16424 @opindex mmcu
16425 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16427 The default for this option is@tie{}@samp{avr2}.
16429 GCC supports the following AVR devices and ISAs:
16431 @include avr-mmcu.texi
16433 @item -mabsdata
16434 @opindex mabsdata
16436 Assume that all data in static storage can be accessed by LDS / STS
16437 instructions.  This option has only an effect on reduced Tiny devices like
16438 ATtiny40.  See also the @code{absdata}
16439 @ref{AVR Variable Attributes,variable attribute}.
16441 @item -maccumulate-args
16442 @opindex maccumulate-args
16443 Accumulate outgoing function arguments and acquire/release the needed
16444 stack space for outgoing function arguments once in function
16445 prologue/epilogue.  Without this option, outgoing arguments are pushed
16446 before calling a function and popped afterwards.
16448 Popping the arguments after the function call can be expensive on
16449 AVR so that accumulating the stack space might lead to smaller
16450 executables because arguments need not be removed from the
16451 stack after such a function call.
16453 This option can lead to reduced code size for functions that perform
16454 several calls to functions that get their arguments on the stack like
16455 calls to printf-like functions.
16457 @item -mbranch-cost=@var{cost}
16458 @opindex mbranch-cost
16459 Set the branch costs for conditional branch instructions to
16460 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16461 integers. The default branch cost is 0.
16463 @item -mcall-prologues
16464 @opindex mcall-prologues
16465 Functions prologues/epilogues are expanded as calls to appropriate
16466 subroutines.  Code size is smaller.
16468 @item -mgas-isr-prologues
16469 @opindex mgas-isr-prologues
16470 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16471 instruction supported by GNU Binutils.
16472 If this option is on, the feature can still be disabled for individual
16473 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16474 function attribute.  This feature is activated per default
16475 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16476 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16478 @item -mint8
16479 @opindex mint8
16480 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16481 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16482 and @code{long long} is 4 bytes.  Please note that this option does not
16483 conform to the C standards, but it results in smaller code
16484 size.
16486 @item -mmain-is-OS_task
16487 @opindex mmain-is-OS_task
16488 Do not save registers in @code{main}.  The effect is the same like
16489 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
16490 to @code{main}. It is activated per default if optimization is on.
16492 @item -mn-flash=@var{num}
16493 @opindex mn-flash
16494 Assume that the flash memory has a size of 
16495 @var{num} times 64@tie{}KiB.
16497 @item -mno-interrupts
16498 @opindex mno-interrupts
16499 Generated code is not compatible with hardware interrupts.
16500 Code size is smaller.
16502 @item -mrelax
16503 @opindex mrelax
16504 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16505 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16506 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16507 the assembler's command line and the @option{--relax} option to the
16508 linker's command line.
16510 Jump relaxing is performed by the linker because jump offsets are not
16511 known before code is located. Therefore, the assembler code generated by the
16512 compiler is the same, but the instructions in the executable may
16513 differ from instructions in the assembler code.
16515 Relaxing must be turned on if linker stubs are needed, see the
16516 section on @code{EIND} and linker stubs below.
16518 @item -mrmw
16519 @opindex mrmw
16520 Assume that the device supports the Read-Modify-Write
16521 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16523 @item -mshort-calls
16524 @opindex mshort-calls
16526 Assume that @code{RJMP} and @code{RCALL} can target the whole
16527 program memory.
16529 This option is used internally for multilib selection.  It is
16530 not an optimization option, and you don't need to set it by hand.
16532 @item -msp8
16533 @opindex msp8
16534 Treat the stack pointer register as an 8-bit register,
16535 i.e.@: assume the high byte of the stack pointer is zero.
16536 In general, you don't need to set this option by hand.
16538 This option is used internally by the compiler to select and
16539 build multilibs for architectures @code{avr2} and @code{avr25}.
16540 These architectures mix devices with and without @code{SPH}.
16541 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16542 the compiler driver adds or removes this option from the compiler
16543 proper's command line, because the compiler then knows if the device
16544 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16545 register or not.
16547 @item -mstrict-X
16548 @opindex mstrict-X
16549 Use address register @code{X} in a way proposed by the hardware.  This means
16550 that @code{X} is only used in indirect, post-increment or
16551 pre-decrement addressing.
16553 Without this option, the @code{X} register may be used in the same way
16554 as @code{Y} or @code{Z} which then is emulated by additional
16555 instructions.  
16556 For example, loading a value with @code{X+const} addressing with a
16557 small non-negative @code{const < 64} to a register @var{Rn} is
16558 performed as
16560 @example
16561 adiw r26, const   ; X += const
16562 ld   @var{Rn}, X        ; @var{Rn} = *X
16563 sbiw r26, const   ; X -= const
16564 @end example
16566 @item -mtiny-stack
16567 @opindex mtiny-stack
16568 Only change the lower 8@tie{}bits of the stack pointer.
16570 @item -mfract-convert-truncate
16571 @opindex mfract-convert-truncate
16572 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16574 @item -nodevicelib
16575 @opindex nodevicelib
16576 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16578 @item -Waddr-space-convert
16579 @opindex Waddr-space-convert
16580 Warn about conversions between address spaces in the case where the
16581 resulting address space is not contained in the incoming address space.
16583 @item -Wmisspelled-isr
16584 @opindex Wmisspelled-isr
16585 Warn if the ISR is misspelled, i.e. without __vector prefix.
16586 Enabled by default.
16587 @end table
16589 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16590 @cindex @code{EIND}
16591 Pointers in the implementation are 16@tie{}bits wide.
16592 The address of a function or label is represented as word address so
16593 that indirect jumps and calls can target any code address in the
16594 range of 64@tie{}Ki words.
16596 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16597 bytes of program memory space, there is a special function register called
16598 @code{EIND} that serves as most significant part of the target address
16599 when @code{EICALL} or @code{EIJMP} instructions are used.
16601 Indirect jumps and calls on these devices are handled as follows by
16602 the compiler and are subject to some limitations:
16604 @itemize @bullet
16606 @item
16607 The compiler never sets @code{EIND}.
16609 @item
16610 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16611 instructions or might read @code{EIND} directly in order to emulate an
16612 indirect call/jump by means of a @code{RET} instruction.
16614 @item
16615 The compiler assumes that @code{EIND} never changes during the startup
16616 code or during the application. In particular, @code{EIND} is not
16617 saved/restored in function or interrupt service routine
16618 prologue/epilogue.
16620 @item
16621 For indirect calls to functions and computed goto, the linker
16622 generates @emph{stubs}. Stubs are jump pads sometimes also called
16623 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16624 The stub contains a direct jump to the desired address.
16626 @item
16627 Linker relaxation must be turned on so that the linker generates
16628 the stubs correctly in all situations. See the compiler option
16629 @option{-mrelax} and the linker option @option{--relax}.
16630 There are corner cases where the linker is supposed to generate stubs
16631 but aborts without relaxation and without a helpful error message.
16633 @item
16634 The default linker script is arranged for code with @code{EIND = 0}.
16635 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16636 linker script has to be used in order to place the sections whose
16637 name start with @code{.trampolines} into the segment where @code{EIND}
16638 points to.
16640 @item
16641 The startup code from libgcc never sets @code{EIND}.
16642 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16643 For the impact of AVR-LibC on @code{EIND}, see the
16644 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16646 @item
16647 It is legitimate for user-specific startup code to set up @code{EIND}
16648 early, for example by means of initialization code located in
16649 section @code{.init3}. Such code runs prior to general startup code
16650 that initializes RAM and calls constructors, but after the bit
16651 of startup code from AVR-LibC that sets @code{EIND} to the segment
16652 where the vector table is located.
16653 @example
16654 #include <avr/io.h>
16656 static void
16657 __attribute__((section(".init3"),naked,used,no_instrument_function))
16658 init3_set_eind (void)
16660   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16661                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16663 @end example
16665 @noindent
16666 The @code{__trampolines_start} symbol is defined in the linker script.
16668 @item
16669 Stubs are generated automatically by the linker if
16670 the following two conditions are met:
16671 @itemize @minus
16673 @item The address of a label is taken by means of the @code{gs} modifier
16674 (short for @emph{generate stubs}) like so:
16675 @example
16676 LDI r24, lo8(gs(@var{func}))
16677 LDI r25, hi8(gs(@var{func}))
16678 @end example
16679 @item The final location of that label is in a code segment
16680 @emph{outside} the segment where the stubs are located.
16681 @end itemize
16683 @item
16684 The compiler emits such @code{gs} modifiers for code labels in the
16685 following situations:
16686 @itemize @minus
16687 @item Taking address of a function or code label.
16688 @item Computed goto.
16689 @item If prologue-save function is used, see @option{-mcall-prologues}
16690 command-line option.
16691 @item Switch/case dispatch tables. If you do not want such dispatch
16692 tables you can specify the @option{-fno-jump-tables} command-line option.
16693 @item C and C++ constructors/destructors called during startup/shutdown.
16694 @item If the tools hit a @code{gs()} modifier explained above.
16695 @end itemize
16697 @item
16698 Jumping to non-symbolic addresses like so is @emph{not} supported:
16700 @example
16701 int main (void)
16703     /* Call function at word address 0x2 */
16704     return ((int(*)(void)) 0x2)();
16706 @end example
16708 Instead, a stub has to be set up, i.e.@: the function has to be called
16709 through a symbol (@code{func_4} in the example):
16711 @example
16712 int main (void)
16714     extern int func_4 (void);
16716     /* Call function at byte address 0x4 */
16717     return func_4();
16719 @end example
16721 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16722 Alternatively, @code{func_4} can be defined in the linker script.
16723 @end itemize
16725 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16726 @cindex @code{RAMPD}
16727 @cindex @code{RAMPX}
16728 @cindex @code{RAMPY}
16729 @cindex @code{RAMPZ}
16730 Some AVR devices support memories larger than the 64@tie{}KiB range
16731 that can be accessed with 16-bit pointers.  To access memory locations
16732 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16733 register is used as high part of the address:
16734 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16735 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16736 register, respectively, to get a wide address. Similarly,
16737 @code{RAMPD} is used together with direct addressing.
16739 @itemize
16740 @item
16741 The startup code initializes the @code{RAMP} special function
16742 registers with zero.
16744 @item
16745 If a @ref{AVR Named Address Spaces,named address space} other than
16746 generic or @code{__flash} is used, then @code{RAMPZ} is set
16747 as needed before the operation.
16749 @item
16750 If the device supports RAM larger than 64@tie{}KiB and the compiler
16751 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16752 is reset to zero after the operation.
16754 @item
16755 If the device comes with a specific @code{RAMP} register, the ISR
16756 prologue/epilogue saves/restores that SFR and initializes it with
16757 zero in case the ISR code might (implicitly) use it.
16759 @item
16760 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16761 If you use inline assembler to read from locations outside the
16762 16-bit address range and change one of the @code{RAMP} registers,
16763 you must reset it to zero after the access.
16765 @end itemize
16767 @subsubsection AVR Built-in Macros
16769 GCC defines several built-in macros so that the user code can test
16770 for the presence or absence of features.  Almost any of the following
16771 built-in macros are deduced from device capabilities and thus
16772 triggered by the @option{-mmcu=} command-line option.
16774 For even more AVR-specific built-in macros see
16775 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16777 @table @code
16779 @item __AVR_ARCH__
16780 Build-in macro that resolves to a decimal number that identifies the
16781 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16782 Possible values are:
16784 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16785 @code{4}, @code{5}, @code{51}, @code{6}
16787 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16788 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16790 respectively and
16792 @code{100},
16793 @code{102}, @code{103}, @code{104},
16794 @code{105}, @code{106}, @code{107}
16796 for @var{mcu}=@code{avrtiny},
16797 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16798 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16799 If @var{mcu} specifies a device, this built-in macro is set
16800 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16801 defined to @code{4}.
16803 @item __AVR_@var{Device}__
16804 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16805 the device's name. For example, @option{-mmcu=atmega8} defines the
16806 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16807 @code{__AVR_ATtiny261A__}, etc.
16809 The built-in macros' names follow
16810 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16811 the device name as from the AVR user manual. The difference between
16812 @var{Device} in the built-in macro and @var{device} in
16813 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16815 If @var{device} is not a device but only a core architecture like
16816 @samp{avr51}, this macro is not defined.
16818 @item __AVR_DEVICE_NAME__
16819 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16820 the device's name. For example, with @option{-mmcu=atmega8} the macro
16821 is defined to @code{atmega8}.
16823 If @var{device} is not a device but only a core architecture like
16824 @samp{avr51}, this macro is not defined.
16826 @item __AVR_XMEGA__
16827 The device / architecture belongs to the XMEGA family of devices.
16829 @item __AVR_HAVE_ELPM__
16830 The device has the @code{ELPM} instruction.
16832 @item __AVR_HAVE_ELPMX__
16833 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16834 R@var{n},Z+} instructions.
16836 @item __AVR_HAVE_MOVW__
16837 The device has the @code{MOVW} instruction to perform 16-bit
16838 register-register moves.
16840 @item __AVR_HAVE_LPMX__
16841 The device has the @code{LPM R@var{n},Z} and
16842 @code{LPM R@var{n},Z+} instructions.
16844 @item __AVR_HAVE_MUL__
16845 The device has a hardware multiplier. 
16847 @item __AVR_HAVE_JMP_CALL__
16848 The device has the @code{JMP} and @code{CALL} instructions.
16849 This is the case for devices with more than 8@tie{}KiB of program
16850 memory.
16852 @item __AVR_HAVE_EIJMP_EICALL__
16853 @itemx __AVR_3_BYTE_PC__
16854 The device has the @code{EIJMP} and @code{EICALL} instructions.
16855 This is the case for devices with more than 128@tie{}KiB of program memory.
16856 This also means that the program counter
16857 (PC) is 3@tie{}bytes wide.
16859 @item __AVR_2_BYTE_PC__
16860 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16861 with up to 128@tie{}KiB of program memory.
16863 @item __AVR_HAVE_8BIT_SP__
16864 @itemx __AVR_HAVE_16BIT_SP__
16865 The stack pointer (SP) register is treated as 8-bit respectively
16866 16-bit register by the compiler.
16867 The definition of these macros is affected by @option{-mtiny-stack}.
16869 @item __AVR_HAVE_SPH__
16870 @itemx __AVR_SP8__
16871 The device has the SPH (high part of stack pointer) special function
16872 register or has an 8-bit stack pointer, respectively.
16873 The definition of these macros is affected by @option{-mmcu=} and
16874 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16875 by @option{-msp8}.
16877 @item __AVR_HAVE_RAMPD__
16878 @itemx __AVR_HAVE_RAMPX__
16879 @itemx __AVR_HAVE_RAMPY__
16880 @itemx __AVR_HAVE_RAMPZ__
16881 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16882 @code{RAMPZ} special function register, respectively.
16884 @item __NO_INTERRUPTS__
16885 This macro reflects the @option{-mno-interrupts} command-line option.
16887 @item __AVR_ERRATA_SKIP__
16888 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16889 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16890 instructions because of a hardware erratum.  Skip instructions are
16891 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16892 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16893 set.
16895 @item __AVR_ISA_RMW__
16896 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16898 @item __AVR_SFR_OFFSET__=@var{offset}
16899 Instructions that can address I/O special function registers directly
16900 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16901 address as if addressed by an instruction to access RAM like @code{LD}
16902 or @code{STS}. This offset depends on the device architecture and has
16903 to be subtracted from the RAM address in order to get the
16904 respective I/O@tie{}address.
16906 @item __AVR_SHORT_CALLS__
16907 The @option{-mshort-calls} command line option is set.
16909 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16910 Some devices support reading from flash memory by means of @code{LD*}
16911 instructions.  The flash memory is seen in the data address space
16912 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16913 is not defined, this feature is not available.  If defined,
16914 the address space is linear and there is no need to put
16915 @code{.rodata} into RAM.  This is handled by the default linker
16916 description file, and is currently available for
16917 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16918 there is no need to use address spaces like @code{__flash} or
16919 features like attribute @code{progmem} and @code{pgm_read_*}.
16921 @item __WITH_AVRLIBC__
16922 The compiler is configured to be used together with AVR-Libc.
16923 See the @option{--with-avrlibc} configure option.
16925 @end table
16927 @node Blackfin Options
16928 @subsection Blackfin Options
16929 @cindex Blackfin Options
16931 @table @gcctabopt
16932 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16933 @opindex mcpu=
16934 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16935 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16936 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16937 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16938 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16939 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16940 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16941 @samp{bf561}, @samp{bf592}.
16943 The optional @var{sirevision} specifies the silicon revision of the target
16944 Blackfin processor.  Any workarounds available for the targeted silicon revision
16945 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16946 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16947 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16948 hexadecimal digits representing the major and minor numbers in the silicon
16949 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16950 is not defined.  If @var{sirevision} is @samp{any}, the
16951 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16952 If this optional @var{sirevision} is not used, GCC assumes the latest known
16953 silicon revision of the targeted Blackfin processor.
16955 GCC defines a preprocessor macro for the specified @var{cpu}.
16956 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16957 provided by libgloss to be linked in if @option{-msim} is not given.
16959 Without this option, @samp{bf532} is used as the processor by default.
16961 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16962 only the preprocessor macro is defined.
16964 @item -msim
16965 @opindex msim
16966 Specifies that the program will be run on the simulator.  This causes
16967 the simulator BSP provided by libgloss to be linked in.  This option
16968 has effect only for @samp{bfin-elf} toolchain.
16969 Certain other options, such as @option{-mid-shared-library} and
16970 @option{-mfdpic}, imply @option{-msim}.
16972 @item -momit-leaf-frame-pointer
16973 @opindex momit-leaf-frame-pointer
16974 Don't keep the frame pointer in a register for leaf functions.  This
16975 avoids the instructions to save, set up and restore frame pointers and
16976 makes an extra register available in leaf functions.
16978 @item -mspecld-anomaly
16979 @opindex mspecld-anomaly
16980 When enabled, the compiler ensures that the generated code does not
16981 contain speculative loads after jump instructions. If this option is used,
16982 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16984 @item -mno-specld-anomaly
16985 @opindex mno-specld-anomaly
16986 Don't generate extra code to prevent speculative loads from occurring.
16988 @item -mcsync-anomaly
16989 @opindex mcsync-anomaly
16990 When enabled, the compiler ensures that the generated code does not
16991 contain CSYNC or SSYNC instructions too soon after conditional branches.
16992 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16994 @item -mno-csync-anomaly
16995 @opindex mno-csync-anomaly
16996 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16997 occurring too soon after a conditional branch.
16999 @item -mlow-64k
17000 @opindex mlow-64k
17001 When enabled, the compiler is free to take advantage of the knowledge that
17002 the entire program fits into the low 64k of memory.
17004 @item -mno-low-64k
17005 @opindex mno-low-64k
17006 Assume that the program is arbitrarily large.  This is the default.
17008 @item -mstack-check-l1
17009 @opindex mstack-check-l1
17010 Do stack checking using information placed into L1 scratchpad memory by the
17011 uClinux kernel.
17013 @item -mid-shared-library
17014 @opindex mid-shared-library
17015 Generate code that supports shared libraries via the library ID method.
17016 This allows for execute in place and shared libraries in an environment
17017 without virtual memory management.  This option implies @option{-fPIC}.
17018 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17020 @item -mno-id-shared-library
17021 @opindex mno-id-shared-library
17022 Generate code that doesn't assume ID-based shared libraries are being used.
17023 This is the default.
17025 @item -mleaf-id-shared-library
17026 @opindex mleaf-id-shared-library
17027 Generate code that supports shared libraries via the library ID method,
17028 but assumes that this library or executable won't link against any other
17029 ID shared libraries.  That allows the compiler to use faster code for jumps
17030 and calls.
17032 @item -mno-leaf-id-shared-library
17033 @opindex mno-leaf-id-shared-library
17034 Do not assume that the code being compiled won't link against any ID shared
17035 libraries.  Slower code is generated for jump and call insns.
17037 @item -mshared-library-id=n
17038 @opindex mshared-library-id
17039 Specifies the identification number of the ID-based shared library being
17040 compiled.  Specifying a value of 0 generates more compact code; specifying
17041 other values forces the allocation of that number to the current
17042 library but is no more space- or time-efficient than omitting this option.
17044 @item -msep-data
17045 @opindex msep-data
17046 Generate code that allows the data segment to be located in a different
17047 area of memory from the text segment.  This allows for execute in place in
17048 an environment without virtual memory management by eliminating relocations
17049 against the text section.
17051 @item -mno-sep-data
17052 @opindex mno-sep-data
17053 Generate code that assumes that the data segment follows the text segment.
17054 This is the default.
17056 @item -mlong-calls
17057 @itemx -mno-long-calls
17058 @opindex mlong-calls
17059 @opindex mno-long-calls
17060 Tells the compiler to perform function calls by first loading the
17061 address of the function into a register and then performing a subroutine
17062 call on this register.  This switch is needed if the target function
17063 lies outside of the 24-bit addressing range of the offset-based
17064 version of subroutine call instruction.
17066 This feature is not enabled by default.  Specifying
17067 @option{-mno-long-calls} restores the default behavior.  Note these
17068 switches have no effect on how the compiler generates code to handle
17069 function calls via function pointers.
17071 @item -mfast-fp
17072 @opindex mfast-fp
17073 Link with the fast floating-point library. This library relaxes some of
17074 the IEEE floating-point standard's rules for checking inputs against
17075 Not-a-Number (NAN), in the interest of performance.
17077 @item -minline-plt
17078 @opindex minline-plt
17079 Enable inlining of PLT entries in function calls to functions that are
17080 not known to bind locally.  It has no effect without @option{-mfdpic}.
17082 @item -mmulticore
17083 @opindex mmulticore
17084 Build a standalone application for multicore Blackfin processors. 
17085 This option causes proper start files and link scripts supporting 
17086 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17087 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17089 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17090 selects the one-application-per-core programming model.  Without
17091 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17092 programming model is used. In this model, the main function of Core B
17093 should be named as @code{coreb_main}.
17095 If this option is not used, the single-core application programming
17096 model is used.
17098 @item -mcorea
17099 @opindex mcorea
17100 Build a standalone application for Core A of BF561 when using
17101 the one-application-per-core programming model. Proper start files
17102 and link scripts are used to support Core A, and the macro
17103 @code{__BFIN_COREA} is defined.
17104 This option can only be used in conjunction with @option{-mmulticore}.
17106 @item -mcoreb
17107 @opindex mcoreb
17108 Build a standalone application for Core B of BF561 when using
17109 the one-application-per-core programming model. Proper start files
17110 and link scripts are used to support Core B, and the macro
17111 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17112 should be used instead of @code{main}. 
17113 This option can only be used in conjunction with @option{-mmulticore}.
17115 @item -msdram
17116 @opindex msdram
17117 Build a standalone application for SDRAM. Proper start files and
17118 link scripts are used to put the application into SDRAM, and the macro
17119 @code{__BFIN_SDRAM} is defined.
17120 The loader should initialize SDRAM before loading the application.
17122 @item -micplb
17123 @opindex micplb
17124 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17125 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17126 are enabled; for standalone applications the default is off.
17127 @end table
17129 @node C6X Options
17130 @subsection C6X Options
17131 @cindex C6X Options
17133 @table @gcctabopt
17134 @item -march=@var{name}
17135 @opindex march
17136 This specifies the name of the target architecture.  GCC uses this
17137 name to determine what kind of instructions it can emit when generating
17138 assembly code.  Permissible names are: @samp{c62x},
17139 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17141 @item -mbig-endian
17142 @opindex mbig-endian
17143 Generate code for a big-endian target.
17145 @item -mlittle-endian
17146 @opindex mlittle-endian
17147 Generate code for a little-endian target.  This is the default.
17149 @item -msim
17150 @opindex msim
17151 Choose startup files and linker script suitable for the simulator.
17153 @item -msdata=default
17154 @opindex msdata=default
17155 Put small global and static data in the @code{.neardata} section,
17156 which is pointed to by register @code{B14}.  Put small uninitialized
17157 global and static data in the @code{.bss} section, which is adjacent
17158 to the @code{.neardata} section.  Put small read-only data into the
17159 @code{.rodata} section.  The corresponding sections used for large
17160 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17162 @item -msdata=all
17163 @opindex msdata=all
17164 Put all data, not just small objects, into the sections reserved for
17165 small data, and use addressing relative to the @code{B14} register to
17166 access them.
17168 @item -msdata=none
17169 @opindex msdata=none
17170 Make no use of the sections reserved for small data, and use absolute
17171 addresses to access all data.  Put all initialized global and static
17172 data in the @code{.fardata} section, and all uninitialized data in the
17173 @code{.far} section.  Put all constant data into the @code{.const}
17174 section.
17175 @end table
17177 @node CRIS Options
17178 @subsection CRIS Options
17179 @cindex CRIS Options
17181 These options are defined specifically for the CRIS ports.
17183 @table @gcctabopt
17184 @item -march=@var{architecture-type}
17185 @itemx -mcpu=@var{architecture-type}
17186 @opindex march
17187 @opindex mcpu
17188 Generate code for the specified architecture.  The choices for
17189 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17190 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17191 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17192 @samp{v10}.
17194 @item -mtune=@var{architecture-type}
17195 @opindex mtune
17196 Tune to @var{architecture-type} everything applicable about the generated
17197 code, except for the ABI and the set of available instructions.  The
17198 choices for @var{architecture-type} are the same as for
17199 @option{-march=@var{architecture-type}}.
17201 @item -mmax-stack-frame=@var{n}
17202 @opindex mmax-stack-frame
17203 Warn when the stack frame of a function exceeds @var{n} bytes.
17205 @item -metrax4
17206 @itemx -metrax100
17207 @opindex metrax4
17208 @opindex metrax100
17209 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17210 @option{-march=v3} and @option{-march=v8} respectively.
17212 @item -mmul-bug-workaround
17213 @itemx -mno-mul-bug-workaround
17214 @opindex mmul-bug-workaround
17215 @opindex mno-mul-bug-workaround
17216 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17217 models where it applies.  This option is active by default.
17219 @item -mpdebug
17220 @opindex mpdebug
17221 Enable CRIS-specific verbose debug-related information in the assembly
17222 code.  This option also has the effect of turning off the @samp{#NO_APP}
17223 formatted-code indicator to the assembler at the beginning of the
17224 assembly file.
17226 @item -mcc-init
17227 @opindex mcc-init
17228 Do not use condition-code results from previous instruction; always emit
17229 compare and test instructions before use of condition codes.
17231 @item -mno-side-effects
17232 @opindex mno-side-effects
17233 Do not emit instructions with side effects in addressing modes other than
17234 post-increment.
17236 @item -mstack-align
17237 @itemx -mno-stack-align
17238 @itemx -mdata-align
17239 @itemx -mno-data-align
17240 @itemx -mconst-align
17241 @itemx -mno-const-align
17242 @opindex mstack-align
17243 @opindex mno-stack-align
17244 @opindex mdata-align
17245 @opindex mno-data-align
17246 @opindex mconst-align
17247 @opindex mno-const-align
17248 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17249 stack frame, individual data and constants to be aligned for the maximum
17250 single data access size for the chosen CPU model.  The default is to
17251 arrange for 32-bit alignment.  ABI details such as structure layout are
17252 not affected by these options.
17254 @item -m32-bit
17255 @itemx -m16-bit
17256 @itemx -m8-bit
17257 @opindex m32-bit
17258 @opindex m16-bit
17259 @opindex m8-bit
17260 Similar to the stack- data- and const-align options above, these options
17261 arrange for stack frame, writable data and constants to all be 32-bit,
17262 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17264 @item -mno-prologue-epilogue
17265 @itemx -mprologue-epilogue
17266 @opindex mno-prologue-epilogue
17267 @opindex mprologue-epilogue
17268 With @option{-mno-prologue-epilogue}, the normal function prologue and
17269 epilogue which set up the stack frame are omitted and no return
17270 instructions or return sequences are generated in the code.  Use this
17271 option only together with visual inspection of the compiled code: no
17272 warnings or errors are generated when call-saved registers must be saved,
17273 or storage for local variables needs to be allocated.
17275 @item -mno-gotplt
17276 @itemx -mgotplt
17277 @opindex mno-gotplt
17278 @opindex mgotplt
17279 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17280 instruction sequences that load addresses for functions from the PLT part
17281 of the GOT rather than (traditional on other architectures) calls to the
17282 PLT@.  The default is @option{-mgotplt}.
17284 @item -melf
17285 @opindex melf
17286 Legacy no-op option only recognized with the cris-axis-elf and
17287 cris-axis-linux-gnu targets.
17289 @item -mlinux
17290 @opindex mlinux
17291 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17293 @item -sim
17294 @opindex sim
17295 This option, recognized for the cris-axis-elf, arranges
17296 to link with input-output functions from a simulator library.  Code,
17297 initialized data and zero-initialized data are allocated consecutively.
17299 @item -sim2
17300 @opindex sim2
17301 Like @option{-sim}, but pass linker options to locate initialized data at
17302 0x40000000 and zero-initialized data at 0x80000000.
17303 @end table
17305 @node CR16 Options
17306 @subsection CR16 Options
17307 @cindex CR16 Options
17309 These options are defined specifically for the CR16 ports.
17311 @table @gcctabopt
17313 @item -mmac
17314 @opindex mmac
17315 Enable the use of multiply-accumulate instructions. Disabled by default.
17317 @item -mcr16cplus
17318 @itemx -mcr16c
17319 @opindex mcr16cplus
17320 @opindex mcr16c
17321 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17322 is default.
17324 @item -msim
17325 @opindex msim
17326 Links the library libsim.a which is in compatible with simulator. Applicable
17327 to ELF compiler only.
17329 @item -mint32
17330 @opindex mint32
17331 Choose integer type as 32-bit wide.
17333 @item -mbit-ops
17334 @opindex mbit-ops
17335 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17337 @item -mdata-model=@var{model}
17338 @opindex mdata-model
17339 Choose a data model. The choices for @var{model} are @samp{near},
17340 @samp{far} or @samp{medium}. @samp{medium} is default.
17341 However, @samp{far} is not valid with @option{-mcr16c}, as the
17342 CR16C architecture does not support the far data model.
17343 @end table
17345 @node Darwin Options
17346 @subsection Darwin Options
17347 @cindex Darwin options
17349 These options are defined for all architectures running the Darwin operating
17350 system.
17352 FSF GCC on Darwin does not create ``fat'' object files; it creates
17353 an object file for the single architecture that GCC was built to
17354 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17355 @option{-arch} options are used; it does so by running the compiler or
17356 linker multiple times and joining the results together with
17357 @file{lipo}.
17359 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17360 @samp{i686}) is determined by the flags that specify the ISA
17361 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17362 @option{-force_cpusubtype_ALL} option can be used to override this.
17364 The Darwin tools vary in their behavior when presented with an ISA
17365 mismatch.  The assembler, @file{as}, only permits instructions to
17366 be used that are valid for the subtype of the file it is generating,
17367 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17368 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17369 and prints an error if asked to create a shared library with a less
17370 restrictive subtype than its input files (for instance, trying to put
17371 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17372 for executables, @command{ld}, quietly gives the executable the most
17373 restrictive subtype of any of its input files.
17375 @table @gcctabopt
17376 @item -F@var{dir}
17377 @opindex F
17378 Add the framework directory @var{dir} to the head of the list of
17379 directories to be searched for header files.  These directories are
17380 interleaved with those specified by @option{-I} options and are
17381 scanned in a left-to-right order.
17383 A framework directory is a directory with frameworks in it.  A
17384 framework is a directory with a @file{Headers} and/or
17385 @file{PrivateHeaders} directory contained directly in it that ends
17386 in @file{.framework}.  The name of a framework is the name of this
17387 directory excluding the @file{.framework}.  Headers associated with
17388 the framework are found in one of those two directories, with
17389 @file{Headers} being searched first.  A subframework is a framework
17390 directory that is in a framework's @file{Frameworks} directory.
17391 Includes of subframework headers can only appear in a header of a
17392 framework that contains the subframework, or in a sibling subframework
17393 header.  Two subframeworks are siblings if they occur in the same
17394 framework.  A subframework should not have the same name as a
17395 framework; a warning is issued if this is violated.  Currently a
17396 subframework cannot have subframeworks; in the future, the mechanism
17397 may be extended to support this.  The standard frameworks can be found
17398 in @file{/System/Library/Frameworks} and
17399 @file{/Library/Frameworks}.  An example include looks like
17400 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17401 the name of the framework and @file{header.h} is found in the
17402 @file{PrivateHeaders} or @file{Headers} directory.
17404 @item -iframework@var{dir}
17405 @opindex iframework
17406 Like @option{-F} except the directory is a treated as a system
17407 directory.  The main difference between this @option{-iframework} and
17408 @option{-F} is that with @option{-iframework} the compiler does not
17409 warn about constructs contained within header files found via
17410 @var{dir}.  This option is valid only for the C family of languages.
17412 @item -gused
17413 @opindex gused
17414 Emit debugging information for symbols that are used.  For stabs
17415 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17416 This is by default ON@.
17418 @item -gfull
17419 @opindex gfull
17420 Emit debugging information for all symbols and types.
17422 @item -mmacosx-version-min=@var{version}
17423 The earliest version of MacOS X that this executable will run on
17424 is @var{version}.  Typical values of @var{version} include @code{10.1},
17425 @code{10.2}, and @code{10.3.9}.
17427 If the compiler was built to use the system's headers by default,
17428 then the default for this option is the system version on which the
17429 compiler is running, otherwise the default is to make choices that
17430 are compatible with as many systems and code bases as possible.
17432 @item -mkernel
17433 @opindex mkernel
17434 Enable kernel development mode.  The @option{-mkernel} option sets
17435 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17436 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17437 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17438 applicable.  This mode also sets @option{-mno-altivec},
17439 @option{-msoft-float}, @option{-fno-builtin} and
17440 @option{-mlong-branch} for PowerPC targets.
17442 @item -mone-byte-bool
17443 @opindex mone-byte-bool
17444 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17445 By default @code{sizeof(bool)} is @code{4} when compiling for
17446 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17447 option has no effect on x86.
17449 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17450 to generate code that is not binary compatible with code generated
17451 without that switch.  Using this switch may require recompiling all
17452 other modules in a program, including system libraries.  Use this
17453 switch to conform to a non-default data model.
17455 @item -mfix-and-continue
17456 @itemx -ffix-and-continue
17457 @itemx -findirect-data
17458 @opindex mfix-and-continue
17459 @opindex ffix-and-continue
17460 @opindex findirect-data
17461 Generate code suitable for fast turnaround development, such as to
17462 allow GDB to dynamically load @file{.o} files into already-running
17463 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17464 are provided for backwards compatibility.
17466 @item -all_load
17467 @opindex all_load
17468 Loads all members of static archive libraries.
17469 See man ld(1) for more information.
17471 @item -arch_errors_fatal
17472 @opindex arch_errors_fatal
17473 Cause the errors having to do with files that have the wrong architecture
17474 to be fatal.
17476 @item -bind_at_load
17477 @opindex bind_at_load
17478 Causes the output file to be marked such that the dynamic linker will
17479 bind all undefined references when the file is loaded or launched.
17481 @item -bundle
17482 @opindex bundle
17483 Produce a Mach-o bundle format file.
17484 See man ld(1) for more information.
17486 @item -bundle_loader @var{executable}
17487 @opindex bundle_loader
17488 This option specifies the @var{executable} that will load the build
17489 output file being linked.  See man ld(1) for more information.
17491 @item -dynamiclib
17492 @opindex dynamiclib
17493 When passed this option, GCC produces a dynamic library instead of
17494 an executable when linking, using the Darwin @file{libtool} command.
17496 @item -force_cpusubtype_ALL
17497 @opindex force_cpusubtype_ALL
17498 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17499 one controlled by the @option{-mcpu} or @option{-march} option.
17501 @item -allowable_client  @var{client_name}
17502 @itemx -client_name
17503 @itemx -compatibility_version
17504 @itemx -current_version
17505 @itemx -dead_strip
17506 @itemx -dependency-file
17507 @itemx -dylib_file
17508 @itemx -dylinker_install_name
17509 @itemx -dynamic
17510 @itemx -exported_symbols_list
17511 @itemx -filelist
17512 @need 800
17513 @itemx -flat_namespace
17514 @itemx -force_flat_namespace
17515 @itemx -headerpad_max_install_names
17516 @itemx -image_base
17517 @itemx -init
17518 @itemx -install_name
17519 @itemx -keep_private_externs
17520 @itemx -multi_module
17521 @itemx -multiply_defined
17522 @itemx -multiply_defined_unused
17523 @need 800
17524 @itemx -noall_load
17525 @itemx -no_dead_strip_inits_and_terms
17526 @itemx -nofixprebinding
17527 @itemx -nomultidefs
17528 @itemx -noprebind
17529 @itemx -noseglinkedit
17530 @itemx -pagezero_size
17531 @itemx -prebind
17532 @itemx -prebind_all_twolevel_modules
17533 @itemx -private_bundle
17534 @need 800
17535 @itemx -read_only_relocs
17536 @itemx -sectalign
17537 @itemx -sectobjectsymbols
17538 @itemx -whyload
17539 @itemx -seg1addr
17540 @itemx -sectcreate
17541 @itemx -sectobjectsymbols
17542 @itemx -sectorder
17543 @itemx -segaddr
17544 @itemx -segs_read_only_addr
17545 @need 800
17546 @itemx -segs_read_write_addr
17547 @itemx -seg_addr_table
17548 @itemx -seg_addr_table_filename
17549 @itemx -seglinkedit
17550 @itemx -segprot
17551 @itemx -segs_read_only_addr
17552 @itemx -segs_read_write_addr
17553 @itemx -single_module
17554 @itemx -static
17555 @itemx -sub_library
17556 @need 800
17557 @itemx -sub_umbrella
17558 @itemx -twolevel_namespace
17559 @itemx -umbrella
17560 @itemx -undefined
17561 @itemx -unexported_symbols_list
17562 @itemx -weak_reference_mismatches
17563 @itemx -whatsloaded
17564 @opindex allowable_client
17565 @opindex client_name
17566 @opindex compatibility_version
17567 @opindex current_version
17568 @opindex dead_strip
17569 @opindex dependency-file
17570 @opindex dylib_file
17571 @opindex dylinker_install_name
17572 @opindex dynamic
17573 @opindex exported_symbols_list
17574 @opindex filelist
17575 @opindex flat_namespace
17576 @opindex force_flat_namespace
17577 @opindex headerpad_max_install_names
17578 @opindex image_base
17579 @opindex init
17580 @opindex install_name
17581 @opindex keep_private_externs
17582 @opindex multi_module
17583 @opindex multiply_defined
17584 @opindex multiply_defined_unused
17585 @opindex noall_load
17586 @opindex no_dead_strip_inits_and_terms
17587 @opindex nofixprebinding
17588 @opindex nomultidefs
17589 @opindex noprebind
17590 @opindex noseglinkedit
17591 @opindex pagezero_size
17592 @opindex prebind
17593 @opindex prebind_all_twolevel_modules
17594 @opindex private_bundle
17595 @opindex read_only_relocs
17596 @opindex sectalign
17597 @opindex sectobjectsymbols
17598 @opindex whyload
17599 @opindex seg1addr
17600 @opindex sectcreate
17601 @opindex sectobjectsymbols
17602 @opindex sectorder
17603 @opindex segaddr
17604 @opindex segs_read_only_addr
17605 @opindex segs_read_write_addr
17606 @opindex seg_addr_table
17607 @opindex seg_addr_table_filename
17608 @opindex seglinkedit
17609 @opindex segprot
17610 @opindex segs_read_only_addr
17611 @opindex segs_read_write_addr
17612 @opindex single_module
17613 @opindex static
17614 @opindex sub_library
17615 @opindex sub_umbrella
17616 @opindex twolevel_namespace
17617 @opindex umbrella
17618 @opindex undefined
17619 @opindex unexported_symbols_list
17620 @opindex weak_reference_mismatches
17621 @opindex whatsloaded
17622 These options are passed to the Darwin linker.  The Darwin linker man page
17623 describes them in detail.
17624 @end table
17626 @node DEC Alpha Options
17627 @subsection DEC Alpha Options
17629 These @samp{-m} options are defined for the DEC Alpha implementations:
17631 @table @gcctabopt
17632 @item -mno-soft-float
17633 @itemx -msoft-float
17634 @opindex mno-soft-float
17635 @opindex msoft-float
17636 Use (do not use) the hardware floating-point instructions for
17637 floating-point operations.  When @option{-msoft-float} is specified,
17638 functions in @file{libgcc.a} are used to perform floating-point
17639 operations.  Unless they are replaced by routines that emulate the
17640 floating-point operations, or compiled in such a way as to call such
17641 emulations routines, these routines issue floating-point
17642 operations.   If you are compiling for an Alpha without floating-point
17643 operations, you must ensure that the library is built so as not to call
17644 them.
17646 Note that Alpha implementations without floating-point operations are
17647 required to have floating-point registers.
17649 @item -mfp-reg
17650 @itemx -mno-fp-regs
17651 @opindex mfp-reg
17652 @opindex mno-fp-regs
17653 Generate code that uses (does not use) the floating-point register set.
17654 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17655 register set is not used, floating-point operands are passed in integer
17656 registers as if they were integers and floating-point results are passed
17657 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17658 so any function with a floating-point argument or return value called by code
17659 compiled with @option{-mno-fp-regs} must also be compiled with that
17660 option.
17662 A typical use of this option is building a kernel that does not use,
17663 and hence need not save and restore, any floating-point registers.
17665 @item -mieee
17666 @opindex mieee
17667 The Alpha architecture implements floating-point hardware optimized for
17668 maximum performance.  It is mostly compliant with the IEEE floating-point
17669 standard.  However, for full compliance, software assistance is
17670 required.  This option generates code fully IEEE-compliant code
17671 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17672 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17673 defined during compilation.  The resulting code is less efficient but is
17674 able to correctly support denormalized numbers and exceptional IEEE
17675 values such as not-a-number and plus/minus infinity.  Other Alpha
17676 compilers call this option @option{-ieee_with_no_inexact}.
17678 @item -mieee-with-inexact
17679 @opindex mieee-with-inexact
17680 This is like @option{-mieee} except the generated code also maintains
17681 the IEEE @var{inexact-flag}.  Turning on this option causes the
17682 generated code to implement fully-compliant IEEE math.  In addition to
17683 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17684 macro.  On some Alpha implementations the resulting code may execute
17685 significantly slower than the code generated by default.  Since there is
17686 very little code that depends on the @var{inexact-flag}, you should
17687 normally not specify this option.  Other Alpha compilers call this
17688 option @option{-ieee_with_inexact}.
17690 @item -mfp-trap-mode=@var{trap-mode}
17691 @opindex mfp-trap-mode
17692 This option controls what floating-point related traps are enabled.
17693 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17694 The trap mode can be set to one of four values:
17696 @table @samp
17697 @item n
17698 This is the default (normal) setting.  The only traps that are enabled
17699 are the ones that cannot be disabled in software (e.g., division by zero
17700 trap).
17702 @item u
17703 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17704 as well.
17706 @item su
17707 Like @samp{u}, but the instructions are marked to be safe for software
17708 completion (see Alpha architecture manual for details).
17710 @item sui
17711 Like @samp{su}, but inexact traps are enabled as well.
17712 @end table
17714 @item -mfp-rounding-mode=@var{rounding-mode}
17715 @opindex mfp-rounding-mode
17716 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17717 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17720 @table @samp
17721 @item n
17722 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17723 the nearest machine number or towards the even machine number in case
17724 of a tie.
17726 @item m
17727 Round towards minus infinity.
17729 @item c
17730 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17732 @item d
17733 Dynamic rounding mode.  A field in the floating-point control register
17734 (@var{fpcr}, see Alpha architecture reference manual) controls the
17735 rounding mode in effect.  The C library initializes this register for
17736 rounding towards plus infinity.  Thus, unless your program modifies the
17737 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17738 @end table
17740 @item -mtrap-precision=@var{trap-precision}
17741 @opindex mtrap-precision
17742 In the Alpha architecture, floating-point traps are imprecise.  This
17743 means without software assistance it is impossible to recover from a
17744 floating trap and program execution normally needs to be terminated.
17745 GCC can generate code that can assist operating system trap handlers
17746 in determining the exact location that caused a floating-point trap.
17747 Depending on the requirements of an application, different levels of
17748 precisions can be selected:
17750 @table @samp
17751 @item p
17752 Program precision.  This option is the default and means a trap handler
17753 can only identify which program caused a floating-point exception.
17755 @item f
17756 Function precision.  The trap handler can determine the function that
17757 caused a floating-point exception.
17759 @item i
17760 Instruction precision.  The trap handler can determine the exact
17761 instruction that caused a floating-point exception.
17762 @end table
17764 Other Alpha compilers provide the equivalent options called
17765 @option{-scope_safe} and @option{-resumption_safe}.
17767 @item -mieee-conformant
17768 @opindex mieee-conformant
17769 This option marks the generated code as IEEE conformant.  You must not
17770 use this option unless you also specify @option{-mtrap-precision=i} and either
17771 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17772 is to emit the line @samp{.eflag 48} in the function prologue of the
17773 generated assembly file.
17775 @item -mbuild-constants
17776 @opindex mbuild-constants
17777 Normally GCC examines a 32- or 64-bit integer constant to
17778 see if it can construct it from smaller constants in two or three
17779 instructions.  If it cannot, it outputs the constant as a literal and
17780 generates code to load it from the data segment at run time.
17782 Use this option to require GCC to construct @emph{all} integer constants
17783 using code, even if it takes more instructions (the maximum is six).
17785 You typically use this option to build a shared library dynamic
17786 loader.  Itself a shared library, it must relocate itself in memory
17787 before it can find the variables and constants in its own data segment.
17789 @item -mbwx
17790 @itemx -mno-bwx
17791 @itemx -mcix
17792 @itemx -mno-cix
17793 @itemx -mfix
17794 @itemx -mno-fix
17795 @itemx -mmax
17796 @itemx -mno-max
17797 @opindex mbwx
17798 @opindex mno-bwx
17799 @opindex mcix
17800 @opindex mno-cix
17801 @opindex mfix
17802 @opindex mno-fix
17803 @opindex mmax
17804 @opindex mno-max
17805 Indicate whether GCC should generate code to use the optional BWX,
17806 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17807 sets supported by the CPU type specified via @option{-mcpu=} option or that
17808 of the CPU on which GCC was built if none is specified.
17810 @item -mfloat-vax
17811 @itemx -mfloat-ieee
17812 @opindex mfloat-vax
17813 @opindex mfloat-ieee
17814 Generate code that uses (does not use) VAX F and G floating-point
17815 arithmetic instead of IEEE single and double precision.
17817 @item -mexplicit-relocs
17818 @itemx -mno-explicit-relocs
17819 @opindex mexplicit-relocs
17820 @opindex mno-explicit-relocs
17821 Older Alpha assemblers provided no way to generate symbol relocations
17822 except via assembler macros.  Use of these macros does not allow
17823 optimal instruction scheduling.  GNU binutils as of version 2.12
17824 supports a new syntax that allows the compiler to explicitly mark
17825 which relocations should apply to which instructions.  This option
17826 is mostly useful for debugging, as GCC detects the capabilities of
17827 the assembler when it is built and sets the default accordingly.
17829 @item -msmall-data
17830 @itemx -mlarge-data
17831 @opindex msmall-data
17832 @opindex mlarge-data
17833 When @option{-mexplicit-relocs} is in effect, static data is
17834 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17835 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17836 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17837 16-bit relocations off of the @code{$gp} register.  This limits the
17838 size of the small data area to 64KB, but allows the variables to be
17839 directly accessed via a single instruction.
17841 The default is @option{-mlarge-data}.  With this option the data area
17842 is limited to just below 2GB@.  Programs that require more than 2GB of
17843 data must use @code{malloc} or @code{mmap} to allocate the data in the
17844 heap instead of in the program's data segment.
17846 When generating code for shared libraries, @option{-fpic} implies
17847 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17849 @item -msmall-text
17850 @itemx -mlarge-text
17851 @opindex msmall-text
17852 @opindex mlarge-text
17853 When @option{-msmall-text} is used, the compiler assumes that the
17854 code of the entire program (or shared library) fits in 4MB, and is
17855 thus reachable with a branch instruction.  When @option{-msmall-data}
17856 is used, the compiler can assume that all local symbols share the
17857 same @code{$gp} value, and thus reduce the number of instructions
17858 required for a function call from 4 to 1.
17860 The default is @option{-mlarge-text}.
17862 @item -mcpu=@var{cpu_type}
17863 @opindex mcpu
17864 Set the instruction set and instruction scheduling parameters for
17865 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17866 style name or the corresponding chip number.  GCC supports scheduling
17867 parameters for the EV4, EV5 and EV6 family of processors and
17868 chooses the default values for the instruction set from the processor
17869 you specify.  If you do not specify a processor type, GCC defaults
17870 to the processor on which the compiler was built.
17872 Supported values for @var{cpu_type} are
17874 @table @samp
17875 @item ev4
17876 @itemx ev45
17877 @itemx 21064
17878 Schedules as an EV4 and has no instruction set extensions.
17880 @item ev5
17881 @itemx 21164
17882 Schedules as an EV5 and has no instruction set extensions.
17884 @item ev56
17885 @itemx 21164a
17886 Schedules as an EV5 and supports the BWX extension.
17888 @item pca56
17889 @itemx 21164pc
17890 @itemx 21164PC
17891 Schedules as an EV5 and supports the BWX and MAX extensions.
17893 @item ev6
17894 @itemx 21264
17895 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17897 @item ev67
17898 @itemx 21264a
17899 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17900 @end table
17902 Native toolchains also support the value @samp{native},
17903 which selects the best architecture option for the host processor.
17904 @option{-mcpu=native} has no effect if GCC does not recognize
17905 the processor.
17907 @item -mtune=@var{cpu_type}
17908 @opindex mtune
17909 Set only the instruction scheduling parameters for machine type
17910 @var{cpu_type}.  The instruction set is not changed.
17912 Native toolchains also support the value @samp{native},
17913 which selects the best architecture option for the host processor.
17914 @option{-mtune=native} has no effect if GCC does not recognize
17915 the processor.
17917 @item -mmemory-latency=@var{time}
17918 @opindex mmemory-latency
17919 Sets the latency the scheduler should assume for typical memory
17920 references as seen by the application.  This number is highly
17921 dependent on the memory access patterns used by the application
17922 and the size of the external cache on the machine.
17924 Valid options for @var{time} are
17926 @table @samp
17927 @item @var{number}
17928 A decimal number representing clock cycles.
17930 @item L1
17931 @itemx L2
17932 @itemx L3
17933 @itemx main
17934 The compiler contains estimates of the number of clock cycles for
17935 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17936 (also called Dcache, Scache, and Bcache), as well as to main memory.
17937 Note that L3 is only valid for EV5.
17939 @end table
17940 @end table
17942 @node FR30 Options
17943 @subsection FR30 Options
17944 @cindex FR30 Options
17946 These options are defined specifically for the FR30 port.
17948 @table @gcctabopt
17950 @item -msmall-model
17951 @opindex msmall-model
17952 Use the small address space model.  This can produce smaller code, but
17953 it does assume that all symbolic values and addresses fit into a
17954 20-bit range.
17956 @item -mno-lsim
17957 @opindex mno-lsim
17958 Assume that runtime support has been provided and so there is no need
17959 to include the simulator library (@file{libsim.a}) on the linker
17960 command line.
17962 @end table
17964 @node FT32 Options
17965 @subsection FT32 Options
17966 @cindex FT32 Options
17968 These options are defined specifically for the FT32 port.
17970 @table @gcctabopt
17972 @item -msim
17973 @opindex msim
17974 Specifies that the program will be run on the simulator.  This causes
17975 an alternate runtime startup and library to be linked.
17976 You must not use this option when generating programs that will run on
17977 real hardware; you must provide your own runtime library for whatever
17978 I/O functions are needed.
17980 @item -mlra
17981 @opindex mlra
17982 Enable Local Register Allocation.  This is still experimental for FT32,
17983 so by default the compiler uses standard reload.
17985 @item -mnodiv
17986 @opindex mnodiv
17987 Do not use div and mod instructions.
17989 @item -mft32b
17990 @opindex mft32b
17991 Enable use of the extended instructions of the FT32B processor.
17993 @item -mcompress
17994 @opindex mcompress
17995 Compress all code using the Ft32B code compression scheme.
17997 @item -mnopm
17998 @opindex  mnopm
17999 Do not generate code that reads program memory.
18001 @end table
18003 @node FRV Options
18004 @subsection FRV Options
18005 @cindex FRV Options
18007 @table @gcctabopt
18008 @item -mgpr-32
18009 @opindex mgpr-32
18011 Only use the first 32 general-purpose registers.
18013 @item -mgpr-64
18014 @opindex mgpr-64
18016 Use all 64 general-purpose registers.
18018 @item -mfpr-32
18019 @opindex mfpr-32
18021 Use only the first 32 floating-point registers.
18023 @item -mfpr-64
18024 @opindex mfpr-64
18026 Use all 64 floating-point registers.
18028 @item -mhard-float
18029 @opindex mhard-float
18031 Use hardware instructions for floating-point operations.
18033 @item -msoft-float
18034 @opindex msoft-float
18036 Use library routines for floating-point operations.
18038 @item -malloc-cc
18039 @opindex malloc-cc
18041 Dynamically allocate condition code registers.
18043 @item -mfixed-cc
18044 @opindex mfixed-cc
18046 Do not try to dynamically allocate condition code registers, only
18047 use @code{icc0} and @code{fcc0}.
18049 @item -mdword
18050 @opindex mdword
18052 Change ABI to use double word insns.
18054 @item -mno-dword
18055 @opindex mno-dword
18057 Do not use double word instructions.
18059 @item -mdouble
18060 @opindex mdouble
18062 Use floating-point double instructions.
18064 @item -mno-double
18065 @opindex mno-double
18067 Do not use floating-point double instructions.
18069 @item -mmedia
18070 @opindex mmedia
18072 Use media instructions.
18074 @item -mno-media
18075 @opindex mno-media
18077 Do not use media instructions.
18079 @item -mmuladd
18080 @opindex mmuladd
18082 Use multiply and add/subtract instructions.
18084 @item -mno-muladd
18085 @opindex mno-muladd
18087 Do not use multiply and add/subtract instructions.
18089 @item -mfdpic
18090 @opindex mfdpic
18092 Select the FDPIC ABI, which uses function descriptors to represent
18093 pointers to functions.  Without any PIC/PIE-related options, it
18094 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18095 assumes GOT entries and small data are within a 12-bit range from the
18096 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18097 are computed with 32 bits.
18098 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18100 @item -minline-plt
18101 @opindex minline-plt
18103 Enable inlining of PLT entries in function calls to functions that are
18104 not known to bind locally.  It has no effect without @option{-mfdpic}.
18105 It's enabled by default if optimizing for speed and compiling for
18106 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18107 optimization option such as @option{-O3} or above is present in the
18108 command line.
18110 @item -mTLS
18111 @opindex mTLS
18113 Assume a large TLS segment when generating thread-local code.
18115 @item -mtls
18116 @opindex mtls
18118 Do not assume a large TLS segment when generating thread-local code.
18120 @item -mgprel-ro
18121 @opindex mgprel-ro
18123 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18124 that is known to be in read-only sections.  It's enabled by default,
18125 except for @option{-fpic} or @option{-fpie}: even though it may help
18126 make the global offset table smaller, it trades 1 instruction for 4.
18127 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18128 one of which may be shared by multiple symbols, and it avoids the need
18129 for a GOT entry for the referenced symbol, so it's more likely to be a
18130 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18132 @item -multilib-library-pic
18133 @opindex multilib-library-pic
18135 Link with the (library, not FD) pic libraries.  It's implied by
18136 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18137 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18138 it explicitly.
18140 @item -mlinked-fp
18141 @opindex mlinked-fp
18143 Follow the EABI requirement of always creating a frame pointer whenever
18144 a stack frame is allocated.  This option is enabled by default and can
18145 be disabled with @option{-mno-linked-fp}.
18147 @item -mlong-calls
18148 @opindex mlong-calls
18150 Use indirect addressing to call functions outside the current
18151 compilation unit.  This allows the functions to be placed anywhere
18152 within the 32-bit address space.
18154 @item -malign-labels
18155 @opindex malign-labels
18157 Try to align labels to an 8-byte boundary by inserting NOPs into the
18158 previous packet.  This option only has an effect when VLIW packing
18159 is enabled.  It doesn't create new packets; it merely adds NOPs to
18160 existing ones.
18162 @item -mlibrary-pic
18163 @opindex mlibrary-pic
18165 Generate position-independent EABI code.
18167 @item -macc-4
18168 @opindex macc-4
18170 Use only the first four media accumulator registers.
18172 @item -macc-8
18173 @opindex macc-8
18175 Use all eight media accumulator registers.
18177 @item -mpack
18178 @opindex mpack
18180 Pack VLIW instructions.
18182 @item -mno-pack
18183 @opindex mno-pack
18185 Do not pack VLIW instructions.
18187 @item -mno-eflags
18188 @opindex mno-eflags
18190 Do not mark ABI switches in e_flags.
18192 @item -mcond-move
18193 @opindex mcond-move
18195 Enable the use of conditional-move instructions (default).
18197 This switch is mainly for debugging the compiler and will likely be removed
18198 in a future version.
18200 @item -mno-cond-move
18201 @opindex mno-cond-move
18203 Disable the use of conditional-move instructions.
18205 This switch is mainly for debugging the compiler and will likely be removed
18206 in a future version.
18208 @item -mscc
18209 @opindex mscc
18211 Enable the use of conditional set instructions (default).
18213 This switch is mainly for debugging the compiler and will likely be removed
18214 in a future version.
18216 @item -mno-scc
18217 @opindex mno-scc
18219 Disable the use of conditional set instructions.
18221 This switch is mainly for debugging the compiler and will likely be removed
18222 in a future version.
18224 @item -mcond-exec
18225 @opindex mcond-exec
18227 Enable the use of conditional execution (default).
18229 This switch is mainly for debugging the compiler and will likely be removed
18230 in a future version.
18232 @item -mno-cond-exec
18233 @opindex mno-cond-exec
18235 Disable the use of conditional execution.
18237 This switch is mainly for debugging the compiler and will likely be removed
18238 in a future version.
18240 @item -mvliw-branch
18241 @opindex mvliw-branch
18243 Run a pass to pack branches into VLIW instructions (default).
18245 This switch is mainly for debugging the compiler and will likely be removed
18246 in a future version.
18248 @item -mno-vliw-branch
18249 @opindex mno-vliw-branch
18251 Do not run a pass to pack branches into VLIW instructions.
18253 This switch is mainly for debugging the compiler and will likely be removed
18254 in a future version.
18256 @item -mmulti-cond-exec
18257 @opindex mmulti-cond-exec
18259 Enable optimization of @code{&&} and @code{||} in conditional execution
18260 (default).
18262 This switch is mainly for debugging the compiler and will likely be removed
18263 in a future version.
18265 @item -mno-multi-cond-exec
18266 @opindex mno-multi-cond-exec
18268 Disable optimization of @code{&&} and @code{||} in conditional execution.
18270 This switch is mainly for debugging the compiler and will likely be removed
18271 in a future version.
18273 @item -mnested-cond-exec
18274 @opindex mnested-cond-exec
18276 Enable nested conditional execution optimizations (default).
18278 This switch is mainly for debugging the compiler and will likely be removed
18279 in a future version.
18281 @item -mno-nested-cond-exec
18282 @opindex mno-nested-cond-exec
18284 Disable nested conditional execution optimizations.
18286 This switch is mainly for debugging the compiler and will likely be removed
18287 in a future version.
18289 @item -moptimize-membar
18290 @opindex moptimize-membar
18292 This switch removes redundant @code{membar} instructions from the
18293 compiler-generated code.  It is enabled by default.
18295 @item -mno-optimize-membar
18296 @opindex mno-optimize-membar
18298 This switch disables the automatic removal of redundant @code{membar}
18299 instructions from the generated code.
18301 @item -mtomcat-stats
18302 @opindex mtomcat-stats
18304 Cause gas to print out tomcat statistics.
18306 @item -mcpu=@var{cpu}
18307 @opindex mcpu
18309 Select the processor type for which to generate code.  Possible values are
18310 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18311 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18313 @end table
18315 @node GNU/Linux Options
18316 @subsection GNU/Linux Options
18318 These @samp{-m} options are defined for GNU/Linux targets:
18320 @table @gcctabopt
18321 @item -mglibc
18322 @opindex mglibc
18323 Use the GNU C library.  This is the default except
18324 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18325 @samp{*-*-linux-*android*} targets.
18327 @item -muclibc
18328 @opindex muclibc
18329 Use uClibc C library.  This is the default on
18330 @samp{*-*-linux-*uclibc*} targets.
18332 @item -mmusl
18333 @opindex mmusl
18334 Use the musl C library.  This is the default on
18335 @samp{*-*-linux-*musl*} targets.
18337 @item -mbionic
18338 @opindex mbionic
18339 Use Bionic C library.  This is the default on
18340 @samp{*-*-linux-*android*} targets.
18342 @item -mandroid
18343 @opindex mandroid
18344 Compile code compatible with Android platform.  This is the default on
18345 @samp{*-*-linux-*android*} targets.
18347 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18348 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18349 this option makes the GCC driver pass Android-specific options to the linker.
18350 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18351 to be defined.
18353 @item -tno-android-cc
18354 @opindex tno-android-cc
18355 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18356 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18357 @option{-fno-rtti} by default.
18359 @item -tno-android-ld
18360 @opindex tno-android-ld
18361 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18362 linking options to the linker.
18364 @end table
18366 @node H8/300 Options
18367 @subsection H8/300 Options
18369 These @samp{-m} options are defined for the H8/300 implementations:
18371 @table @gcctabopt
18372 @item -mrelax
18373 @opindex mrelax
18374 Shorten some address references at link time, when possible; uses the
18375 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18376 ld, Using ld}, for a fuller description.
18378 @item -mh
18379 @opindex mh
18380 Generate code for the H8/300H@.
18382 @item -ms
18383 @opindex ms
18384 Generate code for the H8S@.
18386 @item -mn
18387 @opindex mn
18388 Generate code for the H8S and H8/300H in the normal mode.  This switch
18389 must be used either with @option{-mh} or @option{-ms}.
18391 @item -ms2600
18392 @opindex ms2600
18393 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18395 @item -mexr
18396 @opindex mexr
18397 Extended registers are stored on stack before execution of function
18398 with monitor attribute. Default option is @option{-mexr}.
18399 This option is valid only for H8S targets.
18401 @item -mno-exr
18402 @opindex mno-exr
18403 Extended registers are not stored on stack before execution of function 
18404 with monitor attribute. Default option is @option{-mno-exr}. 
18405 This option is valid only for H8S targets.
18407 @item -mint32
18408 @opindex mint32
18409 Make @code{int} data 32 bits by default.
18411 @item -malign-300
18412 @opindex malign-300
18413 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18414 The default for the H8/300H and H8S is to align longs and floats on
18415 4-byte boundaries.
18416 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18417 This option has no effect on the H8/300.
18418 @end table
18420 @node HPPA Options
18421 @subsection HPPA Options
18422 @cindex HPPA Options
18424 These @samp{-m} options are defined for the HPPA family of computers:
18426 @table @gcctabopt
18427 @item -march=@var{architecture-type}
18428 @opindex march
18429 Generate code for the specified architecture.  The choices for
18430 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18431 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18432 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18433 architecture option for your machine.  Code compiled for lower numbered
18434 architectures runs on higher numbered architectures, but not the
18435 other way around.
18437 @item -mpa-risc-1-0
18438 @itemx -mpa-risc-1-1
18439 @itemx -mpa-risc-2-0
18440 @opindex mpa-risc-1-0
18441 @opindex mpa-risc-1-1
18442 @opindex mpa-risc-2-0
18443 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18445 @item -mcaller-copies
18446 @opindex mcaller-copies
18447 The caller copies function arguments passed by hidden reference.  This
18448 option should be used with care as it is not compatible with the default
18449 32-bit runtime.  However, only aggregates larger than eight bytes are
18450 passed by hidden reference and the option provides better compatibility
18451 with OpenMP.
18453 @item -mjump-in-delay
18454 @opindex mjump-in-delay
18455 This option is ignored and provided for compatibility purposes only.
18457 @item -mdisable-fpregs
18458 @opindex mdisable-fpregs
18459 Prevent floating-point registers from being used in any manner.  This is
18460 necessary for compiling kernels that perform lazy context switching of
18461 floating-point registers.  If you use this option and attempt to perform
18462 floating-point operations, the compiler aborts.
18464 @item -mdisable-indexing
18465 @opindex mdisable-indexing
18466 Prevent the compiler from using indexing address modes.  This avoids some
18467 rather obscure problems when compiling MIG generated code under MACH@.
18469 @item -mno-space-regs
18470 @opindex mno-space-regs
18471 Generate code that assumes the target has no space registers.  This allows
18472 GCC to generate faster indirect calls and use unscaled index address modes.
18474 Such code is suitable for level 0 PA systems and kernels.
18476 @item -mfast-indirect-calls
18477 @opindex mfast-indirect-calls
18478 Generate code that assumes calls never cross space boundaries.  This
18479 allows GCC to emit code that performs faster indirect calls.
18481 This option does not work in the presence of shared libraries or nested
18482 functions.
18484 @item -mfixed-range=@var{register-range}
18485 @opindex mfixed-range
18486 Generate code treating the given register range as fixed registers.
18487 A fixed register is one that the register allocator cannot use.  This is
18488 useful when compiling kernel code.  A register range is specified as
18489 two registers separated by a dash.  Multiple register ranges can be
18490 specified separated by a comma.
18492 @item -mlong-load-store
18493 @opindex mlong-load-store
18494 Generate 3-instruction load and store sequences as sometimes required by
18495 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18496 the HP compilers.
18498 @item -mportable-runtime
18499 @opindex mportable-runtime
18500 Use the portable calling conventions proposed by HP for ELF systems.
18502 @item -mgas
18503 @opindex mgas
18504 Enable the use of assembler directives only GAS understands.
18506 @item -mschedule=@var{cpu-type}
18507 @opindex mschedule
18508 Schedule code according to the constraints for the machine type
18509 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18510 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18511 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18512 proper scheduling option for your machine.  The default scheduling is
18513 @samp{8000}.
18515 @item -mlinker-opt
18516 @opindex mlinker-opt
18517 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18518 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18519 linkers in which they give bogus error messages when linking some programs.
18521 @item -msoft-float
18522 @opindex msoft-float
18523 Generate output containing library calls for floating point.
18524 @strong{Warning:} the requisite libraries are not available for all HPPA
18525 targets.  Normally the facilities of the machine's usual C compiler are
18526 used, but this cannot be done directly in cross-compilation.  You must make
18527 your own arrangements to provide suitable library functions for
18528 cross-compilation.
18530 @option{-msoft-float} changes the calling convention in the output file;
18531 therefore, it is only useful if you compile @emph{all} of a program with
18532 this option.  In particular, you need to compile @file{libgcc.a}, the
18533 library that comes with GCC, with @option{-msoft-float} in order for
18534 this to work.
18536 @item -msio
18537 @opindex msio
18538 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18539 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18540 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18541 options are available under HP-UX and HI-UX@.
18543 @item -mgnu-ld
18544 @opindex mgnu-ld
18545 Use options specific to GNU @command{ld}.
18546 This passes @option{-shared} to @command{ld} when
18547 building a shared library.  It is the default when GCC is configured,
18548 explicitly or implicitly, with the GNU linker.  This option does not
18549 affect which @command{ld} is called; it only changes what parameters
18550 are passed to that @command{ld}.
18551 The @command{ld} that is called is determined by the
18552 @option{--with-ld} configure option, GCC's program search path, and
18553 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18554 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18555 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18557 @item -mhp-ld
18558 @opindex mhp-ld
18559 Use options specific to HP @command{ld}.
18560 This passes @option{-b} to @command{ld} when building
18561 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18562 links.  It is the default when GCC is configured, explicitly or
18563 implicitly, with the HP linker.  This option does not affect
18564 which @command{ld} is called; it only changes what parameters are passed to that
18565 @command{ld}.
18566 The @command{ld} that is called is determined by the @option{--with-ld}
18567 configure option, GCC's program search path, and finally by the user's
18568 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18569 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18570 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18572 @item -mlong-calls
18573 @opindex mno-long-calls
18574 Generate code that uses long call sequences.  This ensures that a call
18575 is always able to reach linker generated stubs.  The default is to generate
18576 long calls only when the distance from the call site to the beginning
18577 of the function or translation unit, as the case may be, exceeds a
18578 predefined limit set by the branch type being used.  The limits for
18579 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18580 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18581 240,000 bytes.
18583 Distances are measured from the beginning of functions when using the
18584 @option{-ffunction-sections} option, or when using the @option{-mgas}
18585 and @option{-mno-portable-runtime} options together under HP-UX with
18586 the SOM linker.
18588 It is normally not desirable to use this option as it degrades
18589 performance.  However, it may be useful in large applications,
18590 particularly when partial linking is used to build the application.
18592 The types of long calls used depends on the capabilities of the
18593 assembler and linker, and the type of code being generated.  The
18594 impact on systems that support long absolute calls, and long pic
18595 symbol-difference or pc-relative calls should be relatively small.
18596 However, an indirect call is used on 32-bit ELF systems in pic code
18597 and it is quite long.
18599 @item -munix=@var{unix-std}
18600 @opindex march
18601 Generate compiler predefines and select a startfile for the specified
18602 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18603 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18604 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18605 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18606 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18607 and later.
18609 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18610 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18611 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18612 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18613 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18614 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18616 It is @emph{important} to note that this option changes the interfaces
18617 for various library routines.  It also affects the operational behavior
18618 of the C library.  Thus, @emph{extreme} care is needed in using this
18619 option.
18621 Library code that is intended to operate with more than one UNIX
18622 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18623 as appropriate.  Most GNU software doesn't provide this capability.
18625 @item -nolibdld
18626 @opindex nolibdld
18627 Suppress the generation of link options to search libdld.sl when the
18628 @option{-static} option is specified on HP-UX 10 and later.
18630 @item -static
18631 @opindex static
18632 The HP-UX implementation of setlocale in libc has a dependency on
18633 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18634 when the @option{-static} option is specified, special link options
18635 are needed to resolve this dependency.
18637 On HP-UX 10 and later, the GCC driver adds the necessary options to
18638 link with libdld.sl when the @option{-static} option is specified.
18639 This causes the resulting binary to be dynamic.  On the 64-bit port,
18640 the linkers generate dynamic binaries by default in any case.  The
18641 @option{-nolibdld} option can be used to prevent the GCC driver from
18642 adding these link options.
18644 @item -threads
18645 @opindex threads
18646 Add support for multithreading with the @dfn{dce thread} library
18647 under HP-UX@.  This option sets flags for both the preprocessor and
18648 linker.
18649 @end table
18651 @node IA-64 Options
18652 @subsection IA-64 Options
18653 @cindex IA-64 Options
18655 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18657 @table @gcctabopt
18658 @item -mbig-endian
18659 @opindex mbig-endian
18660 Generate code for a big-endian target.  This is the default for HP-UX@.
18662 @item -mlittle-endian
18663 @opindex mlittle-endian
18664 Generate code for a little-endian target.  This is the default for AIX5
18665 and GNU/Linux.
18667 @item -mgnu-as
18668 @itemx -mno-gnu-as
18669 @opindex mgnu-as
18670 @opindex mno-gnu-as
18671 Generate (or don't) code for the GNU assembler.  This is the default.
18672 @c Also, this is the default if the configure option @option{--with-gnu-as}
18673 @c is used.
18675 @item -mgnu-ld
18676 @itemx -mno-gnu-ld
18677 @opindex mgnu-ld
18678 @opindex mno-gnu-ld
18679 Generate (or don't) code for the GNU linker.  This is the default.
18680 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18681 @c is used.
18683 @item -mno-pic
18684 @opindex mno-pic
18685 Generate code that does not use a global pointer register.  The result
18686 is not position independent code, and violates the IA-64 ABI@.
18688 @item -mvolatile-asm-stop
18689 @itemx -mno-volatile-asm-stop
18690 @opindex mvolatile-asm-stop
18691 @opindex mno-volatile-asm-stop
18692 Generate (or don't) a stop bit immediately before and after volatile asm
18693 statements.
18695 @item -mregister-names
18696 @itemx -mno-register-names
18697 @opindex mregister-names
18698 @opindex mno-register-names
18699 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18700 the stacked registers.  This may make assembler output more readable.
18702 @item -mno-sdata
18703 @itemx -msdata
18704 @opindex mno-sdata
18705 @opindex msdata
18706 Disable (or enable) optimizations that use the small data section.  This may
18707 be useful for working around optimizer bugs.
18709 @item -mconstant-gp
18710 @opindex mconstant-gp
18711 Generate code that uses a single constant global pointer value.  This is
18712 useful when compiling kernel code.
18714 @item -mauto-pic
18715 @opindex mauto-pic
18716 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18717 This is useful when compiling firmware code.
18719 @item -minline-float-divide-min-latency
18720 @opindex minline-float-divide-min-latency
18721 Generate code for inline divides of floating-point values
18722 using the minimum latency algorithm.
18724 @item -minline-float-divide-max-throughput
18725 @opindex minline-float-divide-max-throughput
18726 Generate code for inline divides of floating-point values
18727 using the maximum throughput algorithm.
18729 @item -mno-inline-float-divide
18730 @opindex mno-inline-float-divide
18731 Do not generate inline code for divides of floating-point values.
18733 @item -minline-int-divide-min-latency
18734 @opindex minline-int-divide-min-latency
18735 Generate code for inline divides of integer values
18736 using the minimum latency algorithm.
18738 @item -minline-int-divide-max-throughput
18739 @opindex minline-int-divide-max-throughput
18740 Generate code for inline divides of integer values
18741 using the maximum throughput algorithm.
18743 @item -mno-inline-int-divide
18744 @opindex mno-inline-int-divide
18745 Do not generate inline code for divides of integer values.
18747 @item -minline-sqrt-min-latency
18748 @opindex minline-sqrt-min-latency
18749 Generate code for inline square roots
18750 using the minimum latency algorithm.
18752 @item -minline-sqrt-max-throughput
18753 @opindex minline-sqrt-max-throughput
18754 Generate code for inline square roots
18755 using the maximum throughput algorithm.
18757 @item -mno-inline-sqrt
18758 @opindex mno-inline-sqrt
18759 Do not generate inline code for @code{sqrt}.
18761 @item -mfused-madd
18762 @itemx -mno-fused-madd
18763 @opindex mfused-madd
18764 @opindex mno-fused-madd
18765 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18766 instructions.  The default is to use these instructions.
18768 @item -mno-dwarf2-asm
18769 @itemx -mdwarf2-asm
18770 @opindex mno-dwarf2-asm
18771 @opindex mdwarf2-asm
18772 Don't (or do) generate assembler code for the DWARF line number debugging
18773 info.  This may be useful when not using the GNU assembler.
18775 @item -mearly-stop-bits
18776 @itemx -mno-early-stop-bits
18777 @opindex mearly-stop-bits
18778 @opindex mno-early-stop-bits
18779 Allow stop bits to be placed earlier than immediately preceding the
18780 instruction that triggered the stop bit.  This can improve instruction
18781 scheduling, but does not always do so.
18783 @item -mfixed-range=@var{register-range}
18784 @opindex mfixed-range
18785 Generate code treating the given register range as fixed registers.
18786 A fixed register is one that the register allocator cannot use.  This is
18787 useful when compiling kernel code.  A register range is specified as
18788 two registers separated by a dash.  Multiple register ranges can be
18789 specified separated by a comma.
18791 @item -mtls-size=@var{tls-size}
18792 @opindex mtls-size
18793 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18796 @item -mtune=@var{cpu-type}
18797 @opindex mtune
18798 Tune the instruction scheduling for a particular CPU, Valid values are
18799 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18800 and @samp{mckinley}.
18802 @item -milp32
18803 @itemx -mlp64
18804 @opindex milp32
18805 @opindex mlp64
18806 Generate code for a 32-bit or 64-bit environment.
18807 The 32-bit environment sets int, long and pointer to 32 bits.
18808 The 64-bit environment sets int to 32 bits and long and pointer
18809 to 64 bits.  These are HP-UX specific flags.
18811 @item -mno-sched-br-data-spec
18812 @itemx -msched-br-data-spec
18813 @opindex mno-sched-br-data-spec
18814 @opindex msched-br-data-spec
18815 (Dis/En)able data speculative scheduling before reload.
18816 This results in generation of @code{ld.a} instructions and
18817 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18818 The default setting is disabled.
18820 @item -msched-ar-data-spec
18821 @itemx -mno-sched-ar-data-spec
18822 @opindex msched-ar-data-spec
18823 @opindex mno-sched-ar-data-spec
18824 (En/Dis)able data speculative scheduling after reload.
18825 This results in generation of @code{ld.a} instructions and
18826 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18827 The default setting is enabled.
18829 @item -mno-sched-control-spec
18830 @itemx -msched-control-spec
18831 @opindex mno-sched-control-spec
18832 @opindex msched-control-spec
18833 (Dis/En)able control speculative scheduling.  This feature is
18834 available only during region scheduling (i.e.@: before reload).
18835 This results in generation of the @code{ld.s} instructions and
18836 the corresponding check instructions @code{chk.s}.
18837 The default setting is disabled.
18839 @item -msched-br-in-data-spec
18840 @itemx -mno-sched-br-in-data-spec
18841 @opindex msched-br-in-data-spec
18842 @opindex mno-sched-br-in-data-spec
18843 (En/Dis)able speculative scheduling of the instructions that
18844 are dependent on the data speculative loads before reload.
18845 This is effective only with @option{-msched-br-data-spec} enabled.
18846 The default setting is enabled.
18848 @item -msched-ar-in-data-spec
18849 @itemx -mno-sched-ar-in-data-spec
18850 @opindex msched-ar-in-data-spec
18851 @opindex mno-sched-ar-in-data-spec
18852 (En/Dis)able speculative scheduling of the instructions that
18853 are dependent on the data speculative loads after reload.
18854 This is effective only with @option{-msched-ar-data-spec} enabled.
18855 The default setting is enabled.
18857 @item -msched-in-control-spec
18858 @itemx -mno-sched-in-control-spec
18859 @opindex msched-in-control-spec
18860 @opindex mno-sched-in-control-spec
18861 (En/Dis)able speculative scheduling of the instructions that
18862 are dependent on the control speculative loads.
18863 This is effective only with @option{-msched-control-spec} enabled.
18864 The default setting is enabled.
18866 @item -mno-sched-prefer-non-data-spec-insns
18867 @itemx -msched-prefer-non-data-spec-insns
18868 @opindex mno-sched-prefer-non-data-spec-insns
18869 @opindex msched-prefer-non-data-spec-insns
18870 If enabled, data-speculative instructions are chosen for schedule
18871 only if there are no other choices at the moment.  This makes
18872 the use of the data speculation much more conservative.
18873 The default setting is disabled.
18875 @item -mno-sched-prefer-non-control-spec-insns
18876 @itemx -msched-prefer-non-control-spec-insns
18877 @opindex mno-sched-prefer-non-control-spec-insns
18878 @opindex msched-prefer-non-control-spec-insns
18879 If enabled, control-speculative instructions are chosen for schedule
18880 only if there are no other choices at the moment.  This makes
18881 the use of the control speculation much more conservative.
18882 The default setting is disabled.
18884 @item -mno-sched-count-spec-in-critical-path
18885 @itemx -msched-count-spec-in-critical-path
18886 @opindex mno-sched-count-spec-in-critical-path
18887 @opindex msched-count-spec-in-critical-path
18888 If enabled, speculative dependencies are considered during
18889 computation of the instructions priorities.  This makes the use of the
18890 speculation a bit more conservative.
18891 The default setting is disabled.
18893 @item -msched-spec-ldc
18894 @opindex msched-spec-ldc
18895 Use a simple data speculation check.  This option is on by default.
18897 @item -msched-control-spec-ldc
18898 @opindex msched-spec-ldc
18899 Use a simple check for control speculation.  This option is on by default.
18901 @item -msched-stop-bits-after-every-cycle
18902 @opindex msched-stop-bits-after-every-cycle
18903 Place a stop bit after every cycle when scheduling.  This option is on
18904 by default.
18906 @item -msched-fp-mem-deps-zero-cost
18907 @opindex msched-fp-mem-deps-zero-cost
18908 Assume that floating-point stores and loads are not likely to cause a conflict
18909 when placed into the same instruction group.  This option is disabled by
18910 default.
18912 @item -msel-sched-dont-check-control-spec
18913 @opindex msel-sched-dont-check-control-spec
18914 Generate checks for control speculation in selective scheduling.
18915 This flag is disabled by default.
18917 @item -msched-max-memory-insns=@var{max-insns}
18918 @opindex msched-max-memory-insns
18919 Limit on the number of memory insns per instruction group, giving lower
18920 priority to subsequent memory insns attempting to schedule in the same
18921 instruction group. Frequently useful to prevent cache bank conflicts.
18922 The default value is 1.
18924 @item -msched-max-memory-insns-hard-limit
18925 @opindex msched-max-memory-insns-hard-limit
18926 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18927 disallowing more than that number in an instruction group.
18928 Otherwise, the limit is ``soft'', meaning that non-memory operations
18929 are preferred when the limit is reached, but memory operations may still
18930 be scheduled.
18932 @end table
18934 @node LM32 Options
18935 @subsection LM32 Options
18936 @cindex LM32 options
18938 These @option{-m} options are defined for the LatticeMico32 architecture:
18940 @table @gcctabopt
18941 @item -mbarrel-shift-enabled
18942 @opindex mbarrel-shift-enabled
18943 Enable barrel-shift instructions.
18945 @item -mdivide-enabled
18946 @opindex mdivide-enabled
18947 Enable divide and modulus instructions.
18949 @item -mmultiply-enabled
18950 @opindex multiply-enabled
18951 Enable multiply instructions.
18953 @item -msign-extend-enabled
18954 @opindex msign-extend-enabled
18955 Enable sign extend instructions.
18957 @item -muser-enabled
18958 @opindex muser-enabled
18959 Enable user-defined instructions.
18961 @end table
18963 @node M32C Options
18964 @subsection M32C Options
18965 @cindex M32C options
18967 @table @gcctabopt
18968 @item -mcpu=@var{name}
18969 @opindex mcpu=
18970 Select the CPU for which code is generated.  @var{name} may be one of
18971 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18972 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18973 the M32C/80 series.
18975 @item -msim
18976 @opindex msim
18977 Specifies that the program will be run on the simulator.  This causes
18978 an alternate runtime library to be linked in which supports, for
18979 example, file I/O@.  You must not use this option when generating
18980 programs that will run on real hardware; you must provide your own
18981 runtime library for whatever I/O functions are needed.
18983 @item -memregs=@var{number}
18984 @opindex memregs=
18985 Specifies the number of memory-based pseudo-registers GCC uses
18986 during code generation.  These pseudo-registers are used like real
18987 registers, so there is a tradeoff between GCC's ability to fit the
18988 code into available registers, and the performance penalty of using
18989 memory instead of registers.  Note that all modules in a program must
18990 be compiled with the same value for this option.  Because of that, you
18991 must not use this option with GCC's default runtime libraries.
18993 @end table
18995 @node M32R/D Options
18996 @subsection M32R/D Options
18997 @cindex M32R/D options
18999 These @option{-m} options are defined for Renesas M32R/D architectures:
19001 @table @gcctabopt
19002 @item -m32r2
19003 @opindex m32r2
19004 Generate code for the M32R/2@.
19006 @item -m32rx
19007 @opindex m32rx
19008 Generate code for the M32R/X@.
19010 @item -m32r
19011 @opindex m32r
19012 Generate code for the M32R@.  This is the default.
19014 @item -mmodel=small
19015 @opindex mmodel=small
19016 Assume all objects live in the lower 16MB of memory (so that their addresses
19017 can be loaded with the @code{ld24} instruction), and assume all subroutines
19018 are reachable with the @code{bl} instruction.
19019 This is the default.
19021 The addressability of a particular object can be set with the
19022 @code{model} attribute.
19024 @item -mmodel=medium
19025 @opindex mmodel=medium
19026 Assume objects may be anywhere in the 32-bit address space (the compiler
19027 generates @code{seth/add3} instructions to load their addresses), and
19028 assume all subroutines are reachable with the @code{bl} instruction.
19030 @item -mmodel=large
19031 @opindex mmodel=large
19032 Assume objects may be anywhere in the 32-bit address space (the compiler
19033 generates @code{seth/add3} instructions to load their addresses), and
19034 assume subroutines may not be reachable with the @code{bl} instruction
19035 (the compiler generates the much slower @code{seth/add3/jl}
19036 instruction sequence).
19038 @item -msdata=none
19039 @opindex msdata=none
19040 Disable use of the small data area.  Variables are put into
19041 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19042 @code{section} attribute has been specified).
19043 This is the default.
19045 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19046 Objects may be explicitly put in the small data area with the
19047 @code{section} attribute using one of these sections.
19049 @item -msdata=sdata
19050 @opindex msdata=sdata
19051 Put small global and static data in the small data area, but do not
19052 generate special code to reference them.
19054 @item -msdata=use
19055 @opindex msdata=use
19056 Put small global and static data in the small data area, and generate
19057 special instructions to reference them.
19059 @item -G @var{num}
19060 @opindex G
19061 @cindex smaller data references
19062 Put global and static objects less than or equal to @var{num} bytes
19063 into the small data or BSS sections instead of the normal data or BSS
19064 sections.  The default value of @var{num} is 8.
19065 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
19066 for this option to have any effect.
19068 All modules should be compiled with the same @option{-G @var{num}} value.
19069 Compiling with different values of @var{num} may or may not work; if it
19070 doesn't the linker gives an error message---incorrect code is not
19071 generated.
19073 @item -mdebug
19074 @opindex mdebug
19075 Makes the M32R-specific code in the compiler display some statistics
19076 that might help in debugging programs.
19078 @item -malign-loops
19079 @opindex malign-loops
19080 Align all loops to a 32-byte boundary.
19082 @item -mno-align-loops
19083 @opindex mno-align-loops
19084 Do not enforce a 32-byte alignment for loops.  This is the default.
19086 @item -missue-rate=@var{number}
19087 @opindex missue-rate=@var{number}
19088 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19089 or 2.
19091 @item -mbranch-cost=@var{number}
19092 @opindex mbranch-cost=@var{number}
19093 @var{number} can only be 1 or 2.  If it is 1 then branches are
19094 preferred over conditional code, if it is 2, then the opposite applies.
19096 @item -mflush-trap=@var{number}
19097 @opindex mflush-trap=@var{number}
19098 Specifies the trap number to use to flush the cache.  The default is
19099 12.  Valid numbers are between 0 and 15 inclusive.
19101 @item -mno-flush-trap
19102 @opindex mno-flush-trap
19103 Specifies that the cache cannot be flushed by using a trap.
19105 @item -mflush-func=@var{name}
19106 @opindex mflush-func=@var{name}
19107 Specifies the name of the operating system function to call to flush
19108 the cache.  The default is @samp{_flush_cache}, but a function call
19109 is only used if a trap is not available.
19111 @item -mno-flush-func
19112 @opindex mno-flush-func
19113 Indicates that there is no OS function for flushing the cache.
19115 @end table
19117 @node M680x0 Options
19118 @subsection M680x0 Options
19119 @cindex M680x0 options
19121 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19122 The default settings depend on which architecture was selected when
19123 the compiler was configured; the defaults for the most common choices
19124 are given below.
19126 @table @gcctabopt
19127 @item -march=@var{arch}
19128 @opindex march
19129 Generate code for a specific M680x0 or ColdFire instruction set
19130 architecture.  Permissible values of @var{arch} for M680x0
19131 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19132 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19133 architectures are selected according to Freescale's ISA classification
19134 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19135 @samp{isab} and @samp{isac}.
19137 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19138 code for a ColdFire target.  The @var{arch} in this macro is one of the
19139 @option{-march} arguments given above.
19141 When used together, @option{-march} and @option{-mtune} select code
19142 that runs on a family of similar processors but that is optimized
19143 for a particular microarchitecture.
19145 @item -mcpu=@var{cpu}
19146 @opindex mcpu
19147 Generate code for a specific M680x0 or ColdFire processor.
19148 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19149 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19150 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19151 below, which also classifies the CPUs into families:
19153 @multitable @columnfractions 0.20 0.80
19154 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19155 @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}
19156 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19157 @item @samp{5206e} @tab @samp{5206e}
19158 @item @samp{5208} @tab @samp{5207} @samp{5208}
19159 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19160 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19161 @item @samp{5216} @tab @samp{5214} @samp{5216}
19162 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19163 @item @samp{5225} @tab @samp{5224} @samp{5225}
19164 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19165 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19166 @item @samp{5249} @tab @samp{5249}
19167 @item @samp{5250} @tab @samp{5250}
19168 @item @samp{5271} @tab @samp{5270} @samp{5271}
19169 @item @samp{5272} @tab @samp{5272}
19170 @item @samp{5275} @tab @samp{5274} @samp{5275}
19171 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19172 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19173 @item @samp{5307} @tab @samp{5307}
19174 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19175 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19176 @item @samp{5407} @tab @samp{5407}
19177 @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}
19178 @end multitable
19180 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19181 @var{arch} is compatible with @var{cpu}.  Other combinations of
19182 @option{-mcpu} and @option{-march} are rejected.
19184 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19185 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19186 where the value of @var{family} is given by the table above.
19188 @item -mtune=@var{tune}
19189 @opindex mtune
19190 Tune the code for a particular microarchitecture within the
19191 constraints set by @option{-march} and @option{-mcpu}.
19192 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19193 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19194 and @samp{cpu32}.  The ColdFire microarchitectures
19195 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19197 You can also use @option{-mtune=68020-40} for code that needs
19198 to run relatively well on 68020, 68030 and 68040 targets.
19199 @option{-mtune=68020-60} is similar but includes 68060 targets
19200 as well.  These two options select the same tuning decisions as
19201 @option{-m68020-40} and @option{-m68020-60} respectively.
19203 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19204 when tuning for 680x0 architecture @var{arch}.  It also defines
19205 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19206 option is used.  If GCC is tuning for a range of architectures,
19207 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19208 it defines the macros for every architecture in the range.
19210 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19211 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19212 of the arguments given above.
19214 @item -m68000
19215 @itemx -mc68000
19216 @opindex m68000
19217 @opindex mc68000
19218 Generate output for a 68000.  This is the default
19219 when the compiler is configured for 68000-based systems.
19220 It is equivalent to @option{-march=68000}.
19222 Use this option for microcontrollers with a 68000 or EC000 core,
19223 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19225 @item -m68010
19226 @opindex m68010
19227 Generate output for a 68010.  This is the default
19228 when the compiler is configured for 68010-based systems.
19229 It is equivalent to @option{-march=68010}.
19231 @item -m68020
19232 @itemx -mc68020
19233 @opindex m68020
19234 @opindex mc68020
19235 Generate output for a 68020.  This is the default
19236 when the compiler is configured for 68020-based systems.
19237 It is equivalent to @option{-march=68020}.
19239 @item -m68030
19240 @opindex m68030
19241 Generate output for a 68030.  This is the default when the compiler is
19242 configured for 68030-based systems.  It is equivalent to
19243 @option{-march=68030}.
19245 @item -m68040
19246 @opindex m68040
19247 Generate output for a 68040.  This is the default when the compiler is
19248 configured for 68040-based systems.  It is equivalent to
19249 @option{-march=68040}.
19251 This option inhibits the use of 68881/68882 instructions that have to be
19252 emulated by software on the 68040.  Use this option if your 68040 does not
19253 have code to emulate those instructions.
19255 @item -m68060
19256 @opindex m68060
19257 Generate output for a 68060.  This is the default when the compiler is
19258 configured for 68060-based systems.  It is equivalent to
19259 @option{-march=68060}.
19261 This option inhibits the use of 68020 and 68881/68882 instructions that
19262 have to be emulated by software on the 68060.  Use this option if your 68060
19263 does not have code to emulate those instructions.
19265 @item -mcpu32
19266 @opindex mcpu32
19267 Generate output for a CPU32.  This is the default
19268 when the compiler is configured for CPU32-based systems.
19269 It is equivalent to @option{-march=cpu32}.
19271 Use this option for microcontrollers with a
19272 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19273 68336, 68340, 68341, 68349 and 68360.
19275 @item -m5200
19276 @opindex m5200
19277 Generate output for a 520X ColdFire CPU@.  This is the default
19278 when the compiler is configured for 520X-based systems.
19279 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19280 in favor of that option.
19282 Use this option for microcontroller with a 5200 core, including
19283 the MCF5202, MCF5203, MCF5204 and MCF5206.
19285 @item -m5206e
19286 @opindex m5206e
19287 Generate output for a 5206e ColdFire CPU@.  The option is now
19288 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19290 @item -m528x
19291 @opindex m528x
19292 Generate output for a member of the ColdFire 528X family.
19293 The option is now deprecated in favor of the equivalent
19294 @option{-mcpu=528x}.
19296 @item -m5307
19297 @opindex m5307
19298 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19299 in favor of the equivalent @option{-mcpu=5307}.
19301 @item -m5407
19302 @opindex m5407
19303 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19304 in favor of the equivalent @option{-mcpu=5407}.
19306 @item -mcfv4e
19307 @opindex mcfv4e
19308 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19309 This includes use of hardware floating-point instructions.
19310 The option is equivalent to @option{-mcpu=547x}, and is now
19311 deprecated in favor of that option.
19313 @item -m68020-40
19314 @opindex m68020-40
19315 Generate output for a 68040, without using any of the new instructions.
19316 This results in code that can run relatively efficiently on either a
19317 68020/68881 or a 68030 or a 68040.  The generated code does use the
19318 68881 instructions that are emulated on the 68040.
19320 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19322 @item -m68020-60
19323 @opindex m68020-60
19324 Generate output for a 68060, without using any of the new instructions.
19325 This results in code that can run relatively efficiently on either a
19326 68020/68881 or a 68030 or a 68040.  The generated code does use the
19327 68881 instructions that are emulated on the 68060.
19329 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19331 @item -mhard-float
19332 @itemx -m68881
19333 @opindex mhard-float
19334 @opindex m68881
19335 Generate floating-point instructions.  This is the default for 68020
19336 and above, and for ColdFire devices that have an FPU@.  It defines the
19337 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19338 on ColdFire targets.
19340 @item -msoft-float
19341 @opindex msoft-float
19342 Do not generate floating-point instructions; use library calls instead.
19343 This is the default for 68000, 68010, and 68832 targets.  It is also
19344 the default for ColdFire devices that have no FPU.
19346 @item -mdiv
19347 @itemx -mno-div
19348 @opindex mdiv
19349 @opindex mno-div
19350 Generate (do not generate) ColdFire hardware divide and remainder
19351 instructions.  If @option{-march} is used without @option{-mcpu},
19352 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19353 architectures.  Otherwise, the default is taken from the target CPU
19354 (either the default CPU, or the one specified by @option{-mcpu}).  For
19355 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19356 @option{-mcpu=5206e}.
19358 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19360 @item -mshort
19361 @opindex mshort
19362 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19363 Additionally, parameters passed on the stack are also aligned to a
19364 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19366 @item -mno-short
19367 @opindex mno-short
19368 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19370 @item -mnobitfield
19371 @itemx -mno-bitfield
19372 @opindex mnobitfield
19373 @opindex mno-bitfield
19374 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19375 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19377 @item -mbitfield
19378 @opindex mbitfield
19379 Do use the bit-field instructions.  The @option{-m68020} option implies
19380 @option{-mbitfield}.  This is the default if you use a configuration
19381 designed for a 68020.
19383 @item -mrtd
19384 @opindex mrtd
19385 Use a different function-calling convention, in which functions
19386 that take a fixed number of arguments return with the @code{rtd}
19387 instruction, which pops their arguments while returning.  This
19388 saves one instruction in the caller since there is no need to pop
19389 the arguments there.
19391 This calling convention is incompatible with the one normally
19392 used on Unix, so you cannot use it if you need to call libraries
19393 compiled with the Unix compiler.
19395 Also, you must provide function prototypes for all functions that
19396 take variable numbers of arguments (including @code{printf});
19397 otherwise incorrect code is generated for calls to those
19398 functions.
19400 In addition, seriously incorrect code results if you call a
19401 function with too many arguments.  (Normally, extra arguments are
19402 harmlessly ignored.)
19404 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19405 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19407 @item -mno-rtd
19408 @opindex mno-rtd
19409 Do not use the calling conventions selected by @option{-mrtd}.
19410 This is the default.
19412 @item -malign-int
19413 @itemx -mno-align-int
19414 @opindex malign-int
19415 @opindex mno-align-int
19416 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19417 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19418 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19419 Aligning variables on 32-bit boundaries produces code that runs somewhat
19420 faster on processors with 32-bit busses at the expense of more memory.
19422 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19423 aligns structures containing the above types differently than
19424 most published application binary interface specifications for the m68k.
19426 @item -mpcrel
19427 @opindex mpcrel
19428 Use the pc-relative addressing mode of the 68000 directly, instead of
19429 using a global offset table.  At present, this option implies @option{-fpic},
19430 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19431 not presently supported with @option{-mpcrel}, though this could be supported for
19432 68020 and higher processors.
19434 @item -mno-strict-align
19435 @itemx -mstrict-align
19436 @opindex mno-strict-align
19437 @opindex mstrict-align
19438 Do not (do) assume that unaligned memory references are handled by
19439 the system.
19441 @item -msep-data
19442 Generate code that allows the data segment to be located in a different
19443 area of memory from the text segment.  This allows for execute-in-place in
19444 an environment without virtual memory management.  This option implies
19445 @option{-fPIC}.
19447 @item -mno-sep-data
19448 Generate code that assumes that the data segment follows the text segment.
19449 This is the default.
19451 @item -mid-shared-library
19452 Generate code that supports shared libraries via the library ID method.
19453 This allows for execute-in-place and shared libraries in an environment
19454 without virtual memory management.  This option implies @option{-fPIC}.
19456 @item -mno-id-shared-library
19457 Generate code that doesn't assume ID-based shared libraries are being used.
19458 This is the default.
19460 @item -mshared-library-id=n
19461 Specifies the identification number of the ID-based shared library being
19462 compiled.  Specifying a value of 0 generates more compact code; specifying
19463 other values forces the allocation of that number to the current
19464 library, but is no more space- or time-efficient than omitting this option.
19466 @item -mxgot
19467 @itemx -mno-xgot
19468 @opindex mxgot
19469 @opindex mno-xgot
19470 When generating position-independent code for ColdFire, generate code
19471 that works if the GOT has more than 8192 entries.  This code is
19472 larger and slower than code generated without this option.  On M680x0
19473 processors, this option is not needed; @option{-fPIC} suffices.
19475 GCC normally uses a single instruction to load values from the GOT@.
19476 While this is relatively efficient, it only works if the GOT
19477 is smaller than about 64k.  Anything larger causes the linker
19478 to report an error such as:
19480 @cindex relocation truncated to fit (ColdFire)
19481 @smallexample
19482 relocation truncated to fit: R_68K_GOT16O foobar
19483 @end smallexample
19485 If this happens, you should recompile your code with @option{-mxgot}.
19486 It should then work with very large GOTs.  However, code generated with
19487 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19488 the value of a global symbol.
19490 Note that some linkers, including newer versions of the GNU linker,
19491 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19492 you should only need to use @option{-mxgot} when compiling a single
19493 object file that accesses more than 8192 GOT entries.  Very few do.
19495 These options have no effect unless GCC is generating
19496 position-independent code.
19498 @item -mlong-jump-table-offsets
19499 @opindex mlong-jump-table-offsets
19500 Use 32-bit offsets in @code{switch} tables.  The default is to use
19501 16-bit offsets.
19503 @end table
19505 @node MCore Options
19506 @subsection MCore Options
19507 @cindex MCore options
19509 These are the @samp{-m} options defined for the Motorola M*Core
19510 processors.
19512 @table @gcctabopt
19514 @item -mhardlit
19515 @itemx -mno-hardlit
19516 @opindex mhardlit
19517 @opindex mno-hardlit
19518 Inline constants into the code stream if it can be done in two
19519 instructions or less.
19521 @item -mdiv
19522 @itemx -mno-div
19523 @opindex mdiv
19524 @opindex mno-div
19525 Use the divide instruction.  (Enabled by default).
19527 @item -mrelax-immediate
19528 @itemx -mno-relax-immediate
19529 @opindex mrelax-immediate
19530 @opindex mno-relax-immediate
19531 Allow arbitrary-sized immediates in bit operations.
19533 @item -mwide-bitfields
19534 @itemx -mno-wide-bitfields
19535 @opindex mwide-bitfields
19536 @opindex mno-wide-bitfields
19537 Always treat bit-fields as @code{int}-sized.
19539 @item -m4byte-functions
19540 @itemx -mno-4byte-functions
19541 @opindex m4byte-functions
19542 @opindex mno-4byte-functions
19543 Force all functions to be aligned to a 4-byte boundary.
19545 @item -mcallgraph-data
19546 @itemx -mno-callgraph-data
19547 @opindex mcallgraph-data
19548 @opindex mno-callgraph-data
19549 Emit callgraph information.
19551 @item -mslow-bytes
19552 @itemx -mno-slow-bytes
19553 @opindex mslow-bytes
19554 @opindex mno-slow-bytes
19555 Prefer word access when reading byte quantities.
19557 @item -mlittle-endian
19558 @itemx -mbig-endian
19559 @opindex mlittle-endian
19560 @opindex mbig-endian
19561 Generate code for a little-endian target.
19563 @item -m210
19564 @itemx -m340
19565 @opindex m210
19566 @opindex m340
19567 Generate code for the 210 processor.
19569 @item -mno-lsim
19570 @opindex mno-lsim
19571 Assume that runtime support has been provided and so omit the
19572 simulator library (@file{libsim.a)} from the linker command line.
19574 @item -mstack-increment=@var{size}
19575 @opindex mstack-increment
19576 Set the maximum amount for a single stack increment operation.  Large
19577 values can increase the speed of programs that contain functions
19578 that need a large amount of stack space, but they can also trigger a
19579 segmentation fault if the stack is extended too much.  The default
19580 value is 0x1000.
19582 @end table
19584 @node MeP Options
19585 @subsection MeP Options
19586 @cindex MeP options
19588 @table @gcctabopt
19590 @item -mabsdiff
19591 @opindex mabsdiff
19592 Enables the @code{abs} instruction, which is the absolute difference
19593 between two registers.
19595 @item -mall-opts
19596 @opindex mall-opts
19597 Enables all the optional instructions---average, multiply, divide, bit
19598 operations, leading zero, absolute difference, min/max, clip, and
19599 saturation.
19602 @item -maverage
19603 @opindex maverage
19604 Enables the @code{ave} instruction, which computes the average of two
19605 registers.
19607 @item -mbased=@var{n}
19608 @opindex mbased=
19609 Variables of size @var{n} bytes or smaller are placed in the
19610 @code{.based} section by default.  Based variables use the @code{$tp}
19611 register as a base register, and there is a 128-byte limit to the
19612 @code{.based} section.
19614 @item -mbitops
19615 @opindex mbitops
19616 Enables the bit operation instructions---bit test (@code{btstm}), set
19617 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19618 test-and-set (@code{tas}).
19620 @item -mc=@var{name}
19621 @opindex mc=
19622 Selects which section constant data is placed in.  @var{name} may
19623 be @samp{tiny}, @samp{near}, or @samp{far}.
19625 @item -mclip
19626 @opindex mclip
19627 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19628 useful unless you also provide @option{-mminmax}.
19630 @item -mconfig=@var{name}
19631 @opindex mconfig=
19632 Selects one of the built-in core configurations.  Each MeP chip has
19633 one or more modules in it; each module has a core CPU and a variety of
19634 coprocessors, optional instructions, and peripherals.  The
19635 @code{MeP-Integrator} tool, not part of GCC, provides these
19636 configurations through this option; using this option is the same as
19637 using all the corresponding command-line options.  The default
19638 configuration is @samp{default}.
19640 @item -mcop
19641 @opindex mcop
19642 Enables the coprocessor instructions.  By default, this is a 32-bit
19643 coprocessor.  Note that the coprocessor is normally enabled via the
19644 @option{-mconfig=} option.
19646 @item -mcop32
19647 @opindex mcop32
19648 Enables the 32-bit coprocessor's instructions.
19650 @item -mcop64
19651 @opindex mcop64
19652 Enables the 64-bit coprocessor's instructions.
19654 @item -mivc2
19655 @opindex mivc2
19656 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19658 @item -mdc
19659 @opindex mdc
19660 Causes constant variables to be placed in the @code{.near} section.
19662 @item -mdiv
19663 @opindex mdiv
19664 Enables the @code{div} and @code{divu} instructions.
19666 @item -meb
19667 @opindex meb
19668 Generate big-endian code.
19670 @item -mel
19671 @opindex mel
19672 Generate little-endian code.
19674 @item -mio-volatile
19675 @opindex mio-volatile
19676 Tells the compiler that any variable marked with the @code{io}
19677 attribute is to be considered volatile.
19679 @item -ml
19680 @opindex ml
19681 Causes variables to be assigned to the @code{.far} section by default.
19683 @item -mleadz
19684 @opindex mleadz
19685 Enables the @code{leadz} (leading zero) instruction.
19687 @item -mm
19688 @opindex mm
19689 Causes variables to be assigned to the @code{.near} section by default.
19691 @item -mminmax
19692 @opindex mminmax
19693 Enables the @code{min} and @code{max} instructions.
19695 @item -mmult
19696 @opindex mmult
19697 Enables the multiplication and multiply-accumulate instructions.
19699 @item -mno-opts
19700 @opindex mno-opts
19701 Disables all the optional instructions enabled by @option{-mall-opts}.
19703 @item -mrepeat
19704 @opindex mrepeat
19705 Enables the @code{repeat} and @code{erepeat} instructions, used for
19706 low-overhead looping.
19708 @item -ms
19709 @opindex ms
19710 Causes all variables to default to the @code{.tiny} section.  Note
19711 that there is a 65536-byte limit to this section.  Accesses to these
19712 variables use the @code{%gp} base register.
19714 @item -msatur
19715 @opindex msatur
19716 Enables the saturation instructions.  Note that the compiler does not
19717 currently generate these itself, but this option is included for
19718 compatibility with other tools, like @code{as}.
19720 @item -msdram
19721 @opindex msdram
19722 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19724 @item -msim
19725 @opindex msim
19726 Link the simulator run-time libraries.
19728 @item -msimnovec
19729 @opindex msimnovec
19730 Link the simulator runtime libraries, excluding built-in support
19731 for reset and exception vectors and tables.
19733 @item -mtf
19734 @opindex mtf
19735 Causes all functions to default to the @code{.far} section.  Without
19736 this option, functions default to the @code{.near} section.
19738 @item -mtiny=@var{n}
19739 @opindex mtiny=
19740 Variables that are @var{n} bytes or smaller are allocated to the
19741 @code{.tiny} section.  These variables use the @code{$gp} base
19742 register.  The default for this option is 4, but note that there's a
19743 65536-byte limit to the @code{.tiny} section.
19745 @end table
19747 @node MicroBlaze Options
19748 @subsection MicroBlaze Options
19749 @cindex MicroBlaze Options
19751 @table @gcctabopt
19753 @item -msoft-float
19754 @opindex msoft-float
19755 Use software emulation for floating point (default).
19757 @item -mhard-float
19758 @opindex mhard-float
19759 Use hardware floating-point instructions.
19761 @item -mmemcpy
19762 @opindex mmemcpy
19763 Do not optimize block moves, use @code{memcpy}.
19765 @item -mno-clearbss
19766 @opindex mno-clearbss
19767 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19769 @item -mcpu=@var{cpu-type}
19770 @opindex mcpu=
19771 Use features of, and schedule code for, the given CPU.
19772 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19773 where @var{X} is a major version, @var{YY} is the minor version, and
19774 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19775 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19777 @item -mxl-soft-mul
19778 @opindex mxl-soft-mul
19779 Use software multiply emulation (default).
19781 @item -mxl-soft-div
19782 @opindex mxl-soft-div
19783 Use software emulation for divides (default).
19785 @item -mxl-barrel-shift
19786 @opindex mxl-barrel-shift
19787 Use the hardware barrel shifter.
19789 @item -mxl-pattern-compare
19790 @opindex mxl-pattern-compare
19791 Use pattern compare instructions.
19793 @item -msmall-divides
19794 @opindex msmall-divides
19795 Use table lookup optimization for small signed integer divisions.
19797 @item -mxl-stack-check
19798 @opindex mxl-stack-check
19799 This option is deprecated.  Use @option{-fstack-check} instead.
19801 @item -mxl-gp-opt
19802 @opindex mxl-gp-opt
19803 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19805 @item -mxl-multiply-high
19806 @opindex mxl-multiply-high
19807 Use multiply high instructions for high part of 32x32 multiply.
19809 @item -mxl-float-convert
19810 @opindex mxl-float-convert
19811 Use hardware floating-point conversion instructions.
19813 @item -mxl-float-sqrt
19814 @opindex mxl-float-sqrt
19815 Use hardware floating-point square root instruction.
19817 @item -mbig-endian
19818 @opindex mbig-endian
19819 Generate code for a big-endian target.
19821 @item -mlittle-endian
19822 @opindex mlittle-endian
19823 Generate code for a little-endian target.
19825 @item -mxl-reorder
19826 @opindex mxl-reorder
19827 Use reorder instructions (swap and byte reversed load/store).
19829 @item -mxl-mode-@var{app-model}
19830 Select application model @var{app-model}.  Valid models are
19831 @table @samp
19832 @item executable
19833 normal executable (default), uses startup code @file{crt0.o}.
19835 @item xmdstub
19836 for use with Xilinx Microprocessor Debugger (XMD) based
19837 software intrusive debug agent called xmdstub. This uses startup file
19838 @file{crt1.o} and sets the start address of the program to 0x800.
19840 @item bootstrap
19841 for applications that are loaded using a bootloader.
19842 This model uses startup file @file{crt2.o} which does not contain a processor
19843 reset vector handler. This is suitable for transferring control on a
19844 processor reset to the bootloader rather than the application.
19846 @item novectors
19847 for applications that do not require any of the
19848 MicroBlaze vectors. This option may be useful for applications running
19849 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19850 @end table
19852 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19853 @option{-mxl-mode-@var{app-model}}.
19855 @end table
19857 @node MIPS Options
19858 @subsection MIPS Options
19859 @cindex MIPS options
19861 @table @gcctabopt
19863 @item -EB
19864 @opindex EB
19865 Generate big-endian code.
19867 @item -EL
19868 @opindex EL
19869 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19870 configurations.
19872 @item -march=@var{arch}
19873 @opindex march
19874 Generate code that runs on @var{arch}, which can be the name of a
19875 generic MIPS ISA, or the name of a particular processor.
19876 The ISA names are:
19877 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19878 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19879 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19880 @samp{mips64r5} and @samp{mips64r6}.
19881 The processor names are:
19882 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19883 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19884 @samp{5kc}, @samp{5kf},
19885 @samp{20kc},
19886 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19887 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19888 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19889 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19890 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19891 @samp{i6400},
19892 @samp{interaptiv},
19893 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19894 @samp{m4k},
19895 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19896 @samp{m5100}, @samp{m5101},
19897 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19898 @samp{orion},
19899 @samp{p5600},
19900 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19901 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19902 @samp{rm7000}, @samp{rm9000},
19903 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19904 @samp{sb1},
19905 @samp{sr71000},
19906 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19907 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19908 @samp{xlr} and @samp{xlp}.
19909 The special value @samp{from-abi} selects the
19910 most compatible architecture for the selected ABI (that is,
19911 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19913 The native Linux/GNU toolchain also supports the value @samp{native},
19914 which selects the best architecture option for the host processor.
19915 @option{-march=native} has no effect if GCC does not recognize
19916 the processor.
19918 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19919 (for example, @option{-march=r2k}).  Prefixes are optional, and
19920 @samp{vr} may be written @samp{r}.
19922 Names of the form @samp{@var{n}f2_1} refer to processors with
19923 FPUs clocked at half the rate of the core, names of the form
19924 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19925 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19926 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19927 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19928 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19929 accepted as synonyms for @samp{@var{n}f1_1}.
19931 GCC defines two macros based on the value of this option.  The first
19932 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19933 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19934 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19935 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19936 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19938 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19939 above.  In other words, it has the full prefix and does not
19940 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19941 the macro names the resolved architecture (either @code{"mips1"} or
19942 @code{"mips3"}).  It names the default architecture when no
19943 @option{-march} option is given.
19945 @item -mtune=@var{arch}
19946 @opindex mtune
19947 Optimize for @var{arch}.  Among other things, this option controls
19948 the way instructions are scheduled, and the perceived cost of arithmetic
19949 operations.  The list of @var{arch} values is the same as for
19950 @option{-march}.
19952 When this option is not used, GCC optimizes for the processor
19953 specified by @option{-march}.  By using @option{-march} and
19954 @option{-mtune} together, it is possible to generate code that
19955 runs on a family of processors, but optimize the code for one
19956 particular member of that family.
19958 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19959 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19960 @option{-march} ones described above.
19962 @item -mips1
19963 @opindex mips1
19964 Equivalent to @option{-march=mips1}.
19966 @item -mips2
19967 @opindex mips2
19968 Equivalent to @option{-march=mips2}.
19970 @item -mips3
19971 @opindex mips3
19972 Equivalent to @option{-march=mips3}.
19974 @item -mips4
19975 @opindex mips4
19976 Equivalent to @option{-march=mips4}.
19978 @item -mips32
19979 @opindex mips32
19980 Equivalent to @option{-march=mips32}.
19982 @item -mips32r3
19983 @opindex mips32r3
19984 Equivalent to @option{-march=mips32r3}.
19986 @item -mips32r5
19987 @opindex mips32r5
19988 Equivalent to @option{-march=mips32r5}.
19990 @item -mips32r6
19991 @opindex mips32r6
19992 Equivalent to @option{-march=mips32r6}.
19994 @item -mips64
19995 @opindex mips64
19996 Equivalent to @option{-march=mips64}.
19998 @item -mips64r2
19999 @opindex mips64r2
20000 Equivalent to @option{-march=mips64r2}.
20002 @item -mips64r3
20003 @opindex mips64r3
20004 Equivalent to @option{-march=mips64r3}.
20006 @item -mips64r5
20007 @opindex mips64r5
20008 Equivalent to @option{-march=mips64r5}.
20010 @item -mips64r6
20011 @opindex mips64r6
20012 Equivalent to @option{-march=mips64r6}.
20014 @item -mips16
20015 @itemx -mno-mips16
20016 @opindex mips16
20017 @opindex mno-mips16
20018 Generate (do not generate) MIPS16 code.  If GCC is targeting a
20019 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
20021 MIPS16 code generation can also be controlled on a per-function basis
20022 by means of @code{mips16} and @code{nomips16} attributes.
20023 @xref{Function Attributes}, for more information.
20025 @item -mflip-mips16
20026 @opindex mflip-mips16
20027 Generate MIPS16 code on alternating functions.  This option is provided
20028 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20029 not intended for ordinary use in compiling user code.
20031 @item -minterlink-compressed
20032 @item -mno-interlink-compressed
20033 @opindex minterlink-compressed
20034 @opindex mno-interlink-compressed
20035 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20036 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20038 For example, code using the standard ISA encoding cannot jump directly
20039 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20040 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20041 knows that the target of the jump is not compressed.
20043 @item -minterlink-mips16
20044 @itemx -mno-interlink-mips16
20045 @opindex minterlink-mips16
20046 @opindex mno-interlink-mips16
20047 Aliases of @option{-minterlink-compressed} and
20048 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
20049 and are retained for backwards compatibility.
20051 @item -mabi=32
20052 @itemx -mabi=o64
20053 @itemx -mabi=n32
20054 @itemx -mabi=64
20055 @itemx -mabi=eabi
20056 @opindex mabi=32
20057 @opindex mabi=o64
20058 @opindex mabi=n32
20059 @opindex mabi=64
20060 @opindex mabi=eabi
20061 Generate code for the given ABI@.
20063 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
20064 generates 64-bit code when you select a 64-bit architecture, but you
20065 can use @option{-mgp32} to get 32-bit code instead.
20067 For information about the O64 ABI, see
20068 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20070 GCC supports a variant of the o32 ABI in which floating-point registers
20071 are 64 rather than 32 bits wide.  You can select this combination with
20072 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20073 and @code{mfhc1} instructions and is therefore only supported for
20074 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20076 The register assignments for arguments and return values remain the
20077 same, but each scalar value is passed in a single 64-bit register
20078 rather than a pair of 32-bit registers.  For example, scalar
20079 floating-point values are returned in @samp{$f0} only, not a
20080 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20081 remains the same in that the even-numbered double-precision registers
20082 are saved.
20084 Two additional variants of the o32 ABI are supported to enable
20085 a transition from 32-bit to 64-bit registers.  These are FPXX
20086 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20087 The FPXX extension mandates that all code must execute correctly
20088 when run using 32-bit or 64-bit registers.  The code can be interlinked
20089 with either FP32 or FP64, but not both.
20090 The FP64A extension is similar to the FP64 extension but forbids the
20091 use of odd-numbered single-precision registers.  This can be used
20092 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20093 processors and allows both FP32 and FP64A code to interlink and
20094 run in the same process without changing FPU modes.
20096 @item -mabicalls
20097 @itemx -mno-abicalls
20098 @opindex mabicalls
20099 @opindex mno-abicalls
20100 Generate (do not generate) code that is suitable for SVR4-style
20101 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20102 systems.
20104 @item -mshared
20105 @itemx -mno-shared
20106 Generate (do not generate) code that is fully position-independent,
20107 and that can therefore be linked into shared libraries.  This option
20108 only affects @option{-mabicalls}.
20110 All @option{-mabicalls} code has traditionally been position-independent,
20111 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20112 as an extension, the GNU toolchain allows executables to use absolute
20113 accesses for locally-binding symbols.  It can also use shorter GP
20114 initialization sequences and generate direct calls to locally-defined
20115 functions.  This mode is selected by @option{-mno-shared}.
20117 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20118 objects that can only be linked by the GNU linker.  However, the option
20119 does not affect the ABI of the final executable; it only affects the ABI
20120 of relocatable objects.  Using @option{-mno-shared} generally makes
20121 executables both smaller and quicker.
20123 @option{-mshared} is the default.
20125 @item -mplt
20126 @itemx -mno-plt
20127 @opindex mplt
20128 @opindex mno-plt
20129 Assume (do not assume) that the static and dynamic linkers
20130 support PLTs and copy relocations.  This option only affects
20131 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20132 has no effect without @option{-msym32}.
20134 You can make @option{-mplt} the default by configuring
20135 GCC with @option{--with-mips-plt}.  The default is
20136 @option{-mno-plt} otherwise.
20138 @item -mxgot
20139 @itemx -mno-xgot
20140 @opindex mxgot
20141 @opindex mno-xgot
20142 Lift (do not lift) the usual restrictions on the size of the global
20143 offset table.
20145 GCC normally uses a single instruction to load values from the GOT@.
20146 While this is relatively efficient, it only works if the GOT
20147 is smaller than about 64k.  Anything larger causes the linker
20148 to report an error such as:
20150 @cindex relocation truncated to fit (MIPS)
20151 @smallexample
20152 relocation truncated to fit: R_MIPS_GOT16 foobar
20153 @end smallexample
20155 If this happens, you should recompile your code with @option{-mxgot}.
20156 This works with very large GOTs, although the code is also
20157 less efficient, since it takes three instructions to fetch the
20158 value of a global symbol.
20160 Note that some linkers can create multiple GOTs.  If you have such a
20161 linker, you should only need to use @option{-mxgot} when a single object
20162 file accesses more than 64k's worth of GOT entries.  Very few do.
20164 These options have no effect unless GCC is generating position
20165 independent code.
20167 @item -mgp32
20168 @opindex mgp32
20169 Assume that general-purpose registers are 32 bits wide.
20171 @item -mgp64
20172 @opindex mgp64
20173 Assume that general-purpose registers are 64 bits wide.
20175 @item -mfp32
20176 @opindex mfp32
20177 Assume that floating-point registers are 32 bits wide.
20179 @item -mfp64
20180 @opindex mfp64
20181 Assume that floating-point registers are 64 bits wide.
20183 @item -mfpxx
20184 @opindex mfpxx
20185 Do not assume the width of floating-point registers.
20187 @item -mhard-float
20188 @opindex mhard-float
20189 Use floating-point coprocessor instructions.
20191 @item -msoft-float
20192 @opindex msoft-float
20193 Do not use floating-point coprocessor instructions.  Implement
20194 floating-point calculations using library calls instead.
20196 @item -mno-float
20197 @opindex mno-float
20198 Equivalent to @option{-msoft-float}, but additionally asserts that the
20199 program being compiled does not perform any floating-point operations.
20200 This option is presently supported only by some bare-metal MIPS
20201 configurations, where it may select a special set of libraries
20202 that lack all floating-point support (including, for example, the
20203 floating-point @code{printf} formats).  
20204 If code compiled with @option{-mno-float} accidentally contains
20205 floating-point operations, it is likely to suffer a link-time
20206 or run-time failure.
20208 @item -msingle-float
20209 @opindex msingle-float
20210 Assume that the floating-point coprocessor only supports single-precision
20211 operations.
20213 @item -mdouble-float
20214 @opindex mdouble-float
20215 Assume that the floating-point coprocessor supports double-precision
20216 operations.  This is the default.
20218 @item -modd-spreg
20219 @itemx -mno-odd-spreg
20220 @opindex modd-spreg
20221 @opindex mno-odd-spreg
20222 Enable the use of odd-numbered single-precision floating-point registers
20223 for the o32 ABI.  This is the default for processors that are known to
20224 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20225 is set by default.
20227 @item -mabs=2008
20228 @itemx -mabs=legacy
20229 @opindex mabs=2008
20230 @opindex mabs=legacy
20231 These options control the treatment of the special not-a-number (NaN)
20232 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20233 @code{neg.@i{fmt}} machine instructions.
20235 By default or when @option{-mabs=legacy} is used the legacy
20236 treatment is selected.  In this case these instructions are considered
20237 arithmetic and avoided where correct operation is required and the
20238 input operand might be a NaN.  A longer sequence of instructions that
20239 manipulate the sign bit of floating-point datum manually is used
20240 instead unless the @option{-ffinite-math-only} option has also been
20241 specified.
20243 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20244 this case these instructions are considered non-arithmetic and therefore
20245 operating correctly in all cases, including in particular where the
20246 input operand is a NaN.  These instructions are therefore always used
20247 for the respective operations.
20249 @item -mnan=2008
20250 @itemx -mnan=legacy
20251 @opindex mnan=2008
20252 @opindex mnan=legacy
20253 These options control the encoding of the special not-a-number (NaN)
20254 IEEE 754 floating-point data.
20256 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20257 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20258 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20259 by the first bit of their trailing significand field being 1.
20261 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20262 this case qNaNs are denoted by the first bit of their trailing
20263 significand field being 1, whereas sNaNs are denoted by the first bit of
20264 their trailing significand field being 0.
20266 The default is @option{-mnan=legacy} unless GCC has been configured with
20267 @option{--with-nan=2008}.
20269 @item -mllsc
20270 @itemx -mno-llsc
20271 @opindex mllsc
20272 @opindex mno-llsc
20273 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20274 implement atomic memory built-in functions.  When neither option is
20275 specified, GCC uses the instructions if the target architecture
20276 supports them.
20278 @option{-mllsc} is useful if the runtime environment can emulate the
20279 instructions and @option{-mno-llsc} can be useful when compiling for
20280 nonstandard ISAs.  You can make either option the default by
20281 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20282 respectively.  @option{--with-llsc} is the default for some
20283 configurations; see the installation documentation for details.
20285 @item -mdsp
20286 @itemx -mno-dsp
20287 @opindex mdsp
20288 @opindex mno-dsp
20289 Use (do not use) revision 1 of the MIPS DSP ASE@.
20290 @xref{MIPS DSP Built-in Functions}.  This option defines the
20291 preprocessor macro @code{__mips_dsp}.  It also defines
20292 @code{__mips_dsp_rev} to 1.
20294 @item -mdspr2
20295 @itemx -mno-dspr2
20296 @opindex mdspr2
20297 @opindex mno-dspr2
20298 Use (do not use) revision 2 of the MIPS DSP ASE@.
20299 @xref{MIPS DSP Built-in Functions}.  This option defines the
20300 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20301 It also defines @code{__mips_dsp_rev} to 2.
20303 @item -msmartmips
20304 @itemx -mno-smartmips
20305 @opindex msmartmips
20306 @opindex mno-smartmips
20307 Use (do not use) the MIPS SmartMIPS ASE.
20309 @item -mpaired-single
20310 @itemx -mno-paired-single
20311 @opindex mpaired-single
20312 @opindex mno-paired-single
20313 Use (do not use) paired-single floating-point instructions.
20314 @xref{MIPS Paired-Single Support}.  This option requires
20315 hardware floating-point support to be enabled.
20317 @item -mdmx
20318 @itemx -mno-mdmx
20319 @opindex mdmx
20320 @opindex mno-mdmx
20321 Use (do not use) MIPS Digital Media Extension instructions.
20322 This option can only be used when generating 64-bit code and requires
20323 hardware floating-point support to be enabled.
20325 @item -mips3d
20326 @itemx -mno-mips3d
20327 @opindex mips3d
20328 @opindex mno-mips3d
20329 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20330 The option @option{-mips3d} implies @option{-mpaired-single}.
20332 @item -mmicromips
20333 @itemx -mno-micromips
20334 @opindex mmicromips
20335 @opindex mno-mmicromips
20336 Generate (do not generate) microMIPS code.
20338 MicroMIPS code generation can also be controlled on a per-function basis
20339 by means of @code{micromips} and @code{nomicromips} attributes.
20340 @xref{Function Attributes}, for more information.
20342 @item -mmt
20343 @itemx -mno-mt
20344 @opindex mmt
20345 @opindex mno-mt
20346 Use (do not use) MT Multithreading instructions.
20348 @item -mmcu
20349 @itemx -mno-mcu
20350 @opindex mmcu
20351 @opindex mno-mcu
20352 Use (do not use) the MIPS MCU ASE instructions.
20354 @item -meva
20355 @itemx -mno-eva
20356 @opindex meva
20357 @opindex mno-eva
20358 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20360 @item -mvirt
20361 @itemx -mno-virt
20362 @opindex mvirt
20363 @opindex mno-virt
20364 Use (do not use) the MIPS Virtualization (VZ) instructions.
20366 @item -mxpa
20367 @itemx -mno-xpa
20368 @opindex mxpa
20369 @opindex mno-xpa
20370 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20372 @item -mlong64
20373 @opindex mlong64
20374 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20375 an explanation of the default and the way that the pointer size is
20376 determined.
20378 @item -mlong32
20379 @opindex mlong32
20380 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20382 The default size of @code{int}s, @code{long}s and pointers depends on
20383 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20384 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20385 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20386 or the same size as integer registers, whichever is smaller.
20388 @item -msym32
20389 @itemx -mno-sym32
20390 @opindex msym32
20391 @opindex mno-sym32
20392 Assume (do not assume) that all symbols have 32-bit values, regardless
20393 of the selected ABI@.  This option is useful in combination with
20394 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20395 to generate shorter and faster references to symbolic addresses.
20397 @item -G @var{num}
20398 @opindex G
20399 Put definitions of externally-visible data in a small data section
20400 if that data is no bigger than @var{num} bytes.  GCC can then generate
20401 more efficient accesses to the data; see @option{-mgpopt} for details.
20403 The default @option{-G} option depends on the configuration.
20405 @item -mlocal-sdata
20406 @itemx -mno-local-sdata
20407 @opindex mlocal-sdata
20408 @opindex mno-local-sdata
20409 Extend (do not extend) the @option{-G} behavior to local data too,
20410 such as to static variables in C@.  @option{-mlocal-sdata} is the
20411 default for all configurations.
20413 If the linker complains that an application is using too much small data,
20414 you might want to try rebuilding the less performance-critical parts with
20415 @option{-mno-local-sdata}.  You might also want to build large
20416 libraries with @option{-mno-local-sdata}, so that the libraries leave
20417 more room for the main program.
20419 @item -mextern-sdata
20420 @itemx -mno-extern-sdata
20421 @opindex mextern-sdata
20422 @opindex mno-extern-sdata
20423 Assume (do not assume) that externally-defined data is in
20424 a small data section if the size of that data is within the @option{-G} limit.
20425 @option{-mextern-sdata} is the default for all configurations.
20427 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20428 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20429 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20430 is placed in a small data section.  If @var{Var} is defined by another
20431 module, you must either compile that module with a high-enough
20432 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20433 definition.  If @var{Var} is common, you must link the application
20434 with a high-enough @option{-G} setting.
20436 The easiest way of satisfying these restrictions is to compile
20437 and link every module with the same @option{-G} option.  However,
20438 you may wish to build a library that supports several different
20439 small data limits.  You can do this by compiling the library with
20440 the highest supported @option{-G} setting and additionally using
20441 @option{-mno-extern-sdata} to stop the library from making assumptions
20442 about externally-defined data.
20444 @item -mgpopt
20445 @itemx -mno-gpopt
20446 @opindex mgpopt
20447 @opindex mno-gpopt
20448 Use (do not use) GP-relative accesses for symbols that are known to be
20449 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20450 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20451 configurations.
20453 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20454 might not hold the value of @code{_gp}.  For example, if the code is
20455 part of a library that might be used in a boot monitor, programs that
20456 call boot monitor routines pass an unknown value in @code{$gp}.
20457 (In such situations, the boot monitor itself is usually compiled
20458 with @option{-G0}.)
20460 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20461 @option{-mno-extern-sdata}.
20463 @item -membedded-data
20464 @itemx -mno-embedded-data
20465 @opindex membedded-data
20466 @opindex mno-embedded-data
20467 Allocate variables to the read-only data section first if possible, then
20468 next in the small data section if possible, otherwise in data.  This gives
20469 slightly slower code than the default, but reduces the amount of RAM required
20470 when executing, and thus may be preferred for some embedded systems.
20472 @item -muninit-const-in-rodata
20473 @itemx -mno-uninit-const-in-rodata
20474 @opindex muninit-const-in-rodata
20475 @opindex mno-uninit-const-in-rodata
20476 Put uninitialized @code{const} variables in the read-only data section.
20477 This option is only meaningful in conjunction with @option{-membedded-data}.
20479 @item -mcode-readable=@var{setting}
20480 @opindex mcode-readable
20481 Specify whether GCC may generate code that reads from executable sections.
20482 There are three possible settings:
20484 @table @gcctabopt
20485 @item -mcode-readable=yes
20486 Instructions may freely access executable sections.  This is the
20487 default setting.
20489 @item -mcode-readable=pcrel
20490 MIPS16 PC-relative load instructions can access executable sections,
20491 but other instructions must not do so.  This option is useful on 4KSc
20492 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20493 It is also useful on processors that can be configured to have a dual
20494 instruction/data SRAM interface and that, like the M4K, automatically
20495 redirect PC-relative loads to the instruction RAM.
20497 @item -mcode-readable=no
20498 Instructions must not access executable sections.  This option can be
20499 useful on targets that are configured to have a dual instruction/data
20500 SRAM interface but that (unlike the M4K) do not automatically redirect
20501 PC-relative loads to the instruction RAM.
20502 @end table
20504 @item -msplit-addresses
20505 @itemx -mno-split-addresses
20506 @opindex msplit-addresses
20507 @opindex mno-split-addresses
20508 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20509 relocation operators.  This option has been superseded by
20510 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20512 @item -mexplicit-relocs
20513 @itemx -mno-explicit-relocs
20514 @opindex mexplicit-relocs
20515 @opindex mno-explicit-relocs
20516 Use (do not use) assembler relocation operators when dealing with symbolic
20517 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20518 is to use assembler macros instead.
20520 @option{-mexplicit-relocs} is the default if GCC was configured
20521 to use an assembler that supports relocation operators.
20523 @item -mcheck-zero-division
20524 @itemx -mno-check-zero-division
20525 @opindex mcheck-zero-division
20526 @opindex mno-check-zero-division
20527 Trap (do not trap) on integer division by zero.
20529 The default is @option{-mcheck-zero-division}.
20531 @item -mdivide-traps
20532 @itemx -mdivide-breaks
20533 @opindex mdivide-traps
20534 @opindex mdivide-breaks
20535 MIPS systems check for division by zero by generating either a
20536 conditional trap or a break instruction.  Using traps results in
20537 smaller code, but is only supported on MIPS II and later.  Also, some
20538 versions of the Linux kernel have a bug that prevents trap from
20539 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20540 allow conditional traps on architectures that support them and
20541 @option{-mdivide-breaks} to force the use of breaks.
20543 The default is usually @option{-mdivide-traps}, but this can be
20544 overridden at configure time using @option{--with-divide=breaks}.
20545 Divide-by-zero checks can be completely disabled using
20546 @option{-mno-check-zero-division}.
20548 @item -mload-store-pairs
20549 @itemx -mno-load-store-pairs
20550 @opindex mload-store-pairs
20551 @opindex mno-load-store-pairs
20552 Enable (disable) an optimization that pairs consecutive load or store
20553 instructions to enable load/store bonding.  This option is enabled by
20554 default but only takes effect when the selected architecture is known
20555 to support bonding.
20557 @item -mmemcpy
20558 @itemx -mno-memcpy
20559 @opindex mmemcpy
20560 @opindex mno-memcpy
20561 Force (do not force) the use of @code{memcpy} for non-trivial block
20562 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20563 most constant-sized copies.
20565 @item -mlong-calls
20566 @itemx -mno-long-calls
20567 @opindex mlong-calls
20568 @opindex mno-long-calls
20569 Disable (do not disable) use of the @code{jal} instruction.  Calling
20570 functions using @code{jal} is more efficient but requires the caller
20571 and callee to be in the same 256 megabyte segment.
20573 This option has no effect on abicalls code.  The default is
20574 @option{-mno-long-calls}.
20576 @item -mmad
20577 @itemx -mno-mad
20578 @opindex mmad
20579 @opindex mno-mad
20580 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20581 instructions, as provided by the R4650 ISA@.
20583 @item -mimadd
20584 @itemx -mno-imadd
20585 @opindex mimadd
20586 @opindex mno-imadd
20587 Enable (disable) use of the @code{madd} and @code{msub} integer
20588 instructions.  The default is @option{-mimadd} on architectures
20589 that support @code{madd} and @code{msub} except for the 74k 
20590 architecture where it was found to generate slower code.
20592 @item -mfused-madd
20593 @itemx -mno-fused-madd
20594 @opindex mfused-madd
20595 @opindex mno-fused-madd
20596 Enable (disable) use of the floating-point multiply-accumulate
20597 instructions, when they are available.  The default is
20598 @option{-mfused-madd}.
20600 On the R8000 CPU when multiply-accumulate instructions are used,
20601 the intermediate product is calculated to infinite precision
20602 and is not subject to the FCSR Flush to Zero bit.  This may be
20603 undesirable in some circumstances.  On other processors the result
20604 is numerically identical to the equivalent computation using
20605 separate multiply, add, subtract and negate instructions.
20607 @item -nocpp
20608 @opindex nocpp
20609 Tell the MIPS assembler to not run its preprocessor over user
20610 assembler files (with a @samp{.s} suffix) when assembling them.
20612 @item -mfix-24k
20613 @item -mno-fix-24k
20614 @opindex mfix-24k
20615 @opindex mno-fix-24k
20616 Work around the 24K E48 (lost data on stores during refill) errata.
20617 The workarounds are implemented by the assembler rather than by GCC@.
20619 @item -mfix-r4000
20620 @itemx -mno-fix-r4000
20621 @opindex mfix-r4000
20622 @opindex mno-fix-r4000
20623 Work around certain R4000 CPU errata:
20624 @itemize @minus
20625 @item
20626 A double-word or a variable shift may give an incorrect result if executed
20627 immediately after starting an integer division.
20628 @item
20629 A double-word or a variable shift may give an incorrect result if executed
20630 while an integer multiplication is in progress.
20631 @item
20632 An integer division may give an incorrect result if started in a delay slot
20633 of a taken branch or a jump.
20634 @end itemize
20636 @item -mfix-r4400
20637 @itemx -mno-fix-r4400
20638 @opindex mfix-r4400
20639 @opindex mno-fix-r4400
20640 Work around certain R4400 CPU errata:
20641 @itemize @minus
20642 @item
20643 A double-word or a variable shift may give an incorrect result if executed
20644 immediately after starting an integer division.
20645 @end itemize
20647 @item -mfix-r10000
20648 @itemx -mno-fix-r10000
20649 @opindex mfix-r10000
20650 @opindex mno-fix-r10000
20651 Work around certain R10000 errata:
20652 @itemize @minus
20653 @item
20654 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20655 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20656 @end itemize
20658 This option can only be used if the target architecture supports
20659 branch-likely instructions.  @option{-mfix-r10000} is the default when
20660 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20661 otherwise.
20663 @item -mfix-rm7000
20664 @itemx -mno-fix-rm7000
20665 @opindex mfix-rm7000
20666 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20667 workarounds are implemented by the assembler rather than by GCC@.
20669 @item -mfix-vr4120
20670 @itemx -mno-fix-vr4120
20671 @opindex mfix-vr4120
20672 Work around certain VR4120 errata:
20673 @itemize @minus
20674 @item
20675 @code{dmultu} does not always produce the correct result.
20676 @item
20677 @code{div} and @code{ddiv} do not always produce the correct result if one
20678 of the operands is negative.
20679 @end itemize
20680 The workarounds for the division errata rely on special functions in
20681 @file{libgcc.a}.  At present, these functions are only provided by
20682 the @code{mips64vr*-elf} configurations.
20684 Other VR4120 errata require a NOP to be inserted between certain pairs of
20685 instructions.  These errata are handled by the assembler, not by GCC itself.
20687 @item -mfix-vr4130
20688 @opindex mfix-vr4130
20689 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20690 workarounds are implemented by the assembler rather than by GCC,
20691 although GCC avoids using @code{mflo} and @code{mfhi} if the
20692 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20693 instructions are available instead.
20695 @item -mfix-sb1
20696 @itemx -mno-fix-sb1
20697 @opindex mfix-sb1
20698 Work around certain SB-1 CPU core errata.
20699 (This flag currently works around the SB-1 revision 2
20700 ``F1'' and ``F2'' floating-point errata.)
20702 @item -mr10k-cache-barrier=@var{setting}
20703 @opindex mr10k-cache-barrier
20704 Specify whether GCC should insert cache barriers to avoid the
20705 side-effects of speculation on R10K processors.
20707 In common with many processors, the R10K tries to predict the outcome
20708 of a conditional branch and speculatively executes instructions from
20709 the ``taken'' branch.  It later aborts these instructions if the
20710 predicted outcome is wrong.  However, on the R10K, even aborted
20711 instructions can have side effects.
20713 This problem only affects kernel stores and, depending on the system,
20714 kernel loads.  As an example, a speculatively-executed store may load
20715 the target memory into cache and mark the cache line as dirty, even if
20716 the store itself is later aborted.  If a DMA operation writes to the
20717 same area of memory before the ``dirty'' line is flushed, the cached
20718 data overwrites the DMA-ed data.  See the R10K processor manual
20719 for a full description, including other potential problems.
20721 One workaround is to insert cache barrier instructions before every memory
20722 access that might be speculatively executed and that might have side
20723 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20724 controls GCC's implementation of this workaround.  It assumes that
20725 aborted accesses to any byte in the following regions does not have
20726 side effects:
20728 @enumerate
20729 @item
20730 the memory occupied by the current function's stack frame;
20732 @item
20733 the memory occupied by an incoming stack argument;
20735 @item
20736 the memory occupied by an object with a link-time-constant address.
20737 @end enumerate
20739 It is the kernel's responsibility to ensure that speculative
20740 accesses to these regions are indeed safe.
20742 If the input program contains a function declaration such as:
20744 @smallexample
20745 void foo (void);
20746 @end smallexample
20748 then the implementation of @code{foo} must allow @code{j foo} and
20749 @code{jal foo} to be executed speculatively.  GCC honors this
20750 restriction for functions it compiles itself.  It expects non-GCC
20751 functions (such as hand-written assembly code) to do the same.
20753 The option has three forms:
20755 @table @gcctabopt
20756 @item -mr10k-cache-barrier=load-store
20757 Insert a cache barrier before a load or store that might be
20758 speculatively executed and that might have side effects even
20759 if aborted.
20761 @item -mr10k-cache-barrier=store
20762 Insert a cache barrier before a store that might be speculatively
20763 executed and that might have side effects even if aborted.
20765 @item -mr10k-cache-barrier=none
20766 Disable the insertion of cache barriers.  This is the default setting.
20767 @end table
20769 @item -mflush-func=@var{func}
20770 @itemx -mno-flush-func
20771 @opindex mflush-func
20772 Specifies the function to call to flush the I and D caches, or to not
20773 call any such function.  If called, the function must take the same
20774 arguments as the common @code{_flush_func}, that is, the address of the
20775 memory range for which the cache is being flushed, the size of the
20776 memory range, and the number 3 (to flush both caches).  The default
20777 depends on the target GCC was configured for, but commonly is either
20778 @code{_flush_func} or @code{__cpu_flush}.
20780 @item mbranch-cost=@var{num}
20781 @opindex mbranch-cost
20782 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20783 This cost is only a heuristic and is not guaranteed to produce
20784 consistent results across releases.  A zero cost redundantly selects
20785 the default, which is based on the @option{-mtune} setting.
20787 @item -mbranch-likely
20788 @itemx -mno-branch-likely
20789 @opindex mbranch-likely
20790 @opindex mno-branch-likely
20791 Enable or disable use of Branch Likely instructions, regardless of the
20792 default for the selected architecture.  By default, Branch Likely
20793 instructions may be generated if they are supported by the selected
20794 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20795 and processors that implement those architectures; for those, Branch
20796 Likely instructions are not be generated by default because the MIPS32
20797 and MIPS64 architectures specifically deprecate their use.
20799 @item -mcompact-branches=never
20800 @itemx -mcompact-branches=optimal
20801 @itemx -mcompact-branches=always
20802 @opindex mcompact-branches=never
20803 @opindex mcompact-branches=optimal
20804 @opindex mcompact-branches=always
20805 These options control which form of branches will be generated.  The
20806 default is @option{-mcompact-branches=optimal}.
20808 The @option{-mcompact-branches=never} option ensures that compact branch
20809 instructions will never be generated.
20811 The @option{-mcompact-branches=always} option ensures that a compact
20812 branch instruction will be generated if available.  If a compact branch
20813 instruction is not available, a delay slot form of the branch will be
20814 used instead.
20816 This option is supported from MIPS Release 6 onwards.
20818 The @option{-mcompact-branches=optimal} option will cause a delay slot
20819 branch to be used if one is available in the current ISA and the delay
20820 slot is successfully filled.  If the delay slot is not filled, a compact
20821 branch will be chosen if one is available.
20823 @item -mfp-exceptions
20824 @itemx -mno-fp-exceptions
20825 @opindex mfp-exceptions
20826 Specifies whether FP exceptions are enabled.  This affects how
20827 FP instructions are scheduled for some processors.
20828 The default is that FP exceptions are
20829 enabled.
20831 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20832 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20833 FP pipe.
20835 @item -mvr4130-align
20836 @itemx -mno-vr4130-align
20837 @opindex mvr4130-align
20838 The VR4130 pipeline is two-way superscalar, but can only issue two
20839 instructions together if the first one is 8-byte aligned.  When this
20840 option is enabled, GCC aligns pairs of instructions that it
20841 thinks should execute in parallel.
20843 This option only has an effect when optimizing for the VR4130.
20844 It normally makes code faster, but at the expense of making it bigger.
20845 It is enabled by default at optimization level @option{-O3}.
20847 @item -msynci
20848 @itemx -mno-synci
20849 @opindex msynci
20850 Enable (disable) generation of @code{synci} instructions on
20851 architectures that support it.  The @code{synci} instructions (if
20852 enabled) are generated when @code{__builtin___clear_cache} is
20853 compiled.
20855 This option defaults to @option{-mno-synci}, but the default can be
20856 overridden by configuring GCC with @option{--with-synci}.
20858 When compiling code for single processor systems, it is generally safe
20859 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20860 does not invalidate the instruction caches on all cores and may lead
20861 to undefined behavior.
20863 @item -mrelax-pic-calls
20864 @itemx -mno-relax-pic-calls
20865 @opindex mrelax-pic-calls
20866 Try to turn PIC calls that are normally dispatched via register
20867 @code{$25} into direct calls.  This is only possible if the linker can
20868 resolve the destination at link time and if the destination is within
20869 range for a direct call.
20871 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20872 an assembler and a linker that support the @code{.reloc} assembly
20873 directive and @option{-mexplicit-relocs} is in effect.  With
20874 @option{-mno-explicit-relocs}, this optimization can be performed by the
20875 assembler and the linker alone without help from the compiler.
20877 @item -mmcount-ra-address
20878 @itemx -mno-mcount-ra-address
20879 @opindex mmcount-ra-address
20880 @opindex mno-mcount-ra-address
20881 Emit (do not emit) code that allows @code{_mcount} to modify the
20882 calling function's return address.  When enabled, this option extends
20883 the usual @code{_mcount} interface with a new @var{ra-address}
20884 parameter, which has type @code{intptr_t *} and is passed in register
20885 @code{$12}.  @code{_mcount} can then modify the return address by
20886 doing both of the following:
20887 @itemize
20888 @item
20889 Returning the new address in register @code{$31}.
20890 @item
20891 Storing the new address in @code{*@var{ra-address}},
20892 if @var{ra-address} is nonnull.
20893 @end itemize
20895 The default is @option{-mno-mcount-ra-address}.
20897 @item -mframe-header-opt
20898 @itemx -mno-frame-header-opt
20899 @opindex mframe-header-opt
20900 Enable (disable) frame header optimization in the o32 ABI.  When using the
20901 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20902 function to write out register arguments.  When enabled, this optimization
20903 will suppress the allocation of the frame header if it can be determined that
20904 it is unused.
20906 This optimization is off by default at all optimization levels.
20908 @item -mlxc1-sxc1
20909 @itemx -mno-lxc1-sxc1
20910 @opindex mlxc1-sxc1
20911 When applicable, enable (disable) the generation of @code{lwxc1},
20912 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20914 @item -mmadd4
20915 @itemx -mno-madd4
20916 @opindex mmadd4
20917 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20918 @code{madd.d} and related instructions.  Enabled by default.
20920 @end table
20922 @node MMIX Options
20923 @subsection MMIX Options
20924 @cindex MMIX Options
20926 These options are defined for the MMIX:
20928 @table @gcctabopt
20929 @item -mlibfuncs
20930 @itemx -mno-libfuncs
20931 @opindex mlibfuncs
20932 @opindex mno-libfuncs
20933 Specify that intrinsic library functions are being compiled, passing all
20934 values in registers, no matter the size.
20936 @item -mepsilon
20937 @itemx -mno-epsilon
20938 @opindex mepsilon
20939 @opindex mno-epsilon
20940 Generate floating-point comparison instructions that compare with respect
20941 to the @code{rE} epsilon register.
20943 @item -mabi=mmixware
20944 @itemx -mabi=gnu
20945 @opindex mabi=mmixware
20946 @opindex mabi=gnu
20947 Generate code that passes function parameters and return values that (in
20948 the called function) are seen as registers @code{$0} and up, as opposed to
20949 the GNU ABI which uses global registers @code{$231} and up.
20951 @item -mzero-extend
20952 @itemx -mno-zero-extend
20953 @opindex mzero-extend
20954 @opindex mno-zero-extend
20955 When reading data from memory in sizes shorter than 64 bits, use (do not
20956 use) zero-extending load instructions by default, rather than
20957 sign-extending ones.
20959 @item -mknuthdiv
20960 @itemx -mno-knuthdiv
20961 @opindex mknuthdiv
20962 @opindex mno-knuthdiv
20963 Make the result of a division yielding a remainder have the same sign as
20964 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20965 remainder follows the sign of the dividend.  Both methods are
20966 arithmetically valid, the latter being almost exclusively used.
20968 @item -mtoplevel-symbols
20969 @itemx -mno-toplevel-symbols
20970 @opindex mtoplevel-symbols
20971 @opindex mno-toplevel-symbols
20972 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20973 code can be used with the @code{PREFIX} assembly directive.
20975 @item -melf
20976 @opindex melf
20977 Generate an executable in the ELF format, rather than the default
20978 @samp{mmo} format used by the @command{mmix} simulator.
20980 @item -mbranch-predict
20981 @itemx -mno-branch-predict
20982 @opindex mbranch-predict
20983 @opindex mno-branch-predict
20984 Use (do not use) the probable-branch instructions, when static branch
20985 prediction indicates a probable branch.
20987 @item -mbase-addresses
20988 @itemx -mno-base-addresses
20989 @opindex mbase-addresses
20990 @opindex mno-base-addresses
20991 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20992 base address automatically generates a request (handled by the assembler
20993 and the linker) for a constant to be set up in a global register.  The
20994 register is used for one or more base address requests within the range 0
20995 to 255 from the value held in the register.  The generally leads to short
20996 and fast code, but the number of different data items that can be
20997 addressed is limited.  This means that a program that uses lots of static
20998 data may require @option{-mno-base-addresses}.
21000 @item -msingle-exit
21001 @itemx -mno-single-exit
21002 @opindex msingle-exit
21003 @opindex mno-single-exit
21004 Force (do not force) generated code to have a single exit point in each
21005 function.
21006 @end table
21008 @node MN10300 Options
21009 @subsection MN10300 Options
21010 @cindex MN10300 options
21012 These @option{-m} options are defined for Matsushita MN10300 architectures:
21014 @table @gcctabopt
21015 @item -mmult-bug
21016 @opindex mmult-bug
21017 Generate code to avoid bugs in the multiply instructions for the MN10300
21018 processors.  This is the default.
21020 @item -mno-mult-bug
21021 @opindex mno-mult-bug
21022 Do not generate code to avoid bugs in the multiply instructions for the
21023 MN10300 processors.
21025 @item -mam33
21026 @opindex mam33
21027 Generate code using features specific to the AM33 processor.
21029 @item -mno-am33
21030 @opindex mno-am33
21031 Do not generate code using features specific to the AM33 processor.  This
21032 is the default.
21034 @item -mam33-2
21035 @opindex mam33-2
21036 Generate code using features specific to the AM33/2.0 processor.
21038 @item -mam34
21039 @opindex mam34
21040 Generate code using features specific to the AM34 processor.
21042 @item -mtune=@var{cpu-type}
21043 @opindex mtune
21044 Use the timing characteristics of the indicated CPU type when
21045 scheduling instructions.  This does not change the targeted processor
21046 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
21047 @samp{am33-2} or @samp{am34}.
21049 @item -mreturn-pointer-on-d0
21050 @opindex mreturn-pointer-on-d0
21051 When generating a function that returns a pointer, return the pointer
21052 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
21053 only in @code{a0}, and attempts to call such functions without a prototype
21054 result in errors.  Note that this option is on by default; use
21055 @option{-mno-return-pointer-on-d0} to disable it.
21057 @item -mno-crt0
21058 @opindex mno-crt0
21059 Do not link in the C run-time initialization object file.
21061 @item -mrelax
21062 @opindex mrelax
21063 Indicate to the linker that it should perform a relaxation optimization pass
21064 to shorten branches, calls and absolute memory addresses.  This option only
21065 has an effect when used on the command line for the final link step.
21067 This option makes symbolic debugging impossible.
21069 @item -mliw
21070 @opindex mliw
21071 Allow the compiler to generate @emph{Long Instruction Word}
21072 instructions if the target is the @samp{AM33} or later.  This is the
21073 default.  This option defines the preprocessor macro @code{__LIW__}.
21075 @item -mnoliw
21076 @opindex mnoliw
21077 Do not allow the compiler to generate @emph{Long Instruction Word}
21078 instructions.  This option defines the preprocessor macro
21079 @code{__NO_LIW__}.
21081 @item -msetlb
21082 @opindex msetlb
21083 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21084 instructions if the target is the @samp{AM33} or later.  This is the
21085 default.  This option defines the preprocessor macro @code{__SETLB__}.
21087 @item -mnosetlb
21088 @opindex mnosetlb
21089 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21090 instructions.  This option defines the preprocessor macro
21091 @code{__NO_SETLB__}.
21093 @end table
21095 @node Moxie Options
21096 @subsection Moxie Options
21097 @cindex Moxie Options
21099 @table @gcctabopt
21101 @item -meb
21102 @opindex meb
21103 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21104 configurations.
21106 @item -mel
21107 @opindex mel
21108 Generate little-endian code.
21110 @item -mmul.x
21111 @opindex mmul.x
21112 Generate mul.x and umul.x instructions.  This is the default for
21113 @samp{moxiebox-*-*} configurations.
21115 @item -mno-crt0
21116 @opindex mno-crt0
21117 Do not link in the C run-time initialization object file.
21119 @end table
21121 @node MSP430 Options
21122 @subsection MSP430 Options
21123 @cindex MSP430 Options
21125 These options are defined for the MSP430:
21127 @table @gcctabopt
21129 @item -masm-hex
21130 @opindex masm-hex
21131 Force assembly output to always use hex constants.  Normally such
21132 constants are signed decimals, but this option is available for
21133 testsuite and/or aesthetic purposes.
21135 @item -mmcu=
21136 @opindex mmcu=
21137 Select the MCU to target.  This is used to create a C preprocessor
21138 symbol based upon the MCU name, converted to upper case and pre- and
21139 post-fixed with @samp{__}.  This in turn is used by the
21140 @file{msp430.h} header file to select an MCU-specific supplementary
21141 header file.
21143 The option also sets the ISA to use.  If the MCU name is one that is
21144 known to only support the 430 ISA then that is selected, otherwise the
21145 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21146 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21147 name selects the 430X ISA.
21149 In addition an MCU-specific linker script is added to the linker
21150 command line.  The script's name is the name of the MCU with
21151 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21152 command line defines the C preprocessor symbol @code{__XXX__} and
21153 cause the linker to search for a script called @file{xxx.ld}.
21155 This option is also passed on to the assembler.
21157 @item -mwarn-mcu
21158 @itemx -mno-warn-mcu
21159 @opindex mwarn-mcu
21160 @opindex mno-warn-mcu
21161 This option enables or disables warnings about conflicts between the
21162 MCU name specified by the @option{-mmcu} option and the ISA set by the
21163 @option{-mcpu} option and/or the hardware multiply support set by the
21164 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21165 MCU names.  This option is on by default.
21167 @item -mcpu=
21168 @opindex mcpu=
21169 Specifies the ISA to use.  Accepted values are @samp{msp430},
21170 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21171 @option{-mmcu=} option should be used to select the ISA.
21173 @item -msim
21174 @opindex msim
21175 Link to the simulator runtime libraries and linker script.  Overrides
21176 any scripts that would be selected by the @option{-mmcu=} option.
21178 @item -mlarge
21179 @opindex mlarge
21180 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21182 @item -msmall
21183 @opindex msmall
21184 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21186 @item -mrelax
21187 @opindex mrelax
21188 This option is passed to the assembler and linker, and allows the
21189 linker to perform certain optimizations that cannot be done until
21190 the final link.
21192 @item mhwmult=
21193 @opindex mhwmult=
21194 Describes the type of hardware multiply supported by the target.
21195 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21196 for the original 16-bit-only multiply supported by early MCUs.
21197 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21198 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21199 A value of @samp{auto} can also be given.  This tells GCC to deduce
21200 the hardware multiply support based upon the MCU name provided by the
21201 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21202 the MCU name is not recognized then no hardware multiply support is
21203 assumed.  @code{auto} is the default setting.
21205 Hardware multiplies are normally performed by calling a library
21206 routine.  This saves space in the generated code.  When compiling at
21207 @option{-O3} or higher however the hardware multiplier is invoked
21208 inline.  This makes for bigger, but faster code.
21210 The hardware multiply routines disable interrupts whilst running and
21211 restore the previous interrupt state when they finish.  This makes
21212 them safe to use inside interrupt handlers as well as in normal code.
21214 @item -minrt
21215 @opindex minrt
21216 Enable the use of a minimum runtime environment - no static
21217 initializers or constructors.  This is intended for memory-constrained
21218 devices.  The compiler includes special symbols in some objects
21219 that tell the linker and runtime which code fragments are required.
21221 @item -mcode-region=
21222 @itemx -mdata-region=
21223 @opindex mcode-region
21224 @opindex mdata-region
21225 These options tell the compiler where to place functions and data that
21226 do not have one of the @code{lower}, @code{upper}, @code{either} or
21227 @code{section} attributes.  Possible values are @code{lower},
21228 @code{upper}, @code{either} or @code{any}.  The first three behave
21229 like the corresponding attribute.  The fourth possible value -
21230 @code{any} - is the default.  It leaves placement entirely up to the
21231 linker script and how it assigns the standard sections
21232 (@code{.text}, @code{.data}, etc) to the memory regions.
21234 @item -msilicon-errata=
21235 @opindex msilicon-errata
21236 This option passes on a request to assembler to enable the fixes for
21237 the named silicon errata.
21239 @item -msilicon-errata-warn=
21240 @opindex msilicon-errata-warn
21241 This option passes on a request to the assembler to enable warning
21242 messages when a silicon errata might need to be applied.
21244 @end table
21246 @node NDS32 Options
21247 @subsection NDS32 Options
21248 @cindex NDS32 Options
21250 These options are defined for NDS32 implementations:
21252 @table @gcctabopt
21254 @item -mbig-endian
21255 @opindex mbig-endian
21256 Generate code in big-endian mode.
21258 @item -mlittle-endian
21259 @opindex mlittle-endian
21260 Generate code in little-endian mode.
21262 @item -mreduced-regs
21263 @opindex mreduced-regs
21264 Use reduced-set registers for register allocation.
21266 @item -mfull-regs
21267 @opindex mfull-regs
21268 Use full-set registers for register allocation.
21270 @item -mcmov
21271 @opindex mcmov
21272 Generate conditional move instructions.
21274 @item -mno-cmov
21275 @opindex mno-cmov
21276 Do not generate conditional move instructions.
21278 @item -mperf-ext
21279 @opindex mperf-ext
21280 Generate performance extension instructions.
21282 @item -mno-perf-ext
21283 @opindex mno-perf-ext
21284 Do not generate performance extension instructions.
21286 @item -mv3push
21287 @opindex mv3push
21288 Generate v3 push25/pop25 instructions.
21290 @item -mno-v3push
21291 @opindex mno-v3push
21292 Do not generate v3 push25/pop25 instructions.
21294 @item -m16-bit
21295 @opindex m16-bit
21296 Generate 16-bit instructions.
21298 @item -mno-16-bit
21299 @opindex mno-16-bit
21300 Do not generate 16-bit instructions.
21302 @item -misr-vector-size=@var{num}
21303 @opindex misr-vector-size
21304 Specify the size of each interrupt vector, which must be 4 or 16.
21306 @item -mcache-block-size=@var{num}
21307 @opindex mcache-block-size
21308 Specify the size of each cache block,
21309 which must be a power of 2 between 4 and 512.
21311 @item -march=@var{arch}
21312 @opindex march
21313 Specify the name of the target architecture.
21315 @item -mcmodel=@var{code-model}
21316 @opindex mcmodel
21317 Set the code model to one of
21318 @table @asis
21319 @item @samp{small}
21320 All the data and read-only data segments must be within 512KB addressing space.
21321 The text segment must be within 16MB addressing space.
21322 @item @samp{medium}
21323 The data segment must be within 512KB while the read-only data segment can be
21324 within 4GB addressing space.  The text segment should be still within 16MB
21325 addressing space.
21326 @item @samp{large}
21327 All the text and data segments can be within 4GB addressing space.
21328 @end table
21330 @item -mctor-dtor
21331 @opindex mctor-dtor
21332 Enable constructor/destructor feature.
21334 @item -mrelax
21335 @opindex mrelax
21336 Guide linker to relax instructions.
21338 @end table
21340 @node Nios II Options
21341 @subsection Nios II Options
21342 @cindex Nios II options
21343 @cindex Altera Nios II options
21345 These are the options defined for the Altera Nios II processor.
21347 @table @gcctabopt
21349 @item -G @var{num}
21350 @opindex G
21351 @cindex smaller data references
21352 Put global and static objects less than or equal to @var{num} bytes
21353 into the small data or BSS sections instead of the normal data or BSS
21354 sections.  The default value of @var{num} is 8.
21356 @item -mgpopt=@var{option}
21357 @item -mgpopt
21358 @itemx -mno-gpopt
21359 @opindex mgpopt
21360 @opindex mno-gpopt
21361 Generate (do not generate) GP-relative accesses.  The following 
21362 @var{option} names are recognized:
21364 @table @samp
21366 @item none
21367 Do not generate GP-relative accesses.
21369 @item local
21370 Generate GP-relative accesses for small data objects that are not 
21371 external, weak, or uninitialized common symbols.  
21372 Also use GP-relative addressing for objects that
21373 have been explicitly placed in a small data section via a @code{section}
21374 attribute.
21376 @item global
21377 As for @samp{local}, but also generate GP-relative accesses for
21378 small data objects that are external, weak, or common.  If you use this option,
21379 you must ensure that all parts of your program (including libraries) are
21380 compiled with the same @option{-G} setting.
21382 @item data
21383 Generate GP-relative accesses for all data objects in the program.  If you
21384 use this option, the entire data and BSS segments
21385 of your program must fit in 64K of memory and you must use an appropriate
21386 linker script to allocate them within the addressable range of the
21387 global pointer.
21389 @item all
21390 Generate GP-relative addresses for function pointers as well as data
21391 pointers.  If you use this option, the entire text, data, and BSS segments
21392 of your program must fit in 64K of memory and you must use an appropriate
21393 linker script to allocate them within the addressable range of the
21394 global pointer.
21396 @end table
21398 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21399 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21401 The default is @option{-mgpopt} except when @option{-fpic} or
21402 @option{-fPIC} is specified to generate position-independent code.
21403 Note that the Nios II ABI does not permit GP-relative accesses from
21404 shared libraries.
21406 You may need to specify @option{-mno-gpopt} explicitly when building
21407 programs that include large amounts of small data, including large
21408 GOT data sections.  In this case, the 16-bit offset for GP-relative
21409 addressing may not be large enough to allow access to the entire 
21410 small data section.
21412 @item -mgprel-sec=@var{regexp}
21413 @opindex mgprel-sec
21414 This option specifies additional section names that can be accessed via
21415 GP-relative addressing.  It is most useful in conjunction with 
21416 @code{section} attributes on variable declarations 
21417 (@pxref{Common Variable Attributes}) and a custom linker script.  
21418 The @var{regexp} is a POSIX Extended Regular Expression.
21420 This option does not affect the behavior of the @option{-G} option, and 
21421 and the specified sections are in addition to the standard @code{.sdata} 
21422 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21424 @item -mr0rel-sec=@var{regexp}
21425 @opindex mr0rel-sec
21426 This option specifies names of sections that can be accessed via a 
21427 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21428 of the 32-bit address space.  It is most useful in conjunction with 
21429 @code{section} attributes on variable declarations 
21430 (@pxref{Common Variable Attributes}) and a custom linker script.  
21431 The @var{regexp} is a POSIX Extended Regular Expression.
21433 In contrast to the use of GP-relative addressing for small data, 
21434 zero-based addressing is never generated by default and there are no 
21435 conventional section names used in standard linker scripts for sections
21436 in the low or high areas of memory.
21438 @item -mel
21439 @itemx -meb
21440 @opindex mel
21441 @opindex meb
21442 Generate little-endian (default) or big-endian (experimental) code,
21443 respectively.
21445 @item -march=@var{arch}
21446 @opindex march
21447 This specifies the name of the target Nios II architecture.  GCC uses this
21448 name to determine what kind of instructions it can emit when generating
21449 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21451 The preprocessor macro @code{__nios2_arch__} is available to programs,
21452 with value 1 or 2, indicating the targeted ISA level.
21454 @item -mbypass-cache
21455 @itemx -mno-bypass-cache
21456 @opindex mno-bypass-cache
21457 @opindex mbypass-cache
21458 Force all load and store instructions to always bypass cache by 
21459 using I/O variants of the instructions. The default is not to
21460 bypass the cache.
21462 @item -mno-cache-volatile 
21463 @itemx -mcache-volatile       
21464 @opindex mcache-volatile 
21465 @opindex mno-cache-volatile
21466 Volatile memory access bypass the cache using the I/O variants of 
21467 the load and store instructions. The default is not to bypass the cache.
21469 @item -mno-fast-sw-div
21470 @itemx -mfast-sw-div
21471 @opindex mno-fast-sw-div
21472 @opindex mfast-sw-div
21473 Do not use table-based fast divide for small numbers. The default 
21474 is to use the fast divide at @option{-O3} and above.
21476 @item -mno-hw-mul
21477 @itemx -mhw-mul
21478 @itemx -mno-hw-mulx
21479 @itemx -mhw-mulx
21480 @itemx -mno-hw-div
21481 @itemx -mhw-div
21482 @opindex mno-hw-mul
21483 @opindex mhw-mul
21484 @opindex mno-hw-mulx
21485 @opindex mhw-mulx
21486 @opindex mno-hw-div
21487 @opindex mhw-div
21488 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21489 instructions by the compiler. The default is to emit @code{mul}
21490 and not emit @code{div} and @code{mulx}.
21492 @item -mbmx
21493 @itemx -mno-bmx
21494 @itemx -mcdx
21495 @itemx -mno-cdx
21496 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21497 CDX (code density) instructions.  Enabling these instructions also
21498 requires @option{-march=r2}.  Since these instructions are optional
21499 extensions to the R2 architecture, the default is not to emit them.
21501 @item -mcustom-@var{insn}=@var{N}
21502 @itemx -mno-custom-@var{insn}
21503 @opindex mcustom-@var{insn}
21504 @opindex mno-custom-@var{insn}
21505 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21506 custom instruction with encoding @var{N} when generating code that uses 
21507 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21508 instruction 253 for single-precision floating-point add operations instead
21509 of the default behavior of using a library call.
21511 The following values of @var{insn} are supported.  Except as otherwise
21512 noted, floating-point operations are expected to be implemented with
21513 normal IEEE 754 semantics and correspond directly to the C operators or the
21514 equivalent GCC built-in functions (@pxref{Other Builtins}).
21516 Single-precision floating point:
21517 @table @asis
21519 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21520 Binary arithmetic operations.
21522 @item @samp{fnegs}
21523 Unary negation.
21525 @item @samp{fabss}
21526 Unary absolute value.
21528 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21529 Comparison operations.
21531 @item @samp{fmins}, @samp{fmaxs}
21532 Floating-point minimum and maximum.  These instructions are only
21533 generated if @option{-ffinite-math-only} is specified.
21535 @item @samp{fsqrts}
21536 Unary square root operation.
21538 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21539 Floating-point trigonometric and exponential functions.  These instructions
21540 are only generated if @option{-funsafe-math-optimizations} is also specified.
21542 @end table
21544 Double-precision floating point:
21545 @table @asis
21547 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21548 Binary arithmetic operations.
21550 @item @samp{fnegd}
21551 Unary negation.
21553 @item @samp{fabsd}
21554 Unary absolute value.
21556 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21557 Comparison operations.
21559 @item @samp{fmind}, @samp{fmaxd}
21560 Double-precision minimum and maximum.  These instructions are only
21561 generated if @option{-ffinite-math-only} is specified.
21563 @item @samp{fsqrtd}
21564 Unary square root operation.
21566 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21567 Double-precision trigonometric and exponential functions.  These instructions
21568 are only generated if @option{-funsafe-math-optimizations} is also specified.
21570 @end table
21572 Conversions:
21573 @table @asis
21574 @item @samp{fextsd}
21575 Conversion from single precision to double precision.
21577 @item @samp{ftruncds}
21578 Conversion from double precision to single precision.
21580 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21581 Conversion from floating point to signed or unsigned integer types, with
21582 truncation towards zero.
21584 @item @samp{round}
21585 Conversion from single-precision floating point to signed integer,
21586 rounding to the nearest integer and ties away from zero.
21587 This corresponds to the @code{__builtin_lroundf} function when
21588 @option{-fno-math-errno} is used.
21590 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21591 Conversion from signed or unsigned integer types to floating-point types.
21593 @end table
21595 In addition, all of the following transfer instructions for internal
21596 registers X and Y must be provided to use any of the double-precision
21597 floating-point instructions.  Custom instructions taking two
21598 double-precision source operands expect the first operand in the
21599 64-bit register X.  The other operand (or only operand of a unary
21600 operation) is given to the custom arithmetic instruction with the
21601 least significant half in source register @var{src1} and the most
21602 significant half in @var{src2}.  A custom instruction that returns a
21603 double-precision result returns the most significant 32 bits in the
21604 destination register and the other half in 32-bit register Y.  
21605 GCC automatically generates the necessary code sequences to write
21606 register X and/or read register Y when double-precision floating-point
21607 instructions are used.
21609 @table @asis
21611 @item @samp{fwrx}
21612 Write @var{src1} into the least significant half of X and @var{src2} into
21613 the most significant half of X.
21615 @item @samp{fwry}
21616 Write @var{src1} into Y.
21618 @item @samp{frdxhi}, @samp{frdxlo}
21619 Read the most or least (respectively) significant half of X and store it in
21620 @var{dest}.
21622 @item @samp{frdy}
21623 Read the value of Y and store it into @var{dest}.
21624 @end table
21626 Note that you can gain more local control over generation of Nios II custom
21627 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21628 and @code{target("no-custom-@var{insn}")} function attributes
21629 (@pxref{Function Attributes})
21630 or pragmas (@pxref{Function Specific Option Pragmas}).
21632 @item -mcustom-fpu-cfg=@var{name}
21633 @opindex mcustom-fpu-cfg
21635 This option enables a predefined, named set of custom instruction encodings
21636 (see @option{-mcustom-@var{insn}} above).  
21637 Currently, the following sets are defined:
21639 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21640 @gccoptlist{-mcustom-fmuls=252 @gol
21641 -mcustom-fadds=253 @gol
21642 -mcustom-fsubs=254 @gol
21643 -fsingle-precision-constant}
21645 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21646 @gccoptlist{-mcustom-fmuls=252 @gol
21647 -mcustom-fadds=253 @gol
21648 -mcustom-fsubs=254 @gol
21649 -mcustom-fdivs=255 @gol
21650 -fsingle-precision-constant}
21652 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21653 @gccoptlist{-mcustom-floatus=243 @gol
21654 -mcustom-fixsi=244 @gol
21655 -mcustom-floatis=245 @gol
21656 -mcustom-fcmpgts=246 @gol
21657 -mcustom-fcmples=249 @gol
21658 -mcustom-fcmpeqs=250 @gol
21659 -mcustom-fcmpnes=251 @gol
21660 -mcustom-fmuls=252 @gol
21661 -mcustom-fadds=253 @gol
21662 -mcustom-fsubs=254 @gol
21663 -mcustom-fdivs=255 @gol
21664 -fsingle-precision-constant}
21666 Custom instruction assignments given by individual
21667 @option{-mcustom-@var{insn}=} options override those given by
21668 @option{-mcustom-fpu-cfg=}, regardless of the
21669 order of the options on the command line.
21671 Note that you can gain more local control over selection of a FPU
21672 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21673 function attribute (@pxref{Function Attributes})
21674 or pragma (@pxref{Function Specific Option Pragmas}).
21676 @end table
21678 These additional @samp{-m} options are available for the Altera Nios II
21679 ELF (bare-metal) target:
21681 @table @gcctabopt
21683 @item -mhal
21684 @opindex mhal
21685 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21686 startup and termination code, and is typically used in conjunction with
21687 @option{-msys-crt0=} to specify the location of the alternate startup code
21688 provided by the HAL BSP.
21690 @item -msmallc
21691 @opindex msmallc
21692 Link with a limited version of the C library, @option{-lsmallc}, rather than
21693 Newlib.
21695 @item -msys-crt0=@var{startfile}
21696 @opindex msys-crt0
21697 @var{startfile} is the file name of the startfile (crt0) to use 
21698 when linking.  This option is only useful in conjunction with @option{-mhal}.
21700 @item -msys-lib=@var{systemlib}
21701 @opindex msys-lib
21702 @var{systemlib} is the library name of the library that provides
21703 low-level system calls required by the C library,
21704 e.g. @code{read} and @code{write}.
21705 This option is typically used to link with a library provided by a HAL BSP.
21707 @end table
21709 @node Nvidia PTX Options
21710 @subsection Nvidia PTX Options
21711 @cindex Nvidia PTX options
21712 @cindex nvptx options
21714 These options are defined for Nvidia PTX:
21716 @table @gcctabopt
21718 @item -m32
21719 @itemx -m64
21720 @opindex m32
21721 @opindex m64
21722 Generate code for 32-bit or 64-bit ABI.
21724 @item -mmainkernel
21725 @opindex mmainkernel
21726 Link in code for a __main kernel.  This is for stand-alone instead of
21727 offloading execution.
21729 @item -moptimize
21730 @opindex moptimize
21731 Apply partitioned execution optimizations.  This is the default when any
21732 level of optimization is selected.
21734 @item -msoft-stack
21735 @opindex msoft-stack
21736 Generate code that does not use @code{.local} memory
21737 directly for stack storage. Instead, a per-warp stack pointer is
21738 maintained explicitly. This enables variable-length stack allocation (with
21739 variable-length arrays or @code{alloca}), and when global memory is used for
21740 underlying storage, makes it possible to access automatic variables from other
21741 threads, or with atomic instructions. This code generation variant is used
21742 for OpenMP offloading, but the option is exposed on its own for the purpose
21743 of testing the compiler; to generate code suitable for linking into programs
21744 using OpenMP offloading, use option @option{-mgomp}.
21746 @item -muniform-simt
21747 @opindex muniform-simt
21748 Switch to code generation variant that allows to execute all threads in each
21749 warp, while maintaining memory state and side effects as if only one thread
21750 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21751 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21752 current lane index equals the master lane index), and the register being
21753 assigned is copied via a shuffle instruction from the master lane.  Outside of
21754 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21755 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21756 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21757 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21758 with current lane index to compute the master lane index.
21760 @item -mgomp
21761 @opindex mgomp
21762 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21763 @option{-muniform-simt} options, and selects corresponding multilib variant.
21765 @end table
21767 @node PDP-11 Options
21768 @subsection PDP-11 Options
21769 @cindex PDP-11 Options
21771 These options are defined for the PDP-11:
21773 @table @gcctabopt
21774 @item -mfpu
21775 @opindex mfpu
21776 Use hardware FPP floating point.  This is the default.  (FIS floating
21777 point on the PDP-11/40 is not supported.)
21779 @item -msoft-float
21780 @opindex msoft-float
21781 Do not use hardware floating point.
21783 @item -mac0
21784 @opindex mac0
21785 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21787 @item -mno-ac0
21788 @opindex mno-ac0
21789 Return floating-point results in memory.  This is the default.
21791 @item -m40
21792 @opindex m40
21793 Generate code for a PDP-11/40.
21795 @item -m45
21796 @opindex m45
21797 Generate code for a PDP-11/45.  This is the default.
21799 @item -m10
21800 @opindex m10
21801 Generate code for a PDP-11/10.
21803 @item -mbcopy-builtin
21804 @opindex mbcopy-builtin
21805 Use inline @code{movmemhi} patterns for copying memory.  This is the
21806 default.
21808 @item -mbcopy
21809 @opindex mbcopy
21810 Do not use inline @code{movmemhi} patterns for copying memory.
21812 @item -mint16
21813 @itemx -mno-int32
21814 @opindex mint16
21815 @opindex mno-int32
21816 Use 16-bit @code{int}.  This is the default.
21818 @item -mint32
21819 @itemx -mno-int16
21820 @opindex mint32
21821 @opindex mno-int16
21822 Use 32-bit @code{int}.
21824 @item -mfloat64
21825 @itemx -mno-float32
21826 @opindex mfloat64
21827 @opindex mno-float32
21828 Use 64-bit @code{float}.  This is the default.
21830 @item -mfloat32
21831 @itemx -mno-float64
21832 @opindex mfloat32
21833 @opindex mno-float64
21834 Use 32-bit @code{float}.
21836 @item -mabshi
21837 @opindex mabshi
21838 Use @code{abshi2} pattern.  This is the default.
21840 @item -mno-abshi
21841 @opindex mno-abshi
21842 Do not use @code{abshi2} pattern.
21844 @item -mbranch-expensive
21845 @opindex mbranch-expensive
21846 Pretend that branches are expensive.  This is for experimenting with
21847 code generation only.
21849 @item -mbranch-cheap
21850 @opindex mbranch-cheap
21851 Do not pretend that branches are expensive.  This is the default.
21853 @item -munix-asm
21854 @opindex munix-asm
21855 Use Unix assembler syntax.  This is the default when configured for
21856 @samp{pdp11-*-bsd}.
21858 @item -mdec-asm
21859 @opindex mdec-asm
21860 Use DEC assembler syntax.  This is the default when configured for any
21861 PDP-11 target other than @samp{pdp11-*-bsd}.
21862 @end table
21864 @node picoChip Options
21865 @subsection picoChip Options
21866 @cindex picoChip options
21868 These @samp{-m} options are defined for picoChip implementations:
21870 @table @gcctabopt
21872 @item -mae=@var{ae_type}
21873 @opindex mcpu
21874 Set the instruction set, register set, and instruction scheduling
21875 parameters for array element type @var{ae_type}.  Supported values
21876 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21878 @option{-mae=ANY} selects a completely generic AE type.  Code
21879 generated with this option runs on any of the other AE types.  The
21880 code is not as efficient as it would be if compiled for a specific
21881 AE type, and some types of operation (e.g., multiplication) do not
21882 work properly on all types of AE.
21884 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21885 for compiled code, and is the default.
21887 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21888 option may suffer from poor performance of byte (char) manipulation,
21889 since the DSP AE does not provide hardware support for byte load/stores.
21891 @item -msymbol-as-address
21892 Enable the compiler to directly use a symbol name as an address in a
21893 load/store instruction, without first loading it into a
21894 register.  Typically, the use of this option generates larger
21895 programs, which run faster than when the option isn't used.  However, the
21896 results vary from program to program, so it is left as a user option,
21897 rather than being permanently enabled.
21899 @item -mno-inefficient-warnings
21900 Disables warnings about the generation of inefficient code.  These
21901 warnings can be generated, for example, when compiling code that
21902 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21903 no hardware support for byte-level memory operations, so all byte
21904 load/stores must be synthesized from word load/store operations.  This is
21905 inefficient and a warning is generated to indicate
21906 that you should rewrite the code to avoid byte operations, or to target
21907 an AE type that has the necessary hardware support.  This option disables
21908 these warnings.
21910 @end table
21912 @node PowerPC Options
21913 @subsection PowerPC Options
21914 @cindex PowerPC options
21916 These are listed under @xref{RS/6000 and PowerPC Options}.
21918 @node RISC-V Options
21919 @subsection RISC-V Options
21920 @cindex RISC-V Options
21922 These command-line options are defined for RISC-V targets:
21924 @table @gcctabopt
21925 @item -mbranch-cost=@var{n}
21926 @opindex mbranch-cost
21927 Set the cost of branches to roughly @var{n} instructions.
21929 @item -mplt
21930 @itemx -mno-plt
21931 @opindex plt
21932 When generating PIC code, do or don't allow the use of PLTs. Ignored for
21933 non-PIC.  The default is @option{-mplt}.
21935 @item -mabi=@var{ABI-string}
21936 @opindex mabi
21937 Specify integer and floating-point calling convention.  @var{ABI-string}
21938 contains two parts: the size of integer types and the registers used for
21939 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
21940 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
21941 32-bit), and that floating-point values up to 64 bits wide are passed in F
21942 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
21943 allows the compiler to generate code that uses the F and D extensions but only
21944 allows floating-point values up to 32 bits long to be passed in registers; or
21945 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
21946 passed in registers.
21948 The default for this argument is system dependent, users who want a specific
21949 calling convention should specify one explicitly.  The valid calling
21950 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
21951 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
21952 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
21953 invalid because the ABI requires 64-bit values be passed in F registers, but F
21954 registers are only 32 bits wide.
21956 @item -mfdiv
21957 @itemx -mno-fdiv
21958 @opindex mfdiv
21959 Do or don't use hardware floating-point divide and square root instructions.
21960 This requires the F or D extensions for floating-point registers.  The default
21961 is to use them if the specified architecture has these instructions.
21963 @item -mdiv
21964 @itemx -mno-div
21965 @opindex mdiv
21966 Do or don't use hardware instructions for integer division.  This requires the
21967 M extension.  The default is to use them if the specified architecture has
21968 these instructions.
21970 @item -march=@var{ISA-string}
21971 @opindex march
21972 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21973 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21975 @item -mtune=@var{processor-string}
21976 @opindex mtune
21977 Optimize the output for the given processor, specified by microarchitecture
21978 name.
21980 @item -msmall-data-limit=@var{n}
21981 @opindex msmall-data-limit
21982 Put global and static data smaller than @var{n} bytes into a special section
21983 (on some targets).
21985 @item -msave-restore
21986 @itemx -mno-save-restore
21987 @opindex msave-restore
21988 Do or don't use smaller but slower prologue and epilogue code that uses
21989 library function calls.  The default is to use fast inline prologues and
21990 epilogues.
21992 @item -mstrict-align
21993 @itemx -mno-strict-align
21994 @opindex mstrict-align
21995 Do not or do generate unaligned memory accesses.  The default is set depending
21996 on whether the processor we are optimizing for supports fast unaligned access
21997 or not.
21999 @item -mcmodel=medlow
22000 @opindex mcmodel=medlow
22001 Generate code for the medium-low code model. The program and its statically
22002 defined symbols must lie within a single 2 GiB address range and must lie
22003 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
22004 statically or dynamically linked. This is the default code model.
22006 @item -mcmodel=medany
22007 @opindex mcmodel=medany
22008 Generate code for the medium-any code model. The program and its statically
22009 defined symbols must be within any single 2 GiB address range. Programs can be
22010 statically or dynamically linked.
22012 @item -mexplicit-relocs
22013 @itemx -mno-exlicit-relocs
22014 Use or do not use assembler relocation operators when dealing with symbolic
22015 addresses.  The alternative is to use assembler macros instead, which may
22016 limit optimization.
22018 @end table
22020 @node RL78 Options
22021 @subsection RL78 Options
22022 @cindex RL78 Options
22024 @table @gcctabopt
22026 @item -msim
22027 @opindex msim
22028 Links in additional target libraries to support operation within a
22029 simulator.
22031 @item -mmul=none
22032 @itemx -mmul=g10
22033 @itemx -mmul=g13
22034 @itemx -mmul=g14
22035 @itemx -mmul=rl78
22036 @opindex mmul
22037 Specifies the type of hardware multiplication and division support to
22038 be used.  The simplest is @code{none}, which uses software for both
22039 multiplication and division.  This is the default.  The @code{g13}
22040 value is for the hardware multiply/divide peripheral found on the
22041 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
22042 the multiplication and division instructions supported by the RL78/G14
22043 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
22044 the value @code{mg10} is an alias for @code{none}.
22046 In addition a C preprocessor macro is defined, based upon the setting
22047 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
22048 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
22050 @item -mcpu=g10
22051 @itemx -mcpu=g13
22052 @itemx -mcpu=g14
22053 @itemx -mcpu=rl78
22054 @opindex mcpu
22055 Specifies the RL78 core to target.  The default is the G14 core, also
22056 known as an S3 core or just RL78.  The G13 or S2 core does not have
22057 multiply or divide instructions, instead it uses a hardware peripheral
22058 for these operations.  The G10 or S1 core does not have register
22059 banks, so it uses a different calling convention.
22061 If this option is set it also selects the type of hardware multiply
22062 support to use, unless this is overridden by an explicit
22063 @option{-mmul=none} option on the command line.  Thus specifying
22064 @option{-mcpu=g13} enables the use of the G13 hardware multiply
22065 peripheral and specifying @option{-mcpu=g10} disables the use of
22066 hardware multiplications altogether.
22068 Note, although the RL78/G14 core is the default target, specifying
22069 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
22070 change the behavior of the toolchain since it also enables G14
22071 hardware multiply support.  If these options are not specified on the
22072 command line then software multiplication routines will be used even
22073 though the code targets the RL78 core.  This is for backwards
22074 compatibility with older toolchains which did not have hardware
22075 multiply and divide support.
22077 In addition a C preprocessor macro is defined, based upon the setting
22078 of this option.  Possible values are: @code{__RL78_G10__},
22079 @code{__RL78_G13__} or @code{__RL78_G14__}.
22081 @item -mg10
22082 @itemx -mg13
22083 @itemx -mg14
22084 @itemx -mrl78
22085 @opindex mg10
22086 @opindex mg13
22087 @opindex mg14
22088 @opindex mrl78
22089 These are aliases for the corresponding @option{-mcpu=} option.  They
22090 are provided for backwards compatibility.
22092 @item -mallregs
22093 @opindex mallregs
22094 Allow the compiler to use all of the available registers.  By default
22095 registers @code{r24..r31} are reserved for use in interrupt handlers.
22096 With this option enabled these registers can be used in ordinary
22097 functions as well.
22099 @item -m64bit-doubles
22100 @itemx -m32bit-doubles
22101 @opindex m64bit-doubles
22102 @opindex m32bit-doubles
22103 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22104 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22105 @option{-m32bit-doubles}.
22107 @item -msave-mduc-in-interrupts
22108 @item -mno-save-mduc-in-interrupts
22109 @opindex msave-mduc-in-interrupts
22110 @opindex mno-save-mduc-in-interrupts
22111 Specifies that interrupt handler functions should preserve the
22112 MDUC registers.  This is only necessary if normal code might use
22113 the MDUC registers, for example because it performs multiplication
22114 and division operations.  The default is to ignore the MDUC registers
22115 as this makes the interrupt handlers faster.  The target option -mg13
22116 needs to be passed for this to work as this feature is only available
22117 on the G13 target (S2 core).  The MDUC registers will only be saved
22118 if the interrupt handler performs a multiplication or division
22119 operation or it calls another function.
22121 @end table
22123 @node RS/6000 and PowerPC Options
22124 @subsection IBM RS/6000 and PowerPC Options
22125 @cindex RS/6000 and PowerPC Options
22126 @cindex IBM RS/6000 and PowerPC Options
22128 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
22129 @table @gcctabopt
22130 @item -mpowerpc-gpopt
22131 @itemx -mno-powerpc-gpopt
22132 @itemx -mpowerpc-gfxopt
22133 @itemx -mno-powerpc-gfxopt
22134 @need 800
22135 @itemx -mpowerpc64
22136 @itemx -mno-powerpc64
22137 @itemx -mmfcrf
22138 @itemx -mno-mfcrf
22139 @itemx -mpopcntb
22140 @itemx -mno-popcntb
22141 @itemx -mpopcntd
22142 @itemx -mno-popcntd
22143 @itemx -mfprnd
22144 @itemx -mno-fprnd
22145 @need 800
22146 @itemx -mcmpb
22147 @itemx -mno-cmpb
22148 @itemx -mmfpgpr
22149 @itemx -mno-mfpgpr
22150 @itemx -mhard-dfp
22151 @itemx -mno-hard-dfp
22152 @opindex mpowerpc-gpopt
22153 @opindex mno-powerpc-gpopt
22154 @opindex mpowerpc-gfxopt
22155 @opindex mno-powerpc-gfxopt
22156 @opindex mpowerpc64
22157 @opindex mno-powerpc64
22158 @opindex mmfcrf
22159 @opindex mno-mfcrf
22160 @opindex mpopcntb
22161 @opindex mno-popcntb
22162 @opindex mpopcntd
22163 @opindex mno-popcntd
22164 @opindex mfprnd
22165 @opindex mno-fprnd
22166 @opindex mcmpb
22167 @opindex mno-cmpb
22168 @opindex mmfpgpr
22169 @opindex mno-mfpgpr
22170 @opindex mhard-dfp
22171 @opindex mno-hard-dfp
22172 You use these options to specify which instructions are available on the
22173 processor you are using.  The default value of these options is
22174 determined when configuring GCC@.  Specifying the
22175 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22176 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22177 rather than the options listed above.
22179 Specifying @option{-mpowerpc-gpopt} allows
22180 GCC to use the optional PowerPC architecture instructions in the
22181 General Purpose group, including floating-point square root.  Specifying
22182 @option{-mpowerpc-gfxopt} allows GCC to
22183 use the optional PowerPC architecture instructions in the Graphics
22184 group, including floating-point select.
22186 The @option{-mmfcrf} option allows GCC to generate the move from
22187 condition register field instruction implemented on the POWER4
22188 processor and other processors that support the PowerPC V2.01
22189 architecture.
22190 The @option{-mpopcntb} option allows GCC to generate the popcount and
22191 double-precision FP reciprocal estimate instruction implemented on the
22192 POWER5 processor and other processors that support the PowerPC V2.02
22193 architecture.
22194 The @option{-mpopcntd} option allows GCC to generate the popcount
22195 instruction implemented on the POWER7 processor and other processors
22196 that support the PowerPC V2.06 architecture.
22197 The @option{-mfprnd} option allows GCC to generate the FP round to
22198 integer instructions implemented on the POWER5+ processor and other
22199 processors that support the PowerPC V2.03 architecture.
22200 The @option{-mcmpb} option allows GCC to generate the compare bytes
22201 instruction implemented on the POWER6 processor and other processors
22202 that support the PowerPC V2.05 architecture.
22203 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
22204 general-purpose register instructions implemented on the POWER6X
22205 processor and other processors that support the extended PowerPC V2.05
22206 architecture.
22207 The @option{-mhard-dfp} option allows GCC to generate the decimal
22208 floating-point instructions implemented on some POWER processors.
22210 The @option{-mpowerpc64} option allows GCC to generate the additional
22211 64-bit instructions that are found in the full PowerPC64 architecture
22212 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
22213 @option{-mno-powerpc64}.
22215 @item -mcpu=@var{cpu_type}
22216 @opindex mcpu
22217 Set architecture type, register usage, and
22218 instruction scheduling parameters for machine type @var{cpu_type}.
22219 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
22220 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
22221 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
22222 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
22223 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
22224 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
22225 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
22226 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
22227 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
22228 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
22229 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
22230 and @samp{rs64}.
22232 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
22233 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
22234 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
22235 architecture machine types, with an appropriate, generic processor
22236 model assumed for scheduling purposes.
22238 The other options specify a specific processor.  Code generated under
22239 those options runs best on that processor, and may not run at all on
22240 others.
22242 The @option{-mcpu} options automatically enable or disable the
22243 following options:
22245 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
22246 -mpopcntb -mpopcntd  -mpowerpc64 @gol
22247 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
22248 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
22249 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
22250 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
22252 The particular options set for any particular CPU varies between
22253 compiler versions, depending on what setting seems to produce optimal
22254 code for that CPU; it doesn't necessarily reflect the actual hardware's
22255 capabilities.  If you wish to set an individual option to a particular
22256 value, you may specify it after the @option{-mcpu} option, like
22257 @option{-mcpu=970 -mno-altivec}.
22259 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
22260 not enabled or disabled by the @option{-mcpu} option at present because
22261 AIX does not have full support for these options.  You may still
22262 enable or disable them individually if you're sure it'll work in your
22263 environment.
22265 @item -mtune=@var{cpu_type}
22266 @opindex mtune
22267 Set the instruction scheduling parameters for machine type
22268 @var{cpu_type}, but do not set the architecture type or register usage,
22269 as @option{-mcpu=@var{cpu_type}} does.  The same
22270 values for @var{cpu_type} are used for @option{-mtune} as for
22271 @option{-mcpu}.  If both are specified, the code generated uses the
22272 architecture and registers set by @option{-mcpu}, but the
22273 scheduling parameters set by @option{-mtune}.
22275 @item -mcmodel=small
22276 @opindex mcmodel=small
22277 Generate PowerPC64 code for the small model: The TOC is limited to
22278 64k.
22280 @item -mcmodel=medium
22281 @opindex mcmodel=medium
22282 Generate PowerPC64 code for the medium model: The TOC and other static
22283 data may be up to a total of 4G in size.  This is the default for 64-bit
22284 Linux.
22286 @item -mcmodel=large
22287 @opindex mcmodel=large
22288 Generate PowerPC64 code for the large model: The TOC may be up to 4G
22289 in size.  Other data and code is only limited by the 64-bit address
22290 space.
22292 @item -maltivec
22293 @itemx -mno-altivec
22294 @opindex maltivec
22295 @opindex mno-altivec
22296 Generate code that uses (does not use) AltiVec instructions, and also
22297 enable the use of built-in functions that allow more direct access to
22298 the AltiVec instruction set.  You may also need to set
22299 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
22300 enhancements.
22302 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
22303 @option{-maltivec=be}, the element order for AltiVec intrinsics such
22304 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
22305 match array element order corresponding to the endianness of the
22306 target.  That is, element zero identifies the leftmost element in a
22307 vector register when targeting a big-endian platform, and identifies
22308 the rightmost element in a vector register when targeting a
22309 little-endian platform.
22311 @item -maltivec=be
22312 @opindex maltivec=be
22313 Generate AltiVec instructions using big-endian element order,
22314 regardless of whether the target is big- or little-endian.  This is
22315 the default when targeting a big-endian platform.
22317 The element order is used to interpret element numbers in AltiVec
22318 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22319 @code{vec_insert}.  By default, these match array element order
22320 corresponding to the endianness for the target.
22322 @item -maltivec=le
22323 @opindex maltivec=le
22324 Generate AltiVec instructions using little-endian element order,
22325 regardless of whether the target is big- or little-endian.  This is
22326 the default when targeting a little-endian platform.  This option is
22327 currently ignored when targeting a big-endian platform.
22329 The element order is used to interpret element numbers in AltiVec
22330 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22331 @code{vec_insert}.  By default, these match array element order
22332 corresponding to the endianness for the target.
22334 @item -mvrsave
22335 @itemx -mno-vrsave
22336 @opindex mvrsave
22337 @opindex mno-vrsave
22338 Generate VRSAVE instructions when generating AltiVec code.
22340 @item -msecure-plt
22341 @opindex msecure-plt
22342 Generate code that allows @command{ld} and @command{ld.so}
22343 to build executables and shared
22344 libraries with non-executable @code{.plt} and @code{.got} sections.
22345 This is a PowerPC
22346 32-bit SYSV ABI option.
22348 @item -mbss-plt
22349 @opindex mbss-plt
22350 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22351 fills in, and
22352 requires @code{.plt} and @code{.got}
22353 sections that are both writable and executable.
22354 This is a PowerPC 32-bit SYSV ABI option.
22356 @item -misel
22357 @itemx -mno-isel
22358 @opindex misel
22359 @opindex mno-isel
22360 This switch enables or disables the generation of ISEL instructions.
22362 @item -misel=@var{yes/no}
22363 This switch has been deprecated.  Use @option{-misel} and
22364 @option{-mno-isel} instead.
22366 @item -mspe
22367 @itemx -mno-spe
22368 @opindex mspe
22369 @opindex mno-spe
22370 This switch enables or disables the generation of SPE simd
22371 instructions.
22373 @item -mpaired
22374 @itemx -mno-paired
22375 @opindex mpaired
22376 @opindex mno-paired
22377 This switch enables or disables the generation of PAIRED simd
22378 instructions.
22380 @item -mspe=@var{yes/no}
22381 This option has been deprecated.  Use @option{-mspe} and
22382 @option{-mno-spe} instead.
22384 @item -mvsx
22385 @itemx -mno-vsx
22386 @opindex mvsx
22387 @opindex mno-vsx
22388 Generate code that uses (does not use) vector/scalar (VSX)
22389 instructions, and also enable the use of built-in functions that allow
22390 more direct access to the VSX instruction set.
22392 @item -mcrypto
22393 @itemx -mno-crypto
22394 @opindex mcrypto
22395 @opindex mno-crypto
22396 Enable the use (disable) of the built-in functions that allow direct
22397 access to the cryptographic instructions that were added in version
22398 2.07 of the PowerPC ISA.
22400 @item -mdirect-move
22401 @itemx -mno-direct-move
22402 @opindex mdirect-move
22403 @opindex mno-direct-move
22404 Generate code that uses (does not use) the instructions to move data
22405 between the general purpose registers and the vector/scalar (VSX)
22406 registers that were added in version 2.07 of the PowerPC ISA.
22408 @item -mhtm
22409 @itemx -mno-htm
22410 @opindex mhtm
22411 @opindex mno-htm
22412 Enable (disable) the use of the built-in functions that allow direct
22413 access to the Hardware Transactional Memory (HTM) instructions that
22414 were added in version 2.07 of the PowerPC ISA.
22416 @item -mpower8-fusion
22417 @itemx -mno-power8-fusion
22418 @opindex mpower8-fusion
22419 @opindex mno-power8-fusion
22420 Generate code that keeps (does not keeps) some integer operations
22421 adjacent so that the instructions can be fused together on power8 and
22422 later processors.
22424 @item -mpower8-vector
22425 @itemx -mno-power8-vector
22426 @opindex mpower8-vector
22427 @opindex mno-power8-vector
22428 Generate code that uses (does not use) the vector and scalar
22429 instructions that were added in version 2.07 of the PowerPC ISA.  Also
22430 enable the use of built-in functions that allow more direct access to
22431 the vector instructions.
22433 @item -mquad-memory
22434 @itemx -mno-quad-memory
22435 @opindex mquad-memory
22436 @opindex mno-quad-memory
22437 Generate code that uses (does not use) the non-atomic quad word memory
22438 instructions.  The @option{-mquad-memory} option requires use of
22439 64-bit mode.
22441 @item -mquad-memory-atomic
22442 @itemx -mno-quad-memory-atomic
22443 @opindex mquad-memory-atomic
22444 @opindex mno-quad-memory-atomic
22445 Generate code that uses (does not use) the atomic quad word memory
22446 instructions.  The @option{-mquad-memory-atomic} option requires use of
22447 64-bit mode.
22449 @item -mfloat128
22450 @itemx -mno-float128
22451 @opindex mfloat128
22452 @opindex mno-float128
22453 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22454 and use either software emulation for IEEE 128-bit floating point or
22455 hardware instructions.
22457 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
22458 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
22459 use the IEEE 128-bit floating point support.  The IEEE 128-bit
22460 floating point support only works on PowerPC Linux systems.
22462 The default for @option{-mfloat128} is enabled on PowerPC Linux
22463 systems using the VSX instruction set, and disabled on other systems.
22465 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
22466 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
22467 point support will also enable the generation of ISA 3.0 IEEE 128-bit
22468 floating point instructions.  Otherwise, if you do not specify to
22469 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
22470 system, IEEE 128-bit floating point will be done with software
22471 emulation.
22473 @item -mfloat128-hardware
22474 @itemx -mno-float128-hardware
22475 @opindex mfloat128-hardware
22476 @opindex mno-float128-hardware
22477 Enable/disable using ISA 3.0 hardware instructions to support the
22478 @var{__float128} data type.
22480 The default for @option{-mfloat128-hardware} is enabled on PowerPC
22481 Linux systems using the ISA 3.0 instruction set, and disabled on other
22482 systems.
22484 @item -mfloat-gprs=@var{yes/single/double/no}
22485 @itemx -mfloat-gprs
22486 @opindex mfloat-gprs
22487 This switch enables or disables the generation of floating-point
22488 operations on the general-purpose registers for architectures that
22489 support it.
22491 The argument @samp{yes} or @samp{single} enables the use of
22492 single-precision floating-point operations.
22494 The argument @samp{double} enables the use of single and
22495 double-precision floating-point operations.
22497 The argument @samp{no} disables floating-point operations on the
22498 general-purpose registers.
22500 This option is currently only available on the MPC854x.
22502 @item -m32
22503 @itemx -m64
22504 @opindex m32
22505 @opindex m64
22506 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
22507 targets (including GNU/Linux).  The 32-bit environment sets int, long
22508 and pointer to 32 bits and generates code that runs on any PowerPC
22509 variant.  The 64-bit environment sets int to 32 bits and long and
22510 pointer to 64 bits, and generates code for PowerPC64, as for
22511 @option{-mpowerpc64}.
22513 @item -mfull-toc
22514 @itemx -mno-fp-in-toc
22515 @itemx -mno-sum-in-toc
22516 @itemx -mminimal-toc
22517 @opindex mfull-toc
22518 @opindex mno-fp-in-toc
22519 @opindex mno-sum-in-toc
22520 @opindex mminimal-toc
22521 Modify generation of the TOC (Table Of Contents), which is created for
22522 every executable file.  The @option{-mfull-toc} option is selected by
22523 default.  In that case, GCC allocates at least one TOC entry for
22524 each unique non-automatic variable reference in your program.  GCC
22525 also places floating-point constants in the TOC@.  However, only
22526 16,384 entries are available in the TOC@.
22528 If you receive a linker error message that saying you have overflowed
22529 the available TOC space, you can reduce the amount of TOC space used
22530 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22531 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22532 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22533 generate code to calculate the sum of an address and a constant at
22534 run time instead of putting that sum into the TOC@.  You may specify one
22535 or both of these options.  Each causes GCC to produce very slightly
22536 slower and larger code at the expense of conserving TOC space.
22538 If you still run out of space in the TOC even when you specify both of
22539 these options, specify @option{-mminimal-toc} instead.  This option causes
22540 GCC to make only one TOC entry for every file.  When you specify this
22541 option, GCC produces code that is slower and larger but which
22542 uses extremely little TOC space.  You may wish to use this option
22543 only on files that contain less frequently-executed code.
22545 @item -maix64
22546 @itemx -maix32
22547 @opindex maix64
22548 @opindex maix32
22549 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22550 @code{long} type, and the infrastructure needed to support them.
22551 Specifying @option{-maix64} implies @option{-mpowerpc64},
22552 while @option{-maix32} disables the 64-bit ABI and
22553 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22555 @item -mxl-compat
22556 @itemx -mno-xl-compat
22557 @opindex mxl-compat
22558 @opindex mno-xl-compat
22559 Produce code that conforms more closely to IBM XL compiler semantics
22560 when using AIX-compatible ABI@.  Pass floating-point arguments to
22561 prototyped functions beyond the register save area (RSA) on the stack
22562 in addition to argument FPRs.  Do not assume that most significant
22563 double in 128-bit long double value is properly rounded when comparing
22564 values and converting to double.  Use XL symbol names for long double
22565 support routines.
22567 The AIX calling convention was extended but not initially documented to
22568 handle an obscure K&R C case of calling a function that takes the
22569 address of its arguments with fewer arguments than declared.  IBM XL
22570 compilers access floating-point arguments that do not fit in the
22571 RSA from the stack when a subroutine is compiled without
22572 optimization.  Because always storing floating-point arguments on the
22573 stack is inefficient and rarely needed, this option is not enabled by
22574 default and only is necessary when calling subroutines compiled by IBM
22575 XL compilers without optimization.
22577 @item -mpe
22578 @opindex mpe
22579 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22580 application written to use message passing with special startup code to
22581 enable the application to run.  The system must have PE installed in the
22582 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22583 must be overridden with the @option{-specs=} option to specify the
22584 appropriate directory location.  The Parallel Environment does not
22585 support threads, so the @option{-mpe} option and the @option{-pthread}
22586 option are incompatible.
22588 @item -malign-natural
22589 @itemx -malign-power
22590 @opindex malign-natural
22591 @opindex malign-power
22592 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22593 @option{-malign-natural} overrides the ABI-defined alignment of larger
22594 types, such as floating-point doubles, on their natural size-based boundary.
22595 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22596 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22598 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22599 is not supported.
22601 @item -msoft-float
22602 @itemx -mhard-float
22603 @opindex msoft-float
22604 @opindex mhard-float
22605 Generate code that does not use (uses) the floating-point register set.
22606 Software floating-point emulation is provided if you use the
22607 @option{-msoft-float} option, and pass the option to GCC when linking.
22609 @item -msingle-float
22610 @itemx -mdouble-float
22611 @opindex msingle-float
22612 @opindex mdouble-float
22613 Generate code for single- or double-precision floating-point operations.
22614 @option{-mdouble-float} implies @option{-msingle-float}.
22616 @item -msimple-fpu
22617 @opindex msimple-fpu
22618 Do not generate @code{sqrt} and @code{div} instructions for hardware
22619 floating-point unit.
22621 @item -mfpu=@var{name}
22622 @opindex mfpu
22623 Specify type of floating-point unit.  Valid values for @var{name} are
22624 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22625 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22626 @samp{sp_full} (equivalent to @option{-msingle-float}),
22627 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22629 @item -mxilinx-fpu
22630 @opindex mxilinx-fpu
22631 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22633 @item -mmultiple
22634 @itemx -mno-multiple
22635 @opindex mmultiple
22636 @opindex mno-multiple
22637 Generate code that uses (does not use) the load multiple word
22638 instructions and the store multiple word instructions.  These
22639 instructions are generated by default on POWER systems, and not
22640 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22641 PowerPC systems, since those instructions do not work when the
22642 processor is in little-endian mode.  The exceptions are PPC740 and
22643 PPC750 which permit these instructions in little-endian mode.
22645 @item -mstring
22646 @itemx -mno-string
22647 @opindex mstring
22648 @opindex mno-string
22649 Generate code that uses (does not use) the load string instructions
22650 and the store string word instructions to save multiple registers and
22651 do small block moves.  These instructions are generated by default on
22652 POWER systems, and not generated on PowerPC systems.  Do not use
22653 @option{-mstring} on little-endian PowerPC systems, since those
22654 instructions do not work when the processor is in little-endian mode.
22655 The exceptions are PPC740 and PPC750 which permit these instructions
22656 in little-endian mode.
22658 @item -mupdate
22659 @itemx -mno-update
22660 @opindex mupdate
22661 @opindex mno-update
22662 Generate code that uses (does not use) the load or store instructions
22663 that update the base register to the address of the calculated memory
22664 location.  These instructions are generated by default.  If you use
22665 @option{-mno-update}, there is a small window between the time that the
22666 stack pointer is updated and the address of the previous frame is
22667 stored, which means code that walks the stack frame across interrupts or
22668 signals may get corrupted data.
22670 @item -mavoid-indexed-addresses
22671 @itemx -mno-avoid-indexed-addresses
22672 @opindex mavoid-indexed-addresses
22673 @opindex mno-avoid-indexed-addresses
22674 Generate code that tries to avoid (not avoid) the use of indexed load
22675 or store instructions. These instructions can incur a performance
22676 penalty on Power6 processors in certain situations, such as when
22677 stepping through large arrays that cross a 16M boundary.  This option
22678 is enabled by default when targeting Power6 and disabled otherwise.
22680 @item -mfused-madd
22681 @itemx -mno-fused-madd
22682 @opindex mfused-madd
22683 @opindex mno-fused-madd
22684 Generate code that uses (does not use) the floating-point multiply and
22685 accumulate instructions.  These instructions are generated by default
22686 if hardware floating point is used.  The machine-dependent
22687 @option{-mfused-madd} option is now mapped to the machine-independent
22688 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22689 mapped to @option{-ffp-contract=off}.
22691 @item -mmulhw
22692 @itemx -mno-mulhw
22693 @opindex mmulhw
22694 @opindex mno-mulhw
22695 Generate code that uses (does not use) the half-word multiply and
22696 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22697 These instructions are generated by default when targeting those
22698 processors.
22700 @item -mdlmzb
22701 @itemx -mno-dlmzb
22702 @opindex mdlmzb
22703 @opindex mno-dlmzb
22704 Generate code that uses (does not use) the string-search @samp{dlmzb}
22705 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22706 generated by default when targeting those processors.
22708 @item -mno-bit-align
22709 @itemx -mbit-align
22710 @opindex mno-bit-align
22711 @opindex mbit-align
22712 On System V.4 and embedded PowerPC systems do not (do) force structures
22713 and unions that contain bit-fields to be aligned to the base type of the
22714 bit-field.
22716 For example, by default a structure containing nothing but 8
22717 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22718 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22719 the structure is aligned to a 1-byte boundary and is 1 byte in
22720 size.
22722 @item -mno-strict-align
22723 @itemx -mstrict-align
22724 @opindex mno-strict-align
22725 @opindex mstrict-align
22726 On System V.4 and embedded PowerPC systems do not (do) assume that
22727 unaligned memory references are handled by the system.
22729 @item -mrelocatable
22730 @itemx -mno-relocatable
22731 @opindex mrelocatable
22732 @opindex mno-relocatable
22733 Generate code that allows (does not allow) a static executable to be
22734 relocated to a different address at run time.  A simple embedded
22735 PowerPC system loader should relocate the entire contents of
22736 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22737 a table of 32-bit addresses generated by this option.  For this to
22738 work, all objects linked together must be compiled with
22739 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22740 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22742 @item -mrelocatable-lib
22743 @itemx -mno-relocatable-lib
22744 @opindex mrelocatable-lib
22745 @opindex mno-relocatable-lib
22746 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22747 @code{.fixup} section to allow static executables to be relocated at
22748 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22749 alignment of @option{-mrelocatable}.  Objects compiled with
22750 @option{-mrelocatable-lib} may be linked with objects compiled with
22751 any combination of the @option{-mrelocatable} options.
22753 @item -mno-toc
22754 @itemx -mtoc
22755 @opindex mno-toc
22756 @opindex mtoc
22757 On System V.4 and embedded PowerPC systems do not (do) assume that
22758 register 2 contains a pointer to a global area pointing to the addresses
22759 used in the program.
22761 @item -mlittle
22762 @itemx -mlittle-endian
22763 @opindex mlittle
22764 @opindex mlittle-endian
22765 On System V.4 and embedded PowerPC systems compile code for the
22766 processor in little-endian mode.  The @option{-mlittle-endian} option is
22767 the same as @option{-mlittle}.
22769 @item -mbig
22770 @itemx -mbig-endian
22771 @opindex mbig
22772 @opindex mbig-endian
22773 On System V.4 and embedded PowerPC systems compile code for the
22774 processor in big-endian mode.  The @option{-mbig-endian} option is
22775 the same as @option{-mbig}.
22777 @item -mdynamic-no-pic
22778 @opindex mdynamic-no-pic
22779 On Darwin and Mac OS X systems, compile code so that it is not
22780 relocatable, but that its external references are relocatable.  The
22781 resulting code is suitable for applications, but not shared
22782 libraries.
22784 @item -msingle-pic-base
22785 @opindex msingle-pic-base
22786 Treat the register used for PIC addressing as read-only, rather than
22787 loading it in the prologue for each function.  The runtime system is
22788 responsible for initializing this register with an appropriate value
22789 before execution begins.
22791 @item -mprioritize-restricted-insns=@var{priority}
22792 @opindex mprioritize-restricted-insns
22793 This option controls the priority that is assigned to
22794 dispatch-slot restricted instructions during the second scheduling
22795 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22796 or @samp{2} to assign no, highest, or second-highest (respectively) 
22797 priority to dispatch-slot restricted
22798 instructions.
22800 @item -msched-costly-dep=@var{dependence_type}
22801 @opindex msched-costly-dep
22802 This option controls which dependences are considered costly
22803 by the target during instruction scheduling.  The argument
22804 @var{dependence_type} takes one of the following values:
22806 @table @asis
22807 @item @samp{no}
22808 No dependence is costly.
22810 @item @samp{all}
22811 All dependences are costly.
22813 @item @samp{true_store_to_load}
22814 A true dependence from store to load is costly.
22816 @item @samp{store_to_load}
22817 Any dependence from store to load is costly.
22819 @item @var{number}
22820 Any dependence for which the latency is greater than or equal to 
22821 @var{number} is costly.
22822 @end table
22824 @item -minsert-sched-nops=@var{scheme}
22825 @opindex minsert-sched-nops
22826 This option controls which NOP insertion scheme is used during
22827 the second scheduling pass.  The argument @var{scheme} takes one of the
22828 following values:
22830 @table @asis
22831 @item @samp{no}
22832 Don't insert NOPs.
22834 @item @samp{pad}
22835 Pad with NOPs any dispatch group that has vacant issue slots,
22836 according to the scheduler's grouping.
22838 @item @samp{regroup_exact}
22839 Insert NOPs to force costly dependent insns into
22840 separate groups.  Insert exactly as many NOPs as needed to force an insn
22841 to a new group, according to the estimated processor grouping.
22843 @item @var{number}
22844 Insert NOPs to force costly dependent insns into
22845 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22846 @end table
22848 @item -mcall-sysv
22849 @opindex mcall-sysv
22850 On System V.4 and embedded PowerPC systems compile code using calling
22851 conventions that adhere to the March 1995 draft of the System V
22852 Application Binary Interface, PowerPC processor supplement.  This is the
22853 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22855 @item -mcall-sysv-eabi
22856 @itemx -mcall-eabi
22857 @opindex mcall-sysv-eabi
22858 @opindex mcall-eabi
22859 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22861 @item -mcall-sysv-noeabi
22862 @opindex mcall-sysv-noeabi
22863 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22865 @item -mcall-aixdesc
22866 @opindex m
22867 On System V.4 and embedded PowerPC systems compile code for the AIX
22868 operating system.
22870 @item -mcall-linux
22871 @opindex mcall-linux
22872 On System V.4 and embedded PowerPC systems compile code for the
22873 Linux-based GNU system.
22875 @item -mcall-freebsd
22876 @opindex mcall-freebsd
22877 On System V.4 and embedded PowerPC systems compile code for the
22878 FreeBSD operating system.
22880 @item -mcall-netbsd
22881 @opindex mcall-netbsd
22882 On System V.4 and embedded PowerPC systems compile code for the
22883 NetBSD operating system.
22885 @item -mcall-openbsd
22886 @opindex mcall-netbsd
22887 On System V.4 and embedded PowerPC systems compile code for the
22888 OpenBSD operating system.
22890 @item -maix-struct-return
22891 @opindex maix-struct-return
22892 Return all structures in memory (as specified by the AIX ABI)@.
22894 @item -msvr4-struct-return
22895 @opindex msvr4-struct-return
22896 Return structures smaller than 8 bytes in registers (as specified by the
22897 SVR4 ABI)@.
22899 @item -mabi=@var{abi-type}
22900 @opindex mabi
22901 Extend the current ABI with a particular extension, or remove such extension.
22902 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22903 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22904 @samp{elfv1}, @samp{elfv2}@.
22906 @item -mabi=spe
22907 @opindex mabi=spe
22908 Extend the current ABI with SPE ABI extensions.  This does not change
22909 the default ABI, instead it adds the SPE ABI extensions to the current
22910 ABI@.
22912 @item -mabi=no-spe
22913 @opindex mabi=no-spe
22914 Disable Book-E SPE ABI extensions for the current ABI@.
22916 @item -mabi=ibmlongdouble
22917 @opindex mabi=ibmlongdouble
22918 Change the current ABI to use IBM extended-precision long double.
22919 This is not likely to work if your system defaults to using IEEE
22920 extended-precision long double.  If you change the long double type
22921 from IEEE extended-precision, the compiler will issue a warning unless
22922 you use the @option{-Wno-psabi} option.
22924 @item -mabi=ieeelongdouble
22925 @opindex mabi=ieeelongdouble
22926 Change the current ABI to use IEEE extended-precision long double.
22927 This is not likely to work if your system defaults to using IBM
22928 extended-precision long double.  If you change the long double type
22929 from IBM extended-precision, the compiler will issue a warning unless
22930 you use the @option{-Wno-psabi} option.
22932 @item -mabi=elfv1
22933 @opindex mabi=elfv1
22934 Change the current ABI to use the ELFv1 ABI.
22935 This is the default ABI for big-endian PowerPC 64-bit Linux.
22936 Overriding the default ABI requires special system support and is
22937 likely to fail in spectacular ways.
22939 @item -mabi=elfv2
22940 @opindex mabi=elfv2
22941 Change the current ABI to use the ELFv2 ABI.
22942 This is the default ABI for little-endian PowerPC 64-bit Linux.
22943 Overriding the default ABI requires special system support and is
22944 likely to fail in spectacular ways.
22946 @item -mgnu-attribute
22947 @itemx -mno-gnu-attribute
22948 @opindex mgnu-attribute
22949 @opindex mno-gnu-attribute
22950 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22951 .gnu.attributes section that specify ABI variations in function
22952 parameters or return values.
22954 @item -mprototype
22955 @itemx -mno-prototype
22956 @opindex mprototype
22957 @opindex mno-prototype
22958 On System V.4 and embedded PowerPC systems assume that all calls to
22959 variable argument functions are properly prototyped.  Otherwise, the
22960 compiler must insert an instruction before every non-prototyped call to
22961 set or clear bit 6 of the condition code register (@code{CR}) to
22962 indicate whether floating-point values are passed in the floating-point
22963 registers in case the function takes variable arguments.  With
22964 @option{-mprototype}, only calls to prototyped variable argument functions
22965 set or clear the bit.
22967 @item -msim
22968 @opindex msim
22969 On embedded PowerPC systems, assume that the startup module is called
22970 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22971 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22972 configurations.
22974 @item -mmvme
22975 @opindex mmvme
22976 On embedded PowerPC systems, assume that the startup module is called
22977 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22978 @file{libc.a}.
22980 @item -mads
22981 @opindex mads
22982 On embedded PowerPC systems, assume that the startup module is called
22983 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22984 @file{libc.a}.
22986 @item -myellowknife
22987 @opindex myellowknife
22988 On embedded PowerPC systems, assume that the startup module is called
22989 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22990 @file{libc.a}.
22992 @item -mvxworks
22993 @opindex mvxworks
22994 On System V.4 and embedded PowerPC systems, specify that you are
22995 compiling for a VxWorks system.
22997 @item -memb
22998 @opindex memb
22999 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
23000 header to indicate that @samp{eabi} extended relocations are used.
23002 @item -meabi
23003 @itemx -mno-eabi
23004 @opindex meabi
23005 @opindex mno-eabi
23006 On System V.4 and embedded PowerPC systems do (do not) adhere to the
23007 Embedded Applications Binary Interface (EABI), which is a set of
23008 modifications to the System V.4 specifications.  Selecting @option{-meabi}
23009 means that the stack is aligned to an 8-byte boundary, a function
23010 @code{__eabi} is called from @code{main} to set up the EABI
23011 environment, and the @option{-msdata} option can use both @code{r2} and
23012 @code{r13} to point to two separate small data areas.  Selecting
23013 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
23014 no EABI initialization function is called from @code{main}, and the
23015 @option{-msdata} option only uses @code{r13} to point to a single
23016 small data area.  The @option{-meabi} option is on by default if you
23017 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
23019 @item -msdata=eabi
23020 @opindex msdata=eabi
23021 On System V.4 and embedded PowerPC systems, put small initialized
23022 @code{const} global and static data in the @code{.sdata2} section, which
23023 is pointed to by register @code{r2}.  Put small initialized
23024 non-@code{const} global and static data in the @code{.sdata} section,
23025 which is pointed to by register @code{r13}.  Put small uninitialized
23026 global and static data in the @code{.sbss} section, which is adjacent to
23027 the @code{.sdata} section.  The @option{-msdata=eabi} option is
23028 incompatible with the @option{-mrelocatable} option.  The
23029 @option{-msdata=eabi} option also sets the @option{-memb} option.
23031 @item -msdata=sysv
23032 @opindex msdata=sysv
23033 On System V.4 and embedded PowerPC systems, put small global and static
23034 data in the @code{.sdata} section, which is pointed to by register
23035 @code{r13}.  Put small uninitialized global and static data in the
23036 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
23037 The @option{-msdata=sysv} option is incompatible with the
23038 @option{-mrelocatable} option.
23040 @item -msdata=default
23041 @itemx -msdata
23042 @opindex msdata=default
23043 @opindex msdata
23044 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
23045 compile code the same as @option{-msdata=eabi}, otherwise compile code the
23046 same as @option{-msdata=sysv}.
23048 @item -msdata=data
23049 @opindex msdata=data
23050 On System V.4 and embedded PowerPC systems, put small global
23051 data in the @code{.sdata} section.  Put small uninitialized global
23052 data in the @code{.sbss} section.  Do not use register @code{r13}
23053 to address small data however.  This is the default behavior unless
23054 other @option{-msdata} options are used.
23056 @item -msdata=none
23057 @itemx -mno-sdata
23058 @opindex msdata=none
23059 @opindex mno-sdata
23060 On embedded PowerPC systems, put all initialized global and static data
23061 in the @code{.data} section, and all uninitialized data in the
23062 @code{.bss} section.
23064 @item -mblock-move-inline-limit=@var{num}
23065 @opindex mblock-move-inline-limit
23066 Inline all block moves (such as calls to @code{memcpy} or structure
23067 copies) less than or equal to @var{num} bytes.  The minimum value for
23068 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
23069 targets.  The default value is target-specific.
23071 @item -G @var{num}
23072 @opindex G
23073 @cindex smaller data references (PowerPC)
23074 @cindex .sdata/.sdata2 references (PowerPC)
23075 On embedded PowerPC systems, put global and static items less than or
23076 equal to @var{num} bytes into the small data or BSS sections instead of
23077 the normal data or BSS section.  By default, @var{num} is 8.  The
23078 @option{-G @var{num}} switch is also passed to the linker.
23079 All modules should be compiled with the same @option{-G @var{num}} value.
23081 @item -mregnames
23082 @itemx -mno-regnames
23083 @opindex mregnames
23084 @opindex mno-regnames
23085 On System V.4 and embedded PowerPC systems do (do not) emit register
23086 names in the assembly language output using symbolic forms.
23088 @item -mlongcall
23089 @itemx -mno-longcall
23090 @opindex mlongcall
23091 @opindex mno-longcall
23092 By default assume that all calls are far away so that a longer and more
23093 expensive calling sequence is required.  This is required for calls
23094 farther than 32 megabytes (33,554,432 bytes) from the current location.
23095 A short call is generated if the compiler knows
23096 the call cannot be that far away.  This setting can be overridden by
23097 the @code{shortcall} function attribute, or by @code{#pragma
23098 longcall(0)}.
23100 Some linkers are capable of detecting out-of-range calls and generating
23101 glue code on the fly.  On these systems, long calls are unnecessary and
23102 generate slower code.  As of this writing, the AIX linker can do this,
23103 as can the GNU linker for PowerPC/64.  It is planned to add this feature
23104 to the GNU linker for 32-bit PowerPC systems as well.
23106 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
23107 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
23108 addresses represent the callee and the branch island.  The
23109 Darwin/PPC linker prefers the first address and generates a @code{bl
23110 callee} if the PPC @code{bl} instruction reaches the callee directly;
23111 otherwise, the linker generates @code{bl L42} to call the branch
23112 island.  The branch island is appended to the body of the
23113 calling function; it computes the full 32-bit address of the callee
23114 and jumps to it.
23116 On Mach-O (Darwin) systems, this option directs the compiler emit to
23117 the glue for every direct call, and the Darwin linker decides whether
23118 to use or discard it.
23120 In the future, GCC may ignore all longcall specifications
23121 when the linker is known to generate glue.
23123 @item -mtls-markers
23124 @itemx -mno-tls-markers
23125 @opindex mtls-markers
23126 @opindex mno-tls-markers
23127 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
23128 specifying the function argument.  The relocation allows the linker to
23129 reliably associate function call with argument setup instructions for
23130 TLS optimization, which in turn allows GCC to better schedule the
23131 sequence.
23133 @item -mrecip
23134 @itemx -mno-recip
23135 @opindex mrecip
23136 This option enables use of the reciprocal estimate and
23137 reciprocal square root estimate instructions with additional
23138 Newton-Raphson steps to increase precision instead of doing a divide or
23139 square root and divide for floating-point arguments.  You should use
23140 the @option{-ffast-math} option when using @option{-mrecip} (or at
23141 least @option{-funsafe-math-optimizations},
23142 @option{-ffinite-math-only}, @option{-freciprocal-math} and
23143 @option{-fno-trapping-math}).  Note that while the throughput of the
23144 sequence is generally higher than the throughput of the non-reciprocal
23145 instruction, the precision of the sequence can be decreased by up to 2
23146 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
23147 roots.
23149 @item -mrecip=@var{opt}
23150 @opindex mrecip=opt
23151 This option controls which reciprocal estimate instructions
23152 may be used.  @var{opt} is a comma-separated list of options, which may
23153 be preceded by a @code{!} to invert the option:
23155 @table @samp
23157 @item all
23158 Enable all estimate instructions.
23160 @item default 
23161 Enable the default instructions, equivalent to @option{-mrecip}.
23163 @item none 
23164 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23166 @item div 
23167 Enable the reciprocal approximation instructions for both 
23168 single and double precision.
23170 @item divf 
23171 Enable the single-precision reciprocal approximation instructions.
23173 @item divd 
23174 Enable the double-precision reciprocal approximation instructions.
23176 @item rsqrt 
23177 Enable the reciprocal square root approximation instructions for both
23178 single and double precision.
23180 @item rsqrtf 
23181 Enable the single-precision reciprocal square root approximation instructions.
23183 @item rsqrtd 
23184 Enable the double-precision reciprocal square root approximation instructions.
23186 @end table
23188 So, for example, @option{-mrecip=all,!rsqrtd} enables
23189 all of the reciprocal estimate instructions, except for the
23190 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
23191 which handle the double-precision reciprocal square root calculations.
23193 @item -mrecip-precision
23194 @itemx -mno-recip-precision
23195 @opindex mrecip-precision
23196 Assume (do not assume) that the reciprocal estimate instructions
23197 provide higher-precision estimates than is mandated by the PowerPC
23198 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
23199 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
23200 The double-precision square root estimate instructions are not generated by
23201 default on low-precision machines, since they do not provide an
23202 estimate that converges after three steps.
23204 @item -mveclibabi=@var{type}
23205 @opindex mveclibabi
23206 Specifies the ABI type to use for vectorizing intrinsics using an
23207 external library.  The only type supported at present is @samp{mass},
23208 which specifies to use IBM's Mathematical Acceleration Subsystem
23209 (MASS) libraries for vectorizing intrinsics using external libraries.
23210 GCC currently emits calls to @code{acosd2}, @code{acosf4},
23211 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
23212 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
23213 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
23214 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
23215 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
23216 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
23217 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
23218 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
23219 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
23220 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
23221 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
23222 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
23223 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
23224 for power7.  Both @option{-ftree-vectorize} and
23225 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
23226 libraries must be specified at link time.
23228 @item -mfriz
23229 @itemx -mno-friz
23230 @opindex mfriz
23231 Generate (do not generate) the @code{friz} instruction when the
23232 @option{-funsafe-math-optimizations} option is used to optimize
23233 rounding of floating-point values to 64-bit integer and back to floating
23234 point.  The @code{friz} instruction does not return the same value if
23235 the floating-point number is too large to fit in an integer.
23237 @item -mpointers-to-nested-functions
23238 @itemx -mno-pointers-to-nested-functions
23239 @opindex mpointers-to-nested-functions
23240 Generate (do not generate) code to load up the static chain register
23241 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
23242 systems where a function pointer points to a 3-word descriptor giving
23243 the function address, TOC value to be loaded in register @code{r2}, and
23244 static chain value to be loaded in register @code{r11}.  The
23245 @option{-mpointers-to-nested-functions} is on by default.  You cannot
23246 call through pointers to nested functions or pointers
23247 to functions compiled in other languages that use the static chain if
23248 you use @option{-mno-pointers-to-nested-functions}.
23250 @item -msave-toc-indirect
23251 @itemx -mno-save-toc-indirect
23252 @opindex msave-toc-indirect
23253 Generate (do not generate) code to save the TOC value in the reserved
23254 stack location in the function prologue if the function calls through
23255 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
23256 saved in the prologue, it is saved just before the call through the
23257 pointer.  The @option{-mno-save-toc-indirect} option is the default.
23259 @item -mcompat-align-parm
23260 @itemx -mno-compat-align-parm
23261 @opindex mcompat-align-parm
23262 Generate (do not generate) code to pass structure parameters with a
23263 maximum alignment of 64 bits, for compatibility with older versions
23264 of GCC.
23266 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
23267 structure parameter on a 128-bit boundary when that structure contained
23268 a member requiring 128-bit alignment.  This is corrected in more
23269 recent versions of GCC.  This option may be used to generate code
23270 that is compatible with functions compiled with older versions of
23271 GCC.
23273 The @option{-mno-compat-align-parm} option is the default.
23275 @item -mstack-protector-guard=@var{guard}
23276 @itemx -mstack-protector-guard-reg=@var{reg}
23277 @itemx -mstack-protector-guard-offset=@var{offset}
23278 @itemx -mstack-protector-guard-symbol=@var{symbol}
23279 @opindex mstack-protector-guard
23280 @opindex mstack-protector-guard-reg
23281 @opindex mstack-protector-guard-offset
23282 @opindex mstack-protector-guard-symbol
23283 Generate stack protection code using canary at @var{guard}.  Supported
23284 locations are @samp{global} for global canary or @samp{tls} for per-thread
23285 canary in the TLS block (the default with GNU libc version 2.4 or later).
23287 With the latter choice the options
23288 @option{-mstack-protector-guard-reg=@var{reg}} and
23289 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
23290 which register to use as base register for reading the canary, and from what
23291 offset from that base register. The default for those is as specified in the
23292 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
23293 the offset with a symbol reference to a canary in the TLS block.
23294 @end table
23296 @node RX Options
23297 @subsection RX Options
23298 @cindex RX Options
23300 These command-line options are defined for RX targets:
23302 @table @gcctabopt
23303 @item -m64bit-doubles
23304 @itemx -m32bit-doubles
23305 @opindex m64bit-doubles
23306 @opindex m32bit-doubles
23307 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23308 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23309 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
23310 works on 32-bit values, which is why the default is
23311 @option{-m32bit-doubles}.
23313 @item -fpu
23314 @itemx -nofpu
23315 @opindex fpu
23316 @opindex nofpu
23317 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
23318 floating-point hardware.  The default is enabled for the RX600
23319 series and disabled for the RX200 series.
23321 Floating-point instructions are only generated for 32-bit floating-point 
23322 values, however, so the FPU hardware is not used for doubles if the
23323 @option{-m64bit-doubles} option is used.
23325 @emph{Note} If the @option{-fpu} option is enabled then
23326 @option{-funsafe-math-optimizations} is also enabled automatically.
23327 This is because the RX FPU instructions are themselves unsafe.
23329 @item -mcpu=@var{name}
23330 @opindex mcpu
23331 Selects the type of RX CPU to be targeted.  Currently three types are
23332 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
23333 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
23335 The only difference between @samp{RX600} and @samp{RX610} is that the
23336 @samp{RX610} does not support the @code{MVTIPL} instruction.
23338 The @samp{RX200} series does not have a hardware floating-point unit
23339 and so @option{-nofpu} is enabled by default when this type is
23340 selected.
23342 @item -mbig-endian-data
23343 @itemx -mlittle-endian-data
23344 @opindex mbig-endian-data
23345 @opindex mlittle-endian-data
23346 Store data (but not code) in the big-endian format.  The default is
23347 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
23348 format.
23350 @item -msmall-data-limit=@var{N}
23351 @opindex msmall-data-limit
23352 Specifies the maximum size in bytes of global and static variables
23353 which can be placed into the small data area.  Using the small data
23354 area can lead to smaller and faster code, but the size of area is
23355 limited and it is up to the programmer to ensure that the area does
23356 not overflow.  Also when the small data area is used one of the RX's
23357 registers (usually @code{r13}) is reserved for use pointing to this
23358 area, so it is no longer available for use by the compiler.  This
23359 could result in slower and/or larger code if variables are pushed onto
23360 the stack instead of being held in this register.
23362 Note, common variables (variables that have not been initialized) and
23363 constants are not placed into the small data area as they are assigned
23364 to other sections in the output executable.
23366 The default value is zero, which disables this feature.  Note, this
23367 feature is not enabled by default with higher optimization levels
23368 (@option{-O2} etc) because of the potentially detrimental effects of
23369 reserving a register.  It is up to the programmer to experiment and
23370 discover whether this feature is of benefit to their program.  See the
23371 description of the @option{-mpid} option for a description of how the
23372 actual register to hold the small data area pointer is chosen.
23374 @item -msim
23375 @itemx -mno-sim
23376 @opindex msim
23377 @opindex mno-sim
23378 Use the simulator runtime.  The default is to use the libgloss
23379 board-specific runtime.
23381 @item -mas100-syntax
23382 @itemx -mno-as100-syntax
23383 @opindex mas100-syntax
23384 @opindex mno-as100-syntax
23385 When generating assembler output use a syntax that is compatible with
23386 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
23387 assembler, but it has some restrictions so it is not generated by default.
23389 @item -mmax-constant-size=@var{N}
23390 @opindex mmax-constant-size
23391 Specifies the maximum size, in bytes, of a constant that can be used as
23392 an operand in a RX instruction.  Although the RX instruction set does
23393 allow constants of up to 4 bytes in length to be used in instructions,
23394 a longer value equates to a longer instruction.  Thus in some
23395 circumstances it can be beneficial to restrict the size of constants
23396 that are used in instructions.  Constants that are too big are instead
23397 placed into a constant pool and referenced via register indirection.
23399 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
23400 or 4 means that constants of any size are allowed.
23402 @item -mrelax
23403 @opindex mrelax
23404 Enable linker relaxation.  Linker relaxation is a process whereby the
23405 linker attempts to reduce the size of a program by finding shorter
23406 versions of various instructions.  Disabled by default.
23408 @item -mint-register=@var{N}
23409 @opindex mint-register
23410 Specify the number of registers to reserve for fast interrupt handler
23411 functions.  The value @var{N} can be between 0 and 4.  A value of 1
23412 means that register @code{r13} is reserved for the exclusive use
23413 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
23414 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
23415 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
23416 A value of 0, the default, does not reserve any registers.
23418 @item -msave-acc-in-interrupts
23419 @opindex msave-acc-in-interrupts
23420 Specifies that interrupt handler functions should preserve the
23421 accumulator register.  This is only necessary if normal code might use
23422 the accumulator register, for example because it performs 64-bit
23423 multiplications.  The default is to ignore the accumulator as this
23424 makes the interrupt handlers faster.
23426 @item -mpid
23427 @itemx -mno-pid
23428 @opindex mpid
23429 @opindex mno-pid
23430 Enables the generation of position independent data.  When enabled any
23431 access to constant data is done via an offset from a base address
23432 held in a register.  This allows the location of constant data to be
23433 determined at run time without requiring the executable to be
23434 relocated, which is a benefit to embedded applications with tight
23435 memory constraints.  Data that can be modified is not affected by this
23436 option.
23438 Note, using this feature reserves a register, usually @code{r13}, for
23439 the constant data base address.  This can result in slower and/or
23440 larger code, especially in complicated functions.
23442 The actual register chosen to hold the constant data base address
23443 depends upon whether the @option{-msmall-data-limit} and/or the
23444 @option{-mint-register} command-line options are enabled.  Starting
23445 with register @code{r13} and proceeding downwards, registers are
23446 allocated first to satisfy the requirements of @option{-mint-register},
23447 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
23448 is possible for the small data area register to be @code{r8} if both
23449 @option{-mint-register=4} and @option{-mpid} are specified on the
23450 command line.
23452 By default this feature is not enabled.  The default can be restored
23453 via the @option{-mno-pid} command-line option.
23455 @item -mno-warn-multiple-fast-interrupts
23456 @itemx -mwarn-multiple-fast-interrupts
23457 @opindex mno-warn-multiple-fast-interrupts
23458 @opindex mwarn-multiple-fast-interrupts
23459 Prevents GCC from issuing a warning message if it finds more than one
23460 fast interrupt handler when it is compiling a file.  The default is to
23461 issue a warning for each extra fast interrupt handler found, as the RX
23462 only supports one such interrupt.
23464 @item -mallow-string-insns
23465 @itemx -mno-allow-string-insns
23466 @opindex mallow-string-insns
23467 @opindex mno-allow-string-insns
23468 Enables or disables the use of the string manipulation instructions
23469 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
23470 @code{SWHILE} and also the @code{RMPA} instruction.  These
23471 instructions may prefetch data, which is not safe to do if accessing
23472 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
23473 for more information).
23475 The default is to allow these instructions, but it is not possible for
23476 GCC to reliably detect all circumstances where a string instruction
23477 might be used to access an I/O register, so their use cannot be
23478 disabled automatically.  Instead it is reliant upon the programmer to
23479 use the @option{-mno-allow-string-insns} option if their program
23480 accesses I/O space.
23482 When the instructions are enabled GCC defines the C preprocessor
23483 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
23484 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
23486 @item -mjsr
23487 @itemx -mno-jsr
23488 @opindex mjsr
23489 @opindex mno-jsr
23490 Use only (or not only) @code{JSR} instructions to access functions.
23491 This option can be used when code size exceeds the range of @code{BSR}
23492 instructions.  Note that @option{-mno-jsr} does not mean to not use
23493 @code{JSR} but instead means that any type of branch may be used.
23494 @end table
23496 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
23497 has special significance to the RX port when used with the
23498 @code{interrupt} function attribute.  This attribute indicates a
23499 function intended to process fast interrupts.  GCC ensures
23500 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
23501 and/or @code{r13} and only provided that the normal use of the
23502 corresponding registers have been restricted via the
23503 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
23504 options.
23506 @node S/390 and zSeries Options
23507 @subsection S/390 and zSeries Options
23508 @cindex S/390 and zSeries Options
23510 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
23512 @table @gcctabopt
23513 @item -mhard-float
23514 @itemx -msoft-float
23515 @opindex mhard-float
23516 @opindex msoft-float
23517 Use (do not use) the hardware floating-point instructions and registers
23518 for floating-point operations.  When @option{-msoft-float} is specified,
23519 functions in @file{libgcc.a} are used to perform floating-point
23520 operations.  When @option{-mhard-float} is specified, the compiler
23521 generates IEEE floating-point instructions.  This is the default.
23523 @item -mhard-dfp
23524 @itemx -mno-hard-dfp
23525 @opindex mhard-dfp
23526 @opindex mno-hard-dfp
23527 Use (do not use) the hardware decimal-floating-point instructions for
23528 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
23529 specified, functions in @file{libgcc.a} are used to perform
23530 decimal-floating-point operations.  When @option{-mhard-dfp} is
23531 specified, the compiler generates decimal-floating-point hardware
23532 instructions.  This is the default for @option{-march=z9-ec} or higher.
23534 @item -mlong-double-64
23535 @itemx -mlong-double-128
23536 @opindex mlong-double-64
23537 @opindex mlong-double-128
23538 These switches control the size of @code{long double} type. A size
23539 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23540 type. This is the default.
23542 @item -mbackchain
23543 @itemx -mno-backchain
23544 @opindex mbackchain
23545 @opindex mno-backchain
23546 Store (do not store) the address of the caller's frame as backchain pointer
23547 into the callee's stack frame.
23548 A backchain may be needed to allow debugging using tools that do not understand
23549 DWARF call frame information.
23550 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23551 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23552 the backchain is placed into the topmost word of the 96/160 byte register
23553 save area.
23555 In general, code compiled with @option{-mbackchain} is call-compatible with
23556 code compiled with @option{-mmo-backchain}; however, use of the backchain
23557 for debugging purposes usually requires that the whole binary is built with
23558 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23559 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23560 to build a linux kernel use @option{-msoft-float}.
23562 The default is to not maintain the backchain.
23564 @item -mpacked-stack
23565 @itemx -mno-packed-stack
23566 @opindex mpacked-stack
23567 @opindex mno-packed-stack
23568 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23569 specified, the compiler uses the all fields of the 96/160 byte register save
23570 area only for their default purpose; unused fields still take up stack space.
23571 When @option{-mpacked-stack} is specified, register save slots are densely
23572 packed at the top of the register save area; unused space is reused for other
23573 purposes, allowing for more efficient use of the available stack space.
23574 However, when @option{-mbackchain} is also in effect, the topmost word of
23575 the save area is always used to store the backchain, and the return address
23576 register is always saved two words below the backchain.
23578 As long as the stack frame backchain is not used, code generated with
23579 @option{-mpacked-stack} is call-compatible with code generated with
23580 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23581 S/390 or zSeries generated code that uses the stack frame backchain at run
23582 time, not just for debugging purposes.  Such code is not call-compatible
23583 with code compiled with @option{-mpacked-stack}.  Also, note that the
23584 combination of @option{-mbackchain},
23585 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23586 to build a linux kernel use @option{-msoft-float}.
23588 The default is to not use the packed stack layout.
23590 @item -msmall-exec
23591 @itemx -mno-small-exec
23592 @opindex msmall-exec
23593 @opindex mno-small-exec
23594 Generate (or do not generate) code using the @code{bras} instruction
23595 to do subroutine calls.
23596 This only works reliably if the total executable size does not
23597 exceed 64k.  The default is to use the @code{basr} instruction instead,
23598 which does not have this limitation.
23600 @item -m64
23601 @itemx -m31
23602 @opindex m64
23603 @opindex m31
23604 When @option{-m31} is specified, generate code compliant to the
23605 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23606 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23607 particular to generate 64-bit instructions.  For the @samp{s390}
23608 targets, the default is @option{-m31}, while the @samp{s390x}
23609 targets default to @option{-m64}.
23611 @item -mzarch
23612 @itemx -mesa
23613 @opindex mzarch
23614 @opindex mesa
23615 When @option{-mzarch} is specified, generate code using the
23616 instructions available on z/Architecture.
23617 When @option{-mesa} is specified, generate code using the
23618 instructions available on ESA/390.  Note that @option{-mesa} is
23619 not possible with @option{-m64}.
23620 When generating code compliant to the GNU/Linux for S/390 ABI,
23621 the default is @option{-mesa}.  When generating code compliant
23622 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23624 @item -mhtm
23625 @itemx -mno-htm
23626 @opindex mhtm
23627 @opindex mno-htm
23628 The @option{-mhtm} option enables a set of builtins making use of
23629 instructions available with the transactional execution facility
23630 introduced with the IBM zEnterprise EC12 machine generation
23631 @ref{S/390 System z Built-in Functions}.
23632 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23634 @item -mvx
23635 @itemx -mno-vx
23636 @opindex mvx
23637 @opindex mno-vx
23638 When @option{-mvx} is specified, generate code using the instructions
23639 available with the vector extension facility introduced with the IBM
23640 z13 machine generation.
23641 This option changes the ABI for some vector type values with regard to
23642 alignment and calling conventions.  In case vector type values are
23643 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23644 command will be added to mark the resulting binary with the ABI used.
23645 @option{-mvx} is enabled by default when using @option{-march=z13}.
23647 @item -mzvector
23648 @itemx -mno-zvector
23649 @opindex mzvector
23650 @opindex mno-zvector
23651 The @option{-mzvector} option enables vector language extensions and
23652 builtins using instructions available with the vector extension
23653 facility introduced with the IBM z13 machine generation.
23654 This option adds support for @samp{vector} to be used as a keyword to
23655 define vector type variables and arguments.  @samp{vector} is only
23656 available when GNU extensions are enabled.  It will not be expanded
23657 when requesting strict standard compliance e.g. with @option{-std=c99}.
23658 In addition to the GCC low-level builtins @option{-mzvector} enables
23659 a set of builtins added for compatibility with AltiVec-style
23660 implementations like Power and Cell.  In order to make use of these
23661 builtins the header file @file{vecintrin.h} needs to be included.
23662 @option{-mzvector} is disabled by default.
23664 @item -mmvcle
23665 @itemx -mno-mvcle
23666 @opindex mmvcle
23667 @opindex mno-mvcle
23668 Generate (or do not generate) code using the @code{mvcle} instruction
23669 to perform block moves.  When @option{-mno-mvcle} is specified,
23670 use a @code{mvc} loop instead.  This is the default unless optimizing for
23671 size.
23673 @item -mdebug
23674 @itemx -mno-debug
23675 @opindex mdebug
23676 @opindex mno-debug
23677 Print (or do not print) additional debug information when compiling.
23678 The default is to not print debug information.
23680 @item -march=@var{cpu-type}
23681 @opindex march
23682 Generate code that runs on @var{cpu-type}, which is the name of a
23683 system representing a certain processor type.  Possible values for
23684 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23685 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23686 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23687 @samp{native}.
23689 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23690 @samp{g6} are deprecated and will be removed with future releases.
23692 Specifying @samp{native} as cpu type can be used to select the best
23693 architecture option for the host processor.
23694 @option{-march=native} has no effect if GCC does not recognize the
23695 processor.
23697 @item -mtune=@var{cpu-type}
23698 @opindex mtune
23699 Tune to @var{cpu-type} everything applicable about the generated code,
23700 except for the ABI and the set of available instructions.
23701 The list of @var{cpu-type} values is the same as for @option{-march}.
23702 The default is the value used for @option{-march}.
23704 @item -mtpf-trace
23705 @itemx -mno-tpf-trace
23706 @opindex mtpf-trace
23707 @opindex mno-tpf-trace
23708 Generate code that adds (does not add) in TPF OS specific branches to trace
23709 routines in the operating system.  This option is off by default, even
23710 when compiling for the TPF OS@.
23712 @item -mfused-madd
23713 @itemx -mno-fused-madd
23714 @opindex mfused-madd
23715 @opindex mno-fused-madd
23716 Generate code that uses (does not use) the floating-point multiply and
23717 accumulate instructions.  These instructions are generated by default if
23718 hardware floating point is used.
23720 @item -mwarn-framesize=@var{framesize}
23721 @opindex mwarn-framesize
23722 Emit a warning if the current function exceeds the given frame size.  Because
23723 this is a compile-time check it doesn't need to be a real problem when the program
23724 runs.  It is intended to identify functions that most probably cause
23725 a stack overflow.  It is useful to be used in an environment with limited stack
23726 size e.g.@: the linux kernel.
23728 @item -mwarn-dynamicstack
23729 @opindex mwarn-dynamicstack
23730 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23731 arrays.  This is generally a bad idea with a limited stack size.
23733 @item -mstack-guard=@var{stack-guard}
23734 @itemx -mstack-size=@var{stack-size}
23735 @opindex mstack-guard
23736 @opindex mstack-size
23737 If these options are provided the S/390 back end emits additional instructions in
23738 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23739 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23740 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23741 the frame size of the compiled function is chosen.
23742 These options are intended to be used to help debugging stack overflow problems.
23743 The additionally emitted code causes only little overhead and hence can also be
23744 used in production-like systems without greater performance degradation.  The given
23745 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23746 @var{stack-guard} without exceeding 64k.
23747 In order to be efficient the extra code makes the assumption that the stack starts
23748 at an address aligned to the value given by @var{stack-size}.
23749 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23751 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23752 @opindex mhotpatch
23753 If the hotpatch option is enabled, a ``hot-patching'' function
23754 prologue is generated for all functions in the compilation unit.
23755 The funtion label is prepended with the given number of two-byte
23756 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23757 the label, 2 * @var{post-halfwords} bytes are appended, using the
23758 largest NOP like instructions the architecture allows (maximum
23759 1000000).
23761 If both arguments are zero, hotpatching is disabled.
23763 This option can be overridden for individual functions with the
23764 @code{hotpatch} attribute.
23765 @end table
23767 @node Score Options
23768 @subsection Score Options
23769 @cindex Score Options
23771 These options are defined for Score implementations:
23773 @table @gcctabopt
23774 @item -meb
23775 @opindex meb
23776 Compile code for big-endian mode.  This is the default.
23778 @item -mel
23779 @opindex mel
23780 Compile code for little-endian mode.
23782 @item -mnhwloop
23783 @opindex mnhwloop
23784 Disable generation of @code{bcnz} instructions.
23786 @item -muls
23787 @opindex muls
23788 Enable generation of unaligned load and store instructions.
23790 @item -mmac
23791 @opindex mmac
23792 Enable the use of multiply-accumulate instructions. Disabled by default.
23794 @item -mscore5
23795 @opindex mscore5
23796 Specify the SCORE5 as the target architecture.
23798 @item -mscore5u
23799 @opindex mscore5u
23800 Specify the SCORE5U of the target architecture.
23802 @item -mscore7
23803 @opindex mscore7
23804 Specify the SCORE7 as the target architecture. This is the default.
23806 @item -mscore7d
23807 @opindex mscore7d
23808 Specify the SCORE7D as the target architecture.
23809 @end table
23811 @node SH Options
23812 @subsection SH Options
23814 These @samp{-m} options are defined for the SH implementations:
23816 @table @gcctabopt
23817 @item -m1
23818 @opindex m1
23819 Generate code for the SH1.
23821 @item -m2
23822 @opindex m2
23823 Generate code for the SH2.
23825 @item -m2e
23826 Generate code for the SH2e.
23828 @item -m2a-nofpu
23829 @opindex m2a-nofpu
23830 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23831 that the floating-point unit is not used.
23833 @item -m2a-single-only
23834 @opindex m2a-single-only
23835 Generate code for the SH2a-FPU, in such a way that no double-precision
23836 floating-point operations are used.
23838 @item -m2a-single
23839 @opindex m2a-single
23840 Generate code for the SH2a-FPU assuming the floating-point unit is in
23841 single-precision mode by default.
23843 @item -m2a
23844 @opindex m2a
23845 Generate code for the SH2a-FPU assuming the floating-point unit is in
23846 double-precision mode by default.
23848 @item -m3
23849 @opindex m3
23850 Generate code for the SH3.
23852 @item -m3e
23853 @opindex m3e
23854 Generate code for the SH3e.
23856 @item -m4-nofpu
23857 @opindex m4-nofpu
23858 Generate code for the SH4 without a floating-point unit.
23860 @item -m4-single-only
23861 @opindex m4-single-only
23862 Generate code for the SH4 with a floating-point unit that only
23863 supports single-precision arithmetic.
23865 @item -m4-single
23866 @opindex m4-single
23867 Generate code for the SH4 assuming the floating-point unit is in
23868 single-precision mode by default.
23870 @item -m4
23871 @opindex m4
23872 Generate code for the SH4.
23874 @item -m4-100
23875 @opindex m4-100
23876 Generate code for SH4-100.
23878 @item -m4-100-nofpu
23879 @opindex m4-100-nofpu
23880 Generate code for SH4-100 in such a way that the
23881 floating-point unit is not used.
23883 @item -m4-100-single
23884 @opindex m4-100-single
23885 Generate code for SH4-100 assuming the floating-point unit is in
23886 single-precision mode by default.
23888 @item -m4-100-single-only
23889 @opindex m4-100-single-only
23890 Generate code for SH4-100 in such a way that no double-precision
23891 floating-point operations are used.
23893 @item -m4-200
23894 @opindex m4-200
23895 Generate code for SH4-200.
23897 @item -m4-200-nofpu
23898 @opindex m4-200-nofpu
23899 Generate code for SH4-200 without in such a way that the
23900 floating-point unit is not used.
23902 @item -m4-200-single
23903 @opindex m4-200-single
23904 Generate code for SH4-200 assuming the floating-point unit is in
23905 single-precision mode by default.
23907 @item -m4-200-single-only
23908 @opindex m4-200-single-only
23909 Generate code for SH4-200 in such a way that no double-precision
23910 floating-point operations are used.
23912 @item -m4-300
23913 @opindex m4-300
23914 Generate code for SH4-300.
23916 @item -m4-300-nofpu
23917 @opindex m4-300-nofpu
23918 Generate code for SH4-300 without in such a way that the
23919 floating-point unit is not used.
23921 @item -m4-300-single
23922 @opindex m4-300-single
23923 Generate code for SH4-300 in such a way that no double-precision
23924 floating-point operations are used.
23926 @item -m4-300-single-only
23927 @opindex m4-300-single-only
23928 Generate code for SH4-300 in such a way that no double-precision
23929 floating-point operations are used.
23931 @item -m4-340
23932 @opindex m4-340
23933 Generate code for SH4-340 (no MMU, no FPU).
23935 @item -m4-500
23936 @opindex m4-500
23937 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23938 assembler.
23940 @item -m4a-nofpu
23941 @opindex m4a-nofpu
23942 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23943 floating-point unit is not used.
23945 @item -m4a-single-only
23946 @opindex m4a-single-only
23947 Generate code for the SH4a, in such a way that no double-precision
23948 floating-point operations are used.
23950 @item -m4a-single
23951 @opindex m4a-single
23952 Generate code for the SH4a assuming the floating-point unit is in
23953 single-precision mode by default.
23955 @item -m4a
23956 @opindex m4a
23957 Generate code for the SH4a.
23959 @item -m4al
23960 @opindex m4al
23961 Same as @option{-m4a-nofpu}, except that it implicitly passes
23962 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23963 instructions at the moment.
23965 @item -mb
23966 @opindex mb
23967 Compile code for the processor in big-endian mode.
23969 @item -ml
23970 @opindex ml
23971 Compile code for the processor in little-endian mode.
23973 @item -mdalign
23974 @opindex mdalign
23975 Align doubles at 64-bit boundaries.  Note that this changes the calling
23976 conventions, and thus some functions from the standard C library do
23977 not work unless you recompile it first with @option{-mdalign}.
23979 @item -mrelax
23980 @opindex mrelax
23981 Shorten some address references at link time, when possible; uses the
23982 linker option @option{-relax}.
23984 @item -mbigtable
23985 @opindex mbigtable
23986 Use 32-bit offsets in @code{switch} tables.  The default is to use
23987 16-bit offsets.
23989 @item -mbitops
23990 @opindex mbitops
23991 Enable the use of bit manipulation instructions on SH2A.
23993 @item -mfmovd
23994 @opindex mfmovd
23995 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23996 alignment constraints.
23998 @item -mrenesas
23999 @opindex mrenesas
24000 Comply with the calling conventions defined by Renesas.
24002 @item -mno-renesas
24003 @opindex mno-renesas
24004 Comply with the calling conventions defined for GCC before the Renesas
24005 conventions were available.  This option is the default for all
24006 targets of the SH toolchain.
24008 @item -mnomacsave
24009 @opindex mnomacsave
24010 Mark the @code{MAC} register as call-clobbered, even if
24011 @option{-mrenesas} is given.
24013 @item -mieee
24014 @itemx -mno-ieee
24015 @opindex mieee
24016 @opindex mno-ieee
24017 Control the IEEE compliance of floating-point comparisons, which affects the
24018 handling of cases where the result of a comparison is unordered.  By default
24019 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
24020 enabled @option{-mno-ieee} is implicitly set, which results in faster
24021 floating-point greater-equal and less-equal comparisons.  The implicit settings
24022 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
24024 @item -minline-ic_invalidate
24025 @opindex minline-ic_invalidate
24026 Inline code to invalidate instruction cache entries after setting up
24027 nested function trampolines.
24028 This option has no effect if @option{-musermode} is in effect and the selected
24029 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
24030 instruction.
24031 If the selected code generation option does not allow the use of the @code{icbi}
24032 instruction, and @option{-musermode} is not in effect, the inlined code
24033 manipulates the instruction cache address array directly with an associative
24034 write.  This not only requires privileged mode at run time, but it also
24035 fails if the cache line had been mapped via the TLB and has become unmapped.
24037 @item -misize
24038 @opindex misize
24039 Dump instruction size and location in the assembly code.
24041 @item -mpadstruct
24042 @opindex mpadstruct
24043 This option is deprecated.  It pads structures to multiple of 4 bytes,
24044 which is incompatible with the SH ABI@.
24046 @item -matomic-model=@var{model}
24047 @opindex matomic-model=@var{model}
24048 Sets the model of atomic operations and additional parameters as a comma
24049 separated list.  For details on the atomic built-in functions see
24050 @ref{__atomic Builtins}.  The following models and parameters are supported:
24052 @table @samp
24054 @item none
24055 Disable compiler generated atomic sequences and emit library calls for atomic
24056 operations.  This is the default if the target is not @code{sh*-*-linux*}.
24058 @item soft-gusa
24059 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
24060 built-in functions.  The generated atomic sequences require additional support
24061 from the interrupt/exception handling code of the system and are only suitable
24062 for SH3* and SH4* single-core systems.  This option is enabled by default when
24063 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
24064 this option also partially utilizes the hardware atomic instructions
24065 @code{movli.l} and @code{movco.l} to create more efficient code, unless
24066 @samp{strict} is specified.  
24068 @item soft-tcb
24069 Generate software atomic sequences that use a variable in the thread control
24070 block.  This is a variation of the gUSA sequences which can also be used on
24071 SH1* and SH2* targets.  The generated atomic sequences require additional
24072 support from the interrupt/exception handling code of the system and are only
24073 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
24074 parameter has to be specified as well.
24076 @item soft-imask
24077 Generate software atomic sequences that temporarily disable interrupts by
24078 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
24079 in privileged mode and is only suitable for single-core systems.  Additional
24080 support from the interrupt/exception handling code of the system is not
24081 required.  This model is enabled by default when the target is
24082 @code{sh*-*-linux*} and SH1* or SH2*.
24084 @item hard-llcs
24085 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
24086 instructions only.  This is only available on SH4A and is suitable for
24087 multi-core systems.  Since the hardware instructions support only 32 bit atomic
24088 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
24089 Code compiled with this option is also compatible with other software
24090 atomic model interrupt/exception handling systems if executed on an SH4A
24091 system.  Additional support from the interrupt/exception handling code of the
24092 system is not required for this model.
24094 @item gbr-offset=
24095 This parameter specifies the offset in bytes of the variable in the thread
24096 control block structure that should be used by the generated atomic sequences
24097 when the @samp{soft-tcb} model has been selected.  For other models this
24098 parameter is ignored.  The specified value must be an integer multiple of four
24099 and in the range 0-1020.
24101 @item strict
24102 This parameter prevents mixed usage of multiple atomic models, even if they
24103 are compatible, and makes the compiler generate atomic sequences of the
24104 specified model only.
24106 @end table
24108 @item -mtas
24109 @opindex mtas
24110 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
24111 Notice that depending on the particular hardware and software configuration
24112 this can degrade overall performance due to the operand cache line flushes
24113 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
24114 processors the @code{tas.b} instruction must be used with caution since it
24115 can result in data corruption for certain cache configurations.
24117 @item -mprefergot
24118 @opindex mprefergot
24119 When generating position-independent code, emit function calls using
24120 the Global Offset Table instead of the Procedure Linkage Table.
24122 @item -musermode
24123 @itemx -mno-usermode
24124 @opindex musermode
24125 @opindex mno-usermode
24126 Don't allow (allow) the compiler generating privileged mode code.  Specifying
24127 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
24128 inlined code would not work in user mode.  @option{-musermode} is the default
24129 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
24130 @option{-musermode} has no effect, since there is no user mode.
24132 @item -multcost=@var{number}
24133 @opindex multcost=@var{number}
24134 Set the cost to assume for a multiply insn.
24136 @item -mdiv=@var{strategy}
24137 @opindex mdiv=@var{strategy}
24138 Set the division strategy to be used for integer division operations.
24139 @var{strategy} can be one of: 
24141 @table @samp
24143 @item call-div1
24144 Calls a library function that uses the single-step division instruction
24145 @code{div1} to perform the operation.  Division by zero calculates an
24146 unspecified result and does not trap.  This is the default except for SH4,
24147 SH2A and SHcompact.
24149 @item call-fp
24150 Calls a library function that performs the operation in double precision
24151 floating point.  Division by zero causes a floating-point exception.  This is
24152 the default for SHcompact with FPU.  Specifying this for targets that do not
24153 have a double precision FPU defaults to @code{call-div1}.
24155 @item call-table
24156 Calls a library function that uses a lookup table for small divisors and
24157 the @code{div1} instruction with case distinction for larger divisors.  Division
24158 by zero calculates an unspecified result and does not trap.  This is the default
24159 for SH4.  Specifying this for targets that do not have dynamic shift
24160 instructions defaults to @code{call-div1}.
24162 @end table
24164 When a division strategy has not been specified the default strategy is
24165 selected based on the current target.  For SH2A the default strategy is to
24166 use the @code{divs} and @code{divu} instructions instead of library function
24167 calls.
24169 @item -maccumulate-outgoing-args
24170 @opindex maccumulate-outgoing-args
24171 Reserve space once for outgoing arguments in the function prologue rather
24172 than around each call.  Generally beneficial for performance and size.  Also
24173 needed for unwinding to avoid changing the stack frame around conditional code.
24175 @item -mdivsi3_libfunc=@var{name}
24176 @opindex mdivsi3_libfunc=@var{name}
24177 Set the name of the library function used for 32-bit signed division to
24178 @var{name}.
24179 This only affects the name used in the @samp{call} division strategies, and
24180 the compiler still expects the same sets of input/output/clobbered registers as
24181 if this option were not present.
24183 @item -mfixed-range=@var{register-range}
24184 @opindex mfixed-range
24185 Generate code treating the given register range as fixed registers.
24186 A fixed register is one that the register allocator can not use.  This is
24187 useful when compiling kernel code.  A register range is specified as
24188 two registers separated by a dash.  Multiple register ranges can be
24189 specified separated by a comma.
24191 @item -mbranch-cost=@var{num}
24192 @opindex mbranch-cost=@var{num}
24193 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
24194 make the compiler try to generate more branch-free code if possible.  
24195 If not specified the value is selected depending on the processor type that
24196 is being compiled for.
24198 @item -mzdcbranch
24199 @itemx -mno-zdcbranch
24200 @opindex mzdcbranch
24201 @opindex mno-zdcbranch
24202 Assume (do not assume) that zero displacement conditional branch instructions
24203 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
24204 compiler prefers zero displacement branch code sequences.  This is
24205 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
24206 disabled by specifying @option{-mno-zdcbranch}.
24208 @item -mcbranch-force-delay-slot
24209 @opindex mcbranch-force-delay-slot
24210 Force the usage of delay slots for conditional branches, which stuffs the delay
24211 slot with a @code{nop} if a suitable instruction cannot be found.  By default
24212 this option is disabled.  It can be enabled to work around hardware bugs as
24213 found in the original SH7055.
24215 @item -mfused-madd
24216 @itemx -mno-fused-madd
24217 @opindex mfused-madd
24218 @opindex mno-fused-madd
24219 Generate code that uses (does not use) the floating-point multiply and
24220 accumulate instructions.  These instructions are generated by default
24221 if hardware floating point is used.  The machine-dependent
24222 @option{-mfused-madd} option is now mapped to the machine-independent
24223 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
24224 mapped to @option{-ffp-contract=off}.
24226 @item -mfsca
24227 @itemx -mno-fsca
24228 @opindex mfsca
24229 @opindex mno-fsca
24230 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
24231 and cosine approximations.  The option @option{-mfsca} must be used in
24232 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
24233 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
24234 approximations even if @option{-funsafe-math-optimizations} is in effect.
24236 @item -mfsrra
24237 @itemx -mno-fsrra
24238 @opindex mfsrra
24239 @opindex mno-fsrra
24240 Allow or disallow the compiler to emit the @code{fsrra} instruction for
24241 reciprocal square root approximations.  The option @option{-mfsrra} must be used
24242 in combination with @option{-funsafe-math-optimizations} and
24243 @option{-ffinite-math-only}.  It is enabled by default when generating code for
24244 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
24245 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
24246 in effect.
24248 @item -mpretend-cmove
24249 @opindex mpretend-cmove
24250 Prefer zero-displacement conditional branches for conditional move instruction
24251 patterns.  This can result in faster code on the SH4 processor.
24253 @item -mfdpic
24254 @opindex fdpic
24255 Generate code using the FDPIC ABI.
24257 @end table
24259 @node Solaris 2 Options
24260 @subsection Solaris 2 Options
24261 @cindex Solaris 2 options
24263 These @samp{-m} options are supported on Solaris 2:
24265 @table @gcctabopt
24266 @item -mclear-hwcap
24267 @opindex mclear-hwcap
24268 @option{-mclear-hwcap} tells the compiler to remove the hardware
24269 capabilities generated by the Solaris assembler.  This is only necessary
24270 when object files use ISA extensions not supported by the current
24271 machine, but check at runtime whether or not to use them.
24273 @item -mimpure-text
24274 @opindex mimpure-text
24275 @option{-mimpure-text}, used in addition to @option{-shared}, tells
24276 the compiler to not pass @option{-z text} to the linker when linking a
24277 shared object.  Using this option, you can link position-dependent
24278 code into a shared object.
24280 @option{-mimpure-text} suppresses the ``relocations remain against
24281 allocatable but non-writable sections'' linker error message.
24282 However, the necessary relocations trigger copy-on-write, and the
24283 shared object is not actually shared across processes.  Instead of
24284 using @option{-mimpure-text}, you should compile all source code with
24285 @option{-fpic} or @option{-fPIC}.
24287 @end table
24289 These switches are supported in addition to the above on Solaris 2:
24291 @table @gcctabopt
24292 @item -pthreads
24293 @opindex pthreads
24294 This is a synonym for @option{-pthread}.
24295 @end table
24297 @node SPARC Options
24298 @subsection SPARC Options
24299 @cindex SPARC options
24301 These @samp{-m} options are supported on the SPARC:
24303 @table @gcctabopt
24304 @item -mno-app-regs
24305 @itemx -mapp-regs
24306 @opindex mno-app-regs
24307 @opindex mapp-regs
24308 Specify @option{-mapp-regs} to generate output using the global registers
24309 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
24310 global register 1, each global register 2 through 4 is then treated as an
24311 allocable register that is clobbered by function calls.  This is the default.
24313 To be fully SVR4 ABI-compliant at the cost of some performance loss,
24314 specify @option{-mno-app-regs}.  You should compile libraries and system
24315 software with this option.
24317 @item -mflat
24318 @itemx -mno-flat
24319 @opindex mflat
24320 @opindex mno-flat
24321 With @option{-mflat}, the compiler does not generate save/restore instructions
24322 and uses a ``flat'' or single register window model.  This model is compatible
24323 with the regular register window model.  The local registers and the input
24324 registers (0--5) are still treated as ``call-saved'' registers and are
24325 saved on the stack as needed.
24327 With @option{-mno-flat} (the default), the compiler generates save/restore
24328 instructions (except for leaf functions).  This is the normal operating mode.
24330 @item -mfpu
24331 @itemx -mhard-float
24332 @opindex mfpu
24333 @opindex mhard-float
24334 Generate output containing floating-point instructions.  This is the
24335 default.
24337 @item -mno-fpu
24338 @itemx -msoft-float
24339 @opindex mno-fpu
24340 @opindex msoft-float
24341 Generate output containing library calls for floating point.
24342 @strong{Warning:} the requisite libraries are not available for all SPARC
24343 targets.  Normally the facilities of the machine's usual C compiler are
24344 used, but this cannot be done directly in cross-compilation.  You must make
24345 your own arrangements to provide suitable library functions for
24346 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
24347 @samp{sparclite-*-*} do provide software floating-point support.
24349 @option{-msoft-float} changes the calling convention in the output file;
24350 therefore, it is only useful if you compile @emph{all} of a program with
24351 this option.  In particular, you need to compile @file{libgcc.a}, the
24352 library that comes with GCC, with @option{-msoft-float} in order for
24353 this to work.
24355 @item -mhard-quad-float
24356 @opindex mhard-quad-float
24357 Generate output containing quad-word (long double) floating-point
24358 instructions.
24360 @item -msoft-quad-float
24361 @opindex msoft-quad-float
24362 Generate output containing library calls for quad-word (long double)
24363 floating-point instructions.  The functions called are those specified
24364 in the SPARC ABI@.  This is the default.
24366 As of this writing, there are no SPARC implementations that have hardware
24367 support for the quad-word floating-point instructions.  They all invoke
24368 a trap handler for one of these instructions, and then the trap handler
24369 emulates the effect of the instruction.  Because of the trap handler overhead,
24370 this is much slower than calling the ABI library routines.  Thus the
24371 @option{-msoft-quad-float} option is the default.
24373 @item -mno-unaligned-doubles
24374 @itemx -munaligned-doubles
24375 @opindex mno-unaligned-doubles
24376 @opindex munaligned-doubles
24377 Assume that doubles have 8-byte alignment.  This is the default.
24379 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
24380 alignment only if they are contained in another type, or if they have an
24381 absolute address.  Otherwise, it assumes they have 4-byte alignment.
24382 Specifying this option avoids some rare compatibility problems with code
24383 generated by other compilers.  It is not the default because it results
24384 in a performance loss, especially for floating-point code.
24386 @item -muser-mode
24387 @itemx -mno-user-mode
24388 @opindex muser-mode
24389 @opindex mno-user-mode
24390 Do not generate code that can only run in supervisor mode.  This is relevant
24391 only for the @code{casa} instruction emitted for the LEON3 processor.  This
24392 is the default.
24394 @item -mfaster-structs
24395 @itemx -mno-faster-structs
24396 @opindex mfaster-structs
24397 @opindex mno-faster-structs
24398 With @option{-mfaster-structs}, the compiler assumes that structures
24399 should have 8-byte alignment.  This enables the use of pairs of
24400 @code{ldd} and @code{std} instructions for copies in structure
24401 assignment, in place of twice as many @code{ld} and @code{st} pairs.
24402 However, the use of this changed alignment directly violates the SPARC
24403 ABI@.  Thus, it's intended only for use on targets where the developer
24404 acknowledges that their resulting code is not directly in line with
24405 the rules of the ABI@.
24407 @item -mstd-struct-return
24408 @itemx -mno-std-struct-return
24409 @opindex mstd-struct-return
24410 @opindex mno-std-struct-return
24411 With @option{-mstd-struct-return}, the compiler generates checking code
24412 in functions returning structures or unions to detect size mismatches
24413 between the two sides of function calls, as per the 32-bit ABI@.
24415 The default is @option{-mno-std-struct-return}.  This option has no effect
24416 in 64-bit mode.
24418 @item -mlra
24419 @itemx -mno-lra
24420 @opindex mlra
24421 @opindex mno-lra
24422 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
24423 so @option{-mno-lra} needs to be passed to get old Reload.
24425 @item -mcpu=@var{cpu_type}
24426 @opindex mcpu
24427 Set the instruction set, register set, and instruction scheduling parameters
24428 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24429 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
24430 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
24431 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
24432 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
24433 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
24435 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
24436 which selects the best architecture option for the host processor.
24437 @option{-mcpu=native} has no effect if GCC does not recognize
24438 the processor.
24440 Default instruction scheduling parameters are used for values that select
24441 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
24442 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
24444 Here is a list of each supported architecture and their supported
24445 implementations.
24447 @table @asis
24448 @item v7
24449 cypress, leon3v7
24451 @item v8
24452 supersparc, hypersparc, leon, leon3
24454 @item sparclite
24455 f930, f934, sparclite86x
24457 @item sparclet
24458 tsc701
24460 @item v9
24461 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
24462 niagara7, m8
24463 @end table
24465 By default (unless configured otherwise), GCC generates code for the V7
24466 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
24467 additionally optimizes it for the Cypress CY7C602 chip, as used in the
24468 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
24469 SPARCStation 1, 2, IPX etc.
24471 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
24472 architecture.  The only difference from V7 code is that the compiler emits
24473 the integer multiply and integer divide instructions which exist in SPARC-V8
24474 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
24475 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
24476 2000 series.
24478 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
24479 the SPARC architecture.  This adds the integer multiply, integer divide step
24480 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
24481 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
24482 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
24483 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
24484 MB86934 chip, which is the more recent SPARClite with FPU@.
24486 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
24487 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
24488 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
24489 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
24490 optimizes it for the TEMIC SPARClet chip.
24492 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
24493 architecture.  This adds 64-bit integer and floating-point move instructions,
24494 3 additional floating-point condition code registers and conditional move
24495 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
24496 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
24497 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
24498 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
24499 @option{-mcpu=niagara}, the compiler additionally optimizes it for
24500 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
24501 additionally optimizes it for Sun UltraSPARC T2 chips. With
24502 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
24503 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
24504 additionally optimizes it for Sun UltraSPARC T4 chips.  With
24505 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
24506 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
24507 additionally optimizes it for Oracle M8 chips.
24509 @item -mtune=@var{cpu_type}
24510 @opindex mtune
24511 Set the instruction scheduling parameters for machine type
24512 @var{cpu_type}, but do not set the instruction set or register set that the
24513 option @option{-mcpu=@var{cpu_type}} does.
24515 The same values for @option{-mcpu=@var{cpu_type}} can be used for
24516 @option{-mtune=@var{cpu_type}}, but the only useful values are those
24517 that select a particular CPU implementation.  Those are
24518 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
24519 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
24520 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
24521 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
24522 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
24523 and GNU/Linux toolchains, @samp{native} can also be used.
24525 @item -mv8plus
24526 @itemx -mno-v8plus
24527 @opindex mv8plus
24528 @opindex mno-v8plus
24529 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
24530 difference from the V8 ABI is that the global and out registers are
24531 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
24532 mode for all SPARC-V9 processors.
24534 @item -mvis
24535 @itemx -mno-vis
24536 @opindex mvis
24537 @opindex mno-vis
24538 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
24539 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
24541 @item -mvis2
24542 @itemx -mno-vis2
24543 @opindex mvis2
24544 @opindex mno-vis2
24545 With @option{-mvis2}, GCC generates code that takes advantage of
24546 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
24547 default is @option{-mvis2} when targeting a cpu that supports such
24548 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
24549 also sets @option{-mvis}.
24551 @item -mvis3
24552 @itemx -mno-vis3
24553 @opindex mvis3
24554 @opindex mno-vis3
24555 With @option{-mvis3}, GCC generates code that takes advantage of
24556 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24557 default is @option{-mvis3} when targeting a cpu that supports such
24558 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24559 also sets @option{-mvis2} and @option{-mvis}.
24561 @item -mvis4
24562 @itemx -mno-vis4
24563 @opindex mvis4
24564 @opindex mno-vis4
24565 With @option{-mvis4}, GCC generates code that takes advantage of
24566 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24567 default is @option{-mvis4} when targeting a cpu that supports such
24568 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24569 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24571 @item -mvis4b
24572 @itemx -mno-vis4b
24573 @opindex mvis4b
24574 @opindex mno-vis4b
24575 With @option{-mvis4b}, GCC generates code that takes advantage of
24576 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
24577 the additional VIS instructions introduced in the Oracle SPARC
24578 Architecture 2017.  The default is @option{-mvis4b} when targeting a
24579 cpu that supports such instructions, such as m8 and later.  Setting
24580 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
24581 @option{-mvis2} and @option{-mvis}.
24583 @item -mcbcond
24584 @itemx -mno-cbcond
24585 @opindex mcbcond
24586 @opindex mno-cbcond
24587 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24588 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24589 when targeting a CPU that supports such instructions, such as Niagara-4 and
24590 later.
24592 @item -mfmaf
24593 @itemx -mno-fmaf
24594 @opindex mfmaf
24595 @opindex mno-fmaf
24596 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24597 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24598 when targeting a CPU that supports such instructions, such as Niagara-3 and
24599 later.
24601 @item -mfsmuld
24602 @itemx -mno-fsmuld
24603 @opindex mfsmuld
24604 @opindex mno-fsmuld
24605 With @option{-mfsmuld}, GCC generates code that takes advantage of the
24606 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
24607 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
24608 or V9 with FPU except @option{-mcpu=leon}.
24610 @item -mpopc
24611 @itemx -mno-popc
24612 @opindex mpopc
24613 @opindex mno-popc
24614 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24615 Population Count instruction.  The default is @option{-mpopc}
24616 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24617 later.
24619 @item -msubxc
24620 @itemx -mno-subxc
24621 @opindex msubxc
24622 @opindex mno-subxc
24623 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24624 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24625 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24626 later.
24628 @item -mfix-at697f
24629 @opindex mfix-at697f
24630 Enable the documented workaround for the single erratum of the Atmel AT697F
24631 processor (which corresponds to erratum #13 of the AT697E processor).
24633 @item -mfix-ut699
24634 @opindex mfix-ut699
24635 Enable the documented workarounds for the floating-point errata and the data
24636 cache nullify errata of the UT699 processor.
24638 @item -mfix-ut700
24639 @opindex mfix-ut700
24640 Enable the documented workaround for the back-to-back store errata of
24641 the UT699E/UT700 processor.
24643 @item -mfix-gr712rc
24644 @opindex mfix-gr712rc
24645 Enable the documented workaround for the back-to-back store errata of
24646 the GR712RC processor.
24647 @end table
24649 These @samp{-m} options are supported in addition to the above
24650 on SPARC-V9 processors in 64-bit environments:
24652 @table @gcctabopt
24653 @item -m32
24654 @itemx -m64
24655 @opindex m32
24656 @opindex m64
24657 Generate code for a 32-bit or 64-bit environment.
24658 The 32-bit environment sets int, long and pointer to 32 bits.
24659 The 64-bit environment sets int to 32 bits and long and pointer
24660 to 64 bits.
24662 @item -mcmodel=@var{which}
24663 @opindex mcmodel
24664 Set the code model to one of
24666 @table @samp
24667 @item medlow
24668 The Medium/Low code model: 64-bit addresses, programs
24669 must be linked in the low 32 bits of memory.  Programs can be statically
24670 or dynamically linked.
24672 @item medmid
24673 The Medium/Middle code model: 64-bit addresses, programs
24674 must be linked in the low 44 bits of memory, the text and data segments must
24675 be less than 2GB in size and the data segment must be located within 2GB of
24676 the text segment.
24678 @item medany
24679 The Medium/Anywhere code model: 64-bit addresses, programs
24680 may be linked anywhere in memory, the text and data segments must be less
24681 than 2GB in size and the data segment must be located within 2GB of the
24682 text segment.
24684 @item embmedany
24685 The Medium/Anywhere code model for embedded systems:
24686 64-bit addresses, the text and data segments must be less than 2GB in
24687 size, both starting anywhere in memory (determined at link time).  The
24688 global register %g4 points to the base of the data segment.  Programs
24689 are statically linked and PIC is not supported.
24690 @end table
24692 @item -mmemory-model=@var{mem-model}
24693 @opindex mmemory-model
24694 Set the memory model in force on the processor to one of
24696 @table @samp
24697 @item default
24698 The default memory model for the processor and operating system.
24700 @item rmo
24701 Relaxed Memory Order
24703 @item pso
24704 Partial Store Order
24706 @item tso
24707 Total Store Order
24709 @item sc
24710 Sequential Consistency
24711 @end table
24713 These memory models are formally defined in Appendix D of the SPARC-V9
24714 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24716 @item -mstack-bias
24717 @itemx -mno-stack-bias
24718 @opindex mstack-bias
24719 @opindex mno-stack-bias
24720 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24721 frame pointer if present, are offset by @minus{}2047 which must be added back
24722 when making stack frame references.  This is the default in 64-bit mode.
24723 Otherwise, assume no such offset is present.
24724 @end table
24726 @node SPU Options
24727 @subsection SPU Options
24728 @cindex SPU options
24730 These @samp{-m} options are supported on the SPU:
24732 @table @gcctabopt
24733 @item -mwarn-reloc
24734 @itemx -merror-reloc
24735 @opindex mwarn-reloc
24736 @opindex merror-reloc
24738 The loader for SPU does not handle dynamic relocations.  By default, GCC
24739 gives an error when it generates code that requires a dynamic
24740 relocation.  @option{-mno-error-reloc} disables the error,
24741 @option{-mwarn-reloc} generates a warning instead.
24743 @item -msafe-dma
24744 @itemx -munsafe-dma
24745 @opindex msafe-dma
24746 @opindex munsafe-dma
24748 Instructions that initiate or test completion of DMA must not be
24749 reordered with respect to loads and stores of the memory that is being
24750 accessed.
24751 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24752 memory accesses, but that can lead to inefficient code in places where the
24753 memory is known to not change.  Rather than mark the memory as volatile,
24754 you can use @option{-msafe-dma} to tell the compiler to treat
24755 the DMA instructions as potentially affecting all memory.  
24757 @item -mbranch-hints
24758 @opindex mbranch-hints
24760 By default, GCC generates a branch hint instruction to avoid
24761 pipeline stalls for always-taken or probably-taken branches.  A hint
24762 is not generated closer than 8 instructions away from its branch.
24763 There is little reason to disable them, except for debugging purposes,
24764 or to make an object a little bit smaller.
24766 @item -msmall-mem
24767 @itemx -mlarge-mem
24768 @opindex msmall-mem
24769 @opindex mlarge-mem
24771 By default, GCC generates code assuming that addresses are never larger
24772 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24773 a full 32-bit address.
24775 @item -mstdmain
24776 @opindex mstdmain
24778 By default, GCC links against startup code that assumes the SPU-style
24779 main function interface (which has an unconventional parameter list).
24780 With @option{-mstdmain}, GCC links your program against startup
24781 code that assumes a C99-style interface to @code{main}, including a
24782 local copy of @code{argv} strings.
24784 @item -mfixed-range=@var{register-range}
24785 @opindex mfixed-range
24786 Generate code treating the given register range as fixed registers.
24787 A fixed register is one that the register allocator cannot use.  This is
24788 useful when compiling kernel code.  A register range is specified as
24789 two registers separated by a dash.  Multiple register ranges can be
24790 specified separated by a comma.
24792 @item -mea32
24793 @itemx -mea64
24794 @opindex mea32
24795 @opindex mea64
24796 Compile code assuming that pointers to the PPU address space accessed
24797 via the @code{__ea} named address space qualifier are either 32 or 64
24798 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24799 all object code in an executable must be compiled with the same setting.
24801 @item -maddress-space-conversion
24802 @itemx -mno-address-space-conversion
24803 @opindex maddress-space-conversion
24804 @opindex mno-address-space-conversion
24805 Allow/disallow treating the @code{__ea} address space as superset
24806 of the generic address space.  This enables explicit type casts
24807 between @code{__ea} and generic pointer as well as implicit
24808 conversions of generic pointers to @code{__ea} pointers.  The
24809 default is to allow address space pointer conversions.
24811 @item -mcache-size=@var{cache-size}
24812 @opindex mcache-size
24813 This option controls the version of libgcc that the compiler links to an
24814 executable and selects a software-managed cache for accessing variables
24815 in the @code{__ea} address space with a particular cache size.  Possible
24816 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24817 and @samp{128}.  The default cache size is 64KB.
24819 @item -matomic-updates
24820 @itemx -mno-atomic-updates
24821 @opindex matomic-updates
24822 @opindex mno-atomic-updates
24823 This option controls the version of libgcc that the compiler links to an
24824 executable and selects whether atomic updates to the software-managed
24825 cache of PPU-side variables are used.  If you use atomic updates, changes
24826 to a PPU variable from SPU code using the @code{__ea} named address space
24827 qualifier do not interfere with changes to other PPU variables residing
24828 in the same cache line from PPU code.  If you do not use atomic updates,
24829 such interference may occur; however, writing back cache lines is
24830 more efficient.  The default behavior is to use atomic updates.
24832 @item -mdual-nops
24833 @itemx -mdual-nops=@var{n}
24834 @opindex mdual-nops
24835 By default, GCC inserts NOPs to increase dual issue when it expects
24836 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24837 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24838 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24840 @item -mhint-max-nops=@var{n}
24841 @opindex mhint-max-nops
24842 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24843 be at least 8 instructions away from the branch it is affecting.  GCC
24844 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24845 generate the branch hint.
24847 @item -mhint-max-distance=@var{n}
24848 @opindex mhint-max-distance
24849 The encoding of the branch hint instruction limits the hint to be within
24850 256 instructions of the branch it is affecting.  By default, GCC makes
24851 sure it is within 125.
24853 @item -msafe-hints
24854 @opindex msafe-hints
24855 Work around a hardware bug that causes the SPU to stall indefinitely.
24856 By default, GCC inserts the @code{hbrp} instruction to make sure
24857 this stall won't happen.
24859 @end table
24861 @node System V Options
24862 @subsection Options for System V
24864 These additional options are available on System V Release 4 for
24865 compatibility with other compilers on those systems:
24867 @table @gcctabopt
24868 @item -G
24869 @opindex G
24870 Create a shared object.
24871 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24873 @item -Qy
24874 @opindex Qy
24875 Identify the versions of each tool used by the compiler, in a
24876 @code{.ident} assembler directive in the output.
24878 @item -Qn
24879 @opindex Qn
24880 Refrain from adding @code{.ident} directives to the output file (this is
24881 the default).
24883 @item -YP,@var{dirs}
24884 @opindex YP
24885 Search the directories @var{dirs}, and no others, for libraries
24886 specified with @option{-l}.
24888 @item -Ym,@var{dir}
24889 @opindex Ym
24890 Look in the directory @var{dir} to find the M4 preprocessor.
24891 The assembler uses this option.
24892 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24893 @c the generic assembler that comes with Solaris takes just -Ym.
24894 @end table
24896 @node TILE-Gx Options
24897 @subsection TILE-Gx Options
24898 @cindex TILE-Gx options
24900 These @samp{-m} options are supported on the TILE-Gx:
24902 @table @gcctabopt
24903 @item -mcmodel=small
24904 @opindex mcmodel=small
24905 Generate code for the small model.  The distance for direct calls is
24906 limited to 500M in either direction.  PC-relative addresses are 32
24907 bits.  Absolute addresses support the full address range.
24909 @item -mcmodel=large
24910 @opindex mcmodel=large
24911 Generate code for the large model.  There is no limitation on call
24912 distance, pc-relative addresses, or absolute addresses.
24914 @item -mcpu=@var{name}
24915 @opindex mcpu
24916 Selects the type of CPU to be targeted.  Currently the only supported
24917 type is @samp{tilegx}.
24919 @item -m32
24920 @itemx -m64
24921 @opindex m32
24922 @opindex m64
24923 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24924 environment sets int, long, and pointer to 32 bits.  The 64-bit
24925 environment sets int to 32 bits and long and pointer to 64 bits.
24927 @item -mbig-endian
24928 @itemx -mlittle-endian
24929 @opindex mbig-endian
24930 @opindex mlittle-endian
24931 Generate code in big/little endian mode, respectively.
24932 @end table
24934 @node TILEPro Options
24935 @subsection TILEPro Options
24936 @cindex TILEPro options
24938 These @samp{-m} options are supported on the TILEPro:
24940 @table @gcctabopt
24941 @item -mcpu=@var{name}
24942 @opindex mcpu
24943 Selects the type of CPU to be targeted.  Currently the only supported
24944 type is @samp{tilepro}.
24946 @item -m32
24947 @opindex m32
24948 Generate code for a 32-bit environment, which sets int, long, and
24949 pointer to 32 bits.  This is the only supported behavior so the flag
24950 is essentially ignored.
24951 @end table
24953 @node V850 Options
24954 @subsection V850 Options
24955 @cindex V850 Options
24957 These @samp{-m} options are defined for V850 implementations:
24959 @table @gcctabopt
24960 @item -mlong-calls
24961 @itemx -mno-long-calls
24962 @opindex mlong-calls
24963 @opindex mno-long-calls
24964 Treat all calls as being far away (near).  If calls are assumed to be
24965 far away, the compiler always loads the function's address into a
24966 register, and calls indirect through the pointer.
24968 @item -mno-ep
24969 @itemx -mep
24970 @opindex mno-ep
24971 @opindex mep
24972 Do not optimize (do optimize) basic blocks that use the same index
24973 pointer 4 or more times to copy pointer into the @code{ep} register, and
24974 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24975 option is on by default if you optimize.
24977 @item -mno-prolog-function
24978 @itemx -mprolog-function
24979 @opindex mno-prolog-function
24980 @opindex mprolog-function
24981 Do not use (do use) external functions to save and restore registers
24982 at the prologue and epilogue of a function.  The external functions
24983 are slower, but use less code space if more than one function saves
24984 the same number of registers.  The @option{-mprolog-function} option
24985 is on by default if you optimize.
24987 @item -mspace
24988 @opindex mspace
24989 Try to make the code as small as possible.  At present, this just turns
24990 on the @option{-mep} and @option{-mprolog-function} options.
24992 @item -mtda=@var{n}
24993 @opindex mtda
24994 Put static or global variables whose size is @var{n} bytes or less into
24995 the tiny data area that register @code{ep} points to.  The tiny data
24996 area can hold up to 256 bytes in total (128 bytes for byte references).
24998 @item -msda=@var{n}
24999 @opindex msda
25000 Put static or global variables whose size is @var{n} bytes or less into
25001 the small data area that register @code{gp} points to.  The small data
25002 area can hold up to 64 kilobytes.
25004 @item -mzda=@var{n}
25005 @opindex mzda
25006 Put static or global variables whose size is @var{n} bytes or less into
25007 the first 32 kilobytes of memory.
25009 @item -mv850
25010 @opindex mv850
25011 Specify that the target processor is the V850.
25013 @item -mv850e3v5
25014 @opindex mv850e3v5
25015 Specify that the target processor is the V850E3V5.  The preprocessor
25016 constant @code{__v850e3v5__} is defined if this option is used.
25018 @item -mv850e2v4
25019 @opindex mv850e2v4
25020 Specify that the target processor is the V850E3V5.  This is an alias for
25021 the @option{-mv850e3v5} option.
25023 @item -mv850e2v3
25024 @opindex mv850e2v3
25025 Specify that the target processor is the V850E2V3.  The preprocessor
25026 constant @code{__v850e2v3__} is defined if this option is used.
25028 @item -mv850e2
25029 @opindex mv850e2
25030 Specify that the target processor is the V850E2.  The preprocessor
25031 constant @code{__v850e2__} is defined if this option is used.
25033 @item -mv850e1
25034 @opindex mv850e1
25035 Specify that the target processor is the V850E1.  The preprocessor
25036 constants @code{__v850e1__} and @code{__v850e__} are defined if
25037 this option is used.
25039 @item -mv850es
25040 @opindex mv850es
25041 Specify that the target processor is the V850ES.  This is an alias for
25042 the @option{-mv850e1} option.
25044 @item -mv850e
25045 @opindex mv850e
25046 Specify that the target processor is the V850E@.  The preprocessor
25047 constant @code{__v850e__} is defined if this option is used.
25049 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
25050 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
25051 are defined then a default target processor is chosen and the
25052 relevant @samp{__v850*__} preprocessor constant is defined.
25054 The preprocessor constants @code{__v850} and @code{__v851__} are always
25055 defined, regardless of which processor variant is the target.
25057 @item -mdisable-callt
25058 @itemx -mno-disable-callt
25059 @opindex mdisable-callt
25060 @opindex mno-disable-callt
25061 This option suppresses generation of the @code{CALLT} instruction for the
25062 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
25063 architecture.
25065 This option is enabled by default when the RH850 ABI is
25066 in use (see @option{-mrh850-abi}), and disabled by default when the
25067 GCC ABI is in use.  If @code{CALLT} instructions are being generated
25068 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
25070 @item -mrelax
25071 @itemx -mno-relax
25072 @opindex mrelax
25073 @opindex mno-relax
25074 Pass on (or do not pass on) the @option{-mrelax} command-line option
25075 to the assembler.
25077 @item -mlong-jumps
25078 @itemx -mno-long-jumps
25079 @opindex mlong-jumps
25080 @opindex mno-long-jumps
25081 Disable (or re-enable) the generation of PC-relative jump instructions.
25083 @item -msoft-float
25084 @itemx -mhard-float
25085 @opindex msoft-float
25086 @opindex mhard-float
25087 Disable (or re-enable) the generation of hardware floating point
25088 instructions.  This option is only significant when the target
25089 architecture is @samp{V850E2V3} or higher.  If hardware floating point
25090 instructions are being generated then the C preprocessor symbol
25091 @code{__FPU_OK__} is defined, otherwise the symbol
25092 @code{__NO_FPU__} is defined.
25094 @item -mloop
25095 @opindex mloop
25096 Enables the use of the e3v5 LOOP instruction.  The use of this
25097 instruction is not enabled by default when the e3v5 architecture is
25098 selected because its use is still experimental.
25100 @item -mrh850-abi
25101 @itemx -mghs
25102 @opindex mrh850-abi
25103 @opindex mghs
25104 Enables support for the RH850 version of the V850 ABI.  This is the
25105 default.  With this version of the ABI the following rules apply:
25107 @itemize
25108 @item
25109 Integer sized structures and unions are returned via a memory pointer
25110 rather than a register.
25112 @item
25113 Large structures and unions (more than 8 bytes in size) are passed by
25114 value.
25116 @item
25117 Functions are aligned to 16-bit boundaries.
25119 @item
25120 The @option{-m8byte-align} command-line option is supported.
25122 @item
25123 The @option{-mdisable-callt} command-line option is enabled by
25124 default.  The @option{-mno-disable-callt} command-line option is not
25125 supported.
25126 @end itemize
25128 When this version of the ABI is enabled the C preprocessor symbol
25129 @code{__V850_RH850_ABI__} is defined.
25131 @item -mgcc-abi
25132 @opindex mgcc-abi
25133 Enables support for the old GCC version of the V850 ABI.  With this
25134 version of the ABI the following rules apply:
25136 @itemize
25137 @item
25138 Integer sized structures and unions are returned in register @code{r10}.
25140 @item
25141 Large structures and unions (more than 8 bytes in size) are passed by
25142 reference.
25144 @item
25145 Functions are aligned to 32-bit boundaries, unless optimizing for
25146 size.
25148 @item
25149 The @option{-m8byte-align} command-line option is not supported.
25151 @item
25152 The @option{-mdisable-callt} command-line option is supported but not
25153 enabled by default.
25154 @end itemize
25156 When this version of the ABI is enabled the C preprocessor symbol
25157 @code{__V850_GCC_ABI__} is defined.
25159 @item -m8byte-align
25160 @itemx -mno-8byte-align
25161 @opindex m8byte-align
25162 @opindex mno-8byte-align
25163 Enables support for @code{double} and @code{long long} types to be
25164 aligned on 8-byte boundaries.  The default is to restrict the
25165 alignment of all objects to at most 4-bytes.  When
25166 @option{-m8byte-align} is in effect the C preprocessor symbol
25167 @code{__V850_8BYTE_ALIGN__} is defined.
25169 @item -mbig-switch
25170 @opindex mbig-switch
25171 Generate code suitable for big switch tables.  Use this option only if
25172 the assembler/linker complain about out of range branches within a switch
25173 table.
25175 @item -mapp-regs
25176 @opindex mapp-regs
25177 This option causes r2 and r5 to be used in the code generated by
25178 the compiler.  This setting is the default.
25180 @item -mno-app-regs
25181 @opindex mno-app-regs
25182 This option causes r2 and r5 to be treated as fixed registers.
25184 @end table
25186 @node VAX Options
25187 @subsection VAX Options
25188 @cindex VAX options
25190 These @samp{-m} options are defined for the VAX:
25192 @table @gcctabopt
25193 @item -munix
25194 @opindex munix
25195 Do not output certain jump instructions (@code{aobleq} and so on)
25196 that the Unix assembler for the VAX cannot handle across long
25197 ranges.
25199 @item -mgnu
25200 @opindex mgnu
25201 Do output those jump instructions, on the assumption that the
25202 GNU assembler is being used.
25204 @item -mg
25205 @opindex mg
25206 Output code for G-format floating-point numbers instead of D-format.
25207 @end table
25209 @node Visium Options
25210 @subsection Visium Options
25211 @cindex Visium options
25213 @table @gcctabopt
25215 @item -mdebug
25216 @opindex mdebug
25217 A program which performs file I/O and is destined to run on an MCM target
25218 should be linked with this option.  It causes the libraries libc.a and
25219 libdebug.a to be linked.  The program should be run on the target under
25220 the control of the GDB remote debugging stub.
25222 @item -msim
25223 @opindex msim
25224 A program which performs file I/O and is destined to run on the simulator
25225 should be linked with option.  This causes libraries libc.a and libsim.a to
25226 be linked.
25228 @item -mfpu
25229 @itemx -mhard-float
25230 @opindex mfpu
25231 @opindex mhard-float
25232 Generate code containing floating-point instructions.  This is the
25233 default.
25235 @item -mno-fpu
25236 @itemx -msoft-float
25237 @opindex mno-fpu
25238 @opindex msoft-float
25239 Generate code containing library calls for floating-point.
25241 @option{-msoft-float} changes the calling convention in the output file;
25242 therefore, it is only useful if you compile @emph{all} of a program with
25243 this option.  In particular, you need to compile @file{libgcc.a}, the
25244 library that comes with GCC, with @option{-msoft-float} in order for
25245 this to work.
25247 @item -mcpu=@var{cpu_type}
25248 @opindex mcpu
25249 Set the instruction set, register set, and instruction scheduling parameters
25250 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25251 @samp{mcm}, @samp{gr5} and @samp{gr6}.
25253 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
25255 By default (unless configured otherwise), GCC generates code for the GR5
25256 variant of the Visium architecture.  
25258 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
25259 architecture.  The only difference from GR5 code is that the compiler will
25260 generate block move instructions.
25262 @item -mtune=@var{cpu_type}
25263 @opindex mtune
25264 Set the instruction scheduling parameters for machine type @var{cpu_type},
25265 but do not set the instruction set or register set that the option
25266 @option{-mcpu=@var{cpu_type}} would.
25268 @item -msv-mode
25269 @opindex msv-mode
25270 Generate code for the supervisor mode, where there are no restrictions on
25271 the access to general registers.  This is the default.
25273 @item -muser-mode
25274 @opindex muser-mode
25275 Generate code for the user mode, where the access to some general registers
25276 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
25277 mode; on the GR6, only registers r29 to r31 are affected.
25278 @end table
25280 @node VMS Options
25281 @subsection VMS Options
25283 These @samp{-m} options are defined for the VMS implementations:
25285 @table @gcctabopt
25286 @item -mvms-return-codes
25287 @opindex mvms-return-codes
25288 Return VMS condition codes from @code{main}. The default is to return POSIX-style
25289 condition (e.g.@ error) codes.
25291 @item -mdebug-main=@var{prefix}
25292 @opindex mdebug-main=@var{prefix}
25293 Flag the first routine whose name starts with @var{prefix} as the main
25294 routine for the debugger.
25296 @item -mmalloc64
25297 @opindex mmalloc64
25298 Default to 64-bit memory allocation routines.
25300 @item -mpointer-size=@var{size}
25301 @opindex mpointer-size=@var{size}
25302 Set the default size of pointers. Possible options for @var{size} are
25303 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
25304 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
25305 The later option disables @code{pragma pointer_size}.
25306 @end table
25308 @node VxWorks Options
25309 @subsection VxWorks Options
25310 @cindex VxWorks Options
25312 The options in this section are defined for all VxWorks targets.
25313 Options specific to the target hardware are listed with the other
25314 options for that target.
25316 @table @gcctabopt
25317 @item -mrtp
25318 @opindex mrtp
25319 GCC can generate code for both VxWorks kernels and real time processes
25320 (RTPs).  This option switches from the former to the latter.  It also
25321 defines the preprocessor macro @code{__RTP__}.
25323 @item -non-static
25324 @opindex non-static
25325 Link an RTP executable against shared libraries rather than static
25326 libraries.  The options @option{-static} and @option{-shared} can
25327 also be used for RTPs (@pxref{Link Options}); @option{-static}
25328 is the default.
25330 @item -Bstatic
25331 @itemx -Bdynamic
25332 @opindex Bstatic
25333 @opindex Bdynamic
25334 These options are passed down to the linker.  They are defined for
25335 compatibility with Diab.
25337 @item -Xbind-lazy
25338 @opindex Xbind-lazy
25339 Enable lazy binding of function calls.  This option is equivalent to
25340 @option{-Wl,-z,now} and is defined for compatibility with Diab.
25342 @item -Xbind-now
25343 @opindex Xbind-now
25344 Disable lazy binding of function calls.  This option is the default and
25345 is defined for compatibility with Diab.
25346 @end table
25348 @node x86 Options
25349 @subsection x86 Options
25350 @cindex x86 Options
25352 These @samp{-m} options are defined for the x86 family of computers.
25354 @table @gcctabopt
25356 @item -march=@var{cpu-type}
25357 @opindex march
25358 Generate instructions for the machine type @var{cpu-type}.  In contrast to
25359 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
25360 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
25361 to generate code that may not run at all on processors other than the one
25362 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
25363 @option{-mtune=@var{cpu-type}}.
25365 The choices for @var{cpu-type} are:
25367 @table @samp
25368 @item native
25369 This selects the CPU to generate code for at compilation time by determining
25370 the processor type of the compiling machine.  Using @option{-march=native}
25371 enables all instruction subsets supported by the local machine (hence
25372 the result might not run on different machines).  Using @option{-mtune=native}
25373 produces code optimized for the local machine under the constraints
25374 of the selected instruction set.  
25376 @item i386
25377 Original Intel i386 CPU@.
25379 @item i486
25380 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
25382 @item i586
25383 @itemx pentium
25384 Intel Pentium CPU with no MMX support.
25386 @item lakemont
25387 Intel Lakemont MCU, based on Intel Pentium CPU.
25389 @item pentium-mmx
25390 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
25392 @item pentiumpro
25393 Intel Pentium Pro CPU@.
25395 @item i686
25396 When used with @option{-march}, the Pentium Pro
25397 instruction set is used, so the code runs on all i686 family chips.
25398 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
25400 @item pentium2
25401 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
25402 support.
25404 @item pentium3
25405 @itemx pentium3m
25406 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
25407 set support.
25409 @item pentium-m
25410 Intel Pentium M; low-power version of Intel Pentium III CPU
25411 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
25413 @item pentium4
25414 @itemx pentium4m
25415 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
25417 @item prescott
25418 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
25419 set support.
25421 @item nocona
25422 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
25423 SSE2 and SSE3 instruction set support.
25425 @item core2
25426 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
25427 instruction set support.
25429 @item nehalem
25430 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25431 SSE4.1, SSE4.2 and POPCNT instruction set support.
25433 @item westmere
25434 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25435 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
25437 @item sandybridge
25438 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25439 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
25441 @item ivybridge
25442 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25443 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
25444 instruction set support.
25446 @item haswell
25447 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25448 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25449 BMI, BMI2 and F16C instruction set support.
25451 @item broadwell
25452 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25453 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25454 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
25456 @item skylake
25457 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25458 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25459 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
25460 XSAVES instruction set support.
25462 @item bonnell
25463 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
25464 instruction set support.
25466 @item silvermont
25467 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25468 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
25470 @item knl
25471 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25472 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25473 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
25474 AVX512CD instruction set support.
25476 @item knm
25477 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25478 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25479 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25480 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
25482 @item skylake-avx512
25483 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25484 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25485 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
25486 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
25488 @item cannonlake
25489 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
25490 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
25491 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
25492 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
25493 AVX512IFMA, SHA, CLWB and UMIP instruction set support.
25495 @item k6
25496 AMD K6 CPU with MMX instruction set support.
25498 @item k6-2
25499 @itemx k6-3
25500 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
25502 @item athlon
25503 @itemx athlon-tbird
25504 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
25505 support.
25507 @item athlon-4
25508 @itemx athlon-xp
25509 @itemx athlon-mp
25510 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
25511 instruction set support.
25513 @item k8
25514 @itemx opteron
25515 @itemx athlon64
25516 @itemx athlon-fx
25517 Processors based on the AMD K8 core with x86-64 instruction set support,
25518 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
25519 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
25520 instruction set extensions.)
25522 @item k8-sse3
25523 @itemx opteron-sse3
25524 @itemx athlon64-sse3
25525 Improved versions of AMD K8 cores with SSE3 instruction set support.
25527 @item amdfam10
25528 @itemx barcelona
25529 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
25530 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
25531 instruction set extensions.)
25533 @item bdver1
25534 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
25535 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
25536 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
25537 @item bdver2
25538 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25539 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
25540 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
25541 extensions.)
25542 @item bdver3
25543 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25544 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
25545 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
25546 64-bit instruction set extensions.
25547 @item bdver4
25548 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25549 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
25550 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
25551 SSE4.2, ABM and 64-bit instruction set extensions.
25553 @item znver1
25554 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
25555 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
25556 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
25557 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
25558 instruction set extensions.
25560 @item btver1
25561 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
25562 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
25563 instruction set extensions.)
25565 @item btver2
25566 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
25567 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
25568 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
25570 @item winchip-c6
25571 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
25572 set support.
25574 @item winchip2
25575 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
25576 instruction set support.
25578 @item c3
25579 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
25580 (No scheduling is implemented for this chip.)
25582 @item c3-2
25583 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
25584 (No scheduling is implemented for this chip.)
25586 @item c7
25587 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25588 (No scheduling is implemented for this chip.)
25590 @item samuel-2
25591 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
25592 (No scheduling is implemented for this chip.)
25594 @item nehemiah
25595 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
25596 (No scheduling is implemented for this chip.)
25598 @item esther
25599 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25600 (No scheduling is implemented for this chip.)
25602 @item eden-x2
25603 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25604 (No scheduling is implemented for this chip.)
25606 @item eden-x4
25607 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25608 AVX and AVX2 instruction set support.
25609 (No scheduling is implemented for this chip.)
25611 @item nano
25612 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25613 instruction set support.
25614 (No scheduling is implemented for this chip.)
25616 @item nano-1000
25617 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25618 instruction set support.
25619 (No scheduling is implemented for this chip.)
25621 @item nano-2000
25622 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25623 instruction set support.
25624 (No scheduling is implemented for this chip.)
25626 @item nano-3000
25627 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25628 instruction set support.
25629 (No scheduling is implemented for this chip.)
25631 @item nano-x2
25632 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25633 instruction set support.
25634 (No scheduling is implemented for this chip.)
25636 @item nano-x4
25637 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25638 instruction set support.
25639 (No scheduling is implemented for this chip.)
25641 @item geode
25642 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25643 @end table
25645 @item -mtune=@var{cpu-type}
25646 @opindex mtune
25647 Tune to @var{cpu-type} everything applicable about the generated code, except
25648 for the ABI and the set of available instructions.  
25649 While picking a specific @var{cpu-type} schedules things appropriately
25650 for that particular chip, the compiler does not generate any code that
25651 cannot run on the default machine type unless you use a
25652 @option{-march=@var{cpu-type}} option.
25653 For example, if GCC is configured for i686-pc-linux-gnu
25654 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25655 but still runs on i686 machines.
25657 The choices for @var{cpu-type} are the same as for @option{-march}.
25658 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25660 @table @samp
25661 @item generic
25662 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25663 If you know the CPU on which your code will run, then you should use
25664 the corresponding @option{-mtune} or @option{-march} option instead of
25665 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25666 of your application will have, then you should use this option.
25668 As new processors are deployed in the marketplace, the behavior of this
25669 option will change.  Therefore, if you upgrade to a newer version of
25670 GCC, code generation controlled by this option will change to reflect
25671 the processors
25672 that are most common at the time that version of GCC is released.
25674 There is no @option{-march=generic} option because @option{-march}
25675 indicates the instruction set the compiler can use, and there is no
25676 generic instruction set applicable to all processors.  In contrast,
25677 @option{-mtune} indicates the processor (or, in this case, collection of
25678 processors) for which the code is optimized.
25680 @item intel
25681 Produce code optimized for the most current Intel processors, which are
25682 Haswell and Silvermont for this version of GCC.  If you know the CPU
25683 on which your code will run, then you should use the corresponding
25684 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25685 But, if you want your application performs better on both Haswell and
25686 Silvermont, then you should use this option.
25688 As new Intel processors are deployed in the marketplace, the behavior of
25689 this option will change.  Therefore, if you upgrade to a newer version of
25690 GCC, code generation controlled by this option will change to reflect
25691 the most current Intel processors at the time that version of GCC is
25692 released.
25694 There is no @option{-march=intel} option because @option{-march} indicates
25695 the instruction set the compiler can use, and there is no common
25696 instruction set applicable to all processors.  In contrast,
25697 @option{-mtune} indicates the processor (or, in this case, collection of
25698 processors) for which the code is optimized.
25699 @end table
25701 @item -mcpu=@var{cpu-type}
25702 @opindex mcpu
25703 A deprecated synonym for @option{-mtune}.
25705 @item -mfpmath=@var{unit}
25706 @opindex mfpmath
25707 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25708 for @var{unit} are:
25710 @table @samp
25711 @item 387
25712 Use the standard 387 floating-point coprocessor present on the majority of chips and
25713 emulated otherwise.  Code compiled with this option runs almost everywhere.
25714 The temporary results are computed in 80-bit precision instead of the precision
25715 specified by the type, resulting in slightly different results compared to most
25716 of other chips.  See @option{-ffloat-store} for more detailed description.
25718 This is the default choice for non-Darwin x86-32 targets.
25720 @item sse
25721 Use scalar floating-point instructions present in the SSE instruction set.
25722 This instruction set is supported by Pentium III and newer chips,
25723 and in the AMD line
25724 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25725 instruction set supports only single-precision arithmetic, thus the double and
25726 extended-precision arithmetic are still done using 387.  A later version, present
25727 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25728 arithmetic too.
25730 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25731 or @option{-msse2} switches to enable SSE extensions and make this option
25732 effective.  For the x86-64 compiler, these extensions are enabled by default.
25734 The resulting code should be considerably faster in the majority of cases and avoid
25735 the numerical instability problems of 387 code, but may break some existing
25736 code that expects temporaries to be 80 bits.
25738 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25739 and the default choice for x86-32 targets with the SSE2 instruction set
25740 when @option{-ffast-math} is enabled.
25742 @item sse,387
25743 @itemx sse+387
25744 @itemx both
25745 Attempt to utilize both instruction sets at once.  This effectively doubles the
25746 amount of available registers, and on chips with separate execution units for
25747 387 and SSE the execution resources too.  Use this option with care, as it is
25748 still experimental, because the GCC register allocator does not model separate
25749 functional units well, resulting in unstable performance.
25750 @end table
25752 @item -masm=@var{dialect}
25753 @opindex masm=@var{dialect}
25754 Output assembly instructions using selected @var{dialect}.  Also affects
25755 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25756 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25757 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25758 not support @samp{intel}.
25760 @item -mieee-fp
25761 @itemx -mno-ieee-fp
25762 @opindex mieee-fp
25763 @opindex mno-ieee-fp
25764 Control whether or not the compiler uses IEEE floating-point
25765 comparisons.  These correctly handle the case where the result of a
25766 comparison is unordered.
25768 @item -m80387
25769 @item -mhard-float
25770 @opindex 80387
25771 @opindex mhard-float
25772 Generate output containing 80387 instructions for floating point.
25774 @item -mno-80387
25775 @item -msoft-float
25776 @opindex no-80387
25777 @opindex msoft-float
25778 Generate output containing library calls for floating point.
25780 @strong{Warning:} the requisite libraries are not part of GCC@.
25781 Normally the facilities of the machine's usual C compiler are used, but
25782 this cannot be done directly in cross-compilation.  You must make your
25783 own arrangements to provide suitable library functions for
25784 cross-compilation.
25786 On machines where a function returns floating-point results in the 80387
25787 register stack, some floating-point opcodes may be emitted even if
25788 @option{-msoft-float} is used.
25790 @item -mno-fp-ret-in-387
25791 @opindex mno-fp-ret-in-387
25792 Do not use the FPU registers for return values of functions.
25794 The usual calling convention has functions return values of types
25795 @code{float} and @code{double} in an FPU register, even if there
25796 is no FPU@.  The idea is that the operating system should emulate
25797 an FPU@.
25799 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25800 in ordinary CPU registers instead.
25802 @item -mno-fancy-math-387
25803 @opindex mno-fancy-math-387
25804 Some 387 emulators do not support the @code{sin}, @code{cos} and
25805 @code{sqrt} instructions for the 387.  Specify this option to avoid
25806 generating those instructions.  This option is the default on
25807 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25808 indicates that the target CPU always has an FPU and so the
25809 instruction does not need emulation.  These
25810 instructions are not generated unless you also use the
25811 @option{-funsafe-math-optimizations} switch.
25813 @item -malign-double
25814 @itemx -mno-align-double
25815 @opindex malign-double
25816 @opindex mno-align-double
25817 Control whether GCC aligns @code{double}, @code{long double}, and
25818 @code{long long} variables on a two-word boundary or a one-word
25819 boundary.  Aligning @code{double} variables on a two-word boundary
25820 produces code that runs somewhat faster on a Pentium at the
25821 expense of more memory.
25823 On x86-64, @option{-malign-double} is enabled by default.
25825 @strong{Warning:} if you use the @option{-malign-double} switch,
25826 structures containing the above types are aligned differently than
25827 the published application binary interface specifications for the x86-32
25828 and are not binary compatible with structures in code compiled
25829 without that switch.
25831 @item -m96bit-long-double
25832 @itemx -m128bit-long-double
25833 @opindex m96bit-long-double
25834 @opindex m128bit-long-double
25835 These switches control the size of @code{long double} type.  The x86-32
25836 application binary interface specifies the size to be 96 bits,
25837 so @option{-m96bit-long-double} is the default in 32-bit mode.
25839 Modern architectures (Pentium and newer) prefer @code{long double}
25840 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25841 conforming to the ABI, this is not possible.  So specifying
25842 @option{-m128bit-long-double} aligns @code{long double}
25843 to a 16-byte boundary by padding the @code{long double} with an additional
25844 32-bit zero.
25846 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25847 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25849 Notice that neither of these options enable any extra precision over the x87
25850 standard of 80 bits for a @code{long double}.
25852 @strong{Warning:} if you override the default value for your target ABI, this
25853 changes the size of 
25854 structures and arrays containing @code{long double} variables,
25855 as well as modifying the function calling convention for functions taking
25856 @code{long double}.  Hence they are not binary-compatible
25857 with code compiled without that switch.
25859 @item -mlong-double-64
25860 @itemx -mlong-double-80
25861 @itemx -mlong-double-128
25862 @opindex mlong-double-64
25863 @opindex mlong-double-80
25864 @opindex mlong-double-128
25865 These switches control the size of @code{long double} type. A size
25866 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25867 type. This is the default for 32-bit Bionic C library.  A size
25868 of 128 bits makes the @code{long double} type equivalent to the
25869 @code{__float128} type. This is the default for 64-bit Bionic C library.
25871 @strong{Warning:} if you override the default value for your target ABI, this
25872 changes the size of
25873 structures and arrays containing @code{long double} variables,
25874 as well as modifying the function calling convention for functions taking
25875 @code{long double}.  Hence they are not binary-compatible
25876 with code compiled without that switch.
25878 @item -malign-data=@var{type}
25879 @opindex malign-data
25880 Control how GCC aligns variables.  Supported values for @var{type} are
25881 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25882 and earlier, @samp{abi} uses alignment value as specified by the
25883 psABI, and @samp{cacheline} uses increased alignment value to match
25884 the cache line size.  @samp{compat} is the default.
25886 @item -mlarge-data-threshold=@var{threshold}
25887 @opindex mlarge-data-threshold
25888 When @option{-mcmodel=medium} is specified, data objects larger than
25889 @var{threshold} are placed in the large data section.  This value must be the
25890 same across all objects linked into the binary, and defaults to 65535.
25892 @item -mrtd
25893 @opindex mrtd
25894 Use a different function-calling convention, in which functions that
25895 take a fixed number of arguments return with the @code{ret @var{num}}
25896 instruction, which pops their arguments while returning.  This saves one
25897 instruction in the caller since there is no need to pop the arguments
25898 there.
25900 You can specify that an individual function is called with this calling
25901 sequence with the function attribute @code{stdcall}.  You can also
25902 override the @option{-mrtd} option by using the function attribute
25903 @code{cdecl}.  @xref{Function Attributes}.
25905 @strong{Warning:} this calling convention is incompatible with the one
25906 normally used on Unix, so you cannot use it if you need to call
25907 libraries compiled with the Unix compiler.
25909 Also, you must provide function prototypes for all functions that
25910 take variable numbers of arguments (including @code{printf});
25911 otherwise incorrect code is generated for calls to those
25912 functions.
25914 In addition, seriously incorrect code results if you call a
25915 function with too many arguments.  (Normally, extra arguments are
25916 harmlessly ignored.)
25918 @item -mregparm=@var{num}
25919 @opindex mregparm
25920 Control how many registers are used to pass integer arguments.  By
25921 default, no registers are used to pass arguments, and at most 3
25922 registers can be used.  You can control this behavior for a specific
25923 function by using the function attribute @code{regparm}.
25924 @xref{Function Attributes}.
25926 @strong{Warning:} if you use this switch, and
25927 @var{num} is nonzero, then you must build all modules with the same
25928 value, including any libraries.  This includes the system libraries and
25929 startup modules.
25931 @item -msseregparm
25932 @opindex msseregparm
25933 Use SSE register passing conventions for float and double arguments
25934 and return values.  You can control this behavior for a specific
25935 function by using the function attribute @code{sseregparm}.
25936 @xref{Function Attributes}.
25938 @strong{Warning:} if you use this switch then you must build all
25939 modules with the same value, including any libraries.  This includes
25940 the system libraries and startup modules.
25942 @item -mvect8-ret-in-mem
25943 @opindex mvect8-ret-in-mem
25944 Return 8-byte vectors in memory instead of MMX registers.  This is the
25945 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
25946 Studio compilers until version 12.  Later compiler versions (starting
25947 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
25948 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
25949 you need to remain compatible with existing code produced by those
25950 previous compiler versions or older versions of GCC@.
25952 @item -mpc32
25953 @itemx -mpc64
25954 @itemx -mpc80
25955 @opindex mpc32
25956 @opindex mpc64
25957 @opindex mpc80
25959 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
25960 is specified, the significands of results of floating-point operations are
25961 rounded to 24 bits (single precision); @option{-mpc64} rounds the
25962 significands of results of floating-point operations to 53 bits (double
25963 precision) and @option{-mpc80} rounds the significands of results of
25964 floating-point operations to 64 bits (extended double precision), which is
25965 the default.  When this option is used, floating-point operations in higher
25966 precisions are not available to the programmer without setting the FPU
25967 control word explicitly.
25969 Setting the rounding of floating-point operations to less than the default
25970 80 bits can speed some programs by 2% or more.  Note that some mathematical
25971 libraries assume that extended-precision (80-bit) floating-point operations
25972 are enabled by default; routines in such libraries could suffer significant
25973 loss of accuracy, typically through so-called ``catastrophic cancellation'',
25974 when this option is used to set the precision to less than extended precision.
25976 @item -mstackrealign
25977 @opindex mstackrealign
25978 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
25979 option generates an alternate prologue and epilogue that realigns the
25980 run-time stack if necessary.  This supports mixing legacy codes that keep
25981 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
25982 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
25983 applicable to individual functions.
25985 @item -mpreferred-stack-boundary=@var{num}
25986 @opindex mpreferred-stack-boundary
25987 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25988 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25989 the default is 4 (16 bytes or 128 bits).
25991 @strong{Warning:} When generating code for the x86-64 architecture with
25992 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25993 used to keep the stack boundary aligned to 8 byte boundary.  Since
25994 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25995 intended to be used in controlled environment where stack space is
25996 important limitation.  This option leads to wrong code when functions
25997 compiled with 16 byte stack alignment (such as functions from a standard
25998 library) are called with misaligned stack.  In this case, SSE
25999 instructions may lead to misaligned memory access traps.  In addition,
26000 variable arguments are handled incorrectly for 16 byte aligned
26001 objects (including x87 long double and __int128), leading to wrong
26002 results.  You must build all modules with
26003 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
26004 includes the system libraries and startup modules.
26006 @item -mincoming-stack-boundary=@var{num}
26007 @opindex mincoming-stack-boundary
26008 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
26009 boundary.  If @option{-mincoming-stack-boundary} is not specified,
26010 the one specified by @option{-mpreferred-stack-boundary} is used.
26012 On Pentium and Pentium Pro, @code{double} and @code{long double} values
26013 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
26014 suffer significant run time performance penalties.  On Pentium III, the
26015 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
26016 properly if it is not 16-byte aligned.
26018 To ensure proper alignment of this values on the stack, the stack boundary
26019 must be as aligned as that required by any value stored on the stack.
26020 Further, every function must be generated such that it keeps the stack
26021 aligned.  Thus calling a function compiled with a higher preferred
26022 stack boundary from a function compiled with a lower preferred stack
26023 boundary most likely misaligns the stack.  It is recommended that
26024 libraries that use callbacks always use the default setting.
26026 This extra alignment does consume extra stack space, and generally
26027 increases code size.  Code that is sensitive to stack space usage, such
26028 as embedded systems and operating system kernels, may want to reduce the
26029 preferred alignment to @option{-mpreferred-stack-boundary=2}.
26031 @need 200
26032 @item -mmmx
26033 @opindex mmmx
26034 @need 200
26035 @itemx -msse
26036 @opindex msse
26037 @need 200
26038 @itemx -msse2
26039 @opindex msse2
26040 @need 200
26041 @itemx -msse3
26042 @opindex msse3
26043 @need 200
26044 @itemx -mssse3
26045 @opindex mssse3
26046 @need 200
26047 @itemx -msse4
26048 @opindex msse4
26049 @need 200
26050 @itemx -msse4a
26051 @opindex msse4a
26052 @need 200
26053 @itemx -msse4.1
26054 @opindex msse4.1
26055 @need 200
26056 @itemx -msse4.2
26057 @opindex msse4.2
26058 @need 200
26059 @itemx -mavx
26060 @opindex mavx
26061 @need 200
26062 @itemx -mavx2
26063 @opindex mavx2
26064 @need 200
26065 @itemx -mavx512f
26066 @opindex mavx512f
26067 @need 200
26068 @itemx -mavx512pf
26069 @opindex mavx512pf
26070 @need 200
26071 @itemx -mavx512er
26072 @opindex mavx512er
26073 @need 200
26074 @itemx -mavx512cd
26075 @opindex mavx512cd
26076 @need 200
26077 @itemx -mavx512vl
26078 @opindex mavx512vl
26079 @need 200
26080 @itemx -mavx512bw
26081 @opindex mavx512bw
26082 @need 200
26083 @itemx -mavx512dq
26084 @opindex mavx512dq
26085 @need 200
26086 @itemx -mavx512ifma
26087 @opindex mavx512ifma
26088 @need 200
26089 @itemx -mavx512vbmi
26090 @opindex mavx512vbmi
26091 @need 200
26092 @itemx -msha
26093 @opindex msha
26094 @need 200
26095 @itemx -maes
26096 @opindex maes
26097 @need 200
26098 @itemx -mpclmul
26099 @opindex mpclmul
26100 @need 200
26101 @itemx -mclfushopt
26102 @opindex mclfushopt
26103 @need 200
26104 @itemx -mfsgsbase
26105 @opindex mfsgsbase
26106 @need 200
26107 @itemx -mrdrnd
26108 @opindex mrdrnd
26109 @need 200
26110 @itemx -mf16c
26111 @opindex mf16c
26112 @need 200
26113 @itemx -mfma
26114 @opindex mfma
26115 @need 200
26116 @itemx -mfma4
26117 @opindex mfma4
26118 @need 200
26119 @itemx -mprefetchwt1
26120 @opindex mprefetchwt1
26121 @need 200
26122 @itemx -mxop
26123 @opindex mxop
26124 @need 200
26125 @itemx -mlwp
26126 @opindex mlwp
26127 @need 200
26128 @itemx -m3dnow
26129 @opindex m3dnow
26130 @need 200
26131 @itemx -m3dnowa
26132 @opindex m3dnowa
26133 @need 200
26134 @itemx -mpopcnt
26135 @opindex mpopcnt
26136 @need 200
26137 @itemx -mabm
26138 @opindex mabm
26139 @need 200
26140 @itemx -mbmi
26141 @opindex mbmi
26142 @need 200
26143 @itemx -mbmi2
26144 @need 200
26145 @itemx -mlzcnt
26146 @opindex mlzcnt
26147 @need 200
26148 @itemx -mfxsr
26149 @opindex mfxsr
26150 @need 200
26151 @itemx -mxsave
26152 @opindex mxsave
26153 @need 200
26154 @itemx -mxsaveopt
26155 @opindex mxsaveopt
26156 @need 200
26157 @itemx -mxsavec
26158 @opindex mxsavec
26159 @need 200
26160 @itemx -mxsaves
26161 @opindex mxsaves
26162 @need 200
26163 @itemx -mrtm
26164 @opindex mrtm
26165 @need 200
26166 @itemx -mtbm
26167 @opindex mtbm
26168 @need 200
26169 @itemx -mmpx
26170 @opindex mmpx
26171 @need 200
26172 @itemx -mmwaitx
26173 @opindex mmwaitx
26174 @need 200
26175 @itemx -mclzero
26176 @opindex mclzero
26177 @need 200
26178 @itemx -mpku
26179 @opindex mpku
26180 @need 200
26181 @itemx -mcet
26182 @opindex mcet
26183 @need 200
26184 @itemx -mavx512vbmi2
26185 @opindex mavx512vbmi2
26186 @need 200
26187 @itemx -mgfni
26188 @opindex mgfni
26189 @need 200
26190 @itemx -mvaes
26191 @opindex mvaes
26192 @need 200
26193 @itemx -mvpclmulqdq
26194 @opindex mvpclmulqdq
26195 @need 200
26196 @itemx -mavx512bitalg
26197 @opindex mavx512bitalg
26198 @need 200
26199 @itemx -mavx512vpopcntdq
26200 @opindex mavx512vpopcntdq
26201 These switches enable the use of instructions in the MMX, SSE,
26202 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26203 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
26204 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES,
26205 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
26206 GFNI, VPCLMULQDQ, AVX512BITALG, AVX512VPOPCNTDQ3DNow!@: or enhanced 3DNow!@:
26207 extended instruction sets.
26208 Each has a corresponding @option{-mno-} option to disable use of these
26209 instructions.
26211 These extensions are also available as built-in functions: see
26212 @ref{x86 Built-in Functions}, for details of the functions enabled and
26213 disabled by these switches.
26215 To generate SSE/SSE2 instructions automatically from floating-point
26216 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
26218 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
26219 generates new AVX instructions or AVX equivalence for all SSEx instructions
26220 when needed.
26222 These options enable GCC to use these extended instructions in
26223 generated code, even without @option{-mfpmath=sse}.  Applications that
26224 perform run-time CPU detection must compile separate files for each
26225 supported architecture, using the appropriate flags.  In particular,
26226 the file containing the CPU detection code should be compiled without
26227 these options.
26229 The @option{-mcet} option turns on the @option{-mibt} and @option{-mshstk}
26230 options.  The @option{-mibt} option enables indirect branch tracking support
26231 and the @option{-mshstk} option enables shadow stack support from
26232 Intel Control-flow Enforcement Technology (CET).  The compiler also provides
26233 a number of built-in functions for fine-grained control in a CET-based
26234 application.  See @xref{x86 Built-in Functions}, for more information.
26236 @item -mdump-tune-features
26237 @opindex mdump-tune-features
26238 This option instructs GCC to dump the names of the x86 performance 
26239 tuning features and default settings. The names can be used in 
26240 @option{-mtune-ctrl=@var{feature-list}}.
26242 @item -mtune-ctrl=@var{feature-list}
26243 @opindex mtune-ctrl=@var{feature-list}
26244 This option is used to do fine grain control of x86 code generation features.
26245 @var{feature-list} is a comma separated list of @var{feature} names. See also
26246 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
26247 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
26248 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
26249 developers. Using it may lead to code paths not covered by testing and can
26250 potentially result in compiler ICEs or runtime errors.
26252 @item -mno-default
26253 @opindex mno-default
26254 This option instructs GCC to turn off all tunable features. See also 
26255 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
26257 @item -mcld
26258 @opindex mcld
26259 This option instructs GCC to emit a @code{cld} instruction in the prologue
26260 of functions that use string instructions.  String instructions depend on
26261 the DF flag to select between autoincrement or autodecrement mode.  While the
26262 ABI specifies the DF flag to be cleared on function entry, some operating
26263 systems violate this specification by not clearing the DF flag in their
26264 exception dispatchers.  The exception handler can be invoked with the DF flag
26265 set, which leads to wrong direction mode when string instructions are used.
26266 This option can be enabled by default on 32-bit x86 targets by configuring
26267 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
26268 instructions can be suppressed with the @option{-mno-cld} compiler option
26269 in this case.
26271 @item -mvzeroupper
26272 @opindex mvzeroupper
26273 This option instructs GCC to emit a @code{vzeroupper} instruction
26274 before a transfer of control flow out of the function to minimize
26275 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
26276 intrinsics.
26278 @item -mprefer-avx128
26279 @opindex mprefer-avx128
26280 This option instructs GCC to use 128-bit AVX instructions instead of
26281 256-bit AVX instructions in the auto-vectorizer.
26283 @item -mprefer-vector-width=@var{opt}
26284 @opindex mprefer-vector-width
26285 This option instructs GCC to use @var{opt}-bit vector width in instructions
26286 instead of default on the selected platform.
26288 @table @samp
26289 @item none
26290 No extra limitations applied to GCC other than defined by the selected platform.
26292 @item 128
26293 Prefer 128-bit vector width for instructions.
26295 @item 256
26296 Prefer 256-bit vector width for instructions.
26298 @item 512
26299 Prefer 512-bit vector width for instructions.
26300 @end table
26302 @item -mcx16
26303 @opindex mcx16
26304 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
26305 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
26306 objects.  This is useful for atomic updates of data structures exceeding one
26307 machine word in size.  The compiler uses this instruction to implement
26308 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
26309 128-bit integers, a library call is always used.
26311 @item -msahf
26312 @opindex msahf
26313 This option enables generation of @code{SAHF} instructions in 64-bit code.
26314 Early Intel Pentium 4 CPUs with Intel 64 support,
26315 prior to the introduction of Pentium 4 G1 step in December 2005,
26316 lacked the @code{LAHF} and @code{SAHF} instructions
26317 which are supported by AMD64.
26318 These are load and store instructions, respectively, for certain status flags.
26319 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
26320 @code{drem}, and @code{remainder} built-in functions;
26321 see @ref{Other Builtins} for details.
26323 @item -mmovbe
26324 @opindex mmovbe
26325 This option enables use of the @code{movbe} instruction to implement
26326 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
26328 @item -mibt
26329 @opindex mibt
26330 This option tells the compiler to use indirect branch tracking support
26331 (for indirect calls and jumps) from x86 Control-flow Enforcement
26332 Technology (CET).  The option has effect only if the
26333 @option{-fcf-protection=full} or @option{-fcf-protection=branch} option
26334 is specified. The option @option{-mibt} is on by default when the
26335 @code{-mcet} option is specified.
26337 @item -mshstk
26338 @opindex mshstk
26339 This option tells the compiler to use shadow stack support (return
26340 address tracking) from x86 Control-flow Enforcement Technology (CET).
26341 The option has effect only if the @option{-fcf-protection=full} or
26342 @option{-fcf-protection=return} option is specified.  The option
26343 @option{-mshstk} is on by default when the @option{-mcet} option is
26344 specified.
26346 @item -mcrc32
26347 @opindex mcrc32
26348 This option enables built-in functions @code{__builtin_ia32_crc32qi},
26349 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
26350 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
26352 @item -mrecip
26353 @opindex mrecip
26354 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
26355 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
26356 with an additional Newton-Raphson step
26357 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
26358 (and their vectorized
26359 variants) for single-precision floating-point arguments.  These instructions
26360 are generated only when @option{-funsafe-math-optimizations} is enabled
26361 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
26362 Note that while the throughput of the sequence is higher than the throughput
26363 of the non-reciprocal instruction, the precision of the sequence can be
26364 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
26366 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
26367 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
26368 combination), and doesn't need @option{-mrecip}.
26370 Also note that GCC emits the above sequence with additional Newton-Raphson step
26371 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
26372 already with @option{-ffast-math} (or the above option combination), and
26373 doesn't need @option{-mrecip}.
26375 @item -mrecip=@var{opt}
26376 @opindex mrecip=opt
26377 This option controls which reciprocal estimate instructions
26378 may be used.  @var{opt} is a comma-separated list of options, which may
26379 be preceded by a @samp{!} to invert the option:
26381 @table @samp
26382 @item all
26383 Enable all estimate instructions.
26385 @item default
26386 Enable the default instructions, equivalent to @option{-mrecip}.
26388 @item none
26389 Disable all estimate instructions, equivalent to @option{-mno-recip}.
26391 @item div
26392 Enable the approximation for scalar division.
26394 @item vec-div
26395 Enable the approximation for vectorized division.
26397 @item sqrt
26398 Enable the approximation for scalar square root.
26400 @item vec-sqrt
26401 Enable the approximation for vectorized square root.
26402 @end table
26404 So, for example, @option{-mrecip=all,!sqrt} enables
26405 all of the reciprocal approximations, except for square root.
26407 @item -mveclibabi=@var{type}
26408 @opindex mveclibabi
26409 Specifies the ABI type to use for vectorizing intrinsics using an
26410 external library.  Supported values for @var{type} are @samp{svml} 
26411 for the Intel short
26412 vector math library and @samp{acml} for the AMD math core library.
26413 To use this option, both @option{-ftree-vectorize} and
26414 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
26415 ABI-compatible library must be specified at link time.
26417 GCC currently emits calls to @code{vmldExp2},
26418 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
26419 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
26420 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
26421 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
26422 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
26423 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
26424 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
26425 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
26426 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
26427 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
26428 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
26429 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
26430 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
26431 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
26432 when @option{-mveclibabi=acml} is used.  
26434 @item -mabi=@var{name}
26435 @opindex mabi
26436 Generate code for the specified calling convention.  Permissible values
26437 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
26438 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
26439 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
26440 You can control this behavior for specific functions by
26441 using the function attributes @code{ms_abi} and @code{sysv_abi}.
26442 @xref{Function Attributes}.
26444 @item -mforce-indirect-call
26445 @opindex mforce-indirect-call
26446 Force all calls to functions to be indirect. This is useful
26447 when using Intel Processor Trace where it generates more precise timing
26448 information for function calls.
26450 @item -mcall-ms2sysv-xlogues
26451 @opindex mcall-ms2sysv-xlogues
26452 @opindex mno-call-ms2sysv-xlogues
26453 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
26454 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
26455 default, the code for saving and restoring these registers is emitted inline,
26456 resulting in fairly lengthy prologues and epilogues.  Using
26457 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
26458 use stubs in the static portion of libgcc to perform these saves and restores,
26459 thus reducing function size at the cost of a few extra instructions.
26461 @item -mtls-dialect=@var{type}
26462 @opindex mtls-dialect
26463 Generate code to access thread-local storage using the @samp{gnu} or
26464 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
26465 @samp{gnu2} is more efficient, but it may add compile- and run-time
26466 requirements that cannot be satisfied on all systems.
26468 @item -mpush-args
26469 @itemx -mno-push-args
26470 @opindex mpush-args
26471 @opindex mno-push-args
26472 Use PUSH operations to store outgoing parameters.  This method is shorter
26473 and usually equally fast as method using SUB/MOV operations and is enabled
26474 by default.  In some cases disabling it may improve performance because of
26475 improved scheduling and reduced dependencies.
26477 @item -maccumulate-outgoing-args
26478 @opindex maccumulate-outgoing-args
26479 If enabled, the maximum amount of space required for outgoing arguments is
26480 computed in the function prologue.  This is faster on most modern CPUs
26481 because of reduced dependencies, improved scheduling and reduced stack usage
26482 when the preferred stack boundary is not equal to 2.  The drawback is a notable
26483 increase in code size.  This switch implies @option{-mno-push-args}.
26485 @item -mthreads
26486 @opindex mthreads
26487 Support thread-safe exception handling on MinGW.  Programs that rely
26488 on thread-safe exception handling must compile and link all code with the
26489 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
26490 @option{-D_MT}; when linking, it links in a special thread helper library
26491 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
26493 @item -mms-bitfields
26494 @itemx -mno-ms-bitfields
26495 @opindex mms-bitfields
26496 @opindex mno-ms-bitfields
26498 Enable/disable bit-field layout compatible with the native Microsoft
26499 Windows compiler.  
26501 If @code{packed} is used on a structure, or if bit-fields are used,
26502 it may be that the Microsoft ABI lays out the structure differently
26503 than the way GCC normally does.  Particularly when moving packed
26504 data between functions compiled with GCC and the native Microsoft compiler
26505 (either via function call or as data in a file), it may be necessary to access
26506 either format.
26508 This option is enabled by default for Microsoft Windows
26509 targets.  This behavior can also be controlled locally by use of variable
26510 or type attributes.  For more information, see @ref{x86 Variable Attributes}
26511 and @ref{x86 Type Attributes}.
26513 The Microsoft structure layout algorithm is fairly simple with the exception
26514 of the bit-field packing.  
26515 The padding and alignment of members of structures and whether a bit-field 
26516 can straddle a storage-unit boundary are determine by these rules:
26518 @enumerate
26519 @item Structure members are stored sequentially in the order in which they are
26520 declared: the first member has the lowest memory address and the last member
26521 the highest.
26523 @item Every data object has an alignment requirement.  The alignment requirement
26524 for all data except structures, unions, and arrays is either the size of the
26525 object or the current packing size (specified with either the
26526 @code{aligned} attribute or the @code{pack} pragma),
26527 whichever is less.  For structures, unions, and arrays,
26528 the alignment requirement is the largest alignment requirement of its members.
26529 Every object is allocated an offset so that:
26531 @smallexample
26532 offset % alignment_requirement == 0
26533 @end smallexample
26535 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
26536 unit if the integral types are the same size and if the next bit-field fits
26537 into the current allocation unit without crossing the boundary imposed by the
26538 common alignment requirements of the bit-fields.
26539 @end enumerate
26541 MSVC interprets zero-length bit-fields in the following ways:
26543 @enumerate
26544 @item If a zero-length bit-field is inserted between two bit-fields that
26545 are normally coalesced, the bit-fields are not coalesced.
26547 For example:
26549 @smallexample
26550 struct
26551  @{
26552    unsigned long bf_1 : 12;
26553    unsigned long : 0;
26554    unsigned long bf_2 : 12;
26555  @} t1;
26556 @end smallexample
26558 @noindent
26559 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
26560 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
26562 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
26563 alignment of the zero-length bit-field is greater than the member that follows it,
26564 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
26566 For example:
26568 @smallexample
26569 struct
26570  @{
26571    char foo : 4;
26572    short : 0;
26573    char bar;
26574  @} t2;
26576 struct
26577  @{
26578    char foo : 4;
26579    short : 0;
26580    double bar;
26581  @} t3;
26582 @end smallexample
26584 @noindent
26585 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
26586 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
26587 bit-field does not affect the alignment of @code{bar} or, as a result, the size
26588 of the structure.
26590 Taking this into account, it is important to note the following:
26592 @enumerate
26593 @item If a zero-length bit-field follows a normal bit-field, the type of the
26594 zero-length bit-field may affect the alignment of the structure as whole. For
26595 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
26596 normal bit-field, and is of type short.
26598 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
26599 still affect the alignment of the structure:
26601 @smallexample
26602 struct
26603  @{
26604    char foo : 6;
26605    long : 0;
26606  @} t4;
26607 @end smallexample
26609 @noindent
26610 Here, @code{t4} takes up 4 bytes.
26611 @end enumerate
26613 @item Zero-length bit-fields following non-bit-field members are ignored:
26615 @smallexample
26616 struct
26617  @{
26618    char foo;
26619    long : 0;
26620    char bar;
26621  @} t5;
26622 @end smallexample
26624 @noindent
26625 Here, @code{t5} takes up 2 bytes.
26626 @end enumerate
26629 @item -mno-align-stringops
26630 @opindex mno-align-stringops
26631 Do not align the destination of inlined string operations.  This switch reduces
26632 code size and improves performance in case the destination is already aligned,
26633 but GCC doesn't know about it.
26635 @item -minline-all-stringops
26636 @opindex minline-all-stringops
26637 By default GCC inlines string operations only when the destination is 
26638 known to be aligned to least a 4-byte boundary.  
26639 This enables more inlining and increases code
26640 size, but may improve performance of code that depends on fast
26641 @code{memcpy}, @code{strlen},
26642 and @code{memset} for short lengths.
26644 @item -minline-stringops-dynamically
26645 @opindex minline-stringops-dynamically
26646 For string operations of unknown size, use run-time checks with
26647 inline code for small blocks and a library call for large blocks.
26649 @item -mstringop-strategy=@var{alg}
26650 @opindex mstringop-strategy=@var{alg}
26651 Override the internal decision heuristic for the particular algorithm to use
26652 for inlining string operations.  The allowed values for @var{alg} are:
26654 @table @samp
26655 @item rep_byte
26656 @itemx rep_4byte
26657 @itemx rep_8byte
26658 Expand using i386 @code{rep} prefix of the specified size.
26660 @item byte_loop
26661 @itemx loop
26662 @itemx unrolled_loop
26663 Expand into an inline loop.
26665 @item libcall
26666 Always use a library call.
26667 @end table
26669 @item -mmemcpy-strategy=@var{strategy}
26670 @opindex mmemcpy-strategy=@var{strategy}
26671 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26672 should be inlined and what inline algorithm to use when the expected size
26673 of the copy operation is known. @var{strategy} 
26674 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26675 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26676 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26677 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26678 in the list must be specified in increasing order.  The minimal byte size for 
26679 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26680 preceding range.
26682 @item -mmemset-strategy=@var{strategy}
26683 @opindex mmemset-strategy=@var{strategy}
26684 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26685 @code{__builtin_memset} expansion.
26687 @item -momit-leaf-frame-pointer
26688 @opindex momit-leaf-frame-pointer
26689 Don't keep the frame pointer in a register for leaf functions.  This
26690 avoids the instructions to save, set up, and restore frame pointers and
26691 makes an extra register available in leaf functions.  The option
26692 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26693 which might make debugging harder.
26695 @item -mtls-direct-seg-refs
26696 @itemx -mno-tls-direct-seg-refs
26697 @opindex mtls-direct-seg-refs
26698 Controls whether TLS variables may be accessed with offsets from the
26699 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26700 or whether the thread base pointer must be added.  Whether or not this
26701 is valid depends on the operating system, and whether it maps the
26702 segment to cover the entire TLS area.
26704 For systems that use the GNU C Library, the default is on.
26706 @item -msse2avx
26707 @itemx -mno-sse2avx
26708 @opindex msse2avx
26709 Specify that the assembler should encode SSE instructions with VEX
26710 prefix.  The option @option{-mavx} turns this on by default.
26712 @item -mfentry
26713 @itemx -mno-fentry
26714 @opindex mfentry
26715 If profiling is active (@option{-pg}), put the profiling
26716 counter call before the prologue.
26717 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26718 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26720 @item -mrecord-mcount
26721 @itemx -mno-record-mcount
26722 @opindex mrecord-mcount
26723 If profiling is active (@option{-pg}), generate a __mcount_loc section
26724 that contains pointers to each profiling call. This is useful for
26725 automatically patching and out calls.
26727 @item -mnop-mcount
26728 @itemx -mno-nop-mcount
26729 @opindex mnop-mcount
26730 If profiling is active (@option{-pg}), generate the calls to
26731 the profiling functions as NOPs. This is useful when they
26732 should be patched in later dynamically. This is likely only
26733 useful together with @option{-mrecord-mcount}.
26735 @item -mskip-rax-setup
26736 @itemx -mno-skip-rax-setup
26737 @opindex mskip-rax-setup
26738 When generating code for the x86-64 architecture with SSE extensions
26739 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26740 register when there are no variable arguments passed in vector registers.
26742 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26743 saving vector registers on stack when passing variable arguments, the
26744 impacts of this option are callees may waste some stack space,
26745 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26746 those issues, regardless the RAX register value.
26748 @item -m8bit-idiv
26749 @itemx -mno-8bit-idiv
26750 @opindex m8bit-idiv
26751 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26752 much faster than 32-bit/64-bit integer divide.  This option generates a
26753 run-time check.  If both dividend and divisor are within range of 0
26754 to 255, 8-bit unsigned integer divide is used instead of
26755 32-bit/64-bit integer divide.
26757 @item -mavx256-split-unaligned-load
26758 @itemx -mavx256-split-unaligned-store
26759 @opindex mavx256-split-unaligned-load
26760 @opindex mavx256-split-unaligned-store
26761 Split 32-byte AVX unaligned load and store.
26763 @item -mstack-protector-guard=@var{guard}
26764 @itemx -mstack-protector-guard-reg=@var{reg}
26765 @itemx -mstack-protector-guard-offset=@var{offset}
26766 @opindex mstack-protector-guard
26767 @opindex mstack-protector-guard-reg
26768 @opindex mstack-protector-guard-offset
26769 Generate stack protection code using canary at @var{guard}.  Supported
26770 locations are @samp{global} for global canary or @samp{tls} for per-thread
26771 canary in the TLS block (the default).  This option has effect only when
26772 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26774 With the latter choice the options
26775 @option{-mstack-protector-guard-reg=@var{reg}} and
26776 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
26777 which segment register (@code{%fs} or @code{%gs}) to use as base register
26778 for reading the canary, and from what offset from that base register.
26779 The default for those is as specified in the relevant ABI.
26781 @item -mmitigate-rop
26782 @opindex mmitigate-rop
26783 Try to avoid generating code sequences that contain unintended return
26784 opcodes, to mitigate against certain forms of attack. At the moment,
26785 this option is limited in what it can do and should not be relied
26786 on to provide serious protection.
26788 @item -mgeneral-regs-only
26789 @opindex mgeneral-regs-only
26790 Generate code that uses only the general-purpose registers.  This
26791 prevents the compiler from using floating-point, vector, mask and bound
26792 registers.
26794 @end table
26796 These @samp{-m} switches are supported in addition to the above
26797 on x86-64 processors in 64-bit environments.
26799 @table @gcctabopt
26800 @item -m32
26801 @itemx -m64
26802 @itemx -mx32
26803 @itemx -m16
26804 @itemx -miamcu
26805 @opindex m32
26806 @opindex m64
26807 @opindex mx32
26808 @opindex m16
26809 @opindex miamcu
26810 Generate code for a 16-bit, 32-bit or 64-bit environment.
26811 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26812 to 32 bits, and
26813 generates code that runs on any i386 system.
26815 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26816 types to 64 bits, and generates code for the x86-64 architecture.
26817 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26818 and @option{-mdynamic-no-pic} options.
26820 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26821 to 32 bits, and
26822 generates code for the x86-64 architecture.
26824 The @option{-m16} option is the same as @option{-m32}, except for that
26825 it outputs the @code{.code16gcc} assembly directive at the beginning of
26826 the assembly output so that the binary can run in 16-bit mode.
26828 The @option{-miamcu} option generates code which conforms to Intel MCU
26829 psABI.  It requires the @option{-m32} option to be turned on.
26831 @item -mno-red-zone
26832 @opindex mno-red-zone
26833 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26834 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26835 stack pointer that is not modified by signal or interrupt handlers
26836 and therefore can be used for temporary data without adjusting the stack
26837 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26839 @item -mcmodel=small
26840 @opindex mcmodel=small
26841 Generate code for the small code model: the program and its symbols must
26842 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26843 Programs can be statically or dynamically linked.  This is the default
26844 code model.
26846 @item -mcmodel=kernel
26847 @opindex mcmodel=kernel
26848 Generate code for the kernel code model.  The kernel runs in the
26849 negative 2 GB of the address space.
26850 This model has to be used for Linux kernel code.
26852 @item -mcmodel=medium
26853 @opindex mcmodel=medium
26854 Generate code for the medium model: the program is linked in the lower 2
26855 GB of the address space.  Small symbols are also placed there.  Symbols
26856 with sizes larger than @option{-mlarge-data-threshold} are put into
26857 large data or BSS sections and can be located above 2GB.  Programs can
26858 be statically or dynamically linked.
26860 @item -mcmodel=large
26861 @opindex mcmodel=large
26862 Generate code for the large model.  This model makes no assumptions
26863 about addresses and sizes of sections.
26865 @item -maddress-mode=long
26866 @opindex maddress-mode=long
26867 Generate code for long address mode.  This is only supported for 64-bit
26868 and x32 environments.  It is the default address mode for 64-bit
26869 environments.
26871 @item -maddress-mode=short
26872 @opindex maddress-mode=short
26873 Generate code for short address mode.  This is only supported for 32-bit
26874 and x32 environments.  It is the default address mode for 32-bit and
26875 x32 environments.
26876 @end table
26878 @node x86 Windows Options
26879 @subsection x86 Windows Options
26880 @cindex x86 Windows Options
26881 @cindex Windows Options for x86
26883 These additional options are available for Microsoft Windows targets:
26885 @table @gcctabopt
26886 @item -mconsole
26887 @opindex mconsole
26888 This option
26889 specifies that a console application is to be generated, by
26890 instructing the linker to set the PE header subsystem type
26891 required for console applications.
26892 This option is available for Cygwin and MinGW targets and is
26893 enabled by default on those targets.
26895 @item -mdll
26896 @opindex mdll
26897 This option is available for Cygwin and MinGW targets.  It
26898 specifies that a DLL---a dynamic link library---is to be
26899 generated, enabling the selection of the required runtime
26900 startup object and entry point.
26902 @item -mnop-fun-dllimport
26903 @opindex mnop-fun-dllimport
26904 This option is available for Cygwin and MinGW targets.  It
26905 specifies that the @code{dllimport} attribute should be ignored.
26907 @item -mthread
26908 @opindex mthread
26909 This option is available for MinGW targets. It specifies
26910 that MinGW-specific thread support is to be used.
26912 @item -municode
26913 @opindex municode
26914 This option is available for MinGW-w64 targets.  It causes
26915 the @code{UNICODE} preprocessor macro to be predefined, and
26916 chooses Unicode-capable runtime startup code.
26918 @item -mwin32
26919 @opindex mwin32
26920 This option is available for Cygwin and MinGW targets.  It
26921 specifies that the typical Microsoft Windows predefined macros are to
26922 be set in the pre-processor, but does not influence the choice
26923 of runtime library/startup code.
26925 @item -mwindows
26926 @opindex mwindows
26927 This option is available for Cygwin and MinGW targets.  It
26928 specifies that a GUI application is to be generated by
26929 instructing the linker to set the PE header subsystem type
26930 appropriately.
26932 @item -fno-set-stack-executable
26933 @opindex fno-set-stack-executable
26934 This option is available for MinGW targets. It specifies that
26935 the executable flag for the stack used by nested functions isn't
26936 set. This is necessary for binaries running in kernel mode of
26937 Microsoft Windows, as there the User32 API, which is used to set executable
26938 privileges, isn't available.
26940 @item -fwritable-relocated-rdata
26941 @opindex fno-writable-relocated-rdata
26942 This option is available for MinGW and Cygwin targets.  It specifies
26943 that relocated-data in read-only section is put into the @code{.data}
26944 section.  This is a necessary for older runtimes not supporting
26945 modification of @code{.rdata} sections for pseudo-relocation.
26947 @item -mpe-aligned-commons
26948 @opindex mpe-aligned-commons
26949 This option is available for Cygwin and MinGW targets.  It
26950 specifies that the GNU extension to the PE file format that
26951 permits the correct alignment of COMMON variables should be
26952 used when generating code.  It is enabled by default if
26953 GCC detects that the target assembler found during configuration
26954 supports the feature.
26955 @end table
26957 See also under @ref{x86 Options} for standard options.
26959 @node Xstormy16 Options
26960 @subsection Xstormy16 Options
26961 @cindex Xstormy16 Options
26963 These options are defined for Xstormy16:
26965 @table @gcctabopt
26966 @item -msim
26967 @opindex msim
26968 Choose startup files and linker script suitable for the simulator.
26969 @end table
26971 @node Xtensa Options
26972 @subsection Xtensa Options
26973 @cindex Xtensa Options
26975 These options are supported for Xtensa targets:
26977 @table @gcctabopt
26978 @item -mconst16
26979 @itemx -mno-const16
26980 @opindex mconst16
26981 @opindex mno-const16
26982 Enable or disable use of @code{CONST16} instructions for loading
26983 constant values.  The @code{CONST16} instruction is currently not a
26984 standard option from Tensilica.  When enabled, @code{CONST16}
26985 instructions are always used in place of the standard @code{L32R}
26986 instructions.  The use of @code{CONST16} is enabled by default only if
26987 the @code{L32R} instruction is not available.
26989 @item -mfused-madd
26990 @itemx -mno-fused-madd
26991 @opindex mfused-madd
26992 @opindex mno-fused-madd
26993 Enable or disable use of fused multiply/add and multiply/subtract
26994 instructions in the floating-point option.  This has no effect if the
26995 floating-point option is not also enabled.  Disabling fused multiply/add
26996 and multiply/subtract instructions forces the compiler to use separate
26997 instructions for the multiply and add/subtract operations.  This may be
26998 desirable in some cases where strict IEEE 754-compliant results are
26999 required: the fused multiply add/subtract instructions do not round the
27000 intermediate result, thereby producing results with @emph{more} bits of
27001 precision than specified by the IEEE standard.  Disabling fused multiply
27002 add/subtract instructions also ensures that the program output is not
27003 sensitive to the compiler's ability to combine multiply and add/subtract
27004 operations.
27006 @item -mserialize-volatile
27007 @itemx -mno-serialize-volatile
27008 @opindex mserialize-volatile
27009 @opindex mno-serialize-volatile
27010 When this option is enabled, GCC inserts @code{MEMW} instructions before
27011 @code{volatile} memory references to guarantee sequential consistency.
27012 The default is @option{-mserialize-volatile}.  Use
27013 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
27015 @item -mforce-no-pic
27016 @opindex mforce-no-pic
27017 For targets, like GNU/Linux, where all user-mode Xtensa code must be
27018 position-independent code (PIC), this option disables PIC for compiling
27019 kernel code.
27021 @item -mtext-section-literals
27022 @itemx -mno-text-section-literals
27023 @opindex mtext-section-literals
27024 @opindex mno-text-section-literals
27025 These options control the treatment of literal pools.  The default is
27026 @option{-mno-text-section-literals}, which places literals in a separate
27027 section in the output file.  This allows the literal pool to be placed
27028 in a data RAM/ROM, and it also allows the linker to combine literal
27029 pools from separate object files to remove redundant literals and
27030 improve code size.  With @option{-mtext-section-literals}, the literals
27031 are interspersed in the text section in order to keep them as close as
27032 possible to their references.  This may be necessary for large assembly
27033 files.  Literals for each function are placed right before that function.
27035 @item -mauto-litpools
27036 @itemx -mno-auto-litpools
27037 @opindex mauto-litpools
27038 @opindex mno-auto-litpools
27039 These options control the treatment of literal pools.  The default is
27040 @option{-mno-auto-litpools}, which places literals in a separate
27041 section in the output file unless @option{-mtext-section-literals} is
27042 used.  With @option{-mauto-litpools} the literals are interspersed in
27043 the text section by the assembler.  Compiler does not produce explicit
27044 @code{.literal} directives and loads literals into registers with
27045 @code{MOVI} instructions instead of @code{L32R} to let the assembler
27046 do relaxation and place literals as necessary.  This option allows
27047 assembler to create several literal pools per function and assemble
27048 very big functions, which may not be possible with
27049 @option{-mtext-section-literals}.
27051 @item -mtarget-align
27052 @itemx -mno-target-align
27053 @opindex mtarget-align
27054 @opindex mno-target-align
27055 When this option is enabled, GCC instructs the assembler to
27056 automatically align instructions to reduce branch penalties at the
27057 expense of some code density.  The assembler attempts to widen density
27058 instructions to align branch targets and the instructions following call
27059 instructions.  If there are not enough preceding safe density
27060 instructions to align a target, no widening is performed.  The
27061 default is @option{-mtarget-align}.  These options do not affect the
27062 treatment of auto-aligned instructions like @code{LOOP}, which the
27063 assembler always aligns, either by widening density instructions or
27064 by inserting NOP instructions.
27066 @item -mlongcalls
27067 @itemx -mno-longcalls
27068 @opindex mlongcalls
27069 @opindex mno-longcalls
27070 When this option is enabled, GCC instructs the assembler to translate
27071 direct calls to indirect calls unless it can determine that the target
27072 of a direct call is in the range allowed by the call instruction.  This
27073 translation typically occurs for calls to functions in other source
27074 files.  Specifically, the assembler translates a direct @code{CALL}
27075 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
27076 The default is @option{-mno-longcalls}.  This option should be used in
27077 programs where the call target can potentially be out of range.  This
27078 option is implemented in the assembler, not the compiler, so the
27079 assembly code generated by GCC still shows direct call
27080 instructions---look at the disassembled object code to see the actual
27081 instructions.  Note that the assembler uses an indirect call for
27082 every cross-file call, not just those that really are out of range.
27083 @end table
27085 @node zSeries Options
27086 @subsection zSeries Options
27087 @cindex zSeries options
27089 These are listed under @xref{S/390 and zSeries Options}.
27092 @c man end
27094 @node Spec Files
27095 @section Specifying Subprocesses and the Switches to Pass to Them
27096 @cindex Spec Files
27098 @command{gcc} is a driver program.  It performs its job by invoking a
27099 sequence of other programs to do the work of compiling, assembling and
27100 linking.  GCC interprets its command-line parameters and uses these to
27101 deduce which programs it should invoke, and which command-line options
27102 it ought to place on their command lines.  This behavior is controlled
27103 by @dfn{spec strings}.  In most cases there is one spec string for each
27104 program that GCC can invoke, but a few programs have multiple spec
27105 strings to control their behavior.  The spec strings built into GCC can
27106 be overridden by using the @option{-specs=} command-line switch to specify
27107 a spec file.
27109 @dfn{Spec files} are plain-text files that are used to construct spec
27110 strings.  They consist of a sequence of directives separated by blank
27111 lines.  The type of directive is determined by the first non-whitespace
27112 character on the line, which can be one of the following:
27114 @table @code
27115 @item %@var{command}
27116 Issues a @var{command} to the spec file processor.  The commands that can
27117 appear here are:
27119 @table @code
27120 @item %include <@var{file}>
27121 @cindex @code{%include}
27122 Search for @var{file} and insert its text at the current point in the
27123 specs file.
27125 @item %include_noerr <@var{file}>
27126 @cindex @code{%include_noerr}
27127 Just like @samp{%include}, but do not generate an error message if the include
27128 file cannot be found.
27130 @item %rename @var{old_name} @var{new_name}
27131 @cindex @code{%rename}
27132 Rename the spec string @var{old_name} to @var{new_name}.
27134 @end table
27136 @item *[@var{spec_name}]:
27137 This tells the compiler to create, override or delete the named spec
27138 string.  All lines after this directive up to the next directive or
27139 blank line are considered to be the text for the spec string.  If this
27140 results in an empty string then the spec is deleted.  (Or, if the
27141 spec did not exist, then nothing happens.)  Otherwise, if the spec
27142 does not currently exist a new spec is created.  If the spec does
27143 exist then its contents are overridden by the text of this
27144 directive, unless the first character of that text is the @samp{+}
27145 character, in which case the text is appended to the spec.
27147 @item [@var{suffix}]:
27148 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
27149 and up to the next directive or blank line are considered to make up the
27150 spec string for the indicated suffix.  When the compiler encounters an
27151 input file with the named suffix, it processes the spec string in
27152 order to work out how to compile that file.  For example:
27154 @smallexample
27155 .ZZ:
27156 z-compile -input %i
27157 @end smallexample
27159 This says that any input file whose name ends in @samp{.ZZ} should be
27160 passed to the program @samp{z-compile}, which should be invoked with the
27161 command-line switch @option{-input} and with the result of performing the
27162 @samp{%i} substitution.  (See below.)
27164 As an alternative to providing a spec string, the text following a
27165 suffix directive can be one of the following:
27167 @table @code
27168 @item @@@var{language}
27169 This says that the suffix is an alias for a known @var{language}.  This is
27170 similar to using the @option{-x} command-line switch to GCC to specify a
27171 language explicitly.  For example:
27173 @smallexample
27174 .ZZ:
27175 @@c++
27176 @end smallexample
27178 Says that .ZZ files are, in fact, C++ source files.
27180 @item #@var{name}
27181 This causes an error messages saying:
27183 @smallexample
27184 @var{name} compiler not installed on this system.
27185 @end smallexample
27186 @end table
27188 GCC already has an extensive list of suffixes built into it.
27189 This directive adds an entry to the end of the list of suffixes, but
27190 since the list is searched from the end backwards, it is effectively
27191 possible to override earlier entries using this technique.
27193 @end table
27195 GCC has the following spec strings built into it.  Spec files can
27196 override these strings or create their own.  Note that individual
27197 targets can also add their own spec strings to this list.
27199 @smallexample
27200 asm          Options to pass to the assembler
27201 asm_final    Options to pass to the assembler post-processor
27202 cpp          Options to pass to the C preprocessor
27203 cc1          Options to pass to the C compiler
27204 cc1plus      Options to pass to the C++ compiler
27205 endfile      Object files to include at the end of the link
27206 link         Options to pass to the linker
27207 lib          Libraries to include on the command line to the linker
27208 libgcc       Decides which GCC support library to pass to the linker
27209 linker       Sets the name of the linker
27210 predefines   Defines to be passed to the C preprocessor
27211 signed_char  Defines to pass to CPP to say whether @code{char} is signed
27212              by default
27213 startfile    Object files to include at the start of the link
27214 @end smallexample
27216 Here is a small example of a spec file:
27218 @smallexample
27219 %rename lib                 old_lib
27221 *lib:
27222 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
27223 @end smallexample
27225 This example renames the spec called @samp{lib} to @samp{old_lib} and
27226 then overrides the previous definition of @samp{lib} with a new one.
27227 The new definition adds in some extra command-line options before
27228 including the text of the old definition.
27230 @dfn{Spec strings} are a list of command-line options to be passed to their
27231 corresponding program.  In addition, the spec strings can contain
27232 @samp{%}-prefixed sequences to substitute variable text or to
27233 conditionally insert text into the command line.  Using these constructs
27234 it is possible to generate quite complex command lines.
27236 Here is a table of all defined @samp{%}-sequences for spec
27237 strings.  Note that spaces are not generated automatically around the
27238 results of expanding these sequences.  Therefore you can concatenate them
27239 together or combine them with constant text in a single argument.
27241 @table @code
27242 @item %%
27243 Substitute one @samp{%} into the program name or argument.
27245 @item %i
27246 Substitute the name of the input file being processed.
27248 @item %b
27249 Substitute the basename of the input file being processed.
27250 This is the substring up to (and not including) the last period
27251 and not including the directory.
27253 @item %B
27254 This is the same as @samp{%b}, but include the file suffix (text after
27255 the last period).
27257 @item %d
27258 Marks the argument containing or following the @samp{%d} as a
27259 temporary file name, so that that file is deleted if GCC exits
27260 successfully.  Unlike @samp{%g}, this contributes no text to the
27261 argument.
27263 @item %g@var{suffix}
27264 Substitute a file name that has suffix @var{suffix} and is chosen
27265 once per compilation, and mark the argument in the same way as
27266 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
27267 name is now chosen in a way that is hard to predict even when previously
27268 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
27269 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
27270 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
27271 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
27272 was simply substituted with a file name chosen once per compilation,
27273 without regard to any appended suffix (which was therefore treated
27274 just like ordinary text), making such attacks more likely to succeed.
27276 @item %u@var{suffix}
27277 Like @samp{%g}, but generates a new temporary file name
27278 each time it appears instead of once per compilation.
27280 @item %U@var{suffix}
27281 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
27282 new one if there is no such last file name.  In the absence of any
27283 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
27284 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
27285 involves the generation of two distinct file names, one
27286 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
27287 simply substituted with a file name chosen for the previous @samp{%u},
27288 without regard to any appended suffix.
27290 @item %j@var{suffix}
27291 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
27292 writable, and if @option{-save-temps} is not used; 
27293 otherwise, substitute the name
27294 of a temporary file, just like @samp{%u}.  This temporary file is not
27295 meant for communication between processes, but rather as a junk
27296 disposal mechanism.
27298 @item %|@var{suffix}
27299 @itemx %m@var{suffix}
27300 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
27301 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
27302 all.  These are the two most common ways to instruct a program that it
27303 should read from standard input or write to standard output.  If you
27304 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
27305 construct: see for example @file{f/lang-specs.h}.
27307 @item %.@var{SUFFIX}
27308 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
27309 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
27310 terminated by the next space or %.
27312 @item %w
27313 Marks the argument containing or following the @samp{%w} as the
27314 designated output file of this compilation.  This puts the argument
27315 into the sequence of arguments that @samp{%o} substitutes.
27317 @item %o
27318 Substitutes the names of all the output files, with spaces
27319 automatically placed around them.  You should write spaces
27320 around the @samp{%o} as well or the results are undefined.
27321 @samp{%o} is for use in the specs for running the linker.
27322 Input files whose names have no recognized suffix are not compiled
27323 at all, but they are included among the output files, so they are
27324 linked.
27326 @item %O
27327 Substitutes the suffix for object files.  Note that this is
27328 handled specially when it immediately follows @samp{%g, %u, or %U},
27329 because of the need for those to form complete file names.  The
27330 handling is such that @samp{%O} is treated exactly as if it had already
27331 been substituted, except that @samp{%g, %u, and %U} do not currently
27332 support additional @var{suffix} characters following @samp{%O} as they do
27333 following, for example, @samp{.o}.
27335 @item %p
27336 Substitutes the standard macro predefinitions for the
27337 current target machine.  Use this when running @command{cpp}.
27339 @item %P
27340 Like @samp{%p}, but puts @samp{__} before and after the name of each
27341 predefined macro, except for macros that start with @samp{__} or with
27342 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
27345 @item %I
27346 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
27347 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
27348 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
27349 and @option{-imultilib} as necessary.
27351 @item %s
27352 Current argument is the name of a library or startup file of some sort.
27353 Search for that file in a standard list of directories and substitute
27354 the full name found.  The current working directory is included in the
27355 list of directories scanned.
27357 @item %T
27358 Current argument is the name of a linker script.  Search for that file
27359 in the current list of directories to scan for libraries. If the file
27360 is located insert a @option{--script} option into the command line
27361 followed by the full path name found.  If the file is not found then
27362 generate an error message.  Note: the current working directory is not
27363 searched.
27365 @item %e@var{str}
27366 Print @var{str} as an error message.  @var{str} is terminated by a newline.
27367 Use this when inconsistent options are detected.
27369 @item %(@var{name})
27370 Substitute the contents of spec string @var{name} at this point.
27372 @item %x@{@var{option}@}
27373 Accumulate an option for @samp{%X}.
27375 @item %X
27376 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
27377 spec string.
27379 @item %Y
27380 Output the accumulated assembler options specified by @option{-Wa}.
27382 @item %Z
27383 Output the accumulated preprocessor options specified by @option{-Wp}.
27385 @item %a
27386 Process the @code{asm} spec.  This is used to compute the
27387 switches to be passed to the assembler.
27389 @item %A
27390 Process the @code{asm_final} spec.  This is a spec string for
27391 passing switches to an assembler post-processor, if such a program is
27392 needed.
27394 @item %l
27395 Process the @code{link} spec.  This is the spec for computing the
27396 command line passed to the linker.  Typically it makes use of the
27397 @samp{%L %G %S %D and %E} sequences.
27399 @item %D
27400 Dump out a @option{-L} option for each directory that GCC believes might
27401 contain startup files.  If the target supports multilibs then the
27402 current multilib directory is prepended to each of these paths.
27404 @item %L
27405 Process the @code{lib} spec.  This is a spec string for deciding which
27406 libraries are included on the command line to the linker.
27408 @item %G
27409 Process the @code{libgcc} spec.  This is a spec string for deciding
27410 which GCC support library is included on the command line to the linker.
27412 @item %S
27413 Process the @code{startfile} spec.  This is a spec for deciding which
27414 object files are the first ones passed to the linker.  Typically
27415 this might be a file named @file{crt0.o}.
27417 @item %E
27418 Process the @code{endfile} spec.  This is a spec string that specifies
27419 the last object files that are passed to the linker.
27421 @item %C
27422 Process the @code{cpp} spec.  This is used to construct the arguments
27423 to be passed to the C preprocessor.
27425 @item %1
27426 Process the @code{cc1} spec.  This is used to construct the options to be
27427 passed to the actual C compiler (@command{cc1}).
27429 @item %2
27430 Process the @code{cc1plus} spec.  This is used to construct the options to be
27431 passed to the actual C++ compiler (@command{cc1plus}).
27433 @item %*
27434 Substitute the variable part of a matched option.  See below.
27435 Note that each comma in the substituted string is replaced by
27436 a single space.
27438 @item %<S
27439 Remove all occurrences of @code{-S} from the command line.  Note---this
27440 command is position dependent.  @samp{%} commands in the spec string
27441 before this one see @code{-S}, @samp{%} commands in the spec string
27442 after this one do not.
27444 @item %:@var{function}(@var{args})
27445 Call the named function @var{function}, passing it @var{args}.
27446 @var{args} is first processed as a nested spec string, then split
27447 into an argument vector in the usual fashion.  The function returns
27448 a string which is processed as if it had appeared literally as part
27449 of the current spec.
27451 The following built-in spec functions are provided:
27453 @table @code
27454 @item @code{getenv}
27455 The @code{getenv} spec function takes two arguments: an environment
27456 variable name and a string.  If the environment variable is not
27457 defined, a fatal error is issued.  Otherwise, the return value is the
27458 value of the environment variable concatenated with the string.  For
27459 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
27461 @smallexample
27462 %:getenv(TOPDIR /include)
27463 @end smallexample
27465 expands to @file{/path/to/top/include}.
27467 @item @code{if-exists}
27468 The @code{if-exists} spec function takes one argument, an absolute
27469 pathname to a file.  If the file exists, @code{if-exists} returns the
27470 pathname.  Here is a small example of its usage:
27472 @smallexample
27473 *startfile:
27474 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
27475 @end smallexample
27477 @item @code{if-exists-else}
27478 The @code{if-exists-else} spec function is similar to the @code{if-exists}
27479 spec function, except that it takes two arguments.  The first argument is
27480 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
27481 returns the pathname.  If it does not exist, it returns the second argument.
27482 This way, @code{if-exists-else} can be used to select one file or another,
27483 based on the existence of the first.  Here is a small example of its usage:
27485 @smallexample
27486 *startfile:
27487 crt0%O%s %:if-exists(crti%O%s) \
27488 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
27489 @end smallexample
27491 @item @code{replace-outfile}
27492 The @code{replace-outfile} spec function takes two arguments.  It looks for the
27493 first argument in the outfiles array and replaces it with the second argument.  Here
27494 is a small example of its usage:
27496 @smallexample
27497 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
27498 @end smallexample
27500 @item @code{remove-outfile}
27501 The @code{remove-outfile} spec function takes one argument.  It looks for the
27502 first argument in the outfiles array and removes it.  Here is a small example
27503 its usage:
27505 @smallexample
27506 %:remove-outfile(-lm)
27507 @end smallexample
27509 @item @code{pass-through-libs}
27510 The @code{pass-through-libs} spec function takes any number of arguments.  It
27511 finds any @option{-l} options and any non-options ending in @file{.a} (which it
27512 assumes are the names of linker input library archive files) and returns a
27513 result containing all the found arguments each prepended by
27514 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
27515 intended to be passed to the LTO linker plugin.
27517 @smallexample
27518 %:pass-through-libs(%G %L %G)
27519 @end smallexample
27521 @item @code{print-asm-header}
27522 The @code{print-asm-header} function takes no arguments and simply
27523 prints a banner like:
27525 @smallexample
27526 Assembler options
27527 =================
27529 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
27530 @end smallexample
27532 It is used to separate compiler options from assembler options
27533 in the @option{--target-help} output.
27534 @end table
27536 @item %@{S@}
27537 Substitutes the @code{-S} switch, if that switch is given to GCC@.
27538 If that switch is not specified, this substitutes nothing.  Note that
27539 the leading dash is omitted when specifying this option, and it is
27540 automatically inserted if the substitution is performed.  Thus the spec
27541 string @samp{%@{foo@}} matches the command-line option @option{-foo}
27542 and outputs the command-line option @option{-foo}.
27544 @item %W@{S@}
27545 Like %@{@code{S}@} but mark last argument supplied within as a file to be
27546 deleted on failure.
27548 @item %@{S*@}
27549 Substitutes all the switches specified to GCC whose names start
27550 with @code{-S}, but which also take an argument.  This is used for
27551 switches like @option{-o}, @option{-D}, @option{-I}, etc.
27552 GCC considers @option{-o foo} as being
27553 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
27554 text, including the space.  Thus two arguments are generated.
27556 @item %@{S*&T*@}
27557 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
27558 (the order of @code{S} and @code{T} in the spec is not significant).
27559 There can be any number of ampersand-separated variables; for each the
27560 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
27562 @item %@{S:X@}
27563 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
27565 @item %@{!S:X@}
27566 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
27568 @item %@{S*:X@}
27569 Substitutes @code{X} if one or more switches whose names start with
27570 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
27571 once, no matter how many such switches appeared.  However, if @code{%*}
27572 appears somewhere in @code{X}, then @code{X} is substituted once
27573 for each matching switch, with the @code{%*} replaced by the part of
27574 that switch matching the @code{*}.
27576 If @code{%*} appears as the last part of a spec sequence then a space
27577 is added after the end of the last substitution.  If there is more
27578 text in the sequence, however, then a space is not generated.  This
27579 allows the @code{%*} substitution to be used as part of a larger
27580 string.  For example, a spec string like this:
27582 @smallexample
27583 %@{mcu=*:--script=%*/memory.ld@}
27584 @end smallexample
27586 @noindent
27587 when matching an option like @option{-mcu=newchip} produces:
27589 @smallexample
27590 --script=newchip/memory.ld
27591 @end smallexample
27593 @item %@{.S:X@}
27594 Substitutes @code{X}, if processing a file with suffix @code{S}.
27596 @item %@{!.S:X@}
27597 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
27599 @item %@{,S:X@}
27600 Substitutes @code{X}, if processing a file for language @code{S}.
27602 @item %@{!,S:X@}
27603 Substitutes @code{X}, if not processing a file for language @code{S}.
27605 @item %@{S|P:X@}
27606 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
27607 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
27608 @code{*} sequences as well, although they have a stronger binding than
27609 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
27610 alternatives must be starred, and only the first matching alternative
27611 is substituted.
27613 For example, a spec string like this:
27615 @smallexample
27616 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
27617 @end smallexample
27619 @noindent
27620 outputs the following command-line options from the following input
27621 command-line options:
27623 @smallexample
27624 fred.c        -foo -baz
27625 jim.d         -bar -boggle
27626 -d fred.c     -foo -baz -boggle
27627 -d jim.d      -bar -baz -boggle
27628 @end smallexample
27630 @item %@{S:X; T:Y; :D@}
27632 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
27633 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
27634 be as many clauses as you need.  This may be combined with @code{.},
27635 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
27638 @end table
27640 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
27641 or similar construct can use a backslash to ignore the special meaning
27642 of the character following it, thus allowing literal matching of a
27643 character that is otherwise specially treated.  For example,
27644 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
27645 @option{-std=iso9899:1999} option is given.
27647 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
27648 construct may contain other nested @samp{%} constructs or spaces, or
27649 even newlines.  They are processed as usual, as described above.
27650 Trailing white space in @code{X} is ignored.  White space may also
27651 appear anywhere on the left side of the colon in these constructs,
27652 except between @code{.} or @code{*} and the corresponding word.
27654 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
27655 handled specifically in these constructs.  If another value of
27656 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
27657 @option{-W} switch is found later in the command line, the earlier
27658 switch value is ignored, except with @{@code{S}*@} where @code{S} is
27659 just one letter, which passes all matching options.
27661 The character @samp{|} at the beginning of the predicate text is used to
27662 indicate that a command should be piped to the following command, but
27663 only if @option{-pipe} is specified.
27665 It is built into GCC which switches take arguments and which do not.
27666 (You might think it would be useful to generalize this to allow each
27667 compiler's spec to say which switches take arguments.  But this cannot
27668 be done in a consistent fashion.  GCC cannot even decide which input
27669 files have been specified without knowing which switches take arguments,
27670 and it must know which input files to compile in order to tell which
27671 compilers to run).
27673 GCC also knows implicitly that arguments starting in @option{-l} are to be
27674 treated as compiler output files, and passed to the linker in their
27675 proper position among the other output files.
27677 @node Environment Variables
27678 @section Environment Variables Affecting GCC
27679 @cindex environment variables
27681 @c man begin ENVIRONMENT
27682 This section describes several environment variables that affect how GCC
27683 operates.  Some of them work by specifying directories or prefixes to use
27684 when searching for various kinds of files.  Some are used to specify other
27685 aspects of the compilation environment.
27687 Note that you can also specify places to search using options such as
27688 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27689 take precedence over places specified using environment variables, which
27690 in turn take precedence over those specified by the configuration of GCC@.
27691 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27692 GNU Compiler Collection (GCC) Internals}.
27694 @table @env
27695 @item LANG
27696 @itemx LC_CTYPE
27697 @c @itemx LC_COLLATE
27698 @itemx LC_MESSAGES
27699 @c @itemx LC_MONETARY
27700 @c @itemx LC_NUMERIC
27701 @c @itemx LC_TIME
27702 @itemx LC_ALL
27703 @findex LANG
27704 @findex LC_CTYPE
27705 @c @findex LC_COLLATE
27706 @findex LC_MESSAGES
27707 @c @findex LC_MONETARY
27708 @c @findex LC_NUMERIC
27709 @c @findex LC_TIME
27710 @findex LC_ALL
27711 @cindex locale
27712 These environment variables control the way that GCC uses
27713 localization information which allows GCC to work with different
27714 national conventions.  GCC inspects the locale categories
27715 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27716 so.  These locale categories can be set to any value supported by your
27717 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27718 Kingdom encoded in UTF-8.
27720 The @env{LC_CTYPE} environment variable specifies character
27721 classification.  GCC uses it to determine the character boundaries in
27722 a string; this is needed for some multibyte encodings that contain quote
27723 and escape characters that are otherwise interpreted as a string
27724 end or escape.
27726 The @env{LC_MESSAGES} environment variable specifies the language to
27727 use in diagnostic messages.
27729 If the @env{LC_ALL} environment variable is set, it overrides the value
27730 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27731 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27732 environment variable.  If none of these variables are set, GCC
27733 defaults to traditional C English behavior.
27735 @item TMPDIR
27736 @findex TMPDIR
27737 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27738 files.  GCC uses temporary files to hold the output of one stage of
27739 compilation which is to be used as input to the next stage: for example,
27740 the output of the preprocessor, which is the input to the compiler
27741 proper.
27743 @item GCC_COMPARE_DEBUG
27744 @findex GCC_COMPARE_DEBUG
27745 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27746 @option{-fcompare-debug} to the compiler driver.  See the documentation
27747 of this option for more details.
27749 @item GCC_EXEC_PREFIX
27750 @findex GCC_EXEC_PREFIX
27751 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27752 names of the subprograms executed by the compiler.  No slash is added
27753 when this prefix is combined with the name of a subprogram, but you can
27754 specify a prefix that ends with a slash if you wish.
27756 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27757 an appropriate prefix to use based on the pathname it is invoked with.
27759 If GCC cannot find the subprogram using the specified prefix, it
27760 tries looking in the usual places for the subprogram.
27762 The default value of @env{GCC_EXEC_PREFIX} is
27763 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27764 the installed compiler. In many cases @var{prefix} is the value
27765 of @code{prefix} when you ran the @file{configure} script.
27767 Other prefixes specified with @option{-B} take precedence over this prefix.
27769 This prefix is also used for finding files such as @file{crt0.o} that are
27770 used for linking.
27772 In addition, the prefix is used in an unusual way in finding the
27773 directories to search for header files.  For each of the standard
27774 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27775 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27776 replacing that beginning with the specified prefix to produce an
27777 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27778 @file{foo/bar} just before it searches the standard directory 
27779 @file{/usr/local/lib/bar}.
27780 If a standard directory begins with the configured
27781 @var{prefix} then the value of @var{prefix} is replaced by
27782 @env{GCC_EXEC_PREFIX} when looking for header files.
27784 @item COMPILER_PATH
27785 @findex COMPILER_PATH
27786 The value of @env{COMPILER_PATH} is a colon-separated list of
27787 directories, much like @env{PATH}.  GCC tries the directories thus
27788 specified when searching for subprograms, if it cannot find the
27789 subprograms using @env{GCC_EXEC_PREFIX}.
27791 @item LIBRARY_PATH
27792 @findex LIBRARY_PATH
27793 The value of @env{LIBRARY_PATH} is a colon-separated list of
27794 directories, much like @env{PATH}.  When configured as a native compiler,
27795 GCC tries the directories thus specified when searching for special
27796 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27797 using GCC also uses these directories when searching for ordinary
27798 libraries for the @option{-l} option (but directories specified with
27799 @option{-L} come first).
27801 @item LANG
27802 @findex LANG
27803 @cindex locale definition
27804 This variable is used to pass locale information to the compiler.  One way in
27805 which this information is used is to determine the character set to be used
27806 when character literals, string literals and comments are parsed in C and C++.
27807 When the compiler is configured to allow multibyte characters,
27808 the following values for @env{LANG} are recognized:
27810 @table @samp
27811 @item C-JIS
27812 Recognize JIS characters.
27813 @item C-SJIS
27814 Recognize SJIS characters.
27815 @item C-EUCJP
27816 Recognize EUCJP characters.
27817 @end table
27819 If @env{LANG} is not defined, or if it has some other value, then the
27820 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27821 recognize and translate multibyte characters.
27822 @end table
27824 @noindent
27825 Some additional environment variables affect the behavior of the
27826 preprocessor.
27828 @include cppenv.texi
27830 @c man end
27832 @node Precompiled Headers
27833 @section Using Precompiled Headers
27834 @cindex precompiled headers
27835 @cindex speed of compilation
27837 Often large projects have many header files that are included in every
27838 source file.  The time the compiler takes to process these header files
27839 over and over again can account for nearly all of the time required to
27840 build the project.  To make builds faster, GCC allows you to
27841 @dfn{precompile} a header file.
27843 To create a precompiled header file, simply compile it as you would any
27844 other file, if necessary using the @option{-x} option to make the driver
27845 treat it as a C or C++ header file.  You may want to use a
27846 tool like @command{make} to keep the precompiled header up-to-date when
27847 the headers it contains change.
27849 A precompiled header file is searched for when @code{#include} is
27850 seen in the compilation.  As it searches for the included file
27851 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27852 compiler looks for a precompiled header in each directory just before it
27853 looks for the include file in that directory.  The name searched for is
27854 the name specified in the @code{#include} with @samp{.gch} appended.  If
27855 the precompiled header file cannot be used, it is ignored.
27857 For instance, if you have @code{#include "all.h"}, and you have
27858 @file{all.h.gch} in the same directory as @file{all.h}, then the
27859 precompiled header file is used if possible, and the original
27860 header is used otherwise.
27862 Alternatively, you might decide to put the precompiled header file in a
27863 directory and use @option{-I} to ensure that directory is searched
27864 before (or instead of) the directory containing the original header.
27865 Then, if you want to check that the precompiled header file is always
27866 used, you can put a file of the same name as the original header in this
27867 directory containing an @code{#error} command.
27869 This also works with @option{-include}.  So yet another way to use
27870 precompiled headers, good for projects not designed with precompiled
27871 header files in mind, is to simply take most of the header files used by
27872 a project, include them from another header file, precompile that header
27873 file, and @option{-include} the precompiled header.  If the header files
27874 have guards against multiple inclusion, they are skipped because
27875 they've already been included (in the precompiled header).
27877 If you need to precompile the same header file for different
27878 languages, targets, or compiler options, you can instead make a
27879 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27880 header in the directory, perhaps using @option{-o}.  It doesn't matter
27881 what you call the files in the directory; every precompiled header in
27882 the directory is considered.  The first precompiled header
27883 encountered in the directory that is valid for this compilation is
27884 used; they're searched in no particular order.
27886 There are many other possibilities, limited only by your imagination,
27887 good sense, and the constraints of your build system.
27889 A precompiled header file can be used only when these conditions apply:
27891 @itemize
27892 @item
27893 Only one precompiled header can be used in a particular compilation.
27895 @item
27896 A precompiled header cannot be used once the first C token is seen.  You
27897 can have preprocessor directives before a precompiled header; you cannot
27898 include a precompiled header from inside another header.
27900 @item
27901 The precompiled header file must be produced for the same language as
27902 the current compilation.  You cannot use a C precompiled header for a C++
27903 compilation.
27905 @item
27906 The precompiled header file must have been produced by the same compiler
27907 binary as the current compilation is using.
27909 @item
27910 Any macros defined before the precompiled header is included must
27911 either be defined in the same way as when the precompiled header was
27912 generated, or must not affect the precompiled header, which usually
27913 means that they don't appear in the precompiled header at all.
27915 The @option{-D} option is one way to define a macro before a
27916 precompiled header is included; using a @code{#define} can also do it.
27917 There are also some options that define macros implicitly, like
27918 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
27919 defined this way.
27921 @item If debugging information is output when using the precompiled
27922 header, using @option{-g} or similar, the same kind of debugging information
27923 must have been output when building the precompiled header.  However,
27924 a precompiled header built using @option{-g} can be used in a compilation
27925 when no debugging information is being output.
27927 @item The same @option{-m} options must generally be used when building
27928 and using the precompiled header.  @xref{Submodel Options},
27929 for any cases where this rule is relaxed.
27931 @item Each of the following options must be the same when building and using
27932 the precompiled header:
27934 @gccoptlist{-fexceptions}
27936 @item
27937 Some other command-line options starting with @option{-f},
27938 @option{-p}, or @option{-O} must be defined in the same way as when
27939 the precompiled header was generated.  At present, it's not clear
27940 which options are safe to change and which are not; the safest choice
27941 is to use exactly the same options when generating and using the
27942 precompiled header.  The following are known to be safe:
27944 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
27945 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
27946 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
27947 -pedantic-errors}
27949 @end itemize
27951 For all of these except the last, the compiler automatically
27952 ignores the precompiled header if the conditions aren't met.  If you
27953 find an option combination that doesn't work and doesn't cause the
27954 precompiled header to be ignored, please consider filing a bug report,
27955 see @ref{Bugs}.
27957 If you do use differing options when generating and using the
27958 precompiled header, the actual behavior is a mixture of the
27959 behavior for the options.  For instance, if you use @option{-g} to
27960 generate the precompiled header but not when using it, you may or may
27961 not get debugging information for routines in the precompiled header.