x86: Add -mindirect-branch-register
[official-gcc.git] / gcc / doc / invoke.texi
blobcb18a0ebdf1a2bc683e9a6823c9862e08cd0ed02
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 -mext-perf  -mno-ext-perf @gol
945 -mext-perf2  -mno-ext-perf2 @gol
946 -mext-string  -mno-ext-string @gol
947 -mv3push  -mno-v3push @gol
948 -m16bit  -mno-16bit @gol
949 -misr-vector-size=@var{num} @gol
950 -mcache-block-size=@var{num} @gol
951 -march=@var{arch} @gol
952 -mcmodel=@var{code-model} @gol
953 -mctor-dtor  -mrelax}
955 @emph{Nios II Options}
956 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
957 -mgprel-sec=@var{regexp} -mr0rel-sec=@var{regexp} @gol
958 -mel  -meb @gol
959 -mno-bypass-cache  -mbypass-cache @gol
960 -mno-cache-volatile  -mcache-volatile @gol
961 -mno-fast-sw-div  -mfast-sw-div @gol
962 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
963 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
964 -mcustom-fpu-cfg=@var{name} @gol
965 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
966 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
968 @emph{Nvidia PTX Options}
969 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
971 @emph{PDP-11 Options}
972 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
973 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
974 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
975 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
976 -mbranch-expensive  -mbranch-cheap @gol
977 -munix-asm  -mdec-asm}
979 @emph{picoChip Options}
980 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
981 -msymbol-as-address  -mno-inefficient-warnings}
983 @emph{PowerPC Options}
984 See RS/6000 and PowerPC Options.
986 @emph{RISC-V Options}
987 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
988 -mplt  -mno-plt @gol
989 -mabi=@var{ABI-string} @gol
990 -mfdiv  -mno-fdiv @gol
991 -mdiv  -mno-div @gol
992 -march=@var{ISA-string} @gol
993 -mtune=@var{processor-string} @gol
994 -msmall-data-limit=@var{N-bytes} @gol
995 -msave-restore  -mno-save-restore @gol
996 -mstrict-align -mno-strict-align @gol
997 -mcmodel=medlow -mcmodel=medany @gol
998 -mexplicit-relocs  -mno-explicit-relocs @gol}
1000 @emph{RL78 Options}
1001 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
1002 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
1003 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
1005 @emph{RS/6000 and PowerPC Options}
1006 @gccoptlist{-mcpu=@var{cpu-type} @gol
1007 -mtune=@var{cpu-type} @gol
1008 -mcmodel=@var{code-model} @gol
1009 -mpowerpc64 @gol
1010 -maltivec  -mno-altivec @gol
1011 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1012 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1013 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1014 -mfprnd  -mno-fprnd @gol
1015 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1016 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1017 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1018 -malign-power  -malign-natural @gol
1019 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1020 -msingle-float  -mdouble-float  -msimple-fpu @gol
1021 -mupdate  -mno-update @gol
1022 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1023 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1024 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1025 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1026 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1027 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1028 -mprioritize-restricted-insns=@var{priority} @gol
1029 -msched-costly-dep=@var{dependence_type} @gol
1030 -minsert-sched-nops=@var{scheme} @gol
1031 -mcall-sysv  -mcall-netbsd @gol
1032 -maix-struct-return  -msvr4-struct-return @gol
1033 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1034 -mblock-move-inline-limit=@var{num} @gol
1035 -misel  -mno-isel @gol
1036 -misel=yes  -misel=no @gol
1037 -mspe  -mno-spe @gol
1038 -mspe=yes  -mspe=no @gol
1039 -mpaired @gol
1040 -mvrsave  -mno-vrsave @gol
1041 -mmulhw  -mno-mulhw @gol
1042 -mdlmzb  -mno-dlmzb @gol
1043 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1044 -mprototype  -mno-prototype @gol
1045 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1046 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1047 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1048 -mno-recip-precision @gol
1049 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1050 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1051 -msave-toc-indirect  -mno-save-toc-indirect @gol
1052 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1053 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1054 -mquad-memory  -mno-quad-memory @gol
1055 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1056 -mcompat-align-parm  -mno-compat-align-parm @gol
1057 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1058 -mgnu-attribute  -mno-gnu-attribute @gol
1059 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1060 -mstack-protector-guard-offset=@var{offset}}
1062 @emph{RX Options}
1063 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1064 -mcpu=@gol
1065 -mbig-endian-data  -mlittle-endian-data @gol
1066 -msmall-data @gol
1067 -msim  -mno-sim@gol
1068 -mas100-syntax  -mno-as100-syntax@gol
1069 -mrelax@gol
1070 -mmax-constant-size=@gol
1071 -mint-register=@gol
1072 -mpid@gol
1073 -mallow-string-insns  -mno-allow-string-insns@gol
1074 -mjsr@gol
1075 -mno-warn-multiple-fast-interrupts@gol
1076 -msave-acc-in-interrupts}
1078 @emph{S/390 and zSeries Options}
1079 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1080 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1081 -mlong-double-64  -mlong-double-128 @gol
1082 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1083 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1084 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1085 -mhtm  -mvx  -mzvector @gol
1086 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1087 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1088 -mhotpatch=@var{halfwords},@var{halfwords}}
1090 @emph{Score Options}
1091 @gccoptlist{-meb  -mel @gol
1092 -mnhwloop @gol
1093 -muls @gol
1094 -mmac @gol
1095 -mscore5  -mscore5u  -mscore7  -mscore7d}
1097 @emph{SH Options}
1098 @gccoptlist{-m1  -m2  -m2e @gol
1099 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1100 -m3  -m3e @gol
1101 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1102 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1103 -mb  -ml  -mdalign  -mrelax @gol
1104 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1105 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1106 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1107 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1108 -maccumulate-outgoing-args @gol
1109 -matomic-model=@var{atomic-model} @gol
1110 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1111 -mcbranch-force-delay-slot @gol
1112 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1113 -mpretend-cmove  -mtas}
1115 @emph{Solaris 2 Options}
1116 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1117 -pthreads}
1119 @emph{SPARC Options}
1120 @gccoptlist{-mcpu=@var{cpu-type} @gol
1121 -mtune=@var{cpu-type} @gol
1122 -mcmodel=@var{code-model} @gol
1123 -mmemory-model=@var{mem-model} @gol
1124 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1125 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1126 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1127 -mhard-quad-float  -msoft-quad-float @gol
1128 -mstack-bias  -mno-stack-bias @gol
1129 -mstd-struct-return  -mno-std-struct-return @gol
1130 -munaligned-doubles  -mno-unaligned-doubles @gol
1131 -muser-mode  -mno-user-mode @gol
1132 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1133 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1134 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1135 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1136 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1137 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1138 -mlra  -mno-lra}
1140 @emph{SPU Options}
1141 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1142 -msafe-dma  -munsafe-dma @gol
1143 -mbranch-hints @gol
1144 -msmall-mem  -mlarge-mem  -mstdmain @gol
1145 -mfixed-range=@var{register-range} @gol
1146 -mea32  -mea64 @gol
1147 -maddress-space-conversion  -mno-address-space-conversion @gol
1148 -mcache-size=@var{cache-size} @gol
1149 -matomic-updates  -mno-atomic-updates}
1151 @emph{System V Options}
1152 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1154 @emph{TILE-Gx Options}
1155 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1156 -mcmodel=@var{code-model}}
1158 @emph{TILEPro Options}
1159 @gccoptlist{-mcpu=@var{cpu}  -m32}
1161 @emph{V850 Options}
1162 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1163 -mprolog-function  -mno-prolog-function  -mspace @gol
1164 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1165 -mapp-regs  -mno-app-regs @gol
1166 -mdisable-callt  -mno-disable-callt @gol
1167 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1168 -mv850e  -mv850  -mv850e3v5 @gol
1169 -mloop @gol
1170 -mrelax @gol
1171 -mlong-jumps @gol
1172 -msoft-float @gol
1173 -mhard-float @gol
1174 -mgcc-abi @gol
1175 -mrh850-abi @gol
1176 -mbig-switch}
1178 @emph{VAX Options}
1179 @gccoptlist{-mg  -mgnu  -munix}
1181 @emph{Visium Options}
1182 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1183 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1185 @emph{VMS Options}
1186 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1187 -mpointer-size=@var{size}}
1189 @emph{VxWorks Options}
1190 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1191 -Xbind-lazy  -Xbind-now}
1193 @emph{x86 Options}
1194 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1195 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1196 -mfpmath=@var{unit} @gol
1197 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1198 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1199 -mno-wide-multiply  -mrtd  -malign-double @gol
1200 -mpreferred-stack-boundary=@var{num} @gol
1201 -mincoming-stack-boundary=@var{num} @gol
1202 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1203 -mrecip  -mrecip=@var{opt} @gol
1204 -mvzeroupper  -mprefer-avx128 -mprefer-vector-width=@var{opt} @gol
1205 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1206 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1207 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1208 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1209 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1210 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1211 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1212 -mmwaitx  -mclzero  -mpku  -mthreads -mgfni  -mvaes  @gol
1213 -mcet -mibt -mshstk -mforce-indirect-call -mavx512vbmi2 @gol
1214 -mvpclmulqdq -mavx512bitalg -mavx512vpopcntdq @gol
1215 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1216 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1217 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1218 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1219 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1220 -mregparm=@var{num}  -msseregparm @gol
1221 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1222 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1223 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1224 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1225 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1226 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1227 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1228 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1229 -mstack-protector-guard-reg=@var{reg} @gol
1230 -mstack-protector-guard-offset=@var{offset} @gol
1231 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1232 -mgeneral-regs-only -mcall-ms2sysv-xlogues @gol
1233 -mindirect-branch=@var{choice} -mfunction-return==@var{choice} @gol
1234 -mindirect-branch-register}
1236 @emph{x86 Windows Options}
1237 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1238 -mnop-fun-dllimport  -mthread @gol
1239 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1241 @emph{Xstormy16 Options}
1242 @gccoptlist{-msim}
1244 @emph{Xtensa Options}
1245 @gccoptlist{-mconst16  -mno-const16 @gol
1246 -mfused-madd  -mno-fused-madd @gol
1247 -mforce-no-pic @gol
1248 -mserialize-volatile  -mno-serialize-volatile @gol
1249 -mtext-section-literals  -mno-text-section-literals @gol
1250 -mauto-litpools  -mno-auto-litpools @gol
1251 -mtarget-align  -mno-target-align @gol
1252 -mlongcalls  -mno-longcalls}
1254 @emph{zSeries Options}
1255 See S/390 and zSeries Options.
1256 @end table
1259 @node Overall Options
1260 @section Options Controlling the Kind of Output
1262 Compilation can involve up to four stages: preprocessing, compilation
1263 proper, assembly and linking, always in that order.  GCC is capable of
1264 preprocessing and compiling several files either into several
1265 assembler input files, or into one assembler input file; then each
1266 assembler input file produces an object file, and linking combines all
1267 the object files (those newly compiled, and those specified as input)
1268 into an executable file.
1270 @cindex file name suffix
1271 For any given input file, the file name suffix determines what kind of
1272 compilation is done:
1274 @table @gcctabopt
1275 @item @var{file}.c
1276 C source code that must be preprocessed.
1278 @item @var{file}.i
1279 C source code that should not be preprocessed.
1281 @item @var{file}.ii
1282 C++ source code that should not be preprocessed.
1284 @item @var{file}.m
1285 Objective-C source code.  Note that you must link with the @file{libobjc}
1286 library to make an Objective-C program work.
1288 @item @var{file}.mi
1289 Objective-C source code that should not be preprocessed.
1291 @item @var{file}.mm
1292 @itemx @var{file}.M
1293 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1294 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1295 to a literal capital M@.
1297 @item @var{file}.mii
1298 Objective-C++ source code that should not be preprocessed.
1300 @item @var{file}.h
1301 C, C++, Objective-C or Objective-C++ header file to be turned into a
1302 precompiled header (default), or C, C++ header file to be turned into an
1303 Ada spec (via the @option{-fdump-ada-spec} switch).
1305 @item @var{file}.cc
1306 @itemx @var{file}.cp
1307 @itemx @var{file}.cxx
1308 @itemx @var{file}.cpp
1309 @itemx @var{file}.CPP
1310 @itemx @var{file}.c++
1311 @itemx @var{file}.C
1312 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1313 the last two letters must both be literally @samp{x}.  Likewise,
1314 @samp{.C} refers to a literal capital C@.
1316 @item @var{file}.mm
1317 @itemx @var{file}.M
1318 Objective-C++ source code that must be preprocessed.
1320 @item @var{file}.mii
1321 Objective-C++ source code that should not be preprocessed.
1323 @item @var{file}.hh
1324 @itemx @var{file}.H
1325 @itemx @var{file}.hp
1326 @itemx @var{file}.hxx
1327 @itemx @var{file}.hpp
1328 @itemx @var{file}.HPP
1329 @itemx @var{file}.h++
1330 @itemx @var{file}.tcc
1331 C++ header file to be turned into a precompiled header or Ada spec.
1333 @item @var{file}.f
1334 @itemx @var{file}.for
1335 @itemx @var{file}.ftn
1336 Fixed form Fortran source code that should not be preprocessed.
1338 @item @var{file}.F
1339 @itemx @var{file}.FOR
1340 @itemx @var{file}.fpp
1341 @itemx @var{file}.FPP
1342 @itemx @var{file}.FTN
1343 Fixed form Fortran source code that must be preprocessed (with the traditional
1344 preprocessor).
1346 @item @var{file}.f90
1347 @itemx @var{file}.f95
1348 @itemx @var{file}.f03
1349 @itemx @var{file}.f08
1350 Free form Fortran source code that should not be preprocessed.
1352 @item @var{file}.F90
1353 @itemx @var{file}.F95
1354 @itemx @var{file}.F03
1355 @itemx @var{file}.F08
1356 Free form Fortran source code that must be preprocessed (with the
1357 traditional preprocessor).
1359 @item @var{file}.go
1360 Go source code.
1362 @item @var{file}.brig
1363 BRIG files (binary representation of HSAIL).
1365 @item @var{file}.ads
1366 Ada source code file that contains a library unit declaration (a
1367 declaration of a package, subprogram, or generic, or a generic
1368 instantiation), or a library unit renaming declaration (a package,
1369 generic, or subprogram renaming declaration).  Such files are also
1370 called @dfn{specs}.
1372 @item @var{file}.adb
1373 Ada source code file containing a library unit body (a subprogram or
1374 package body).  Such files are also called @dfn{bodies}.
1376 @c GCC also knows about some suffixes for languages not yet included:
1377 @c Pascal:
1378 @c @var{file}.p
1379 @c @var{file}.pas
1380 @c Ratfor:
1381 @c @var{file}.r
1383 @item @var{file}.s
1384 Assembler code.
1386 @item @var{file}.S
1387 @itemx @var{file}.sx
1388 Assembler code that must be preprocessed.
1390 @item @var{other}
1391 An object file to be fed straight into linking.
1392 Any file name with no recognized suffix is treated this way.
1393 @end table
1395 @opindex x
1396 You can specify the input language explicitly with the @option{-x} option:
1398 @table @gcctabopt
1399 @item -x @var{language}
1400 Specify explicitly the @var{language} for the following input files
1401 (rather than letting the compiler choose a default based on the file
1402 name suffix).  This option applies to all following input files until
1403 the next @option{-x} option.  Possible values for @var{language} are:
1404 @smallexample
1405 c  c-header  cpp-output
1406 c++  c++-header  c++-cpp-output
1407 objective-c  objective-c-header  objective-c-cpp-output
1408 objective-c++ objective-c++-header objective-c++-cpp-output
1409 assembler  assembler-with-cpp
1411 f77  f77-cpp-input f95  f95-cpp-input
1413 brig
1414 @end smallexample
1416 @item -x none
1417 Turn off any specification of a language, so that subsequent files are
1418 handled according to their file name suffixes (as they are if @option{-x}
1419 has not been used at all).
1420 @end table
1422 If you only want some of the stages of compilation, you can use
1423 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1424 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1425 @command{gcc} is to stop.  Note that some combinations (for example,
1426 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1428 @table @gcctabopt
1429 @item -c
1430 @opindex c
1431 Compile or assemble the source files, but do not link.  The linking
1432 stage simply is not done.  The ultimate output is in the form of an
1433 object file for each source file.
1435 By default, the object file name for a source file is made by replacing
1436 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1438 Unrecognized input files, not requiring compilation or assembly, are
1439 ignored.
1441 @item -S
1442 @opindex S
1443 Stop after the stage of compilation proper; do not assemble.  The output
1444 is in the form of an assembler code file for each non-assembler input
1445 file specified.
1447 By default, the assembler file name for a source file is made by
1448 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1450 Input files that don't require compilation are ignored.
1452 @item -E
1453 @opindex E
1454 Stop after the preprocessing stage; do not run the compiler proper.  The
1455 output is in the form of preprocessed source code, which is sent to the
1456 standard output.
1458 Input files that don't require preprocessing are ignored.
1460 @cindex output file option
1461 @item -o @var{file}
1462 @opindex o
1463 Place output in file @var{file}.  This applies to whatever
1464 sort of output is being produced, whether it be an executable file,
1465 an object file, an assembler file or preprocessed C code.
1467 If @option{-o} is not specified, the default is to put an executable
1468 file in @file{a.out}, the object file for
1469 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1470 assembler file in @file{@var{source}.s}, a precompiled header file in
1471 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1472 standard output.
1474 @item -v
1475 @opindex v
1476 Print (on standard error output) the commands executed to run the stages
1477 of compilation.  Also print the version number of the compiler driver
1478 program and of the preprocessor and the compiler proper.
1480 @item -###
1481 @opindex ###
1482 Like @option{-v} except the commands are not executed and arguments
1483 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1484 This is useful for shell scripts to capture the driver-generated command lines.
1486 @item --help
1487 @opindex help
1488 Print (on the standard output) a description of the command-line options
1489 understood by @command{gcc}.  If the @option{-v} option is also specified
1490 then @option{--help} is also passed on to the various processes
1491 invoked by @command{gcc}, so that they can display the command-line options
1492 they accept.  If the @option{-Wextra} option has also been specified
1493 (prior to the @option{--help} option), then command-line options that
1494 have no documentation associated with them are also displayed.
1496 @item --target-help
1497 @opindex target-help
1498 Print (on the standard output) a description of target-specific command-line
1499 options for each tool.  For some targets extra target-specific
1500 information may also be printed.
1502 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1503 Print (on the standard output) a description of the command-line
1504 options understood by the compiler that fit into all specified classes
1505 and qualifiers.  These are the supported classes:
1507 @table @asis
1508 @item @samp{optimizers}
1509 Display all of the optimization options supported by the
1510 compiler.
1512 @item @samp{warnings}
1513 Display all of the options controlling warning messages
1514 produced by the compiler.
1516 @item @samp{target}
1517 Display target-specific options.  Unlike the
1518 @option{--target-help} option however, target-specific options of the
1519 linker and assembler are not displayed.  This is because those
1520 tools do not currently support the extended @option{--help=} syntax.
1522 @item @samp{params}
1523 Display the values recognized by the @option{--param}
1524 option.
1526 @item @var{language}
1527 Display the options supported for @var{language}, where
1528 @var{language} is the name of one of the languages supported in this
1529 version of GCC@.
1531 @item @samp{common}
1532 Display the options that are common to all languages.
1533 @end table
1535 These are the supported qualifiers:
1537 @table @asis
1538 @item @samp{undocumented}
1539 Display only those options that are undocumented.
1541 @item @samp{joined}
1542 Display options taking an argument that appears after an equal
1543 sign in the same continuous piece of text, such as:
1544 @samp{--help=target}.
1546 @item @samp{separate}
1547 Display options taking an argument that appears as a separate word
1548 following the original option, such as: @samp{-o output-file}.
1549 @end table
1551 Thus for example to display all the undocumented target-specific
1552 switches supported by the compiler, use:
1554 @smallexample
1555 --help=target,undocumented
1556 @end smallexample
1558 The sense of a qualifier can be inverted by prefixing it with the
1559 @samp{^} character, so for example to display all binary warning
1560 options (i.e., ones that are either on or off and that do not take an
1561 argument) that have a description, use:
1563 @smallexample
1564 --help=warnings,^joined,^undocumented
1565 @end smallexample
1567 The argument to @option{--help=} should not consist solely of inverted
1568 qualifiers.
1570 Combining several classes is possible, although this usually
1571 restricts the output so much that there is nothing to display.  One
1572 case where it does work, however, is when one of the classes is
1573 @var{target}.  For example, to display all the target-specific
1574 optimization options, use:
1576 @smallexample
1577 --help=target,optimizers
1578 @end smallexample
1580 The @option{--help=} option can be repeated on the command line.  Each
1581 successive use displays its requested class of options, skipping
1582 those that have already been displayed.
1584 If the @option{-Q} option appears on the command line before the
1585 @option{--help=} option, then the descriptive text displayed by
1586 @option{--help=} is changed.  Instead of describing the displayed
1587 options, an indication is given as to whether the option is enabled,
1588 disabled or set to a specific value (assuming that the compiler
1589 knows this at the point where the @option{--help=} option is used).
1591 Here is a truncated example from the ARM port of @command{gcc}:
1593 @smallexample
1594   % gcc -Q -mabi=2 --help=target -c
1595   The following options are target specific:
1596   -mabi=                                2
1597   -mabort-on-noreturn                   [disabled]
1598   -mapcs                                [disabled]
1599 @end smallexample
1601 The output is sensitive to the effects of previous command-line
1602 options, so for example it is possible to find out which optimizations
1603 are enabled at @option{-O2} by using:
1605 @smallexample
1606 -Q -O2 --help=optimizers
1607 @end smallexample
1609 Alternatively you can discover which binary optimizations are enabled
1610 by @option{-O3} by using:
1612 @smallexample
1613 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1614 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1615 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1616 @end smallexample
1618 @item --version
1619 @opindex version
1620 Display the version number and copyrights of the invoked GCC@.
1622 @item -pass-exit-codes
1623 @opindex pass-exit-codes
1624 Normally the @command{gcc} program exits with the code of 1 if any
1625 phase of the compiler returns a non-success return code.  If you specify
1626 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1627 the numerically highest error produced by any phase returning an error
1628 indication.  The C, C++, and Fortran front ends return 4 if an internal
1629 compiler error is encountered.
1631 @item -pipe
1632 @opindex pipe
1633 Use pipes rather than temporary files for communication between the
1634 various stages of compilation.  This fails to work on some systems where
1635 the assembler is unable to read from a pipe; but the GNU assembler has
1636 no trouble.
1638 @item -specs=@var{file}
1639 @opindex specs
1640 Process @var{file} after the compiler reads in the standard @file{specs}
1641 file, in order to override the defaults which the @command{gcc} driver
1642 program uses when determining what switches to pass to @command{cc1},
1643 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1644 @option{-specs=@var{file}} can be specified on the command line, and they
1645 are processed in order, from left to right.  @xref{Spec Files}, for
1646 information about the format of the @var{file}.
1648 @item -wrapper
1649 @opindex wrapper
1650 Invoke all subcommands under a wrapper program.  The name of the
1651 wrapper program and its parameters are passed as a comma separated
1652 list.
1654 @smallexample
1655 gcc -c t.c -wrapper gdb,--args
1656 @end smallexample
1658 @noindent
1659 This invokes all subprograms of @command{gcc} under
1660 @samp{gdb --args}, thus the invocation of @command{cc1} is
1661 @samp{gdb --args cc1 @dots{}}.
1663 @item -fplugin=@var{name}.so
1664 @opindex fplugin
1665 Load the plugin code in file @var{name}.so, assumed to be a
1666 shared object to be dlopen'd by the compiler.  The base name of
1667 the shared object file is used to identify the plugin for the
1668 purposes of argument parsing (See
1669 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1670 Each plugin should define the callback functions specified in the
1671 Plugins API.
1673 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1674 @opindex fplugin-arg
1675 Define an argument called @var{key} with a value of @var{value}
1676 for the plugin called @var{name}.
1678 @item -fdump-ada-spec@r{[}-slim@r{]}
1679 @opindex fdump-ada-spec
1680 For C and C++ source and include files, generate corresponding Ada specs.
1681 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1682 GNAT User's Guide}, which provides detailed documentation on this feature.
1684 @item -fada-spec-parent=@var{unit}
1685 @opindex fada-spec-parent
1686 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1687 Ada specs as child units of parent @var{unit}.
1689 @item -fdump-go-spec=@var{file}
1690 @opindex fdump-go-spec
1691 For input files in any language, generate corresponding Go
1692 declarations in @var{file}.  This generates Go @code{const},
1693 @code{type}, @code{var}, and @code{func} declarations which may be a
1694 useful way to start writing a Go interface to code written in some
1695 other language.
1697 @include @value{srcdir}/../libiberty/at-file.texi
1698 @end table
1700 @node Invoking G++
1701 @section Compiling C++ Programs
1703 @cindex suffixes for C++ source
1704 @cindex C++ source file suffixes
1705 C++ source files conventionally use one of the suffixes @samp{.C},
1706 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1707 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1708 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1709 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1710 files with these names and compiles them as C++ programs even if you
1711 call the compiler the same way as for compiling C programs (usually
1712 with the name @command{gcc}).
1714 @findex g++
1715 @findex c++
1716 However, the use of @command{gcc} does not add the C++ library.
1717 @command{g++} is a program that calls GCC and automatically specifies linking
1718 against the C++ library.  It treats @samp{.c},
1719 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1720 files unless @option{-x} is used.  This program is also useful when
1721 precompiling a C header file with a @samp{.h} extension for use in C++
1722 compilations.  On many systems, @command{g++} is also installed with
1723 the name @command{c++}.
1725 @cindex invoking @command{g++}
1726 When you compile C++ programs, you may specify many of the same
1727 command-line options that you use for compiling programs in any
1728 language; or command-line options meaningful for C and related
1729 languages; or options that are meaningful only for C++ programs.
1730 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1731 explanations of options for languages related to C@.
1732 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1733 explanations of options that are meaningful only for C++ programs.
1735 @node C Dialect Options
1736 @section Options Controlling C Dialect
1737 @cindex dialect options
1738 @cindex language dialect options
1739 @cindex options, dialect
1741 The following options control the dialect of C (or languages derived
1742 from C, such as C++, Objective-C and Objective-C++) that the compiler
1743 accepts:
1745 @table @gcctabopt
1746 @cindex ANSI support
1747 @cindex ISO support
1748 @item -ansi
1749 @opindex ansi
1750 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1751 equivalent to @option{-std=c++98}.
1753 This turns off certain features of GCC that are incompatible with ISO
1754 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1755 such as the @code{asm} and @code{typeof} keywords, and
1756 predefined macros such as @code{unix} and @code{vax} that identify the
1757 type of system you are using.  It also enables the undesirable and
1758 rarely used ISO trigraph feature.  For the C compiler,
1759 it disables recognition of C++ style @samp{//} comments as well as
1760 the @code{inline} keyword.
1762 The alternate keywords @code{__asm__}, @code{__extension__},
1763 @code{__inline__} and @code{__typeof__} continue to work despite
1764 @option{-ansi}.  You would not want to use them in an ISO C program, of
1765 course, but it is useful to put them in header files that might be included
1766 in compilations done with @option{-ansi}.  Alternate predefined macros
1767 such as @code{__unix__} and @code{__vax__} are also available, with or
1768 without @option{-ansi}.
1770 The @option{-ansi} option does not cause non-ISO programs to be
1771 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1772 addition to @option{-ansi}.  @xref{Warning Options}.
1774 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1775 option is used.  Some header files may notice this macro and refrain
1776 from declaring certain functions or defining certain macros that the
1777 ISO standard doesn't call for; this is to avoid interfering with any
1778 programs that might use these names for other things.
1780 Functions that are normally built in but do not have semantics
1781 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1782 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1783 built-in functions provided by GCC}, for details of the functions
1784 affected.
1786 @item -std=
1787 @opindex std
1788 Determine the language standard. @xref{Standards,,Language Standards
1789 Supported by GCC}, for details of these standard versions.  This option
1790 is currently only supported when compiling C or C++.
1792 The compiler can accept several base standards, such as @samp{c90} or
1793 @samp{c++98}, and GNU dialects of those standards, such as
1794 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1795 compiler accepts all programs following that standard plus those
1796 using GNU extensions that do not contradict it.  For example,
1797 @option{-std=c90} turns off certain features of GCC that are
1798 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1799 keywords, but not other GNU extensions that do not have a meaning in
1800 ISO C90, such as omitting the middle term of a @code{?:}
1801 expression. On the other hand, when a GNU dialect of a standard is
1802 specified, all features supported by the compiler are enabled, even when
1803 those features change the meaning of the base standard.  As a result, some
1804 strict-conforming programs may be rejected.  The particular standard
1805 is used by @option{-Wpedantic} to identify which features are GNU
1806 extensions given that version of the standard. For example
1807 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1808 comments, while @option{-std=gnu99 -Wpedantic} does not.
1810 A value for this option must be provided; possible values are
1812 @table @samp
1813 @item c90
1814 @itemx c89
1815 @itemx iso9899:1990
1816 Support all ISO C90 programs (certain GNU extensions that conflict
1817 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1819 @item iso9899:199409
1820 ISO C90 as modified in amendment 1.
1822 @item c99
1823 @itemx c9x
1824 @itemx iso9899:1999
1825 @itemx iso9899:199x
1826 ISO C99.  This standard is substantially completely supported, modulo
1827 bugs and floating-point issues
1828 (mainly but not entirely relating to optional C99 features from
1829 Annexes F and G).  See
1830 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1831 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1833 @item c11
1834 @itemx c1x
1835 @itemx iso9899:2011
1836 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1837 substantially completely supported, modulo bugs, floating-point issues
1838 (mainly but not entirely relating to optional C11 features from
1839 Annexes F and G) and the optional Annexes K (Bounds-checking
1840 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1842 @item c17
1843 @itemx c18
1844 @itemx iso9899:2017
1845 @itemx iso9899:2018
1846 ISO C17, the 2017 revision of the ISO C standard (expected to be
1847 published in 2018).  This standard is
1848 same as C11 except for corrections of defects (all of which are also
1849 applied with @option{-std=c11}) and a new value of
1850 @code{__STDC_VERSION__}, and so is supported to the same extent as C11.
1852 @item gnu90
1853 @itemx gnu89
1854 GNU dialect of ISO C90 (including some C99 features).
1856 @item gnu99
1857 @itemx gnu9x
1858 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1860 @item gnu11
1861 @itemx gnu1x
1862 GNU dialect of ISO C11.
1863 The name @samp{gnu1x} is deprecated.
1865 @item gnu17
1866 @itemx gnu18
1867 GNU dialect of ISO C17.  This is the default for C code.
1869 @item c++98
1870 @itemx c++03
1871 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1872 additional defect reports. Same as @option{-ansi} for C++ code.
1874 @item gnu++98
1875 @itemx gnu++03
1876 GNU dialect of @option{-std=c++98}.
1878 @item c++11
1879 @itemx c++0x
1880 The 2011 ISO C++ standard plus amendments.
1881 The name @samp{c++0x} is deprecated.
1883 @item gnu++11
1884 @itemx gnu++0x
1885 GNU dialect of @option{-std=c++11}.
1886 The name @samp{gnu++0x} is deprecated.
1888 @item c++14
1889 @itemx c++1y
1890 The 2014 ISO C++ standard plus amendments.
1891 The name @samp{c++1y} is deprecated.
1893 @item gnu++14
1894 @itemx gnu++1y
1895 GNU dialect of @option{-std=c++14}.
1896 This is the default for C++ code.
1897 The name @samp{gnu++1y} is deprecated.
1899 @item c++17
1900 @itemx c++1z
1901 The 2017 ISO C++ standard plus amendments.
1902 The name @samp{c++1z} is deprecated.
1904 @item gnu++17
1905 @itemx gnu++1z
1906 GNU dialect of @option{-std=c++17}.
1907 The name @samp{gnu++1z} is deprecated.
1909 @item c++2a
1910 The next revision of the ISO C++ standard, tentatively planned for
1911 2020.  Support is highly experimental, and will almost certainly
1912 change in incompatible ways in future releases.
1914 @item gnu++2a
1915 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1916 and will almost certainly change in incompatible ways in future
1917 releases.
1918 @end table
1920 @item -fgnu89-inline
1921 @opindex fgnu89-inline
1922 The option @option{-fgnu89-inline} tells GCC to use the traditional
1923 GNU semantics for @code{inline} functions when in C99 mode.
1924 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1925 Using this option is roughly equivalent to adding the
1926 @code{gnu_inline} function attribute to all inline functions
1927 (@pxref{Function Attributes}).
1929 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1930 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1931 specifies the default behavior).
1932 This option is not supported in @option{-std=c90} or
1933 @option{-std=gnu90} mode.
1935 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1936 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1937 in effect for @code{inline} functions.  @xref{Common Predefined
1938 Macros,,,cpp,The C Preprocessor}.
1940 @item -fpermitted-flt-eval-methods=@var{style}
1941 @opindex fpermitted-flt-eval-methods
1942 @opindex fpermitted-flt-eval-methods=c11
1943 @opindex fpermitted-flt-eval-methods=ts-18661-3
1944 ISO/IEC TS 18661-3 defines new permissible values for
1945 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1946 a semantic type that is an interchange or extended format should be
1947 evaluated to the precision and range of that type.  These new values are
1948 a superset of those permitted under C99/C11, which does not specify the
1949 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1950 conforming to C11 may not have been written expecting the possibility of
1951 the new values.
1953 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1954 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1955 or the extended set of values specified in ISO/IEC TS 18661-3.
1957 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1959 The default when in a standards compliant mode (@option{-std=c11} or similar)
1960 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1961 dialect (@option{-std=gnu11} or similar) is
1962 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1964 @item -aux-info @var{filename}
1965 @opindex aux-info
1966 Output to the given filename prototyped declarations for all functions
1967 declared and/or defined in a translation unit, including those in header
1968 files.  This option is silently ignored in any language other than C@.
1970 Besides declarations, the file indicates, in comments, the origin of
1971 each declaration (source file and line), whether the declaration was
1972 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1973 @samp{O} for old, respectively, in the first character after the line
1974 number and the colon), and whether it came from a declaration or a
1975 definition (@samp{C} or @samp{F}, respectively, in the following
1976 character).  In the case of function definitions, a K&R-style list of
1977 arguments followed by their declarations is also provided, inside
1978 comments, after the declaration.
1980 @item -fallow-parameterless-variadic-functions
1981 @opindex fallow-parameterless-variadic-functions
1982 Accept variadic functions without named parameters.
1984 Although it is possible to define such a function, this is not very
1985 useful as it is not possible to read the arguments.  This is only
1986 supported for C as this construct is allowed by C++.
1988 @item -fno-asm
1989 @opindex fno-asm
1990 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1991 keyword, so that code can use these words as identifiers.  You can use
1992 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1993 instead.  @option{-ansi} implies @option{-fno-asm}.
1995 In C++, this switch only affects the @code{typeof} keyword, since
1996 @code{asm} and @code{inline} are standard keywords.  You may want to
1997 use the @option{-fno-gnu-keywords} flag instead, which has the same
1998 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1999 switch only affects the @code{asm} and @code{typeof} keywords, since
2000 @code{inline} is a standard keyword in ISO C99.
2002 @item -fno-builtin
2003 @itemx -fno-builtin-@var{function}
2004 @opindex fno-builtin
2005 @cindex built-in functions
2006 Don't recognize built-in functions that do not begin with
2007 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
2008 functions provided by GCC}, for details of the functions affected,
2009 including those which are not built-in functions when @option{-ansi} or
2010 @option{-std} options for strict ISO C conformance are used because they
2011 do not have an ISO standard meaning.
2013 GCC normally generates special code to handle certain built-in functions
2014 more efficiently; for instance, calls to @code{alloca} may become single
2015 instructions which adjust the stack directly, and calls to @code{memcpy}
2016 may become inline copy loops.  The resulting code is often both smaller
2017 and faster, but since the function calls no longer appear as such, you
2018 cannot set a breakpoint on those calls, nor can you change the behavior
2019 of the functions by linking with a different library.  In addition,
2020 when a function is recognized as a built-in function, GCC may use
2021 information about that function to warn about problems with calls to
2022 that function, or to generate more efficient code, even if the
2023 resulting code still contains calls to that function.  For example,
2024 warnings are given with @option{-Wformat} for bad calls to
2025 @code{printf} when @code{printf} is built in and @code{strlen} is
2026 known not to modify global memory.
2028 With the @option{-fno-builtin-@var{function}} option
2029 only the built-in function @var{function} is
2030 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2031 function is named that is not built-in in this version of GCC, this
2032 option is ignored.  There is no corresponding
2033 @option{-fbuiltin-@var{function}} option; if you wish to enable
2034 built-in functions selectively when using @option{-fno-builtin} or
2035 @option{-ffreestanding}, you may define macros such as:
2037 @smallexample
2038 #define abs(n)          __builtin_abs ((n))
2039 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2040 @end smallexample
2042 @item -fgimple
2043 @opindex fgimple
2045 Enable parsing of function definitions marked with @code{__GIMPLE}.
2046 This is an experimental feature that allows unit testing of GIMPLE
2047 passes.
2049 @item -fhosted
2050 @opindex fhosted
2051 @cindex hosted environment
2053 Assert that compilation targets a hosted environment.  This implies
2054 @option{-fbuiltin}.  A hosted environment is one in which the
2055 entire standard library is available, and in which @code{main} has a return
2056 type of @code{int}.  Examples are nearly everything except a kernel.
2057 This is equivalent to @option{-fno-freestanding}.
2059 @item -ffreestanding
2060 @opindex ffreestanding
2061 @cindex hosted environment
2063 Assert that compilation targets a freestanding environment.  This
2064 implies @option{-fno-builtin}.  A freestanding environment
2065 is one in which the standard library may not exist, and program startup may
2066 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2067 This is equivalent to @option{-fno-hosted}.
2069 @xref{Standards,,Language Standards Supported by GCC}, for details of
2070 freestanding and hosted environments.
2072 @item -fopenacc
2073 @opindex fopenacc
2074 @cindex OpenACC accelerator programming
2075 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2076 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2077 compiler generates accelerated code according to the OpenACC Application
2078 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2079 implies @option{-pthread}, and thus is only supported on targets that
2080 have support for @option{-pthread}.
2082 @item -fopenacc-dim=@var{geom}
2083 @opindex fopenacc-dim
2084 @cindex OpenACC accelerator programming
2085 Specify default compute dimensions for parallel offload regions that do
2086 not explicitly specify.  The @var{geom} value is a triple of
2087 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2088 can be omitted, to use a target-specific default value.
2090 @item -fopenmp
2091 @opindex fopenmp
2092 @cindex OpenMP parallel
2093 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2094 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2095 compiler generates parallel code according to the OpenMP Application
2096 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2097 implies @option{-pthread}, and thus is only supported on targets that
2098 have support for @option{-pthread}. @option{-fopenmp} implies
2099 @option{-fopenmp-simd}.
2101 @item -fopenmp-simd
2102 @opindex fopenmp-simd
2103 @cindex OpenMP SIMD
2104 @cindex SIMD
2105 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2106 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2107 are ignored.
2109 @item -fgnu-tm
2110 @opindex fgnu-tm
2111 When the option @option{-fgnu-tm} is specified, the compiler
2112 generates code for the Linux variant of Intel's current Transactional
2113 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2114 an experimental feature whose interface may change in future versions
2115 of GCC, as the official specification changes.  Please note that not
2116 all architectures are supported for this feature.
2118 For more information on GCC's support for transactional memory,
2119 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2120 Transactional Memory Library}.
2122 Note that the transactional memory feature is not supported with
2123 non-call exceptions (@option{-fnon-call-exceptions}).
2125 @item -fms-extensions
2126 @opindex fms-extensions
2127 Accept some non-standard constructs used in Microsoft header files.
2129 In C++ code, this allows member names in structures to be similar
2130 to previous types declarations.
2132 @smallexample
2133 typedef int UOW;
2134 struct ABC @{
2135   UOW UOW;
2137 @end smallexample
2139 Some cases of unnamed fields in structures and unions are only
2140 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2141 fields within structs/unions}, for details.
2143 Note that this option is off for all targets but x86 
2144 targets using ms-abi.
2146 @item -fplan9-extensions
2147 @opindex fplan9-extensions
2148 Accept some non-standard constructs used in Plan 9 code.
2150 This enables @option{-fms-extensions}, permits passing pointers to
2151 structures with anonymous fields to functions that expect pointers to
2152 elements of the type of the field, and permits referring to anonymous
2153 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2154 struct/union fields within structs/unions}, for details.  This is only
2155 supported for C, not C++.
2157 @item -fcond-mismatch
2158 @opindex fcond-mismatch
2159 Allow conditional expressions with mismatched types in the second and
2160 third arguments.  The value of such an expression is void.  This option
2161 is not supported for C++.
2163 @item -flax-vector-conversions
2164 @opindex flax-vector-conversions
2165 Allow implicit conversions between vectors with differing numbers of
2166 elements and/or incompatible element types.  This option should not be
2167 used for new code.
2169 @item -funsigned-char
2170 @opindex funsigned-char
2171 Let the type @code{char} be unsigned, like @code{unsigned char}.
2173 Each kind of machine has a default for what @code{char} should
2174 be.  It is either like @code{unsigned char} by default or like
2175 @code{signed char} by default.
2177 Ideally, a portable program should always use @code{signed char} or
2178 @code{unsigned char} when it depends on the signedness of an object.
2179 But many programs have been written to use plain @code{char} and
2180 expect it to be signed, or expect it to be unsigned, depending on the
2181 machines they were written for.  This option, and its inverse, let you
2182 make such a program work with the opposite default.
2184 The type @code{char} is always a distinct type from each of
2185 @code{signed char} or @code{unsigned char}, even though its behavior
2186 is always just like one of those two.
2188 @item -fsigned-char
2189 @opindex fsigned-char
2190 Let the type @code{char} be signed, like @code{signed char}.
2192 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2193 the negative form of @option{-funsigned-char}.  Likewise, the option
2194 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2196 @item -fsigned-bitfields
2197 @itemx -funsigned-bitfields
2198 @itemx -fno-signed-bitfields
2199 @itemx -fno-unsigned-bitfields
2200 @opindex fsigned-bitfields
2201 @opindex funsigned-bitfields
2202 @opindex fno-signed-bitfields
2203 @opindex fno-unsigned-bitfields
2204 These options control whether a bit-field is signed or unsigned, when the
2205 declaration does not use either @code{signed} or @code{unsigned}.  By
2206 default, such a bit-field is signed, because this is consistent: the
2207 basic integer types such as @code{int} are signed types.
2209 @item -fsso-struct=@var{endianness}
2210 @opindex fsso-struct
2211 Set the default scalar storage order of structures and unions to the
2212 specified endianness.  The accepted values are @samp{big-endian},
2213 @samp{little-endian} and @samp{native} for the native endianness of
2214 the target (the default).  This option is not supported for C++.
2216 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2217 code that is not binary compatible with code generated without it if the
2218 specified endianness is not the native endianness of the target.
2219 @end table
2221 @node C++ Dialect Options
2222 @section Options Controlling C++ Dialect
2224 @cindex compiler options, C++
2225 @cindex C++ options, command-line
2226 @cindex options, C++
2227 This section describes the command-line options that are only meaningful
2228 for C++ programs.  You can also use most of the GNU compiler options
2229 regardless of what language your program is in.  For example, you
2230 might compile a file @file{firstClass.C} like this:
2232 @smallexample
2233 g++ -g -fstrict-enums -O -c firstClass.C
2234 @end smallexample
2236 @noindent
2237 In this example, only @option{-fstrict-enums} is an option meant
2238 only for C++ programs; you can use the other options with any
2239 language supported by GCC@.
2241 Some options for compiling C programs, such as @option{-std}, are also
2242 relevant for C++ programs.
2243 @xref{C Dialect Options,,Options Controlling C Dialect}.
2245 Here is a list of options that are @emph{only} for compiling C++ programs:
2247 @table @gcctabopt
2249 @item -fabi-version=@var{n}
2250 @opindex fabi-version
2251 Use version @var{n} of the C++ ABI@.  The default is version 0.
2253 Version 0 refers to the version conforming most closely to
2254 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2255 will change in different versions of G++ as ABI bugs are fixed.
2257 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2259 Version 2 is the version of the C++ ABI that first appeared in G++
2260 3.4, and was the default through G++ 4.9.
2262 Version 3 corrects an error in mangling a constant address as a
2263 template argument.
2265 Version 4, which first appeared in G++ 4.5, implements a standard
2266 mangling for vector types.
2268 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2269 attribute const/volatile on function pointer types, decltype of a
2270 plain decl, and use of a function parameter in the declaration of
2271 another parameter.
2273 Version 6, which first appeared in G++ 4.7, corrects the promotion
2274 behavior of C++11 scoped enums and the mangling of template argument
2275 packs, const/static_cast, prefix ++ and --, and a class scope function
2276 used as a template argument.
2278 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2279 builtin type and corrects the mangling of lambdas in default argument
2280 scope.
2282 Version 8, which first appeared in G++ 4.9, corrects the substitution
2283 behavior of function types with function-cv-qualifiers.
2285 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2286 @code{nullptr_t}.
2288 Version 10, which first appeared in G++ 6.1, adds mangling of
2289 attributes that affect type identity, such as ia32 calling convention
2290 attributes (e.g. @samp{stdcall}).
2292 Version 11, which first appeared in G++ 7, corrects the mangling of
2293 sizeof... expressions and operator names.  For multiple entities with
2294 the same name within a function, that are declared in different scopes,
2295 the mangling now changes starting with the twelfth occurrence.  It also
2296 implies @option{-fnew-inheriting-ctors}.
2298 See also @option{-Wabi}.
2300 @item -fabi-compat-version=@var{n}
2301 @opindex fabi-compat-version
2302 On targets that support strong aliases, G++
2303 works around mangling changes by creating an alias with the correct
2304 mangled name when defining a symbol with an incorrect mangled name.
2305 This switch specifies which ABI version to use for the alias.
2307 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2308 compatibility).  If another ABI version is explicitly selected, this
2309 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2310 use @option{-fabi-compat-version=2}.
2312 If this option is not provided but @option{-Wabi=@var{n}} is, that
2313 version is used for compatibility aliases.  If this option is provided
2314 along with @option{-Wabi} (without the version), the version from this
2315 option is used for the warning.
2317 @item -fno-access-control
2318 @opindex fno-access-control
2319 Turn off all access checking.  This switch is mainly useful for working
2320 around bugs in the access control code.
2322 @item -faligned-new
2323 @opindex faligned-new
2324 Enable support for C++17 @code{new} of types that require more
2325 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2326 numeric argument such as @code{-faligned-new=32} can be used to
2327 specify how much alignment (in bytes) is provided by that function,
2328 but few users will need to override the default of
2329 @code{alignof(std::max_align_t)}.
2331 This flag is enabled by default for @option{-std=c++17}.
2333 @item -fcheck-new
2334 @opindex fcheck-new
2335 Check that the pointer returned by @code{operator new} is non-null
2336 before attempting to modify the storage allocated.  This check is
2337 normally unnecessary because the C++ standard specifies that
2338 @code{operator new} only returns @code{0} if it is declared
2339 @code{throw()}, in which case the compiler always checks the
2340 return value even without this option.  In all other cases, when
2341 @code{operator new} has a non-empty exception specification, memory
2342 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2343 @samp{new (nothrow)}.
2345 @item -fconcepts
2346 @opindex fconcepts
2347 Enable support for the C++ Extensions for Concepts Technical
2348 Specification, ISO 19217 (2015), which allows code like
2350 @smallexample
2351 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2352 template <Addable T> T add (T a, T b) @{ return a + b; @}
2353 @end smallexample
2355 @item -fconstexpr-depth=@var{n}
2356 @opindex fconstexpr-depth
2357 Set the maximum nested evaluation depth for C++11 constexpr functions
2358 to @var{n}.  A limit is needed to detect endless recursion during
2359 constant expression evaluation.  The minimum specified by the standard
2360 is 512.
2362 @item -fconstexpr-loop-limit=@var{n}
2363 @opindex fconstexpr-loop-limit
2364 Set the maximum number of iterations for a loop in C++14 constexpr functions
2365 to @var{n}.  A limit is needed to detect infinite loops during
2366 constant expression evaluation.  The default is 262144 (1<<18).
2368 @item -fdeduce-init-list
2369 @opindex fdeduce-init-list
2370 Enable deduction of a template type parameter as
2371 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2373 @smallexample
2374 template <class T> auto forward(T t) -> decltype (realfn (t))
2376   return realfn (t);
2379 void f()
2381   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2383 @end smallexample
2385 This deduction was implemented as a possible extension to the
2386 originally proposed semantics for the C++11 standard, but was not part
2387 of the final standard, so it is disabled by default.  This option is
2388 deprecated, and may be removed in a future version of G++.
2390 @item -ffriend-injection
2391 @opindex ffriend-injection
2392 Inject friend functions into the enclosing namespace, so that they are
2393 visible outside the scope of the class in which they are declared.
2394 Friend functions were documented to work this way in the old Annotated
2395 C++ Reference Manual.  
2396 However, in ISO C++ a friend function that is not declared
2397 in an enclosing scope can only be found using argument dependent
2398 lookup.  GCC defaults to the standard behavior.
2400 This option is for compatibility, and may be removed in a future
2401 release of G++.
2403 @item -fno-elide-constructors
2404 @opindex fno-elide-constructors
2405 The C++ standard allows an implementation to omit creating a temporary
2406 that is only used to initialize another object of the same type.
2407 Specifying this option disables that optimization, and forces G++ to
2408 call the copy constructor in all cases.  This option also causes G++
2409 to call trivial member functions which otherwise would be expanded inline.
2411 In C++17, the compiler is required to omit these temporaries, but this
2412 option still affects trivial member functions.
2414 @item -fno-enforce-eh-specs
2415 @opindex fno-enforce-eh-specs
2416 Don't generate code to check for violation of exception specifications
2417 at run time.  This option violates the C++ standard, but may be useful
2418 for reducing code size in production builds, much like defining
2419 @code{NDEBUG}.  This does not give user code permission to throw
2420 exceptions in violation of the exception specifications; the compiler
2421 still optimizes based on the specifications, so throwing an
2422 unexpected exception results in undefined behavior at run time.
2424 @item -fextern-tls-init
2425 @itemx -fno-extern-tls-init
2426 @opindex fextern-tls-init
2427 @opindex fno-extern-tls-init
2428 The C++11 and OpenMP standards allow @code{thread_local} and
2429 @code{threadprivate} variables to have dynamic (runtime)
2430 initialization.  To support this, any use of such a variable goes
2431 through a wrapper function that performs any necessary initialization.
2432 When the use and definition of the variable are in the same
2433 translation unit, this overhead can be optimized away, but when the
2434 use is in a different translation unit there is significant overhead
2435 even if the variable doesn't actually need dynamic initialization.  If
2436 the programmer can be sure that no use of the variable in a
2437 non-defining TU needs to trigger dynamic initialization (either
2438 because the variable is statically initialized, or a use of the
2439 variable in the defining TU will be executed before any uses in
2440 another TU), they can avoid this overhead with the
2441 @option{-fno-extern-tls-init} option.
2443 On targets that support symbol aliases, the default is
2444 @option{-fextern-tls-init}.  On targets that do not support symbol
2445 aliases, the default is @option{-fno-extern-tls-init}.
2447 @item -ffor-scope
2448 @itemx -fno-for-scope
2449 @opindex ffor-scope
2450 @opindex fno-for-scope
2451 If @option{-ffor-scope} is specified, the scope of variables declared in
2452 a @i{for-init-statement} is limited to the @code{for} loop itself,
2453 as specified by the C++ standard.
2454 If @option{-fno-for-scope} is specified, the scope of variables declared in
2455 a @i{for-init-statement} extends to the end of the enclosing scope,
2456 as was the case in old versions of G++, and other (traditional)
2457 implementations of C++.
2459 If neither flag is given, the default is to follow the standard,
2460 but to allow and give a warning for old-style code that would
2461 otherwise be invalid, or have different behavior.
2463 @item -fno-gnu-keywords
2464 @opindex fno-gnu-keywords
2465 Do not recognize @code{typeof} as a keyword, so that code can use this
2466 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2467 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2468 @option{-std=c++98}, @option{-std=c++11}, etc.
2470 @item -fno-implicit-templates
2471 @opindex fno-implicit-templates
2472 Never emit code for non-inline templates that are instantiated
2473 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2474 @xref{Template Instantiation}, for more information.
2476 @item -fno-implicit-inline-templates
2477 @opindex fno-implicit-inline-templates
2478 Don't emit code for implicit instantiations of inline templates, either.
2479 The default is to handle inlines differently so that compiles with and
2480 without optimization need the same set of explicit instantiations.
2482 @item -fno-implement-inlines
2483 @opindex fno-implement-inlines
2484 To save space, do not emit out-of-line copies of inline functions
2485 controlled by @code{#pragma implementation}.  This causes linker
2486 errors if these functions are not inlined everywhere they are called.
2488 @item -fms-extensions
2489 @opindex fms-extensions
2490 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2491 int and getting a pointer to member function via non-standard syntax.
2493 @item -fnew-inheriting-ctors
2494 @opindex fnew-inheriting-ctors
2495 Enable the P0136 adjustment to the semantics of C++11 constructor
2496 inheritance.  This is part of C++17 but also considered to be a Defect
2497 Report against C++11 and C++14.  This flag is enabled by default
2498 unless @option{-fabi-version=10} or lower is specified.
2500 @item -fnew-ttp-matching
2501 @opindex fnew-ttp-matching
2502 Enable the P0522 resolution to Core issue 150, template template
2503 parameters and default arguments: this allows a template with default
2504 template arguments as an argument for a template template parameter
2505 with fewer template parameters.  This flag is enabled by default for
2506 @option{-std=c++17}.
2508 @item -fno-nonansi-builtins
2509 @opindex fno-nonansi-builtins
2510 Disable built-in declarations of functions that are not mandated by
2511 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2512 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2514 @item -fnothrow-opt
2515 @opindex fnothrow-opt
2516 Treat a @code{throw()} exception specification as if it were a
2517 @code{noexcept} specification to reduce or eliminate the text size
2518 overhead relative to a function with no exception specification.  If
2519 the function has local variables of types with non-trivial
2520 destructors, the exception specification actually makes the
2521 function smaller because the EH cleanups for those variables can be
2522 optimized away.  The semantic effect is that an exception thrown out of
2523 a function with such an exception specification results in a call
2524 to @code{terminate} rather than @code{unexpected}.
2526 @item -fno-operator-names
2527 @opindex fno-operator-names
2528 Do not treat the operator name keywords @code{and}, @code{bitand},
2529 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2530 synonyms as keywords.
2532 @item -fno-optional-diags
2533 @opindex fno-optional-diags
2534 Disable diagnostics that the standard says a compiler does not need to
2535 issue.  Currently, the only such diagnostic issued by G++ is the one for
2536 a name having multiple meanings within a class.
2538 @item -fpermissive
2539 @opindex fpermissive
2540 Downgrade some diagnostics about nonconformant code from errors to
2541 warnings.  Thus, using @option{-fpermissive} allows some
2542 nonconforming code to compile.
2544 @item -fno-pretty-templates
2545 @opindex fno-pretty-templates
2546 When an error message refers to a specialization of a function
2547 template, the compiler normally prints the signature of the
2548 template followed by the template arguments and any typedefs or
2549 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2550 rather than @code{void f(int)}) so that it's clear which template is
2551 involved.  When an error message refers to a specialization of a class
2552 template, the compiler omits any template arguments that match
2553 the default template arguments for that template.  If either of these
2554 behaviors make it harder to understand the error message rather than
2555 easier, you can use @option{-fno-pretty-templates} to disable them.
2557 @item -frepo
2558 @opindex frepo
2559 Enable automatic template instantiation at link time.  This option also
2560 implies @option{-fno-implicit-templates}.  @xref{Template
2561 Instantiation}, for more information.
2563 @item -fno-rtti
2564 @opindex fno-rtti
2565 Disable generation of information about every class with virtual
2566 functions for use by the C++ run-time type identification features
2567 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2568 of the language, you can save some space by using this flag.  Note that
2569 exception handling uses the same information, but G++ generates it as
2570 needed. The @code{dynamic_cast} operator can still be used for casts that
2571 do not require run-time type information, i.e.@: casts to @code{void *} or to
2572 unambiguous base classes.
2574 @item -fsized-deallocation
2575 @opindex fsized-deallocation
2576 Enable the built-in global declarations
2577 @smallexample
2578 void operator delete (void *, std::size_t) noexcept;
2579 void operator delete[] (void *, std::size_t) noexcept;
2580 @end smallexample
2581 as introduced in C++14.  This is useful for user-defined replacement
2582 deallocation functions that, for example, use the size of the object
2583 to make deallocation faster.  Enabled by default under
2584 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2585 warns about places that might want to add a definition.
2587 @item -fstrict-enums
2588 @opindex fstrict-enums
2589 Allow the compiler to optimize using the assumption that a value of
2590 enumerated type can only be one of the values of the enumeration (as
2591 defined in the C++ standard; basically, a value that can be
2592 represented in the minimum number of bits needed to represent all the
2593 enumerators).  This assumption may not be valid if the program uses a
2594 cast to convert an arbitrary integer value to the enumerated type.
2596 @item -fstrong-eval-order
2597 @opindex fstrong-eval-order
2598 Evaluate member access, array subscripting, and shift expressions in
2599 left-to-right order, and evaluate assignment in right-to-left order,
2600 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2601 @option{-fstrong-eval-order=some} enables just the ordering of member
2602 access and shift expressions, and is the default without
2603 @option{-std=c++17}.
2605 @item -ftemplate-backtrace-limit=@var{n}
2606 @opindex ftemplate-backtrace-limit
2607 Set the maximum number of template instantiation notes for a single
2608 warning or error to @var{n}.  The default value is 10.
2610 @item -ftemplate-depth=@var{n}
2611 @opindex ftemplate-depth
2612 Set the maximum instantiation depth for template classes to @var{n}.
2613 A limit on the template instantiation depth is needed to detect
2614 endless recursions during template class instantiation.  ANSI/ISO C++
2615 conforming programs must not rely on a maximum depth greater than 17
2616 (changed to 1024 in C++11).  The default value is 900, as the compiler
2617 can run out of stack space before hitting 1024 in some situations.
2619 @item -fno-threadsafe-statics
2620 @opindex fno-threadsafe-statics
2621 Do not emit the extra code to use the routines specified in the C++
2622 ABI for thread-safe initialization of local statics.  You can use this
2623 option to reduce code size slightly in code that doesn't need to be
2624 thread-safe.
2626 @item -fuse-cxa-atexit
2627 @opindex fuse-cxa-atexit
2628 Register destructors for objects with static storage duration with the
2629 @code{__cxa_atexit} function rather than the @code{atexit} function.
2630 This option is required for fully standards-compliant handling of static
2631 destructors, but only works if your C library supports
2632 @code{__cxa_atexit}.
2634 @item -fno-use-cxa-get-exception-ptr
2635 @opindex fno-use-cxa-get-exception-ptr
2636 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2637 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2638 if the runtime routine is not available.
2640 @item -fvisibility-inlines-hidden
2641 @opindex fvisibility-inlines-hidden
2642 This switch declares that the user does not attempt to compare
2643 pointers to inline functions or methods where the addresses of the two functions
2644 are taken in different shared objects.
2646 The effect of this is that GCC may, effectively, mark inline methods with
2647 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2648 appear in the export table of a DSO and do not require a PLT indirection
2649 when used within the DSO@.  Enabling this option can have a dramatic effect
2650 on load and link times of a DSO as it massively reduces the size of the
2651 dynamic export table when the library makes heavy use of templates.
2653 The behavior of this switch is not quite the same as marking the
2654 methods as hidden directly, because it does not affect static variables
2655 local to the function or cause the compiler to deduce that
2656 the function is defined in only one shared object.
2658 You may mark a method as having a visibility explicitly to negate the
2659 effect of the switch for that method.  For example, if you do want to
2660 compare pointers to a particular inline method, you might mark it as
2661 having default visibility.  Marking the enclosing class with explicit
2662 visibility has no effect.
2664 Explicitly instantiated inline methods are unaffected by this option
2665 as their linkage might otherwise cross a shared library boundary.
2666 @xref{Template Instantiation}.
2668 @item -fvisibility-ms-compat
2669 @opindex fvisibility-ms-compat
2670 This flag attempts to use visibility settings to make GCC's C++
2671 linkage model compatible with that of Microsoft Visual Studio.
2673 The flag makes these changes to GCC's linkage model:
2675 @enumerate
2676 @item
2677 It sets the default visibility to @code{hidden}, like
2678 @option{-fvisibility=hidden}.
2680 @item
2681 Types, but not their members, are not hidden by default.
2683 @item
2684 The One Definition Rule is relaxed for types without explicit
2685 visibility specifications that are defined in more than one
2686 shared object: those declarations are permitted if they are
2687 permitted when this option is not used.
2688 @end enumerate
2690 In new code it is better to use @option{-fvisibility=hidden} and
2691 export those classes that are intended to be externally visible.
2692 Unfortunately it is possible for code to rely, perhaps accidentally,
2693 on the Visual Studio behavior.
2695 Among the consequences of these changes are that static data members
2696 of the same type with the same name but defined in different shared
2697 objects are different, so changing one does not change the other;
2698 and that pointers to function members defined in different shared
2699 objects may not compare equal.  When this flag is given, it is a
2700 violation of the ODR to define types with the same name differently.
2702 @item -fno-weak
2703 @opindex fno-weak
2704 Do not use weak symbol support, even if it is provided by the linker.
2705 By default, G++ uses weak symbols if they are available.  This
2706 option exists only for testing, and should not be used by end-users;
2707 it results in inferior code and has no benefits.  This option may
2708 be removed in a future release of G++.
2710 @item -nostdinc++
2711 @opindex nostdinc++
2712 Do not search for header files in the standard directories specific to
2713 C++, but do still search the other standard directories.  (This option
2714 is used when building the C++ library.)
2715 @end table
2717 In addition, these optimization, warning, and code generation options
2718 have meanings only for C++ programs:
2720 @table @gcctabopt
2721 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2722 @opindex Wabi
2723 @opindex Wno-abi
2724 Warn when G++ it generates code that is probably not compatible with
2725 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2726 ABI with each major release, normally @option{-Wabi} will warn only if
2727 there is a check added later in a release series for an ABI issue
2728 discovered since the initial release.  @option{-Wabi} will warn about
2729 more things if an older ABI version is selected (with
2730 @option{-fabi-version=@var{n}}).
2732 @option{-Wabi} can also be used with an explicit version number to
2733 warn about compatibility with a particular @option{-fabi-version}
2734 level, e.g. @option{-Wabi=2} to warn about changes relative to
2735 @option{-fabi-version=2}.
2737 If an explicit version number is provided and
2738 @option{-fabi-compat-version} is not specified, the version number
2739 from this option is used for compatibility aliases.  If no explicit
2740 version number is provided with this option, but
2741 @option{-fabi-compat-version} is specified, that version number is
2742 used for ABI warnings.
2744 Although an effort has been made to warn about
2745 all such cases, there are probably some cases that are not warned about,
2746 even though G++ is generating incompatible code.  There may also be
2747 cases where warnings are emitted even though the code that is generated
2748 is compatible.
2750 You should rewrite your code to avoid these warnings if you are
2751 concerned about the fact that code generated by G++ may not be binary
2752 compatible with code generated by other compilers.
2754 Known incompatibilities in @option{-fabi-version=2} (which was the
2755 default from GCC 3.4 to 4.9) include:
2757 @itemize @bullet
2759 @item
2760 A template with a non-type template parameter of reference type was
2761 mangled incorrectly:
2762 @smallexample
2763 extern int N;
2764 template <int &> struct S @{@};
2765 void n (S<N>) @{2@}
2766 @end smallexample
2768 This was fixed in @option{-fabi-version=3}.
2770 @item
2771 SIMD vector types declared using @code{__attribute ((vector_size))} were
2772 mangled in a non-standard way that does not allow for overloading of
2773 functions taking vectors of different sizes.
2775 The mangling was changed in @option{-fabi-version=4}.
2777 @item
2778 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2779 qualifiers, and @code{decltype} of a plain declaration was folded away.
2781 These mangling issues were fixed in @option{-fabi-version=5}.
2783 @item
2784 Scoped enumerators passed as arguments to a variadic function are
2785 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2786 On most targets this does not actually affect the parameter passing
2787 ABI, as there is no way to pass an argument smaller than @code{int}.
2789 Also, the ABI changed the mangling of template argument packs,
2790 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2791 a class scope function used as a template argument.
2793 These issues were corrected in @option{-fabi-version=6}.
2795 @item
2796 Lambdas in default argument scope were mangled incorrectly, and the
2797 ABI changed the mangling of @code{nullptr_t}.
2799 These issues were corrected in @option{-fabi-version=7}.
2801 @item
2802 When mangling a function type with function-cv-qualifiers, the
2803 un-qualified function type was incorrectly treated as a substitution
2804 candidate.
2806 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2808 @item
2809 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2810 unaligned accesses.  Note that this did not affect the ABI of a
2811 function with a @code{nullptr_t} parameter, as parameters have a
2812 minimum alignment.
2814 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2816 @item
2817 Target-specific attributes that affect the identity of a type, such as
2818 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2819 did not affect the mangled name, leading to name collisions when
2820 function pointers were used as template arguments.
2822 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2824 @end itemize
2826 It also warns about psABI-related changes.  The known psABI changes at this
2827 point include:
2829 @itemize @bullet
2831 @item
2832 For SysV/x86-64, unions with @code{long double} members are 
2833 passed in memory as specified in psABI.  For example:
2835 @smallexample
2836 union U @{
2837   long double ld;
2838   int i;
2840 @end smallexample
2842 @noindent
2843 @code{union U} is always passed in memory.
2845 @end itemize
2847 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2848 @opindex Wabi-tag
2849 @opindex -Wabi-tag
2850 Warn when a type with an ABI tag is used in a context that does not
2851 have that ABI tag.  See @ref{C++ Attributes} for more information
2852 about ABI tags.
2854 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2855 @opindex Wctor-dtor-privacy
2856 @opindex Wno-ctor-dtor-privacy
2857 Warn when a class seems unusable because all the constructors or
2858 destructors in that class are private, and it has neither friends nor
2859 public static member functions.  Also warn if there are no non-private
2860 methods, and there's at least one private member function that isn't
2861 a constructor or destructor.
2863 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2864 @opindex Wdelete-non-virtual-dtor
2865 @opindex Wno-delete-non-virtual-dtor
2866 Warn when @code{delete} is used to destroy an instance of a class that
2867 has virtual functions and non-virtual destructor. It is unsafe to delete
2868 an instance of a derived class through a pointer to a base class if the
2869 base class does not have a virtual destructor.  This warning is enabled
2870 by @option{-Wall}.
2872 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2873 @opindex Wliteral-suffix
2874 @opindex Wno-literal-suffix
2875 Warn when a string or character literal is followed by a ud-suffix which does
2876 not begin with an underscore.  As a conforming extension, GCC treats such
2877 suffixes as separate preprocessing tokens in order to maintain backwards
2878 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2879 For example:
2881 @smallexample
2882 #define __STDC_FORMAT_MACROS
2883 #include <inttypes.h>
2884 #include <stdio.h>
2886 int main() @{
2887   int64_t i64 = 123;
2888   printf("My int64: %" PRId64"\n", i64);
2890 @end smallexample
2892 In this case, @code{PRId64} is treated as a separate preprocessing token.
2894 Additionally, warn when a user-defined literal operator is declared with
2895 a literal suffix identifier that doesn't begin with an underscore. Literal
2896 suffix identifiers that don't begin with an underscore are reserved for
2897 future standardization.
2899 This warning is enabled by default.
2901 @item -Wlto-type-mismatch
2902 @opindex Wlto-type-mismatch
2903 @opindex Wno-lto-type-mismatch
2905 During the link-time optimization warn about type mismatches in
2906 global declarations from different compilation units.
2907 Requires @option{-flto} to be enabled.  Enabled by default.
2909 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2910 @opindex Wnarrowing
2911 @opindex Wno-narrowing
2912 For C++11 and later standards, narrowing conversions are diagnosed by default,
2913 as required by the standard.  A narrowing conversion from a constant produces
2914 an error, and a narrowing conversion from a non-constant produces a warning,
2915 but @option{-Wno-narrowing} suppresses the diagnostic.
2916 Note that this does not affect the meaning of well-formed code;
2917 narrowing conversions are still considered ill-formed in SFINAE contexts.
2919 With @option{-Wnarrowing} in C++98, warn when a narrowing
2920 conversion prohibited by C++11 occurs within
2921 @samp{@{ @}}, e.g.
2923 @smallexample
2924 int i = @{ 2.2 @}; // error: narrowing from double to int
2925 @end smallexample
2927 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2929 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2930 @opindex Wnoexcept
2931 @opindex Wno-noexcept
2932 Warn when a noexcept-expression evaluates to false because of a call
2933 to a function that does not have a non-throwing exception
2934 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2935 the compiler to never throw an exception.
2937 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2938 @opindex Wnoexcept-type
2939 @opindex Wno-noexcept-type
2940 Warn if the C++17 feature making @code{noexcept} part of a function
2941 type changes the mangled name of a symbol relative to C++14.  Enabled
2942 by @option{-Wabi} and @option{-Wc++17-compat}.
2944 As an example:
2946 @smallexample
2947 template <class T> void f(T t) @{ t(); @};
2948 void g() noexcept;
2949 void h() @{ f(g); @} 
2950 @end smallexample
2952 @noindent
2953 In C++14, @code{f} calls calls @code{f<void(*)()>}, but in
2954 C++17 it calls @code{f<void(*)()noexcept>}.
2956 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2957 @opindex Wclass-memaccess
2958 Warn when the destination of a call to a raw memory function such as
2959 @code{memset} or @code{memcpy} is an object of class type writing into which
2960 might bypass the class non-trivial or deleted constructor or copy assignment,
2961 violate const-correctness or encapsulation, or corrupt the virtual table.
2962 Modifying the representation of such objects may violate invariants maintained
2963 by member functions of the class.  For example, the call to @code{memset}
2964 below is undefined because it modifies a non-trivial class object and is,
2965 therefore, diagnosed.  The safe way to either initialize or clear the storage
2966 of objects of such types is by using the appropriate constructor or assignment
2967 operator, if one is available.
2968 @smallexample
2969 std::string str = "abc";
2970 memset (&str, 0, 3);
2971 @end smallexample
2972 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2974 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2975 @opindex Wnon-virtual-dtor
2976 @opindex Wno-non-virtual-dtor
2977 Warn when a class has virtual functions and an accessible non-virtual
2978 destructor itself or in an accessible polymorphic base class, in which
2979 case it is possible but unsafe to delete an instance of a derived
2980 class through a pointer to the class itself or base class.  This
2981 warning is automatically enabled if @option{-Weffc++} is specified.
2983 @item -Wregister @r{(C++ and Objective-C++ only)}
2984 @opindex Wregister
2985 @opindex Wno-register
2986 Warn on uses of the @code{register} storage class specifier, except
2987 when it is part of the GNU @ref{Explicit Register Variables} extension.
2988 The use of the @code{register} keyword as storage class specifier has
2989 been deprecated in C++11 and removed in C++17.
2990 Enabled by default with @option{-std=c++17}.
2992 @item -Wreorder @r{(C++ and Objective-C++ only)}
2993 @opindex Wreorder
2994 @opindex Wno-reorder
2995 @cindex reordering, warning
2996 @cindex warning for reordering of member initializers
2997 Warn when the order of member initializers given in the code does not
2998 match the order in which they must be executed.  For instance:
3000 @smallexample
3001 struct A @{
3002   int i;
3003   int j;
3004   A(): j (0), i (1) @{ @}
3006 @end smallexample
3008 @noindent
3009 The compiler rearranges the member initializers for @code{i}
3010 and @code{j} to match the declaration order of the members, emitting
3011 a warning to that effect.  This warning is enabled by @option{-Wall}.
3013 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
3014 @opindex fext-numeric-literals
3015 @opindex fno-ext-numeric-literals
3016 Accept imaginary, fixed-point, or machine-defined
3017 literal number suffixes as GNU extensions.
3018 When this option is turned off these suffixes are treated
3019 as C++11 user-defined literal numeric suffixes.
3020 This is on by default for all pre-C++11 dialects and all GNU dialects:
3021 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3022 @option{-std=gnu++14}.
3023 This option is off by default
3024 for ISO C++11 onwards (@option{-std=c++11}, ...).
3025 @end table
3027 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3029 @table @gcctabopt
3030 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3031 @opindex Weffc++
3032 @opindex Wno-effc++
3033 Warn about violations of the following style guidelines from Scott Meyers'
3034 @cite{Effective C++} series of books:
3036 @itemize @bullet
3037 @item
3038 Define a copy constructor and an assignment operator for classes
3039 with dynamically-allocated memory.
3041 @item
3042 Prefer initialization to assignment in constructors.
3044 @item
3045 Have @code{operator=} return a reference to @code{*this}.
3047 @item
3048 Don't try to return a reference when you must return an object.
3050 @item
3051 Distinguish between prefix and postfix forms of increment and
3052 decrement operators.
3054 @item
3055 Never overload @code{&&}, @code{||}, or @code{,}.
3057 @end itemize
3059 This option also enables @option{-Wnon-virtual-dtor}, which is also
3060 one of the effective C++ recommendations.  However, the check is
3061 extended to warn about the lack of virtual destructor in accessible
3062 non-polymorphic bases classes too.
3064 When selecting this option, be aware that the standard library
3065 headers do not obey all of these guidelines; use @samp{grep -v}
3066 to filter out those warnings.
3068 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3069 @opindex Wstrict-null-sentinel
3070 @opindex Wno-strict-null-sentinel
3071 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3072 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3073 to @code{__null}.  Although it is a null pointer constant rather than a
3074 null pointer, it is guaranteed to be of the same size as a pointer.
3075 But this use is not portable across different compilers.
3077 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3078 @opindex Wno-non-template-friend
3079 @opindex Wnon-template-friend
3080 Disable warnings when non-template friend functions are declared
3081 within a template.  In very old versions of GCC that predate implementation
3082 of the ISO standard, declarations such as 
3083 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3084 could be interpreted as a particular specialization of a template
3085 function; the warning exists to diagnose compatibility problems, 
3086 and is enabled by default.
3088 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3089 @opindex Wold-style-cast
3090 @opindex Wno-old-style-cast
3091 Warn if an old-style (C-style) cast to a non-void type is used within
3092 a C++ program.  The new-style casts (@code{dynamic_cast},
3093 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3094 less vulnerable to unintended effects and much easier to search for.
3096 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3097 @opindex Woverloaded-virtual
3098 @opindex Wno-overloaded-virtual
3099 @cindex overloaded virtual function, warning
3100 @cindex warning for overloaded virtual function
3101 Warn when a function declaration hides virtual functions from a
3102 base class.  For example, in:
3104 @smallexample
3105 struct A @{
3106   virtual void f();
3109 struct B: public A @{
3110   void f(int);
3112 @end smallexample
3114 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3115 like:
3117 @smallexample
3118 B* b;
3119 b->f();
3120 @end smallexample
3122 @noindent
3123 fails to compile.
3125 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3126 @opindex Wno-pmf-conversions
3127 @opindex Wpmf-conversions
3128 Disable the diagnostic for converting a bound pointer to member function
3129 to a plain pointer.
3131 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3132 @opindex Wsign-promo
3133 @opindex Wno-sign-promo
3134 Warn when overload resolution chooses a promotion from unsigned or
3135 enumerated type to a signed type, over a conversion to an unsigned type of
3136 the same size.  Previous versions of G++ tried to preserve
3137 unsignedness, but the standard mandates the current behavior.
3139 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3140 @opindex Wtemplates
3141 Warn when a primary template declaration is encountered.  Some coding
3142 rules disallow templates, and this may be used to enforce that rule.
3143 The warning is inactive inside a system header file, such as the STL, so
3144 one can still use the STL.  One may also instantiate or specialize
3145 templates.
3147 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3148 @opindex Wmultiple-inheritance
3149 Warn when a class is defined with multiple direct base classes.  Some
3150 coding rules disallow multiple inheritance, and this may be used to
3151 enforce that rule.  The warning is inactive inside a system header file,
3152 such as the STL, so one can still use the STL.  One may also define
3153 classes that indirectly use multiple inheritance.
3155 @item -Wvirtual-inheritance
3156 @opindex Wvirtual-inheritance
3157 Warn when a class is defined with a virtual direct base class.  Some
3158 coding rules disallow multiple inheritance, and this may be used to
3159 enforce that rule.  The warning is inactive inside a system header file,
3160 such as the STL, so one can still use the STL.  One may also define
3161 classes that indirectly use virtual inheritance.
3163 @item -Wnamespaces
3164 @opindex Wnamespaces
3165 Warn when a namespace definition is opened.  Some coding rules disallow
3166 namespaces, and this may be used to enforce that rule.  The warning is
3167 inactive inside a system header file, such as the STL, so one can still
3168 use the STL.  One may also use using directives and qualified names.
3170 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3171 @opindex Wterminate
3172 @opindex Wno-terminate
3173 Disable the warning about a throw-expression that will immediately
3174 result in a call to @code{terminate}.
3175 @end table
3177 @node Objective-C and Objective-C++ Dialect Options
3178 @section Options Controlling Objective-C and Objective-C++ Dialects
3180 @cindex compiler options, Objective-C and Objective-C++
3181 @cindex Objective-C and Objective-C++ options, command-line
3182 @cindex options, Objective-C and Objective-C++
3183 (NOTE: This manual does not describe the Objective-C and Objective-C++
3184 languages themselves.  @xref{Standards,,Language Standards
3185 Supported by GCC}, for references.)
3187 This section describes the command-line options that are only meaningful
3188 for Objective-C and Objective-C++ programs.  You can also use most of
3189 the language-independent GNU compiler options.
3190 For example, you might compile a file @file{some_class.m} like this:
3192 @smallexample
3193 gcc -g -fgnu-runtime -O -c some_class.m
3194 @end smallexample
3196 @noindent
3197 In this example, @option{-fgnu-runtime} is an option meant only for
3198 Objective-C and Objective-C++ programs; you can use the other options with
3199 any language supported by GCC@.
3201 Note that since Objective-C is an extension of the C language, Objective-C
3202 compilations may also use options specific to the C front-end (e.g.,
3203 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3204 C++-specific options (e.g., @option{-Wabi}).
3206 Here is a list of options that are @emph{only} for compiling Objective-C
3207 and Objective-C++ programs:
3209 @table @gcctabopt
3210 @item -fconstant-string-class=@var{class-name}
3211 @opindex fconstant-string-class
3212 Use @var{class-name} as the name of the class to instantiate for each
3213 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3214 class name is @code{NXConstantString} if the GNU runtime is being used, and
3215 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3216 @option{-fconstant-cfstrings} option, if also present, overrides the
3217 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3218 to be laid out as constant CoreFoundation strings.
3220 @item -fgnu-runtime
3221 @opindex fgnu-runtime
3222 Generate object code compatible with the standard GNU Objective-C
3223 runtime.  This is the default for most types of systems.
3225 @item -fnext-runtime
3226 @opindex fnext-runtime
3227 Generate output compatible with the NeXT runtime.  This is the default
3228 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3229 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3230 used.
3232 @item -fno-nil-receivers
3233 @opindex fno-nil-receivers
3234 Assume that all Objective-C message dispatches (@code{[receiver
3235 message:arg]}) in this translation unit ensure that the receiver is
3236 not @code{nil}.  This allows for more efficient entry points in the
3237 runtime to be used.  This option is only available in conjunction with
3238 the NeXT runtime and ABI version 0 or 1.
3240 @item -fobjc-abi-version=@var{n}
3241 @opindex fobjc-abi-version
3242 Use version @var{n} of the Objective-C ABI for the selected runtime.
3243 This option is currently supported only for the NeXT runtime.  In that
3244 case, Version 0 is the traditional (32-bit) ABI without support for
3245 properties and other Objective-C 2.0 additions.  Version 1 is the
3246 traditional (32-bit) ABI with support for properties and other
3247 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3248 nothing is specified, the default is Version 0 on 32-bit target
3249 machines, and Version 2 on 64-bit target machines.
3251 @item -fobjc-call-cxx-cdtors
3252 @opindex fobjc-call-cxx-cdtors
3253 For each Objective-C class, check if any of its instance variables is a
3254 C++ object with a non-trivial default constructor.  If so, synthesize a
3255 special @code{- (id) .cxx_construct} instance method which runs
3256 non-trivial default constructors on any such instance variables, in order,
3257 and then return @code{self}.  Similarly, check if any instance variable
3258 is a C++ object with a non-trivial destructor, and if so, synthesize a
3259 special @code{- (void) .cxx_destruct} method which runs
3260 all such default destructors, in reverse order.
3262 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3263 methods thusly generated only operate on instance variables
3264 declared in the current Objective-C class, and not those inherited
3265 from superclasses.  It is the responsibility of the Objective-C
3266 runtime to invoke all such methods in an object's inheritance
3267 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3268 by the runtime immediately after a new object instance is allocated;
3269 the @code{- (void) .cxx_destruct} methods are invoked immediately
3270 before the runtime deallocates an object instance.
3272 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3273 support for invoking the @code{- (id) .cxx_construct} and
3274 @code{- (void) .cxx_destruct} methods.
3276 @item -fobjc-direct-dispatch
3277 @opindex fobjc-direct-dispatch
3278 Allow fast jumps to the message dispatcher.  On Darwin this is
3279 accomplished via the comm page.
3281 @item -fobjc-exceptions
3282 @opindex fobjc-exceptions
3283 Enable syntactic support for structured exception handling in
3284 Objective-C, similar to what is offered by C++.  This option
3285 is required to use the Objective-C keywords @code{@@try},
3286 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3287 @code{@@synchronized}.  This option is available with both the GNU
3288 runtime and the NeXT runtime (but not available in conjunction with
3289 the NeXT runtime on Mac OS X 10.2 and earlier).
3291 @item -fobjc-gc
3292 @opindex fobjc-gc
3293 Enable garbage collection (GC) in Objective-C and Objective-C++
3294 programs.  This option is only available with the NeXT runtime; the
3295 GNU runtime has a different garbage collection implementation that
3296 does not require special compiler flags.
3298 @item -fobjc-nilcheck
3299 @opindex fobjc-nilcheck
3300 For the NeXT runtime with version 2 of the ABI, check for a nil
3301 receiver in method invocations before doing the actual method call.
3302 This is the default and can be disabled using
3303 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3304 checked for nil in this way no matter what this flag is set to.
3305 Currently this flag does nothing when the GNU runtime, or an older
3306 version of the NeXT runtime ABI, is used.
3308 @item -fobjc-std=objc1
3309 @opindex fobjc-std
3310 Conform to the language syntax of Objective-C 1.0, the language
3311 recognized by GCC 4.0.  This only affects the Objective-C additions to
3312 the C/C++ language; it does not affect conformance to C/C++ standards,
3313 which is controlled by the separate C/C++ dialect option flags.  When
3314 this option is used with the Objective-C or Objective-C++ compiler,
3315 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3316 This is useful if you need to make sure that your Objective-C code can
3317 be compiled with older versions of GCC@.
3319 @item -freplace-objc-classes
3320 @opindex freplace-objc-classes
3321 Emit a special marker instructing @command{ld(1)} not to statically link in
3322 the resulting object file, and allow @command{dyld(1)} to load it in at
3323 run time instead.  This is used in conjunction with the Fix-and-Continue
3324 debugging mode, where the object file in question may be recompiled and
3325 dynamically reloaded in the course of program execution, without the need
3326 to restart the program itself.  Currently, Fix-and-Continue functionality
3327 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3328 and later.
3330 @item -fzero-link
3331 @opindex fzero-link
3332 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3333 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3334 compile time) with static class references that get initialized at load time,
3335 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3336 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3337 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3338 for individual class implementations to be modified during program execution.
3339 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3340 regardless of command-line options.
3342 @item -fno-local-ivars
3343 @opindex fno-local-ivars
3344 @opindex flocal-ivars
3345 By default instance variables in Objective-C can be accessed as if
3346 they were local variables from within the methods of the class they're
3347 declared in.  This can lead to shadowing between instance variables
3348 and other variables declared either locally inside a class method or
3349 globally with the same name.  Specifying the @option{-fno-local-ivars}
3350 flag disables this behavior thus avoiding variable shadowing issues.
3352 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3353 @opindex fivar-visibility
3354 Set the default instance variable visibility to the specified option
3355 so that instance variables declared outside the scope of any access
3356 modifier directives default to the specified visibility.
3358 @item -gen-decls
3359 @opindex gen-decls
3360 Dump interface declarations for all classes seen in the source file to a
3361 file named @file{@var{sourcename}.decl}.
3363 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3364 @opindex Wassign-intercept
3365 @opindex Wno-assign-intercept
3366 Warn whenever an Objective-C assignment is being intercepted by the
3367 garbage collector.
3369 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3370 @opindex Wno-protocol
3371 @opindex Wprotocol
3372 If a class is declared to implement a protocol, a warning is issued for
3373 every method in the protocol that is not implemented by the class.  The
3374 default behavior is to issue a warning for every method not explicitly
3375 implemented in the class, even if a method implementation is inherited
3376 from the superclass.  If you use the @option{-Wno-protocol} option, then
3377 methods inherited from the superclass are considered to be implemented,
3378 and no warning is issued for them.
3380 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3381 @opindex Wselector
3382 @opindex Wno-selector
3383 Warn if multiple methods of different types for the same selector are
3384 found during compilation.  The check is performed on the list of methods
3385 in the final stage of compilation.  Additionally, a check is performed
3386 for each selector appearing in a @code{@@selector(@dots{})}
3387 expression, and a corresponding method for that selector has been found
3388 during compilation.  Because these checks scan the method table only at
3389 the end of compilation, these warnings are not produced if the final
3390 stage of compilation is not reached, for example because an error is
3391 found during compilation, or because the @option{-fsyntax-only} option is
3392 being used.
3394 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3395 @opindex Wstrict-selector-match
3396 @opindex Wno-strict-selector-match
3397 Warn if multiple methods with differing argument and/or return types are
3398 found for a given selector when attempting to send a message using this
3399 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3400 is off (which is the default behavior), the compiler omits such warnings
3401 if any differences found are confined to types that share the same size
3402 and alignment.
3404 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3405 @opindex Wundeclared-selector
3406 @opindex Wno-undeclared-selector
3407 Warn if a @code{@@selector(@dots{})} expression referring to an
3408 undeclared selector is found.  A selector is considered undeclared if no
3409 method with that name has been declared before the
3410 @code{@@selector(@dots{})} expression, either explicitly in an
3411 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3412 an @code{@@implementation} section.  This option always performs its
3413 checks as soon as a @code{@@selector(@dots{})} expression is found,
3414 while @option{-Wselector} only performs its checks in the final stage of
3415 compilation.  This also enforces the coding style convention
3416 that methods and selectors must be declared before being used.
3418 @item -print-objc-runtime-info
3419 @opindex print-objc-runtime-info
3420 Generate C header describing the largest structure that is passed by
3421 value, if any.
3423 @end table
3425 @node Diagnostic Message Formatting Options
3426 @section Options to Control Diagnostic Messages Formatting
3427 @cindex options to control diagnostics formatting
3428 @cindex diagnostic messages
3429 @cindex message formatting
3431 Traditionally, diagnostic messages have been formatted irrespective of
3432 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3433 options described below
3434 to control the formatting algorithm for diagnostic messages, 
3435 e.g.@: how many characters per line, how often source location
3436 information should be reported.  Note that some language front ends may not
3437 honor these options.
3439 @table @gcctabopt
3440 @item -fmessage-length=@var{n}
3441 @opindex fmessage-length
3442 Try to format error messages so that they fit on lines of about
3443 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3444 done; each error message appears on a single line.  This is the
3445 default for all front ends.
3447 @item -fdiagnostics-show-location=once
3448 @opindex fdiagnostics-show-location
3449 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3450 reporter to emit source location information @emph{once}; that is, in
3451 case the message is too long to fit on a single physical line and has to
3452 be wrapped, the source location won't be emitted (as prefix) again,
3453 over and over, in subsequent continuation lines.  This is the default
3454 behavior.
3456 @item -fdiagnostics-show-location=every-line
3457 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3458 messages reporter to emit the same source location information (as
3459 prefix) for physical lines that result from the process of breaking
3460 a message which is too long to fit on a single line.
3462 @item -fdiagnostics-color[=@var{WHEN}]
3463 @itemx -fno-diagnostics-color
3464 @opindex fdiagnostics-color
3465 @cindex highlight, color
3466 @vindex GCC_COLORS @r{environment variable}
3467 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3468 or @samp{auto}.  The default depends on how the compiler has been configured,
3469 it can be any of the above @var{WHEN} options or also @samp{never}
3470 if @env{GCC_COLORS} environment variable isn't present in the environment,
3471 and @samp{auto} otherwise.
3472 @samp{auto} means to use color only when the standard error is a terminal.
3473 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3474 aliases for @option{-fdiagnostics-color=always} and
3475 @option{-fdiagnostics-color=never}, respectively.
3477 The colors are defined by the environment variable @env{GCC_COLORS}.
3478 Its value is a colon-separated list of capabilities and Select Graphic
3479 Rendition (SGR) substrings. SGR commands are interpreted by the
3480 terminal or terminal emulator.  (See the section in the documentation
3481 of your text terminal for permitted values and their meanings as
3482 character attributes.)  These substring values are integers in decimal
3483 representation and can be concatenated with semicolons.
3484 Common values to concatenate include
3485 @samp{1} for bold,
3486 @samp{4} for underline,
3487 @samp{5} for blink,
3488 @samp{7} for inverse,
3489 @samp{39} for default foreground color,
3490 @samp{30} to @samp{37} for foreground colors,
3491 @samp{90} to @samp{97} for 16-color mode foreground colors,
3492 @samp{38;5;0} to @samp{38;5;255}
3493 for 88-color and 256-color modes foreground colors,
3494 @samp{49} for default background color,
3495 @samp{40} to @samp{47} for background colors,
3496 @samp{100} to @samp{107} for 16-color mode background colors,
3497 and @samp{48;5;0} to @samp{48;5;255}
3498 for 88-color and 256-color modes background colors.
3500 The default @env{GCC_COLORS} is
3501 @smallexample
3502 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3503 quote=01:fixit-insert=32:fixit-delete=31:\
3504 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3505 type-diff=01;32
3506 @end smallexample
3507 @noindent
3508 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3509 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3510 @samp{01} is bold, and @samp{31} is red.
3511 Setting @env{GCC_COLORS} to the empty string disables colors.
3512 Supported capabilities are as follows.
3514 @table @code
3515 @item error=
3516 @vindex error GCC_COLORS @r{capability}
3517 SGR substring for error: markers.
3519 @item warning=
3520 @vindex warning GCC_COLORS @r{capability}
3521 SGR substring for warning: markers.
3523 @item note=
3524 @vindex note GCC_COLORS @r{capability}
3525 SGR substring for note: markers.
3527 @item range1=
3528 @vindex range1 GCC_COLORS @r{capability}
3529 SGR substring for first additional range.
3531 @item range2=
3532 @vindex range2 GCC_COLORS @r{capability}
3533 SGR substring for second additional range.
3535 @item locus=
3536 @vindex locus GCC_COLORS @r{capability}
3537 SGR substring for location information, @samp{file:line} or
3538 @samp{file:line:column} etc.
3540 @item quote=
3541 @vindex quote GCC_COLORS @r{capability}
3542 SGR substring for information printed within quotes.
3544 @item fixit-insert=
3545 @vindex fixit-insert GCC_COLORS @r{capability}
3546 SGR substring for fix-it hints suggesting text to
3547 be inserted or replaced.
3549 @item fixit-delete=
3550 @vindex fixit-delete GCC_COLORS @r{capability}
3551 SGR substring for fix-it hints suggesting text to
3552 be deleted.
3554 @item diff-filename=
3555 @vindex diff-filename GCC_COLORS @r{capability}
3556 SGR substring for filename headers within generated patches.
3558 @item diff-hunk=
3559 @vindex diff-hunk GCC_COLORS @r{capability}
3560 SGR substring for the starts of hunks within generated patches.
3562 @item diff-delete=
3563 @vindex diff-delete GCC_COLORS @r{capability}
3564 SGR substring for deleted lines within generated patches.
3566 @item diff-insert=
3567 @vindex diff-insert GCC_COLORS @r{capability}
3568 SGR substring for inserted lines within generated patches.
3570 @item type-diff=
3571 @vindex type-diff GCC_COLORS @r{capability}
3572 SGR substring for highlighting mismatching types within template
3573 arguments in the C++ frontend.
3574 @end table
3576 @item -fno-diagnostics-show-option
3577 @opindex fno-diagnostics-show-option
3578 @opindex fdiagnostics-show-option
3579 By default, each diagnostic emitted includes text indicating the
3580 command-line option that directly controls the diagnostic (if such an
3581 option is known to the diagnostic machinery).  Specifying the
3582 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3584 @item -fno-diagnostics-show-caret
3585 @opindex fno-diagnostics-show-caret
3586 @opindex fdiagnostics-show-caret
3587 By default, each diagnostic emitted includes the original source line
3588 and a caret @samp{^} indicating the column.  This option suppresses this
3589 information.  The source line is truncated to @var{n} characters, if
3590 the @option{-fmessage-length=n} option is given.  When the output is done
3591 to the terminal, the width is limited to the width given by the
3592 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3594 @item -fdiagnostics-parseable-fixits
3595 @opindex fdiagnostics-parseable-fixits
3596 Emit fix-it hints in a machine-parseable format, suitable for consumption
3597 by IDEs.  For each fix-it, a line will be printed after the relevant
3598 diagnostic, starting with the string ``fix-it:''.  For example:
3600 @smallexample
3601 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3602 @end smallexample
3604 The location is expressed as a half-open range, expressed as a count of
3605 bytes, starting at byte 1 for the initial column.  In the above example,
3606 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3607 given string:
3609 @smallexample
3610 00000000011111111112222222222
3611 12345678901234567890123456789
3612   gtk_widget_showall (dlg);
3613   ^^^^^^^^^^^^^^^^^^
3614   gtk_widget_show_all
3615 @end smallexample
3617 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3618 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3619 (e.g. vertical tab as ``\013'').
3621 An empty replacement string indicates that the given range is to be removed.
3622 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3623 be inserted at the given position.
3625 @item -fdiagnostics-generate-patch
3626 @opindex fdiagnostics-generate-patch
3627 Print fix-it hints to stderr in unified diff format, after any diagnostics
3628 are printed.  For example:
3630 @smallexample
3631 --- test.c
3632 +++ test.c
3633 @@ -42,5 +42,5 @@
3635  void show_cb(GtkDialog *dlg)
3636  @{
3637 -  gtk_widget_showall(dlg);
3638 +  gtk_widget_show_all(dlg);
3639  @}
3641 @end smallexample
3643 The diff may or may not be colorized, following the same rules
3644 as for diagnostics (see @option{-fdiagnostics-color}).
3646 @item -fdiagnostics-show-template-tree
3647 @opindex fdiagnostics-show-template-tree
3649 In the C++ frontend, when printing diagnostics showing mismatching
3650 template types, such as:
3652 @smallexample
3653   could not convert 'std::map<int, std::vector<double> >()'
3654     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3655 @end smallexample
3657 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3658 tree-like structure showing the common and differing parts of the types,
3659 such as:
3661 @smallexample
3662   map<
3663     [...],
3664     vector<
3665       [double != float]>>
3666 @end smallexample
3668 The parts that differ are highlighted with color (``double'' and
3669 ``float'' in this case).
3671 @item -fno-elide-type
3672 @opindex fno-elide-type
3673 @opindex felide-type
3674 By default when the C++ frontend prints diagnostics showing mismatching
3675 template types, common parts of the types are printed as ``[...]'' to
3676 simplify the error message.  For example:
3678 @smallexample
3679   could not convert 'std::map<int, std::vector<double> >()'
3680     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3681 @end smallexample
3683 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3684 This flag also affects the output of the
3685 @option{-fdiagnostics-show-template-tree} flag.
3687 @item -fno-show-column
3688 @opindex fno-show-column
3689 Do not print column numbers in diagnostics.  This may be necessary if
3690 diagnostics are being scanned by a program that does not understand the
3691 column numbers, such as @command{dejagnu}.
3693 @end table
3695 @node Warning Options
3696 @section Options to Request or Suppress Warnings
3697 @cindex options to control warnings
3698 @cindex warning messages
3699 @cindex messages, warning
3700 @cindex suppressing warnings
3702 Warnings are diagnostic messages that report constructions that
3703 are not inherently erroneous but that are risky or suggest there
3704 may have been an error.
3706 The following language-independent options do not enable specific
3707 warnings but control the kinds of diagnostics produced by GCC@.
3709 @table @gcctabopt
3710 @cindex syntax checking
3711 @item -fsyntax-only
3712 @opindex fsyntax-only
3713 Check the code for syntax errors, but don't do anything beyond that.
3715 @item -fmax-errors=@var{n}
3716 @opindex fmax-errors
3717 Limits the maximum number of error messages to @var{n}, at which point
3718 GCC bails out rather than attempting to continue processing the source
3719 code.  If @var{n} is 0 (the default), there is no limit on the number
3720 of error messages produced.  If @option{-Wfatal-errors} is also
3721 specified, then @option{-Wfatal-errors} takes precedence over this
3722 option.
3724 @item -w
3725 @opindex w
3726 Inhibit all warning messages.
3728 @item -Werror
3729 @opindex Werror
3730 @opindex Wno-error
3731 Make all warnings into errors.
3733 @item -Werror=
3734 @opindex Werror=
3735 @opindex Wno-error=
3736 Make the specified warning into an error.  The specifier for a warning
3737 is appended; for example @option{-Werror=switch} turns the warnings
3738 controlled by @option{-Wswitch} into errors.  This switch takes a
3739 negative form, to be used to negate @option{-Werror} for specific
3740 warnings; for example @option{-Wno-error=switch} makes
3741 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3742 is in effect.
3744 The warning message for each controllable warning includes the
3745 option that controls the warning.  That option can then be used with
3746 @option{-Werror=} and @option{-Wno-error=} as described above.
3747 (Printing of the option in the warning message can be disabled using the
3748 @option{-fno-diagnostics-show-option} flag.)
3750 Note that specifying @option{-Werror=}@var{foo} automatically implies
3751 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3752 imply anything.
3754 @item -Wfatal-errors
3755 @opindex Wfatal-errors
3756 @opindex Wno-fatal-errors
3757 This option causes the compiler to abort compilation on the first error
3758 occurred rather than trying to keep going and printing further error
3759 messages.
3761 @end table
3763 You can request many specific warnings with options beginning with
3764 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3765 implicit declarations.  Each of these specific warning options also
3766 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3767 example, @option{-Wno-implicit}.  This manual lists only one of the
3768 two forms, whichever is not the default.  For further
3769 language-specific options also refer to @ref{C++ Dialect Options} and
3770 @ref{Objective-C and Objective-C++ Dialect Options}.
3772 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3773 options, such as @option{-Wunused}, which may turn on further options,
3774 such as @option{-Wunused-value}. The combined effect of positive and
3775 negative forms is that more specific options have priority over less
3776 specific ones, independently of their position in the command-line. For
3777 options of the same specificity, the last one takes effect. Options
3778 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3779 as if they appeared at the end of the command-line.
3781 When an unrecognized warning option is requested (e.g.,
3782 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3783 that the option is not recognized.  However, if the @option{-Wno-} form
3784 is used, the behavior is slightly different: no diagnostic is
3785 produced for @option{-Wno-unknown-warning} unless other diagnostics
3786 are being produced.  This allows the use of new @option{-Wno-} options
3787 with old compilers, but if something goes wrong, the compiler
3788 warns that an unrecognized option is present.
3790 @table @gcctabopt
3791 @item -Wpedantic
3792 @itemx -pedantic
3793 @opindex pedantic
3794 @opindex Wpedantic
3795 Issue all the warnings demanded by strict ISO C and ISO C++;
3796 reject all programs that use forbidden extensions, and some other
3797 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3798 version of the ISO C standard specified by any @option{-std} option used.
3800 Valid ISO C and ISO C++ programs should compile properly with or without
3801 this option (though a rare few require @option{-ansi} or a
3802 @option{-std} option specifying the required version of ISO C)@.  However,
3803 without this option, certain GNU extensions and traditional C and C++
3804 features are supported as well.  With this option, they are rejected.
3806 @option{-Wpedantic} does not cause warning messages for use of the
3807 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3808 warnings are also disabled in the expression that follows
3809 @code{__extension__}.  However, only system header files should use
3810 these escape routes; application programs should avoid them.
3811 @xref{Alternate Keywords}.
3813 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3814 C conformance.  They soon find that it does not do quite what they want:
3815 it finds some non-ISO practices, but not all---only those for which
3816 ISO C @emph{requires} a diagnostic, and some others for which
3817 diagnostics have been added.
3819 A feature to report any failure to conform to ISO C might be useful in
3820 some instances, but would require considerable additional work and would
3821 be quite different from @option{-Wpedantic}.  We don't have plans to
3822 support such a feature in the near future.
3824 Where the standard specified with @option{-std} represents a GNU
3825 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3826 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3827 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3828 where they are required by the base standard.  (It does not make sense
3829 for such warnings to be given only for features not in the specified GNU
3830 C dialect, since by definition the GNU dialects of C include all
3831 features the compiler supports with the given option, and there would be
3832 nothing to warn about.)
3834 @item -pedantic-errors
3835 @opindex pedantic-errors
3836 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3837 requires a diagnostic, in some cases where there is undefined behavior
3838 at compile-time and in some other cases that do not prevent compilation
3839 of programs that are valid according to the standard. This is not
3840 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3841 by this option and not enabled by the latter and vice versa.
3843 @item -Wall
3844 @opindex Wall
3845 @opindex Wno-all
3846 This enables all the warnings about constructions that some users
3847 consider questionable, and that are easy to avoid (or modify to
3848 prevent the warning), even in conjunction with macros.  This also
3849 enables some language-specific warnings described in @ref{C++ Dialect
3850 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3852 @option{-Wall} turns on the following warning flags:
3854 @gccoptlist{-Waddress   @gol
3855 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3856 -Wbool-compare  @gol
3857 -Wbool-operation  @gol
3858 -Wc++11-compat  -Wc++14-compat  @gol
3859 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3860 -Wchar-subscripts  @gol
3861 -Wcomment  @gol
3862 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3863 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3864 -Wformat   @gol
3865 -Wint-in-bool-context  @gol
3866 -Wimplicit @r{(C and Objective-C only)} @gol
3867 -Wimplicit-int @r{(C and Objective-C only)} @gol
3868 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3869 -Winit-self @r{(only for C++)} @gol
3870 -Wlogical-not-parentheses @gol
3871 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3872 -Wmaybe-uninitialized @gol
3873 -Wmemset-elt-size @gol
3874 -Wmemset-transposed-args @gol
3875 -Wmisleading-indentation @r{(only for C/C++)} @gol
3876 -Wmissing-braces @r{(only for C/ObjC)} @gol
3877 -Wmultistatement-macros  @gol
3878 -Wnarrowing @r{(only for C++)}  @gol
3879 -Wnonnull  @gol
3880 -Wnonnull-compare  @gol
3881 -Wopenmp-simd @gol
3882 -Wparentheses  @gol
3883 -Wpointer-sign  @gol
3884 -Wreorder   @gol
3885 -Wrestrict   @gol
3886 -Wreturn-type  @gol
3887 -Wsequence-point  @gol
3888 -Wsign-compare @r{(only in C++)}  @gol
3889 -Wsizeof-pointer-div @gol
3890 -Wsizeof-pointer-memaccess @gol
3891 -Wstrict-aliasing  @gol
3892 -Wstrict-overflow=1  @gol
3893 -Wswitch  @gol
3894 -Wtautological-compare  @gol
3895 -Wtrigraphs  @gol
3896 -Wuninitialized  @gol
3897 -Wunknown-pragmas  @gol
3898 -Wunused-function  @gol
3899 -Wunused-label     @gol
3900 -Wunused-value     @gol
3901 -Wunused-variable  @gol
3902 -Wvolatile-register-var @gol
3905 Note that some warning flags are not implied by @option{-Wall}.  Some of
3906 them warn about constructions that users generally do not consider
3907 questionable, but which occasionally you might wish to check for;
3908 others warn about constructions that are necessary or hard to avoid in
3909 some cases, and there is no simple way to modify the code to suppress
3910 the warning. Some of them are enabled by @option{-Wextra} but many of
3911 them must be enabled individually.
3913 @item -Wextra
3914 @opindex W
3915 @opindex Wextra
3916 @opindex Wno-extra
3917 This enables some extra warning flags that are not enabled by
3918 @option{-Wall}. (This option used to be called @option{-W}.  The older
3919 name is still supported, but the newer name is more descriptive.)
3921 @gccoptlist{-Wclobbered  @gol
3922 -Wcast-function-type  @gol
3923 -Wempty-body  @gol
3924 -Wignored-qualifiers @gol
3925 -Wimplicit-fallthrough=3 @gol
3926 -Wmissing-field-initializers  @gol
3927 -Wmissing-parameter-type @r{(C only)}  @gol
3928 -Wold-style-declaration @r{(C only)}  @gol
3929 -Woverride-init  @gol
3930 -Wsign-compare @r{(C only)} @gol
3931 -Wtype-limits  @gol
3932 -Wuninitialized  @gol
3933 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3934 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3935 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3938 The option @option{-Wextra} also prints warning messages for the
3939 following cases:
3941 @itemize @bullet
3943 @item
3944 A pointer is compared against integer zero with @code{<}, @code{<=},
3945 @code{>}, or @code{>=}.
3947 @item
3948 (C++ only) An enumerator and a non-enumerator both appear in a
3949 conditional expression.
3951 @item
3952 (C++ only) Ambiguous virtual bases.
3954 @item
3955 (C++ only) Subscripting an array that has been declared @code{register}.
3957 @item
3958 (C++ only) Taking the address of a variable that has been declared
3959 @code{register}.
3961 @item
3962 (C++ only) A base class is not initialized in the copy constructor
3963 of a derived class.
3965 @end itemize
3967 @item -Wchar-subscripts
3968 @opindex Wchar-subscripts
3969 @opindex Wno-char-subscripts
3970 Warn if an array subscript has type @code{char}.  This is a common cause
3971 of error, as programmers often forget that this type is signed on some
3972 machines.
3973 This warning is enabled by @option{-Wall}.
3975 @item -Wchkp
3976 @opindex Wchkp
3977 Warn about an invalid memory access that is found by Pointer Bounds Checker
3978 (@option{-fcheck-pointer-bounds}).
3980 @item -Wno-coverage-mismatch
3981 @opindex Wno-coverage-mismatch
3982 Warn if feedback profiles do not match when using the
3983 @option{-fprofile-use} option.
3984 If a source file is changed between compiling with @option{-fprofile-gen} and
3985 with @option{-fprofile-use}, the files with the profile feedback can fail
3986 to match the source file and GCC cannot use the profile feedback
3987 information.  By default, this warning is enabled and is treated as an
3988 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3989 warning or @option{-Wno-error=coverage-mismatch} can be used to
3990 disable the error.  Disabling the error for this warning can result in
3991 poorly optimized code and is useful only in the
3992 case of very minor changes such as bug fixes to an existing code-base.
3993 Completely disabling the warning is not recommended.
3995 @item -Wno-cpp
3996 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3998 Suppress warning messages emitted by @code{#warning} directives.
4000 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
4001 @opindex Wdouble-promotion
4002 @opindex Wno-double-promotion
4003 Give a warning when a value of type @code{float} is implicitly
4004 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
4005 floating-point unit implement @code{float} in hardware, but emulate
4006 @code{double} in software.  On such a machine, doing computations
4007 using @code{double} values is much more expensive because of the
4008 overhead required for software emulation.
4010 It is easy to accidentally do computations with @code{double} because
4011 floating-point literals are implicitly of type @code{double}.  For
4012 example, in:
4013 @smallexample
4014 @group
4015 float area(float radius)
4017    return 3.14159 * radius * radius;
4019 @end group
4020 @end smallexample
4021 the compiler performs the entire computation with @code{double}
4022 because the floating-point literal is a @code{double}.
4024 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4025 @opindex Wduplicate-decl-specifier
4026 @opindex Wno-duplicate-decl-specifier
4027 Warn if a declaration has duplicate @code{const}, @code{volatile},
4028 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4029 @option{-Wall}.
4031 @item -Wformat
4032 @itemx -Wformat=@var{n}
4033 @opindex Wformat
4034 @opindex Wno-format
4035 @opindex ffreestanding
4036 @opindex fno-builtin
4037 @opindex Wformat=
4038 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4039 the arguments supplied have types appropriate to the format string
4040 specified, and that the conversions specified in the format string make
4041 sense.  This includes standard functions, and others specified by format
4042 attributes (@pxref{Function Attributes}), in the @code{printf},
4043 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4044 not in the C standard) families (or other target-specific families).
4045 Which functions are checked without format attributes having been
4046 specified depends on the standard version selected, and such checks of
4047 functions without the attribute specified are disabled by
4048 @option{-ffreestanding} or @option{-fno-builtin}.
4050 The formats are checked against the format features supported by GNU
4051 libc version 2.2.  These include all ISO C90 and C99 features, as well
4052 as features from the Single Unix Specification and some BSD and GNU
4053 extensions.  Other library implementations may not support all these
4054 features; GCC does not support warning about features that go beyond a
4055 particular library's limitations.  However, if @option{-Wpedantic} is used
4056 with @option{-Wformat}, warnings are given about format features not
4057 in the selected standard version (but not for @code{strfmon} formats,
4058 since those are not in any version of the C standard).  @xref{C Dialect
4059 Options,,Options Controlling C Dialect}.
4061 @table @gcctabopt
4062 @item -Wformat=1
4063 @itemx -Wformat
4064 @opindex Wformat
4065 @opindex Wformat=1
4066 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4067 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4068 @option{-Wformat} also checks for null format arguments for several
4069 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4070 aspects of this level of format checking can be disabled by the
4071 options: @option{-Wno-format-contains-nul},
4072 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4073 @option{-Wformat} is enabled by @option{-Wall}.
4075 @item -Wno-format-contains-nul
4076 @opindex Wno-format-contains-nul
4077 @opindex Wformat-contains-nul
4078 If @option{-Wformat} is specified, do not warn about format strings that
4079 contain NUL bytes.
4081 @item -Wno-format-extra-args
4082 @opindex Wno-format-extra-args
4083 @opindex Wformat-extra-args
4084 If @option{-Wformat} is specified, do not warn about excess arguments to a
4085 @code{printf} or @code{scanf} format function.  The C standard specifies
4086 that such arguments are ignored.
4088 Where the unused arguments lie between used arguments that are
4089 specified with @samp{$} operand number specifications, normally
4090 warnings are still given, since the implementation could not know what
4091 type to pass to @code{va_arg} to skip the unused arguments.  However,
4092 in the case of @code{scanf} formats, this option suppresses the
4093 warning if the unused arguments are all pointers, since the Single
4094 Unix Specification says that such unused arguments are allowed.
4096 @item -Wformat-overflow
4097 @itemx -Wformat-overflow=@var{level}
4098 @opindex Wformat-overflow
4099 @opindex Wno-format-overflow
4100 Warn about calls to formatted input/output functions such as @code{sprintf}
4101 and @code{vsprintf} that might overflow the destination buffer.  When the
4102 exact number of bytes written by a format directive cannot be determined
4103 at compile-time it is estimated based on heuristics that depend on the
4104 @var{level} argument and on optimization.  While enabling optimization
4105 will in most cases improve the accuracy of the warning, it may also
4106 result in false positives.
4108 @table @gcctabopt
4109 @item -Wformat-overflow
4110 @item -Wformat-overflow=1
4111 @opindex Wformat-overflow
4112 @opindex Wno-format-overflow
4113 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4114 employs a conservative approach that warns only about calls that most
4115 likely overflow the buffer.  At this level, numeric arguments to format
4116 directives with unknown values are assumed to have the value of one, and
4117 strings of unknown length to be empty.  Numeric arguments that are known
4118 to be bounded to a subrange of their type, or string arguments whose output
4119 is bounded either by their directive's precision or by a finite set of
4120 string literals, are assumed to take on the value within the range that
4121 results in the most bytes on output.  For example, the call to @code{sprintf}
4122 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4123 the terminating NUL character (@code{'\0'}) appended by the function
4124 to the destination buffer will be written past its end.  Increasing
4125 the size of the buffer by a single byte is sufficient to avoid the
4126 warning, though it may not be sufficient to avoid the overflow.
4128 @smallexample
4129 void f (int a, int b)
4131   char buf [12];
4132   sprintf (buf, "a = %i, b = %i\n", a, b);
4134 @end smallexample
4136 @item -Wformat-overflow=2
4137 Level @var{2} warns also about calls that might overflow the destination
4138 buffer given an argument of sufficient length or magnitude.  At level
4139 @var{2}, unknown numeric arguments are assumed to have the minimum
4140 representable value for signed types with a precision greater than 1, and
4141 the maximum representable value otherwise.  Unknown string arguments whose
4142 length cannot be assumed to be bounded either by the directive's precision,
4143 or by a finite set of string literals they may evaluate to, or the character
4144 array they may point to, are assumed to be 1 character long.
4146 At level @var{2}, the call in the example above is again diagnosed, but
4147 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4148 @code{%i} directive will write some of its digits beyond the end of
4149 the destination buffer.  To make the call safe regardless of the values
4150 of the two variables, the size of the destination buffer must be increased
4151 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4152 an informational note following the warning.
4154 An alternative to increasing the size of the destination buffer is to
4155 constrain the range of formatted values.  The maximum length of string
4156 arguments can be bounded by specifying the precision in the format
4157 directive.  When numeric arguments of format directives can be assumed
4158 to be bounded by less than the precision of their type, choosing
4159 an appropriate length modifier to the format specifier will reduce
4160 the required buffer size.  For example, if @var{a} and @var{b} in the
4161 example above can be assumed to be within the precision of
4162 the @code{short int} type then using either the @code{%hi} format
4163 directive or casting the argument to @code{short} reduces the maximum
4164 required size of the buffer to 24 bytes.
4166 @smallexample
4167 void f (int a, int b)
4169   char buf [23];
4170   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4172 @end smallexample
4173 @end table
4175 @item -Wno-format-zero-length
4176 @opindex Wno-format-zero-length
4177 @opindex Wformat-zero-length
4178 If @option{-Wformat} is specified, do not warn about zero-length formats.
4179 The C standard specifies that zero-length formats are allowed.
4182 @item -Wformat=2
4183 @opindex Wformat=2
4184 Enable @option{-Wformat} plus additional format checks.  Currently
4185 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4186 -Wformat-y2k}.
4188 @item -Wformat-nonliteral
4189 @opindex Wformat-nonliteral
4190 @opindex Wno-format-nonliteral
4191 If @option{-Wformat} is specified, also warn if the format string is not a
4192 string literal and so cannot be checked, unless the format function
4193 takes its format arguments as a @code{va_list}.
4195 @item -Wformat-security
4196 @opindex Wformat-security
4197 @opindex Wno-format-security
4198 If @option{-Wformat} is specified, also warn about uses of format
4199 functions that represent possible security problems.  At present, this
4200 warns about calls to @code{printf} and @code{scanf} functions where the
4201 format string is not a string literal and there are no format arguments,
4202 as in @code{printf (foo);}.  This may be a security hole if the format
4203 string came from untrusted input and contains @samp{%n}.  (This is
4204 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4205 in future warnings may be added to @option{-Wformat-security} that are not
4206 included in @option{-Wformat-nonliteral}.)
4208 @item -Wformat-signedness
4209 @opindex Wformat-signedness
4210 @opindex Wno-format-signedness
4211 If @option{-Wformat} is specified, also warn if the format string
4212 requires an unsigned argument and the argument is signed and vice versa.
4214 @item -Wformat-truncation
4215 @itemx -Wformat-truncation=@var{level}
4216 @opindex Wformat-truncation
4217 @opindex Wno-format-truncation
4218 Warn about calls to formatted input/output functions such as @code{snprintf}
4219 and @code{vsnprintf} that might result in output truncation.  When the exact
4220 number of bytes written by a format directive cannot be determined at
4221 compile-time it is estimated based on heuristics that depend on
4222 the @var{level} argument and on optimization.  While enabling optimization
4223 will in most cases improve the accuracy of the warning, it may also result
4224 in false positives.  Except as noted otherwise, the option uses the same
4225 logic @option{-Wformat-overflow}.
4227 @table @gcctabopt
4228 @item -Wformat-truncation
4229 @item -Wformat-truncation=1
4230 @opindex Wformat-truncation
4231 @opindex Wno-format-overflow
4232 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4233 employs a conservative approach that warns only about calls to bounded
4234 functions whose return value is unused and that will most likely result
4235 in output truncation.
4237 @item -Wformat-truncation=2
4238 Level @var{2} warns also about calls to bounded functions whose return
4239 value is used and that might result in truncation given an argument of
4240 sufficient length or magnitude.
4241 @end table
4243 @item -Wformat-y2k
4244 @opindex Wformat-y2k
4245 @opindex Wno-format-y2k
4246 If @option{-Wformat} is specified, also warn about @code{strftime}
4247 formats that may yield only a two-digit year.
4248 @end table
4250 @item -Wnonnull
4251 @opindex Wnonnull
4252 @opindex Wno-nonnull
4253 Warn about passing a null pointer for arguments marked as
4254 requiring a non-null value by the @code{nonnull} function attribute.
4256 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4257 can be disabled with the @option{-Wno-nonnull} option.
4259 @item -Wnonnull-compare
4260 @opindex Wnonnull-compare
4261 @opindex Wno-nonnull-compare
4262 Warn when comparing an argument marked with the @code{nonnull}
4263 function attribute against null inside the function.
4265 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4266 can be disabled with the @option{-Wno-nonnull-compare} option.
4268 @item -Wnull-dereference
4269 @opindex Wnull-dereference
4270 @opindex Wno-null-dereference
4271 Warn if the compiler detects paths that trigger erroneous or
4272 undefined behavior due to dereferencing a null pointer.  This option
4273 is only active when @option{-fdelete-null-pointer-checks} is active,
4274 which is enabled by optimizations in most targets.  The precision of
4275 the warnings depends on the optimization options used.
4277 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4278 @opindex Winit-self
4279 @opindex Wno-init-self
4280 Warn about uninitialized variables that are initialized with themselves.
4281 Note this option can only be used with the @option{-Wuninitialized} option.
4283 For example, GCC warns about @code{i} being uninitialized in the
4284 following snippet only when @option{-Winit-self} has been specified:
4285 @smallexample
4286 @group
4287 int f()
4289   int i = i;
4290   return i;
4292 @end group
4293 @end smallexample
4295 This warning is enabled by @option{-Wall} in C++.
4297 @item -Wimplicit-int @r{(C and Objective-C only)}
4298 @opindex Wimplicit-int
4299 @opindex Wno-implicit-int
4300 Warn when a declaration does not specify a type.
4301 This warning is enabled by @option{-Wall}.
4303 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4304 @opindex Wimplicit-function-declaration
4305 @opindex Wno-implicit-function-declaration
4306 Give a warning whenever a function is used before being declared. In
4307 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4308 enabled by default and it is made into an error by
4309 @option{-pedantic-errors}. This warning is also enabled by
4310 @option{-Wall}.
4312 @item -Wimplicit @r{(C and Objective-C only)}
4313 @opindex Wimplicit
4314 @opindex Wno-implicit
4315 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4316 This warning is enabled by @option{-Wall}.
4318 @item -Wimplicit-fallthrough
4319 @opindex Wimplicit-fallthrough
4320 @opindex Wno-implicit-fallthrough
4321 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4322 and @option{-Wno-implicit-fallthrough} is the same as
4323 @option{-Wimplicit-fallthrough=0}.
4325 @item -Wimplicit-fallthrough=@var{n}
4326 @opindex Wimplicit-fallthrough=
4327 Warn when a switch case falls through.  For example:
4329 @smallexample
4330 @group
4331 switch (cond)
4332   @{
4333   case 1:
4334     a = 1;
4335     break;
4336   case 2:
4337     a = 2;
4338   case 3:
4339     a = 3;
4340     break;
4341   @}
4342 @end group
4343 @end smallexample
4345 This warning does not warn when the last statement of a case cannot
4346 fall through, e.g. when there is a return statement or a call to function
4347 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4348 also takes into account control flow statements, such as ifs, and only
4349 warns when appropriate.  E.g.@:
4351 @smallexample
4352 @group
4353 switch (cond)
4354   @{
4355   case 1:
4356     if (i > 3) @{
4357       bar (5);
4358       break;
4359     @} else if (i < 1) @{
4360       bar (0);
4361     @} else
4362       return;
4363   default:
4364     @dots{}
4365   @}
4366 @end group
4367 @end smallexample
4369 Since there are occasions where a switch case fall through is desirable,
4370 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4371 to be used along with a null statement to suppress this warning that
4372 would normally occur:
4374 @smallexample
4375 @group
4376 switch (cond)
4377   @{
4378   case 1:
4379     bar (0);
4380     __attribute__ ((fallthrough));
4381   default:
4382     @dots{}
4383   @}
4384 @end group
4385 @end smallexample
4387 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4388 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4389 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4390 Instead of these attributes, it is also possible to add a fallthrough comment
4391 to silence the warning.  The whole body of the C or C++ style comment should
4392 match the given regular expressions listed below.  The option argument @var{n}
4393 specifies what kind of comments are accepted:
4395 @itemize @bullet
4397 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4399 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4400 expression, any comment is used as fallthrough comment.
4402 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4403 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4405 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4406 following regular expressions:
4408 @itemize @bullet
4410 @item @code{-fallthrough}
4412 @item @code{@@fallthrough@@}
4414 @item @code{lint -fallthrough[ \t]*}
4416 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4418 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4420 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4422 @end itemize
4424 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4425 following regular expressions:
4427 @itemize @bullet
4429 @item @code{-fallthrough}
4431 @item @code{@@fallthrough@@}
4433 @item @code{lint -fallthrough[ \t]*}
4435 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4437 @end itemize
4439 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4440 fallthrough comments, only attributes disable the warning.
4442 @end itemize
4444 The comment needs to be followed after optional whitespace and other comments
4445 by @code{case} or @code{default} keywords or by a user label that precedes some
4446 @code{case} or @code{default} label.
4448 @smallexample
4449 @group
4450 switch (cond)
4451   @{
4452   case 1:
4453     bar (0);
4454     /* FALLTHRU */
4455   default:
4456     @dots{}
4457   @}
4458 @end group
4459 @end smallexample
4461 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4463 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4464 @opindex Wif-not-aligned
4465 @opindex Wno-if-not-aligned
4466 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4467 should be issued.  This is is enabled by default.
4468 Use @option{-Wno-if-not-aligned} to disable it.
4470 @item -Wignored-qualifiers @r{(C and C++ only)}
4471 @opindex Wignored-qualifiers
4472 @opindex Wno-ignored-qualifiers
4473 Warn if the return type of a function has a type qualifier
4474 such as @code{const}.  For ISO C such a type qualifier has no effect,
4475 since the value returned by a function is not an lvalue.
4476 For C++, the warning is only emitted for scalar types or @code{void}.
4477 ISO C prohibits qualified @code{void} return types on function
4478 definitions, so such return types always receive a warning
4479 even without this option.
4481 This warning is also enabled by @option{-Wextra}.
4483 @item -Wignored-attributes @r{(C and C++ only)}
4484 @opindex Wignored-attributes
4485 @opindex Wno-ignored-attributes
4486 Warn when an attribute is ignored.  This is different from the
4487 @option{-Wattributes} option in that it warns whenever the compiler decides
4488 to drop an attribute, not that the attribute is either unknown, used in a
4489 wrong place, etc.  This warning is enabled by default.
4491 @item -Wmain
4492 @opindex Wmain
4493 @opindex Wno-main
4494 Warn if the type of @code{main} is suspicious.  @code{main} should be
4495 a function with external linkage, returning int, taking either zero
4496 arguments, two, or three arguments of appropriate types.  This warning
4497 is enabled by default in C++ and is enabled by either @option{-Wall}
4498 or @option{-Wpedantic}.
4500 @item -Wmisleading-indentation @r{(C and C++ only)}
4501 @opindex Wmisleading-indentation
4502 @opindex Wno-misleading-indentation
4503 Warn when the indentation of the code does not reflect the block structure.
4504 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4505 @code{for} clauses with a guarded statement that does not use braces,
4506 followed by an unguarded statement with the same indentation.
4508 In the following example, the call to ``bar'' is misleadingly indented as
4509 if it were guarded by the ``if'' conditional.
4511 @smallexample
4512   if (some_condition ())
4513     foo ();
4514     bar ();  /* Gotcha: this is not guarded by the "if".  */
4515 @end smallexample
4517 In the case of mixed tabs and spaces, the warning uses the
4518 @option{-ftabstop=} option to determine if the statements line up
4519 (defaulting to 8).
4521 The warning is not issued for code involving multiline preprocessor logic
4522 such as the following example.
4524 @smallexample
4525   if (flagA)
4526     foo (0);
4527 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4528   if (flagB)
4529 #endif
4530     foo (1);
4531 @end smallexample
4533 The warning is not issued after a @code{#line} directive, since this
4534 typically indicates autogenerated code, and no assumptions can be made
4535 about the layout of the file that the directive references.
4537 This warning is enabled by @option{-Wall} in C and C++.
4539 @item -Wmissing-braces
4540 @opindex Wmissing-braces
4541 @opindex Wno-missing-braces
4542 Warn if an aggregate or union initializer is not fully bracketed.  In
4543 the following example, the initializer for @code{a} is not fully
4544 bracketed, but that for @code{b} is fully bracketed.  This warning is
4545 enabled by @option{-Wall} in C.
4547 @smallexample
4548 int a[2][2] = @{ 0, 1, 2, 3 @};
4549 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4550 @end smallexample
4552 This warning is enabled by @option{-Wall}.
4554 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4555 @opindex Wmissing-include-dirs
4556 @opindex Wno-missing-include-dirs
4557 Warn if a user-supplied include directory does not exist.
4559 @item -Wmultistatement-macros
4560 @opindex Wmultistatement-macros
4561 @opindex Wno-multistatement-macros
4562 Warn about unsafe multiple statement macros that appear to be guarded
4563 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4564 @code{while}, in which only the first statement is actually guarded after
4565 the macro is expanded.
4567 For example:
4569 @smallexample
4570 #define DOIT x++; y++
4571 if (c)
4572   DOIT;
4573 @end smallexample
4575 will increment @code{y} unconditionally, not just when @code{c} holds.
4576 The can usually be fixed by wrapping the macro in a do-while loop:
4577 @smallexample
4578 #define DOIT do @{ x++; y++; @} while (0)
4579 if (c)
4580   DOIT;
4581 @end smallexample
4583 This warning is enabled by @option{-Wall} in C and C++.
4585 @item -Wparentheses
4586 @opindex Wparentheses
4587 @opindex Wno-parentheses
4588 Warn if parentheses are omitted in certain contexts, such
4589 as when there is an assignment in a context where a truth value
4590 is expected, or when operators are nested whose precedence people
4591 often get confused about.
4593 Also warn if a comparison like @code{x<=y<=z} appears; this is
4594 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4595 interpretation from that of ordinary mathematical notation.
4597 Also warn for dangerous uses of the GNU extension to
4598 @code{?:} with omitted middle operand. When the condition
4599 in the @code{?}: operator is a boolean expression, the omitted value is
4600 always 1.  Often programmers expect it to be a value computed
4601 inside the conditional expression instead.
4603 For C++ this also warns for some cases of unnecessary parentheses in
4604 declarations, which can indicate an attempt at a function call instead
4605 of a declaration:
4606 @smallexample
4608   // Declares a local variable called mymutex.
4609   std::unique_lock<std::mutex> (mymutex);
4610   // User meant std::unique_lock<std::mutex> lock (mymutex);
4612 @end smallexample
4614 This warning is enabled by @option{-Wall}.
4616 @item -Wsequence-point
4617 @opindex Wsequence-point
4618 @opindex Wno-sequence-point
4619 Warn about code that may have undefined semantics because of violations
4620 of sequence point rules in the C and C++ standards.
4622 The C and C++ standards define the order in which expressions in a C/C++
4623 program are evaluated in terms of @dfn{sequence points}, which represent
4624 a partial ordering between the execution of parts of the program: those
4625 executed before the sequence point, and those executed after it.  These
4626 occur after the evaluation of a full expression (one which is not part
4627 of a larger expression), after the evaluation of the first operand of a
4628 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4629 function is called (but after the evaluation of its arguments and the
4630 expression denoting the called function), and in certain other places.
4631 Other than as expressed by the sequence point rules, the order of
4632 evaluation of subexpressions of an expression is not specified.  All
4633 these rules describe only a partial order rather than a total order,
4634 since, for example, if two functions are called within one expression
4635 with no sequence point between them, the order in which the functions
4636 are called is not specified.  However, the standards committee have
4637 ruled that function calls do not overlap.
4639 It is not specified when between sequence points modifications to the
4640 values of objects take effect.  Programs whose behavior depends on this
4641 have undefined behavior; the C and C++ standards specify that ``Between
4642 the previous and next sequence point an object shall have its stored
4643 value modified at most once by the evaluation of an expression.
4644 Furthermore, the prior value shall be read only to determine the value
4645 to be stored.''.  If a program breaks these rules, the results on any
4646 particular implementation are entirely unpredictable.
4648 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4649 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4650 diagnosed by this option, and it may give an occasional false positive
4651 result, but in general it has been found fairly effective at detecting
4652 this sort of problem in programs.
4654 The C++17 standard will define the order of evaluation of operands in
4655 more cases: in particular it requires that the right-hand side of an
4656 assignment be evaluated before the left-hand side, so the above
4657 examples are no longer undefined.  But this warning will still warn
4658 about them, to help people avoid writing code that is undefined in C
4659 and earlier revisions of C++.
4661 The standard is worded confusingly, therefore there is some debate
4662 over the precise meaning of the sequence point rules in subtle cases.
4663 Links to discussions of the problem, including proposed formal
4664 definitions, may be found on the GCC readings page, at
4665 @uref{http://gcc.gnu.org/@/readings.html}.
4667 This warning is enabled by @option{-Wall} for C and C++.
4669 @item -Wno-return-local-addr
4670 @opindex Wno-return-local-addr
4671 @opindex Wreturn-local-addr
4672 Do not warn about returning a pointer (or in C++, a reference) to a
4673 variable that goes out of scope after the function returns.
4675 @item -Wreturn-type
4676 @opindex Wreturn-type
4677 @opindex Wno-return-type
4678 Warn whenever a function is defined with a return type that defaults
4679 to @code{int}.  Also warn about any @code{return} statement with no
4680 return value in a function whose return type is not @code{void}
4681 (falling off the end of the function body is considered returning
4682 without a value).
4684 For C only, warn about a @code{return} statement with an expression in a
4685 function whose return type is @code{void}, unless the expression type is
4686 also @code{void}.  As a GNU extension, the latter case is accepted
4687 without a warning unless @option{-Wpedantic} is used.
4689 For C++, a function without return type always produces a diagnostic
4690 message, even when @option{-Wno-return-type} is specified.  The only
4691 exceptions are @code{main} and functions defined in system headers.
4693 This warning is enabled by @option{-Wall}.
4695 @item -Wshift-count-negative
4696 @opindex Wshift-count-negative
4697 @opindex Wno-shift-count-negative
4698 Warn if shift count is negative. This warning is enabled by default.
4700 @item -Wshift-count-overflow
4701 @opindex Wshift-count-overflow
4702 @opindex Wno-shift-count-overflow
4703 Warn if shift count >= width of type. This warning is enabled by default.
4705 @item -Wshift-negative-value
4706 @opindex Wshift-negative-value
4707 @opindex Wno-shift-negative-value
4708 Warn if left shifting a negative value.  This warning is enabled by
4709 @option{-Wextra} in C99 and C++11 modes (and newer).
4711 @item -Wshift-overflow
4712 @itemx -Wshift-overflow=@var{n}
4713 @opindex Wshift-overflow
4714 @opindex Wno-shift-overflow
4715 Warn about left shift overflows.  This warning is enabled by
4716 default in C99 and C++11 modes (and newer).
4718 @table @gcctabopt
4719 @item -Wshift-overflow=1
4720 This is the warning level of @option{-Wshift-overflow} and is enabled
4721 by default in C99 and C++11 modes (and newer).  This warning level does
4722 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4723 an overflow is still rejected in contexts where an integer constant expression
4724 is required.)
4726 @item -Wshift-overflow=2
4727 This warning level also warns about left-shifting 1 into the sign bit,
4728 unless C++14 mode is active.
4729 @end table
4731 @item -Wswitch
4732 @opindex Wswitch
4733 @opindex Wno-switch
4734 Warn whenever a @code{switch} statement has an index of enumerated type
4735 and lacks a @code{case} for one or more of the named codes of that
4736 enumeration.  (The presence of a @code{default} label prevents this
4737 warning.)  @code{case} labels outside the enumeration range also
4738 provoke warnings when this option is used (even if there is a
4739 @code{default} label).
4740 This warning is enabled by @option{-Wall}.
4742 @item -Wswitch-default
4743 @opindex Wswitch-default
4744 @opindex Wno-switch-default
4745 Warn whenever a @code{switch} statement does not have a @code{default}
4746 case.
4748 @item -Wswitch-enum
4749 @opindex Wswitch-enum
4750 @opindex Wno-switch-enum
4751 Warn whenever a @code{switch} statement has an index of enumerated type
4752 and lacks a @code{case} for one or more of the named codes of that
4753 enumeration.  @code{case} labels outside the enumeration range also
4754 provoke warnings when this option is used.  The only difference
4755 between @option{-Wswitch} and this option is that this option gives a
4756 warning about an omitted enumeration code even if there is a
4757 @code{default} label.
4759 @item -Wswitch-bool
4760 @opindex Wswitch-bool
4761 @opindex Wno-switch-bool
4762 Warn whenever a @code{switch} statement has an index of boolean type
4763 and the case values are outside the range of a boolean type.
4764 It is possible to suppress this warning by casting the controlling
4765 expression to a type other than @code{bool}.  For example:
4766 @smallexample
4767 @group
4768 switch ((int) (a == 4))
4769   @{
4770   @dots{}
4771   @}
4772 @end group
4773 @end smallexample
4774 This warning is enabled by default for C and C++ programs.
4776 @item -Wswitch-unreachable
4777 @opindex Wswitch-unreachable
4778 @opindex Wno-switch-unreachable
4779 Warn whenever a @code{switch} statement contains statements between the
4780 controlling expression and the first case label, which will never be
4781 executed.  For example:
4782 @smallexample
4783 @group
4784 switch (cond)
4785   @{
4786    i = 15;
4787   @dots{}
4788    case 5:
4789   @dots{}
4790   @}
4791 @end group
4792 @end smallexample
4793 @option{-Wswitch-unreachable} does not warn if the statement between the
4794 controlling expression and the first case label is just a declaration:
4795 @smallexample
4796 @group
4797 switch (cond)
4798   @{
4799    int i;
4800   @dots{}
4801    case 5:
4802    i = 5;
4803   @dots{}
4804   @}
4805 @end group
4806 @end smallexample
4807 This warning is enabled by default for C and C++ programs.
4809 @item -Wsync-nand @r{(C and C++ only)}
4810 @opindex Wsync-nand
4811 @opindex Wno-sync-nand
4812 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4813 built-in functions are used.  These functions changed semantics in GCC 4.4.
4815 @item -Wunused-but-set-parameter
4816 @opindex Wunused-but-set-parameter
4817 @opindex Wno-unused-but-set-parameter
4818 Warn whenever a function parameter is assigned to, but otherwise unused
4819 (aside from its declaration).
4821 To suppress this warning use the @code{unused} attribute
4822 (@pxref{Variable Attributes}).
4824 This warning is also enabled by @option{-Wunused} together with
4825 @option{-Wextra}.
4827 @item -Wunused-but-set-variable
4828 @opindex Wunused-but-set-variable
4829 @opindex Wno-unused-but-set-variable
4830 Warn whenever a local variable is assigned to, but otherwise unused
4831 (aside from its declaration).
4832 This warning is enabled by @option{-Wall}.
4834 To suppress this warning use the @code{unused} attribute
4835 (@pxref{Variable Attributes}).
4837 This warning is also enabled by @option{-Wunused}, which is enabled
4838 by @option{-Wall}.
4840 @item -Wunused-function
4841 @opindex Wunused-function
4842 @opindex Wno-unused-function
4843 Warn whenever a static function is declared but not defined or a
4844 non-inline static function is unused.
4845 This warning is enabled by @option{-Wall}.
4847 @item -Wunused-label
4848 @opindex Wunused-label
4849 @opindex Wno-unused-label
4850 Warn whenever a label is declared but not used.
4851 This warning is enabled by @option{-Wall}.
4853 To suppress this warning use the @code{unused} attribute
4854 (@pxref{Variable Attributes}).
4856 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4857 @opindex Wunused-local-typedefs
4858 Warn when a typedef locally defined in a function is not used.
4859 This warning is enabled by @option{-Wall}.
4861 @item -Wunused-parameter
4862 @opindex Wunused-parameter
4863 @opindex Wno-unused-parameter
4864 Warn whenever a function parameter is unused aside from its declaration.
4866 To suppress this warning use the @code{unused} attribute
4867 (@pxref{Variable Attributes}).
4869 @item -Wno-unused-result
4870 @opindex Wunused-result
4871 @opindex Wno-unused-result
4872 Do not warn if a caller of a function marked with attribute
4873 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4874 its return value. The default is @option{-Wunused-result}.
4876 @item -Wunused-variable
4877 @opindex Wunused-variable
4878 @opindex Wno-unused-variable
4879 Warn whenever a local or static variable is unused aside from its
4880 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4881 but not for C++. This warning is enabled by @option{-Wall}.
4883 To suppress this warning use the @code{unused} attribute
4884 (@pxref{Variable Attributes}).
4886 @item -Wunused-const-variable
4887 @itemx -Wunused-const-variable=@var{n}
4888 @opindex Wunused-const-variable
4889 @opindex Wno-unused-const-variable
4890 Warn whenever a constant static variable is unused aside from its declaration.
4891 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4892 for C, but not for C++. In C this declares variable storage, but in C++ this
4893 is not an error since const variables take the place of @code{#define}s.
4895 To suppress this warning use the @code{unused} attribute
4896 (@pxref{Variable Attributes}).
4898 @table @gcctabopt
4899 @item -Wunused-const-variable=1
4900 This is the warning level that is enabled by @option{-Wunused-variable} for
4901 C.  It warns only about unused static const variables defined in the main
4902 compilation unit, but not about static const variables declared in any
4903 header included.
4905 @item -Wunused-const-variable=2
4906 This warning level also warns for unused constant static variables in
4907 headers (excluding system headers).  This is the warning level of
4908 @option{-Wunused-const-variable} and must be explicitly requested since
4909 in C++ this isn't an error and in C it might be harder to clean up all
4910 headers included.
4911 @end table
4913 @item -Wunused-value
4914 @opindex Wunused-value
4915 @opindex Wno-unused-value
4916 Warn whenever a statement computes a result that is explicitly not
4917 used. To suppress this warning cast the unused expression to
4918 @code{void}. This includes an expression-statement or the left-hand
4919 side of a comma expression that contains no side effects. For example,
4920 an expression such as @code{x[i,j]} causes a warning, while
4921 @code{x[(void)i,j]} does not.
4923 This warning is enabled by @option{-Wall}.
4925 @item -Wunused
4926 @opindex Wunused
4927 @opindex Wno-unused
4928 All the above @option{-Wunused} options combined.
4930 In order to get a warning about an unused function parameter, you must
4931 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4932 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4934 @item -Wuninitialized
4935 @opindex Wuninitialized
4936 @opindex Wno-uninitialized
4937 Warn if an automatic variable is used without first being initialized
4938 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4939 warn if a non-static reference or non-static @code{const} member
4940 appears in a class without constructors.
4942 If you want to warn about code that uses the uninitialized value of the
4943 variable in its own initializer, use the @option{-Winit-self} option.
4945 These warnings occur for individual uninitialized or clobbered
4946 elements of structure, union or array variables as well as for
4947 variables that are uninitialized or clobbered as a whole.  They do
4948 not occur for variables or elements declared @code{volatile}.  Because
4949 these warnings depend on optimization, the exact variables or elements
4950 for which there are warnings depends on the precise optimization
4951 options and version of GCC used.
4953 Note that there may be no warning about a variable that is used only
4954 to compute a value that itself is never used, because such
4955 computations may be deleted by data flow analysis before the warnings
4956 are printed.
4958 @item -Winvalid-memory-model
4959 @opindex Winvalid-memory-model
4960 @opindex Wno-invalid-memory-model
4961 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4962 and the C11 atomic generic functions with a memory consistency argument
4963 that is either invalid for the operation or outside the range of values
4964 of the @code{memory_order} enumeration.  For example, since the
4965 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4966 defined for the relaxed, release, and sequentially consistent memory
4967 orders the following code is diagnosed:
4969 @smallexample
4970 void store (int *i)
4972   __atomic_store_n (i, 0, memory_order_consume);
4974 @end smallexample
4976 @option{-Winvalid-memory-model} is enabled by default.
4978 @item -Wmaybe-uninitialized
4979 @opindex Wmaybe-uninitialized
4980 @opindex Wno-maybe-uninitialized
4981 For an automatic (i.e.@ local) variable, if there exists a path from the
4982 function entry to a use of the variable that is initialized, but there exist
4983 some other paths for which the variable is not initialized, the compiler
4984 emits a warning if it cannot prove the uninitialized paths are not
4985 executed at run time.
4987 These warnings are only possible in optimizing compilation, because otherwise
4988 GCC does not keep track of the state of variables.
4990 These warnings are made optional because GCC may not be able to determine when
4991 the code is correct in spite of appearing to have an error.  Here is one
4992 example of how this can happen:
4994 @smallexample
4995 @group
4997   int x;
4998   switch (y)
4999     @{
5000     case 1: x = 1;
5001       break;
5002     case 2: x = 4;
5003       break;
5004     case 3: x = 5;
5005     @}
5006   foo (x);
5008 @end group
5009 @end smallexample
5011 @noindent
5012 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
5013 always initialized, but GCC doesn't know this. To suppress the
5014 warning, you need to provide a default case with assert(0) or
5015 similar code.
5017 @cindex @code{longjmp} warnings
5018 This option also warns when a non-volatile automatic variable might be
5019 changed by a call to @code{longjmp}.
5020 The compiler sees only the calls to @code{setjmp}.  It cannot know
5021 where @code{longjmp} will be called; in fact, a signal handler could
5022 call it at any point in the code.  As a result, you may get a warning
5023 even when there is in fact no problem because @code{longjmp} cannot
5024 in fact be called at the place that would cause a problem.
5026 Some spurious warnings can be avoided if you declare all the functions
5027 you use that never return as @code{noreturn}.  @xref{Function
5028 Attributes}.
5030 This warning is enabled by @option{-Wall} or @option{-Wextra}.
5032 @item -Wunknown-pragmas
5033 @opindex Wunknown-pragmas
5034 @opindex Wno-unknown-pragmas
5035 @cindex warning for unknown pragmas
5036 @cindex unknown pragmas, warning
5037 @cindex pragmas, warning of unknown
5038 Warn when a @code{#pragma} directive is encountered that is not understood by 
5039 GCC@.  If this command-line option is used, warnings are even issued
5040 for unknown pragmas in system header files.  This is not the case if
5041 the warnings are only enabled by the @option{-Wall} command-line option.
5043 @item -Wno-pragmas
5044 @opindex Wno-pragmas
5045 @opindex Wpragmas
5046 Do not warn about misuses of pragmas, such as incorrect parameters,
5047 invalid syntax, or conflicts between pragmas.  See also
5048 @option{-Wunknown-pragmas}.
5050 @item -Wstrict-aliasing
5051 @opindex Wstrict-aliasing
5052 @opindex Wno-strict-aliasing
5053 This option is only active when @option{-fstrict-aliasing} is active.
5054 It warns about code that might break the strict aliasing rules that the
5055 compiler is using for optimization.  The warning does not catch all
5056 cases, but does attempt to catch the more common pitfalls.  It is
5057 included in @option{-Wall}.
5058 It is equivalent to @option{-Wstrict-aliasing=3}
5060 @item -Wstrict-aliasing=n
5061 @opindex Wstrict-aliasing=n
5062 This option is only active when @option{-fstrict-aliasing} is active.
5063 It warns about code that might break the strict aliasing rules that the
5064 compiler is using for optimization.
5065 Higher levels correspond to higher accuracy (fewer false positives).
5066 Higher levels also correspond to more effort, similar to the way @option{-O} 
5067 works.
5068 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5070 Level 1: Most aggressive, quick, least accurate.
5071 Possibly useful when higher levels
5072 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5073 false negatives.  However, it has many false positives.
5074 Warns for all pointer conversions between possibly incompatible types,
5075 even if never dereferenced.  Runs in the front end only.
5077 Level 2: Aggressive, quick, not too precise.
5078 May still have many false positives (not as many as level 1 though),
5079 and few false negatives (but possibly more than level 1).
5080 Unlike level 1, it only warns when an address is taken.  Warns about
5081 incomplete types.  Runs in the front end only.
5083 Level 3 (default for @option{-Wstrict-aliasing}):
5084 Should have very few false positives and few false
5085 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5086 Takes care of the common pun+dereference pattern in the front end:
5087 @code{*(int*)&some_float}.
5088 If optimization is enabled, it also runs in the back end, where it deals
5089 with multiple statement cases using flow-sensitive points-to information.
5090 Only warns when the converted pointer is dereferenced.
5091 Does not warn about incomplete types.
5093 @item -Wstrict-overflow
5094 @itemx -Wstrict-overflow=@var{n}
5095 @opindex Wstrict-overflow
5096 @opindex Wno-strict-overflow
5097 This option is only active when signed overflow is undefined.
5098 It warns about cases where the compiler optimizes based on the
5099 assumption that signed overflow does not occur.  Note that it does not
5100 warn about all cases where the code might overflow: it only warns
5101 about cases where the compiler implements some optimization.  Thus
5102 this warning depends on the optimization level.
5104 An optimization that assumes that signed overflow does not occur is
5105 perfectly safe if the values of the variables involved are such that
5106 overflow never does, in fact, occur.  Therefore this warning can
5107 easily give a false positive: a warning about code that is not
5108 actually a problem.  To help focus on important issues, several
5109 warning levels are defined.  No warnings are issued for the use of
5110 undefined signed overflow when estimating how many iterations a loop
5111 requires, in particular when determining whether a loop will be
5112 executed at all.
5114 @table @gcctabopt
5115 @item -Wstrict-overflow=1
5116 Warn about cases that are both questionable and easy to avoid.  For
5117 example the compiler simplifies
5118 @code{x + 1 > x} to @code{1}.  This level of
5119 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5120 are not, and must be explicitly requested.
5122 @item -Wstrict-overflow=2
5123 Also warn about other cases where a comparison is simplified to a
5124 constant.  For example: @code{abs (x) >= 0}.  This can only be
5125 simplified when signed integer overflow is undefined, because
5126 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5127 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5128 @option{-Wstrict-overflow=2}.
5130 @item -Wstrict-overflow=3
5131 Also warn about other cases where a comparison is simplified.  For
5132 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5134 @item -Wstrict-overflow=4
5135 Also warn about other simplifications not covered by the above cases.
5136 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5138 @item -Wstrict-overflow=5
5139 Also warn about cases where the compiler reduces the magnitude of a
5140 constant involved in a comparison.  For example: @code{x + 2 > y} is
5141 simplified to @code{x + 1 >= y}.  This is reported only at the
5142 highest warning level because this simplification applies to many
5143 comparisons, so this warning level gives a very large number of
5144 false positives.
5145 @end table
5147 @item -Wstringop-overflow
5148 @itemx -Wstringop-overflow=@var{type}
5149 @opindex Wstringop-overflow
5150 @opindex Wno-stringop-overflow
5151 Warn for calls to string manipulation functions such as @code{memcpy} and
5152 @code{strcpy} that are determined to overflow the destination buffer.  The
5153 optional argument is one greater than the type of Object Size Checking to
5154 perform to determine the size of the destination.  @xref{Object Size Checking}.
5155 The argument is meaningful only for functions that operate on character arrays
5156 but not for raw memory functions like @code{memcpy} which always make use
5157 of Object Size type-0.  The option also warns for calls that specify a size
5158 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5159 The option produces the best results with optimization enabled but can detect
5160 a small subset of simple buffer overflows even without optimization in
5161 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5162 correspond to the standard functions.  In any case, the option warns about
5163 just a subset of buffer overflows detected by the corresponding overflow
5164 checking built-ins.  For example, the option will issue a warning for
5165 the @code{strcpy} call below because it copies at least 5 characters
5166 (the string @code{"blue"} including the terminating NUL) into the buffer
5167 of size 4.
5169 @smallexample
5170 enum Color @{ blue, purple, yellow @};
5171 const char* f (enum Color clr)
5173   static char buf [4];
5174   const char *str;
5175   switch (clr)
5176     @{
5177       case blue: str = "blue"; break;
5178       case purple: str = "purple"; break;
5179       case yellow: str = "yellow"; break;
5180     @}
5182   return strcpy (buf, str);   // warning here
5184 @end smallexample
5186 Option @option{-Wstringop-overflow=2} is enabled by default.
5188 @table @gcctabopt
5189 @item -Wstringop-overflow
5190 @item -Wstringop-overflow=1
5191 @opindex Wstringop-overflow
5192 @opindex Wno-stringop-overflow
5193 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5194 to determine the sizes of destination objects.  This is the default setting
5195 of the option.  At this setting the option will not warn for writes past
5196 the end of subobjects of larger objects accessed by pointers unless the
5197 size of the largest surrounding object is known.  When the destination may
5198 be one of several objects it is assumed to be the largest one of them.  On
5199 Linux systems, when optimization is enabled at this setting the option warns
5200 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5201 a non-zero value.
5203 @item -Wstringop-overflow=2
5204 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5205 to determine the sizes of destination objects.  At this setting the option
5206 will warn about overflows when writing to members of the largest complete
5207 objects whose exact size is known.  It will, however, not warn for excessive
5208 writes to the same members of unknown objects referenced by pointers since
5209 they may point to arrays containing unknown numbers of elements.
5211 @item -Wstringop-overflow=3
5212 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5213 to determine the sizes of destination objects.  At this setting the option
5214 warns about overflowing the smallest object or data member.  This is the
5215 most restrictive setting of the option that may result in warnings for safe
5216 code.
5218 @item -Wstringop-overflow=4
5219 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5220 to determine the sizes of destination objects.  At this setting the option
5221 will warn about overflowing any data members, and when the destination is
5222 one of several objects it uses the size of the largest of them to decide
5223 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5224 setting of the option may result in warnings for benign code.
5225 @end table
5227 @item -Wstringop-truncation
5228 @opindex Wstringop-truncation
5229 @opindex Wno-stringop-truncation
5230 Warn for calls to bounded string manipulation functions such as @code{strncat},
5231 @code{strncpy}, and @code{stpncpy} that may either truncate the copied string
5232 or leave the destination unchanged.
5234 In the following example, the call to @code{strncat} specifies a bound that
5235 is less than the length of the source string.  As a result, the copy of
5236 the source will be truncated and so the call is diagnosed.  To avoid the
5237 warning use @code{bufsize - strlen (buf) - 1)} as the bound.
5239 @smallexample
5240 void append (char *buf, size_t bufsize)
5242   strncat (buf, ".txt", 3);
5244 @end smallexample
5246 As another example, the following call to @code{strncpy} results in copying
5247 to @code{d} just the characters preceding the terminating NUL, without
5248 appending the NUL to the end.  Assuming the result of @code{strncpy} is
5249 necessarily a NUL-terminated string is a common mistake, and so the call
5250 is diagnosed.  To avoid the warning when the result is not expected to be
5251 NUL-terminated, call @code{memcpy} instead.
5253 @smallexample
5254 void copy (char *d, const char *s)
5256   strncpy (d, s, strlen (s));
5258 @end smallexample
5260 In the following example, the call to @code{strncpy} specifies the size
5261 of the destination buffer as the bound.  If the length of the source
5262 string is equal to or greater than this size the result of the copy will
5263 not be NUL-terminated.  Therefore, the call is also diagnosed.  To avoid
5264 the warning, specify @code{sizeof buf - 1} as the bound and set the last
5265 element of the buffer to @code{NUL}.
5267 @smallexample
5268 void copy (const char *s)
5270   char buf[80];
5271   strncpy (buf, s, sizeof buf);
5272   @dots{}
5274 @end smallexample
5276 In situations where a character array is intended to store a sequence
5277 of bytes with no terminating @code{NUL} such an array may be annotated
5278 with attribute @code{nonstring} to avoid this warning.  Such arrays,
5279 however, are not suitable arguments to functions that expect
5280 @code{NUL}-terminated strings.  To help detect accidental misuses of
5281 such arrays GCC issues warnings unless it can prove that the use is
5282 safe.  @xref{Common Variable Attributes}.
5284 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{|}cold@r{|}malloc@r{]}
5285 @opindex Wsuggest-attribute=
5286 @opindex Wno-suggest-attribute=
5287 Warn for cases where adding an attribute may be beneficial. The
5288 attributes currently supported are listed below.
5290 @table @gcctabopt
5291 @item -Wsuggest-attribute=pure
5292 @itemx -Wsuggest-attribute=const
5293 @itemx -Wsuggest-attribute=noreturn
5294 @itemx -Wsuggest-attribute=malloc
5295 @opindex Wsuggest-attribute=pure
5296 @opindex Wno-suggest-attribute=pure
5297 @opindex Wsuggest-attribute=const
5298 @opindex Wno-suggest-attribute=const
5299 @opindex Wsuggest-attribute=noreturn
5300 @opindex Wno-suggest-attribute=noreturn
5301 @opindex Wsuggest-attribute=malloc
5302 @opindex Wno-suggest-attribute=malloc
5304 Warn about functions that might be candidates for attributes
5305 @code{pure}, @code{const} or @code{noreturn} or @code{malloc}. The compiler
5306 only warns for functions visible in other compilation units or (in the case of
5307 @code{pure} and @code{const}) if it cannot prove that the function returns
5308 normally. A function returns normally if it doesn't contain an infinite loop or
5309 return abnormally by throwing, calling @code{abort} or trapping.  This analysis
5310 requires option @option{-fipa-pure-const}, which is enabled by default at
5311 @option{-O} and higher.  Higher optimization levels improve the accuracy
5312 of the analysis.
5314 @item -Wsuggest-attribute=format
5315 @itemx -Wmissing-format-attribute
5316 @opindex Wsuggest-attribute=format
5317 @opindex Wmissing-format-attribute
5318 @opindex Wno-suggest-attribute=format
5319 @opindex Wno-missing-format-attribute
5320 @opindex Wformat
5321 @opindex Wno-format
5323 Warn about function pointers that might be candidates for @code{format}
5324 attributes.  Note these are only possible candidates, not absolute ones.
5325 GCC guesses that function pointers with @code{format} attributes that
5326 are used in assignment, initialization, parameter passing or return
5327 statements should have a corresponding @code{format} attribute in the
5328 resulting type.  I.e.@: the left-hand side of the assignment or
5329 initialization, the type of the parameter variable, or the return type
5330 of the containing function respectively should also have a @code{format}
5331 attribute to avoid the warning.
5333 GCC also warns about function definitions that might be
5334 candidates for @code{format} attributes.  Again, these are only
5335 possible candidates.  GCC guesses that @code{format} attributes
5336 might be appropriate for any function that calls a function like
5337 @code{vprintf} or @code{vscanf}, but this might not always be the
5338 case, and some functions for which @code{format} attributes are
5339 appropriate may not be detected.
5341 @item -Wsuggest-attribute=cold
5342 @opindex Wsuggest-attribute=cold
5343 @opindex Wno-suggest-attribute=cold
5345 Warn about functions that might be candidates for @code{cold} attribute.  This
5346 is based on static detection and generally will only warn about functions which
5347 always leads to a call to another @code{cold} function such as wrappers of
5348 C++ @code{throw} or fatal error reporting functions leading to @code{abort}.
5349 @end table
5351 @item -Wsuggest-final-types
5352 @opindex Wno-suggest-final-types
5353 @opindex Wsuggest-final-types
5354 Warn about types with virtual methods where code quality would be improved
5355 if the type were declared with the C++11 @code{final} specifier, 
5356 or, if possible,
5357 declared in an anonymous namespace. This allows GCC to more aggressively
5358 devirtualize the polymorphic calls. This warning is more effective with link
5359 time optimization, where the information about the class hierarchy graph is
5360 more complete.
5362 @item -Wsuggest-final-methods
5363 @opindex Wno-suggest-final-methods
5364 @opindex Wsuggest-final-methods
5365 Warn about virtual methods where code quality would be improved if the method
5366 were declared with the C++11 @code{final} specifier, 
5367 or, if possible, its type were
5368 declared in an anonymous namespace or with the @code{final} specifier.
5369 This warning is
5370 more effective with link-time optimization, where the information about the
5371 class hierarchy graph is more complete. It is recommended to first consider
5372 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5373 annotations.
5375 @item -Wsuggest-override
5376 Warn about overriding virtual functions that are not marked with the override
5377 keyword.
5379 @item -Walloc-zero
5380 @opindex Wno-alloc-zero
5381 @opindex Walloc-zero
5382 Warn about calls to allocation functions decorated with attribute
5383 @code{alloc_size} that specify zero bytes, including those to the built-in
5384 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5385 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5386 when called with a zero size differs among implementations (and in the case
5387 of @code{realloc} has been deprecated) relying on it may result in subtle
5388 portability bugs and should be avoided.
5390 @item -Walloc-size-larger-than=@var{n}
5391 Warn about calls to functions decorated with attribute @code{alloc_size}
5392 that attempt to allocate objects larger than the specified number of bytes,
5393 or where the result of the size computation in an integer type with infinite
5394 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5395 may end in one of the standard suffixes designating a multiple of bytes
5396 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5397 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5398 @xref{Function Attributes}.
5400 @item -Walloca
5401 @opindex Wno-alloca
5402 @opindex Walloca
5403 This option warns on all uses of @code{alloca} in the source.
5405 @item -Walloca-larger-than=@var{n}
5406 This option warns on calls to @code{alloca} that are not bounded by a
5407 controlling predicate limiting its argument of integer type to at most
5408 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5409 Arguments of non-integer types are considered unbounded even if they
5410 appear to be constrained to the expected range.
5412 For example, a bounded case of @code{alloca} could be:
5414 @smallexample
5415 void func (size_t n)
5417   void *p;
5418   if (n <= 1000)
5419     p = alloca (n);
5420   else
5421     p = malloc (n);
5422   f (p);
5424 @end smallexample
5426 In the above example, passing @code{-Walloca-larger-than=1000} would not
5427 issue a warning because the call to @code{alloca} is known to be at most
5428 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5429 the compiler would emit a warning.
5431 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5432 controlling predicate constraining its integer argument.  For example:
5434 @smallexample
5435 void func ()
5437   void *p = alloca (n);
5438   f (p);
5440 @end smallexample
5442 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5443 a warning, but this time because of the lack of bounds checking.
5445 Note, that even seemingly correct code involving signed integers could
5446 cause a warning:
5448 @smallexample
5449 void func (signed int n)
5451   if (n < 500)
5452     @{
5453       p = alloca (n);
5454       f (p);
5455     @}
5457 @end smallexample
5459 In the above example, @var{n} could be negative, causing a larger than
5460 expected argument to be implicitly cast into the @code{alloca} call.
5462 This option also warns when @code{alloca} is used in a loop.
5464 This warning is not enabled by @option{-Wall}, and is only active when
5465 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5467 See also @option{-Wvla-larger-than=@var{n}}.
5469 @item -Warray-bounds
5470 @itemx -Warray-bounds=@var{n}
5471 @opindex Wno-array-bounds
5472 @opindex Warray-bounds
5473 This option is only active when @option{-ftree-vrp} is active
5474 (default for @option{-O2} and above). It warns about subscripts to arrays
5475 that are always out of bounds. This warning is enabled by @option{-Wall}.
5477 @table @gcctabopt
5478 @item -Warray-bounds=1
5479 This is the warning level of @option{-Warray-bounds} and is enabled
5480 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5482 @item -Warray-bounds=2
5483 This warning level also warns about out of bounds access for
5484 arrays at the end of a struct and for arrays accessed through
5485 pointers. This warning level may give a larger number of
5486 false positives and is deactivated by default.
5487 @end table
5489 @item -Wattribute-alias
5490 Warn about declarations using the @code{alias} and similar attributes whose
5491 target is incompatible with the type of the alias.  @xref{Function Attributes,
5492 ,Declaring Attributes of Functions}.
5494 @item -Wbool-compare
5495 @opindex Wno-bool-compare
5496 @opindex Wbool-compare
5497 Warn about boolean expression compared with an integer value different from
5498 @code{true}/@code{false}.  For instance, the following comparison is
5499 always false:
5500 @smallexample
5501 int n = 5;
5502 @dots{}
5503 if ((n > 1) == 2) @{ @dots{} @}
5504 @end smallexample
5505 This warning is enabled by @option{-Wall}.
5507 @item -Wbool-operation
5508 @opindex Wno-bool-operation
5509 @opindex Wbool-operation
5510 Warn about suspicious operations on expressions of a boolean type.  For
5511 instance, bitwise negation of a boolean is very likely a bug in the program.
5512 For C, this warning also warns about incrementing or decrementing a boolean,
5513 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5514 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5516 This warning is enabled by @option{-Wall}.
5518 @item -Wduplicated-branches
5519 @opindex Wno-duplicated-branches
5520 @opindex Wduplicated-branches
5521 Warn when an if-else has identical branches.  This warning detects cases like
5522 @smallexample
5523 if (p != NULL)
5524   return 0;
5525 else
5526   return 0;
5527 @end smallexample
5528 It doesn't warn when both branches contain just a null statement.  This warning
5529 also warn for conditional operators:
5530 @smallexample
5531   int i = x ? *p : *p;
5532 @end smallexample
5534 @item -Wduplicated-cond
5535 @opindex Wno-duplicated-cond
5536 @opindex Wduplicated-cond
5537 Warn about duplicated conditions in an if-else-if chain.  For instance,
5538 warn for the following code:
5539 @smallexample
5540 if (p->q != NULL) @{ @dots{} @}
5541 else if (p->q != NULL) @{ @dots{} @}
5542 @end smallexample
5544 @item -Wframe-address
5545 @opindex Wno-frame-address
5546 @opindex Wframe-address
5547 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5548 is called with an argument greater than 0.  Such calls may return indeterminate
5549 values or crash the program.  The warning is included in @option{-Wall}.
5551 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5552 @opindex Wno-discarded-qualifiers
5553 @opindex Wdiscarded-qualifiers
5554 Do not warn if type qualifiers on pointers are being discarded.
5555 Typically, the compiler warns if a @code{const char *} variable is
5556 passed to a function that takes a @code{char *} parameter.  This option
5557 can be used to suppress such a warning.
5559 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5560 @opindex Wno-discarded-array-qualifiers
5561 @opindex Wdiscarded-array-qualifiers
5562 Do not warn if type qualifiers on arrays which are pointer targets
5563 are being discarded. Typically, the compiler warns if a
5564 @code{const int (*)[]} variable is passed to a function that
5565 takes a @code{int (*)[]} parameter.  This option can be used to
5566 suppress such a warning.
5568 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5569 @opindex Wno-incompatible-pointer-types
5570 @opindex Wincompatible-pointer-types
5571 Do not warn when there is a conversion between pointers that have incompatible
5572 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5573 which warns for pointer argument passing or assignment with different
5574 signedness.
5576 @item -Wno-int-conversion @r{(C and Objective-C only)}
5577 @opindex Wno-int-conversion
5578 @opindex Wint-conversion
5579 Do not warn about incompatible integer to pointer and pointer to integer
5580 conversions.  This warning is about implicit conversions; for explicit
5581 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5582 @option{-Wno-pointer-to-int-cast} may be used.
5584 @item -Wno-div-by-zero
5585 @opindex Wno-div-by-zero
5586 @opindex Wdiv-by-zero
5587 Do not warn about compile-time integer division by zero.  Floating-point
5588 division by zero is not warned about, as it can be a legitimate way of
5589 obtaining infinities and NaNs.
5591 @item -Wsystem-headers
5592 @opindex Wsystem-headers
5593 @opindex Wno-system-headers
5594 @cindex warnings from system headers
5595 @cindex system headers, warnings from
5596 Print warning messages for constructs found in system header files.
5597 Warnings from system headers are normally suppressed, on the assumption
5598 that they usually do not indicate real problems and would only make the
5599 compiler output harder to read.  Using this command-line option tells
5600 GCC to emit warnings from system headers as if they occurred in user
5601 code.  However, note that using @option{-Wall} in conjunction with this
5602 option does @emph{not} warn about unknown pragmas in system
5603 headers---for that, @option{-Wunknown-pragmas} must also be used.
5605 @item -Wtautological-compare
5606 @opindex Wtautological-compare
5607 @opindex Wno-tautological-compare
5608 Warn if a self-comparison always evaluates to true or false.  This
5609 warning detects various mistakes such as:
5610 @smallexample
5611 int i = 1;
5612 @dots{}
5613 if (i > i) @{ @dots{} @}
5614 @end smallexample
5616 This warning also warns about bitwise comparisons that always evaluate
5617 to true or false, for instance:
5618 @smallexample
5619 if ((a & 16) == 10) @{ @dots{} @}
5620 @end smallexample
5621 will always be false.
5623 This warning is enabled by @option{-Wall}.
5625 @item -Wtrampolines
5626 @opindex Wtrampolines
5627 @opindex Wno-trampolines
5628 Warn about trampolines generated for pointers to nested functions.
5629 A trampoline is a small piece of data or code that is created at run
5630 time on the stack when the address of a nested function is taken, and is
5631 used to call the nested function indirectly.  For some targets, it is
5632 made up of data only and thus requires no special treatment.  But, for
5633 most targets, it is made up of code and thus requires the stack to be
5634 made executable in order for the program to work properly.
5636 @item -Wfloat-equal
5637 @opindex Wfloat-equal
5638 @opindex Wno-float-equal
5639 Warn if floating-point values are used in equality comparisons.
5641 The idea behind this is that sometimes it is convenient (for the
5642 programmer) to consider floating-point values as approximations to
5643 infinitely precise real numbers.  If you are doing this, then you need
5644 to compute (by analyzing the code, or in some other way) the maximum or
5645 likely maximum error that the computation introduces, and allow for it
5646 when performing comparisons (and when producing output, but that's a
5647 different problem).  In particular, instead of testing for equality, you
5648 should check to see whether the two values have ranges that overlap; and
5649 this is done with the relational operators, so equality comparisons are
5650 probably mistaken.
5652 @item -Wtraditional @r{(C and Objective-C only)}
5653 @opindex Wtraditional
5654 @opindex Wno-traditional
5655 Warn about certain constructs that behave differently in traditional and
5656 ISO C@.  Also warn about ISO C constructs that have no traditional C
5657 equivalent, and/or problematic constructs that should be avoided.
5659 @itemize @bullet
5660 @item
5661 Macro parameters that appear within string literals in the macro body.
5662 In traditional C macro replacement takes place within string literals,
5663 but in ISO C it does not.
5665 @item
5666 In traditional C, some preprocessor directives did not exist.
5667 Traditional preprocessors only considered a line to be a directive
5668 if the @samp{#} appeared in column 1 on the line.  Therefore
5669 @option{-Wtraditional} warns about directives that traditional C
5670 understands but ignores because the @samp{#} does not appear as the
5671 first character on the line.  It also suggests you hide directives like
5672 @code{#pragma} not understood by traditional C by indenting them.  Some
5673 traditional implementations do not recognize @code{#elif}, so this option
5674 suggests avoiding it altogether.
5676 @item
5677 A function-like macro that appears without arguments.
5679 @item
5680 The unary plus operator.
5682 @item
5683 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5684 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5685 constants.)  Note, these suffixes appear in macros defined in the system
5686 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5687 Use of these macros in user code might normally lead to spurious
5688 warnings, however GCC's integrated preprocessor has enough context to
5689 avoid warning in these cases.
5691 @item
5692 A function declared external in one block and then used after the end of
5693 the block.
5695 @item
5696 A @code{switch} statement has an operand of type @code{long}.
5698 @item
5699 A non-@code{static} function declaration follows a @code{static} one.
5700 This construct is not accepted by some traditional C compilers.
5702 @item
5703 The ISO type of an integer constant has a different width or
5704 signedness from its traditional type.  This warning is only issued if
5705 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5706 typically represent bit patterns, are not warned about.
5708 @item
5709 Usage of ISO string concatenation is detected.
5711 @item
5712 Initialization of automatic aggregates.
5714 @item
5715 Identifier conflicts with labels.  Traditional C lacks a separate
5716 namespace for labels.
5718 @item
5719 Initialization of unions.  If the initializer is zero, the warning is
5720 omitted.  This is done under the assumption that the zero initializer in
5721 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5722 initializer warnings and relies on default initialization to zero in the
5723 traditional C case.
5725 @item
5726 Conversions by prototypes between fixed/floating-point values and vice
5727 versa.  The absence of these prototypes when compiling with traditional
5728 C causes serious problems.  This is a subset of the possible
5729 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5731 @item
5732 Use of ISO C style function definitions.  This warning intentionally is
5733 @emph{not} issued for prototype declarations or variadic functions
5734 because these ISO C features appear in your code when using
5735 libiberty's traditional C compatibility macros, @code{PARAMS} and
5736 @code{VPARAMS}.  This warning is also bypassed for nested functions
5737 because that feature is already a GCC extension and thus not relevant to
5738 traditional C compatibility.
5739 @end itemize
5741 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5742 @opindex Wtraditional-conversion
5743 @opindex Wno-traditional-conversion
5744 Warn if a prototype causes a type conversion that is different from what
5745 would happen to the same argument in the absence of a prototype.  This
5746 includes conversions of fixed point to floating and vice versa, and
5747 conversions changing the width or signedness of a fixed-point argument
5748 except when the same as the default promotion.
5750 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5751 @opindex Wdeclaration-after-statement
5752 @opindex Wno-declaration-after-statement
5753 Warn when a declaration is found after a statement in a block.  This
5754 construct, known from C++, was introduced with ISO C99 and is by default
5755 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5757 @item -Wshadow
5758 @opindex Wshadow
5759 @opindex Wno-shadow
5760 Warn whenever a local variable or type declaration shadows another
5761 variable, parameter, type, class member (in C++), or instance variable
5762 (in Objective-C) or whenever a built-in function is shadowed. Note
5763 that in C++, the compiler warns if a local variable shadows an
5764 explicit typedef, but not if it shadows a struct/class/enum.
5765 Same as @option{-Wshadow=global}.
5767 @item -Wno-shadow-ivar @r{(Objective-C only)}
5768 @opindex Wno-shadow-ivar
5769 @opindex Wshadow-ivar
5770 Do not warn whenever a local variable shadows an instance variable in an
5771 Objective-C method.
5773 @item -Wshadow=global
5774 @opindex Wshadow=local
5775 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5777 @item -Wshadow=local
5778 @opindex Wshadow=local
5779 Warn when a local variable shadows another local variable or parameter.
5780 This warning is enabled by @option{-Wshadow=global}.
5782 @item -Wshadow=compatible-local
5783 @opindex Wshadow=compatible-local
5784 Warn when a local variable shadows another local variable or parameter
5785 whose type is compatible with that of the shadowing variable. In C++,
5786 type compatibility here means the type of the shadowing variable can be
5787 converted to that of the shadowed variable. The creation of this flag
5788 (in addition to @option{-Wshadow=local}) is based on the idea that when
5789 a local variable shadows another one of incompatible type, it is most
5790 likely intentional, not a bug or typo, as shown in the following example:
5792 @smallexample
5793 @group
5794 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5796   for (int i = 0; i < N; ++i)
5797   @{
5798     ...
5799   @}
5800   ...
5802 @end group
5803 @end smallexample
5805 Since the two variable @code{i} in the example above have incompatible types,
5806 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5807 Because their types are incompatible, if a programmer accidentally uses one
5808 in place of the other, type checking will catch that and emit an error or
5809 warning. So not warning (about shadowing) in this case will not lead to
5810 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5811 possibly reduce the number of warnings triggered by intentional shadowing.
5813 This warning is enabled by @option{-Wshadow=local}.
5815 @item -Wlarger-than=@var{len}
5816 @opindex Wlarger-than=@var{len}
5817 @opindex Wlarger-than-@var{len}
5818 Warn whenever an object of larger than @var{len} bytes is defined.
5820 @item -Wframe-larger-than=@var{len}
5821 @opindex Wframe-larger-than
5822 Warn if the size of a function frame is larger than @var{len} bytes.
5823 The computation done to determine the stack frame size is approximate
5824 and not conservative.
5825 The actual requirements may be somewhat greater than @var{len}
5826 even if you do not get a warning.  In addition, any space allocated
5827 via @code{alloca}, variable-length arrays, or related constructs
5828 is not included by the compiler when determining
5829 whether or not to issue a warning.
5831 @item -Wno-free-nonheap-object
5832 @opindex Wno-free-nonheap-object
5833 @opindex Wfree-nonheap-object
5834 Do not warn when attempting to free an object that was not allocated
5835 on the heap.
5837 @item -Wstack-usage=@var{len}
5838 @opindex Wstack-usage
5839 Warn if the stack usage of a function might be larger than @var{len} bytes.
5840 The computation done to determine the stack usage is conservative.
5841 Any space allocated via @code{alloca}, variable-length arrays, or related
5842 constructs is included by the compiler when determining whether or not to
5843 issue a warning.
5845 The message is in keeping with the output of @option{-fstack-usage}.
5847 @itemize
5848 @item
5849 If the stack usage is fully static but exceeds the specified amount, it's:
5851 @smallexample
5852   warning: stack usage is 1120 bytes
5853 @end smallexample
5854 @item
5855 If the stack usage is (partly) dynamic but bounded, it's:
5857 @smallexample
5858   warning: stack usage might be 1648 bytes
5859 @end smallexample
5860 @item
5861 If the stack usage is (partly) dynamic and not bounded, it's:
5863 @smallexample
5864   warning: stack usage might be unbounded
5865 @end smallexample
5866 @end itemize
5868 @item -Wunsafe-loop-optimizations
5869 @opindex Wunsafe-loop-optimizations
5870 @opindex Wno-unsafe-loop-optimizations
5871 Warn if the loop cannot be optimized because the compiler cannot
5872 assume anything on the bounds of the loop indices.  With
5873 @option{-funsafe-loop-optimizations} warn if the compiler makes
5874 such assumptions.
5876 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5877 @opindex Wno-pedantic-ms-format
5878 @opindex Wpedantic-ms-format
5879 When used in combination with @option{-Wformat}
5880 and @option{-pedantic} without GNU extensions, this option
5881 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5882 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5883 which depend on the MS runtime.
5885 @item -Waligned-new
5886 @opindex Waligned-new
5887 @opindex Wno-aligned-new
5888 Warn about a new-expression of a type that requires greater alignment
5889 than the @code{alignof(std::max_align_t)} but uses an allocation
5890 function without an explicit alignment parameter. This option is
5891 enabled by @option{-Wall}.
5893 Normally this only warns about global allocation functions, but
5894 @option{-Waligned-new=all} also warns about class member allocation
5895 functions.
5897 @item -Wplacement-new
5898 @itemx -Wplacement-new=@var{n}
5899 @opindex Wplacement-new
5900 @opindex Wno-placement-new
5901 Warn about placement new expressions with undefined behavior, such as
5902 constructing an object in a buffer that is smaller than the type of
5903 the object.  For example, the placement new expression below is diagnosed
5904 because it attempts to construct an array of 64 integers in a buffer only
5905 64 bytes large.
5906 @smallexample
5907 char buf [64];
5908 new (buf) int[64];
5909 @end smallexample
5910 This warning is enabled by default.
5912 @table @gcctabopt
5913 @item -Wplacement-new=1
5914 This is the default warning level of @option{-Wplacement-new}.  At this
5915 level the warning is not issued for some strictly undefined constructs that
5916 GCC allows as extensions for compatibility with legacy code.  For example,
5917 the following @code{new} expression is not diagnosed at this level even
5918 though it has undefined behavior according to the C++ standard because
5919 it writes past the end of the one-element array.
5920 @smallexample
5921 struct S @{ int n, a[1]; @};
5922 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5923 new (s->a)int [32]();
5924 @end smallexample
5926 @item -Wplacement-new=2
5927 At this level, in addition to diagnosing all the same constructs as at level
5928 1, a diagnostic is also issued for placement new expressions that construct
5929 an object in the last member of structure whose type is an array of a single
5930 element and whose size is less than the size of the object being constructed.
5931 While the previous example would be diagnosed, the following construct makes
5932 use of the flexible member array extension to avoid the warning at level 2.
5933 @smallexample
5934 struct S @{ int n, a[]; @};
5935 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5936 new (s->a)int [32]();
5937 @end smallexample
5939 @end table
5941 @item -Wpointer-arith
5942 @opindex Wpointer-arith
5943 @opindex Wno-pointer-arith
5944 Warn about anything that depends on the ``size of'' a function type or
5945 of @code{void}.  GNU C assigns these types a size of 1, for
5946 convenience in calculations with @code{void *} pointers and pointers
5947 to functions.  In C++, warn also when an arithmetic operation involves
5948 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5950 @item -Wpointer-compare
5951 @opindex Wpointer-compare
5952 @opindex Wno-pointer-compare
5953 Warn if a pointer is compared with a zero character constant.  This usually
5954 means that the pointer was meant to be dereferenced.  For example:
5956 @smallexample
5957 const char *p = foo ();
5958 if (p == '\0')
5959   return 42;
5960 @end smallexample
5962 Note that the code above is invalid in C++11.
5964 This warning is enabled by default.
5966 @item -Wtype-limits
5967 @opindex Wtype-limits
5968 @opindex Wno-type-limits
5969 Warn if a comparison is always true or always false due to the limited
5970 range of the data type, but do not warn for constant expressions.  For
5971 example, warn if an unsigned variable is compared against zero with
5972 @code{<} or @code{>=}.  This warning is also enabled by
5973 @option{-Wextra}.
5975 @include cppwarnopts.texi
5977 @item -Wbad-function-cast @r{(C and Objective-C only)}
5978 @opindex Wbad-function-cast
5979 @opindex Wno-bad-function-cast
5980 Warn when a function call is cast to a non-matching type.
5981 For example, warn if a call to a function returning an integer type 
5982 is cast to a pointer type.
5984 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5985 @opindex Wc90-c99-compat
5986 @opindex Wno-c90-c99-compat
5987 Warn about features not present in ISO C90, but present in ISO C99.
5988 For instance, warn about use of variable length arrays, @code{long long}
5989 type, @code{bool} type, compound literals, designated initializers, and so
5990 on.  This option is independent of the standards mode.  Warnings are disabled
5991 in the expression that follows @code{__extension__}.
5993 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5994 @opindex Wc99-c11-compat
5995 @opindex Wno-c99-c11-compat
5996 Warn about features not present in ISO C99, but present in ISO C11.
5997 For instance, warn about use of anonymous structures and unions,
5998 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5999 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
6000 and so on.  This option is independent of the standards mode.  Warnings are
6001 disabled in the expression that follows @code{__extension__}.
6003 @item -Wc++-compat @r{(C and Objective-C only)}
6004 @opindex Wc++-compat
6005 Warn about ISO C constructs that are outside of the common subset of
6006 ISO C and ISO C++, e.g.@: request for implicit conversion from
6007 @code{void *} to a pointer to non-@code{void} type.
6009 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
6010 @opindex Wc++11-compat
6011 Warn about C++ constructs whose meaning differs between ISO C++ 1998
6012 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
6013 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
6014 enabled by @option{-Wall}.
6016 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
6017 @opindex Wc++14-compat
6018 Warn about C++ constructs whose meaning differs between ISO C++ 2011
6019 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
6021 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
6022 @opindex Wc++17-compat
6023 Warn about C++ constructs whose meaning differs between ISO C++ 2014
6024 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
6026 @item -Wcast-qual
6027 @opindex Wcast-qual
6028 @opindex Wno-cast-qual
6029 Warn whenever a pointer is cast so as to remove a type qualifier from
6030 the target type.  For example, warn if a @code{const char *} is cast
6031 to an ordinary @code{char *}.
6033 Also warn when making a cast that introduces a type qualifier in an
6034 unsafe way.  For example, casting @code{char **} to @code{const char **}
6035 is unsafe, as in this example:
6037 @smallexample
6038   /* p is char ** value.  */
6039   const char **q = (const char **) p;
6040   /* Assignment of readonly string to const char * is OK.  */
6041   *q = "string";
6042   /* Now char** pointer points to read-only memory.  */
6043   **p = 'b';
6044 @end smallexample
6046 @item -Wcast-align
6047 @opindex Wcast-align
6048 @opindex Wno-cast-align
6049 Warn whenever a pointer is cast such that the required alignment of the
6050 target is increased.  For example, warn if a @code{char *} is cast to
6051 an @code{int *} on machines where integers can only be accessed at
6052 two- or four-byte boundaries.
6054 @item -Wcast-align=strict
6055 @opindex Wcast-align=strict
6056 Warn whenever a pointer is cast such that the required alignment of the
6057 target is increased.  For example, warn if a @code{char *} is cast to
6058 an @code{int *} regardless of the target machine.
6060 @item -Wcast-function-type
6061 @opindex Wcast-function-type
6062 @opindex Wno-cast-function-type
6063 Warn when a function pointer is cast to an incompatible function pointer.
6064 In a cast involving function types with a variable argument list only
6065 the types of initial arguments that are provided are considered.
6066 Any parameter of pointer-type matches any other pointer-type.  Any benign
6067 differences in integral types are ignored, like @code{int} vs. @code{long}
6068 on ILP32 targets.  Likewise type qualifiers are ignored.  The function
6069 type @code{void (*) (void)} is special and matches everything, which can
6070 be used to suppress this warning.
6071 In a cast involving pointer to member types this warning warns whenever
6072 the type cast is changing the pointer to member type.
6073 This warning is enabled by @option{-Wextra}.
6075 @item -Wwrite-strings
6076 @opindex Wwrite-strings
6077 @opindex Wno-write-strings
6078 When compiling C, give string constants the type @code{const
6079 char[@var{length}]} so that copying the address of one into a
6080 non-@code{const} @code{char *} pointer produces a warning.  These
6081 warnings help you find at compile time code that can try to write
6082 into a string constant, but only if you have been very careful about
6083 using @code{const} in declarations and prototypes.  Otherwise, it is
6084 just a nuisance. This is why we did not make @option{-Wall} request
6085 these warnings.
6087 When compiling C++, warn about the deprecated conversion from string
6088 literals to @code{char *}.  This warning is enabled by default for C++
6089 programs.
6091 @item -Wcatch-value
6092 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
6093 @opindex Wcatch-value
6094 @opindex Wno-catch-value
6095 Warn about catch handlers that do not catch via reference.
6096 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
6097 warn about polymorphic class types that are caught by value.
6098 With @option{-Wcatch-value=2} warn about all class types that are caught
6099 by value. With @option{-Wcatch-value=3} warn about all types that are
6100 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
6102 @item -Wclobbered
6103 @opindex Wclobbered
6104 @opindex Wno-clobbered
6105 Warn for variables that might be changed by @code{longjmp} or
6106 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
6108 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
6109 @opindex Wconditionally-supported
6110 @opindex Wno-conditionally-supported
6111 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
6113 @item -Wconversion
6114 @opindex Wconversion
6115 @opindex Wno-conversion
6116 Warn for implicit conversions that may alter a value. This includes
6117 conversions between real and integer, like @code{abs (x)} when
6118 @code{x} is @code{double}; conversions between signed and unsigned,
6119 like @code{unsigned ui = -1}; and conversions to smaller types, like
6120 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
6121 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
6122 changed by the conversion like in @code{abs (2.0)}.  Warnings about
6123 conversions between signed and unsigned integers can be disabled by
6124 using @option{-Wno-sign-conversion}.
6126 For C++, also warn for confusing overload resolution for user-defined
6127 conversions; and conversions that never use a type conversion
6128 operator: conversions to @code{void}, the same type, a base class or a
6129 reference to them. Warnings about conversions between signed and
6130 unsigned integers are disabled by default in C++ unless
6131 @option{-Wsign-conversion} is explicitly enabled.
6133 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6134 @opindex Wconversion-null
6135 @opindex Wno-conversion-null
6136 Do not warn for conversions between @code{NULL} and non-pointer
6137 types. @option{-Wconversion-null} is enabled by default.
6139 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6140 @opindex Wzero-as-null-pointer-constant
6141 @opindex Wno-zero-as-null-pointer-constant
6142 Warn when a literal @samp{0} is used as null pointer constant.  This can
6143 be useful to facilitate the conversion to @code{nullptr} in C++11.
6145 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6146 @opindex Wsubobject-linkage
6147 @opindex Wno-subobject-linkage
6148 Warn if a class type has a base or a field whose type uses the anonymous
6149 namespace or depends on a type with no linkage.  If a type A depends on
6150 a type B with no or internal linkage, defining it in multiple
6151 translation units would be an ODR violation because the meaning of B
6152 is different in each translation unit.  If A only appears in a single
6153 translation unit, the best way to silence the warning is to give it
6154 internal linkage by putting it in an anonymous namespace as well.  The
6155 compiler doesn't give this warning for types defined in the main .C
6156 file, as those are unlikely to have multiple definitions.
6157 @option{-Wsubobject-linkage} is enabled by default.
6159 @item -Wdangling-else
6160 @opindex Wdangling-else
6161 @opindex Wno-dangling-else
6162 Warn about constructions where there may be confusion to which
6163 @code{if} statement an @code{else} branch belongs.  Here is an example of
6164 such a case:
6166 @smallexample
6167 @group
6169   if (a)
6170     if (b)
6171       foo ();
6172   else
6173     bar ();
6175 @end group
6176 @end smallexample
6178 In C/C++, every @code{else} branch belongs to the innermost possible
6179 @code{if} statement, which in this example is @code{if (b)}.  This is
6180 often not what the programmer expected, as illustrated in the above
6181 example by indentation the programmer chose.  When there is the
6182 potential for this confusion, GCC issues a warning when this flag
6183 is specified.  To eliminate the warning, add explicit braces around
6184 the innermost @code{if} statement so there is no way the @code{else}
6185 can belong to the enclosing @code{if}.  The resulting code
6186 looks like this:
6188 @smallexample
6189 @group
6191   if (a)
6192     @{
6193       if (b)
6194         foo ();
6195       else
6196         bar ();
6197     @}
6199 @end group
6200 @end smallexample
6202 This warning is enabled by @option{-Wparentheses}.
6204 @item -Wdate-time
6205 @opindex Wdate-time
6206 @opindex Wno-date-time
6207 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6208 are encountered as they might prevent bit-wise-identical reproducible
6209 compilations.
6211 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6212 @opindex Wdelete-incomplete
6213 @opindex Wno-delete-incomplete
6214 Warn when deleting a pointer to incomplete type, which may cause
6215 undefined behavior at runtime.  This warning is enabled by default.
6217 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6218 @opindex Wuseless-cast
6219 @opindex Wno-useless-cast
6220 Warn when an expression is casted to its own type.
6222 @item -Wempty-body
6223 @opindex Wempty-body
6224 @opindex Wno-empty-body
6225 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6226 while} statement.  This warning is also enabled by @option{-Wextra}.
6228 @item -Wenum-compare
6229 @opindex Wenum-compare
6230 @opindex Wno-enum-compare
6231 Warn about a comparison between values of different enumerated types.
6232 In C++ enumerated type mismatches in conditional expressions are also
6233 diagnosed and the warning is enabled by default.  In C this warning is 
6234 enabled by @option{-Wall}.
6236 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6237 @opindex Wextra-semi
6238 @opindex Wno-extra-semi
6239 Warn about redundant semicolon after in-class function definition.
6241 @item -Wjump-misses-init @r{(C, Objective-C only)}
6242 @opindex Wjump-misses-init
6243 @opindex Wno-jump-misses-init
6244 Warn if a @code{goto} statement or a @code{switch} statement jumps
6245 forward across the initialization of a variable, or jumps backward to a
6246 label after the variable has been initialized.  This only warns about
6247 variables that are initialized when they are declared.  This warning is
6248 only supported for C and Objective-C; in C++ this sort of branch is an
6249 error in any case.
6251 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6252 can be disabled with the @option{-Wno-jump-misses-init} option.
6254 @item -Wsign-compare
6255 @opindex Wsign-compare
6256 @opindex Wno-sign-compare
6257 @cindex warning for comparison of signed and unsigned values
6258 @cindex comparison of signed and unsigned values, warning
6259 @cindex signed and unsigned values, comparison warning
6260 Warn when a comparison between signed and unsigned values could produce
6261 an incorrect result when the signed value is converted to unsigned.
6262 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6263 also enabled by @option{-Wextra}.
6265 @item -Wsign-conversion
6266 @opindex Wsign-conversion
6267 @opindex Wno-sign-conversion
6268 Warn for implicit conversions that may change the sign of an integer
6269 value, like assigning a signed integer expression to an unsigned
6270 integer variable. An explicit cast silences the warning. In C, this
6271 option is enabled also by @option{-Wconversion}.
6273 @item -Wfloat-conversion
6274 @opindex Wfloat-conversion
6275 @opindex Wno-float-conversion
6276 Warn for implicit conversions that reduce the precision of a real value.
6277 This includes conversions from real to integer, and from higher precision
6278 real to lower precision real values.  This option is also enabled by
6279 @option{-Wconversion}.
6281 @item -Wno-scalar-storage-order
6282 @opindex -Wno-scalar-storage-order
6283 @opindex -Wscalar-storage-order
6284 Do not warn on suspicious constructs involving reverse scalar storage order.
6286 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6287 @opindex Wsized-deallocation
6288 @opindex Wno-sized-deallocation
6289 Warn about a definition of an unsized deallocation function
6290 @smallexample
6291 void operator delete (void *) noexcept;
6292 void operator delete[] (void *) noexcept;
6293 @end smallexample
6294 without a definition of the corresponding sized deallocation function
6295 @smallexample
6296 void operator delete (void *, std::size_t) noexcept;
6297 void operator delete[] (void *, std::size_t) noexcept;
6298 @end smallexample
6299 or vice versa.  Enabled by @option{-Wextra} along with
6300 @option{-fsized-deallocation}.
6302 @item -Wsizeof-pointer-div
6303 @opindex Wsizeof-pointer-div
6304 @opindex Wno-sizeof-pointer-div
6305 Warn for suspicious divisions of two sizeof expressions that divide
6306 the pointer size by the element size, which is the usual way to compute
6307 the array size but won't work out correctly with pointers.  This warning
6308 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6309 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6311 @item -Wsizeof-pointer-memaccess
6312 @opindex Wsizeof-pointer-memaccess
6313 @opindex Wno-sizeof-pointer-memaccess
6314 Warn for suspicious length parameters to certain string and memory built-in
6315 functions if the argument uses @code{sizeof}.  This warning triggers for
6316 example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not
6317 an array, but a pointer, and suggests a possible fix, or about
6318 @code{memcpy (&foo, ptr, sizeof (&foo));}.  @option{-Wsizeof-pointer-memaccess}
6319 also warns about calls to bounded string copy functions like @code{strncat}
6320 or @code{strncpy} that specify as the bound a @code{sizeof} expression of
6321 the source array.  For example, in the following function the call to
6322 @code{strncat} specifies the size of the source string as the bound.  That
6323 is almost certainly a mistake and so the call is diagnosed.
6324 @smallexample
6325 void make_file (const char *name)
6327   char path[PATH_MAX];
6328   strncpy (path, name, sizeof path - 1);
6329   strncat (path, ".text", sizeof ".text");
6330   @dots{}
6332 @end smallexample
6334 The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}.
6336 @item -Wsizeof-array-argument
6337 @opindex Wsizeof-array-argument
6338 @opindex Wno-sizeof-array-argument
6339 Warn when the @code{sizeof} operator is applied to a parameter that is
6340 declared as an array in a function definition.  This warning is enabled by
6341 default for C and C++ programs.
6343 @item -Wmemset-elt-size
6344 @opindex Wmemset-elt-size
6345 @opindex Wno-memset-elt-size
6346 Warn for suspicious calls to the @code{memset} built-in function, if the
6347 first argument references an array, and the third argument is a number
6348 equal to the number of elements, but not equal to the size of the array
6349 in memory.  This indicates that the user has omitted a multiplication by
6350 the element size.  This warning is enabled by @option{-Wall}.
6352 @item -Wmemset-transposed-args
6353 @opindex Wmemset-transposed-args
6354 @opindex Wno-memset-transposed-args
6355 Warn for suspicious calls to the @code{memset} built-in function, if the
6356 second argument is not zero and the third argument is zero.  This warns e.g.@
6357 about @code{memset (buf, sizeof buf, 0)} where most probably
6358 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6359 is only emitted if the third argument is literal zero.  If it is some
6360 expression that is folded to zero, a cast of zero to some type, etc., 
6361 it is far less likely that the user has mistakenly exchanged the arguments 
6362 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6364 @item -Waddress
6365 @opindex Waddress
6366 @opindex Wno-address
6367 Warn about suspicious uses of memory addresses. These include using
6368 the address of a function in a conditional expression, such as
6369 @code{void func(void); if (func)}, and comparisons against the memory
6370 address of a string literal, such as @code{if (x == "abc")}.  Such
6371 uses typically indicate a programmer error: the address of a function
6372 always evaluates to true, so their use in a conditional usually
6373 indicate that the programmer forgot the parentheses in a function
6374 call; and comparisons against string literals result in unspecified
6375 behavior and are not portable in C, so they usually indicate that the
6376 programmer intended to use @code{strcmp}.  This warning is enabled by
6377 @option{-Wall}.
6379 @item -Wlogical-op
6380 @opindex Wlogical-op
6381 @opindex Wno-logical-op
6382 Warn about suspicious uses of logical operators in expressions.
6383 This includes using logical operators in contexts where a
6384 bit-wise operator is likely to be expected.  Also warns when
6385 the operands of a logical operator are the same:
6386 @smallexample
6387 extern int a;
6388 if (a < 0 && a < 0) @{ @dots{} @}
6389 @end smallexample
6391 @item -Wlogical-not-parentheses
6392 @opindex Wlogical-not-parentheses
6393 @opindex Wno-logical-not-parentheses
6394 Warn about logical not used on the left hand side operand of a comparison.
6395 This option does not warn if the right operand is considered to be a boolean
6396 expression.  Its purpose is to detect suspicious code like the following:
6397 @smallexample
6398 int a;
6399 @dots{}
6400 if (!a > 1) @{ @dots{} @}
6401 @end smallexample
6403 It is possible to suppress the warning by wrapping the LHS into
6404 parentheses:
6405 @smallexample
6406 if ((!a) > 1) @{ @dots{} @}
6407 @end smallexample
6409 This warning is enabled by @option{-Wall}.
6411 @item -Waggregate-return
6412 @opindex Waggregate-return
6413 @opindex Wno-aggregate-return
6414 Warn if any functions that return structures or unions are defined or
6415 called.  (In languages where you can return an array, this also elicits
6416 a warning.)
6418 @item -Wno-aggressive-loop-optimizations
6419 @opindex Wno-aggressive-loop-optimizations
6420 @opindex Waggressive-loop-optimizations
6421 Warn if in a loop with constant number of iterations the compiler detects
6422 undefined behavior in some statement during one or more of the iterations.
6424 @item -Wno-attributes
6425 @opindex Wno-attributes
6426 @opindex Wattributes
6427 Do not warn if an unexpected @code{__attribute__} is used, such as
6428 unrecognized attributes, function attributes applied to variables,
6429 etc.  This does not stop errors for incorrect use of supported
6430 attributes.
6432 @item -Wno-builtin-declaration-mismatch
6433 @opindex Wno-builtin-declaration-mismatch
6434 @opindex Wbuiltin-declaration-mismatch
6435 Warn if a built-in function is declared with the wrong signature or 
6436 as non-function.
6437 This warning is enabled by default.
6439 @item -Wno-builtin-macro-redefined
6440 @opindex Wno-builtin-macro-redefined
6441 @opindex Wbuiltin-macro-redefined
6442 Do not warn if certain built-in macros are redefined.  This suppresses
6443 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6444 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6446 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6447 @opindex Wstrict-prototypes
6448 @opindex Wno-strict-prototypes
6449 Warn if a function is declared or defined without specifying the
6450 argument types.  (An old-style function definition is permitted without
6451 a warning if preceded by a declaration that specifies the argument
6452 types.)
6454 @item -Wold-style-declaration @r{(C and Objective-C only)}
6455 @opindex Wold-style-declaration
6456 @opindex Wno-old-style-declaration
6457 Warn for obsolescent usages, according to the C Standard, in a
6458 declaration. For example, warn if storage-class specifiers like
6459 @code{static} are not the first things in a declaration.  This warning
6460 is also enabled by @option{-Wextra}.
6462 @item -Wold-style-definition @r{(C and Objective-C only)}
6463 @opindex Wold-style-definition
6464 @opindex Wno-old-style-definition
6465 Warn if an old-style function definition is used.  A warning is given
6466 even if there is a previous prototype.
6468 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6469 @opindex Wmissing-parameter-type
6470 @opindex Wno-missing-parameter-type
6471 A function parameter is declared without a type specifier in K&R-style
6472 functions:
6474 @smallexample
6475 void foo(bar) @{ @}
6476 @end smallexample
6478 This warning is also enabled by @option{-Wextra}.
6480 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6481 @opindex Wmissing-prototypes
6482 @opindex Wno-missing-prototypes
6483 Warn if a global function is defined without a previous prototype
6484 declaration.  This warning is issued even if the definition itself
6485 provides a prototype.  Use this option to detect global functions
6486 that do not have a matching prototype declaration in a header file.
6487 This option is not valid for C++ because all function declarations
6488 provide prototypes and a non-matching declaration declares an
6489 overload rather than conflict with an earlier declaration.
6490 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6492 @item -Wmissing-declarations
6493 @opindex Wmissing-declarations
6494 @opindex Wno-missing-declarations
6495 Warn if a global function is defined without a previous declaration.
6496 Do so even if the definition itself provides a prototype.
6497 Use this option to detect global functions that are not declared in
6498 header files.  In C, no warnings are issued for functions with previous
6499 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6500 missing prototypes.  In C++, no warnings are issued for function templates,
6501 or for inline functions, or for functions in anonymous namespaces.
6503 @item -Wmissing-field-initializers
6504 @opindex Wmissing-field-initializers
6505 @opindex Wno-missing-field-initializers
6506 @opindex W
6507 @opindex Wextra
6508 @opindex Wno-extra
6509 Warn if a structure's initializer has some fields missing.  For
6510 example, the following code causes such a warning, because
6511 @code{x.h} is implicitly zero:
6513 @smallexample
6514 struct s @{ int f, g, h; @};
6515 struct s x = @{ 3, 4 @};
6516 @end smallexample
6518 This option does not warn about designated initializers, so the following
6519 modification does not trigger a warning:
6521 @smallexample
6522 struct s @{ int f, g, h; @};
6523 struct s x = @{ .f = 3, .g = 4 @};
6524 @end smallexample
6526 In C this option does not warn about the universal zero initializer
6527 @samp{@{ 0 @}}:
6529 @smallexample
6530 struct s @{ int f, g, h; @};
6531 struct s x = @{ 0 @};
6532 @end smallexample
6534 Likewise, in C++ this option does not warn about the empty @{ @}
6535 initializer, for example:
6537 @smallexample
6538 struct s @{ int f, g, h; @};
6539 s x = @{ @};
6540 @end smallexample
6542 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6543 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6545 @item -Wno-multichar
6546 @opindex Wno-multichar
6547 @opindex Wmultichar
6548 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6549 Usually they indicate a typo in the user's code, as they have
6550 implementation-defined values, and should not be used in portable code.
6552 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6553 @opindex Wnormalized=
6554 @opindex Wnormalized
6555 @opindex Wno-normalized
6556 @cindex NFC
6557 @cindex NFKC
6558 @cindex character set, input normalization
6559 In ISO C and ISO C++, two identifiers are different if they are
6560 different sequences of characters.  However, sometimes when characters
6561 outside the basic ASCII character set are used, you can have two
6562 different character sequences that look the same.  To avoid confusion,
6563 the ISO 10646 standard sets out some @dfn{normalization rules} which
6564 when applied ensure that two sequences that look the same are turned into
6565 the same sequence.  GCC can warn you if you are using identifiers that
6566 have not been normalized; this option controls that warning.
6568 There are four levels of warning supported by GCC@.  The default is
6569 @option{-Wnormalized=nfc}, which warns about any identifier that is
6570 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6571 recommended form for most uses.  It is equivalent to
6572 @option{-Wnormalized}.
6574 Unfortunately, there are some characters allowed in identifiers by
6575 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6576 identifiers.  That is, there's no way to use these symbols in portable
6577 ISO C or C++ and have all your identifiers in NFC@.
6578 @option{-Wnormalized=id} suppresses the warning for these characters.
6579 It is hoped that future versions of the standards involved will correct
6580 this, which is why this option is not the default.
6582 You can switch the warning off for all characters by writing
6583 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6584 only do this if you are using some other normalization scheme (like
6585 ``D''), because otherwise you can easily create bugs that are
6586 literally impossible to see.
6588 Some characters in ISO 10646 have distinct meanings but look identical
6589 in some fonts or display methodologies, especially once formatting has
6590 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6591 LETTER N'', displays just like a regular @code{n} that has been
6592 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6593 normalization scheme to convert all these into a standard form as
6594 well, and GCC warns if your code is not in NFKC if you use
6595 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6596 about every identifier that contains the letter O because it might be
6597 confused with the digit 0, and so is not the default, but may be
6598 useful as a local coding convention if the programming environment 
6599 cannot be fixed to display these characters distinctly.
6601 @item -Wno-deprecated
6602 @opindex Wno-deprecated
6603 @opindex Wdeprecated
6604 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6606 @item -Wno-deprecated-declarations
6607 @opindex Wno-deprecated-declarations
6608 @opindex Wdeprecated-declarations
6609 Do not warn about uses of functions (@pxref{Function Attributes}),
6610 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6611 Attributes}) marked as deprecated by using the @code{deprecated}
6612 attribute.
6614 @item -Wno-overflow
6615 @opindex Wno-overflow
6616 @opindex Woverflow
6617 Do not warn about compile-time overflow in constant expressions.
6619 @item -Wno-odr
6620 @opindex Wno-odr
6621 @opindex Wodr
6622 Warn about One Definition Rule violations during link-time optimization.
6623 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6625 @item -Wopenmp-simd
6626 @opindex Wopenm-simd
6627 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6628 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6629 option can be used to relax the cost model.
6631 @item -Woverride-init @r{(C and Objective-C only)}
6632 @opindex Woverride-init
6633 @opindex Wno-override-init
6634 @opindex W
6635 @opindex Wextra
6636 @opindex Wno-extra
6637 Warn if an initialized field without side effects is overridden when
6638 using designated initializers (@pxref{Designated Inits, , Designated
6639 Initializers}).
6641 This warning is included in @option{-Wextra}.  To get other
6642 @option{-Wextra} warnings without this one, use @option{-Wextra
6643 -Wno-override-init}.
6645 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6646 @opindex Woverride-init-side-effects
6647 @opindex Wno-override-init-side-effects
6648 Warn if an initialized field with side effects is overridden when
6649 using designated initializers (@pxref{Designated Inits, , Designated
6650 Initializers}).  This warning is enabled by default.
6652 @item -Wpacked
6653 @opindex Wpacked
6654 @opindex Wno-packed
6655 Warn if a structure is given the packed attribute, but the packed
6656 attribute has no effect on the layout or size of the structure.
6657 Such structures may be mis-aligned for little benefit.  For
6658 instance, in this code, the variable @code{f.x} in @code{struct bar}
6659 is misaligned even though @code{struct bar} does not itself
6660 have the packed attribute:
6662 @smallexample
6663 @group
6664 struct foo @{
6665   int x;
6666   char a, b, c, d;
6667 @} __attribute__((packed));
6668 struct bar @{
6669   char z;
6670   struct foo f;
6672 @end group
6673 @end smallexample
6675 @item -Wpacked-bitfield-compat
6676 @opindex Wpacked-bitfield-compat
6677 @opindex Wno-packed-bitfield-compat
6678 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6679 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6680 the change can lead to differences in the structure layout.  GCC
6681 informs you when the offset of such a field has changed in GCC 4.4.
6682 For example there is no longer a 4-bit padding between field @code{a}
6683 and @code{b} in this structure:
6685 @smallexample
6686 struct foo
6688   char a:4;
6689   char b:8;
6690 @} __attribute__ ((packed));
6691 @end smallexample
6693 This warning is enabled by default.  Use
6694 @option{-Wno-packed-bitfield-compat} to disable this warning.
6696 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6697 @opindex Wpacked-not-aligned
6698 @opindex Wno-packed-not-aligned
6699 Warn if a structure field with explicitly specified alignment in a
6700 packed struct or union is misaligned.  For example, a warning will
6701 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6702 'struct S' is less than 8}, in this code:
6704 @smallexample
6705 @group
6706 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6707 struct __attribute__ ((packed)) S @{
6708   struct S8 s8;
6710 @end group
6711 @end smallexample
6713 This warning is enabled by @option{-Wall}.
6715 @item -Wpadded
6716 @opindex Wpadded
6717 @opindex Wno-padded
6718 Warn if padding is included in a structure, either to align an element
6719 of the structure or to align the whole structure.  Sometimes when this
6720 happens it is possible to rearrange the fields of the structure to
6721 reduce the padding and so make the structure smaller.
6723 @item -Wredundant-decls
6724 @opindex Wredundant-decls
6725 @opindex Wno-redundant-decls
6726 Warn if anything is declared more than once in the same scope, even in
6727 cases where multiple declaration is valid and changes nothing.
6729 @item -Wno-restrict
6730 @opindex Wrestrict
6731 @opindex Wno-restrict
6732 Warn when an object referenced by a @code{restrict}-qualified parameter
6733 (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another
6734 argument, or when copies between such objects overlap.  For example,
6735 the call to the @code{strcpy} function below attempts to truncate the string
6736 by replacing its initial characters with the last four.  However, because
6737 the call writes the terminating NUL into @code{a[4]}, the copies overlap and
6738 the call is diagnosed.
6740 @smallexample
6741 struct foo
6743   char a[] = "abcd1234";
6744   strcpy (a, a + 4);
6746 @end smallexample
6747 The @option{-Wrestrict} is included in @option{-Wall}.
6749 @item -Wnested-externs @r{(C and Objective-C only)}
6750 @opindex Wnested-externs
6751 @opindex Wno-nested-externs
6752 Warn if an @code{extern} declaration is encountered within a function.
6754 @item -Wno-inherited-variadic-ctor
6755 @opindex Winherited-variadic-ctor
6756 @opindex Wno-inherited-variadic-ctor
6757 Suppress warnings about use of C++11 inheriting constructors when the
6758 base class inherited from has a C variadic constructor; the warning is
6759 on by default because the ellipsis is not inherited.
6761 @item -Winline
6762 @opindex Winline
6763 @opindex Wno-inline
6764 Warn if a function that is declared as inline cannot be inlined.
6765 Even with this option, the compiler does not warn about failures to
6766 inline functions declared in system headers.
6768 The compiler uses a variety of heuristics to determine whether or not
6769 to inline a function.  For example, the compiler takes into account
6770 the size of the function being inlined and the amount of inlining
6771 that has already been done in the current function.  Therefore,
6772 seemingly insignificant changes in the source program can cause the
6773 warnings produced by @option{-Winline} to appear or disappear.
6775 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6776 @opindex Wno-invalid-offsetof
6777 @opindex Winvalid-offsetof
6778 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6779 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6780 to a non-standard-layout type is undefined.  In existing C++ implementations,
6781 however, @code{offsetof} typically gives meaningful results.
6782 This flag is for users who are aware that they are
6783 writing nonportable code and who have deliberately chosen to ignore the
6784 warning about it.
6786 The restrictions on @code{offsetof} may be relaxed in a future version
6787 of the C++ standard.
6789 @item -Wint-in-bool-context
6790 @opindex Wint-in-bool-context
6791 @opindex Wno-int-in-bool-context
6792 Warn for suspicious use of integer values where boolean values are expected,
6793 such as conditional expressions (?:) using non-boolean integer constants in
6794 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6795 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6796 for all kinds of multiplications regardless of the data type.
6797 This warning is enabled by @option{-Wall}.
6799 @item -Wno-int-to-pointer-cast
6800 @opindex Wno-int-to-pointer-cast
6801 @opindex Wint-to-pointer-cast
6802 Suppress warnings from casts to pointer type of an integer of a
6803 different size. In C++, casting to a pointer type of smaller size is
6804 an error. @option{Wint-to-pointer-cast} is enabled by default.
6807 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6808 @opindex Wno-pointer-to-int-cast
6809 @opindex Wpointer-to-int-cast
6810 Suppress warnings from casts from a pointer to an integer type of a
6811 different size.
6813 @item -Winvalid-pch
6814 @opindex Winvalid-pch
6815 @opindex Wno-invalid-pch
6816 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6817 the search path but cannot be used.
6819 @item -Wlong-long
6820 @opindex Wlong-long
6821 @opindex Wno-long-long
6822 Warn if @code{long long} type is used.  This is enabled by either
6823 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6824 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6826 @item -Wvariadic-macros
6827 @opindex Wvariadic-macros
6828 @opindex Wno-variadic-macros
6829 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6830 alternate syntax is used in ISO C99 mode.  This is enabled by either
6831 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6832 messages, use @option{-Wno-variadic-macros}.
6834 @item -Wvarargs
6835 @opindex Wvarargs
6836 @opindex Wno-varargs
6837 Warn upon questionable usage of the macros used to handle variable
6838 arguments like @code{va_start}.  This is default.  To inhibit the
6839 warning messages, use @option{-Wno-varargs}.
6841 @item -Wvector-operation-performance
6842 @opindex Wvector-operation-performance
6843 @opindex Wno-vector-operation-performance
6844 Warn if vector operation is not implemented via SIMD capabilities of the
6845 architecture.  Mainly useful for the performance tuning.
6846 Vector operation can be implemented @code{piecewise}, which means that the
6847 scalar operation is performed on every vector element; 
6848 @code{in parallel}, which means that the vector operation is implemented
6849 using scalars of wider type, which normally is more performance efficient;
6850 and @code{as a single scalar}, which means that vector fits into a
6851 scalar type.
6853 @item -Wno-virtual-move-assign
6854 @opindex Wvirtual-move-assign
6855 @opindex Wno-virtual-move-assign
6856 Suppress warnings about inheriting from a virtual base with a
6857 non-trivial C++11 move assignment operator.  This is dangerous because
6858 if the virtual base is reachable along more than one path, it is
6859 moved multiple times, which can mean both objects end up in the
6860 moved-from state.  If the move assignment operator is written to avoid
6861 moving from a moved-from object, this warning can be disabled.
6863 @item -Wvla
6864 @opindex Wvla
6865 @opindex Wno-vla
6866 Warn if a variable-length array is used in the code.
6867 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6868 the variable-length array.
6870 @item -Wvla-larger-than=@var{n}
6871 If this option is used, the compiler will warn on uses of
6872 variable-length arrays where the size is either unbounded, or bounded
6873 by an argument that can be larger than @var{n} bytes.  This is similar
6874 to how @option{-Walloca-larger-than=@var{n}} works, but with
6875 variable-length arrays.
6877 Note that GCC may optimize small variable-length arrays of a known
6878 value into plain arrays, so this warning may not get triggered for
6879 such arrays.
6881 This warning is not enabled by @option{-Wall}, and is only active when
6882 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6884 See also @option{-Walloca-larger-than=@var{n}}.
6886 @item -Wvolatile-register-var
6887 @opindex Wvolatile-register-var
6888 @opindex Wno-volatile-register-var
6889 Warn if a register variable is declared volatile.  The volatile
6890 modifier does not inhibit all optimizations that may eliminate reads
6891 and/or writes to register variables.  This warning is enabled by
6892 @option{-Wall}.
6894 @item -Wdisabled-optimization
6895 @opindex Wdisabled-optimization
6896 @opindex Wno-disabled-optimization
6897 Warn if a requested optimization pass is disabled.  This warning does
6898 not generally indicate that there is anything wrong with your code; it
6899 merely indicates that GCC's optimizers are unable to handle the code
6900 effectively.  Often, the problem is that your code is too big or too
6901 complex; GCC refuses to optimize programs when the optimization
6902 itself is likely to take inordinate amounts of time.
6904 @item -Wpointer-sign @r{(C and Objective-C only)}
6905 @opindex Wpointer-sign
6906 @opindex Wno-pointer-sign
6907 Warn for pointer argument passing or assignment with different signedness.
6908 This option is only supported for C and Objective-C@.  It is implied by
6909 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6910 @option{-Wno-pointer-sign}.
6912 @item -Wstack-protector
6913 @opindex Wstack-protector
6914 @opindex Wno-stack-protector
6915 This option is only active when @option{-fstack-protector} is active.  It
6916 warns about functions that are not protected against stack smashing.
6918 @item -Woverlength-strings
6919 @opindex Woverlength-strings
6920 @opindex Wno-overlength-strings
6921 Warn about string constants that are longer than the ``minimum
6922 maximum'' length specified in the C standard.  Modern compilers
6923 generally allow string constants that are much longer than the
6924 standard's minimum limit, but very portable programs should avoid
6925 using longer strings.
6927 The limit applies @emph{after} string constant concatenation, and does
6928 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6929 C99, it was raised to 4095.  C++98 does not specify a normative
6930 minimum maximum, so we do not diagnose overlength strings in C++@.
6932 This option is implied by @option{-Wpedantic}, and can be disabled with
6933 @option{-Wno-overlength-strings}.
6935 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6936 @opindex Wunsuffixed-float-constants
6938 Issue a warning for any floating constant that does not have
6939 a suffix.  When used together with @option{-Wsystem-headers} it
6940 warns about such constants in system header files.  This can be useful
6941 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6942 from the decimal floating-point extension to C99.
6944 @item -Wno-designated-init @r{(C and Objective-C only)}
6945 Suppress warnings when a positional initializer is used to initialize
6946 a structure that has been marked with the @code{designated_init}
6947 attribute.
6949 @item -Whsa
6950 Issue a warning when HSAIL cannot be emitted for the compiled function or
6951 OpenMP construct.
6953 @end table
6955 @node Debugging Options
6956 @section Options for Debugging Your Program
6957 @cindex options, debugging
6958 @cindex debugging information options
6960 To tell GCC to emit extra information for use by a debugger, in almost 
6961 all cases you need only to add @option{-g} to your other options.
6963 GCC allows you to use @option{-g} with
6964 @option{-O}.  The shortcuts taken by optimized code may occasionally
6965 be surprising: some variables you declared may not exist
6966 at all; flow of control may briefly move where you did not expect it;
6967 some statements may not be executed because they compute constant
6968 results or their values are already at hand; some statements may
6969 execute in different places because they have been moved out of loops.
6970 Nevertheless it is possible to debug optimized output.  This makes
6971 it reasonable to use the optimizer for programs that might have bugs.
6973 If you are not using some other optimization option, consider
6974 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6975 With no @option{-O} option at all, some compiler passes that collect
6976 information useful for debugging do not run at all, so that
6977 @option{-Og} may result in a better debugging experience.
6979 @table @gcctabopt
6980 @item -g
6981 @opindex g
6982 Produce debugging information in the operating system's native format
6983 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6984 information.
6986 On most systems that use stabs format, @option{-g} enables use of extra
6987 debugging information that only GDB can use; this extra information
6988 makes debugging work better in GDB but probably makes other debuggers
6989 crash or
6990 refuse to read the program.  If you want to control for certain whether
6991 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6992 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6994 @item -ggdb
6995 @opindex ggdb
6996 Produce debugging information for use by GDB@.  This means to use the
6997 most expressive format available (DWARF, stabs, or the native format
6998 if neither of those are supported), including GDB extensions if at all
6999 possible.
7001 @item -gdwarf
7002 @itemx -gdwarf-@var{version}
7003 @opindex gdwarf
7004 Produce debugging information in DWARF format (if that is supported).
7005 The value of @var{version} may be either 2, 3, 4 or 5; the default version
7006 for most targets is 4.  DWARF Version 5 is only experimental.
7008 Note that with DWARF Version 2, some ports require and always
7009 use some non-conflicting DWARF 3 extensions in the unwind tables.
7011 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
7012 for maximum benefit.
7014 GCC no longer supports DWARF Version 1, which is substantially
7015 different than Version 2 and later.  For historical reasons, some
7016 other DWARF-related options such as
7017 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
7018 in their names, but apply to all currently-supported versions of DWARF.
7020 @item -gstabs
7021 @opindex gstabs
7022 Produce debugging information in stabs format (if that is supported),
7023 without GDB extensions.  This is the format used by DBX on most BSD
7024 systems.  On MIPS, Alpha and System V Release 4 systems this option
7025 produces stabs debugging output that is not understood by DBX@.
7026 On System V Release 4 systems this option requires the GNU assembler.
7028 @item -gstabs+
7029 @opindex gstabs+
7030 Produce debugging information in stabs format (if that is supported),
7031 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7032 use of these extensions is likely to make other debuggers crash or
7033 refuse to read the program.
7035 @item -gxcoff
7036 @opindex gxcoff
7037 Produce debugging information in XCOFF format (if that is supported).
7038 This is the format used by the DBX debugger on IBM RS/6000 systems.
7040 @item -gxcoff+
7041 @opindex gxcoff+
7042 Produce debugging information in XCOFF format (if that is supported),
7043 using GNU extensions understood only by the GNU debugger (GDB)@.  The
7044 use of these extensions is likely to make other debuggers crash or
7045 refuse to read the program, and may cause assemblers other than the GNU
7046 assembler (GAS) to fail with an error.
7048 @item -gvms
7049 @opindex gvms
7050 Produce debugging information in Alpha/VMS debug format (if that is
7051 supported).  This is the format used by DEBUG on Alpha/VMS systems.
7053 @item -g@var{level}
7054 @itemx -ggdb@var{level}
7055 @itemx -gstabs@var{level}
7056 @itemx -gxcoff@var{level}
7057 @itemx -gvms@var{level}
7058 Request debugging information and also use @var{level} to specify how
7059 much information.  The default level is 2.
7061 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
7062 @option{-g}.
7064 Level 1 produces minimal information, enough for making backtraces in
7065 parts of the program that you don't plan to debug.  This includes
7066 descriptions of functions and external variables, and line number
7067 tables, but no information about local variables.
7069 Level 3 includes extra information, such as all the macro definitions
7070 present in the program.  Some debuggers support macro expansion when
7071 you use @option{-g3}.
7073 @option{-gdwarf} does not accept a concatenated debug level, to avoid
7074 confusion with @option{-gdwarf-@var{level}}.
7075 Instead use an additional @option{-g@var{level}} option to change the
7076 debug level for DWARF.
7078 @item -feliminate-unused-debug-symbols
7079 @opindex feliminate-unused-debug-symbols
7080 Produce debugging information in stabs format (if that is supported),
7081 for only symbols that are actually used.
7083 @item -femit-class-debug-always
7084 @opindex femit-class-debug-always
7085 Instead of emitting debugging information for a C++ class in only one
7086 object file, emit it in all object files using the class.  This option
7087 should be used only with debuggers that are unable to handle the way GCC
7088 normally emits debugging information for classes because using this
7089 option increases the size of debugging information by as much as a
7090 factor of two.
7092 @item -fno-merge-debug-strings
7093 @opindex fmerge-debug-strings
7094 @opindex fno-merge-debug-strings
7095 Direct the linker to not merge together strings in the debugging
7096 information that are identical in different object files.  Merging is
7097 not supported by all assemblers or linkers.  Merging decreases the size
7098 of the debug information in the output file at the cost of increasing
7099 link processing time.  Merging is enabled by default.
7101 @item -fdebug-prefix-map=@var{old}=@var{new}
7102 @opindex fdebug-prefix-map
7103 When compiling files in directory @file{@var{old}}, record debugging
7104 information describing them as in @file{@var{new}} instead.  This can be
7105 used to replace a build-time path with an install-time path in the debug info.
7106 It can also be used to change an absolute path to a relative path by using
7107 @file{.} for @var{new}.  This can give more reproducible builds, which are
7108 location independent, but may require an extra command to tell GDB where to
7109 find the source files.
7111 @item -fvar-tracking
7112 @opindex fvar-tracking
7113 Run variable tracking pass.  It computes where variables are stored at each
7114 position in code.  Better debugging information is then generated
7115 (if the debugging information format supports this information).
7117 It is enabled by default when compiling with optimization (@option{-Os},
7118 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7119 the debug info format supports it.
7121 @item -fvar-tracking-assignments
7122 @opindex fvar-tracking-assignments
7123 @opindex fno-var-tracking-assignments
7124 Annotate assignments to user variables early in the compilation and
7125 attempt to carry the annotations over throughout the compilation all the
7126 way to the end, in an attempt to improve debug information while
7127 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7129 It can be enabled even if var-tracking is disabled, in which case
7130 annotations are created and maintained, but discarded at the end.
7131 By default, this flag is enabled together with @option{-fvar-tracking},
7132 except when selective scheduling is enabled.
7134 @item -gsplit-dwarf
7135 @opindex gsplit-dwarf
7136 Separate as much DWARF debugging information as possible into a
7137 separate output file with the extension @file{.dwo}.  This option allows
7138 the build system to avoid linking files with debug information.  To
7139 be useful, this option requires a debugger capable of reading @file{.dwo}
7140 files.
7142 @item -gpubnames
7143 @opindex gpubnames
7144 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
7146 @item -ggnu-pubnames
7147 @opindex ggnu-pubnames
7148 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
7149 suitable for conversion into a GDB@ index.  This option is only useful
7150 with a linker that can produce GDB@ index version 7.
7152 @item -fdebug-types-section
7153 @opindex fdebug-types-section
7154 @opindex fno-debug-types-section
7155 When using DWARF Version 4 or higher, type DIEs can be put into
7156 their own @code{.debug_types} section instead of making them part of the
7157 @code{.debug_info} section.  It is more efficient to put them in a separate
7158 comdat sections since the linker can then remove duplicates.
7159 But not all DWARF consumers support @code{.debug_types} sections yet
7160 and on some objects @code{.debug_types} produces larger instead of smaller
7161 debugging information.
7163 @item -grecord-gcc-switches
7164 @item -gno-record-gcc-switches
7165 @opindex grecord-gcc-switches
7166 @opindex gno-record-gcc-switches
7167 This switch causes the command-line options used to invoke the
7168 compiler that may affect code generation to be appended to the
7169 DW_AT_producer attribute in DWARF debugging information.  The options
7170 are concatenated with spaces separating them from each other and from
7171 the compiler version.  
7172 It is enabled by default.
7173 See also @option{-frecord-gcc-switches} for another
7174 way of storing compiler options into the object file.  
7176 @item -gstrict-dwarf
7177 @opindex gstrict-dwarf
7178 Disallow using extensions of later DWARF standard version than selected
7179 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7180 DWARF extensions from later standard versions is allowed.
7182 @item -gno-strict-dwarf
7183 @opindex gno-strict-dwarf
7184 Allow using extensions of later DWARF standard version than selected with
7185 @option{-gdwarf-@var{version}}.
7187 @item -gcolumn-info
7188 @item -gno-column-info
7189 @opindex gcolumn-info
7190 @opindex gno-column-info
7191 Emit location column information into DWARF debugging information, rather
7192 than just file and line.
7193 This option is enabled by default.
7195 @item -gstatement-frontiers
7196 @item -gno-statement-frontiers
7197 @opindex gstatement-frontiers
7198 @opindex gno-statement-frontiers
7199 This option causes GCC to create markers in the internal representation
7200 at the beginning of statements, and to keep them roughly in place
7201 throughout compilation, using them to guide the output of @code{is_stmt}
7202 markers in the line number table.  This is enabled by default when
7203 compiling with optimization (@option{-Os}, @option{-O}, @option{-O2},
7204 @dots{}), and outputting DWARF 2 debug information at the normal level.
7206 @item -gz@r{[}=@var{type}@r{]}
7207 @opindex gz
7208 Produce compressed debug sections in DWARF format, if that is supported.
7209 If @var{type} is not given, the default type depends on the capabilities
7210 of the assembler and linker used.  @var{type} may be one of
7211 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7212 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7213 compression in traditional GNU format).  If the linker doesn't support
7214 writing compressed debug sections, the option is rejected.  Otherwise,
7215 if the assembler does not support them, @option{-gz} is silently ignored
7216 when producing object files.
7218 @item -femit-struct-debug-baseonly
7219 @opindex femit-struct-debug-baseonly
7220 Emit debug information for struct-like types
7221 only when the base name of the compilation source file
7222 matches the base name of file in which the struct is defined.
7224 This option substantially reduces the size of debugging information,
7225 but at significant potential loss in type information to the debugger.
7226 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7227 See @option{-femit-struct-debug-detailed} for more detailed control.
7229 This option works only with DWARF debug output.
7231 @item -femit-struct-debug-reduced
7232 @opindex femit-struct-debug-reduced
7233 Emit debug information for struct-like types
7234 only when the base name of the compilation source file
7235 matches the base name of file in which the type is defined,
7236 unless the struct is a template or defined in a system header.
7238 This option significantly reduces the size of debugging information,
7239 with some potential loss in type information to the debugger.
7240 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7241 See @option{-femit-struct-debug-detailed} for more detailed control.
7243 This option works only with DWARF debug output.
7245 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7246 @opindex femit-struct-debug-detailed
7247 Specify the struct-like types
7248 for which the compiler generates debug information.
7249 The intent is to reduce duplicate struct debug information
7250 between different object files within the same program.
7252 This option is a detailed version of
7253 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7254 which serves for most needs.
7256 A specification has the syntax@*
7257 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7259 The optional first word limits the specification to
7260 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7261 A struct type is used directly when it is the type of a variable, member.
7262 Indirect uses arise through pointers to structs.
7263 That is, when use of an incomplete struct is valid, the use is indirect.
7264 An example is
7265 @samp{struct one direct; struct two * indirect;}.
7267 The optional second word limits the specification to
7268 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7269 Generic structs are a bit complicated to explain.
7270 For C++, these are non-explicit specializations of template classes,
7271 or non-template classes within the above.
7272 Other programming languages have generics,
7273 but @option{-femit-struct-debug-detailed} does not yet implement them.
7275 The third word specifies the source files for those
7276 structs for which the compiler should emit debug information.
7277 The values @samp{none} and @samp{any} have the normal meaning.
7278 The value @samp{base} means that
7279 the base of name of the file in which the type declaration appears
7280 must match the base of the name of the main compilation file.
7281 In practice, this means that when compiling @file{foo.c}, debug information
7282 is generated for types declared in that file and @file{foo.h},
7283 but not other header files.
7284 The value @samp{sys} means those types satisfying @samp{base}
7285 or declared in system or compiler headers.
7287 You may need to experiment to determine the best settings for your application.
7289 The default is @option{-femit-struct-debug-detailed=all}.
7291 This option works only with DWARF debug output.
7293 @item -fno-dwarf2-cfi-asm
7294 @opindex fdwarf2-cfi-asm
7295 @opindex fno-dwarf2-cfi-asm
7296 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7297 instead of using GAS @code{.cfi_*} directives.
7299 @item -fno-eliminate-unused-debug-types
7300 @opindex feliminate-unused-debug-types
7301 @opindex fno-eliminate-unused-debug-types
7302 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7303 output for types that are nowhere used in the source file being compiled.
7304 Sometimes it is useful to have GCC emit debugging
7305 information for all types declared in a compilation
7306 unit, regardless of whether or not they are actually used
7307 in that compilation unit, for example 
7308 if, in the debugger, you want to cast a value to a type that is
7309 not actually used in your program (but is declared).  More often,
7310 however, this results in a significant amount of wasted space.
7311 @end table
7313 @node Optimize Options
7314 @section Options That Control Optimization
7315 @cindex optimize options
7316 @cindex options, optimization
7318 These options control various sorts of optimizations.
7320 Without any optimization option, the compiler's goal is to reduce the
7321 cost of compilation and to make debugging produce the expected
7322 results.  Statements are independent: if you stop the program with a
7323 breakpoint between statements, you can then assign a new value to any
7324 variable or change the program counter to any other statement in the
7325 function and get exactly the results you expect from the source
7326 code.
7328 Turning on optimization flags makes the compiler attempt to improve
7329 the performance and/or code size at the expense of compilation time
7330 and possibly the ability to debug the program.
7332 The compiler performs optimization based on the knowledge it has of the
7333 program.  Compiling multiple files at once to a single output file mode allows
7334 the compiler to use information gained from all of the files when compiling
7335 each of them.
7337 Not all optimizations are controlled directly by a flag.  Only
7338 optimizations that have a flag are listed in this section.
7340 Most optimizations are only enabled if an @option{-O} level is set on
7341 the command line.  Otherwise they are disabled, even if individual
7342 optimization flags are specified.
7344 Depending on the target and how GCC was configured, a slightly different
7345 set of optimizations may be enabled at each @option{-O} level than
7346 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7347 to find out the exact set of optimizations that are enabled at each level.
7348 @xref{Overall Options}, for examples.
7350 @table @gcctabopt
7351 @item -O
7352 @itemx -O1
7353 @opindex O
7354 @opindex O1
7355 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7356 more memory for a large function.
7358 With @option{-O}, the compiler tries to reduce code size and execution
7359 time, without performing any optimizations that take a great deal of
7360 compilation time.
7362 @option{-O} turns on the following optimization flags:
7363 @gccoptlist{
7364 -fauto-inc-dec @gol
7365 -fbranch-count-reg @gol
7366 -fcombine-stack-adjustments @gol
7367 -fcompare-elim @gol
7368 -fcprop-registers @gol
7369 -fdce @gol
7370 -fdefer-pop @gol
7371 -fdelayed-branch @gol
7372 -fdse @gol
7373 -fforward-propagate @gol
7374 -fguess-branch-probability @gol
7375 -fif-conversion2 @gol
7376 -fif-conversion @gol
7377 -finline-functions-called-once @gol
7378 -fipa-pure-const @gol
7379 -fipa-profile @gol
7380 -fipa-reference @gol
7381 -fmerge-constants @gol
7382 -fmove-loop-invariants @gol
7383 -fomit-frame-pointer @gol
7384 -freorder-blocks @gol
7385 -fshrink-wrap @gol
7386 -fshrink-wrap-separate @gol
7387 -fsplit-wide-types @gol
7388 -fssa-backprop @gol
7389 -fssa-phiopt @gol
7390 -ftree-bit-ccp @gol
7391 -ftree-ccp @gol
7392 -ftree-ch @gol
7393 -ftree-coalesce-vars @gol
7394 -ftree-copy-prop @gol
7395 -ftree-dce @gol
7396 -ftree-dominator-opts @gol
7397 -ftree-dse @gol
7398 -ftree-forwprop @gol
7399 -ftree-fre @gol
7400 -ftree-phiprop @gol
7401 -ftree-sink @gol
7402 -ftree-slsr @gol
7403 -ftree-sra @gol
7404 -ftree-pta @gol
7405 -ftree-ter @gol
7406 -funit-at-a-time}
7408 @item -O2
7409 @opindex O2
7410 Optimize even more.  GCC performs nearly all supported optimizations
7411 that do not involve a space-speed tradeoff.
7412 As compared to @option{-O}, this option increases both compilation time
7413 and the performance of the generated code.
7415 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7416 also turns on the following optimization flags:
7417 @gccoptlist{-fthread-jumps @gol
7418 -falign-functions  -falign-jumps @gol
7419 -falign-loops  -falign-labels @gol
7420 -fcaller-saves @gol
7421 -fcrossjumping @gol
7422 -fcse-follow-jumps  -fcse-skip-blocks @gol
7423 -fdelete-null-pointer-checks @gol
7424 -fdevirtualize -fdevirtualize-speculatively @gol
7425 -fexpensive-optimizations @gol
7426 -fgcse  -fgcse-lm  @gol
7427 -fhoist-adjacent-loads @gol
7428 -finline-small-functions @gol
7429 -findirect-inlining @gol
7430 -fipa-cp @gol
7431 -fipa-bit-cp @gol
7432 -fipa-vrp @gol
7433 -fipa-sra @gol
7434 -fipa-icf @gol
7435 -fisolate-erroneous-paths-dereference @gol
7436 -flra-remat @gol
7437 -foptimize-sibling-calls @gol
7438 -foptimize-strlen @gol
7439 -fpartial-inlining @gol
7440 -fpeephole2 @gol
7441 -freorder-blocks-algorithm=stc @gol
7442 -freorder-blocks-and-partition -freorder-functions @gol
7443 -frerun-cse-after-loop  @gol
7444 -fsched-interblock  -fsched-spec @gol
7445 -fschedule-insns  -fschedule-insns2 @gol
7446 -fstore-merging @gol
7447 -fstrict-aliasing @gol
7448 -ftree-builtin-call-dce @gol
7449 -ftree-switch-conversion -ftree-tail-merge @gol
7450 -fcode-hoisting @gol
7451 -ftree-pre @gol
7452 -ftree-vrp @gol
7453 -fipa-ra}
7455 Please note the warning under @option{-fgcse} about
7456 invoking @option{-O2} on programs that use computed gotos.
7458 @item -O3
7459 @opindex O3
7460 Optimize yet more.  @option{-O3} turns on all optimizations specified
7461 by @option{-O2} and also turns on the following optimization flags:
7462 @gccoptlist{-finline-functions @gol
7463 -funswitch-loops @gol
7464 -fpredictive-commoning @gol
7465 -fgcse-after-reload @gol
7466 -ftree-loop-vectorize @gol
7467 -ftree-loop-distribution @gol
7468 -ftree-loop-distribute-patterns @gol
7469 -floop-interchange @gol
7470 -fsplit-paths @gol
7471 -ftree-slp-vectorize @gol
7472 -fvect-cost-model @gol
7473 -ftree-partial-pre @gol
7474 -fpeel-loops @gol
7475 -fipa-cp-clone}
7477 @item -O0
7478 @opindex O0
7479 Reduce compilation time and make debugging produce the expected
7480 results.  This is the default.
7482 @item -Os
7483 @opindex Os
7484 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7485 do not typically increase code size.  It also performs further
7486 optimizations designed to reduce code size.
7488 @option{-Os} disables the following optimization flags:
7489 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7490 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7491 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7493 @item -Ofast
7494 @opindex Ofast
7495 Disregard strict standards compliance.  @option{-Ofast} enables all
7496 @option{-O3} optimizations.  It also enables optimizations that are not
7497 valid for all standard-compliant programs.
7498 It turns on @option{-ffast-math} and the Fortran-specific
7499 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7500 specified, and @option{-fno-protect-parens}.
7502 @item -Og
7503 @opindex Og
7504 Optimize debugging experience.  @option{-Og} enables optimizations
7505 that do not interfere with debugging. It should be the optimization
7506 level of choice for the standard edit-compile-debug cycle, offering
7507 a reasonable level of optimization while maintaining fast compilation
7508 and a good debugging experience.
7509 @end table
7511 If you use multiple @option{-O} options, with or without level numbers,
7512 the last such option is the one that is effective.
7514 Options of the form @option{-f@var{flag}} specify machine-independent
7515 flags.  Most flags have both positive and negative forms; the negative
7516 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7517 below, only one of the forms is listed---the one you typically 
7518 use.  You can figure out the other form by either removing @samp{no-}
7519 or adding it.
7521 The following options control specific optimizations.  They are either
7522 activated by @option{-O} options or are related to ones that are.  You
7523 can use the following flags in the rare cases when ``fine-tuning'' of
7524 optimizations to be performed is desired.
7526 @table @gcctabopt
7527 @item -fno-defer-pop
7528 @opindex fno-defer-pop
7529 Always pop the arguments to each function call as soon as that function
7530 returns.  For machines that must pop arguments after a function call,
7531 the compiler normally lets arguments accumulate on the stack for several
7532 function calls and pops them all at once.
7534 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7536 @item -fforward-propagate
7537 @opindex fforward-propagate
7538 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7539 instructions and checks if the result can be simplified.  If loop unrolling
7540 is active, two passes are performed and the second is scheduled after
7541 loop unrolling.
7543 This option is enabled by default at optimization levels @option{-O},
7544 @option{-O2}, @option{-O3}, @option{-Os}.
7546 @item -ffp-contract=@var{style}
7547 @opindex ffp-contract
7548 @option{-ffp-contract=off} disables floating-point expression contraction.
7549 @option{-ffp-contract=fast} enables floating-point expression contraction
7550 such as forming of fused multiply-add operations if the target has
7551 native support for them.
7552 @option{-ffp-contract=on} enables floating-point expression contraction
7553 if allowed by the language standard.  This is currently not implemented
7554 and treated equal to @option{-ffp-contract=off}.
7556 The default is @option{-ffp-contract=fast}.
7558 @item -fomit-frame-pointer
7559 @opindex fomit-frame-pointer
7560 Omit the frame pointer in functions that don't need one.  This avoids the
7561 instructions to save, set up and restore the frame pointer; on many targets
7562 it also makes an extra register available.
7564 On some targets this flag has no effect because the standard calling sequence
7565 always uses a frame pointer, so it cannot be omitted.
7567 Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer
7568 is used in all functions.  Several targets always omit the frame pointer in
7569 leaf functions.
7571 Enabled by default at @option{-O} and higher.
7573 @item -foptimize-sibling-calls
7574 @opindex foptimize-sibling-calls
7575 Optimize sibling and tail recursive calls.
7577 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7579 @item -foptimize-strlen
7580 @opindex foptimize-strlen
7581 Optimize various standard C string functions (e.g. @code{strlen},
7582 @code{strchr} or @code{strcpy}) and
7583 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7585 Enabled at levels @option{-O2}, @option{-O3}.
7587 @item -fno-inline
7588 @opindex fno-inline
7589 Do not expand any functions inline apart from those marked with
7590 the @code{always_inline} attribute.  This is the default when not
7591 optimizing.
7593 Single functions can be exempted from inlining by marking them
7594 with the @code{noinline} attribute.
7596 @item -finline-small-functions
7597 @opindex finline-small-functions
7598 Integrate functions into their callers when their body is smaller than expected
7599 function call code (so overall size of program gets smaller).  The compiler
7600 heuristically decides which functions are simple enough to be worth integrating
7601 in this way.  This inlining applies to all functions, even those not declared
7602 inline.
7604 Enabled at level @option{-O2}.
7606 @item -findirect-inlining
7607 @opindex findirect-inlining
7608 Inline also indirect calls that are discovered to be known at compile
7609 time thanks to previous inlining.  This option has any effect only
7610 when inlining itself is turned on by the @option{-finline-functions}
7611 or @option{-finline-small-functions} options.
7613 Enabled at level @option{-O2}.
7615 @item -finline-functions
7616 @opindex finline-functions
7617 Consider all functions for inlining, even if they are not declared inline.
7618 The compiler heuristically decides which functions are worth integrating
7619 in this way.
7621 If all calls to a given function are integrated, and the function is
7622 declared @code{static}, then the function is normally not output as
7623 assembler code in its own right.
7625 Enabled at level @option{-O3}.
7627 @item -finline-functions-called-once
7628 @opindex finline-functions-called-once
7629 Consider all @code{static} functions called once for inlining into their
7630 caller even if they are not marked @code{inline}.  If a call to a given
7631 function is integrated, then the function is not output as assembler code
7632 in its own right.
7634 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7636 @item -fearly-inlining
7637 @opindex fearly-inlining
7638 Inline functions marked by @code{always_inline} and functions whose body seems
7639 smaller than the function call overhead early before doing
7640 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7641 makes profiling significantly cheaper and usually inlining faster on programs
7642 having large chains of nested wrapper functions.
7644 Enabled by default.
7646 @item -fipa-sra
7647 @opindex fipa-sra
7648 Perform interprocedural scalar replacement of aggregates, removal of
7649 unused parameters and replacement of parameters passed by reference
7650 by parameters passed by value.
7652 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7654 @item -finline-limit=@var{n}
7655 @opindex finline-limit
7656 By default, GCC limits the size of functions that can be inlined.  This flag
7657 allows coarse control of this limit.  @var{n} is the size of functions that
7658 can be inlined in number of pseudo instructions.
7660 Inlining is actually controlled by a number of parameters, which may be
7661 specified individually by using @option{--param @var{name}=@var{value}}.
7662 The @option{-finline-limit=@var{n}} option sets some of these parameters
7663 as follows:
7665 @table @gcctabopt
7666 @item max-inline-insns-single
7667 is set to @var{n}/2.
7668 @item max-inline-insns-auto
7669 is set to @var{n}/2.
7670 @end table
7672 See below for a documentation of the individual
7673 parameters controlling inlining and for the defaults of these parameters.
7675 @emph{Note:} there may be no value to @option{-finline-limit} that results
7676 in default behavior.
7678 @emph{Note:} pseudo instruction represents, in this particular context, an
7679 abstract measurement of function's size.  In no way does it represent a count
7680 of assembly instructions and as such its exact meaning might change from one
7681 release to an another.
7683 @item -fno-keep-inline-dllexport
7684 @opindex fno-keep-inline-dllexport
7685 This is a more fine-grained version of @option{-fkeep-inline-functions},
7686 which applies only to functions that are declared using the @code{dllexport}
7687 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7688 Functions}.
7690 @item -fkeep-inline-functions
7691 @opindex fkeep-inline-functions
7692 In C, emit @code{static} functions that are declared @code{inline}
7693 into the object file, even if the function has been inlined into all
7694 of its callers.  This switch does not affect functions using the
7695 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7696 inline functions into the object file.
7698 @item -fkeep-static-functions
7699 @opindex fkeep-static-functions
7700 Emit @code{static} functions into the object file, even if the function
7701 is never used.
7703 @item -fkeep-static-consts
7704 @opindex fkeep-static-consts
7705 Emit variables declared @code{static const} when optimization isn't turned
7706 on, even if the variables aren't referenced.
7708 GCC enables this option by default.  If you want to force the compiler to
7709 check if a variable is referenced, regardless of whether or not
7710 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7712 @item -fmerge-constants
7713 @opindex fmerge-constants
7714 Attempt to merge identical constants (string constants and floating-point
7715 constants) across compilation units.
7717 This option is the default for optimized compilation if the assembler and
7718 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7719 behavior.
7721 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7723 @item -fmerge-all-constants
7724 @opindex fmerge-all-constants
7725 Attempt to merge identical constants and identical variables.
7727 This option implies @option{-fmerge-constants}.  In addition to
7728 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7729 arrays or initialized constant variables with integral or floating-point
7730 types.  Languages like C or C++ require each variable, including multiple
7731 instances of the same variable in recursive calls, to have distinct locations,
7732 so using this option results in non-conforming
7733 behavior.
7735 @item -fmodulo-sched
7736 @opindex fmodulo-sched
7737 Perform swing modulo scheduling immediately before the first scheduling
7738 pass.  This pass looks at innermost loops and reorders their
7739 instructions by overlapping different iterations.
7741 @item -fmodulo-sched-allow-regmoves
7742 @opindex fmodulo-sched-allow-regmoves
7743 Perform more aggressive SMS-based modulo scheduling with register moves
7744 allowed.  By setting this flag certain anti-dependences edges are
7745 deleted, which triggers the generation of reg-moves based on the
7746 life-range analysis.  This option is effective only with
7747 @option{-fmodulo-sched} enabled.
7749 @item -fno-branch-count-reg
7750 @opindex fno-branch-count-reg
7751 Avoid running a pass scanning for opportunities to use ``decrement and
7752 branch'' instructions on a count register instead of generating sequences
7753 of instructions that decrement a register, compare it against zero, and
7754 then branch based upon the result.  This option is only meaningful on
7755 architectures that support such instructions, which include x86, PowerPC,
7756 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7757 doesn't remove the decrement and branch instructions from the generated
7758 instruction stream introduced by other optimization passes.
7760 Enabled by default at @option{-O1} and higher.
7762 The default is @option{-fbranch-count-reg}.
7764 @item -fno-function-cse
7765 @opindex fno-function-cse
7766 Do not put function addresses in registers; make each instruction that
7767 calls a constant function contain the function's address explicitly.
7769 This option results in less efficient code, but some strange hacks
7770 that alter the assembler output may be confused by the optimizations
7771 performed when this option is not used.
7773 The default is @option{-ffunction-cse}
7775 @item -fno-zero-initialized-in-bss
7776 @opindex fno-zero-initialized-in-bss
7777 If the target supports a BSS section, GCC by default puts variables that
7778 are initialized to zero into BSS@.  This can save space in the resulting
7779 code.
7781 This option turns off this behavior because some programs explicitly
7782 rely on variables going to the data section---e.g., so that the
7783 resulting executable can find the beginning of that section and/or make
7784 assumptions based on that.
7786 The default is @option{-fzero-initialized-in-bss}.
7788 @item -fthread-jumps
7789 @opindex fthread-jumps
7790 Perform optimizations that check to see if a jump branches to a
7791 location where another comparison subsumed by the first is found.  If
7792 so, the first branch is redirected to either the destination of the
7793 second branch or a point immediately following it, depending on whether
7794 the condition is known to be true or false.
7796 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7798 @item -fsplit-wide-types
7799 @opindex fsplit-wide-types
7800 When using a type that occupies multiple registers, such as @code{long
7801 long} on a 32-bit system, split the registers apart and allocate them
7802 independently.  This normally generates better code for those types,
7803 but may make debugging more difficult.
7805 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7806 @option{-Os}.
7808 @item -fcse-follow-jumps
7809 @opindex fcse-follow-jumps
7810 In common subexpression elimination (CSE), scan through jump instructions
7811 when the target of the jump is not reached by any other path.  For
7812 example, when CSE encounters an @code{if} statement with an
7813 @code{else} clause, CSE follows the jump when the condition
7814 tested is false.
7816 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7818 @item -fcse-skip-blocks
7819 @opindex fcse-skip-blocks
7820 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7821 follow jumps that conditionally skip over blocks.  When CSE
7822 encounters a simple @code{if} statement with no else clause,
7823 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7824 body of the @code{if}.
7826 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7828 @item -frerun-cse-after-loop
7829 @opindex frerun-cse-after-loop
7830 Re-run common subexpression elimination after loop optimizations are
7831 performed.
7833 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7835 @item -fgcse
7836 @opindex fgcse
7837 Perform a global common subexpression elimination pass.
7838 This pass also performs global constant and copy propagation.
7840 @emph{Note:} When compiling a program using computed gotos, a GCC
7841 extension, you may get better run-time performance if you disable
7842 the global common subexpression elimination pass by adding
7843 @option{-fno-gcse} to the command line.
7845 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7847 @item -fgcse-lm
7848 @opindex fgcse-lm
7849 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7850 attempts to move loads that are only killed by stores into themselves.  This
7851 allows a loop containing a load/store sequence to be changed to a load outside
7852 the loop, and a copy/store within the loop.
7854 Enabled by default when @option{-fgcse} is enabled.
7856 @item -fgcse-sm
7857 @opindex fgcse-sm
7858 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7859 global common subexpression elimination.  This pass attempts to move
7860 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7861 loops containing a load/store sequence can be changed to a load before
7862 the loop and a store after the loop.
7864 Not enabled at any optimization level.
7866 @item -fgcse-las
7867 @opindex fgcse-las
7868 When @option{-fgcse-las} is enabled, the global common subexpression
7869 elimination pass eliminates redundant loads that come after stores to the
7870 same memory location (both partial and full redundancies).
7872 Not enabled at any optimization level.
7874 @item -fgcse-after-reload
7875 @opindex fgcse-after-reload
7876 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7877 pass is performed after reload.  The purpose of this pass is to clean up
7878 redundant spilling.
7880 @item -faggressive-loop-optimizations
7881 @opindex faggressive-loop-optimizations
7882 This option tells the loop optimizer to use language constraints to
7883 derive bounds for the number of iterations of a loop.  This assumes that
7884 loop code does not invoke undefined behavior by for example causing signed
7885 integer overflows or out-of-bound array accesses.  The bounds for the
7886 number of iterations of a loop are used to guide loop unrolling and peeling
7887 and loop exit test optimizations.
7888 This option is enabled by default.
7890 @item -funconstrained-commons
7891 @opindex funconstrained-commons
7892 This option tells the compiler that variables declared in common blocks
7893 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7894 prevents certain optimizations that depend on knowing the array bounds.
7896 @item -fcrossjumping
7897 @opindex fcrossjumping
7898 Perform cross-jumping transformation.
7899 This transformation unifies equivalent code and saves code size.  The
7900 resulting code may or may not perform better than without cross-jumping.
7902 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7904 @item -fauto-inc-dec
7905 @opindex fauto-inc-dec
7906 Combine increments or decrements of addresses with memory accesses.
7907 This pass is always skipped on architectures that do not have
7908 instructions to support this.  Enabled by default at @option{-O} and
7909 higher on architectures that support this.
7911 @item -fdce
7912 @opindex fdce
7913 Perform dead code elimination (DCE) on RTL@.
7914 Enabled by default at @option{-O} and higher.
7916 @item -fdse
7917 @opindex fdse
7918 Perform dead store elimination (DSE) on RTL@.
7919 Enabled by default at @option{-O} and higher.
7921 @item -fif-conversion
7922 @opindex fif-conversion
7923 Attempt to transform conditional jumps into branch-less equivalents.  This
7924 includes use of conditional moves, min, max, set flags and abs instructions, and
7925 some tricks doable by standard arithmetics.  The use of conditional execution
7926 on chips where it is available is controlled by @option{-fif-conversion2}.
7928 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7930 @item -fif-conversion2
7931 @opindex fif-conversion2
7932 Use conditional execution (where available) to transform conditional jumps into
7933 branch-less equivalents.
7935 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7937 @item -fdeclone-ctor-dtor
7938 @opindex fdeclone-ctor-dtor
7939 The C++ ABI requires multiple entry points for constructors and
7940 destructors: one for a base subobject, one for a complete object, and
7941 one for a virtual destructor that calls operator delete afterwards.
7942 For a hierarchy with virtual bases, the base and complete variants are
7943 clones, which means two copies of the function.  With this option, the
7944 base and complete variants are changed to be thunks that call a common
7945 implementation.
7947 Enabled by @option{-Os}.
7949 @item -fdelete-null-pointer-checks
7950 @opindex fdelete-null-pointer-checks
7951 Assume that programs cannot safely dereference null pointers, and that
7952 no code or data element resides at address zero.
7953 This option enables simple constant
7954 folding optimizations at all optimization levels.  In addition, other
7955 optimization passes in GCC use this flag to control global dataflow
7956 analyses that eliminate useless checks for null pointers; these assume
7957 that a memory access to address zero always results in a trap, so
7958 that if a pointer is checked after it has already been dereferenced,
7959 it cannot be null.
7961 Note however that in some environments this assumption is not true.
7962 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7963 for programs that depend on that behavior.
7965 This option is enabled by default on most targets.  On Nios II ELF, it
7966 defaults to off.  On AVR, CR16, and MSP430, this option is completely disabled.
7968 Passes that use the dataflow information
7969 are enabled independently at different optimization levels.
7971 @item -fdevirtualize
7972 @opindex fdevirtualize
7973 Attempt to convert calls to virtual functions to direct calls.  This
7974 is done both within a procedure and interprocedurally as part of
7975 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7976 propagation (@option{-fipa-cp}).
7977 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7979 @item -fdevirtualize-speculatively
7980 @opindex fdevirtualize-speculatively
7981 Attempt to convert calls to virtual functions to speculative direct calls.
7982 Based on the analysis of the type inheritance graph, determine for a given call
7983 the set of likely targets. If the set is small, preferably of size 1, change
7984 the call into a conditional deciding between direct and indirect calls.  The
7985 speculative calls enable more optimizations, such as inlining.  When they seem
7986 useless after further optimization, they are converted back into original form.
7988 @item -fdevirtualize-at-ltrans
7989 @opindex fdevirtualize-at-ltrans
7990 Stream extra information needed for aggressive devirtualization when running
7991 the link-time optimizer in local transformation mode.  
7992 This option enables more devirtualization but
7993 significantly increases the size of streamed data. For this reason it is
7994 disabled by default.
7996 @item -fexpensive-optimizations
7997 @opindex fexpensive-optimizations
7998 Perform a number of minor optimizations that are relatively expensive.
8000 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8002 @item -free
8003 @opindex free
8004 Attempt to remove redundant extension instructions.  This is especially
8005 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8006 registers after writing to their lower 32-bit half.
8008 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8009 @option{-O3}, @option{-Os}.
8011 @item -fno-lifetime-dse
8012 @opindex fno-lifetime-dse
8013 In C++ the value of an object is only affected by changes within its
8014 lifetime: when the constructor begins, the object has an indeterminate
8015 value, and any changes during the lifetime of the object are dead when
8016 the object is destroyed.  Normally dead store elimination will take
8017 advantage of this; if your code relies on the value of the object
8018 storage persisting beyond the lifetime of the object, you can use this
8019 flag to disable this optimization.  To preserve stores before the
8020 constructor starts (e.g. because your operator new clears the object
8021 storage) but still treat the object as dead after the destructor you,
8022 can use @option{-flifetime-dse=1}.  The default behavior can be
8023 explicitly selected with @option{-flifetime-dse=2}.
8024 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
8026 @item -flive-range-shrinkage
8027 @opindex flive-range-shrinkage
8028 Attempt to decrease register pressure through register live range
8029 shrinkage.  This is helpful for fast processors with small or moderate
8030 size register sets.
8032 @item -fira-algorithm=@var{algorithm}
8033 @opindex fira-algorithm
8034 Use the specified coloring algorithm for the integrated register
8035 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8036 specifies Chow's priority coloring, or @samp{CB}, which specifies
8037 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8038 for all architectures, but for those targets that do support it, it is
8039 the default because it generates better code.
8041 @item -fira-region=@var{region}
8042 @opindex fira-region
8043 Use specified regions for the integrated register allocator.  The
8044 @var{region} argument should be one of the following:
8046 @table @samp
8048 @item all
8049 Use all loops as register allocation regions.
8050 This can give the best results for machines with a small and/or
8051 irregular register set.
8053 @item mixed
8054 Use all loops except for loops with small register pressure 
8055 as the regions.  This value usually gives
8056 the best results in most cases and for most architectures,
8057 and is enabled by default when compiling with optimization for speed
8058 (@option{-O}, @option{-O2}, @dots{}).
8060 @item one
8061 Use all functions as a single region.  
8062 This typically results in the smallest code size, and is enabled by default for
8063 @option{-Os} or @option{-O0}.
8065 @end table
8067 @item -fira-hoist-pressure
8068 @opindex fira-hoist-pressure
8069 Use IRA to evaluate register pressure in the code hoisting pass for
8070 decisions to hoist expressions.  This option usually results in smaller
8071 code, but it can slow the compiler down.
8073 This option is enabled at level @option{-Os} for all targets.
8075 @item -fira-loop-pressure
8076 @opindex fira-loop-pressure
8077 Use IRA to evaluate register pressure in loops for decisions to move
8078 loop invariants.  This option usually results in generation
8079 of faster and smaller code on machines with large register files (>= 32
8080 registers), but it can slow the compiler down.
8082 This option is enabled at level @option{-O3} for some targets.
8084 @item -fno-ira-share-save-slots
8085 @opindex fno-ira-share-save-slots
8086 Disable sharing of stack slots used for saving call-used hard
8087 registers living through a call.  Each hard register gets a
8088 separate stack slot, and as a result function stack frames are
8089 larger.
8091 @item -fno-ira-share-spill-slots
8092 @opindex fno-ira-share-spill-slots
8093 Disable sharing of stack slots allocated for pseudo-registers.  Each
8094 pseudo-register that does not get a hard register gets a separate
8095 stack slot, and as a result function stack frames are larger.
8097 @item -flra-remat
8098 @opindex flra-remat
8099 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8100 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8101 values if it is profitable.
8103 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8105 @item -fdelayed-branch
8106 @opindex fdelayed-branch
8107 If supported for the target machine, attempt to reorder instructions
8108 to exploit instruction slots available after delayed branch
8109 instructions.
8111 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8113 @item -fschedule-insns
8114 @opindex fschedule-insns
8115 If supported for the target machine, attempt to reorder instructions to
8116 eliminate execution stalls due to required data being unavailable.  This
8117 helps machines that have slow floating point or memory load instructions
8118 by allowing other instructions to be issued until the result of the load
8119 or floating-point instruction is required.
8121 Enabled at levels @option{-O2}, @option{-O3}.
8123 @item -fschedule-insns2
8124 @opindex fschedule-insns2
8125 Similar to @option{-fschedule-insns}, but requests an additional pass of
8126 instruction scheduling after register allocation has been done.  This is
8127 especially useful on machines with a relatively small number of
8128 registers and where memory load instructions take more than one cycle.
8130 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8132 @item -fno-sched-interblock
8133 @opindex fno-sched-interblock
8134 Don't schedule instructions across basic blocks.  This is normally
8135 enabled by default when scheduling before register allocation, i.e.@:
8136 with @option{-fschedule-insns} or at @option{-O2} or higher.
8138 @item -fno-sched-spec
8139 @opindex fno-sched-spec
8140 Don't allow speculative motion of non-load instructions.  This is normally
8141 enabled by default when scheduling before register allocation, i.e.@:
8142 with @option{-fschedule-insns} or at @option{-O2} or higher.
8144 @item -fsched-pressure
8145 @opindex fsched-pressure
8146 Enable register pressure sensitive insn scheduling before register
8147 allocation.  This only makes sense when scheduling before register
8148 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8149 @option{-O2} or higher.  Usage of this option can improve the
8150 generated code and decrease its size by preventing register pressure
8151 increase above the number of available hard registers and subsequent
8152 spills in register allocation.
8154 @item -fsched-spec-load
8155 @opindex fsched-spec-load
8156 Allow speculative motion of some load instructions.  This only makes
8157 sense when scheduling before register allocation, i.e.@: with
8158 @option{-fschedule-insns} or at @option{-O2} or higher.
8160 @item -fsched-spec-load-dangerous
8161 @opindex fsched-spec-load-dangerous
8162 Allow speculative motion of more load instructions.  This only makes
8163 sense when scheduling before register allocation, i.e.@: with
8164 @option{-fschedule-insns} or at @option{-O2} or higher.
8166 @item -fsched-stalled-insns
8167 @itemx -fsched-stalled-insns=@var{n}
8168 @opindex fsched-stalled-insns
8169 Define how many insns (if any) can be moved prematurely from the queue
8170 of stalled insns into the ready list during the second scheduling pass.
8171 @option{-fno-sched-stalled-insns} means that no insns are moved
8172 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8173 on how many queued insns can be moved prematurely.
8174 @option{-fsched-stalled-insns} without a value is equivalent to
8175 @option{-fsched-stalled-insns=1}.
8177 @item -fsched-stalled-insns-dep
8178 @itemx -fsched-stalled-insns-dep=@var{n}
8179 @opindex fsched-stalled-insns-dep
8180 Define how many insn groups (cycles) are examined for a dependency
8181 on a stalled insn that is a candidate for premature removal from the queue
8182 of stalled insns.  This has an effect only during the second scheduling pass,
8183 and only if @option{-fsched-stalled-insns} is used.
8184 @option{-fno-sched-stalled-insns-dep} is equivalent to
8185 @option{-fsched-stalled-insns-dep=0}.
8186 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8187 @option{-fsched-stalled-insns-dep=1}.
8189 @item -fsched2-use-superblocks
8190 @opindex fsched2-use-superblocks
8191 When scheduling after register allocation, use superblock scheduling.
8192 This allows motion across basic block boundaries,
8193 resulting in faster schedules.  This option is experimental, as not all machine
8194 descriptions used by GCC model the CPU closely enough to avoid unreliable
8195 results from the algorithm.
8197 This only makes sense when scheduling after register allocation, i.e.@: with
8198 @option{-fschedule-insns2} or at @option{-O2} or higher.
8200 @item -fsched-group-heuristic
8201 @opindex fsched-group-heuristic
8202 Enable the group heuristic in the scheduler.  This heuristic favors
8203 the instruction that belongs to a schedule group.  This is enabled
8204 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8205 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8207 @item -fsched-critical-path-heuristic
8208 @opindex fsched-critical-path-heuristic
8209 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8210 instructions on the critical path.  This is enabled by default when
8211 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8212 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8214 @item -fsched-spec-insn-heuristic
8215 @opindex fsched-spec-insn-heuristic
8216 Enable the speculative instruction heuristic in the scheduler.  This
8217 heuristic favors speculative instructions with greater dependency weakness.
8218 This is enabled by default when scheduling is enabled, i.e.@:
8219 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8220 or at @option{-O2} or higher.
8222 @item -fsched-rank-heuristic
8223 @opindex fsched-rank-heuristic
8224 Enable the rank heuristic in the scheduler.  This heuristic favors
8225 the instruction belonging to a basic block with greater size or frequency.
8226 This is enabled by default when scheduling is enabled, i.e.@:
8227 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8228 at @option{-O2} or higher.
8230 @item -fsched-last-insn-heuristic
8231 @opindex fsched-last-insn-heuristic
8232 Enable the last-instruction heuristic in the scheduler.  This heuristic
8233 favors the instruction that is less dependent on the last instruction
8234 scheduled.  This is enabled by default when scheduling is enabled,
8235 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8236 at @option{-O2} or higher.
8238 @item -fsched-dep-count-heuristic
8239 @opindex fsched-dep-count-heuristic
8240 Enable the dependent-count heuristic in the scheduler.  This heuristic
8241 favors the instruction that has more instructions depending on it.
8242 This is enabled by default when scheduling is enabled, i.e.@:
8243 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8244 at @option{-O2} or higher.
8246 @item -freschedule-modulo-scheduled-loops
8247 @opindex freschedule-modulo-scheduled-loops
8248 Modulo scheduling is performed before traditional scheduling.  If a loop
8249 is modulo scheduled, later scheduling passes may change its schedule.  
8250 Use this option to control that behavior.
8252 @item -fselective-scheduling
8253 @opindex fselective-scheduling
8254 Schedule instructions using selective scheduling algorithm.  Selective
8255 scheduling runs instead of the first scheduler pass.
8257 @item -fselective-scheduling2
8258 @opindex fselective-scheduling2
8259 Schedule instructions using selective scheduling algorithm.  Selective
8260 scheduling runs instead of the second scheduler pass.
8262 @item -fsel-sched-pipelining
8263 @opindex fsel-sched-pipelining
8264 Enable software pipelining of innermost loops during selective scheduling.
8265 This option has no effect unless one of @option{-fselective-scheduling} or
8266 @option{-fselective-scheduling2} is turned on.
8268 @item -fsel-sched-pipelining-outer-loops
8269 @opindex fsel-sched-pipelining-outer-loops
8270 When pipelining loops during selective scheduling, also pipeline outer loops.
8271 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8273 @item -fsemantic-interposition
8274 @opindex fsemantic-interposition
8275 Some object formats, like ELF, allow interposing of symbols by the 
8276 dynamic linker.
8277 This means that for symbols exported from the DSO, the compiler cannot perform
8278 interprocedural propagation, inlining and other optimizations in anticipation
8279 that the function or variable in question may change. While this feature is
8280 useful, for example, to rewrite memory allocation functions by a debugging
8281 implementation, it is expensive in the terms of code quality.
8282 With @option{-fno-semantic-interposition} the compiler assumes that 
8283 if interposition happens for functions the overwriting function will have 
8284 precisely the same semantics (and side effects). 
8285 Similarly if interposition happens
8286 for variables, the constructor of the variable will be the same. The flag
8287 has no effect for functions explicitly declared inline 
8288 (where it is never allowed for interposition to change semantics) 
8289 and for symbols explicitly declared weak.
8291 @item -fshrink-wrap
8292 @opindex fshrink-wrap
8293 Emit function prologues only before parts of the function that need it,
8294 rather than at the top of the function.  This flag is enabled by default at
8295 @option{-O} and higher.
8297 @item -fshrink-wrap-separate
8298 @opindex fshrink-wrap-separate
8299 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8300 those parts are only executed when needed.
8301 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8302 is also turned on and the target supports this.
8304 @item -fcaller-saves
8305 @opindex fcaller-saves
8306 Enable allocation of values to registers that are clobbered by
8307 function calls, by emitting extra instructions to save and restore the
8308 registers around such calls.  Such allocation is done only when it
8309 seems to result in better code.
8311 This option is always enabled by default on certain machines, usually
8312 those which have no call-preserved registers to use instead.
8314 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8316 @item -fcombine-stack-adjustments
8317 @opindex fcombine-stack-adjustments
8318 Tracks stack adjustments (pushes and pops) and stack memory references
8319 and then tries to find ways to combine them.
8321 Enabled by default at @option{-O1} and higher.
8323 @item -fipa-ra
8324 @opindex fipa-ra
8325 Use caller save registers for allocation if those registers are not used by
8326 any called function.  In that case it is not necessary to save and restore
8327 them around calls.  This is only possible if called functions are part of
8328 same compilation unit as current function and they are compiled before it.
8330 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8331 is disabled if generated code will be instrumented for profiling
8332 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8333 exactly (this happens on targets that do not expose prologues
8334 and epilogues in RTL).
8336 @item -fconserve-stack
8337 @opindex fconserve-stack
8338 Attempt to minimize stack usage.  The compiler attempts to use less
8339 stack space, even if that makes the program slower.  This option
8340 implies setting the @option{large-stack-frame} parameter to 100
8341 and the @option{large-stack-frame-growth} parameter to 400.
8343 @item -ftree-reassoc
8344 @opindex ftree-reassoc
8345 Perform reassociation on trees.  This flag is enabled by default
8346 at @option{-O} and higher.
8348 @item -fcode-hoisting
8349 @opindex fcode-hoisting
8350 Perform code hoisting.  Code hoisting tries to move the
8351 evaluation of expressions executed on all paths to the function exit
8352 as early as possible.  This is especially useful as a code size
8353 optimization, but it often helps for code speed as well.
8354 This flag is enabled by default at @option{-O2} and higher.
8356 @item -ftree-pre
8357 @opindex ftree-pre
8358 Perform partial redundancy elimination (PRE) on trees.  This flag is
8359 enabled by default at @option{-O2} and @option{-O3}.
8361 @item -ftree-partial-pre
8362 @opindex ftree-partial-pre
8363 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8364 enabled by default at @option{-O3}.
8366 @item -ftree-forwprop
8367 @opindex ftree-forwprop
8368 Perform forward propagation on trees.  This flag is enabled by default
8369 at @option{-O} and higher.
8371 @item -ftree-fre
8372 @opindex ftree-fre
8373 Perform full redundancy elimination (FRE) on trees.  The difference
8374 between FRE and PRE is that FRE only considers expressions
8375 that are computed on all paths leading to the redundant computation.
8376 This analysis is faster than PRE, though it exposes fewer redundancies.
8377 This flag is enabled by default at @option{-O} and higher.
8379 @item -ftree-phiprop
8380 @opindex ftree-phiprop
8381 Perform hoisting of loads from conditional pointers on trees.  This
8382 pass is enabled by default at @option{-O} and higher.
8384 @item -fhoist-adjacent-loads
8385 @opindex fhoist-adjacent-loads
8386 Speculatively hoist loads from both branches of an if-then-else if the
8387 loads are from adjacent locations in the same structure and the target
8388 architecture has a conditional move instruction.  This flag is enabled
8389 by default at @option{-O2} and higher.
8391 @item -ftree-copy-prop
8392 @opindex ftree-copy-prop
8393 Perform copy propagation on trees.  This pass eliminates unnecessary
8394 copy operations.  This flag is enabled by default at @option{-O} and
8395 higher.
8397 @item -fipa-pure-const
8398 @opindex fipa-pure-const
8399 Discover which functions are pure or constant.
8400 Enabled by default at @option{-O} and higher.
8402 @item -fipa-reference
8403 @opindex fipa-reference
8404 Discover which static variables do not escape the
8405 compilation unit.
8406 Enabled by default at @option{-O} and higher.
8408 @item -fipa-pta
8409 @opindex fipa-pta
8410 Perform interprocedural pointer analysis and interprocedural modification
8411 and reference analysis.  This option can cause excessive memory and
8412 compile-time usage on large compilation units.  It is not enabled by
8413 default at any optimization level.
8415 @item -fipa-profile
8416 @opindex fipa-profile
8417 Perform interprocedural profile propagation.  The functions called only from
8418 cold functions are marked as cold. Also functions executed once (such as
8419 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8420 functions and loop less parts of functions executed once are then optimized for
8421 size.
8422 Enabled by default at @option{-O} and higher.
8424 @item -fipa-cp
8425 @opindex fipa-cp
8426 Perform interprocedural constant propagation.
8427 This optimization analyzes the program to determine when values passed
8428 to functions are constants and then optimizes accordingly.
8429 This optimization can substantially increase performance
8430 if the application has constants passed to functions.
8431 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8433 @item -fipa-cp-clone
8434 @opindex fipa-cp-clone
8435 Perform function cloning to make interprocedural constant propagation stronger.
8436 When enabled, interprocedural constant propagation performs function cloning
8437 when externally visible function can be called with constant arguments.
8438 Because this optimization can create multiple copies of functions,
8439 it may significantly increase code size
8440 (see @option{--param ipcp-unit-growth=@var{value}}).
8441 This flag is enabled by default at @option{-O3}.
8443 @item -fipa-bit-cp
8444 @opindex -fipa-bit-cp
8445 When enabled, perform interprocedural bitwise constant
8446 propagation. This flag is enabled by default at @option{-O2}. It
8447 requires that @option{-fipa-cp} is enabled.
8449 @item -fipa-vrp
8450 @opindex -fipa-vrp
8451 When enabled, perform interprocedural propagation of value
8452 ranges. This flag is enabled by default at @option{-O2}. It requires
8453 that @option{-fipa-cp} is enabled.
8455 @item -fipa-icf
8456 @opindex fipa-icf
8457 Perform Identical Code Folding for functions and read-only variables.
8458 The optimization reduces code size and may disturb unwind stacks by replacing
8459 a function by equivalent one with a different name. The optimization works
8460 more effectively with link-time optimization enabled.
8462 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8463 works on different levels and thus the optimizations are not same - there are
8464 equivalences that are found only by GCC and equivalences found only by Gold.
8466 This flag is enabled by default at @option{-O2} and @option{-Os}.
8468 @item -fisolate-erroneous-paths-dereference
8469 @opindex fisolate-erroneous-paths-dereference
8470 Detect paths that trigger erroneous or undefined behavior due to
8471 dereferencing a null pointer.  Isolate those paths from the main control
8472 flow and turn the statement with erroneous or undefined behavior into a trap.
8473 This flag is enabled by default at @option{-O2} and higher and depends on
8474 @option{-fdelete-null-pointer-checks} also being enabled.
8476 @item -fisolate-erroneous-paths-attribute
8477 @opindex fisolate-erroneous-paths-attribute
8478 Detect paths that trigger erroneous or undefined behavior due a null value
8479 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8480 attribute.  Isolate those paths from the main control flow and turn the
8481 statement with erroneous or undefined behavior into a trap.  This is not
8482 currently enabled, but may be enabled by @option{-O2} in the future.
8484 @item -ftree-sink
8485 @opindex ftree-sink
8486 Perform forward store motion on trees.  This flag is
8487 enabled by default at @option{-O} and higher.
8489 @item -ftree-bit-ccp
8490 @opindex ftree-bit-ccp
8491 Perform sparse conditional bit constant propagation on trees and propagate
8492 pointer alignment information.
8493 This pass only operates on local scalar variables and is enabled by default
8494 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8496 @item -ftree-ccp
8497 @opindex ftree-ccp
8498 Perform sparse conditional constant propagation (CCP) on trees.  This
8499 pass only operates on local scalar variables and is enabled by default
8500 at @option{-O} and higher.
8502 @item -fssa-backprop
8503 @opindex fssa-backprop
8504 Propagate information about uses of a value up the definition chain
8505 in order to simplify the definitions.  For example, this pass strips
8506 sign operations if the sign of a value never matters.  The flag is
8507 enabled by default at @option{-O} and higher.
8509 @item -fssa-phiopt
8510 @opindex fssa-phiopt
8511 Perform pattern matching on SSA PHI nodes to optimize conditional
8512 code.  This pass is enabled by default at @option{-O} and higher.
8514 @item -ftree-switch-conversion
8515 @opindex ftree-switch-conversion
8516 Perform conversion of simple initializations in a switch to
8517 initializations from a scalar array.  This flag is enabled by default
8518 at @option{-O2} and higher.
8520 @item -ftree-tail-merge
8521 @opindex ftree-tail-merge
8522 Look for identical code sequences.  When found, replace one with a jump to the
8523 other.  This optimization is known as tail merging or cross jumping.  This flag
8524 is enabled by default at @option{-O2} and higher.  The compilation time
8525 in this pass can
8526 be limited using @option{max-tail-merge-comparisons} parameter and
8527 @option{max-tail-merge-iterations} parameter.
8529 @item -ftree-dce
8530 @opindex ftree-dce
8531 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8532 default at @option{-O} and higher.
8534 @item -ftree-builtin-call-dce
8535 @opindex ftree-builtin-call-dce
8536 Perform conditional dead code elimination (DCE) for calls to built-in functions
8537 that may set @code{errno} but are otherwise side-effect free.  This flag is
8538 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8539 specified.
8541 @item -ftree-dominator-opts
8542 @opindex ftree-dominator-opts
8543 Perform a variety of simple scalar cleanups (constant/copy
8544 propagation, redundancy elimination, range propagation and expression
8545 simplification) based on a dominator tree traversal.  This also
8546 performs jump threading (to reduce jumps to jumps). This flag is
8547 enabled by default at @option{-O} and higher.
8549 @item -ftree-dse
8550 @opindex ftree-dse
8551 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8552 a memory location that is later overwritten by another store without
8553 any intervening loads.  In this case the earlier store can be deleted.  This
8554 flag is enabled by default at @option{-O} and higher.
8556 @item -ftree-ch
8557 @opindex ftree-ch
8558 Perform loop header copying on trees.  This is beneficial since it increases
8559 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8560 is enabled by default at @option{-O} and higher.  It is not enabled
8561 for @option{-Os}, since it usually increases code size.
8563 @item -ftree-loop-optimize
8564 @opindex ftree-loop-optimize
8565 Perform loop optimizations on trees.  This flag is enabled by default
8566 at @option{-O} and higher.
8568 @item -ftree-loop-linear
8569 @itemx -floop-strip-mine
8570 @itemx -floop-block
8571 @opindex ftree-loop-linear
8572 @opindex floop-strip-mine
8573 @opindex floop-block
8574 Perform loop nest optimizations.  Same as
8575 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8576 to be configured with @option{--with-isl} to enable the Graphite loop
8577 transformation infrastructure.
8579 @item -fgraphite-identity
8580 @opindex fgraphite-identity
8581 Enable the identity transformation for graphite.  For every SCoP we generate
8582 the polyhedral representation and transform it back to gimple.  Using
8583 @option{-fgraphite-identity} we can check the costs or benefits of the
8584 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8585 are also performed by the code generator isl, like index splitting and
8586 dead code elimination in loops.
8588 @item -floop-nest-optimize
8589 @opindex floop-nest-optimize
8590 Enable the isl based loop nest optimizer.  This is a generic loop nest
8591 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8592 structure optimized for data-locality and parallelism.  This option
8593 is experimental.
8595 @item -floop-parallelize-all
8596 @opindex floop-parallelize-all
8597 Use the Graphite data dependence analysis to identify loops that can
8598 be parallelized.  Parallelize all the loops that can be analyzed to
8599 not contain loop carried dependences without checking that it is
8600 profitable to parallelize the loops.
8602 @item -ftree-coalesce-vars
8603 @opindex ftree-coalesce-vars
8604 While transforming the program out of the SSA representation, attempt to
8605 reduce copying by coalescing versions of different user-defined
8606 variables, instead of just compiler temporaries.  This may severely
8607 limit the ability to debug an optimized program compiled with
8608 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8609 prevents SSA coalescing of user variables.  This option is enabled by
8610 default if optimization is enabled, and it does very little otherwise.
8612 @item -ftree-loop-if-convert
8613 @opindex ftree-loop-if-convert
8614 Attempt to transform conditional jumps in the innermost loops to
8615 branch-less equivalents.  The intent is to remove control-flow from
8616 the innermost loops in order to improve the ability of the
8617 vectorization pass to handle these loops.  This is enabled by default
8618 if vectorization is enabled.
8620 @item -ftree-loop-distribution
8621 @opindex ftree-loop-distribution
8622 Perform loop distribution.  This flag can improve cache performance on
8623 big loop bodies and allow further loop optimizations, like
8624 parallelization or vectorization, to take place.  For example, the loop
8625 @smallexample
8626 DO I = 1, N
8627   A(I) = B(I) + C
8628   D(I) = E(I) * F
8629 ENDDO
8630 @end smallexample
8631 is transformed to
8632 @smallexample
8633 DO I = 1, N
8634    A(I) = B(I) + C
8635 ENDDO
8636 DO I = 1, N
8637    D(I) = E(I) * F
8638 ENDDO
8639 @end smallexample
8641 @item -ftree-loop-distribute-patterns
8642 @opindex ftree-loop-distribute-patterns
8643 Perform loop distribution of patterns that can be code generated with
8644 calls to a library.  This flag is enabled by default at @option{-O3}.
8646 This pass distributes the initialization loops and generates a call to
8647 memset zero.  For example, the loop
8648 @smallexample
8649 DO I = 1, N
8650   A(I) = 0
8651   B(I) = A(I) + I
8652 ENDDO
8653 @end smallexample
8654 is transformed to
8655 @smallexample
8656 DO I = 1, N
8657    A(I) = 0
8658 ENDDO
8659 DO I = 1, N
8660    B(I) = A(I) + I
8661 ENDDO
8662 @end smallexample
8663 and the initialization loop is transformed into a call to memset zero.
8665 @item -floop-interchange
8666 @opindex floop-interchange
8667 Perform loop interchange outside of graphite.  This flag can improve cache
8668 performance on loop nest and allow further loop optimizations, like
8669 vectorization, to take place.  For example, the loop
8670 @smallexample
8671 for (int i = 0; i < N; i++)
8672   for (int j = 0; j < N; j++)
8673     for (int k = 0; k < N; k++)
8674       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8675 @end smallexample
8676 is transformed to
8677 @smallexample
8678 for (int i = 0; i < N; i++)
8679   for (int k = 0; k < N; k++)
8680     for (int j = 0; j < N; j++)
8681       c[i][j] = c[i][j] + a[i][k]*b[k][j];
8682 @end smallexample
8684 @item -ftree-loop-im
8685 @opindex ftree-loop-im
8686 Perform loop invariant motion on trees.  This pass moves only invariants that
8687 are hard to handle at RTL level (function calls, operations that expand to
8688 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8689 operands of conditions that are invariant out of the loop, so that we can use
8690 just trivial invariantness analysis in loop unswitching.  The pass also includes
8691 store motion.
8693 @item -ftree-loop-ivcanon
8694 @opindex ftree-loop-ivcanon
8695 Create a canonical counter for number of iterations in loops for which
8696 determining number of iterations requires complicated analysis.  Later
8697 optimizations then may determine the number easily.  Useful especially
8698 in connection with unrolling.
8700 @item -fivopts
8701 @opindex fivopts
8702 Perform induction variable optimizations (strength reduction, induction
8703 variable merging and induction variable elimination) on trees.
8705 @item -ftree-parallelize-loops=n
8706 @opindex ftree-parallelize-loops
8707 Parallelize loops, i.e., split their iteration space to run in n threads.
8708 This is only possible for loops whose iterations are independent
8709 and can be arbitrarily reordered.  The optimization is only
8710 profitable on multiprocessor machines, for loops that are CPU-intensive,
8711 rather than constrained e.g.@: by memory bandwidth.  This option
8712 implies @option{-pthread}, and thus is only supported on targets
8713 that have support for @option{-pthread}.
8715 @item -ftree-pta
8716 @opindex ftree-pta
8717 Perform function-local points-to analysis on trees.  This flag is
8718 enabled by default at @option{-O} and higher.
8720 @item -ftree-sra
8721 @opindex ftree-sra
8722 Perform scalar replacement of aggregates.  This pass replaces structure
8723 references with scalars to prevent committing structures to memory too
8724 early.  This flag is enabled by default at @option{-O} and higher.
8726 @item -fstore-merging
8727 @opindex fstore-merging
8728 Perform merging of narrow stores to consecutive memory addresses.  This pass
8729 merges contiguous stores of immediate values narrower than a word into fewer
8730 wider stores to reduce the number of instructions.  This is enabled by default
8731 at @option{-O2} and higher as well as @option{-Os}.
8733 @item -ftree-ter
8734 @opindex ftree-ter
8735 Perform temporary expression replacement during the SSA->normal phase.  Single
8736 use/single def temporaries are replaced at their use location with their
8737 defining expression.  This results in non-GIMPLE code, but gives the expanders
8738 much more complex trees to work on resulting in better RTL generation.  This is
8739 enabled by default at @option{-O} and higher.
8741 @item -ftree-slsr
8742 @opindex ftree-slsr
8743 Perform straight-line strength reduction on trees.  This recognizes related
8744 expressions involving multiplications and replaces them by less expensive
8745 calculations when possible.  This is enabled by default at @option{-O} and
8746 higher.
8748 @item -ftree-vectorize
8749 @opindex ftree-vectorize
8750 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8751 and @option{-ftree-slp-vectorize} if not explicitly specified.
8753 @item -ftree-loop-vectorize
8754 @opindex ftree-loop-vectorize
8755 Perform loop vectorization on trees. This flag is enabled by default at
8756 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8758 @item -ftree-slp-vectorize
8759 @opindex ftree-slp-vectorize
8760 Perform basic block vectorization on trees. This flag is enabled by default at
8761 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8763 @item -fvect-cost-model=@var{model}
8764 @opindex fvect-cost-model
8765 Alter the cost model used for vectorization.  The @var{model} argument
8766 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8767 With the @samp{unlimited} model the vectorized code-path is assumed
8768 to be profitable while with the @samp{dynamic} model a runtime check
8769 guards the vectorized code-path to enable it only for iteration
8770 counts that will likely execute faster than when executing the original
8771 scalar loop.  The @samp{cheap} model disables vectorization of
8772 loops where doing so would be cost prohibitive for example due to
8773 required runtime checks for data dependence or alignment but otherwise
8774 is equal to the @samp{dynamic} model.
8775 The default cost model depends on other optimization flags and is
8776 either @samp{dynamic} or @samp{cheap}.
8778 @item -fsimd-cost-model=@var{model}
8779 @opindex fsimd-cost-model
8780 Alter the cost model used for vectorization of loops marked with the OpenMP
8781 or Cilk Plus simd directive.  The @var{model} argument should be one of
8782 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8783 have the same meaning as described in @option{-fvect-cost-model} and by
8784 default a cost model defined with @option{-fvect-cost-model} is used.
8786 @item -ftree-vrp
8787 @opindex ftree-vrp
8788 Perform Value Range Propagation on trees.  This is similar to the
8789 constant propagation pass, but instead of values, ranges of values are
8790 propagated.  This allows the optimizers to remove unnecessary range
8791 checks like array bound checks and null pointer checks.  This is
8792 enabled by default at @option{-O2} and higher.  Null pointer check
8793 elimination is only done if @option{-fdelete-null-pointer-checks} is
8794 enabled.
8796 @item -fsplit-paths
8797 @opindex fsplit-paths
8798 Split paths leading to loop backedges.  This can improve dead code
8799 elimination and common subexpression elimination.  This is enabled by
8800 default at @option{-O2} and above.
8802 @item -fsplit-ivs-in-unroller
8803 @opindex fsplit-ivs-in-unroller
8804 Enables expression of values of induction variables in later iterations
8805 of the unrolled loop using the value in the first iteration.  This breaks
8806 long dependency chains, thus improving efficiency of the scheduling passes.
8808 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8809 same effect.  However, that is not reliable in cases where the loop body
8810 is more complicated than a single basic block.  It also does not work at all
8811 on some architectures due to restrictions in the CSE pass.
8813 This optimization is enabled by default.
8815 @item -fvariable-expansion-in-unroller
8816 @opindex fvariable-expansion-in-unroller
8817 With this option, the compiler creates multiple copies of some
8818 local variables when unrolling a loop, which can result in superior code.
8820 @item -fpartial-inlining
8821 @opindex fpartial-inlining
8822 Inline parts of functions.  This option has any effect only
8823 when inlining itself is turned on by the @option{-finline-functions}
8824 or @option{-finline-small-functions} options.
8826 Enabled at level @option{-O2}.
8828 @item -fpredictive-commoning
8829 @opindex fpredictive-commoning
8830 Perform predictive commoning optimization, i.e., reusing computations
8831 (especially memory loads and stores) performed in previous
8832 iterations of loops.
8834 This option is enabled at level @option{-O3}.
8836 @item -fprefetch-loop-arrays
8837 @opindex fprefetch-loop-arrays
8838 If supported by the target machine, generate instructions to prefetch
8839 memory to improve the performance of loops that access large arrays.
8841 This option may generate better or worse code; results are highly
8842 dependent on the structure of loops within the source code.
8844 Disabled at level @option{-Os}.
8846 @item -fno-printf-return-value
8847 @opindex fno-printf-return-value
8848 Do not substitute constants for known return value of formatted output
8849 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8850 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8851 transformation allows GCC to optimize or even eliminate branches based
8852 on the known return value of these functions called with arguments that
8853 are either constant, or whose values are known to be in a range that
8854 makes determining the exact return value possible.  For example, when
8855 @option{-fprintf-return-value} is in effect, both the branch and the
8856 body of the @code{if} statement (but not the call to @code{snprint})
8857 can be optimized away when @code{i} is a 32-bit or smaller integer
8858 because the return value is guaranteed to be at most 8.
8860 @smallexample
8861 char buf[9];
8862 if (snprintf (buf, "%08x", i) >= sizeof buf)
8863   @dots{}
8864 @end smallexample
8866 The @option{-fprintf-return-value} option relies on other optimizations
8867 and yields best results with @option{-O2}.  It works in tandem with the
8868 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8869 The @option{-fprintf-return-value} option is enabled by default.
8871 @item -fno-peephole
8872 @itemx -fno-peephole2
8873 @opindex fno-peephole
8874 @opindex fno-peephole2
8875 Disable any machine-specific peephole optimizations.  The difference
8876 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8877 are implemented in the compiler; some targets use one, some use the
8878 other, a few use both.
8880 @option{-fpeephole} is enabled by default.
8881 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8883 @item -fno-guess-branch-probability
8884 @opindex fno-guess-branch-probability
8885 Do not guess branch probabilities using heuristics.
8887 GCC uses heuristics to guess branch probabilities if they are
8888 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8889 heuristics are based on the control flow graph.  If some branch probabilities
8890 are specified by @code{__builtin_expect}, then the heuristics are
8891 used to guess branch probabilities for the rest of the control flow graph,
8892 taking the @code{__builtin_expect} info into account.  The interactions
8893 between the heuristics and @code{__builtin_expect} can be complex, and in
8894 some cases, it may be useful to disable the heuristics so that the effects
8895 of @code{__builtin_expect} are easier to understand.
8897 The default is @option{-fguess-branch-probability} at levels
8898 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8900 @item -freorder-blocks
8901 @opindex freorder-blocks
8902 Reorder basic blocks in the compiled function in order to reduce number of
8903 taken branches and improve code locality.
8905 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8907 @item -freorder-blocks-algorithm=@var{algorithm}
8908 @opindex freorder-blocks-algorithm
8909 Use the specified algorithm for basic block reordering.  The
8910 @var{algorithm} argument can be @samp{simple}, which does not increase
8911 code size (except sometimes due to secondary effects like alignment),
8912 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8913 put all often executed code together, minimizing the number of branches
8914 executed by making extra copies of code.
8916 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8917 @samp{stc} at levels @option{-O2}, @option{-O3}.
8919 @item -freorder-blocks-and-partition
8920 @opindex freorder-blocks-and-partition
8921 In addition to reordering basic blocks in the compiled function, in order
8922 to reduce number of taken branches, partitions hot and cold basic blocks
8923 into separate sections of the assembly and @file{.o} files, to improve
8924 paging and cache locality performance.
8926 This optimization is automatically turned off in the presence of
8927 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8928 section attribute and on any architecture that does not support named
8929 sections.  When @option{-fsplit-stack} is used this option is not
8930 enabled by default (to avoid linker errors), but may be enabled
8931 explicitly (if using a working linker).
8933 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8935 @item -freorder-functions
8936 @opindex freorder-functions
8937 Reorder functions in the object file in order to
8938 improve code locality.  This is implemented by using special
8939 subsections @code{.text.hot} for most frequently executed functions and
8940 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8941 the linker so object file format must support named sections and linker must
8942 place them in a reasonable way.
8944 Also profile feedback must be available to make this option effective.  See
8945 @option{-fprofile-arcs} for details.
8947 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8949 @item -fstrict-aliasing
8950 @opindex fstrict-aliasing
8951 Allow the compiler to assume the strictest aliasing rules applicable to
8952 the language being compiled.  For C (and C++), this activates
8953 optimizations based on the type of expressions.  In particular, an
8954 object of one type is assumed never to reside at the same address as an
8955 object of a different type, unless the types are almost the same.  For
8956 example, an @code{unsigned int} can alias an @code{int}, but not a
8957 @code{void*} or a @code{double}.  A character type may alias any other
8958 type.
8960 @anchor{Type-punning}Pay special attention to code like this:
8961 @smallexample
8962 union a_union @{
8963   int i;
8964   double d;
8967 int f() @{
8968   union a_union t;
8969   t.d = 3.0;
8970   return t.i;
8972 @end smallexample
8973 The practice of reading from a different union member than the one most
8974 recently written to (called ``type-punning'') is common.  Even with
8975 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8976 is accessed through the union type.  So, the code above works as
8977 expected.  @xref{Structures unions enumerations and bit-fields
8978 implementation}.  However, this code might not:
8979 @smallexample
8980 int f() @{
8981   union a_union t;
8982   int* ip;
8983   t.d = 3.0;
8984   ip = &t.i;
8985   return *ip;
8987 @end smallexample
8989 Similarly, access by taking the address, casting the resulting pointer
8990 and dereferencing the result has undefined behavior, even if the cast
8991 uses a union type, e.g.:
8992 @smallexample
8993 int f() @{
8994   double d = 3.0;
8995   return ((union a_union *) &d)->i;
8997 @end smallexample
8999 The @option{-fstrict-aliasing} option is enabled at levels
9000 @option{-O2}, @option{-O3}, @option{-Os}.
9002 @item -falign-functions
9003 @itemx -falign-functions=@var{n}
9004 @opindex falign-functions
9005 Align the start of functions to the next power-of-two greater than
9006 @var{n}, skipping up to @var{n} bytes.  For instance,
9007 @option{-falign-functions=32} aligns functions to the next 32-byte
9008 boundary, but @option{-falign-functions=24} aligns to the next
9009 32-byte boundary only if this can be done by skipping 23 bytes or less.
9011 @option{-fno-align-functions} and @option{-falign-functions=1} are
9012 equivalent and mean that functions are not aligned.
9014 Some assemblers only support this flag when @var{n} is a power of two;
9015 in that case, it is rounded up.
9017 If @var{n} is not specified or is zero, use a machine-dependent default.
9019 Enabled at levels @option{-O2}, @option{-O3}.
9021 @item -flimit-function-alignment
9022 If this option is enabled, the compiler tries to avoid unnecessarily
9023 overaligning functions. It attempts to instruct the assembler to align
9024 by the amount specified by @option{-falign-functions}, but not to
9025 skip more bytes than the size of the function.
9027 @item -falign-labels
9028 @itemx -falign-labels=@var{n}
9029 @opindex falign-labels
9030 Align all branch targets to a power-of-two boundary, skipping up to
9031 @var{n} bytes like @option{-falign-functions}.  This option can easily
9032 make code slower, because it must insert dummy operations for when the
9033 branch target is reached in the usual flow of the code.
9035 @option{-fno-align-labels} and @option{-falign-labels=1} are
9036 equivalent and mean that labels are not aligned.
9038 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9039 are greater than this value, then their values are used instead.
9041 If @var{n} is not specified or is zero, use a machine-dependent default
9042 which is very likely to be @samp{1}, meaning no alignment.
9044 Enabled at levels @option{-O2}, @option{-O3}.
9046 @item -falign-loops
9047 @itemx -falign-loops=@var{n}
9048 @opindex falign-loops
9049 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9050 like @option{-falign-functions}.  If the loops are
9051 executed many times, this makes up for any execution of the dummy
9052 operations.
9054 @option{-fno-align-loops} and @option{-falign-loops=1} are
9055 equivalent and mean that loops are not aligned.
9057 If @var{n} is not specified or is zero, use a machine-dependent default.
9059 Enabled at levels @option{-O2}, @option{-O3}.
9061 @item -falign-jumps
9062 @itemx -falign-jumps=@var{n}
9063 @opindex falign-jumps
9064 Align branch targets to a power-of-two boundary, for branch targets
9065 where the targets can only be reached by jumping, skipping up to @var{n}
9066 bytes like @option{-falign-functions}.  In this case, no dummy operations
9067 need be executed.
9069 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9070 equivalent and mean that loops are not aligned.
9072 If @var{n} is not specified or is zero, use a machine-dependent default.
9074 Enabled at levels @option{-O2}, @option{-O3}.
9076 @item -funit-at-a-time
9077 @opindex funit-at-a-time
9078 This option is left for compatibility reasons. @option{-funit-at-a-time}
9079 has no effect, while @option{-fno-unit-at-a-time} implies
9080 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9082 Enabled by default.
9084 @item -fno-toplevel-reorder
9085 @opindex fno-toplevel-reorder
9086 Do not reorder top-level functions, variables, and @code{asm}
9087 statements.  Output them in the same order that they appear in the
9088 input file.  When this option is used, unreferenced static variables
9089 are not removed.  This option is intended to support existing code
9090 that relies on a particular ordering.  For new code, it is better to
9091 use attributes when possible.
9093 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9094 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9095 targets.
9097 @item -fweb
9098 @opindex fweb
9099 Constructs webs as commonly used for register allocation purposes and assign
9100 each web individual pseudo register.  This allows the register allocation pass
9101 to operate on pseudos directly, but also strengthens several other optimization
9102 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9103 however, make debugging impossible, since variables no longer stay in a
9104 ``home register''.
9106 Enabled by default with @option{-funroll-loops}.
9108 @item -fwhole-program
9109 @opindex fwhole-program
9110 Assume that the current compilation unit represents the whole program being
9111 compiled.  All public functions and variables with the exception of @code{main}
9112 and those merged by attribute @code{externally_visible} become static functions
9113 and in effect are optimized more aggressively by interprocedural optimizers.
9115 This option should not be used in combination with @option{-flto}.
9116 Instead relying on a linker plugin should provide safer and more precise
9117 information.
9119 @item -flto[=@var{n}]
9120 @opindex flto
9121 This option runs the standard link-time optimizer.  When invoked
9122 with source code, it generates GIMPLE (one of GCC's internal
9123 representations) and writes it to special ELF sections in the object
9124 file.  When the object files are linked together, all the function
9125 bodies are read from these ELF sections and instantiated as if they
9126 had been part of the same translation unit.
9128 To use the link-time optimizer, @option{-flto} and optimization
9129 options should be specified at compile time and during the final link.
9130 It is recommended that you compile all the files participating in the
9131 same link with the same options and also specify those options at
9132 link time.  
9133 For example:
9135 @smallexample
9136 gcc -c -O2 -flto foo.c
9137 gcc -c -O2 -flto bar.c
9138 gcc -o myprog -flto -O2 foo.o bar.o
9139 @end smallexample
9141 The first two invocations to GCC save a bytecode representation
9142 of GIMPLE into special ELF sections inside @file{foo.o} and
9143 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9144 @file{foo.o} and @file{bar.o}, merges the two files into a single
9145 internal image, and compiles the result as usual.  Since both
9146 @file{foo.o} and @file{bar.o} are merged into a single image, this
9147 causes all the interprocedural analyses and optimizations in GCC to
9148 work across the two files as if they were a single one.  This means,
9149 for example, that the inliner is able to inline functions in
9150 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9152 Another (simpler) way to enable link-time optimization is:
9154 @smallexample
9155 gcc -o myprog -flto -O2 foo.c bar.c
9156 @end smallexample
9158 The above generates bytecode for @file{foo.c} and @file{bar.c},
9159 merges them together into a single GIMPLE representation and optimizes
9160 them as usual to produce @file{myprog}.
9162 The only important thing to keep in mind is that to enable link-time
9163 optimizations you need to use the GCC driver to perform the link step.
9164 GCC then automatically performs link-time optimization if any of the
9165 objects involved were compiled with the @option{-flto} command-line option.  
9166 You generally
9167 should specify the optimization options to be used for link-time
9168 optimization though GCC tries to be clever at guessing an
9169 optimization level to use from the options used at compile time
9170 if you fail to specify one at link time.  You can always override
9171 the automatic decision to do link-time optimization
9172 by passing @option{-fno-lto} to the link command.
9174 To make whole program optimization effective, it is necessary to make
9175 certain whole program assumptions.  The compiler needs to know
9176 what functions and variables can be accessed by libraries and runtime
9177 outside of the link-time optimized unit.  When supported by the linker,
9178 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9179 to the compiler about used and externally visible symbols.  When
9180 the linker plugin is not available, @option{-fwhole-program} should be
9181 used to allow the compiler to make these assumptions, which leads
9182 to more aggressive optimization decisions.
9184 When @option{-fuse-linker-plugin} is not enabled, when a file is
9185 compiled with @option{-flto}, the generated object file is larger than
9186 a regular object file because it contains GIMPLE bytecodes and the usual
9187 final code (see @option{-ffat-lto-objects}.  This means that
9188 object files with LTO information can be linked as normal object
9189 files; if @option{-fno-lto} is passed to the linker, no
9190 interprocedural optimizations are applied.  Note that when
9191 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9192 but you cannot perform a regular, non-LTO link on them.
9194 Additionally, the optimization flags used to compile individual files
9195 are not necessarily related to those used at link time.  For instance,
9197 @smallexample
9198 gcc -c -O0 -ffat-lto-objects -flto foo.c
9199 gcc -c -O0 -ffat-lto-objects -flto bar.c
9200 gcc -o myprog -O3 foo.o bar.o
9201 @end smallexample
9203 This produces individual object files with unoptimized assembler
9204 code, but the resulting binary @file{myprog} is optimized at
9205 @option{-O3}.  If, instead, the final binary is generated with
9206 @option{-fno-lto}, then @file{myprog} is not optimized.
9208 When producing the final binary, GCC only
9209 applies link-time optimizations to those files that contain bytecode.
9210 Therefore, you can mix and match object files and libraries with
9211 GIMPLE bytecodes and final object code.  GCC automatically selects
9212 which files to optimize in LTO mode and which files to link without
9213 further processing.
9215 There are some code generation flags preserved by GCC when
9216 generating bytecodes, as they need to be used during the final link
9217 stage.  Generally options specified at link time override those
9218 specified at compile time.
9220 If you do not specify an optimization level option @option{-O} at
9221 link time, then GCC uses the highest optimization level 
9222 used when compiling the object files.
9224 Currently, the following options and their settings are taken from
9225 the first object file that explicitly specifies them: 
9226 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9227 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9228 and all the @option{-m} target flags.
9230 Certain ABI-changing flags are required to match in all compilation units,
9231 and trying to override this at link time with a conflicting value
9232 is ignored.  This includes options such as @option{-freg-struct-return}
9233 and @option{-fpcc-struct-return}. 
9235 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9236 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9237 are passed through to the link stage and merged conservatively for
9238 conflicting translation units.  Specifically
9239 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9240 precedence; and for example @option{-ffp-contract=off} takes precedence
9241 over @option{-ffp-contract=fast}.  You can override them at link time.
9243 If LTO encounters objects with C linkage declared with incompatible
9244 types in separate translation units to be linked together (undefined
9245 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9246 issued.  The behavior is still undefined at run time.  Similar
9247 diagnostics may be raised for other languages.
9249 Another feature of LTO is that it is possible to apply interprocedural
9250 optimizations on files written in different languages:
9252 @smallexample
9253 gcc -c -flto foo.c
9254 g++ -c -flto bar.cc
9255 gfortran -c -flto baz.f90
9256 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9257 @end smallexample
9259 Notice that the final link is done with @command{g++} to get the C++
9260 runtime libraries and @option{-lgfortran} is added to get the Fortran
9261 runtime libraries.  In general, when mixing languages in LTO mode, you
9262 should use the same link command options as when mixing languages in a
9263 regular (non-LTO) compilation.
9265 If object files containing GIMPLE bytecode are stored in a library archive, say
9266 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9267 are using a linker with plugin support.  To create static libraries suitable
9268 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9269 and @command{ranlib}; 
9270 to show the symbols of object files with GIMPLE bytecode, use
9271 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9272 and @command{nm} have been compiled with plugin support.  At link time, use the the
9273 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9274 the LTO optimization process:
9276 @smallexample
9277 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9278 @end smallexample
9280 With the linker plugin enabled, the linker extracts the needed
9281 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9282 to make them part of the aggregated GIMPLE image to be optimized.
9284 If you are not using a linker with plugin support and/or do not
9285 enable the linker plugin, then the objects inside @file{libfoo.a}
9286 are extracted and linked as usual, but they do not participate
9287 in the LTO optimization process.  In order to make a static library suitable
9288 for both LTO optimization and usual linkage, compile its object files with
9289 @option{-flto} @option{-ffat-lto-objects}.
9291 Link-time optimizations do not require the presence of the whole program to
9292 operate.  If the program does not require any symbols to be exported, it is
9293 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9294 the interprocedural optimizers to use more aggressive assumptions which may
9295 lead to improved optimization opportunities.
9296 Use of @option{-fwhole-program} is not needed when linker plugin is
9297 active (see @option{-fuse-linker-plugin}).
9299 The current implementation of LTO makes no
9300 attempt to generate bytecode that is portable between different
9301 types of hosts.  The bytecode files are versioned and there is a
9302 strict version check, so bytecode files generated in one version of
9303 GCC do not work with an older or newer version of GCC.
9305 Link-time optimization does not work well with generation of debugging
9306 information.  Combining @option{-flto} with
9307 @option{-g} is currently experimental and expected to produce unexpected
9308 results.
9310 If you specify the optional @var{n}, the optimization and code
9311 generation done at link time is executed in parallel using @var{n}
9312 parallel jobs by utilizing an installed @command{make} program.  The
9313 environment variable @env{MAKE} may be used to override the program
9314 used.  The default value for @var{n} is 1.
9316 You can also specify @option{-flto=jobserver} to use GNU make's
9317 job server mode to determine the number of parallel jobs. This
9318 is useful when the Makefile calling GCC is already executing in parallel.
9319 You must prepend a @samp{+} to the command recipe in the parent Makefile
9320 for this to work.  This option likely only works if @env{MAKE} is
9321 GNU make.
9323 @item -flto-partition=@var{alg}
9324 @opindex flto-partition
9325 Specify the partitioning algorithm used by the link-time optimizer.
9326 The value is either @samp{1to1} to specify a partitioning mirroring
9327 the original source files or @samp{balanced} to specify partitioning
9328 into equally sized chunks (whenever possible) or @samp{max} to create
9329 new partition for every symbol where possible.  Specifying @samp{none}
9330 as an algorithm disables partitioning and streaming completely. 
9331 The default value is @samp{balanced}. While @samp{1to1} can be used
9332 as an workaround for various code ordering issues, the @samp{max}
9333 partitioning is intended for internal testing only.
9334 The value @samp{one} specifies that exactly one partition should be
9335 used while the value @samp{none} bypasses partitioning and executes
9336 the link-time optimization step directly from the WPA phase.
9338 @item -flto-odr-type-merging
9339 @opindex flto-odr-type-merging
9340 Enable streaming of mangled types names of C++ types and their unification
9341 at link time.  This increases size of LTO object files, but enables
9342 diagnostics about One Definition Rule violations.
9344 @item -flto-compression-level=@var{n}
9345 @opindex flto-compression-level
9346 This option specifies the level of compression used for intermediate
9347 language written to LTO object files, and is only meaningful in
9348 conjunction with LTO mode (@option{-flto}).  Valid
9349 values are 0 (no compression) to 9 (maximum compression).  Values
9350 outside this range are clamped to either 0 or 9.  If the option is not
9351 given, a default balanced compression setting is used.
9353 @item -fuse-linker-plugin
9354 @opindex fuse-linker-plugin
9355 Enables the use of a linker plugin during link-time optimization.  This
9356 option relies on plugin support in the linker, which is available in gold
9357 or in GNU ld 2.21 or newer.
9359 This option enables the extraction of object files with GIMPLE bytecode out
9360 of library archives. This improves the quality of optimization by exposing
9361 more code to the link-time optimizer.  This information specifies what
9362 symbols can be accessed externally (by non-LTO object or during dynamic
9363 linking).  Resulting code quality improvements on binaries (and shared
9364 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9365 See @option{-flto} for a description of the effect of this flag and how to
9366 use it.
9368 This option is enabled by default when LTO support in GCC is enabled
9369 and GCC was configured for use with
9370 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9372 @item -ffat-lto-objects
9373 @opindex ffat-lto-objects
9374 Fat LTO objects are object files that contain both the intermediate language
9375 and the object code. This makes them usable for both LTO linking and normal
9376 linking. This option is effective only when compiling with @option{-flto}
9377 and is ignored at link time.
9379 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9380 requires the complete toolchain to be aware of LTO. It requires a linker with
9381 linker plugin support for basic functionality.  Additionally,
9382 @command{nm}, @command{ar} and @command{ranlib}
9383 need to support linker plugins to allow a full-featured build environment
9384 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9385 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9386 to these tools. With non fat LTO makefiles need to be modified to use them.
9388 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9389 support.
9391 @item -fcompare-elim
9392 @opindex fcompare-elim
9393 After register allocation and post-register allocation instruction splitting,
9394 identify arithmetic instructions that compute processor flags similar to a
9395 comparison operation based on that arithmetic.  If possible, eliminate the
9396 explicit comparison operation.
9398 This pass only applies to certain targets that cannot explicitly represent
9399 the comparison operation before register allocation is complete.
9401 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9403 @item -fcprop-registers
9404 @opindex fcprop-registers
9405 After register allocation and post-register allocation instruction splitting,
9406 perform a copy-propagation pass to try to reduce scheduling dependencies
9407 and occasionally eliminate the copy.
9409 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9411 @item -fprofile-correction
9412 @opindex fprofile-correction
9413 Profiles collected using an instrumented binary for multi-threaded programs may
9414 be inconsistent due to missed counter updates. When this option is specified,
9415 GCC uses heuristics to correct or smooth out such inconsistencies. By
9416 default, GCC emits an error message when an inconsistent profile is detected.
9418 @item -fprofile-use
9419 @itemx -fprofile-use=@var{path}
9420 @opindex fprofile-use
9421 Enable profile feedback-directed optimizations, 
9422 and the following optimizations
9423 which are generally profitable only with profile feedback available:
9424 @option{-fbranch-probabilities}, @option{-fvpt},
9425 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9426 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9428 Before you can use this option, you must first generate profiling information.
9429 @xref{Instrumentation Options}, for information about the
9430 @option{-fprofile-generate} option.
9432 By default, GCC emits an error message if the feedback profiles do not
9433 match the source code.  This error can be turned into a warning by using
9434 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9435 code.
9437 If @var{path} is specified, GCC looks at the @var{path} to find
9438 the profile feedback data files. See @option{-fprofile-dir}.
9440 @item -fauto-profile
9441 @itemx -fauto-profile=@var{path}
9442 @opindex fauto-profile
9443 Enable sampling-based feedback-directed optimizations, 
9444 and the following optimizations
9445 which are generally profitable only with profile feedback available:
9446 @option{-fbranch-probabilities}, @option{-fvpt},
9447 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9448 @option{-ftree-vectorize},
9449 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9450 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9451 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9453 @var{path} is the name of a file containing AutoFDO profile information.
9454 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9456 Producing an AutoFDO profile data file requires running your program
9457 with the @command{perf} utility on a supported GNU/Linux target system.
9458 For more information, see @uref{https://perf.wiki.kernel.org/}.
9460 E.g.
9461 @smallexample
9462 perf record -e br_inst_retired:near_taken -b -o perf.data \
9463     -- your_program
9464 @end smallexample
9466 Then use the @command{create_gcov} tool to convert the raw profile data
9467 to a format that can be used by GCC.@  You must also supply the 
9468 unstripped binary for your program to this tool.  
9469 See @uref{https://github.com/google/autofdo}.
9471 E.g.
9472 @smallexample
9473 create_gcov --binary=your_program.unstripped --profile=perf.data \
9474     --gcov=profile.afdo
9475 @end smallexample
9476 @end table
9478 The following options control compiler behavior regarding floating-point 
9479 arithmetic.  These options trade off between speed and
9480 correctness.  All must be specifically enabled.
9482 @table @gcctabopt
9483 @item -ffloat-store
9484 @opindex ffloat-store
9485 Do not store floating-point variables in registers, and inhibit other
9486 options that might change whether a floating-point value is taken from a
9487 register or memory.
9489 @cindex floating-point precision
9490 This option prevents undesirable excess precision on machines such as
9491 the 68000 where the floating registers (of the 68881) keep more
9492 precision than a @code{double} is supposed to have.  Similarly for the
9493 x86 architecture.  For most programs, the excess precision does only
9494 good, but a few programs rely on the precise definition of IEEE floating
9495 point.  Use @option{-ffloat-store} for such programs, after modifying
9496 them to store all pertinent intermediate computations into variables.
9498 @item -fexcess-precision=@var{style}
9499 @opindex fexcess-precision
9500 This option allows further control over excess precision on machines
9501 where floating-point operations occur in a format with more precision or
9502 range than the IEEE standard and interchange floating-point types.  By
9503 default, @option{-fexcess-precision=fast} is in effect; this means that
9504 operations may be carried out in a wider precision than the types specified
9505 in the source if that would result in faster code, and it is unpredictable
9506 when rounding to the types specified in the source code takes place.
9507 When compiling C, if @option{-fexcess-precision=standard} is specified then
9508 excess precision follows the rules specified in ISO C99; in particular,
9509 both casts and assignments cause values to be rounded to their
9510 semantic types (whereas @option{-ffloat-store} only affects
9511 assignments).  This option is enabled by default for C if a strict
9512 conformance option such as @option{-std=c99} is used.
9513 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9514 regardless of whether a strict conformance option is used.
9516 @opindex mfpmath
9517 @option{-fexcess-precision=standard} is not implemented for languages
9518 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9519 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9520 semantics apply without excess precision, and in the latter, rounding
9521 is unpredictable.
9523 @item -ffast-math
9524 @opindex ffast-math
9525 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9526 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9527 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9528 @option{-fexcess-precision=fast}.
9530 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9532 This option is not turned on by any @option{-O} option besides
9533 @option{-Ofast} since it can result in incorrect output for programs
9534 that depend on an exact implementation of IEEE or ISO rules/specifications
9535 for math functions. It may, however, yield faster code for programs
9536 that do not require the guarantees of these specifications.
9538 @item -fno-math-errno
9539 @opindex fno-math-errno
9540 Do not set @code{errno} after calling math functions that are executed
9541 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9542 IEEE exceptions for math error handling may want to use this flag
9543 for speed while maintaining IEEE arithmetic compatibility.
9545 This option is not turned on by any @option{-O} option since
9546 it can result in incorrect output for programs that depend on
9547 an exact implementation of IEEE or ISO rules/specifications for
9548 math functions. It may, however, yield faster code for programs
9549 that do not require the guarantees of these specifications.
9551 The default is @option{-fmath-errno}.
9553 On Darwin systems, the math library never sets @code{errno}.  There is
9554 therefore no reason for the compiler to consider the possibility that
9555 it might, and @option{-fno-math-errno} is the default.
9557 @item -funsafe-math-optimizations
9558 @opindex funsafe-math-optimizations
9560 Allow optimizations for floating-point arithmetic that (a) assume
9561 that arguments and results are valid and (b) may violate IEEE or
9562 ANSI standards.  When used at link time, it may include libraries
9563 or startup files that change the default FPU control word or other
9564 similar optimizations.
9566 This option is not turned on by any @option{-O} option since
9567 it can result in incorrect output for programs that depend on
9568 an exact implementation of IEEE or ISO rules/specifications for
9569 math functions. It may, however, yield faster code for programs
9570 that do not require the guarantees of these specifications.
9571 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9572 @option{-fassociative-math} and @option{-freciprocal-math}.
9574 The default is @option{-fno-unsafe-math-optimizations}.
9576 @item -fassociative-math
9577 @opindex fassociative-math
9579 Allow re-association of operands in series of floating-point operations.
9580 This violates the ISO C and C++ language standard by possibly changing
9581 computation result.  NOTE: re-ordering may change the sign of zero as
9582 well as ignore NaNs and inhibit or create underflow or overflow (and
9583 thus cannot be used on code that relies on rounding behavior like
9584 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9585 and thus may not be used when ordered comparisons are required.
9586 This option requires that both @option{-fno-signed-zeros} and
9587 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9588 much sense with @option{-frounding-math}. For Fortran the option
9589 is automatically enabled when both @option{-fno-signed-zeros} and
9590 @option{-fno-trapping-math} are in effect.
9592 The default is @option{-fno-associative-math}.
9594 @item -freciprocal-math
9595 @opindex freciprocal-math
9597 Allow the reciprocal of a value to be used instead of dividing by
9598 the value if this enables optimizations.  For example @code{x / y}
9599 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9600 is subject to common subexpression elimination.  Note that this loses
9601 precision and increases the number of flops operating on the value.
9603 The default is @option{-fno-reciprocal-math}.
9605 @item -ffinite-math-only
9606 @opindex ffinite-math-only
9607 Allow optimizations for floating-point arithmetic that assume
9608 that arguments and results are not NaNs or +-Infs.
9610 This option is not turned on by any @option{-O} option since
9611 it can result in incorrect output for programs that depend on
9612 an exact implementation of IEEE or ISO rules/specifications for
9613 math functions. It may, however, yield faster code for programs
9614 that do not require the guarantees of these specifications.
9616 The default is @option{-fno-finite-math-only}.
9618 @item -fno-signed-zeros
9619 @opindex fno-signed-zeros
9620 Allow optimizations for floating-point arithmetic that ignore the
9621 signedness of zero.  IEEE arithmetic specifies the behavior of
9622 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9623 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9624 This option implies that the sign of a zero result isn't significant.
9626 The default is @option{-fsigned-zeros}.
9628 @item -fno-trapping-math
9629 @opindex fno-trapping-math
9630 Compile code assuming that floating-point operations cannot generate
9631 user-visible traps.  These traps include division by zero, overflow,
9632 underflow, inexact result and invalid operation.  This option requires
9633 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9634 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9636 This option should never be turned on by any @option{-O} option since
9637 it can result in incorrect output for programs that depend on
9638 an exact implementation of IEEE or ISO rules/specifications for
9639 math functions.
9641 The default is @option{-ftrapping-math}.
9643 @item -frounding-math
9644 @opindex frounding-math
9645 Disable transformations and optimizations that assume default floating-point
9646 rounding behavior.  This is round-to-zero for all floating point
9647 to integer conversions, and round-to-nearest for all other arithmetic
9648 truncations.  This option should be specified for programs that change
9649 the FP rounding mode dynamically, or that may be executed with a
9650 non-default rounding mode.  This option disables constant folding of
9651 floating-point expressions at compile time (which may be affected by
9652 rounding mode) and arithmetic transformations that are unsafe in the
9653 presence of sign-dependent rounding modes.
9655 The default is @option{-fno-rounding-math}.
9657 This option is experimental and does not currently guarantee to
9658 disable all GCC optimizations that are affected by rounding mode.
9659 Future versions of GCC may provide finer control of this setting
9660 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9661 will be used to specify the default state for @code{FENV_ACCESS}.
9663 @item -fsignaling-nans
9664 @opindex fsignaling-nans
9665 Compile code assuming that IEEE signaling NaNs may generate user-visible
9666 traps during floating-point operations.  Setting this option disables
9667 optimizations that may change the number of exceptions visible with
9668 signaling NaNs.  This option implies @option{-ftrapping-math}.
9670 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9671 be defined.
9673 The default is @option{-fno-signaling-nans}.
9675 This option is experimental and does not currently guarantee to
9676 disable all GCC optimizations that affect signaling NaN behavior.
9678 @item -fno-fp-int-builtin-inexact
9679 @opindex fno-fp-int-builtin-inexact
9680 Do not allow the built-in functions @code{ceil}, @code{floor},
9681 @code{round} and @code{trunc}, and their @code{float} and @code{long
9682 double} variants, to generate code that raises the ``inexact''
9683 floating-point exception for noninteger arguments.  ISO C99 and C11
9684 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9685 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9686 functions to do so.
9688 The default is @option{-ffp-int-builtin-inexact}, allowing the
9689 exception to be raised.  This option does nothing unless
9690 @option{-ftrapping-math} is in effect.
9692 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9693 generate a call to a library function then the ``inexact'' exception
9694 may be raised if the library implementation does not follow TS 18661.
9696 @item -fsingle-precision-constant
9697 @opindex fsingle-precision-constant
9698 Treat floating-point constants as single precision instead of
9699 implicitly converting them to double-precision constants.
9701 @item -fcx-limited-range
9702 @opindex fcx-limited-range
9703 When enabled, this option states that a range reduction step is not
9704 needed when performing complex division.  Also, there is no checking
9705 whether the result of a complex multiplication or division is @code{NaN
9706 + I*NaN}, with an attempt to rescue the situation in that case.  The
9707 default is @option{-fno-cx-limited-range}, but is enabled by
9708 @option{-ffast-math}.
9710 This option controls the default setting of the ISO C99
9711 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9712 all languages.
9714 @item -fcx-fortran-rules
9715 @opindex fcx-fortran-rules
9716 Complex multiplication and division follow Fortran rules.  Range
9717 reduction is done as part of complex division, but there is no checking
9718 whether the result of a complex multiplication or division is @code{NaN
9719 + I*NaN}, with an attempt to rescue the situation in that case.
9721 The default is @option{-fno-cx-fortran-rules}.
9723 @end table
9725 The following options control optimizations that may improve
9726 performance, but are not enabled by any @option{-O} options.  This
9727 section includes experimental options that may produce broken code.
9729 @table @gcctabopt
9730 @item -fbranch-probabilities
9731 @opindex fbranch-probabilities
9732 After running a program compiled with @option{-fprofile-arcs}
9733 (@pxref{Instrumentation Options}),
9734 you can compile it a second time using
9735 @option{-fbranch-probabilities}, to improve optimizations based on
9736 the number of times each branch was taken.  When a program
9737 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9738 counts to a file called @file{@var{sourcename}.gcda} for each source
9739 file.  The information in this data file is very dependent on the
9740 structure of the generated code, so you must use the same source code
9741 and the same optimization options for both compilations.
9743 With @option{-fbranch-probabilities}, GCC puts a
9744 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9745 These can be used to improve optimization.  Currently, they are only
9746 used in one place: in @file{reorg.c}, instead of guessing which path a
9747 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9748 exactly determine which path is taken more often.
9750 @item -fprofile-values
9751 @opindex fprofile-values
9752 If combined with @option{-fprofile-arcs}, it adds code so that some
9753 data about values of expressions in the program is gathered.
9755 With @option{-fbranch-probabilities}, it reads back the data gathered
9756 from profiling values of expressions for usage in optimizations.
9758 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9760 @item -fprofile-reorder-functions
9761 @opindex fprofile-reorder-functions
9762 Function reordering based on profile instrumentation collects
9763 first time of execution of a function and orders these functions
9764 in ascending order.
9766 Enabled with @option{-fprofile-use}.
9768 @item -fvpt
9769 @opindex fvpt
9770 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9771 to add code to gather information about values of expressions.
9773 With @option{-fbranch-probabilities}, it reads back the data gathered
9774 and actually performs the optimizations based on them.
9775 Currently the optimizations include specialization of division operations
9776 using the knowledge about the value of the denominator.
9778 @item -frename-registers
9779 @opindex frename-registers
9780 Attempt to avoid false dependencies in scheduled code by making use
9781 of registers left over after register allocation.  This optimization
9782 most benefits processors with lots of registers.  Depending on the
9783 debug information format adopted by the target, however, it can
9784 make debugging impossible, since variables no longer stay in
9785 a ``home register''.
9787 Enabled by default with @option{-funroll-loops}.
9789 @item -fschedule-fusion
9790 @opindex fschedule-fusion
9791 Performs a target dependent pass over the instruction stream to schedule
9792 instructions of same type together because target machine can execute them
9793 more efficiently if they are adjacent to each other in the instruction flow.
9795 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9797 @item -ftracer
9798 @opindex ftracer
9799 Perform tail duplication to enlarge superblock size.  This transformation
9800 simplifies the control flow of the function allowing other optimizations to do
9801 a better job.
9803 Enabled with @option{-fprofile-use}.
9805 @item -funroll-loops
9806 @opindex funroll-loops
9807 Unroll loops whose number of iterations can be determined at compile time or
9808 upon entry to the loop.  @option{-funroll-loops} implies
9809 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9810 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9811 a small constant number of iterations).  This option makes code larger, and may
9812 or may not make it run faster.
9814 Enabled with @option{-fprofile-use}.
9816 @item -funroll-all-loops
9817 @opindex funroll-all-loops
9818 Unroll all loops, even if their number of iterations is uncertain when
9819 the loop is entered.  This usually makes programs run more slowly.
9820 @option{-funroll-all-loops} implies the same options as
9821 @option{-funroll-loops}.
9823 @item -fpeel-loops
9824 @opindex fpeel-loops
9825 Peels loops for which there is enough information that they do not
9826 roll much (from profile feedback or static analysis).  It also turns on
9827 complete loop peeling (i.e.@: complete removal of loops with small constant
9828 number of iterations).
9830 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9832 @item -fmove-loop-invariants
9833 @opindex fmove-loop-invariants
9834 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9835 at level @option{-O1}
9837 @item -fsplit-loops
9838 @opindex fsplit-loops
9839 Split a loop into two if it contains a condition that's always true
9840 for one side of the iteration space and false for the other.
9842 @item -funswitch-loops
9843 @opindex funswitch-loops
9844 Move branches with loop invariant conditions out of the loop, with duplicates
9845 of the loop on both branches (modified according to result of the condition).
9847 @item -floop-unroll-and-jam
9848 @opindex floop-unroll-and-jam
9849 Apply unroll and jam transformations on feasible loops.  In a loop
9850 nest this unrolls the outer loop by some factor and fuses the resulting
9851 multiple inner loops.
9853 @item -ffunction-sections
9854 @itemx -fdata-sections
9855 @opindex ffunction-sections
9856 @opindex fdata-sections
9857 Place each function or data item into its own section in the output
9858 file if the target supports arbitrary sections.  The name of the
9859 function or the name of the data item determines the section's name
9860 in the output file.
9862 Use these options on systems where the linker can perform optimizations to
9863 improve locality of reference in the instruction space.  Most systems using the
9864 ELF object format have linkers with such optimizations.  On AIX, the linker
9865 rearranges sections (CSECTs) based on the call graph.  The performance impact
9866 varies.
9868 Together with a linker garbage collection (linker @option{--gc-sections}
9869 option) these options may lead to smaller statically-linked executables (after
9870 stripping).
9872 On ELF/DWARF systems these options do not degenerate the quality of the debug
9873 information.  There could be issues with other object files/debug info formats.
9875 Only use these options when there are significant benefits from doing so.  When
9876 you specify these options, the assembler and linker create larger object and
9877 executable files and are also slower.  These options affect code generation.
9878 They prevent optimizations by the compiler and assembler using relative
9879 locations inside a translation unit since the locations are unknown until
9880 link time.  An example of such an optimization is relaxing calls to short call
9881 instructions.
9883 @item -fbranch-target-load-optimize
9884 @opindex fbranch-target-load-optimize
9885 Perform branch target register load optimization before prologue / epilogue
9886 threading.
9887 The use of target registers can typically be exposed only during reload,
9888 thus hoisting loads out of loops and doing inter-block scheduling needs
9889 a separate optimization pass.
9891 @item -fbranch-target-load-optimize2
9892 @opindex fbranch-target-load-optimize2
9893 Perform branch target register load optimization after prologue / epilogue
9894 threading.
9896 @item -fbtr-bb-exclusive
9897 @opindex fbtr-bb-exclusive
9898 When performing branch target register load optimization, don't reuse
9899 branch target registers within any basic block.
9901 @item -fstdarg-opt
9902 @opindex fstdarg-opt
9903 Optimize the prologue of variadic argument functions with respect to usage of
9904 those arguments.
9906 @item -fsection-anchors
9907 @opindex fsection-anchors
9908 Try to reduce the number of symbolic address calculations by using
9909 shared ``anchor'' symbols to address nearby objects.  This transformation
9910 can help to reduce the number of GOT entries and GOT accesses on some
9911 targets.
9913 For example, the implementation of the following function @code{foo}:
9915 @smallexample
9916 static int a, b, c;
9917 int foo (void) @{ return a + b + c; @}
9918 @end smallexample
9920 @noindent
9921 usually calculates the addresses of all three variables, but if you
9922 compile it with @option{-fsection-anchors}, it accesses the variables
9923 from a common anchor point instead.  The effect is similar to the
9924 following pseudocode (which isn't valid C):
9926 @smallexample
9927 int foo (void)
9929   register int *xr = &x;
9930   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9932 @end smallexample
9934 Not all targets support this option.
9936 @item --param @var{name}=@var{value}
9937 @opindex param
9938 In some places, GCC uses various constants to control the amount of
9939 optimization that is done.  For example, GCC does not inline functions
9940 that contain more than a certain number of instructions.  You can
9941 control some of these constants on the command line using the
9942 @option{--param} option.
9944 The names of specific parameters, and the meaning of the values, are
9945 tied to the internals of the compiler, and are subject to change
9946 without notice in future releases.
9948 In each case, the @var{value} is an integer.  The allowable choices for
9949 @var{name} are:
9951 @table @gcctabopt
9952 @item predictable-branch-outcome
9953 When branch is predicted to be taken with probability lower than this threshold
9954 (in percent), then it is considered well predictable. The default is 10.
9956 @item max-rtl-if-conversion-insns
9957 RTL if-conversion tries to remove conditional branches around a block and
9958 replace them with conditionally executed instructions.  This parameter
9959 gives the maximum number of instructions in a block which should be
9960 considered for if-conversion.  The default is 10, though the compiler will
9961 also use other heuristics to decide whether if-conversion is likely to be
9962 profitable.
9964 @item max-rtl-if-conversion-predictable-cost
9965 @item max-rtl-if-conversion-unpredictable-cost
9966 RTL if-conversion will try to remove conditional branches around a block
9967 and replace them with conditionally executed instructions.  These parameters
9968 give the maximum permissible cost for the sequence that would be generated
9969 by if-conversion depending on whether the branch is statically determined
9970 to be predictable or not.  The units for this parameter are the same as
9971 those for the GCC internal seq_cost metric.  The compiler will try to
9972 provide a reasonable default for this parameter using the BRANCH_COST
9973 target macro.
9975 @item max-crossjump-edges
9976 The maximum number of incoming edges to consider for cross-jumping.
9977 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9978 the number of edges incoming to each block.  Increasing values mean
9979 more aggressive optimization, making the compilation time increase with
9980 probably small improvement in executable size.
9982 @item min-crossjump-insns
9983 The minimum number of instructions that must be matched at the end
9984 of two blocks before cross-jumping is performed on them.  This
9985 value is ignored in the case where all instructions in the block being
9986 cross-jumped from are matched.  The default value is 5.
9988 @item max-grow-copy-bb-insns
9989 The maximum code size expansion factor when copying basic blocks
9990 instead of jumping.  The expansion is relative to a jump instruction.
9991 The default value is 8.
9993 @item max-goto-duplication-insns
9994 The maximum number of instructions to duplicate to a block that jumps
9995 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9996 passes, GCC factors computed gotos early in the compilation process,
9997 and unfactors them as late as possible.  Only computed jumps at the
9998 end of a basic blocks with no more than max-goto-duplication-insns are
9999 unfactored.  The default value is 8.
10001 @item max-delay-slot-insn-search
10002 The maximum number of instructions to consider when looking for an
10003 instruction to fill a delay slot.  If more than this arbitrary number of
10004 instructions are searched, the time savings from filling the delay slot
10005 are minimal, so stop searching.  Increasing values mean more
10006 aggressive optimization, making the compilation time increase with probably
10007 small improvement in execution time.
10009 @item max-delay-slot-live-search
10010 When trying to fill delay slots, the maximum number of instructions to
10011 consider when searching for a block with valid live register
10012 information.  Increasing this arbitrarily chosen value means more
10013 aggressive optimization, increasing the compilation time.  This parameter
10014 should be removed when the delay slot code is rewritten to maintain the
10015 control-flow graph.
10017 @item max-gcse-memory
10018 The approximate maximum amount of memory that can be allocated in
10019 order to perform the global common subexpression elimination
10020 optimization.  If more memory than specified is required, the
10021 optimization is not done.
10023 @item max-gcse-insertion-ratio
10024 If the ratio of expression insertions to deletions is larger than this value
10025 for any expression, then RTL PRE inserts or removes the expression and thus
10026 leaves partially redundant computations in the instruction stream.  The default value is 20.
10028 @item max-pending-list-length
10029 The maximum number of pending dependencies scheduling allows
10030 before flushing the current state and starting over.  Large functions
10031 with few branches or calls can create excessively large lists which
10032 needlessly consume memory and resources.
10034 @item max-modulo-backtrack-attempts
10035 The maximum number of backtrack attempts the scheduler should make
10036 when modulo scheduling a loop.  Larger values can exponentially increase
10037 compilation time.
10039 @item max-inline-insns-single
10040 Several parameters control the tree inliner used in GCC@.
10041 This number sets the maximum number of instructions (counted in GCC's
10042 internal representation) in a single function that the tree inliner
10043 considers for inlining.  This only affects functions declared
10044 inline and methods implemented in a class declaration (C++).
10045 The default value is 400.
10047 @item max-inline-insns-auto
10048 When you use @option{-finline-functions} (included in @option{-O3}),
10049 a lot of functions that would otherwise not be considered for inlining
10050 by the compiler are investigated.  To those functions, a different
10051 (more restrictive) limit compared to functions declared inline can
10052 be applied.
10053 The default value is 40.
10055 @item inline-min-speedup
10056 When estimated performance improvement of caller + callee runtime exceeds this
10057 threshold (in percent), the function can be inlined regardless of the limit on
10058 @option{--param max-inline-insns-single} and @option{--param
10059 max-inline-insns-auto}.
10061 @item large-function-insns
10062 The limit specifying really large functions.  For functions larger than this
10063 limit after inlining, inlining is constrained by
10064 @option{--param large-function-growth}.  This parameter is useful primarily
10065 to avoid extreme compilation time caused by non-linear algorithms used by the
10066 back end.
10067 The default value is 2700.
10069 @item large-function-growth
10070 Specifies maximal growth of large function caused by inlining in percents.
10071 The default value is 100 which limits large function growth to 2.0 times
10072 the original size.
10074 @item large-unit-insns
10075 The limit specifying large translation unit.  Growth caused by inlining of
10076 units larger than this limit is limited by @option{--param inline-unit-growth}.
10077 For small units this might be too tight.
10078 For example, consider a unit consisting of function A
10079 that is inline and B that just calls A three times.  If B is small relative to
10080 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10081 large units consisting of small inlineable functions, however, the overall unit
10082 growth limit is needed to avoid exponential explosion of code size.  Thus for
10083 smaller units, the size is increased to @option{--param large-unit-insns}
10084 before applying @option{--param inline-unit-growth}.  The default is 10000.
10086 @item inline-unit-growth
10087 Specifies maximal overall growth of the compilation unit caused by inlining.
10088 The default value is 20 which limits unit growth to 1.2 times the original
10089 size. Cold functions (either marked cold via an attribute or by profile
10090 feedback) are not accounted into the unit size.
10092 @item ipcp-unit-growth
10093 Specifies maximal overall growth of the compilation unit caused by
10094 interprocedural constant propagation.  The default value is 10 which limits
10095 unit growth to 1.1 times the original size.
10097 @item large-stack-frame
10098 The limit specifying large stack frames.  While inlining the algorithm is trying
10099 to not grow past this limit too much.  The default value is 256 bytes.
10101 @item large-stack-frame-growth
10102 Specifies maximal growth of large stack frames caused by inlining in percents.
10103 The default value is 1000 which limits large stack frame growth to 11 times
10104 the original size.
10106 @item max-inline-insns-recursive
10107 @itemx max-inline-insns-recursive-auto
10108 Specifies the maximum number of instructions an out-of-line copy of a
10109 self-recursive inline
10110 function can grow into by performing recursive inlining.
10112 @option{--param max-inline-insns-recursive} applies to functions
10113 declared inline.
10114 For functions not declared inline, recursive inlining
10115 happens only when @option{-finline-functions} (included in @option{-O3}) is
10116 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10117 default value is 450.
10119 @item max-inline-recursive-depth
10120 @itemx max-inline-recursive-depth-auto
10121 Specifies the maximum recursion depth used for recursive inlining.
10123 @option{--param max-inline-recursive-depth} applies to functions
10124 declared inline.  For functions not declared inline, recursive inlining
10125 happens only when @option{-finline-functions} (included in @option{-O3}) is
10126 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10127 default value is 8.
10129 @item min-inline-recursive-probability
10130 Recursive inlining is profitable only for function having deep recursion
10131 in average and can hurt for function having little recursion depth by
10132 increasing the prologue size or complexity of function body to other
10133 optimizers.
10135 When profile feedback is available (see @option{-fprofile-generate}) the actual
10136 recursion depth can be guessed from the probability that function recurses
10137 via a given call expression.  This parameter limits inlining only to call
10138 expressions whose probability exceeds the given threshold (in percents).
10139 The default value is 10.
10141 @item early-inlining-insns
10142 Specify growth that the early inliner can make.  In effect it increases
10143 the amount of inlining for code having a large abstraction penalty.
10144 The default value is 14.
10146 @item max-early-inliner-iterations
10147 Limit of iterations of the early inliner.  This basically bounds
10148 the number of nested indirect calls the early inliner can resolve.
10149 Deeper chains are still handled by late inlining.
10151 @item comdat-sharing-probability
10152 Probability (in percent) that C++ inline function with comdat visibility
10153 are shared across multiple compilation units.  The default value is 20.
10155 @item profile-func-internal-id
10156 A parameter to control whether to use function internal id in profile
10157 database lookup. If the value is 0, the compiler uses an id that
10158 is based on function assembler name and filename, which makes old profile
10159 data more tolerant to source changes such as function reordering etc.
10160 The default value is 0.
10162 @item min-vect-loop-bound
10163 The minimum number of iterations under which loops are not vectorized
10164 when @option{-ftree-vectorize} is used.  The number of iterations after
10165 vectorization needs to be greater than the value specified by this option
10166 to allow vectorization.  The default value is 0.
10168 @item gcse-cost-distance-ratio
10169 Scaling factor in calculation of maximum distance an expression
10170 can be moved by GCSE optimizations.  This is currently supported only in the
10171 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10172 is with simple expressions, i.e., the expressions that have cost
10173 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10174 hoisting of simple expressions.  The default value is 10.
10176 @item gcse-unrestricted-cost
10177 Cost, roughly measured as the cost of a single typical machine
10178 instruction, at which GCSE optimizations do not constrain
10179 the distance an expression can travel.  This is currently
10180 supported only in the code hoisting pass.  The lesser the cost,
10181 the more aggressive code hoisting is.  Specifying 0 
10182 allows all expressions to travel unrestricted distances.
10183 The default value is 3.
10185 @item max-hoist-depth
10186 The depth of search in the dominator tree for expressions to hoist.
10187 This is used to avoid quadratic behavior in hoisting algorithm.
10188 The value of 0 does not limit on the search, but may slow down compilation
10189 of huge functions.  The default value is 30.
10191 @item max-tail-merge-comparisons
10192 The maximum amount of similar bbs to compare a bb with.  This is used to
10193 avoid quadratic behavior in tree tail merging.  The default value is 10.
10195 @item max-tail-merge-iterations
10196 The maximum amount of iterations of the pass over the function.  This is used to
10197 limit compilation time in tree tail merging.  The default value is 2.
10199 @item store-merging-allow-unaligned
10200 Allow the store merging pass to introduce unaligned stores if it is legal to
10201 do so.  The default value is 1.
10203 @item max-stores-to-merge
10204 The maximum number of stores to attempt to merge into wider stores in the store
10205 merging pass.  The minimum value is 2 and the default is 64.
10207 @item max-unrolled-insns
10208 The maximum number of instructions that a loop may have to be unrolled.
10209 If a loop is unrolled, this parameter also determines how many times
10210 the loop code is unrolled.
10212 @item max-average-unrolled-insns
10213 The maximum number of instructions biased by probabilities of their execution
10214 that a loop may have to be unrolled.  If a loop is unrolled,
10215 this parameter also determines how many times the loop code is unrolled.
10217 @item max-unroll-times
10218 The maximum number of unrollings of a single loop.
10220 @item max-peeled-insns
10221 The maximum number of instructions that a loop may have to be peeled.
10222 If a loop is peeled, this parameter also determines how many times
10223 the loop code is peeled.
10225 @item max-peel-times
10226 The maximum number of peelings of a single loop.
10228 @item max-peel-branches
10229 The maximum number of branches on the hot path through the peeled sequence.
10231 @item max-completely-peeled-insns
10232 The maximum number of insns of a completely peeled loop.
10234 @item max-completely-peel-times
10235 The maximum number of iterations of a loop to be suitable for complete peeling.
10237 @item max-completely-peel-loop-nest-depth
10238 The maximum depth of a loop nest suitable for complete peeling.
10240 @item max-unswitch-insns
10241 The maximum number of insns of an unswitched loop.
10243 @item max-unswitch-level
10244 The maximum number of branches unswitched in a single loop.
10246 @item max-loop-headers-insns
10247 The maximum number of insns in loop header duplicated by the copy loop headers
10248 pass.
10250 @item lim-expensive
10251 The minimum cost of an expensive expression in the loop invariant motion.
10253 @item iv-consider-all-candidates-bound
10254 Bound on number of candidates for induction variables, below which
10255 all candidates are considered for each use in induction variable
10256 optimizations.  If there are more candidates than this,
10257 only the most relevant ones are considered to avoid quadratic time complexity.
10259 @item iv-max-considered-uses
10260 The induction variable optimizations give up on loops that contain more
10261 induction variable uses.
10263 @item iv-always-prune-cand-set-bound
10264 If the number of candidates in the set is smaller than this value,
10265 always try to remove unnecessary ivs from the set
10266 when adding a new one.
10268 @item avg-loop-niter
10269 Average number of iterations of a loop.
10271 @item dse-max-object-size
10272 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10273 Larger values may result in larger compilation times.
10275 @item scev-max-expr-size
10276 Bound on size of expressions used in the scalar evolutions analyzer.
10277 Large expressions slow the analyzer.
10279 @item scev-max-expr-complexity
10280 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10281 Complex expressions slow the analyzer.
10283 @item max-tree-if-conversion-phi-args
10284 Maximum number of arguments in a PHI supported by TREE if conversion
10285 unless the loop is marked with simd pragma.
10287 @item vect-max-version-for-alignment-checks
10288 The maximum number of run-time checks that can be performed when
10289 doing loop versioning for alignment in the vectorizer.
10291 @item vect-max-version-for-alias-checks
10292 The maximum number of run-time checks that can be performed when
10293 doing loop versioning for alias in the vectorizer.
10295 @item vect-max-peeling-for-alignment
10296 The maximum number of loop peels to enhance access alignment
10297 for vectorizer. Value -1 means no limit.
10299 @item max-iterations-to-track
10300 The maximum number of iterations of a loop the brute-force algorithm
10301 for analysis of the number of iterations of the loop tries to evaluate.
10303 @item hot-bb-count-ws-permille
10304 A basic block profile count is considered hot if it contributes to 
10305 the given permillage (i.e. 0...1000) of the entire profiled execution.
10307 @item hot-bb-frequency-fraction
10308 Select fraction of the entry block frequency of executions of basic block in
10309 function given basic block needs to have to be considered hot.
10311 @item max-predicted-iterations
10312 The maximum number of loop iterations we predict statically.  This is useful
10313 in cases where a function contains a single loop with known bound and
10314 another loop with unknown bound.
10315 The known number of iterations is predicted correctly, while
10316 the unknown number of iterations average to roughly 10.  This means that the
10317 loop without bounds appears artificially cold relative to the other one.
10319 @item builtin-expect-probability
10320 Control the probability of the expression having the specified value. This
10321 parameter takes a percentage (i.e. 0 ... 100) as input.
10322 The default probability of 90 is obtained empirically.
10324 @item align-threshold
10326 Select fraction of the maximal frequency of executions of a basic block in
10327 a function to align the basic block.
10329 @item align-loop-iterations
10331 A loop expected to iterate at least the selected number of iterations is
10332 aligned.
10334 @item tracer-dynamic-coverage
10335 @itemx tracer-dynamic-coverage-feedback
10337 This value is used to limit superblock formation once the given percentage of
10338 executed instructions is covered.  This limits unnecessary code size
10339 expansion.
10341 The @option{tracer-dynamic-coverage-feedback} parameter
10342 is used only when profile
10343 feedback is available.  The real profiles (as opposed to statically estimated
10344 ones) are much less balanced allowing the threshold to be larger value.
10346 @item tracer-max-code-growth
10347 Stop tail duplication once code growth has reached given percentage.  This is
10348 a rather artificial limit, as most of the duplicates are eliminated later in
10349 cross jumping, so it may be set to much higher values than is the desired code
10350 growth.
10352 @item tracer-min-branch-ratio
10354 Stop reverse growth when the reverse probability of best edge is less than this
10355 threshold (in percent).
10357 @item tracer-min-branch-probability
10358 @itemx tracer-min-branch-probability-feedback
10360 Stop forward growth if the best edge has probability lower than this
10361 threshold.
10363 Similarly to @option{tracer-dynamic-coverage} two parameters are
10364 provided.  @option{tracer-min-branch-probability-feedback} is used for
10365 compilation with profile feedback and @option{tracer-min-branch-probability}
10366 compilation without.  The value for compilation with profile feedback
10367 needs to be more conservative (higher) in order to make tracer
10368 effective.
10370 @item stack-clash-protection-guard-size
10371 Specify the size of the operating system provided stack guard as
10372 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10373 Acceptable values are between 12 and 30.  Higher values may reduce the
10374 number of explicit probes, but a value larger than the operating system
10375 provided guard will leave code vulnerable to stack clash style attacks.
10377 @item stack-clash-protection-probe-interval
10378 Stack clash protection involves probing stack space as it is allocated.  This
10379 param controls the maximum distance between probes into the stack as 2 raised
10380 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10381 12.  Higher values may reduce the number of explicit probes, but a value
10382 larger than the operating system provided guard will leave code vulnerable to
10383 stack clash style attacks.
10385 @item max-cse-path-length
10387 The maximum number of basic blocks on path that CSE considers.
10388 The default is 10.
10390 @item max-cse-insns
10391 The maximum number of instructions CSE processes before flushing.
10392 The default is 1000.
10394 @item ggc-min-expand
10396 GCC uses a garbage collector to manage its own memory allocation.  This
10397 parameter specifies the minimum percentage by which the garbage
10398 collector's heap should be allowed to expand between collections.
10399 Tuning this may improve compilation speed; it has no effect on code
10400 generation.
10402 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10403 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10404 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10405 GCC is not able to calculate RAM on a particular platform, the lower
10406 bound of 30% is used.  Setting this parameter and
10407 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10408 every opportunity.  This is extremely slow, but can be useful for
10409 debugging.
10411 @item ggc-min-heapsize
10413 Minimum size of the garbage collector's heap before it begins bothering
10414 to collect garbage.  The first collection occurs after the heap expands
10415 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10416 tuning this may improve compilation speed, and has no effect on code
10417 generation.
10419 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10420 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10421 with a lower bound of 4096 (four megabytes) and an upper bound of
10422 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10423 particular platform, the lower bound is used.  Setting this parameter
10424 very large effectively disables garbage collection.  Setting this
10425 parameter and @option{ggc-min-expand} to zero causes a full collection
10426 to occur at every opportunity.
10428 @item max-reload-search-insns
10429 The maximum number of instruction reload should look backward for equivalent
10430 register.  Increasing values mean more aggressive optimization, making the
10431 compilation time increase with probably slightly better performance.
10432 The default value is 100.
10434 @item max-cselib-memory-locations
10435 The maximum number of memory locations cselib should take into account.
10436 Increasing values mean more aggressive optimization, making the compilation time
10437 increase with probably slightly better performance.  The default value is 500.
10439 @item max-sched-ready-insns
10440 The maximum number of instructions ready to be issued the scheduler should
10441 consider at any given time during the first scheduling pass.  Increasing
10442 values mean more thorough searches, making the compilation time increase
10443 with probably little benefit.  The default value is 100.
10445 @item max-sched-region-blocks
10446 The maximum number of blocks in a region to be considered for
10447 interblock scheduling.  The default value is 10.
10449 @item max-pipeline-region-blocks
10450 The maximum number of blocks in a region to be considered for
10451 pipelining in the selective scheduler.  The default value is 15.
10453 @item max-sched-region-insns
10454 The maximum number of insns in a region to be considered for
10455 interblock scheduling.  The default value is 100.
10457 @item max-pipeline-region-insns
10458 The maximum number of insns in a region to be considered for
10459 pipelining in the selective scheduler.  The default value is 200.
10461 @item min-spec-prob
10462 The minimum probability (in percents) of reaching a source block
10463 for interblock speculative scheduling.  The default value is 40.
10465 @item max-sched-extend-regions-iters
10466 The maximum number of iterations through CFG to extend regions.
10467 A value of 0 (the default) disables region extensions.
10469 @item max-sched-insn-conflict-delay
10470 The maximum conflict delay for an insn to be considered for speculative motion.
10471 The default value is 3.
10473 @item sched-spec-prob-cutoff
10474 The minimal probability of speculation success (in percents), so that
10475 speculative insns are scheduled.
10476 The default value is 40.
10478 @item sched-state-edge-prob-cutoff
10479 The minimum probability an edge must have for the scheduler to save its
10480 state across it.
10481 The default value is 10.
10483 @item sched-mem-true-dep-cost
10484 Minimal distance (in CPU cycles) between store and load targeting same
10485 memory locations.  The default value is 1.
10487 @item selsched-max-lookahead
10488 The maximum size of the lookahead window of selective scheduling.  It is a
10489 depth of search for available instructions.
10490 The default value is 50.
10492 @item selsched-max-sched-times
10493 The maximum number of times that an instruction is scheduled during
10494 selective scheduling.  This is the limit on the number of iterations
10495 through which the instruction may be pipelined.  The default value is 2.
10497 @item selsched-insns-to-rename
10498 The maximum number of best instructions in the ready list that are considered
10499 for renaming in the selective scheduler.  The default value is 2.
10501 @item sms-min-sc
10502 The minimum value of stage count that swing modulo scheduler
10503 generates.  The default value is 2.
10505 @item max-last-value-rtl
10506 The maximum size measured as number of RTLs that can be recorded in an expression
10507 in combiner for a pseudo register as last known value of that register.  The default
10508 is 10000.
10510 @item max-combine-insns
10511 The maximum number of instructions the RTL combiner tries to combine.
10512 The default value is 2 at @option{-Og} and 4 otherwise.
10514 @item integer-share-limit
10515 Small integer constants can use a shared data structure, reducing the
10516 compiler's memory usage and increasing its speed.  This sets the maximum
10517 value of a shared integer constant.  The default value is 256.
10519 @item ssp-buffer-size
10520 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10521 protection when @option{-fstack-protection} is used.
10523 @item min-size-for-stack-sharing
10524 The minimum size of variables taking part in stack slot sharing when not
10525 optimizing. The default value is 32.
10527 @item max-jump-thread-duplication-stmts
10528 Maximum number of statements allowed in a block that needs to be
10529 duplicated when threading jumps.
10531 @item max-fields-for-field-sensitive
10532 Maximum number of fields in a structure treated in
10533 a field sensitive manner during pointer analysis.  The default is zero
10534 for @option{-O0} and @option{-O1},
10535 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10537 @item prefetch-latency
10538 Estimate on average number of instructions that are executed before
10539 prefetch finishes.  The distance prefetched ahead is proportional
10540 to this constant.  Increasing this number may also lead to less
10541 streams being prefetched (see @option{simultaneous-prefetches}).
10543 @item simultaneous-prefetches
10544 Maximum number of prefetches that can run at the same time.
10546 @item l1-cache-line-size
10547 The size of cache line in L1 cache, in bytes.
10549 @item l1-cache-size
10550 The size of L1 cache, in kilobytes.
10552 @item l2-cache-size
10553 The size of L2 cache, in kilobytes.
10555 @item loop-interchange-max-num-stmts
10556 The maximum number of stmts in a loop to be interchanged.
10558 @item loop-interchange-stride-ratio
10559 The minimum ratio between stride of two loops for interchange to be profitable.
10561 @item min-insn-to-prefetch-ratio
10562 The minimum ratio between the number of instructions and the
10563 number of prefetches to enable prefetching in a loop.
10565 @item prefetch-min-insn-to-mem-ratio
10566 The minimum ratio between the number of instructions and the
10567 number of memory references to enable prefetching in a loop.
10569 @item use-canonical-types
10570 Whether the compiler should use the ``canonical'' type system.  By
10571 default, this should always be 1, which uses a more efficient internal
10572 mechanism for comparing types in C++ and Objective-C++.  However, if
10573 bugs in the canonical type system are causing compilation failures,
10574 set this value to 0 to disable canonical types.
10576 @item switch-conversion-max-branch-ratio
10577 Switch initialization conversion refuses to create arrays that are
10578 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10579 branches in the switch.
10581 @item max-partial-antic-length
10582 Maximum length of the partial antic set computed during the tree
10583 partial redundancy elimination optimization (@option{-ftree-pre}) when
10584 optimizing at @option{-O3} and above.  For some sorts of source code
10585 the enhanced partial redundancy elimination optimization can run away,
10586 consuming all of the memory available on the host machine.  This
10587 parameter sets a limit on the length of the sets that are computed,
10588 which prevents the runaway behavior.  Setting a value of 0 for
10589 this parameter allows an unlimited set length.
10591 @item sccvn-max-scc-size
10592 Maximum size of a strongly connected component (SCC) during SCCVN
10593 processing.  If this limit is hit, SCCVN processing for the whole
10594 function is not done and optimizations depending on it are
10595 disabled.  The default maximum SCC size is 10000.
10597 @item sccvn-max-alias-queries-per-access
10598 Maximum number of alias-oracle queries we perform when looking for
10599 redundancies for loads and stores.  If this limit is hit the search
10600 is aborted and the load or store is not considered redundant.  The
10601 number of queries is algorithmically limited to the number of
10602 stores on all paths from the load to the function entry.
10603 The default maximum number of queries is 1000.
10605 @item ira-max-loops-num
10606 IRA uses regional register allocation by default.  If a function
10607 contains more loops than the number given by this parameter, only at most
10608 the given number of the most frequently-executed loops form regions
10609 for regional register allocation.  The default value of the
10610 parameter is 100.
10612 @item ira-max-conflict-table-size 
10613 Although IRA uses a sophisticated algorithm to compress the conflict
10614 table, the table can still require excessive amounts of memory for
10615 huge functions.  If the conflict table for a function could be more
10616 than the size in MB given by this parameter, the register allocator
10617 instead uses a faster, simpler, and lower-quality
10618 algorithm that does not require building a pseudo-register conflict table.  
10619 The default value of the parameter is 2000.
10621 @item ira-loop-reserved-regs
10622 IRA can be used to evaluate more accurate register pressure in loops
10623 for decisions to move loop invariants (see @option{-O3}).  The number
10624 of available registers reserved for some other purposes is given
10625 by this parameter.  The default value of the parameter is 2, which is
10626 the minimal number of registers needed by typical instructions.
10627 This value is the best found from numerous experiments.
10629 @item lra-inheritance-ebb-probability-cutoff
10630 LRA tries to reuse values reloaded in registers in subsequent insns.
10631 This optimization is called inheritance.  EBB is used as a region to
10632 do this optimization.  The parameter defines a minimal fall-through
10633 edge probability in percentage used to add BB to inheritance EBB in
10634 LRA.  The default value of the parameter is 40.  The value was chosen
10635 from numerous runs of SPEC2000 on x86-64.
10637 @item loop-invariant-max-bbs-in-loop
10638 Loop invariant motion can be very expensive, both in compilation time and
10639 in amount of needed compile-time memory, with very large loops.  Loops
10640 with more basic blocks than this parameter won't have loop invariant
10641 motion optimization performed on them.  The default value of the
10642 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10644 @item loop-max-datarefs-for-datadeps
10645 Building data dependencies is expensive for very large loops.  This
10646 parameter limits the number of data references in loops that are
10647 considered for data dependence analysis.  These large loops are no
10648 handled by the optimizations using loop data dependencies.
10649 The default value is 1000.
10651 @item max-vartrack-size
10652 Sets a maximum number of hash table slots to use during variable
10653 tracking dataflow analysis of any function.  If this limit is exceeded
10654 with variable tracking at assignments enabled, analysis for that
10655 function is retried without it, after removing all debug insns from
10656 the function.  If the limit is exceeded even without debug insns, var
10657 tracking analysis is completely disabled for the function.  Setting
10658 the parameter to zero makes it unlimited.
10660 @item max-vartrack-expr-depth
10661 Sets a maximum number of recursion levels when attempting to map
10662 variable names or debug temporaries to value expressions.  This trades
10663 compilation time for more complete debug information.  If this is set too
10664 low, value expressions that are available and could be represented in
10665 debug information may end up not being used; setting this higher may
10666 enable the compiler to find more complex debug expressions, but compile
10667 time and memory use may grow.  The default is 12.
10669 @item max-debug-marker-count
10670 Sets a threshold on the number of debug markers (e.g. begin stmt
10671 markers) to avoid complexity explosion at inlining or expanding to RTL.
10672 If a function has more such gimple stmts than the set limit, such stmts
10673 will be dropped from the inlined copy of a function, and from its RTL
10674 expansion.  The default is 100000.
10676 @item min-nondebug-insn-uid
10677 Use uids starting at this parameter for nondebug insns.  The range below
10678 the parameter is reserved exclusively for debug insns created by
10679 @option{-fvar-tracking-assignments}, but debug insns may get
10680 (non-overlapping) uids above it if the reserved range is exhausted.
10682 @item ipa-sra-ptr-growth-factor
10683 IPA-SRA replaces a pointer to an aggregate with one or more new
10684 parameters only when their cumulative size is less or equal to
10685 @option{ipa-sra-ptr-growth-factor} times the size of the original
10686 pointer parameter.
10688 @item sra-max-scalarization-size-Ospeed
10689 @item sra-max-scalarization-size-Osize
10690 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10691 replace scalar parts of aggregates with uses of independent scalar
10692 variables.  These parameters control the maximum size, in storage units,
10693 of aggregate which is considered for replacement when compiling for
10694 speed
10695 (@option{sra-max-scalarization-size-Ospeed}) or size
10696 (@option{sra-max-scalarization-size-Osize}) respectively.
10698 @item tm-max-aggregate-size
10699 When making copies of thread-local variables in a transaction, this
10700 parameter specifies the size in bytes after which variables are
10701 saved with the logging functions as opposed to save/restore code
10702 sequence pairs.  This option only applies when using
10703 @option{-fgnu-tm}.
10705 @item graphite-max-nb-scop-params
10706 To avoid exponential effects in the Graphite loop transforms, the
10707 number of parameters in a Static Control Part (SCoP) is bounded.  The
10708 default value is 10 parameters, a value of zero can be used to lift
10709 the bound.  A variable whose value is unknown at compilation time and
10710 defined outside a SCoP is a parameter of the SCoP.
10712 @item loop-block-tile-size
10713 Loop blocking or strip mining transforms, enabled with
10714 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10715 loop in the loop nest by a given number of iterations.  The strip
10716 length can be changed using the @option{loop-block-tile-size}
10717 parameter.  The default value is 51 iterations.
10719 @item loop-unroll-jam-size
10720 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10721 default value is 4.
10723 @item loop-unroll-jam-depth
10724 Specify the dimension to be unrolled (counting from the most inner loop)
10725 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10727 @item ipa-cp-value-list-size
10728 IPA-CP attempts to track all possible values and types passed to a function's
10729 parameter in order to propagate them and perform devirtualization.
10730 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10731 stores per one formal parameter of a function.
10733 @item ipa-cp-eval-threshold
10734 IPA-CP calculates its own score of cloning profitability heuristics
10735 and performs those cloning opportunities with scores that exceed
10736 @option{ipa-cp-eval-threshold}.
10738 @item ipa-cp-recursion-penalty
10739 Percentage penalty the recursive functions will receive when they
10740 are evaluated for cloning.
10742 @item ipa-cp-single-call-penalty
10743 Percentage penalty functions containing a single call to another
10744 function will receive when they are evaluated for cloning.
10747 @item ipa-max-agg-items
10748 IPA-CP is also capable to propagate a number of scalar values passed
10749 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10750 number of such values per one parameter.
10752 @item ipa-cp-loop-hint-bonus
10753 When IPA-CP determines that a cloning candidate would make the number
10754 of iterations of a loop known, it adds a bonus of
10755 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10756 the candidate.
10758 @item ipa-cp-array-index-hint-bonus
10759 When IPA-CP determines that a cloning candidate would make the index of
10760 an array access known, it adds a bonus of
10761 @option{ipa-cp-array-index-hint-bonus} to the profitability
10762 score of the candidate.
10764 @item ipa-max-aa-steps
10765 During its analysis of function bodies, IPA-CP employs alias analysis
10766 in order to track values pointed to by function parameters.  In order
10767 not spend too much time analyzing huge functions, it gives up and
10768 consider all memory clobbered after examining
10769 @option{ipa-max-aa-steps} statements modifying memory.
10771 @item lto-partitions
10772 Specify desired number of partitions produced during WHOPR compilation.
10773 The number of partitions should exceed the number of CPUs used for compilation.
10774 The default value is 32.
10776 @item lto-min-partition
10777 Size of minimal partition for WHOPR (in estimated instructions).
10778 This prevents expenses of splitting very small programs into too many
10779 partitions.
10781 @item lto-max-partition
10782 Size of max partition for WHOPR (in estimated instructions).
10783 to provide an upper bound for individual size of partition.
10784 Meant to be used only with balanced partitioning.
10786 @item cxx-max-namespaces-for-diagnostic-help
10787 The maximum number of namespaces to consult for suggestions when C++
10788 name lookup fails for an identifier.  The default is 1000.
10790 @item sink-frequency-threshold
10791 The maximum relative execution frequency (in percents) of the target block
10792 relative to a statement's original block to allow statement sinking of a
10793 statement.  Larger numbers result in more aggressive statement sinking.
10794 The default value is 75.  A small positive adjustment is applied for
10795 statements with memory operands as those are even more profitable so sink.
10797 @item max-stores-to-sink
10798 The maximum number of conditional store pairs that can be sunk.  Set to 0
10799 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10800 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10802 @item allow-store-data-races
10803 Allow optimizers to introduce new data races on stores.
10804 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10805 at optimization level @option{-Ofast}.
10807 @item case-values-threshold
10808 The smallest number of different values for which it is best to use a
10809 jump-table instead of a tree of conditional branches.  If the value is
10810 0, use the default for the machine.  The default is 0.
10812 @item tree-reassoc-width
10813 Set the maximum number of instructions executed in parallel in
10814 reassociated tree. This parameter overrides target dependent
10815 heuristics used by default if has non zero value.
10817 @item sched-pressure-algorithm
10818 Choose between the two available implementations of
10819 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10820 and is the more likely to prevent instructions from being reordered.
10821 Algorithm 2 was designed to be a compromise between the relatively
10822 conservative approach taken by algorithm 1 and the rather aggressive
10823 approach taken by the default scheduler.  It relies more heavily on
10824 having a regular register file and accurate register pressure classes.
10825 See @file{haifa-sched.c} in the GCC sources for more details.
10827 The default choice depends on the target.
10829 @item max-slsr-cand-scan
10830 Set the maximum number of existing candidates that are considered when
10831 seeking a basis for a new straight-line strength reduction candidate.
10833 @item asan-globals
10834 Enable buffer overflow detection for global objects.  This kind
10835 of protection is enabled by default if you are using
10836 @option{-fsanitize=address} option.
10837 To disable global objects protection use @option{--param asan-globals=0}.
10839 @item asan-stack
10840 Enable buffer overflow detection for stack objects.  This kind of
10841 protection is enabled by default when using @option{-fsanitize=address}.
10842 To disable stack protection use @option{--param asan-stack=0} option.
10844 @item asan-instrument-reads
10845 Enable buffer overflow detection for memory reads.  This kind of
10846 protection is enabled by default when using @option{-fsanitize=address}.
10847 To disable memory reads protection use
10848 @option{--param asan-instrument-reads=0}.
10850 @item asan-instrument-writes
10851 Enable buffer overflow detection for memory writes.  This kind of
10852 protection is enabled by default when using @option{-fsanitize=address}.
10853 To disable memory writes protection use
10854 @option{--param asan-instrument-writes=0} option.
10856 @item asan-memintrin
10857 Enable detection for built-in functions.  This kind of protection
10858 is enabled by default when using @option{-fsanitize=address}.
10859 To disable built-in functions protection use
10860 @option{--param asan-memintrin=0}.
10862 @item asan-use-after-return
10863 Enable detection of use-after-return.  This kind of protection
10864 is enabled by default when using the @option{-fsanitize=address} option.
10865 To disable it use @option{--param asan-use-after-return=0}.
10867 Note: By default the check is disabled at run time.  To enable it,
10868 add @code{detect_stack_use_after_return=1} to the environment variable
10869 @env{ASAN_OPTIONS}.
10871 @item asan-instrumentation-with-call-threshold
10872 If number of memory accesses in function being instrumented
10873 is greater or equal to this number, use callbacks instead of inline checks.
10874 E.g. to disable inline code use
10875 @option{--param asan-instrumentation-with-call-threshold=0}.
10877 @item use-after-scope-direct-emission-threshold
10878 If the size of a local variable in bytes is smaller or equal to this
10879 number, directly poison (or unpoison) shadow memory instead of using
10880 run-time callbacks.  The default value is 256.
10882 @item chkp-max-ctor-size
10883 Static constructors generated by Pointer Bounds Checker may become very
10884 large and significantly increase compile time at optimization level
10885 @option{-O1} and higher.  This parameter is a maximum number of statements
10886 in a single generated constructor.  Default value is 5000.
10888 @item max-fsm-thread-path-insns
10889 Maximum number of instructions to copy when duplicating blocks on a
10890 finite state automaton jump thread path.  The default is 100.
10892 @item max-fsm-thread-length
10893 Maximum number of basic blocks on a finite state automaton jump thread
10894 path.  The default is 10.
10896 @item max-fsm-thread-paths
10897 Maximum number of new jump thread paths to create for a finite state
10898 automaton.  The default is 50.
10900 @item parloops-chunk-size
10901 Chunk size of omp schedule for loops parallelized by parloops.  The default
10902 is 0.
10904 @item parloops-schedule
10905 Schedule type of omp schedule for loops parallelized by parloops (static,
10906 dynamic, guided, auto, runtime).  The default is static.
10908 @item parloops-min-per-thread
10909 The minimum number of iterations per thread of an innermost parallelized
10910 loop for which the parallelized variant is prefered over the single threaded
10911 one.  The default is 100.  Note that for a parallelized loop nest the
10912 minimum number of iterations of the outermost loop per thread is two.
10914 @item max-ssa-name-query-depth
10915 Maximum depth of recursion when querying properties of SSA names in things
10916 like fold routines.  One level of recursion corresponds to following a
10917 use-def chain.
10919 @item hsa-gen-debug-stores
10920 Enable emission of special debug stores within HSA kernels which are
10921 then read and reported by libgomp plugin.  Generation of these stores
10922 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10923 enable it.
10925 @item max-speculative-devirt-maydefs
10926 The maximum number of may-defs we analyze when looking for a must-def
10927 specifying the dynamic type of an object that invokes a virtual call
10928 we may be able to devirtualize speculatively.
10930 @item max-vrp-switch-assertions
10931 The maximum number of assertions to add along the default edge of a switch
10932 statement during VRP.  The default is 10.
10934 @item unroll-jam-min-percent
10935 The minimum percentage of memory references that must be optimized
10936 away for the unroll-and-jam transformation to be considered profitable.
10938 @item unroll-jam-max-unroll
10939 The maximum number of times the outer loop should be unrolled by
10940 the unroll-and-jam transformation.
10941 @end table
10942 @end table
10944 @node Instrumentation Options
10945 @section Program Instrumentation Options
10946 @cindex instrumentation options
10947 @cindex program instrumentation options
10948 @cindex run-time error checking options
10949 @cindex profiling options
10950 @cindex options, program instrumentation
10951 @cindex options, run-time error checking
10952 @cindex options, profiling
10954 GCC supports a number of command-line options that control adding
10955 run-time instrumentation to the code it normally generates.  
10956 For example, one purpose of instrumentation is collect profiling
10957 statistics for use in finding program hot spots, code coverage
10958 analysis, or profile-guided optimizations.
10959 Another class of program instrumentation is adding run-time checking 
10960 to detect programming errors like invalid pointer
10961 dereferences or out-of-bounds array accesses, as well as deliberately
10962 hostile attacks such as stack smashing or C++ vtable hijacking.
10963 There is also a general hook which can be used to implement other
10964 forms of tracing or function-level instrumentation for debug or
10965 program analysis purposes.
10967 @table @gcctabopt
10968 @cindex @command{prof}
10969 @item -p
10970 @opindex p
10971 Generate extra code to write profile information suitable for the
10972 analysis program @command{prof}.  You must use this option when compiling
10973 the source files you want data about, and you must also use it when
10974 linking.
10976 @cindex @command{gprof}
10977 @item -pg
10978 @opindex pg
10979 Generate extra code to write profile information suitable for the
10980 analysis program @command{gprof}.  You must use this option when compiling
10981 the source files you want data about, and you must also use it when
10982 linking.
10984 @item -fprofile-arcs
10985 @opindex fprofile-arcs
10986 Add code so that program flow @dfn{arcs} are instrumented.  During
10987 execution the program records how many times each branch and call is
10988 executed and how many times it is taken or returns.  On targets that support
10989 constructors with priority support, profiling properly handles constructors,
10990 destructors and C++ constructors (and destructors) of classes which are used
10991 as a type of a global variable.
10993 When the compiled
10994 program exits it saves this data to a file called
10995 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10996 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10997 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10998 @var{auxname} is generated from the name of the output file, if
10999 explicitly specified and it is not the final executable, otherwise it is
11000 the basename of the source file.  In both cases any suffix is removed
11001 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
11002 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
11003 @xref{Cross-profiling}.
11005 @cindex @command{gcov}
11006 @item --coverage
11007 @opindex coverage
11009 This option is used to compile and link code instrumented for coverage
11010 analysis.  The option is a synonym for @option{-fprofile-arcs}
11011 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
11012 linking).  See the documentation for those options for more details.
11014 @itemize
11016 @item
11017 Compile the source files with @option{-fprofile-arcs} plus optimization
11018 and code generation options.  For test coverage analysis, use the
11019 additional @option{-ftest-coverage} option.  You do not need to profile
11020 every source file in a program.
11022 @item
11023 Compile the source files additionally with @option{-fprofile-abs-path}
11024 to create absolute path names in the @file{.gcno} files.  This allows
11025 @command{gcov} to find the correct sources in projects where compilations
11026 occur with different working directories.
11028 @item
11029 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
11030 (the latter implies the former).
11032 @item
11033 Run the program on a representative workload to generate the arc profile
11034 information.  This may be repeated any number of times.  You can run
11035 concurrent instances of your program, and provided that the file system
11036 supports locking, the data files will be correctly updated.  Unless
11037 a strict ISO C dialect option is in effect, @code{fork} calls are
11038 detected and correctly handled without double counting.
11040 @item
11041 For profile-directed optimizations, compile the source files again with
11042 the same optimization and code generation options plus
11043 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
11044 Control Optimization}).
11046 @item
11047 For test coverage analysis, use @command{gcov} to produce human readable
11048 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
11049 @command{gcov} documentation for further information.
11051 @end itemize
11053 With @option{-fprofile-arcs}, for each function of your program GCC
11054 creates a program flow graph, then finds a spanning tree for the graph.
11055 Only arcs that are not on the spanning tree have to be instrumented: the
11056 compiler adds code to count the number of times that these arcs are
11057 executed.  When an arc is the only exit or only entrance to a block, the
11058 instrumentation code can be added to the block; otherwise, a new basic
11059 block must be created to hold the instrumentation code.
11061 @need 2000
11062 @item -ftest-coverage
11063 @opindex ftest-coverage
11064 Produce a notes file that the @command{gcov} code-coverage utility
11065 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
11066 show program coverage.  Each source file's note file is called
11067 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
11068 above for a description of @var{auxname} and instructions on how to
11069 generate test coverage data.  Coverage data matches the source files
11070 more closely if you do not optimize.
11072 @item -fprofile-abs-path
11073 @opindex fprofile-abs-path
11074 Automatically convert relative source file names to absolute path names
11075 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
11076 sources in projects where compilations occur with different working
11077 directories.
11079 @item -fprofile-dir=@var{path}
11080 @opindex fprofile-dir
11082 Set the directory to search for the profile data files in to @var{path}.
11083 This option affects only the profile data generated by
11084 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
11085 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
11086 and its related options.  Both absolute and relative paths can be used.
11087 By default, GCC uses the current directory as @var{path}, thus the
11088 profile data file appears in the same directory as the object file.
11090 @item -fprofile-generate
11091 @itemx -fprofile-generate=@var{path}
11092 @opindex fprofile-generate
11094 Enable options usually used for instrumenting application to produce
11095 profile useful for later recompilation with profile feedback based
11096 optimization.  You must use @option{-fprofile-generate} both when
11097 compiling and when linking your program.
11099 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
11101 If @var{path} is specified, GCC looks at the @var{path} to find
11102 the profile feedback data files. See @option{-fprofile-dir}.
11104 To optimize the program based on the collected profile information, use
11105 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
11107 @item -fprofile-update=@var{method}
11108 @opindex fprofile-update
11110 Alter the update method for an application instrumented for profile
11111 feedback based optimization.  The @var{method} argument should be one of
11112 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
11113 The first one is useful for single-threaded applications,
11114 while the second one prevents profile corruption by emitting thread-safe code.
11116 @strong{Warning:} When an application does not properly join all threads
11117 (or creates an detached thread), a profile file can be still corrupted.
11119 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
11120 when supported by a target, or to @samp{single} otherwise.  The GCC driver
11121 automatically selects @samp{prefer-atomic} when @option{-pthread}
11122 is present in the command line.
11124 @item -fsanitize=address
11125 @opindex fsanitize=address
11126 Enable AddressSanitizer, a fast memory error detector.
11127 Memory access instructions are instrumented to detect
11128 out-of-bounds and use-after-free bugs.
11129 The option enables @option{-fsanitize-address-use-after-scope}.
11130 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
11131 more details.  The run-time behavior can be influenced using the
11132 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
11133 the available options are shown at startup of the instrumented program.  See
11134 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
11135 for a list of supported options.
11136 The option cannot be combined with @option{-fsanitize=thread}
11137 and/or @option{-fcheck-pointer-bounds}.
11139 @item -fsanitize=kernel-address
11140 @opindex fsanitize=kernel-address
11141 Enable AddressSanitizer for Linux kernel.
11142 See @uref{https://github.com/google/kasan/wiki} for more details.
11143 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11145 @item -fsanitize=pointer-compare
11146 @opindex fsanitize=pointer-compare
11147 Instrument comparison operation (<, <=, >, >=) with pointer operands.
11148 The option must be combined with either @option{-fsanitize=kernel-address} or
11149 @option{-fsanitize=address}
11150 The option cannot be combined with @option{-fsanitize=thread}
11151 and/or @option{-fcheck-pointer-bounds}.
11152 Note: By default the check is disabled at run time.  To enable it,
11153 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11154 @env{ASAN_OPTIONS}.
11156 @item -fsanitize=pointer-subtract
11157 @opindex fsanitize=pointer-subtract
11158 Instrument subtraction with pointer operands.
11159 The option must be combined with either @option{-fsanitize=kernel-address} or
11160 @option{-fsanitize=address}
11161 The option cannot be combined with @option{-fsanitize=thread}
11162 and/or @option{-fcheck-pointer-bounds}.
11163 Note: By default the check is disabled at run time.  To enable it,
11164 add @code{detect_invalid_pointer_pairs=1} to the environment variable
11165 @env{ASAN_OPTIONS}.
11167 @item -fsanitize=thread
11168 @opindex fsanitize=thread
11169 Enable ThreadSanitizer, a fast data race detector.
11170 Memory access instructions are instrumented to detect
11171 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
11172 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
11173 environment variable; see
11174 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
11175 supported options.
11176 The option cannot be combined with @option{-fsanitize=address},
11177 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
11179 Note that sanitized atomic builtins cannot throw exceptions when
11180 operating on invalid memory addresses with non-call exceptions
11181 (@option{-fnon-call-exceptions}).
11183 @item -fsanitize=leak
11184 @opindex fsanitize=leak
11185 Enable LeakSanitizer, a memory leak detector.
11186 This option only matters for linking of executables and
11187 the executable is linked against a library that overrides @code{malloc}
11188 and other allocator functions.  See
11189 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
11190 details.  The run-time behavior can be influenced using the
11191 @env{LSAN_OPTIONS} environment variable.
11192 The option cannot be combined with @option{-fsanitize=thread}.
11194 @item -fsanitize=undefined
11195 @opindex fsanitize=undefined
11196 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
11197 Various computations are instrumented to detect undefined behavior
11198 at runtime.  Current suboptions are:
11200 @table @gcctabopt
11202 @item -fsanitize=shift
11203 @opindex fsanitize=shift
11204 This option enables checking that the result of a shift operation is
11205 not undefined.  Note that what exactly is considered undefined differs
11206 slightly between C and C++, as well as between ISO C90 and C99, etc.
11207 This option has two suboptions, @option{-fsanitize=shift-base} and
11208 @option{-fsanitize=shift-exponent}.
11210 @item -fsanitize=shift-exponent
11211 @opindex fsanitize=shift-exponent
11212 This option enables checking that the second argument of a shift operation
11213 is not negative and is smaller than the precision of the promoted first
11214 argument.
11216 @item -fsanitize=shift-base
11217 @opindex fsanitize=shift-base
11218 If the second argument of a shift operation is within range, check that the
11219 result of a shift operation is not undefined.  Note that what exactly is
11220 considered undefined differs slightly between C and C++, as well as between
11221 ISO C90 and C99, etc.
11223 @item -fsanitize=integer-divide-by-zero
11224 @opindex fsanitize=integer-divide-by-zero
11225 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11227 @item -fsanitize=unreachable
11228 @opindex fsanitize=unreachable
11229 With this option, the compiler turns the @code{__builtin_unreachable}
11230 call into a diagnostics message call instead.  When reaching the
11231 @code{__builtin_unreachable} call, the behavior is undefined.
11233 @item -fsanitize=vla-bound
11234 @opindex fsanitize=vla-bound
11235 This option instructs the compiler to check that the size of a variable
11236 length array is positive.
11238 @item -fsanitize=null
11239 @opindex fsanitize=null
11240 This option enables pointer checking.  Particularly, the application
11241 built with this option turned on will issue an error message when it
11242 tries to dereference a NULL pointer, or if a reference (possibly an
11243 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11244 on an object pointed by a NULL pointer.
11246 @item -fsanitize=return
11247 @opindex fsanitize=return
11248 This option enables return statement checking.  Programs
11249 built with this option turned on will issue an error message
11250 when the end of a non-void function is reached without actually
11251 returning a value.  This option works in C++ only.
11253 @item -fsanitize=signed-integer-overflow
11254 @opindex fsanitize=signed-integer-overflow
11255 This option enables signed integer overflow checking.  We check that
11256 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11257 does not overflow in the signed arithmetics.  Note, integer promotion
11258 rules must be taken into account.  That is, the following is not an
11259 overflow:
11260 @smallexample
11261 signed char a = SCHAR_MAX;
11262 a++;
11263 @end smallexample
11265 @item -fsanitize=bounds
11266 @opindex fsanitize=bounds
11267 This option enables instrumentation of array bounds.  Various out of bounds
11268 accesses are detected.  Flexible array members, flexible array member-like
11269 arrays, and initializers of variables with static storage are not instrumented.
11270 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11272 @item -fsanitize=bounds-strict
11273 @opindex fsanitize=bounds-strict
11274 This option enables strict instrumentation of array bounds.  Most out of bounds
11275 accesses are detected, including flexible array members and flexible array
11276 member-like arrays.  Initializers of variables with static storage are not
11277 instrumented.  The option cannot be combined
11278 with @option{-fcheck-pointer-bounds}.
11280 @item -fsanitize=alignment
11281 @opindex fsanitize=alignment
11283 This option enables checking of alignment of pointers when they are
11284 dereferenced, or when a reference is bound to insufficiently aligned target,
11285 or when a method or constructor is invoked on insufficiently aligned object.
11287 @item -fsanitize=object-size
11288 @opindex fsanitize=object-size
11289 This option enables instrumentation of memory references using the
11290 @code{__builtin_object_size} function.  Various out of bounds pointer
11291 accesses are detected.
11293 @item -fsanitize=float-divide-by-zero
11294 @opindex fsanitize=float-divide-by-zero
11295 Detect floating-point division by zero.  Unlike other similar options,
11296 @option{-fsanitize=float-divide-by-zero} is not enabled by
11297 @option{-fsanitize=undefined}, since floating-point division by zero can
11298 be a legitimate way of obtaining infinities and NaNs.
11300 @item -fsanitize=float-cast-overflow
11301 @opindex fsanitize=float-cast-overflow
11302 This option enables floating-point type to integer conversion checking.
11303 We check that the result of the conversion does not overflow.
11304 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11305 not enabled by @option{-fsanitize=undefined}.
11306 This option does not work well with @code{FE_INVALID} exceptions enabled.
11308 @item -fsanitize=nonnull-attribute
11309 @opindex fsanitize=nonnull-attribute
11311 This option enables instrumentation of calls, checking whether null values
11312 are not passed to arguments marked as requiring a non-null value by the
11313 @code{nonnull} function attribute.
11315 @item -fsanitize=returns-nonnull-attribute
11316 @opindex fsanitize=returns-nonnull-attribute
11318 This option enables instrumentation of return statements in functions
11319 marked with @code{returns_nonnull} function attribute, to detect returning
11320 of null values from such functions.
11322 @item -fsanitize=bool
11323 @opindex fsanitize=bool
11325 This option enables instrumentation of loads from bool.  If a value other
11326 than 0/1 is loaded, a run-time error is issued.
11328 @item -fsanitize=enum
11329 @opindex fsanitize=enum
11331 This option enables instrumentation of loads from an enum type.  If
11332 a value outside the range of values for the enum type is loaded,
11333 a run-time error is issued.
11335 @item -fsanitize=vptr
11336 @opindex fsanitize=vptr
11338 This option enables instrumentation of C++ member function calls, member
11339 accesses and some conversions between pointers to base and derived classes,
11340 to verify the referenced object has the correct dynamic type.
11342 @item -fsanitize=pointer-overflow
11343 @opindex fsanitize=pointer-overflow
11345 This option enables instrumentation of pointer arithmetics.  If the pointer
11346 arithmetics overflows, a run-time error is issued.
11348 @item -fsanitize=builtin
11349 @opindex fsanitize=builtin
11351 This option enables instrumentation of arguments to selected builtin
11352 functions.  If an invalid value is passed to such arguments, a run-time
11353 error is issued.  E.g.@ passing 0 as the argument to @code{__builtin_ctz}
11354 or @code{__builtin_clz} invokes undefined behavior and is diagnosed
11355 by this option.
11357 @end table
11359 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11360 @option{-fsanitize=undefined} gives a diagnostic message.
11361 This currently works only for the C family of languages.
11363 @item -fno-sanitize=all
11364 @opindex fno-sanitize=all
11366 This option disables all previously enabled sanitizers.
11367 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11368 together.
11370 @item -fasan-shadow-offset=@var{number}
11371 @opindex fasan-shadow-offset
11372 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11373 It is useful for experimenting with different shadow memory layouts in
11374 Kernel AddressSanitizer.
11376 @item -fsanitize-sections=@var{s1},@var{s2},...
11377 @opindex fsanitize-sections
11378 Sanitize global variables in selected user-defined sections.  @var{si} may
11379 contain wildcards.
11381 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11382 @opindex fsanitize-recover
11383 @opindex fno-sanitize-recover
11384 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11385 mentioned in comma-separated list of @var{opts}.  Enabling this option
11386 for a sanitizer component causes it to attempt to continue
11387 running the program as if no error happened.  This means multiple
11388 runtime errors can be reported in a single program run, and the exit
11389 code of the program may indicate success even when errors
11390 have been reported.  The @option{-fno-sanitize-recover=} option
11391 can be used to alter
11392 this behavior: only the first detected error is reported
11393 and program then exits with a non-zero exit code.
11395 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11396 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11397 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11398 @option{-fsanitize=bounds-strict},
11399 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11400 For these sanitizers error recovery is turned on by default,
11401 except @option{-fsanitize=address}, for which this feature is experimental.
11402 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11403 accepted, the former enables recovery for all sanitizers that support it,
11404 the latter disables recovery for all sanitizers that support it.
11406 Even if a recovery mode is turned on the compiler side, it needs to be also
11407 enabled on the runtime library side, otherwise the failures are still fatal.
11408 The runtime library defaults to @code{halt_on_error=0} for
11409 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11410 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11411 setting the @code{halt_on_error} flag in the corresponding environment variable.
11413 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11414 equivalent to specifying an @var{opts} list of:
11416 @smallexample
11417 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11418 @end smallexample
11420 @item -fsanitize-address-use-after-scope
11421 @opindex fsanitize-address-use-after-scope
11422 Enable sanitization of local variables to detect use-after-scope bugs.
11423 The option sets @option{-fstack-reuse} to @samp{none}.
11425 @item -fsanitize-undefined-trap-on-error
11426 @opindex fsanitize-undefined-trap-on-error
11427 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11428 report undefined behavior using @code{__builtin_trap} rather than
11429 a @code{libubsan} library routine.  The advantage of this is that the
11430 @code{libubsan} library is not needed and is not linked in, so this
11431 is usable even in freestanding environments.
11433 @item -fsanitize-coverage=trace-pc
11434 @opindex fsanitize-coverage=trace-pc
11435 Enable coverage-guided fuzzing code instrumentation.
11436 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11438 @item -fsanitize-coverage=trace-cmp
11439 @opindex fsanitize-coverage=trace-cmp
11440 Enable dataflow guided fuzzing code instrumentation.
11441 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11442 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11443 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11444 variable or @code{__sanitizer_cov_trace_const_cmp1},
11445 @code{__sanitizer_cov_trace_const_cmp2},
11446 @code{__sanitizer_cov_trace_const_cmp4} or
11447 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11448 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11449 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11450 @code{__sanitizer_cov_trace_switch} for switch statements.
11452 @item -fbounds-check
11453 @opindex fbounds-check
11454 For front ends that support it, generate additional code to check that
11455 indices used to access arrays are within the declared range.  This is
11456 currently only supported by the Fortran front end, where this option
11457 defaults to false.
11459 @item -fcheck-pointer-bounds
11460 @opindex fcheck-pointer-bounds
11461 @opindex fno-check-pointer-bounds
11462 @cindex Pointer Bounds Checker options
11463 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11464 is instrumented with checks of the pointer used for memory access against
11465 bounds associated with that pointer.  
11467 Currently there
11468 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11469 and @option{-mmpx} are required to enable this feature.  
11470 MPX-based instrumentation requires
11471 a runtime library to enable MPX in hardware and handle bounds
11472 violation signals.  By default when @option{-fcheck-pointer-bounds}
11473 and @option{-mmpx} options are used to link a program, the GCC driver
11474 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11475 Bounds checking on calls to dynamic libraries requires a linker
11476 with @option{-z bndplt} support; if GCC was configured with a linker
11477 without support for this option (including the Gold linker and older
11478 versions of ld), a warning is given if you link with @option{-mmpx}
11479 without also specifying @option{-static}, since the overall effectiveness
11480 of the bounds checking protection is reduced.
11481 See also @option{-static-libmpxwrappers}.
11483 MPX-based instrumentation
11484 may be used for debugging and also may be included in production code
11485 to increase program security.  Depending on usage, you may
11486 have different requirements for the runtime library.  The current version
11487 of the MPX runtime library is more oriented for use as a debugging
11488 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11489 also @option{-static-libmpx}.  The runtime library  behavior can be
11490 influenced using various @env{CHKP_RT_*} environment variables.  See
11491 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11492 for more details.
11494 Generated instrumentation may be controlled by various
11495 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11496 structure field attribute (@pxref{Type Attributes}) and
11497 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11498 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11499 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11500 Bounds Checker builtins}, for more information.
11502 @item -fchkp-check-incomplete-type
11503 @opindex fchkp-check-incomplete-type
11504 @opindex fno-chkp-check-incomplete-type
11505 Generate pointer bounds checks for variables with incomplete type.
11506 Enabled by default.
11508 @item -fchkp-narrow-bounds
11509 @opindex fchkp-narrow-bounds
11510 @opindex fno-chkp-narrow-bounds
11511 Controls bounds used by Pointer Bounds Checker for pointers to object
11512 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11513 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11514 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11516 @item -fchkp-first-field-has-own-bounds
11517 @opindex fchkp-first-field-has-own-bounds
11518 @opindex fno-chkp-first-field-has-own-bounds
11519 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11520 first field in the structure.  By default a pointer to the first field has
11521 the same bounds as a pointer to the whole structure.
11523 @item -fchkp-flexible-struct-trailing-arrays
11524 @opindex fchkp-flexible-struct-trailing-arrays
11525 @opindex fno-chkp-flexible-struct-trailing-arrays
11526 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11527 possibly flexible.  By default only array fields with zero length or that are
11528 marked with attribute bnd_variable_size are treated as flexible.
11530 @item -fchkp-narrow-to-innermost-array
11531 @opindex fchkp-narrow-to-innermost-array
11532 @opindex fno-chkp-narrow-to-innermost-array
11533 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11534 case of nested static array access.  By default this option is disabled and
11535 bounds of the outermost array are used.
11537 @item -fchkp-optimize
11538 @opindex fchkp-optimize
11539 @opindex fno-chkp-optimize
11540 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11541 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11543 @item -fchkp-use-fast-string-functions
11544 @opindex fchkp-use-fast-string-functions
11545 @opindex fno-chkp-use-fast-string-functions
11546 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11547 by Pointer Bounds Checker.  Disabled by default.
11549 @item -fchkp-use-nochk-string-functions
11550 @opindex fchkp-use-nochk-string-functions
11551 @opindex fno-chkp-use-nochk-string-functions
11552 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11553 by Pointer Bounds Checker.  Disabled by default.
11555 @item -fchkp-use-static-bounds
11556 @opindex fchkp-use-static-bounds
11557 @opindex fno-chkp-use-static-bounds
11558 Allow Pointer Bounds Checker to generate static bounds holding
11559 bounds of static variables.  Enabled by default.
11561 @item -fchkp-use-static-const-bounds
11562 @opindex fchkp-use-static-const-bounds
11563 @opindex fno-chkp-use-static-const-bounds
11564 Use statically-initialized bounds for constant bounds instead of
11565 generating them each time they are required.  By default enabled when
11566 @option{-fchkp-use-static-bounds} is enabled.
11568 @item -fchkp-treat-zero-dynamic-size-as-infinite
11569 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11570 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11571 With this option, objects with incomplete type whose
11572 dynamically-obtained size is zero are treated as having infinite size
11573 instead by Pointer Bounds
11574 Checker.  This option may be helpful if a program is linked with a library
11575 missing size information for some symbols.  Disabled by default.
11577 @item -fchkp-check-read
11578 @opindex fchkp-check-read
11579 @opindex fno-chkp-check-read
11580 Instructs Pointer Bounds Checker to generate checks for all read
11581 accesses to memory.  Enabled by default.
11583 @item -fchkp-check-write
11584 @opindex fchkp-check-write
11585 @opindex fno-chkp-check-write
11586 Instructs Pointer Bounds Checker to generate checks for all write
11587 accesses to memory.  Enabled by default.
11589 @item -fchkp-store-bounds
11590 @opindex fchkp-store-bounds
11591 @opindex fno-chkp-store-bounds
11592 Instructs Pointer Bounds Checker to generate bounds stores for
11593 pointer writes.  Enabled by default.
11595 @item -fchkp-instrument-calls
11596 @opindex fchkp-instrument-calls
11597 @opindex fno-chkp-instrument-calls
11598 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11599 Enabled by default.
11601 @item -fchkp-instrument-marked-only
11602 @opindex fchkp-instrument-marked-only
11603 @opindex fno-chkp-instrument-marked-only
11604 Instructs Pointer Bounds Checker to instrument only functions
11605 marked with the @code{bnd_instrument} attribute
11606 (@pxref{Function Attributes}).  Disabled by default.
11608 @item -fchkp-use-wrappers
11609 @opindex fchkp-use-wrappers
11610 @opindex fno-chkp-use-wrappers
11611 Allows Pointer Bounds Checker to replace calls to built-in functions
11612 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11613 is used to link a program, the GCC driver automatically links
11614 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11615 Enabled by default.
11617 @item -fcf-protection==@r{[}full@r{|}branch@r{|}return@r{|}none@r{]}
11618 @opindex fcf-protection
11619 Enable code instrumentation of control-flow transfers to increase
11620 program security by checking that target addresses of control-flow
11621 transfer instructions (such as indirect function call, function return,
11622 indirect jump) are valid.  This prevents diverting the flow of control
11623 to an unexpected target.  This is intended to protect against such
11624 threats as Return-oriented Programming (ROP), and similarly
11625 call/jmp-oriented programming (COP/JOP).
11627 The value @code{branch} tells the compiler to implement checking of
11628 validity of control-flow transfer at the point of indirect branch
11629 instructions, i.e. call/jmp instructions.  The value @code{return}
11630 implements checking of validity at the point of returning from a
11631 function.  The value @code{full} is an alias for specifying both
11632 @code{branch} and @code{return}. The value @code{none} turns off
11633 instrumentation.
11635 You can also use the @code{nocf_check} attribute to identify
11636 which functions and calls should be skipped from instrumentation
11637 (@pxref{Function Attributes}).
11639 Currently the x86 GNU/Linux target provides an implementation based
11640 on Intel Control-flow Enforcement Technology (CET).  Instrumentation
11641 for x86 is controlled by target-specific options @option{-mcet},
11642 @option{-mibt} and @option{-mshstk} (@pxref{x86 Options}).
11644 @item -fstack-protector
11645 @opindex fstack-protector
11646 Emit extra code to check for buffer overflows, such as stack smashing
11647 attacks.  This is done by adding a guard variable to functions with
11648 vulnerable objects.  This includes functions that call @code{alloca}, and
11649 functions with buffers larger than 8 bytes.  The guards are initialized
11650 when a function is entered and then checked when the function exits.
11651 If a guard check fails, an error message is printed and the program exits.
11653 @item -fstack-protector-all
11654 @opindex fstack-protector-all
11655 Like @option{-fstack-protector} except that all functions are protected.
11657 @item -fstack-protector-strong
11658 @opindex fstack-protector-strong
11659 Like @option{-fstack-protector} but includes additional functions to
11660 be protected --- those that have local array definitions, or have
11661 references to local frame addresses.
11663 @item -fstack-protector-explicit
11664 @opindex fstack-protector-explicit
11665 Like @option{-fstack-protector} but only protects those functions which
11666 have the @code{stack_protect} attribute.
11668 @item -fstack-check
11669 @opindex fstack-check
11670 Generate code to verify that you do not go beyond the boundary of the
11671 stack.  You should specify this flag if you are running in an
11672 environment with multiple threads, but you only rarely need to specify it in
11673 a single-threaded environment since stack overflow is automatically
11674 detected on nearly all systems if there is only one stack.
11676 Note that this switch does not actually cause checking to be done; the
11677 operating system or the language runtime must do that.  The switch causes
11678 generation of code to ensure that they see the stack being extended.
11680 You can additionally specify a string parameter: @samp{no} means no
11681 checking, @samp{generic} means force the use of old-style checking,
11682 @samp{specific} means use the best checking method and is equivalent
11683 to bare @option{-fstack-check}.
11685 Old-style checking is a generic mechanism that requires no specific
11686 target support in the compiler but comes with the following drawbacks:
11688 @enumerate
11689 @item
11690 Modified allocation strategy for large objects: they are always
11691 allocated dynamically if their size exceeds a fixed threshold.  Note this
11692 may change the semantics of some code.
11694 @item
11695 Fixed limit on the size of the static frame of functions: when it is
11696 topped by a particular function, stack checking is not reliable and
11697 a warning is issued by the compiler.
11699 @item
11700 Inefficiency: because of both the modified allocation strategy and the
11701 generic implementation, code performance is hampered.
11702 @end enumerate
11704 Note that old-style stack checking is also the fallback method for
11705 @samp{specific} if no target support has been added in the compiler.
11707 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11708 and stack overflows.  @samp{specific} is an excellent choice when compiling
11709 Ada code.  It is not generally sufficient to protect against stack-clash
11710 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11712 @item -fstack-clash-protection
11713 @opindex fstack-clash-protection
11714 Generate code to prevent stack clash style attacks.  When this option is
11715 enabled, the compiler will only allocate one page of stack space at a time
11716 and each page is accessed immediately after allocation.  Thus, it prevents
11717 allocations from jumping over any stack guard page provided by the
11718 operating system.
11720 Most targets do not fully support stack clash protection.  However, on
11721 those targets @option{-fstack-clash-protection} will protect dynamic stack
11722 allocations.  @option{-fstack-clash-protection} may also provide limited
11723 protection for static stack allocations if the target supports
11724 @option{-fstack-check=specific}.
11726 @item -fstack-limit-register=@var{reg}
11727 @itemx -fstack-limit-symbol=@var{sym}
11728 @itemx -fno-stack-limit
11729 @opindex fstack-limit-register
11730 @opindex fstack-limit-symbol
11731 @opindex fno-stack-limit
11732 Generate code to ensure that the stack does not grow beyond a certain value,
11733 either the value of a register or the address of a symbol.  If a larger
11734 stack is required, a signal is raised at run time.  For most targets,
11735 the signal is raised before the stack overruns the boundary, so
11736 it is possible to catch the signal without taking special precautions.
11738 For instance, if the stack starts at absolute address @samp{0x80000000}
11739 and grows downwards, you can use the flags
11740 @option{-fstack-limit-symbol=__stack_limit} and
11741 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11742 of 128KB@.  Note that this may only work with the GNU linker.
11744 You can locally override stack limit checking by using the
11745 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11747 @item -fsplit-stack
11748 @opindex fsplit-stack
11749 Generate code to automatically split the stack before it overflows.
11750 The resulting program has a discontiguous stack which can only
11751 overflow if the program is unable to allocate any more memory.  This
11752 is most useful when running threaded programs, as it is no longer
11753 necessary to calculate a good stack size to use for each thread.  This
11754 is currently only implemented for the x86 targets running
11755 GNU/Linux.
11757 When code compiled with @option{-fsplit-stack} calls code compiled
11758 without @option{-fsplit-stack}, there may not be much stack space
11759 available for the latter code to run.  If compiling all code,
11760 including library code, with @option{-fsplit-stack} is not an option,
11761 then the linker can fix up these calls so that the code compiled
11762 without @option{-fsplit-stack} always has a large stack.  Support for
11763 this is implemented in the gold linker in GNU binutils release 2.21
11764 and later.
11766 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11767 @opindex fvtable-verify
11768 This option is only available when compiling C++ code.
11769 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11770 feature that verifies at run time, for every virtual call, that
11771 the vtable pointer through which the call is made is valid for the type of
11772 the object, and has not been corrupted or overwritten.  If an invalid vtable
11773 pointer is detected at run time, an error is reported and execution of the
11774 program is immediately halted.
11776 This option causes run-time data structures to be built at program startup,
11777 which are used for verifying the vtable pointers.  
11778 The options @samp{std} and @samp{preinit}
11779 control the timing of when these data structures are built.  In both cases the
11780 data structures are built before execution reaches @code{main}.  Using
11781 @option{-fvtable-verify=std} causes the data structures to be built after
11782 shared libraries have been loaded and initialized.
11783 @option{-fvtable-verify=preinit} causes them to be built before shared
11784 libraries have been loaded and initialized.
11786 If this option appears multiple times in the command line with different
11787 values specified, @samp{none} takes highest priority over both @samp{std} and
11788 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11790 @item -fvtv-debug
11791 @opindex fvtv-debug
11792 When used in conjunction with @option{-fvtable-verify=std} or 
11793 @option{-fvtable-verify=preinit}, causes debug versions of the 
11794 runtime functions for the vtable verification feature to be called.  
11795 This flag also causes the compiler to log information about which 
11796 vtable pointers it finds for each class.
11797 This information is written to a file named @file{vtv_set_ptr_data.log} 
11798 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11799 if that is defined or the current working directory otherwise.
11801 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11802 file, be sure to delete any existing one.
11804 @item -fvtv-counts
11805 @opindex fvtv-counts
11806 This is a debugging flag.  When used in conjunction with
11807 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11808 causes the compiler to keep track of the total number of virtual calls
11809 it encounters and the number of verifications it inserts.  It also
11810 counts the number of calls to certain run-time library functions
11811 that it inserts and logs this information for each compilation unit.
11812 The compiler writes this information to a file named
11813 @file{vtv_count_data.log} in the directory named by the environment
11814 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11815 directory otherwise.  It also counts the size of the vtable pointer sets
11816 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11817 in the same directory.
11819 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11820 files, be sure to delete any existing ones.
11822 @item -finstrument-functions
11823 @opindex finstrument-functions
11824 Generate instrumentation calls for entry and exit to functions.  Just
11825 after function entry and just before function exit, the following
11826 profiling functions are called with the address of the current
11827 function and its call site.  (On some platforms,
11828 @code{__builtin_return_address} does not work beyond the current
11829 function, so the call site information may not be available to the
11830 profiling functions otherwise.)
11832 @smallexample
11833 void __cyg_profile_func_enter (void *this_fn,
11834                                void *call_site);
11835 void __cyg_profile_func_exit  (void *this_fn,
11836                                void *call_site);
11837 @end smallexample
11839 The first argument is the address of the start of the current function,
11840 which may be looked up exactly in the symbol table.
11842 This instrumentation is also done for functions expanded inline in other
11843 functions.  The profiling calls indicate where, conceptually, the
11844 inline function is entered and exited.  This means that addressable
11845 versions of such functions must be available.  If all your uses of a
11846 function are expanded inline, this may mean an additional expansion of
11847 code size.  If you use @code{extern inline} in your C code, an
11848 addressable version of such functions must be provided.  (This is
11849 normally the case anyway, but if you get lucky and the optimizer always
11850 expands the functions inline, you might have gotten away without
11851 providing static copies.)
11853 A function may be given the attribute @code{no_instrument_function}, in
11854 which case this instrumentation is not done.  This can be used, for
11855 example, for the profiling functions listed above, high-priority
11856 interrupt routines, and any functions from which the profiling functions
11857 cannot safely be called (perhaps signal handlers, if the profiling
11858 routines generate output or allocate memory).
11860 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11861 @opindex finstrument-functions-exclude-file-list
11863 Set the list of functions that are excluded from instrumentation (see
11864 the description of @option{-finstrument-functions}).  If the file that
11865 contains a function definition matches with one of @var{file}, then
11866 that function is not instrumented.  The match is done on substrings:
11867 if the @var{file} parameter is a substring of the file name, it is
11868 considered to be a match.
11870 For example:
11872 @smallexample
11873 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11874 @end smallexample
11876 @noindent
11877 excludes any inline function defined in files whose pathnames
11878 contain @file{/bits/stl} or @file{include/sys}.
11880 If, for some reason, you want to include letter @samp{,} in one of
11881 @var{sym}, write @samp{\,}. For example,
11882 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11883 (note the single quote surrounding the option).
11885 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11886 @opindex finstrument-functions-exclude-function-list
11888 This is similar to @option{-finstrument-functions-exclude-file-list},
11889 but this option sets the list of function names to be excluded from
11890 instrumentation.  The function name to be matched is its user-visible
11891 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11892 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11893 match is done on substrings: if the @var{sym} parameter is a substring
11894 of the function name, it is considered to be a match.  For C99 and C++
11895 extended identifiers, the function name must be given in UTF-8, not
11896 using universal character names.
11898 @item -fpatchable-function-entry=@var{N}[,@var{M}]
11899 @opindex fpatchable-function-entry
11900 Generate @var{N} NOPs right at the beginning
11901 of each function, with the function entry point before the @var{M}th NOP.
11902 If @var{M} is omitted, it defaults to @code{0} so the
11903 function entry points to the address just at the first NOP.
11904 The NOP instructions reserve extra space which can be used to patch in
11905 any desired instrumentation at run time, provided that the code segment
11906 is writable.  The amount of space is controllable indirectly via
11907 the number of NOPs; the NOP instruction used corresponds to the instruction
11908 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
11909 is target-specific and may also depend on the architecture variant and/or
11910 other compilation options.
11912 For run-time identification, the starting addresses of these areas,
11913 which correspond to their respective function entries minus @var{M},
11914 are additionally collected in the @code{__patchable_function_entries}
11915 section of the resulting binary.
11917 Note that the value of @code{__attribute__ ((patchable_function_entry
11918 (N,M)))} takes precedence over command-line option
11919 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
11920 the area size or to remove it completely on a single function.
11921 If @code{N=0}, no pad location is recorded.
11923 The NOP instructions are inserted at---and maybe before, depending on
11924 @var{M}---the function entry address, even before the prologue.
11926 @end table
11929 @node Preprocessor Options
11930 @section Options Controlling the Preprocessor
11931 @cindex preprocessor options
11932 @cindex options, preprocessor
11934 These options control the C preprocessor, which is run on each C source
11935 file before actual compilation.
11937 If you use the @option{-E} option, nothing is done except preprocessing.
11938 Some of these options make sense only together with @option{-E} because
11939 they cause the preprocessor output to be unsuitable for actual
11940 compilation.
11942 In addition to the options listed here, there are a number of options 
11943 to control search paths for include files documented in 
11944 @ref{Directory Options}.  
11945 Options to control preprocessor diagnostics are listed in 
11946 @ref{Warning Options}.
11948 @table @gcctabopt
11949 @include cppopts.texi
11951 @item -Wp,@var{option}
11952 @opindex Wp
11953 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11954 and pass @var{option} directly through to the preprocessor.  If
11955 @var{option} contains commas, it is split into multiple options at the
11956 commas.  However, many options are modified, translated or interpreted
11957 by the compiler driver before being passed to the preprocessor, and
11958 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11959 interface is undocumented and subject to change, so whenever possible
11960 you should avoid using @option{-Wp} and let the driver handle the
11961 options instead.
11963 @item -Xpreprocessor @var{option}
11964 @opindex Xpreprocessor
11965 Pass @var{option} as an option to the preprocessor.  You can use this to
11966 supply system-specific preprocessor options that GCC does not 
11967 recognize.
11969 If you want to pass an option that takes an argument, you must use
11970 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11972 @item -no-integrated-cpp
11973 @opindex no-integrated-cpp
11974 Perform preprocessing as a separate pass before compilation.
11975 By default, GCC performs preprocessing as an integrated part of
11976 input tokenization and parsing.
11977 If this option is provided, the appropriate language front end
11978 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11979 and Objective-C, respectively) is instead invoked twice,
11980 once for preprocessing only and once for actual compilation
11981 of the preprocessed input.
11982 This option may be useful in conjunction with the @option{-B} or
11983 @option{-wrapper} options to specify an alternate preprocessor or
11984 perform additional processing of the program source between
11985 normal preprocessing and compilation.
11987 @end table
11989 @node Assembler Options
11990 @section Passing Options to the Assembler
11992 @c prevent bad page break with this line
11993 You can pass options to the assembler.
11995 @table @gcctabopt
11996 @item -Wa,@var{option}
11997 @opindex Wa
11998 Pass @var{option} as an option to the assembler.  If @var{option}
11999 contains commas, it is split into multiple options at the commas.
12001 @item -Xassembler @var{option}
12002 @opindex Xassembler
12003 Pass @var{option} as an option to the assembler.  You can use this to
12004 supply system-specific assembler options that GCC does not
12005 recognize.
12007 If you want to pass an option that takes an argument, you must use
12008 @option{-Xassembler} twice, once for the option and once for the argument.
12010 @end table
12012 @node Link Options
12013 @section Options for Linking
12014 @cindex link options
12015 @cindex options, linking
12017 These options come into play when the compiler links object files into
12018 an executable output file.  They are meaningless if the compiler is
12019 not doing a link step.
12021 @table @gcctabopt
12022 @cindex file names
12023 @item @var{object-file-name}
12024 A file name that does not end in a special recognized suffix is
12025 considered to name an object file or library.  (Object files are
12026 distinguished from libraries by the linker according to the file
12027 contents.)  If linking is done, these object files are used as input
12028 to the linker.
12030 @item -c
12031 @itemx -S
12032 @itemx -E
12033 @opindex c
12034 @opindex S
12035 @opindex E
12036 If any of these options is used, then the linker is not run, and
12037 object file names should not be used as arguments.  @xref{Overall
12038 Options}.
12040 @item -fuse-ld=bfd
12041 @opindex fuse-ld=bfd
12042 Use the @command{bfd} linker instead of the default linker.
12044 @item -fuse-ld=gold
12045 @opindex fuse-ld=gold
12046 Use the @command{gold} linker instead of the default linker.
12048 @cindex Libraries
12049 @item -l@var{library}
12050 @itemx -l @var{library}
12051 @opindex l
12052 Search the library named @var{library} when linking.  (The second
12053 alternative with the library as a separate argument is only for
12054 POSIX compliance and is not recommended.)
12056 It makes a difference where in the command you write this option; the
12057 linker searches and processes libraries and object files in the order they
12058 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
12059 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
12060 to functions in @samp{z}, those functions may not be loaded.
12062 The linker searches a standard list of directories for the library,
12063 which is actually a file named @file{lib@var{library}.a}.  The linker
12064 then uses this file as if it had been specified precisely by name.
12066 The directories searched include several standard system directories
12067 plus any that you specify with @option{-L}.
12069 Normally the files found this way are library files---archive files
12070 whose members are object files.  The linker handles an archive file by
12071 scanning through it for members which define symbols that have so far
12072 been referenced but not defined.  But if the file that is found is an
12073 ordinary object file, it is linked in the usual fashion.  The only
12074 difference between using an @option{-l} option and specifying a file name
12075 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
12076 and searches several directories.
12078 @item -lobjc
12079 @opindex lobjc
12080 You need this special case of the @option{-l} option in order to
12081 link an Objective-C or Objective-C++ program.
12083 @item -nostartfiles
12084 @opindex nostartfiles
12085 Do not use the standard system startup files when linking.
12086 The standard system libraries are used normally, unless @option{-nostdlib}
12087 or @option{-nodefaultlibs} is used.
12089 @item -nodefaultlibs
12090 @opindex nodefaultlibs
12091 Do not use the standard system libraries when linking.
12092 Only the libraries you specify are passed to the linker, and options
12093 specifying linkage of the system libraries, such as @option{-static-libgcc}
12094 or @option{-shared-libgcc}, are ignored.  
12095 The standard startup files are used normally, unless @option{-nostartfiles}
12096 is used.  
12098 The compiler may generate calls to @code{memcmp},
12099 @code{memset}, @code{memcpy} and @code{memmove}.
12100 These entries are usually resolved by entries in
12101 libc.  These entry points should be supplied through some other
12102 mechanism when this option is specified.
12104 @item -nostdlib
12105 @opindex nostdlib
12106 Do not use the standard system startup files or libraries when linking.
12107 No startup files and only the libraries you specify are passed to
12108 the linker, and options specifying linkage of the system libraries, such as
12109 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
12111 The compiler may generate calls to @code{memcmp}, @code{memset},
12112 @code{memcpy} and @code{memmove}.
12113 These entries are usually resolved by entries in
12114 libc.  These entry points should be supplied through some other
12115 mechanism when this option is specified.
12117 @cindex @option{-lgcc}, use with @option{-nostdlib}
12118 @cindex @option{-nostdlib} and unresolved references
12119 @cindex unresolved references and @option{-nostdlib}
12120 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
12121 @cindex @option{-nodefaultlibs} and unresolved references
12122 @cindex unresolved references and @option{-nodefaultlibs}
12123 One of the standard libraries bypassed by @option{-nostdlib} and
12124 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
12125 which GCC uses to overcome shortcomings of particular machines, or special
12126 needs for some languages.
12127 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
12128 Collection (GCC) Internals},
12129 for more discussion of @file{libgcc.a}.)
12130 In most cases, you need @file{libgcc.a} even when you want to avoid
12131 other standard libraries.  In other words, when you specify @option{-nostdlib}
12132 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
12133 This ensures that you have no unresolved references to internal GCC
12134 library subroutines.
12135 (An example of such an internal subroutine is @code{__main}, used to ensure C++
12136 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
12137 GNU Compiler Collection (GCC) Internals}.)
12139 @item -pie
12140 @opindex pie
12141 Produce a dynamically linked position independent executable on targets
12142 that support it.  For predictable results, you must also specify the same
12143 set of options used for compilation (@option{-fpie}, @option{-fPIE},
12144 or model suboptions) when you specify this linker option.
12146 @item -no-pie
12147 @opindex no-pie
12148 Don't produce a dynamically linked position independent executable.
12150 @item -static-pie
12151 @opindex static-pie
12152 Produce a static position independent executable on targets that support
12153 it.  A static position independent executable is similar to a static
12154 executable, but can be loaded at any address without a dynamic linker.
12155 For predictable results, you must also specify the same set of options
12156 used for compilation (@option{-fpie}, @option{-fPIE}, or model
12157 suboptions) when you specify this linker option.
12159 @item -pthread
12160 @opindex pthread
12161 Link with the POSIX threads library.  This option is supported on 
12162 GNU/Linux targets, most other Unix derivatives, and also on 
12163 x86 Cygwin and MinGW targets.  On some targets this option also sets 
12164 flags for the preprocessor, so it should be used consistently for both
12165 compilation and linking.
12167 @item -rdynamic
12168 @opindex rdynamic
12169 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
12170 that support it. This instructs the linker to add all symbols, not
12171 only used ones, to the dynamic symbol table. This option is needed
12172 for some uses of @code{dlopen} or to allow obtaining backtraces
12173 from within a program.
12175 @item -s
12176 @opindex s
12177 Remove all symbol table and relocation information from the executable.
12179 @item -static
12180 @opindex static
12181 On systems that support dynamic linking, this overrides @option{-pie}
12182 and prevents linking with the shared libraries.  On other systems, this
12183 option has no effect.
12185 @item -shared
12186 @opindex shared
12187 Produce a shared object which can then be linked with other objects to
12188 form an executable.  Not all systems support this option.  For predictable
12189 results, you must also specify the same set of options used for compilation
12190 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
12191 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
12192 needs to build supplementary stub code for constructors to work.  On
12193 multi-libbed systems, @samp{gcc -shared} must select the correct support
12194 libraries to link against.  Failing to supply the correct flags may lead
12195 to subtle defects.  Supplying them in cases where they are not necessary
12196 is innocuous.}
12198 @item -shared-libgcc
12199 @itemx -static-libgcc
12200 @opindex shared-libgcc
12201 @opindex static-libgcc
12202 On systems that provide @file{libgcc} as a shared library, these options
12203 force the use of either the shared or static version, respectively.
12204 If no shared version of @file{libgcc} was built when the compiler was
12205 configured, these options have no effect.
12207 There are several situations in which an application should use the
12208 shared @file{libgcc} instead of the static version.  The most common
12209 of these is when the application wishes to throw and catch exceptions
12210 across different shared libraries.  In that case, each of the libraries
12211 as well as the application itself should use the shared @file{libgcc}.
12213 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
12214  whenever you build a shared library or a main executable, because C++
12215  programs typically use exceptions, so this is the right thing to do.
12217 If, instead, you use the GCC driver to create shared libraries, you may
12218 find that they are not always linked with the shared @file{libgcc}.
12219 If GCC finds, at its configuration time, that you have a non-GNU linker
12220 or a GNU linker that does not support option @option{--eh-frame-hdr},
12221 it links the shared version of @file{libgcc} into shared libraries
12222 by default.  Otherwise, it takes advantage of the linker and optimizes
12223 away the linking with the shared version of @file{libgcc}, linking with
12224 the static version of libgcc by default.  This allows exceptions to
12225 propagate through such shared libraries, without incurring relocation
12226 costs at library load time.
12228 However, if a library or main executable is supposed to throw or catch
12229 exceptions, you must link it using the G++ driver, as appropriate
12230 for the languages used in the program, or using the option
12231 @option{-shared-libgcc}, such that it is linked with the shared
12232 @file{libgcc}.
12234 @item -static-libasan
12235 @opindex static-libasan
12236 When the @option{-fsanitize=address} option is used to link a program,
12237 the GCC driver automatically links against @option{libasan}.  If
12238 @file{libasan} is available as a shared library, and the @option{-static}
12239 option is not used, then this links against the shared version of
12240 @file{libasan}.  The @option{-static-libasan} option directs the GCC
12241 driver to link @file{libasan} statically, without necessarily linking
12242 other libraries statically.
12244 @item -static-libtsan
12245 @opindex static-libtsan
12246 When the @option{-fsanitize=thread} option is used to link a program,
12247 the GCC driver automatically links against @option{libtsan}.  If
12248 @file{libtsan} is available as a shared library, and the @option{-static}
12249 option is not used, then this links against the shared version of
12250 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
12251 driver to link @file{libtsan} statically, without necessarily linking
12252 other libraries statically.
12254 @item -static-liblsan
12255 @opindex static-liblsan
12256 When the @option{-fsanitize=leak} option is used to link a program,
12257 the GCC driver automatically links against @option{liblsan}.  If
12258 @file{liblsan} is available as a shared library, and the @option{-static}
12259 option is not used, then this links against the shared version of
12260 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12261 driver to link @file{liblsan} statically, without necessarily linking
12262 other libraries statically.
12264 @item -static-libubsan
12265 @opindex static-libubsan
12266 When the @option{-fsanitize=undefined} option is used to link a program,
12267 the GCC driver automatically links against @option{libubsan}.  If
12268 @file{libubsan} is available as a shared library, and the @option{-static}
12269 option is not used, then this links against the shared version of
12270 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12271 driver to link @file{libubsan} statically, without necessarily linking
12272 other libraries statically.
12274 @item -static-libmpx
12275 @opindex static-libmpx
12276 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12277 used to link a program, the GCC driver automatically links against
12278 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12279 and the @option{-static} option is not used, then this links against
12280 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12281 option directs the GCC driver to link @file{libmpx} statically,
12282 without necessarily linking other libraries statically.
12284 @item -static-libmpxwrappers
12285 @opindex static-libmpxwrappers
12286 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12287 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12288 GCC driver automatically links against @file{libmpxwrappers}.  If
12289 @file{libmpxwrappers} is available as a shared library, and the
12290 @option{-static} option is not used, then this links against the shared
12291 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12292 option directs the GCC driver to link @file{libmpxwrappers} statically,
12293 without necessarily linking other libraries statically.
12295 @item -static-libstdc++
12296 @opindex static-libstdc++
12297 When the @command{g++} program is used to link a C++ program, it
12298 normally automatically links against @option{libstdc++}.  If
12299 @file{libstdc++} is available as a shared library, and the
12300 @option{-static} option is not used, then this links against the
12301 shared version of @file{libstdc++}.  That is normally fine.  However, it
12302 is sometimes useful to freeze the version of @file{libstdc++} used by
12303 the program without going all the way to a fully static link.  The
12304 @option{-static-libstdc++} option directs the @command{g++} driver to
12305 link @file{libstdc++} statically, without necessarily linking other
12306 libraries statically.
12308 @item -symbolic
12309 @opindex symbolic
12310 Bind references to global symbols when building a shared object.  Warn
12311 about any unresolved references (unless overridden by the link editor
12312 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12313 this option.
12315 @item -T @var{script}
12316 @opindex T
12317 @cindex linker script
12318 Use @var{script} as the linker script.  This option is supported by most
12319 systems using the GNU linker.  On some targets, such as bare-board
12320 targets without an operating system, the @option{-T} option may be required
12321 when linking to avoid references to undefined symbols.
12323 @item -Xlinker @var{option}
12324 @opindex Xlinker
12325 Pass @var{option} as an option to the linker.  You can use this to
12326 supply system-specific linker options that GCC does not recognize.
12328 If you want to pass an option that takes a separate argument, you must use
12329 @option{-Xlinker} twice, once for the option and once for the argument.
12330 For example, to pass @option{-assert definitions}, you must write
12331 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12332 @option{-Xlinker "-assert definitions"}, because this passes the entire
12333 string as a single argument, which is not what the linker expects.
12335 When using the GNU linker, it is usually more convenient to pass
12336 arguments to linker options using the @option{@var{option}=@var{value}}
12337 syntax than as separate arguments.  For example, you can specify
12338 @option{-Xlinker -Map=output.map} rather than
12339 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12340 this syntax for command-line options.
12342 @item -Wl,@var{option}
12343 @opindex Wl
12344 Pass @var{option} as an option to the linker.  If @var{option} contains
12345 commas, it is split into multiple options at the commas.  You can use this
12346 syntax to pass an argument to the option.
12347 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12348 linker.  When using the GNU linker, you can also get the same effect with
12349 @option{-Wl,-Map=output.map}.
12351 @item -u @var{symbol}
12352 @opindex u
12353 Pretend the symbol @var{symbol} is undefined, to force linking of
12354 library modules to define it.  You can use @option{-u} multiple times with
12355 different symbols to force loading of additional library modules.
12357 @item -z @var{keyword}
12358 @opindex z
12359 @option{-z} is passed directly on to the linker along with the keyword
12360 @var{keyword}. See the section in the documentation of your linker for
12361 permitted values and their meanings.
12362 @end table
12364 @node Directory Options
12365 @section Options for Directory Search
12366 @cindex directory options
12367 @cindex options, directory search
12368 @cindex search path
12370 These options specify directories to search for header files, for
12371 libraries and for parts of the compiler:
12373 @table @gcctabopt
12374 @include cppdiropts.texi
12376 @item -iplugindir=@var{dir}
12377 @opindex iplugindir=
12378 Set the directory to search for plugins that are passed
12379 by @option{-fplugin=@var{name}} instead of
12380 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12381 to be used by the user, but only passed by the driver.
12383 @item -L@var{dir}
12384 @opindex L
12385 Add directory @var{dir} to the list of directories to be searched
12386 for @option{-l}.
12388 @item -B@var{prefix}
12389 @opindex B
12390 This option specifies where to find the executables, libraries,
12391 include files, and data files of the compiler itself.
12393 The compiler driver program runs one or more of the subprograms
12394 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12395 @var{prefix} as a prefix for each program it tries to run, both with and
12396 without @samp{@var{machine}/@var{version}/} for the corresponding target
12397 machine and compiler version.
12399 For each subprogram to be run, the compiler driver first tries the
12400 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12401 is not specified, the driver tries two standard prefixes, 
12402 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12403 those results in a file name that is found, the unmodified program
12404 name is searched for using the directories specified in your
12405 @env{PATH} environment variable.
12407 The compiler checks to see if the path provided by @option{-B}
12408 refers to a directory, and if necessary it adds a directory
12409 separator character at the end of the path.
12411 @option{-B} prefixes that effectively specify directory names also apply
12412 to libraries in the linker, because the compiler translates these
12413 options into @option{-L} options for the linker.  They also apply to
12414 include files in the preprocessor, because the compiler translates these
12415 options into @option{-isystem} options for the preprocessor.  In this case,
12416 the compiler appends @samp{include} to the prefix.
12418 The runtime support file @file{libgcc.a} can also be searched for using
12419 the @option{-B} prefix, if needed.  If it is not found there, the two
12420 standard prefixes above are tried, and that is all.  The file is left
12421 out of the link if it is not found by those means.
12423 Another way to specify a prefix much like the @option{-B} prefix is to use
12424 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12425 Variables}.
12427 As a special kludge, if the path provided by @option{-B} is
12428 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12429 9, then it is replaced by @file{[dir/]include}.  This is to help
12430 with boot-strapping the compiler.
12432 @item -no-canonical-prefixes
12433 @opindex no-canonical-prefixes
12434 Do not expand any symbolic links, resolve references to @samp{/../}
12435 or @samp{/./}, or make the path absolute when generating a relative
12436 prefix.
12438 @item --sysroot=@var{dir}
12439 @opindex sysroot
12440 Use @var{dir} as the logical root directory for headers and libraries.
12441 For example, if the compiler normally searches for headers in
12442 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12443 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12445 If you use both this option and the @option{-isysroot} option, then
12446 the @option{--sysroot} option applies to libraries, but the
12447 @option{-isysroot} option applies to header files.
12449 The GNU linker (beginning with version 2.16) has the necessary support
12450 for this option.  If your linker does not support this option, the
12451 header file aspect of @option{--sysroot} still works, but the
12452 library aspect does not.
12454 @item --no-sysroot-suffix
12455 @opindex no-sysroot-suffix
12456 For some targets, a suffix is added to the root directory specified
12457 with @option{--sysroot}, depending on the other options used, so that
12458 headers may for example be found in
12459 @file{@var{dir}/@var{suffix}/usr/include} instead of
12460 @file{@var{dir}/usr/include}.  This option disables the addition of
12461 such a suffix.
12463 @end table
12465 @node Code Gen Options
12466 @section Options for Code Generation Conventions
12467 @cindex code generation conventions
12468 @cindex options, code generation
12469 @cindex run-time options
12471 These machine-independent options control the interface conventions
12472 used in code generation.
12474 Most of them have both positive and negative forms; the negative form
12475 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12476 one of the forms is listed---the one that is not the default.  You
12477 can figure out the other form by either removing @samp{no-} or adding
12480 @table @gcctabopt
12481 @item -fstack-reuse=@var{reuse-level}
12482 @opindex fstack_reuse
12483 This option controls stack space reuse for user declared local/auto variables
12484 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12485 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12486 local variables and temporaries, @samp{named_vars} enables the reuse only for
12487 user defined local variables with names, and @samp{none} disables stack reuse
12488 completely. The default value is @samp{all}. The option is needed when the
12489 program extends the lifetime of a scoped local variable or a compiler generated
12490 temporary beyond the end point defined by the language.  When a lifetime of
12491 a variable ends, and if the variable lives in memory, the optimizing compiler
12492 has the freedom to reuse its stack space with other temporaries or scoped
12493 local variables whose live range does not overlap with it. Legacy code extending
12494 local lifetime is likely to break with the stack reuse optimization.
12496 For example,
12498 @smallexample
12499    int *p;
12500    @{
12501      int local1;
12503      p = &local1;
12504      local1 = 10;
12505      ....
12506    @}
12507    @{
12508       int local2;
12509       local2 = 20;
12510       ...
12511    @}
12513    if (*p == 10)  // out of scope use of local1
12514      @{
12516      @}
12517 @end smallexample
12519 Another example:
12520 @smallexample
12522    struct A
12523    @{
12524        A(int k) : i(k), j(k) @{ @}
12525        int i;
12526        int j;
12527    @};
12529    A *ap;
12531    void foo(const A& ar)
12532    @{
12533       ap = &ar;
12534    @}
12536    void bar()
12537    @{
12538       foo(A(10)); // temp object's lifetime ends when foo returns
12540       @{
12541         A a(20);
12542         ....
12543       @}
12544       ap->i+= 10;  // ap references out of scope temp whose space
12545                    // is reused with a. What is the value of ap->i?
12546    @}
12548 @end smallexample
12550 The lifetime of a compiler generated temporary is well defined by the C++
12551 standard. When a lifetime of a temporary ends, and if the temporary lives
12552 in memory, the optimizing compiler has the freedom to reuse its stack
12553 space with other temporaries or scoped local variables whose live range
12554 does not overlap with it. However some of the legacy code relies on
12555 the behavior of older compilers in which temporaries' stack space is
12556 not reused, the aggressive stack reuse can lead to runtime errors. This
12557 option is used to control the temporary stack reuse optimization.
12559 @item -ftrapv
12560 @opindex ftrapv
12561 This option generates traps for signed overflow on addition, subtraction,
12562 multiplication operations.
12563 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12564 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12565 @option{-fwrapv} being effective.  Note that only active options override, so
12566 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12567 results in @option{-ftrapv} being effective.
12569 @item -fwrapv
12570 @opindex fwrapv
12571 This option instructs the compiler to assume that signed arithmetic
12572 overflow of addition, subtraction and multiplication wraps around
12573 using twos-complement representation.  This flag enables some optimizations
12574 and disables others.
12575 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12576 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12577 @option{-fwrapv} being effective.  Note that only active options override, so
12578 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12579 results in @option{-ftrapv} being effective.
12581 @item -fexceptions
12582 @opindex fexceptions
12583 Enable exception handling.  Generates extra code needed to propagate
12584 exceptions.  For some targets, this implies GCC generates frame
12585 unwind information for all functions, which can produce significant data
12586 size overhead, although it does not affect execution.  If you do not
12587 specify this option, GCC enables it by default for languages like
12588 C++ that normally require exception handling, and disables it for
12589 languages like C that do not normally require it.  However, you may need
12590 to enable this option when compiling C code that needs to interoperate
12591 properly with exception handlers written in C++.  You may also wish to
12592 disable this option if you are compiling older C++ programs that don't
12593 use exception handling.
12595 @item -fnon-call-exceptions
12596 @opindex fnon-call-exceptions
12597 Generate code that allows trapping instructions to throw exceptions.
12598 Note that this requires platform-specific runtime support that does
12599 not exist everywhere.  Moreover, it only allows @emph{trapping}
12600 instructions to throw exceptions, i.e.@: memory references or floating-point
12601 instructions.  It does not allow exceptions to be thrown from
12602 arbitrary signal handlers such as @code{SIGALRM}.
12604 @item -fdelete-dead-exceptions
12605 @opindex fdelete-dead-exceptions
12606 Consider that instructions that may throw exceptions but don't otherwise
12607 contribute to the execution of the program can be optimized away.
12608 This option is enabled by default for the Ada front end, as permitted by
12609 the Ada language specification.
12610 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12612 @item -funwind-tables
12613 @opindex funwind-tables
12614 Similar to @option{-fexceptions}, except that it just generates any needed
12615 static data, but does not affect the generated code in any other way.
12616 You normally do not need to enable this option; instead, a language processor
12617 that needs this handling enables it on your behalf.
12619 @item -fasynchronous-unwind-tables
12620 @opindex fasynchronous-unwind-tables
12621 Generate unwind table in DWARF format, if supported by target machine.  The
12622 table is exact at each instruction boundary, so it can be used for stack
12623 unwinding from asynchronous events (such as debugger or garbage collector).
12625 @item -fno-gnu-unique
12626 @opindex fno-gnu-unique
12627 On systems with recent GNU assembler and C library, the C++ compiler
12628 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12629 of template static data members and static local variables in inline
12630 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12631 is necessary to avoid problems with a library used by two different
12632 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12633 therefore disagreeing with the other one about the binding of the
12634 symbol.  But this causes @code{dlclose} to be ignored for affected
12635 DSOs; if your program relies on reinitialization of a DSO via
12636 @code{dlclose} and @code{dlopen}, you can use
12637 @option{-fno-gnu-unique}.
12639 @item -fpcc-struct-return
12640 @opindex fpcc-struct-return
12641 Return ``short'' @code{struct} and @code{union} values in memory like
12642 longer ones, rather than in registers.  This convention is less
12643 efficient, but it has the advantage of allowing intercallability between
12644 GCC-compiled files and files compiled with other compilers, particularly
12645 the Portable C Compiler (pcc).
12647 The precise convention for returning structures in memory depends
12648 on the target configuration macros.
12650 Short structures and unions are those whose size and alignment match
12651 that of some integer type.
12653 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12654 switch is not binary compatible with code compiled with the
12655 @option{-freg-struct-return} switch.
12656 Use it to conform to a non-default application binary interface.
12658 @item -freg-struct-return
12659 @opindex freg-struct-return
12660 Return @code{struct} and @code{union} values in registers when possible.
12661 This is more efficient for small structures than
12662 @option{-fpcc-struct-return}.
12664 If you specify neither @option{-fpcc-struct-return} nor
12665 @option{-freg-struct-return}, GCC defaults to whichever convention is
12666 standard for the target.  If there is no standard convention, GCC
12667 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12668 the principal compiler.  In those cases, we can choose the standard, and
12669 we chose the more efficient register return alternative.
12671 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12672 switch is not binary compatible with code compiled with the
12673 @option{-fpcc-struct-return} switch.
12674 Use it to conform to a non-default application binary interface.
12676 @item -fshort-enums
12677 @opindex fshort-enums
12678 Allocate to an @code{enum} type only as many bytes as it needs for the
12679 declared range of possible values.  Specifically, the @code{enum} type
12680 is equivalent to the smallest integer type that has enough room.
12682 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12683 code that is not binary compatible with code generated without that switch.
12684 Use it to conform to a non-default application binary interface.
12686 @item -fshort-wchar
12687 @opindex fshort-wchar
12688 Override the underlying type for @code{wchar_t} to be @code{short
12689 unsigned int} instead of the default for the target.  This option is
12690 useful for building programs to run under WINE@.
12692 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12693 code that is not binary compatible with code generated without that switch.
12694 Use it to conform to a non-default application binary interface.
12696 @item -fno-common
12697 @opindex fno-common
12698 @cindex tentative definitions
12699 In C code, this option controls the placement of global variables 
12700 defined without an initializer, known as @dfn{tentative definitions} 
12701 in the C standard.  Tentative definitions are distinct from declarations 
12702 of a variable with the @code{extern} keyword, which do not allocate storage.
12704 Unix C compilers have traditionally allocated storage for
12705 uninitialized global variables in a common block.  This allows the
12706 linker to resolve all tentative definitions of the same variable
12707 in different compilation units to the same object, or to a non-tentative
12708 definition.  
12709 This is the behavior specified by @option{-fcommon}, and is the default for 
12710 GCC on most targets.  
12711 On the other hand, this behavior is not required by ISO
12712 C, and on some targets may carry a speed or code size penalty on
12713 variable references.
12715 The @option{-fno-common} option specifies that the compiler should instead
12716 place uninitialized global variables in the data section of the object file.
12717 This inhibits the merging of tentative definitions by the linker so
12718 you get a multiple-definition error if the same 
12719 variable is defined in more than one compilation unit.
12720 Compiling with @option{-fno-common} is useful on targets for which
12721 it provides better performance, or if you wish to verify that the
12722 program will work on other systems that always treat uninitialized
12723 variable definitions this way.
12725 @item -fno-ident
12726 @opindex fno-ident
12727 Ignore the @code{#ident} directive.
12729 @item -finhibit-size-directive
12730 @opindex finhibit-size-directive
12731 Don't output a @code{.size} assembler directive, or anything else that
12732 would cause trouble if the function is split in the middle, and the
12733 two halves are placed at locations far apart in memory.  This option is
12734 used when compiling @file{crtstuff.c}; you should not need to use it
12735 for anything else.
12737 @item -fverbose-asm
12738 @opindex fverbose-asm
12739 Put extra commentary information in the generated assembly code to
12740 make it more readable.  This option is generally only of use to those
12741 who actually need to read the generated assembly code (perhaps while
12742 debugging the compiler itself).
12744 @option{-fno-verbose-asm}, the default, causes the
12745 extra information to be omitted and is useful when comparing two assembler
12746 files.
12748 The added comments include:
12750 @itemize @bullet
12752 @item
12753 information on the compiler version and command-line options,
12755 @item
12756 the source code lines associated with the assembly instructions,
12757 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12759 @item
12760 hints on which high-level expressions correspond to
12761 the various assembly instruction operands.
12763 @end itemize
12765 For example, given this C source file:
12767 @smallexample
12768 int test (int n)
12770   int i;
12771   int total = 0;
12773   for (i = 0; i < n; i++)
12774     total += i * i;
12776   return total;
12778 @end smallexample
12780 compiling to (x86_64) assembly via @option{-S} and emitting the result
12781 direct to stdout via @option{-o} @option{-}
12783 @smallexample
12784 gcc -S test.c -fverbose-asm -Os -o -
12785 @end smallexample
12787 gives output similar to this:
12789 @smallexample
12790         .file   "test.c"
12791 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12792   [...snip...]
12793 # options passed:
12794   [...snip...]
12796         .text
12797         .globl  test
12798         .type   test, @@function
12799 test:
12800 .LFB0:
12801         .cfi_startproc
12802 # test.c:4:   int total = 0;
12803         xorl    %eax, %eax      # <retval>
12804 # test.c:6:   for (i = 0; i < n; i++)
12805         xorl    %edx, %edx      # i
12806 .L2:
12807 # test.c:6:   for (i = 0; i < n; i++)
12808         cmpl    %edi, %edx      # n, i
12809         jge     .L5     #,
12810 # test.c:7:     total += i * i;
12811         movl    %edx, %ecx      # i, tmp92
12812         imull   %edx, %ecx      # i, tmp92
12813 # test.c:6:   for (i = 0; i < n; i++)
12814         incl    %edx    # i
12815 # test.c:7:     total += i * i;
12816         addl    %ecx, %eax      # tmp92, <retval>
12817         jmp     .L2     #
12818 .L5:
12819 # test.c:10: @}
12820         ret
12821         .cfi_endproc
12822 .LFE0:
12823         .size   test, .-test
12824         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12825         .section        .note.GNU-stack,"",@@progbits
12826 @end smallexample
12828 The comments are intended for humans rather than machines and hence the
12829 precise format of the comments is subject to change.
12831 @item -frecord-gcc-switches
12832 @opindex frecord-gcc-switches
12833 This switch causes the command line used to invoke the
12834 compiler to be recorded into the object file that is being created.
12835 This switch is only implemented on some targets and the exact format
12836 of the recording is target and binary file format dependent, but it
12837 usually takes the form of a section containing ASCII text.  This
12838 switch is related to the @option{-fverbose-asm} switch, but that
12839 switch only records information in the assembler output file as
12840 comments, so it never reaches the object file.
12841 See also @option{-grecord-gcc-switches} for another
12842 way of storing compiler options into the object file.
12844 @item -fpic
12845 @opindex fpic
12846 @cindex global offset table
12847 @cindex PIC
12848 Generate position-independent code (PIC) suitable for use in a shared
12849 library, if supported for the target machine.  Such code accesses all
12850 constant addresses through a global offset table (GOT)@.  The dynamic
12851 loader resolves the GOT entries when the program starts (the dynamic
12852 loader is not part of GCC; it is part of the operating system).  If
12853 the GOT size for the linked executable exceeds a machine-specific
12854 maximum size, you get an error message from the linker indicating that
12855 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12856 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12857 on the m68k and RS/6000.  The x86 has no such limit.)
12859 Position-independent code requires special support, and therefore works
12860 only on certain machines.  For the x86, GCC supports PIC for System V
12861 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12862 position-independent.
12864 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12865 are defined to 1.
12867 @item -fPIC
12868 @opindex fPIC
12869 If supported for the target machine, emit position-independent code,
12870 suitable for dynamic linking and avoiding any limit on the size of the
12871 global offset table.  This option makes a difference on AArch64, m68k,
12872 PowerPC and SPARC@.
12874 Position-independent code requires special support, and therefore works
12875 only on certain machines.
12877 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12878 are defined to 2.
12880 @item -fpie
12881 @itemx -fPIE
12882 @opindex fpie
12883 @opindex fPIE
12884 These options are similar to @option{-fpic} and @option{-fPIC}, but
12885 generated position independent code can be only linked into executables.
12886 Usually these options are used when @option{-pie} GCC option is
12887 used during linking.
12889 @option{-fpie} and @option{-fPIE} both define the macros
12890 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12891 for @option{-fpie} and 2 for @option{-fPIE}.
12893 @item -fno-plt
12894 @opindex fno-plt
12895 Do not use the PLT for external function calls in position-independent code.
12896 Instead, load the callee address at call sites from the GOT and branch to it.
12897 This leads to more efficient code by eliminating PLT stubs and exposing
12898 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12899 PLT stubs expect the GOT pointer in a specific register, this gives more
12900 register allocation freedom to the compiler.
12901 Lazy binding requires use of the PLT; 
12902 with @option{-fno-plt} all external symbols are resolved at load time.
12904 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12905 through the PLT for specific external functions.
12907 In position-dependent code, a few targets also convert calls to
12908 functions that are marked to not use the PLT to use the GOT instead.
12910 @item -fno-jump-tables
12911 @opindex fno-jump-tables
12912 Do not use jump tables for switch statements even where it would be
12913 more efficient than other code generation strategies.  This option is
12914 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12915 building code that forms part of a dynamic linker and cannot
12916 reference the address of a jump table.  On some targets, jump tables
12917 do not require a GOT and this option is not needed.
12919 @item -ffixed-@var{reg}
12920 @opindex ffixed
12921 Treat the register named @var{reg} as a fixed register; generated code
12922 should never refer to it (except perhaps as a stack pointer, frame
12923 pointer or in some other fixed role).
12925 @var{reg} must be the name of a register.  The register names accepted
12926 are machine-specific and are defined in the @code{REGISTER_NAMES}
12927 macro in the machine description macro file.
12929 This flag does not have a negative form, because it specifies a
12930 three-way choice.
12932 @item -fcall-used-@var{reg}
12933 @opindex fcall-used
12934 Treat the register named @var{reg} as an allocable register that is
12935 clobbered by function calls.  It may be allocated for temporaries or
12936 variables that do not live across a call.  Functions compiled this way
12937 do not save and restore the register @var{reg}.
12939 It is an error to use this flag with the frame pointer or stack pointer.
12940 Use of this flag for other registers that have fixed pervasive roles in
12941 the machine's execution model produces disastrous results.
12943 This flag does not have a negative form, because it specifies a
12944 three-way choice.
12946 @item -fcall-saved-@var{reg}
12947 @opindex fcall-saved
12948 Treat the register named @var{reg} as an allocable register saved by
12949 functions.  It may be allocated even for temporaries or variables that
12950 live across a call.  Functions compiled this way save and restore
12951 the register @var{reg} if they use it.
12953 It is an error to use this flag with the frame pointer or stack pointer.
12954 Use of this flag for other registers that have fixed pervasive roles in
12955 the machine's execution model produces disastrous results.
12957 A different sort of disaster results from the use of this flag for
12958 a register in which function values may be returned.
12960 This flag does not have a negative form, because it specifies a
12961 three-way choice.
12963 @item -fpack-struct[=@var{n}]
12964 @opindex fpack-struct
12965 Without a value specified, pack all structure members together without
12966 holes.  When a value is specified (which must be a small power of two), pack
12967 structure members according to this value, representing the maximum
12968 alignment (that is, objects with default alignment requirements larger than
12969 this are output potentially unaligned at the next fitting location.
12971 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12972 code that is not binary compatible with code generated without that switch.
12973 Additionally, it makes the code suboptimal.
12974 Use it to conform to a non-default application binary interface.
12976 @item -fleading-underscore
12977 @opindex fleading-underscore
12978 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12979 change the way C symbols are represented in the object file.  One use
12980 is to help link with legacy assembly code.
12982 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12983 generate code that is not binary compatible with code generated without that
12984 switch.  Use it to conform to a non-default application binary interface.
12985 Not all targets provide complete support for this switch.
12987 @item -ftls-model=@var{model}
12988 @opindex ftls-model
12989 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12990 The @var{model} argument should be one of @samp{global-dynamic},
12991 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12992 Note that the choice is subject to optimization: the compiler may use
12993 a more efficient model for symbols not visible outside of the translation
12994 unit, or if @option{-fpic} is not given on the command line.
12996 The default without @option{-fpic} is @samp{initial-exec}; with
12997 @option{-fpic} the default is @samp{global-dynamic}.
12999 @item -ftrampolines
13000 @opindex ftrampolines
13001 For targets that normally need trampolines for nested functions, always
13002 generate them instead of using descriptors.  Otherwise, for targets that
13003 do not need them, like for example HP-PA or IA-64, do nothing.
13005 A trampoline is a small piece of code that is created at run time on the
13006 stack when the address of a nested function is taken, and is used to call
13007 the nested function indirectly.  Therefore, it requires the stack to be
13008 made executable in order for the program to work properly.
13010 @option{-fno-trampolines} is enabled by default on a language by language
13011 basis to let the compiler avoid generating them, if it computes that this
13012 is safe, and replace them with descriptors.  Descriptors are made up of data
13013 only, but the generated code must be prepared to deal with them.  As of this
13014 writing, @option{-fno-trampolines} is enabled by default only for Ada.
13016 Moreover, code compiled with @option{-ftrampolines} and code compiled with
13017 @option{-fno-trampolines} are not binary compatible if nested functions are
13018 present.  This option must therefore be used on a program-wide basis and be
13019 manipulated with extreme care.
13021 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
13022 @opindex fvisibility
13023 Set the default ELF image symbol visibility to the specified option---all
13024 symbols are marked with this unless overridden within the code.
13025 Using this feature can very substantially improve linking and
13026 load times of shared object libraries, produce more optimized
13027 code, provide near-perfect API export and prevent symbol clashes.
13028 It is @strong{strongly} recommended that you use this in any shared objects
13029 you distribute.
13031 Despite the nomenclature, @samp{default} always means public; i.e.,
13032 available to be linked against from outside the shared object.
13033 @samp{protected} and @samp{internal} are pretty useless in real-world
13034 usage so the only other commonly used option is @samp{hidden}.
13035 The default if @option{-fvisibility} isn't specified is
13036 @samp{default}, i.e., make every symbol public.
13038 A good explanation of the benefits offered by ensuring ELF
13039 symbols have the correct visibility is given by ``How To Write
13040 Shared Libraries'' by Ulrich Drepper (which can be found at
13041 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
13042 solution made possible by this option to marking things hidden when
13043 the default is public is to make the default hidden and mark things
13044 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
13045 and @code{__attribute__ ((visibility("default")))} instead of
13046 @code{__declspec(dllexport)} you get almost identical semantics with
13047 identical syntax.  This is a great boon to those working with
13048 cross-platform projects.
13050 For those adding visibility support to existing code, you may find
13051 @code{#pragma GCC visibility} of use.  This works by you enclosing
13052 the declarations you wish to set visibility for with (for example)
13053 @code{#pragma GCC visibility push(hidden)} and
13054 @code{#pragma GCC visibility pop}.
13055 Bear in mind that symbol visibility should be viewed @strong{as
13056 part of the API interface contract} and thus all new code should
13057 always specify visibility when it is not the default; i.e., declarations
13058 only for use within the local DSO should @strong{always} be marked explicitly
13059 as hidden as so to avoid PLT indirection overheads---making this
13060 abundantly clear also aids readability and self-documentation of the code.
13061 Note that due to ISO C++ specification requirements, @code{operator new} and
13062 @code{operator delete} must always be of default visibility.
13064 Be aware that headers from outside your project, in particular system
13065 headers and headers from any other library you use, may not be
13066 expecting to be compiled with visibility other than the default.  You
13067 may need to explicitly say @code{#pragma GCC visibility push(default)}
13068 before including any such headers.
13070 @code{extern} declarations are not affected by @option{-fvisibility}, so
13071 a lot of code can be recompiled with @option{-fvisibility=hidden} with
13072 no modifications.  However, this means that calls to @code{extern}
13073 functions with no explicit visibility use the PLT, so it is more
13074 effective to use @code{__attribute ((visibility))} and/or
13075 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
13076 declarations should be treated as hidden.
13078 Note that @option{-fvisibility} does affect C++ vague linkage
13079 entities. This means that, for instance, an exception class that is
13080 be thrown between DSOs must be explicitly marked with default
13081 visibility so that the @samp{type_info} nodes are unified between
13082 the DSOs.
13084 An overview of these techniques, their benefits and how to use them
13085 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
13087 @item -fstrict-volatile-bitfields
13088 @opindex fstrict-volatile-bitfields
13089 This option should be used if accesses to volatile bit-fields (or other
13090 structure fields, although the compiler usually honors those types
13091 anyway) should use a single access of the width of the
13092 field's type, aligned to a natural alignment if possible.  For
13093 example, targets with memory-mapped peripheral registers might require
13094 all such accesses to be 16 bits wide; with this flag you can
13095 declare all peripheral bit-fields as @code{unsigned short} (assuming short
13096 is 16 bits on these targets) to force GCC to use 16-bit accesses
13097 instead of, perhaps, a more efficient 32-bit access.
13099 If this option is disabled, the compiler uses the most efficient
13100 instruction.  In the previous example, that might be a 32-bit load
13101 instruction, even though that accesses bytes that do not contain
13102 any portion of the bit-field, or memory-mapped registers unrelated to
13103 the one being updated.
13105 In some cases, such as when the @code{packed} attribute is applied to a 
13106 structure field, it may not be possible to access the field with a single
13107 read or write that is correctly aligned for the target machine.  In this
13108 case GCC falls back to generating multiple accesses rather than code that 
13109 will fault or truncate the result at run time.
13111 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
13112 not allowed to touch non bit-field members.  It is therefore recommended
13113 to define all bits of the field's type as bit-field members.
13115 The default value of this option is determined by the application binary
13116 interface for the target processor.
13118 @item -fsync-libcalls
13119 @opindex fsync-libcalls
13120 This option controls whether any out-of-line instance of the @code{__sync}
13121 family of functions may be used to implement the C++11 @code{__atomic}
13122 family of functions.
13124 The default value of this option is enabled, thus the only useful form
13125 of the option is @option{-fno-sync-libcalls}.  This option is used in
13126 the implementation of the @file{libatomic} runtime library.
13128 @end table
13130 @node Developer Options
13131 @section GCC Developer Options
13132 @cindex developer options
13133 @cindex debugging GCC
13134 @cindex debug dump options
13135 @cindex dump options
13136 @cindex compilation statistics
13138 This section describes command-line options that are primarily of
13139 interest to GCC developers, including options to support compiler
13140 testing and investigation of compiler bugs and compile-time
13141 performance problems.  This includes options that produce debug dumps
13142 at various points in the compilation; that print statistics such as
13143 memory use and execution time; and that print information about GCC's
13144 configuration, such as where it searches for libraries.  You should
13145 rarely need to use any of these options for ordinary compilation and
13146 linking tasks.
13148 @table @gcctabopt
13150 @item -d@var{letters}
13151 @itemx -fdump-rtl-@var{pass}
13152 @itemx -fdump-rtl-@var{pass}=@var{filename}
13153 @opindex d
13154 @opindex fdump-rtl-@var{pass}
13155 Says to make debugging dumps during compilation at times specified by
13156 @var{letters}.  This is used for debugging the RTL-based passes of the
13157 compiler.  The file names for most of the dumps are made by appending
13158 a pass number and a word to the @var{dumpname}, and the files are
13159 created in the directory of the output file.  In case of
13160 @option{=@var{filename}} option, the dump is output on the given file
13161 instead of the pass numbered dump files.  Note that the pass number is
13162 assigned as passes are registered into the pass manager.  Most passes
13163 are registered in the order that they will execute and for these passes
13164 the number corresponds to the pass execution order.  However, passes
13165 registered by plugins, passes specific to compilation targets, or
13166 passes that are otherwise registered after all the other passes are
13167 numbered higher than a pass named "final", even if they are executed
13168 earlier.  @var{dumpname} is generated from the name of the output
13169 file if explicitly specified and not an executable, otherwise it is
13170 the basename of the source file.  
13172 Some @option{-d@var{letters}} switches have different meaning when
13173 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
13174 for information about preprocessor-specific dump options.
13176 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
13177 @option{-d} option @var{letters}.  Here are the possible
13178 letters for use in @var{pass} and @var{letters}, and their meanings:
13180 @table @gcctabopt
13182 @item -fdump-rtl-alignments
13183 @opindex fdump-rtl-alignments
13184 Dump after branch alignments have been computed.
13186 @item -fdump-rtl-asmcons
13187 @opindex fdump-rtl-asmcons
13188 Dump after fixing rtl statements that have unsatisfied in/out constraints.
13190 @item -fdump-rtl-auto_inc_dec
13191 @opindex fdump-rtl-auto_inc_dec
13192 Dump after auto-inc-dec discovery.  This pass is only run on
13193 architectures that have auto inc or auto dec instructions.
13195 @item -fdump-rtl-barriers
13196 @opindex fdump-rtl-barriers
13197 Dump after cleaning up the barrier instructions.
13199 @item -fdump-rtl-bbpart
13200 @opindex fdump-rtl-bbpart
13201 Dump after partitioning hot and cold basic blocks.
13203 @item -fdump-rtl-bbro
13204 @opindex fdump-rtl-bbro
13205 Dump after block reordering.
13207 @item -fdump-rtl-btl1
13208 @itemx -fdump-rtl-btl2
13209 @opindex fdump-rtl-btl2
13210 @opindex fdump-rtl-btl2
13211 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
13212 after the two branch
13213 target load optimization passes.
13215 @item -fdump-rtl-bypass
13216 @opindex fdump-rtl-bypass
13217 Dump after jump bypassing and control flow optimizations.
13219 @item -fdump-rtl-combine
13220 @opindex fdump-rtl-combine
13221 Dump after the RTL instruction combination pass.
13223 @item -fdump-rtl-compgotos
13224 @opindex fdump-rtl-compgotos
13225 Dump after duplicating the computed gotos.
13227 @item -fdump-rtl-ce1
13228 @itemx -fdump-rtl-ce2
13229 @itemx -fdump-rtl-ce3
13230 @opindex fdump-rtl-ce1
13231 @opindex fdump-rtl-ce2
13232 @opindex fdump-rtl-ce3
13233 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
13234 @option{-fdump-rtl-ce3} enable dumping after the three
13235 if conversion passes.
13237 @item -fdump-rtl-cprop_hardreg
13238 @opindex fdump-rtl-cprop_hardreg
13239 Dump after hard register copy propagation.
13241 @item -fdump-rtl-csa
13242 @opindex fdump-rtl-csa
13243 Dump after combining stack adjustments.
13245 @item -fdump-rtl-cse1
13246 @itemx -fdump-rtl-cse2
13247 @opindex fdump-rtl-cse1
13248 @opindex fdump-rtl-cse2
13249 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
13250 the two common subexpression elimination passes.
13252 @item -fdump-rtl-dce
13253 @opindex fdump-rtl-dce
13254 Dump after the standalone dead code elimination passes.
13256 @item -fdump-rtl-dbr
13257 @opindex fdump-rtl-dbr
13258 Dump after delayed branch scheduling.
13260 @item -fdump-rtl-dce1
13261 @itemx -fdump-rtl-dce2
13262 @opindex fdump-rtl-dce1
13263 @opindex fdump-rtl-dce2
13264 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13265 the two dead store elimination passes.
13267 @item -fdump-rtl-eh
13268 @opindex fdump-rtl-eh
13269 Dump after finalization of EH handling code.
13271 @item -fdump-rtl-eh_ranges
13272 @opindex fdump-rtl-eh_ranges
13273 Dump after conversion of EH handling range regions.
13275 @item -fdump-rtl-expand
13276 @opindex fdump-rtl-expand
13277 Dump after RTL generation.
13279 @item -fdump-rtl-fwprop1
13280 @itemx -fdump-rtl-fwprop2
13281 @opindex fdump-rtl-fwprop1
13282 @opindex fdump-rtl-fwprop2
13283 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13284 dumping after the two forward propagation passes.
13286 @item -fdump-rtl-gcse1
13287 @itemx -fdump-rtl-gcse2
13288 @opindex fdump-rtl-gcse1
13289 @opindex fdump-rtl-gcse2
13290 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13291 after global common subexpression elimination.
13293 @item -fdump-rtl-init-regs
13294 @opindex fdump-rtl-init-regs
13295 Dump after the initialization of the registers.
13297 @item -fdump-rtl-initvals
13298 @opindex fdump-rtl-initvals
13299 Dump after the computation of the initial value sets.
13301 @item -fdump-rtl-into_cfglayout
13302 @opindex fdump-rtl-into_cfglayout
13303 Dump after converting to cfglayout mode.
13305 @item -fdump-rtl-ira
13306 @opindex fdump-rtl-ira
13307 Dump after iterated register allocation.
13309 @item -fdump-rtl-jump
13310 @opindex fdump-rtl-jump
13311 Dump after the second jump optimization.
13313 @item -fdump-rtl-loop2
13314 @opindex fdump-rtl-loop2
13315 @option{-fdump-rtl-loop2} enables dumping after the rtl
13316 loop optimization passes.
13318 @item -fdump-rtl-mach
13319 @opindex fdump-rtl-mach
13320 Dump after performing the machine dependent reorganization pass, if that
13321 pass exists.
13323 @item -fdump-rtl-mode_sw
13324 @opindex fdump-rtl-mode_sw
13325 Dump after removing redundant mode switches.
13327 @item -fdump-rtl-rnreg
13328 @opindex fdump-rtl-rnreg
13329 Dump after register renumbering.
13331 @item -fdump-rtl-outof_cfglayout
13332 @opindex fdump-rtl-outof_cfglayout
13333 Dump after converting from cfglayout mode.
13335 @item -fdump-rtl-peephole2
13336 @opindex fdump-rtl-peephole2
13337 Dump after the peephole pass.
13339 @item -fdump-rtl-postreload
13340 @opindex fdump-rtl-postreload
13341 Dump after post-reload optimizations.
13343 @item -fdump-rtl-pro_and_epilogue
13344 @opindex fdump-rtl-pro_and_epilogue
13345 Dump after generating the function prologues and epilogues.
13347 @item -fdump-rtl-sched1
13348 @itemx -fdump-rtl-sched2
13349 @opindex fdump-rtl-sched1
13350 @opindex fdump-rtl-sched2
13351 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13352 after the basic block scheduling passes.
13354 @item -fdump-rtl-ree
13355 @opindex fdump-rtl-ree
13356 Dump after sign/zero extension elimination.
13358 @item -fdump-rtl-seqabstr
13359 @opindex fdump-rtl-seqabstr
13360 Dump after common sequence discovery.
13362 @item -fdump-rtl-shorten
13363 @opindex fdump-rtl-shorten
13364 Dump after shortening branches.
13366 @item -fdump-rtl-sibling
13367 @opindex fdump-rtl-sibling
13368 Dump after sibling call optimizations.
13370 @item -fdump-rtl-split1
13371 @itemx -fdump-rtl-split2
13372 @itemx -fdump-rtl-split3
13373 @itemx -fdump-rtl-split4
13374 @itemx -fdump-rtl-split5
13375 @opindex fdump-rtl-split1
13376 @opindex fdump-rtl-split2
13377 @opindex fdump-rtl-split3
13378 @opindex fdump-rtl-split4
13379 @opindex fdump-rtl-split5
13380 These options enable dumping after five rounds of
13381 instruction splitting.
13383 @item -fdump-rtl-sms
13384 @opindex fdump-rtl-sms
13385 Dump after modulo scheduling.  This pass is only run on some
13386 architectures.
13388 @item -fdump-rtl-stack
13389 @opindex fdump-rtl-stack
13390 Dump after conversion from GCC's ``flat register file'' registers to the
13391 x87's stack-like registers.  This pass is only run on x86 variants.
13393 @item -fdump-rtl-subreg1
13394 @itemx -fdump-rtl-subreg2
13395 @opindex fdump-rtl-subreg1
13396 @opindex fdump-rtl-subreg2
13397 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13398 the two subreg expansion passes.
13400 @item -fdump-rtl-unshare
13401 @opindex fdump-rtl-unshare
13402 Dump after all rtl has been unshared.
13404 @item -fdump-rtl-vartrack
13405 @opindex fdump-rtl-vartrack
13406 Dump after variable tracking.
13408 @item -fdump-rtl-vregs
13409 @opindex fdump-rtl-vregs
13410 Dump after converting virtual registers to hard registers.
13412 @item -fdump-rtl-web
13413 @opindex fdump-rtl-web
13414 Dump after live range splitting.
13416 @item -fdump-rtl-regclass
13417 @itemx -fdump-rtl-subregs_of_mode_init
13418 @itemx -fdump-rtl-subregs_of_mode_finish
13419 @itemx -fdump-rtl-dfinit
13420 @itemx -fdump-rtl-dfinish
13421 @opindex fdump-rtl-regclass
13422 @opindex fdump-rtl-subregs_of_mode_init
13423 @opindex fdump-rtl-subregs_of_mode_finish
13424 @opindex fdump-rtl-dfinit
13425 @opindex fdump-rtl-dfinish
13426 These dumps are defined but always produce empty files.
13428 @item -da
13429 @itemx -fdump-rtl-all
13430 @opindex da
13431 @opindex fdump-rtl-all
13432 Produce all the dumps listed above.
13434 @item -dA
13435 @opindex dA
13436 Annotate the assembler output with miscellaneous debugging information.
13438 @item -dD
13439 @opindex dD
13440 Dump all macro definitions, at the end of preprocessing, in addition to
13441 normal output.
13443 @item -dH
13444 @opindex dH
13445 Produce a core dump whenever an error occurs.
13447 @item -dp
13448 @opindex dp
13449 Annotate the assembler output with a comment indicating which
13450 pattern and alternative is used.  The length and cost of each instruction are
13451 also printed.
13453 @item -dP
13454 @opindex dP
13455 Dump the RTL in the assembler output as a comment before each instruction.
13456 Also turns on @option{-dp} annotation.
13458 @item -dx
13459 @opindex dx
13460 Just generate RTL for a function instead of compiling it.  Usually used
13461 with @option{-fdump-rtl-expand}.
13462 @end table
13464 @item -fdump-noaddr
13465 @opindex fdump-noaddr
13466 When doing debugging dumps, suppress address output.  This makes it more
13467 feasible to use diff on debugging dumps for compiler invocations with
13468 different compiler binaries and/or different
13469 text / bss / data / heap / stack / dso start locations.
13471 @item -freport-bug
13472 @opindex freport-bug
13473 Collect and dump debug information into a temporary file if an
13474 internal compiler error (ICE) occurs.
13476 @item -fdump-unnumbered
13477 @opindex fdump-unnumbered
13478 When doing debugging dumps, suppress instruction numbers and address output.
13479 This makes it more feasible to use diff on debugging dumps for compiler
13480 invocations with different options, in particular with and without
13481 @option{-g}.
13483 @item -fdump-unnumbered-links
13484 @opindex fdump-unnumbered-links
13485 When doing debugging dumps (see @option{-d} option above), suppress
13486 instruction numbers for the links to the previous and next instructions
13487 in a sequence.
13489 @item -fdump-ipa-@var{switch}
13490 @opindex fdump-ipa
13491 Control the dumping at various stages of inter-procedural analysis
13492 language tree to a file.  The file name is generated by appending a
13493 switch specific suffix to the source file name, and the file is created
13494 in the same directory as the output file.  The following dumps are
13495 possible:
13497 @table @samp
13498 @item all
13499 Enables all inter-procedural analysis dumps.
13501 @item cgraph
13502 Dumps information about call-graph optimization, unused function removal,
13503 and inlining decisions.
13505 @item inline
13506 Dump after function inlining.
13508 @end table
13510 @item -fdump-lang-all
13511 @itemx -fdump-lang-@var{switch}
13512 @itemx -fdump-lang-@var{switch}-@var{options}
13513 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13514 @opindex fdump-lang-all
13515 @opindex fdump-lang
13516 Control the dumping of language-specific information.  The @var{options}
13517 and @var{filename} portions behave as described in the
13518 @option{-fdump-tree} option.  The following @var{switch} values are
13519 accepted:
13521 @table @samp
13522 @item all
13524 Enable all language-specific dumps.
13526 @item class
13527 Dump class hierarchy information.  Virtual table information is emitted
13528 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13530 @item raw
13531 Dump the raw internal tree data.  This option is applicable to C++ only.
13533 @end table
13535 @item -fdump-passes
13536 @opindex fdump-passes
13537 Print on @file{stderr} the list of optimization passes that are turned
13538 on and off by the current command-line options.
13540 @item -fdump-statistics-@var{option}
13541 @opindex fdump-statistics
13542 Enable and control dumping of pass statistics in a separate file.  The
13543 file name is generated by appending a suffix ending in
13544 @samp{.statistics} to the source file name, and the file is created in
13545 the same directory as the output file.  If the @samp{-@var{option}}
13546 form is used, @samp{-stats} causes counters to be summed over the
13547 whole compilation unit while @samp{-details} dumps every event as
13548 the passes generate them.  The default with no option is to sum
13549 counters for each function compiled.
13551 @item -fdump-tree-all
13552 @itemx -fdump-tree-@var{switch}
13553 @itemx -fdump-tree-@var{switch}-@var{options}
13554 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13555 @opindex fdump-tree-all
13556 @opindex fdump-tree
13557 Control the dumping at various stages of processing the intermediate
13558 language tree to a file.  The file name is generated by appending a
13559 switch-specific suffix to the source file name, and the file is
13560 created in the same directory as the output file. In case of
13561 @option{=@var{filename}} option, the dump is output on the given file
13562 instead of the auto named dump files.  If the @samp{-@var{options}}
13563 form is used, @var{options} is a list of @samp{-} separated options
13564 which control the details of the dump.  Not all options are applicable
13565 to all dumps; those that are not meaningful are ignored.  The
13566 following options are available
13568 @table @samp
13569 @item address
13570 Print the address of each node.  Usually this is not meaningful as it
13571 changes according to the environment and source file.  Its primary use
13572 is for tying up a dump file with a debug environment.
13573 @item asmname
13574 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13575 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13576 use working backward from mangled names in the assembly file.
13577 @item slim
13578 When dumping front-end intermediate representations, inhibit dumping
13579 of members of a scope or body of a function merely because that scope
13580 has been reached.  Only dump such items when they are directly reachable
13581 by some other path.
13583 When dumping pretty-printed trees, this option inhibits dumping the
13584 bodies of control structures.
13586 When dumping RTL, print the RTL in slim (condensed) form instead of
13587 the default LISP-like representation.
13588 @item raw
13589 Print a raw representation of the tree.  By default, trees are
13590 pretty-printed into a C-like representation.
13591 @item details
13592 Enable more detailed dumps (not honored by every dump option). Also
13593 include information from the optimization passes.
13594 @item stats
13595 Enable dumping various statistics about the pass (not honored by every dump
13596 option).
13597 @item blocks
13598 Enable showing basic block boundaries (disabled in raw dumps).
13599 @item graph
13600 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13601 dump a representation of the control flow graph suitable for viewing with
13602 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13603 the file is pretty-printed as a subgraph, so that GraphViz can render them
13604 all in a single plot.
13606 This option currently only works for RTL dumps, and the RTL is always
13607 dumped in slim form.
13608 @item vops
13609 Enable showing virtual operands for every statement.
13610 @item lineno
13611 Enable showing line numbers for statements.
13612 @item uid
13613 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13614 @item verbose
13615 Enable showing the tree dump for each statement.
13616 @item eh
13617 Enable showing the EH region number holding each statement.
13618 @item scev
13619 Enable showing scalar evolution analysis details.
13620 @item optimized
13621 Enable showing optimization information (only available in certain
13622 passes).
13623 @item missed
13624 Enable showing missed optimization information (only available in certain
13625 passes).
13626 @item note
13627 Enable other detailed optimization information (only available in
13628 certain passes).
13629 @item =@var{filename}
13630 Instead of an auto named dump file, output into the given file
13631 name. The file names @file{stdout} and @file{stderr} are treated
13632 specially and are considered already open standard streams. For
13633 example,
13635 @smallexample
13636 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13637      -fdump-tree-pre=/dev/stderr file.c
13638 @end smallexample
13640 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13641 output on to @file{stderr}. If two conflicting dump filenames are
13642 given for the same pass, then the latter option overrides the earlier
13643 one.
13645 @item all
13646 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13647 and @option{lineno}.
13649 @item optall
13650 Turn on all optimization options, i.e., @option{optimized},
13651 @option{missed}, and @option{note}.
13652 @end table
13654 To determine what tree dumps are available or find the dump for a pass
13655 of interest follow the steps below.
13657 @enumerate
13658 @item
13659 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13660 look for a code that corresponds to the pass you are interested in.
13661 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13662 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13663 The number at the end distinguishes distinct invocations of the same pass.
13664 @item
13665 To enable the creation of the dump file, append the pass code to
13666 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13667 to enable the dump from the Early Value Range Propagation pass, invoke
13668 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13669 specify the name of the dump file.  If you don't specify one, GCC
13670 creates as described below.
13671 @item
13672 Find the pass dump in a file whose name is composed of three components
13673 separated by a period: the name of the source file GCC was invoked to
13674 compile, a numeric suffix indicating the pass number followed by the
13675 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13676 and finally the pass code.  For example, the Early VRP pass dump might
13677 be in a file named @file{myfile.c.038t.evrp} in the current working
13678 directory.  Note that the numeric codes are not stable and may change
13679 from one version of GCC to another.
13680 @end enumerate
13682 @item -fopt-info
13683 @itemx -fopt-info-@var{options}
13684 @itemx -fopt-info-@var{options}=@var{filename}
13685 @opindex fopt-info
13686 Controls optimization dumps from various optimization passes. If the
13687 @samp{-@var{options}} form is used, @var{options} is a list of
13688 @samp{-} separated option keywords to select the dump details and
13689 optimizations.  
13691 The @var{options} can be divided into two groups: options describing the
13692 verbosity of the dump, and options describing which optimizations
13693 should be included. The options from both the groups can be freely
13694 mixed as they are non-overlapping. However, in case of any conflicts,
13695 the later options override the earlier options on the command
13696 line. 
13698 The following options control the dump verbosity:
13700 @table @samp
13701 @item optimized
13702 Print information when an optimization is successfully applied. It is
13703 up to a pass to decide which information is relevant. For example, the
13704 vectorizer passes print the source location of loops which are
13705 successfully vectorized.
13706 @item missed
13707 Print information about missed optimizations. Individual passes
13708 control which information to include in the output. 
13709 @item note
13710 Print verbose information about optimizations, such as certain
13711 transformations, more detailed messages about decisions etc.
13712 @item all
13713 Print detailed optimization information. This includes
13714 @samp{optimized}, @samp{missed}, and @samp{note}.
13715 @end table
13717 One or more of the following option keywords can be used to describe a
13718 group of optimizations:
13720 @table @samp
13721 @item ipa
13722 Enable dumps from all interprocedural optimizations.
13723 @item loop
13724 Enable dumps from all loop optimizations.
13725 @item inline
13726 Enable dumps from all inlining optimizations.
13727 @item omp
13728 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13729 @item vec
13730 Enable dumps from all vectorization optimizations.
13731 @item optall
13732 Enable dumps from all optimizations. This is a superset of
13733 the optimization groups listed above.
13734 @end table
13736 If @var{options} is
13737 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13738 info about successful optimizations from all the passes.  
13740 If the @var{filename} is provided, then the dumps from all the
13741 applicable optimizations are concatenated into the @var{filename}.
13742 Otherwise the dump is output onto @file{stderr}. Though multiple
13743 @option{-fopt-info} options are accepted, only one of them can include
13744 a @var{filename}. If other filenames are provided then all but the
13745 first such option are ignored.
13747 Note that the output @var{filename} is overwritten
13748 in case of multiple translation units. If a combined output from
13749 multiple translation units is desired, @file{stderr} should be used
13750 instead.
13752 In the following example, the optimization info is output to
13753 @file{stderr}:
13755 @smallexample
13756 gcc -O3 -fopt-info
13757 @end smallexample
13759 This example:
13760 @smallexample
13761 gcc -O3 -fopt-info-missed=missed.all
13762 @end smallexample
13764 @noindent
13765 outputs missed optimization report from all the passes into
13766 @file{missed.all}, and this one:
13768 @smallexample
13769 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13770 @end smallexample
13772 @noindent
13773 prints information about missed optimization opportunities from
13774 vectorization passes on @file{stderr}.  
13775 Note that @option{-fopt-info-vec-missed} is equivalent to 
13776 @option{-fopt-info-missed-vec}.  The order of the optimization group
13777 names and message types listed after @option{-fopt-info} does not matter.
13779 As another example,
13780 @smallexample
13781 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13782 @end smallexample
13784 @noindent
13785 outputs information about missed optimizations as well as
13786 optimized locations from all the inlining passes into
13787 @file{inline.txt}.
13789 Finally, consider:
13791 @smallexample
13792 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13793 @end smallexample
13795 @noindent
13796 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13797 in conflict since only one output file is allowed. In this case, only
13798 the first option takes effect and the subsequent options are
13799 ignored. Thus only @file{vec.miss} is produced which contains
13800 dumps from the vectorizer about missed opportunities.
13802 @item -fsched-verbose=@var{n}
13803 @opindex fsched-verbose
13804 On targets that use instruction scheduling, this option controls the
13805 amount of debugging output the scheduler prints to the dump files.
13807 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13808 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13809 For @var{n} greater than one, it also output basic block probabilities,
13810 detailed ready list information and unit/insn info.  For @var{n} greater
13811 than two, it includes RTL at abort point, control-flow and regions info.
13812 And for @var{n} over four, @option{-fsched-verbose} also includes
13813 dependence info.
13817 @item -fenable-@var{kind}-@var{pass}
13818 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13819 @opindex fdisable-
13820 @opindex fenable-
13822 This is a set of options that are used to explicitly disable/enable
13823 optimization passes.  These options are intended for use for debugging GCC.
13824 Compiler users should use regular options for enabling/disabling
13825 passes instead.
13827 @table @gcctabopt
13829 @item -fdisable-ipa-@var{pass}
13830 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13831 statically invoked in the compiler multiple times, the pass name should be
13832 appended with a sequential number starting from 1.
13834 @item -fdisable-rtl-@var{pass}
13835 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13836 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13837 statically invoked in the compiler multiple times, the pass name should be
13838 appended with a sequential number starting from 1.  @var{range-list} is a 
13839 comma-separated list of function ranges or assembler names.  Each range is a number
13840 pair separated by a colon.  The range is inclusive in both ends.  If the range
13841 is trivial, the number pair can be simplified as a single number.  If the
13842 function's call graph node's @var{uid} falls within one of the specified ranges,
13843 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13844 function header of a dump file, and the pass names can be dumped by using
13845 option @option{-fdump-passes}.
13847 @item -fdisable-tree-@var{pass}
13848 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13849 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13850 option arguments.
13852 @item -fenable-ipa-@var{pass}
13853 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13854 statically invoked in the compiler multiple times, the pass name should be
13855 appended with a sequential number starting from 1.
13857 @item -fenable-rtl-@var{pass}
13858 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13859 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13860 description and examples.
13862 @item -fenable-tree-@var{pass}
13863 @itemx -fenable-tree-@var{pass}=@var{range-list}
13864 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13865 of option arguments.
13867 @end table
13869 Here are some examples showing uses of these options.
13871 @smallexample
13873 # disable ccp1 for all functions
13874    -fdisable-tree-ccp1
13875 # disable complete unroll for function whose cgraph node uid is 1
13876    -fenable-tree-cunroll=1
13877 # disable gcse2 for functions at the following ranges [1,1],
13878 # [300,400], and [400,1000]
13879 # disable gcse2 for functions foo and foo2
13880    -fdisable-rtl-gcse2=foo,foo2
13881 # disable early inlining
13882    -fdisable-tree-einline
13883 # disable ipa inlining
13884    -fdisable-ipa-inline
13885 # enable tree full unroll
13886    -fenable-tree-unroll
13888 @end smallexample
13890 @item -fchecking
13891 @itemx -fchecking=@var{n}
13892 @opindex fchecking
13893 @opindex fno-checking
13894 Enable internal consistency checking.  The default depends on
13895 the compiler configuration.  @option{-fchecking=2} enables further
13896 internal consistency checking that might affect code generation.
13898 @item -frandom-seed=@var{string}
13899 @opindex frandom-seed
13900 This option provides a seed that GCC uses in place of
13901 random numbers in generating certain symbol names
13902 that have to be different in every compiled file.  It is also used to
13903 place unique stamps in coverage data files and the object files that
13904 produce them.  You can use the @option{-frandom-seed} option to produce
13905 reproducibly identical object files.
13907 The @var{string} can either be a number (decimal, octal or hex) or an
13908 arbitrary string (in which case it's converted to a number by
13909 computing CRC32).
13911 The @var{string} should be different for every file you compile.
13913 @item -save-temps
13914 @itemx -save-temps=cwd
13915 @opindex save-temps
13916 Store the usual ``temporary'' intermediate files permanently; place them
13917 in the current directory and name them based on the source file.  Thus,
13918 compiling @file{foo.c} with @option{-c -save-temps} produces files
13919 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13920 preprocessed @file{foo.i} output file even though the compiler now
13921 normally uses an integrated preprocessor.
13923 When used in combination with the @option{-x} command-line option,
13924 @option{-save-temps} is sensible enough to avoid over writing an
13925 input source file with the same extension as an intermediate file.
13926 The corresponding intermediate file may be obtained by renaming the
13927 source file before using @option{-save-temps}.
13929 If you invoke GCC in parallel, compiling several different source
13930 files that share a common base name in different subdirectories or the
13931 same source file compiled for multiple output destinations, it is
13932 likely that the different parallel compilers will interfere with each
13933 other, and overwrite the temporary files.  For instance:
13935 @smallexample
13936 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13937 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13938 @end smallexample
13940 may result in @file{foo.i} and @file{foo.o} being written to
13941 simultaneously by both compilers.
13943 @item -save-temps=obj
13944 @opindex save-temps=obj
13945 Store the usual ``temporary'' intermediate files permanently.  If the
13946 @option{-o} option is used, the temporary files are based on the
13947 object file.  If the @option{-o} option is not used, the
13948 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13950 For example:
13952 @smallexample
13953 gcc -save-temps=obj -c foo.c
13954 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13955 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13956 @end smallexample
13958 @noindent
13959 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13960 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13961 @file{dir2/yfoobar.o}.
13963 @item -time@r{[}=@var{file}@r{]}
13964 @opindex time
13965 Report the CPU time taken by each subprocess in the compilation
13966 sequence.  For C source files, this is the compiler proper and assembler
13967 (plus the linker if linking is done).
13969 Without the specification of an output file, the output looks like this:
13971 @smallexample
13972 # cc1 0.12 0.01
13973 # as 0.00 0.01
13974 @end smallexample
13976 The first number on each line is the ``user time'', that is time spent
13977 executing the program itself.  The second number is ``system time'',
13978 time spent executing operating system routines on behalf of the program.
13979 Both numbers are in seconds.
13981 With the specification of an output file, the output is appended to the
13982 named file, and it looks like this:
13984 @smallexample
13985 0.12 0.01 cc1 @var{options}
13986 0.00 0.01 as @var{options}
13987 @end smallexample
13989 The ``user time'' and the ``system time'' are moved before the program
13990 name, and the options passed to the program are displayed, so that one
13991 can later tell what file was being compiled, and with which options.
13993 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13994 @opindex fdump-final-insns
13995 Dump the final internal representation (RTL) to @var{file}.  If the
13996 optional argument is omitted (or if @var{file} is @code{.}), the name
13997 of the dump file is determined by appending @code{.gkd} to the
13998 compilation output file name.
14000 @item -fcompare-debug@r{[}=@var{opts}@r{]}
14001 @opindex fcompare-debug
14002 @opindex fno-compare-debug
14003 If no error occurs during compilation, run the compiler a second time,
14004 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
14005 passed to the second compilation.  Dump the final internal
14006 representation in both compilations, and print an error if they differ.
14008 If the equal sign is omitted, the default @option{-gtoggle} is used.
14010 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
14011 and nonzero, implicitly enables @option{-fcompare-debug}.  If
14012 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
14013 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
14014 is used.
14016 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
14017 is equivalent to @option{-fno-compare-debug}, which disables the dumping
14018 of the final representation and the second compilation, preventing even
14019 @env{GCC_COMPARE_DEBUG} from taking effect.
14021 To verify full coverage during @option{-fcompare-debug} testing, set
14022 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
14023 which GCC rejects as an invalid option in any actual compilation
14024 (rather than preprocessing, assembly or linking).  To get just a
14025 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
14026 not overridden} will do.
14028 @item -fcompare-debug-second
14029 @opindex fcompare-debug-second
14030 This option is implicitly passed to the compiler for the second
14031 compilation requested by @option{-fcompare-debug}, along with options to
14032 silence warnings, and omitting other options that would cause
14033 side-effect compiler outputs to files or to the standard output.  Dump
14034 files and preserved temporary files are renamed so as to contain the
14035 @code{.gk} additional extension during the second compilation, to avoid
14036 overwriting those generated by the first.
14038 When this option is passed to the compiler driver, it causes the
14039 @emph{first} compilation to be skipped, which makes it useful for little
14040 other than debugging the compiler proper.
14042 @item -gtoggle
14043 @opindex gtoggle
14044 Turn off generation of debug info, if leaving out this option
14045 generates it, or turn it on at level 2 otherwise.  The position of this
14046 argument in the command line does not matter; it takes effect after all
14047 other options are processed, and it does so only once, no matter how
14048 many times it is given.  This is mainly intended to be used with
14049 @option{-fcompare-debug}.
14051 @item -fvar-tracking-assignments-toggle
14052 @opindex fvar-tracking-assignments-toggle
14053 @opindex fno-var-tracking-assignments-toggle
14054 Toggle @option{-fvar-tracking-assignments}, in the same way that
14055 @option{-gtoggle} toggles @option{-g}.
14057 @item -Q
14058 @opindex Q
14059 Makes the compiler print out each function name as it is compiled, and
14060 print some statistics about each pass when it finishes.
14062 @item -ftime-report
14063 @opindex ftime-report
14064 Makes the compiler print some statistics about the time consumed by each
14065 pass when it finishes.
14067 @item -ftime-report-details
14068 @opindex ftime-report-details
14069 Record the time consumed by infrastructure parts separately for each pass.
14071 @item -fira-verbose=@var{n}
14072 @opindex fira-verbose
14073 Control the verbosity of the dump file for the integrated register allocator.
14074 The default value is 5.  If the value @var{n} is greater or equal to 10,
14075 the dump output is sent to stderr using the same format as @var{n} minus 10.
14077 @item -flto-report
14078 @opindex flto-report
14079 Prints a report with internal details on the workings of the link-time
14080 optimizer.  The contents of this report vary from version to version.
14081 It is meant to be useful to GCC developers when processing object
14082 files in LTO mode (via @option{-flto}).
14084 Disabled by default.
14086 @item -flto-report-wpa
14087 @opindex flto-report-wpa
14088 Like @option{-flto-report}, but only print for the WPA phase of Link
14089 Time Optimization.
14091 @item -fmem-report
14092 @opindex fmem-report
14093 Makes the compiler print some statistics about permanent memory
14094 allocation when it finishes.
14096 @item -fmem-report-wpa
14097 @opindex fmem-report-wpa
14098 Makes the compiler print some statistics about permanent memory
14099 allocation for the WPA phase only.
14101 @item -fpre-ipa-mem-report
14102 @opindex fpre-ipa-mem-report
14103 @item -fpost-ipa-mem-report
14104 @opindex fpost-ipa-mem-report
14105 Makes the compiler print some statistics about permanent memory
14106 allocation before or after interprocedural optimization.
14108 @item -fprofile-report
14109 @opindex fprofile-report
14110 Makes the compiler print some statistics about consistency of the
14111 (estimated) profile and effect of individual passes.
14113 @item -fstack-usage
14114 @opindex fstack-usage
14115 Makes the compiler output stack usage information for the program, on a
14116 per-function basis.  The filename for the dump is made by appending
14117 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
14118 the output file, if explicitly specified and it is not an executable,
14119 otherwise it is the basename of the source file.  An entry is made up
14120 of three fields:
14122 @itemize
14123 @item
14124 The name of the function.
14125 @item
14126 A number of bytes.
14127 @item
14128 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
14129 @end itemize
14131 The qualifier @code{static} means that the function manipulates the stack
14132 statically: a fixed number of bytes are allocated for the frame on function
14133 entry and released on function exit; no stack adjustments are otherwise made
14134 in the function.  The second field is this fixed number of bytes.
14136 The qualifier @code{dynamic} means that the function manipulates the stack
14137 dynamically: in addition to the static allocation described above, stack
14138 adjustments are made in the body of the function, for example to push/pop
14139 arguments around function calls.  If the qualifier @code{bounded} is also
14140 present, the amount of these adjustments is bounded at compile time and
14141 the second field is an upper bound of the total amount of stack used by
14142 the function.  If it is not present, the amount of these adjustments is
14143 not bounded at compile time and the second field only represents the
14144 bounded part.
14146 @item -fstats
14147 @opindex fstats
14148 Emit statistics about front-end processing at the end of the compilation.
14149 This option is supported only by the C++ front end, and
14150 the information is generally only useful to the G++ development team.
14152 @item -fdbg-cnt-list
14153 @opindex fdbg-cnt-list
14154 Print the name and the counter upper bound for all debug counters.
14157 @item -fdbg-cnt=@var{counter-value-list}
14158 @opindex fdbg-cnt
14159 Set the internal debug counter upper bound.  @var{counter-value-list}
14160 is a comma-separated list of @var{name}:@var{value} pairs
14161 which sets the upper bound of each debug counter @var{name} to @var{value}.
14162 All debug counters have the initial upper bound of @code{UINT_MAX};
14163 thus @code{dbg_cnt} returns true always unless the upper bound
14164 is set by this option.
14165 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
14166 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
14168 @item -print-file-name=@var{library}
14169 @opindex print-file-name
14170 Print the full absolute name of the library file @var{library} that
14171 would be used when linking---and don't do anything else.  With this
14172 option, GCC does not compile or link anything; it just prints the
14173 file name.
14175 @item -print-multi-directory
14176 @opindex print-multi-directory
14177 Print the directory name corresponding to the multilib selected by any
14178 other switches present in the command line.  This directory is supposed
14179 to exist in @env{GCC_EXEC_PREFIX}.
14181 @item -print-multi-lib
14182 @opindex print-multi-lib
14183 Print the mapping from multilib directory names to compiler switches
14184 that enable them.  The directory name is separated from the switches by
14185 @samp{;}, and each switch starts with an @samp{@@} instead of the
14186 @samp{-}, without spaces between multiple switches.  This is supposed to
14187 ease shell processing.
14189 @item -print-multi-os-directory
14190 @opindex print-multi-os-directory
14191 Print the path to OS libraries for the selected
14192 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
14193 present in the @file{lib} subdirectory and no multilibs are used, this is
14194 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
14195 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
14196 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
14197 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
14199 @item -print-multiarch
14200 @opindex print-multiarch
14201 Print the path to OS libraries for the selected multiarch,
14202 relative to some @file{lib} subdirectory.
14204 @item -print-prog-name=@var{program}
14205 @opindex print-prog-name
14206 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
14208 @item -print-libgcc-file-name
14209 @opindex print-libgcc-file-name
14210 Same as @option{-print-file-name=libgcc.a}.
14212 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
14213 but you do want to link with @file{libgcc.a}.  You can do:
14215 @smallexample
14216 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
14217 @end smallexample
14219 @item -print-search-dirs
14220 @opindex print-search-dirs
14221 Print the name of the configured installation directory and a list of
14222 program and library directories @command{gcc} searches---and don't do anything else.
14224 This is useful when @command{gcc} prints the error message
14225 @samp{installation problem, cannot exec cpp0: No such file or directory}.
14226 To resolve this you either need to put @file{cpp0} and the other compiler
14227 components where @command{gcc} expects to find them, or you can set the environment
14228 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
14229 Don't forget the trailing @samp{/}.
14230 @xref{Environment Variables}.
14232 @item -print-sysroot
14233 @opindex print-sysroot
14234 Print the target sysroot directory that is used during
14235 compilation.  This is the target sysroot specified either at configure
14236 time or using the @option{--sysroot} option, possibly with an extra
14237 suffix that depends on compilation options.  If no target sysroot is
14238 specified, the option prints nothing.
14240 @item -print-sysroot-headers-suffix
14241 @opindex print-sysroot-headers-suffix
14242 Print the suffix added to the target sysroot when searching for
14243 headers, or give an error if the compiler is not configured with such
14244 a suffix---and don't do anything else.
14246 @item -dumpmachine
14247 @opindex dumpmachine
14248 Print the compiler's target machine (for example,
14249 @samp{i686-pc-linux-gnu})---and don't do anything else.
14251 @item -dumpversion
14252 @opindex dumpversion
14253 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
14254 anything else.  This is the compiler version used in filesystem paths,
14255 specs, can be depending on how the compiler has been configured just
14256 a single number (major version), two numbers separated by dot (major and
14257 minor version) or three numbers separated by dots (major, minor and patchlevel
14258 version).
14260 @item -dumpfullversion
14261 @opindex dumpfullversion
14262 Print the full compiler version, always 3 numbers separated by dots,
14263 major, minor and patchlevel version.
14265 @item -dumpspecs
14266 @opindex dumpspecs
14267 Print the compiler's built-in specs---and don't do anything else.  (This
14268 is used when GCC itself is being built.)  @xref{Spec Files}.
14269 @end table
14271 @node Submodel Options
14272 @section Machine-Dependent Options
14273 @cindex submodel options
14274 @cindex specifying hardware config
14275 @cindex hardware models and configurations, specifying
14276 @cindex target-dependent options
14277 @cindex machine-dependent options
14279 Each target machine supported by GCC can have its own options---for
14280 example, to allow you to compile for a particular processor variant or
14281 ABI, or to control optimizations specific to that machine.  By
14282 convention, the names of machine-specific options start with
14283 @samp{-m}.
14285 Some configurations of the compiler also support additional target-specific
14286 options, usually for compatibility with other compilers on the same
14287 platform.
14289 @c This list is ordered alphanumerically by subsection name.
14290 @c It should be the same order and spelling as these options are listed
14291 @c in Machine Dependent Options
14293 @menu
14294 * AArch64 Options::
14295 * Adapteva Epiphany Options::
14296 * ARC Options::
14297 * ARM Options::
14298 * AVR Options::
14299 * Blackfin Options::
14300 * C6X Options::
14301 * CRIS Options::
14302 * CR16 Options::
14303 * Darwin Options::
14304 * DEC Alpha Options::
14305 * FR30 Options::
14306 * FT32 Options::
14307 * FRV Options::
14308 * GNU/Linux Options::
14309 * H8/300 Options::
14310 * HPPA Options::
14311 * IA-64 Options::
14312 * LM32 Options::
14313 * M32C Options::
14314 * M32R/D Options::
14315 * M680x0 Options::
14316 * MCore Options::
14317 * MeP Options::
14318 * MicroBlaze Options::
14319 * MIPS Options::
14320 * MMIX Options::
14321 * MN10300 Options::
14322 * Moxie Options::
14323 * MSP430 Options::
14324 * NDS32 Options::
14325 * Nios II Options::
14326 * Nvidia PTX Options::
14327 * PDP-11 Options::
14328 * picoChip Options::
14329 * PowerPC Options::
14330 * RISC-V Options::
14331 * RL78 Options::
14332 * RS/6000 and PowerPC Options::
14333 * RX Options::
14334 * S/390 and zSeries Options::
14335 * Score Options::
14336 * SH Options::
14337 * Solaris 2 Options::
14338 * SPARC Options::
14339 * SPU Options::
14340 * System V Options::
14341 * TILE-Gx Options::
14342 * TILEPro Options::
14343 * V850 Options::
14344 * VAX Options::
14345 * Visium Options::
14346 * VMS Options::
14347 * VxWorks Options::
14348 * x86 Options::
14349 * x86 Windows Options::
14350 * Xstormy16 Options::
14351 * Xtensa Options::
14352 * zSeries Options::
14353 @end menu
14355 @node AArch64 Options
14356 @subsection AArch64 Options
14357 @cindex AArch64 Options
14359 These options are defined for AArch64 implementations:
14361 @table @gcctabopt
14363 @item -mabi=@var{name}
14364 @opindex mabi
14365 Generate code for the specified data model.  Permissible values
14366 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14367 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14368 but long int and pointers are 64 bits.
14370 The default depends on the specific target configuration.  Note that
14371 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14372 entire program with the same ABI, and link with a compatible set of libraries.
14374 @item -mbig-endian
14375 @opindex mbig-endian
14376 Generate big-endian code.  This is the default when GCC is configured for an
14377 @samp{aarch64_be-*-*} target.
14379 @item -mgeneral-regs-only
14380 @opindex mgeneral-regs-only
14381 Generate code which uses only the general-purpose registers.  This will prevent
14382 the compiler from using floating-point and Advanced SIMD registers but will not
14383 impose any restrictions on the assembler.
14385 @item -mlittle-endian
14386 @opindex mlittle-endian
14387 Generate little-endian code.  This is the default when GCC is configured for an
14388 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14390 @item -mcmodel=tiny
14391 @opindex mcmodel=tiny
14392 Generate code for the tiny code model.  The program and its statically defined
14393 symbols must be within 1MB of each other.  Programs can be statically or
14394 dynamically linked.
14396 @item -mcmodel=small
14397 @opindex mcmodel=small
14398 Generate code for the small code model.  The program and its statically defined
14399 symbols must be within 4GB of each other.  Programs can be statically or
14400 dynamically linked.  This is the default code model.
14402 @item -mcmodel=large
14403 @opindex mcmodel=large
14404 Generate code for the large code model.  This makes no assumptions about
14405 addresses and sizes of sections.  Programs can be statically linked only.
14407 @item -mstrict-align
14408 @opindex mstrict-align
14409 Avoid generating memory accesses that may not be aligned on a natural object
14410 boundary as described in the architecture specification.
14412 @item -momit-leaf-frame-pointer
14413 @itemx -mno-omit-leaf-frame-pointer
14414 @opindex momit-leaf-frame-pointer
14415 @opindex mno-omit-leaf-frame-pointer
14416 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14417 default.
14419 @item -mtls-dialect=desc
14420 @opindex mtls-dialect=desc
14421 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14422 of TLS variables.  This is the default.
14424 @item -mtls-dialect=traditional
14425 @opindex mtls-dialect=traditional
14426 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14427 of TLS variables.
14429 @item -mtls-size=@var{size}
14430 @opindex mtls-size
14431 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14432 This option requires binutils 2.26 or newer.
14434 @item -mfix-cortex-a53-835769
14435 @itemx -mno-fix-cortex-a53-835769
14436 @opindex mfix-cortex-a53-835769
14437 @opindex mno-fix-cortex-a53-835769
14438 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14439 This involves inserting a NOP instruction between memory instructions and
14440 64-bit integer multiply-accumulate instructions.
14442 @item -mfix-cortex-a53-843419
14443 @itemx -mno-fix-cortex-a53-843419
14444 @opindex mfix-cortex-a53-843419
14445 @opindex mno-fix-cortex-a53-843419
14446 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14447 This erratum workaround is made at link time and this will only pass the
14448 corresponding flag to the linker.
14450 @item -mlow-precision-recip-sqrt
14451 @item -mno-low-precision-recip-sqrt
14452 @opindex mlow-precision-recip-sqrt
14453 @opindex mno-low-precision-recip-sqrt
14454 Enable or disable the reciprocal square root approximation.
14455 This option only has an effect if @option{-ffast-math} or
14456 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14457 precision of reciprocal square root results to about 16 bits for
14458 single precision and to 32 bits for double precision.
14460 @item -mlow-precision-sqrt
14461 @item -mno-low-precision-sqrt
14462 @opindex -mlow-precision-sqrt
14463 @opindex -mno-low-precision-sqrt
14464 Enable or disable the square root approximation.
14465 This option only has an effect if @option{-ffast-math} or
14466 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14467 precision of square root results to about 16 bits for
14468 single precision and to 32 bits for double precision.
14469 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14471 @item -mlow-precision-div
14472 @item -mno-low-precision-div
14473 @opindex -mlow-precision-div
14474 @opindex -mno-low-precision-div
14475 Enable or disable the division approximation.
14476 This option only has an effect if @option{-ffast-math} or
14477 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14478 precision of division results to about 16 bits for
14479 single precision and to 32 bits for double precision.
14481 @item -march=@var{name}
14482 @opindex march
14483 Specify the name of the target architecture and, optionally, one or
14484 more feature modifiers.  This option has the form
14485 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14487 The permissible values for @var{arch} are @samp{armv8-a},
14488 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @samp{armv8.4-a}
14489 or @var{native}.
14491 The value @samp{armv8.4-a} implies @samp{armv8.3-a} and enables compiler
14492 support for the ARMv8.4-A architecture extensions.
14494 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14495 support for the ARMv8.3-A architecture extensions.
14497 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14498 support for the ARMv8.2-A architecture extensions.
14500 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14501 support for the ARMv8.1-A architecture extension.  In particular, it
14502 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14504 The value @samp{native} is available on native AArch64 GNU/Linux and
14505 causes the compiler to pick the architecture of the host system.  This
14506 option has no effect if the compiler is unable to recognize the
14507 architecture of the host system,
14509 The permissible values for @var{feature} are listed in the sub-section
14510 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14511 Feature Modifiers}.  Where conflicting feature modifiers are
14512 specified, the right-most feature is used.
14514 GCC uses @var{name} to determine what kind of instructions it can emit
14515 when generating assembly code.  If @option{-march} is specified
14516 without either of @option{-mtune} or @option{-mcpu} also being
14517 specified, the code is tuned to perform well across a range of target
14518 processors implementing the target architecture.
14520 @item -mtune=@var{name}
14521 @opindex mtune
14522 Specify the name of the target processor for which GCC should tune the
14523 performance of the code.  Permissible values for this option are:
14524 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14525 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14526 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx}, @samp{saphira},
14527 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14528 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14529 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14530 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14531 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14532 @samp{native}.
14534 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14535 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14536 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14537 big.LITTLE system.
14539 Additionally on native AArch64 GNU/Linux systems the value
14540 @samp{native} tunes performance to the host system.  This option has no effect
14541 if the compiler is unable to recognize the processor of the host system.
14543 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14544 are specified, the code is tuned to perform well across a range
14545 of target processors.
14547 This option cannot be suffixed by feature modifiers.
14549 @item -mcpu=@var{name}
14550 @opindex mcpu
14551 Specify the name of the target processor, optionally suffixed by one
14552 or more feature modifiers.  This option has the form
14553 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14554 the permissible values for @var{cpu} are the same as those available
14555 for @option{-mtune}.  The permissible values for @var{feature} are
14556 documented in the sub-section on
14557 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14558 Feature Modifiers}.  Where conflicting feature modifiers are
14559 specified, the right-most feature is used.
14561 GCC uses @var{name} to determine what kind of instructions it can emit when
14562 generating assembly code (as if by @option{-march}) and to determine
14563 the target processor for which to tune for performance (as if
14564 by @option{-mtune}).  Where this option is used in conjunction
14565 with @option{-march} or @option{-mtune}, those options take precedence
14566 over the appropriate part of this option.
14568 @item -moverride=@var{string}
14569 @opindex moverride
14570 Override tuning decisions made by the back-end in response to a
14571 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14572 for @var{string} in this option are not guaranteed to be consistent
14573 across releases.
14575 This option is only intended to be useful when developing GCC.
14577 @item -mverbose-cost-dump
14578 @opindex mverbose-cost-dump
14579 Enable verbose cost model dumping in the debug dump files.  This option is
14580 provided for use in debugging the compiler.
14582 @item -mpc-relative-literal-loads
14583 @itemx -mno-pc-relative-literal-loads
14584 @opindex mpc-relative-literal-loads
14585 @opindex mno-pc-relative-literal-loads
14586 Enable or disable PC-relative literal loads.  With this option literal pools are
14587 accessed using a single instruction and emitted after each function.  This
14588 limits the maximum size of functions to 1MB.  This is enabled by default for
14589 @option{-mcmodel=tiny}.
14591 @item -msign-return-address=@var{scope}
14592 @opindex msign-return-address
14593 Select the function scope on which return address signing will be applied.
14594 Permissible values are @samp{none}, which disables return address signing,
14595 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14596 functions, and @samp{all}, which enables pointer signing for all functions.  The
14597 default value is @samp{none}.
14599 @item -msve-vector-bits=@var{bits}
14600 @opindex msve-vector-bits
14601 Specify the number of bits in an SVE vector register.  This option only has
14602 an effect when SVE is enabled.
14604 GCC supports two forms of SVE code generation: ``vector-length
14605 agnostic'' output that works with any size of vector register and
14606 ``vector-length specific'' output that only works when the vector
14607 registers are a particular size.  Replacing @var{bits} with
14608 @samp{scalable} selects vector-length agnostic output while
14609 replacing it with a number selects vector-length specific output.
14610 The possible lengths in the latter case are: 128, 256, 512, 1024
14611 and 2048.  @samp{scalable} is the default.
14613 At present, @samp{-msve-vector-bits=128} produces the same output
14614 as @samp{-msve-vector-bits=scalable}.
14616 @end table
14618 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14619 @anchor{aarch64-feature-modifiers}
14620 @cindex @option{-march} feature modifiers
14621 @cindex @option{-mcpu} feature modifiers
14622 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14623 the following and their inverses @option{no@var{feature}}:
14625 @table @samp
14626 @item crc
14627 Enable CRC extension.  This is on by default for
14628 @option{-march=armv8.1-a}.
14629 @item crypto
14630 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14631 instructions.
14632 @item fp
14633 Enable floating-point instructions.  This is on by default for all possible
14634 values for options @option{-march} and @option{-mcpu}.
14635 @item simd
14636 Enable Advanced SIMD instructions.  This also enables floating-point
14637 instructions.  This is on by default for all possible values for options
14638 @option{-march} and @option{-mcpu}.
14639 @item sve
14640 Enable Scalable Vector Extension instructions.  This also enables Advanced
14641 SIMD and floating-point instructions.
14642 @item lse
14643 Enable Large System Extension instructions.  This is on by default for
14644 @option{-march=armv8.1-a}.
14645 @item rdma
14646 Enable Round Double Multiply Accumulate instructions.  This is on by default
14647 for @option{-march=armv8.1-a}.
14648 @item fp16
14649 Enable FP16 extension.  This also enables floating-point instructions.
14650 @item fp16fml
14651 Enable FP16 fmla extension.  This also enables FP16 extensions and
14652 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.
14654 @item rcpc
14655 Enable the RcPc extension.  This does not change code generation from GCC,
14656 but is passed on to the assembler, enabling inline asm statements to use
14657 instructions from the RcPc extension.
14658 @item dotprod
14659 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
14660 @item aes
14661 Enable the Armv8-a aes and pmull crypto extension.  This also enables Advanced
14662 SIMD instructions.
14663 @item sha2
14664 Enable the Armv8-a sha2 crypto extension.  This also enables Advanced SIMD instructions.
14665 @item sha3
14666 Enable the sha512 and sha3 crypto extension.  This also enables Advanced SIMD
14667 instructions. Use of this option with architectures prior to Armv8.2-A is not supported.
14668 @item sm4
14669 Enable the sm3 and sm4 crypto extension.  This also enables Advanced SIMD instructions.
14670 Use of this option with architectures prior to Armv8.2-A is not supported.
14672 @end table
14674 Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd},
14675 which implies @option{fp}.
14676 Conversely, @option{nofp} implies @option{nosimd}, which implies
14677 @option{nocrypto}, @option{noaes} and @option{nosha2}.
14679 @node Adapteva Epiphany Options
14680 @subsection Adapteva Epiphany Options
14682 These @samp{-m} options are defined for Adapteva Epiphany:
14684 @table @gcctabopt
14685 @item -mhalf-reg-file
14686 @opindex mhalf-reg-file
14687 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14688 That allows code to run on hardware variants that lack these registers.
14690 @item -mprefer-short-insn-regs
14691 @opindex mprefer-short-insn-regs
14692 Preferentially allocate registers that allow short instruction generation.
14693 This can result in increased instruction count, so this may either reduce or
14694 increase overall code size.
14696 @item -mbranch-cost=@var{num}
14697 @opindex mbranch-cost
14698 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14699 This cost is only a heuristic and is not guaranteed to produce
14700 consistent results across releases.
14702 @item -mcmove
14703 @opindex mcmove
14704 Enable the generation of conditional moves.
14706 @item -mnops=@var{num}
14707 @opindex mnops
14708 Emit @var{num} NOPs before every other generated instruction.
14710 @item -mno-soft-cmpsf
14711 @opindex mno-soft-cmpsf
14712 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14713 and test the flags.  This is faster than a software comparison, but can
14714 get incorrect results in the presence of NaNs, or when two different small
14715 numbers are compared such that their difference is calculated as zero.
14716 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14717 software comparisons.
14719 @item -mstack-offset=@var{num}
14720 @opindex mstack-offset
14721 Set the offset between the top of the stack and the stack pointer.
14722 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14723 can be used by leaf functions without stack allocation.
14724 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14725 Note also that this option changes the ABI; compiling a program with a
14726 different stack offset than the libraries have been compiled with
14727 generally does not work.
14728 This option can be useful if you want to evaluate if a different stack
14729 offset would give you better code, but to actually use a different stack
14730 offset to build working programs, it is recommended to configure the
14731 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14733 @item -mno-round-nearest
14734 @opindex mno-round-nearest
14735 Make the scheduler assume that the rounding mode has been set to
14736 truncating.  The default is @option{-mround-nearest}.
14738 @item -mlong-calls
14739 @opindex mlong-calls
14740 If not otherwise specified by an attribute, assume all calls might be beyond
14741 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14742 function address into a register before performing a (otherwise direct) call.
14743 This is the default.
14745 @item -mshort-calls
14746 @opindex short-calls
14747 If not otherwise specified by an attribute, assume all direct calls are
14748 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14749 for direct calls.  The default is @option{-mlong-calls}.
14751 @item -msmall16
14752 @opindex msmall16
14753 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14754 apply to function addresses for which @option{-mlong-calls} semantics
14755 are in effect.
14757 @item -mfp-mode=@var{mode}
14758 @opindex mfp-mode
14759 Set the prevailing mode of the floating-point unit.
14760 This determines the floating-point mode that is provided and expected
14761 at function call and return time.  Making this mode match the mode you
14762 predominantly need at function start can make your programs smaller and
14763 faster by avoiding unnecessary mode switches.
14765 @var{mode} can be set to one the following values:
14767 @table @samp
14768 @item caller
14769 Any mode at function entry is valid, and retained or restored when
14770 the function returns, and when it calls other functions.
14771 This mode is useful for compiling libraries or other compilation units
14772 you might want to incorporate into different programs with different
14773 prevailing FPU modes, and the convenience of being able to use a single
14774 object file outweighs the size and speed overhead for any extra
14775 mode switching that might be needed, compared with what would be needed
14776 with a more specific choice of prevailing FPU mode.
14778 @item truncate
14779 This is the mode used for floating-point calculations with
14780 truncating (i.e.@: round towards zero) rounding mode.  That includes
14781 conversion from floating point to integer.
14783 @item round-nearest
14784 This is the mode used for floating-point calculations with
14785 round-to-nearest-or-even rounding mode.
14787 @item int
14788 This is the mode used to perform integer calculations in the FPU, e.g.@:
14789 integer multiply, or integer multiply-and-accumulate.
14790 @end table
14792 The default is @option{-mfp-mode=caller}
14794 @item -mnosplit-lohi
14795 @itemx -mno-postinc
14796 @itemx -mno-postmodify
14797 @opindex mnosplit-lohi
14798 @opindex mno-postinc
14799 @opindex mno-postmodify
14800 Code generation tweaks that disable, respectively, splitting of 32-bit
14801 loads, generation of post-increment addresses, and generation of
14802 post-modify addresses.  The defaults are @option{msplit-lohi},
14803 @option{-mpost-inc}, and @option{-mpost-modify}.
14805 @item -mnovect-double
14806 @opindex mno-vect-double
14807 Change the preferred SIMD mode to SImode.  The default is
14808 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14810 @item -max-vect-align=@var{num}
14811 @opindex max-vect-align
14812 The maximum alignment for SIMD vector mode types.
14813 @var{num} may be 4 or 8.  The default is 8.
14814 Note that this is an ABI change, even though many library function
14815 interfaces are unaffected if they don't use SIMD vector modes
14816 in places that affect size and/or alignment of relevant types.
14818 @item -msplit-vecmove-early
14819 @opindex msplit-vecmove-early
14820 Split vector moves into single word moves before reload.  In theory this
14821 can give better register allocation, but so far the reverse seems to be
14822 generally the case.
14824 @item -m1reg-@var{reg}
14825 @opindex m1reg-
14826 Specify a register to hold the constant @minus{}1, which makes loading small negative
14827 constants and certain bitmasks faster.
14828 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14829 which specify use of that register as a fixed register,
14830 and @samp{none}, which means that no register is used for this
14831 purpose.  The default is @option{-m1reg-none}.
14833 @end table
14835 @node ARC Options
14836 @subsection ARC Options
14837 @cindex ARC options
14839 The following options control the architecture variant for which code
14840 is being compiled:
14842 @c architecture variants
14843 @table @gcctabopt
14845 @item -mbarrel-shifter
14846 @opindex mbarrel-shifter
14847 Generate instructions supported by barrel shifter.  This is the default
14848 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14850 @item -mcpu=@var{cpu}
14851 @opindex mcpu
14852 Set architecture type, register usage, and instruction scheduling
14853 parameters for @var{cpu}.  There are also shortcut alias options
14854 available for backward compatibility and convenience.  Supported
14855 values for @var{cpu} are
14857 @table @samp
14858 @opindex mA6
14859 @opindex mARC600
14860 @item arc600
14861 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14863 @item arc601
14864 @opindex mARC601
14865 Compile for ARC601.  Alias: @option{-mARC601}.
14867 @item arc700
14868 @opindex mA7
14869 @opindex mARC700
14870 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14871 This is the default when configured with @option{--with-cpu=arc700}@.
14873 @item arcem
14874 Compile for ARC EM.
14876 @item archs
14877 Compile for ARC HS.
14879 @item em
14880 Compile for ARC EM CPU with no hardware extensions.
14882 @item em4
14883 Compile for ARC EM4 CPU.
14885 @item em4_dmips
14886 Compile for ARC EM4 DMIPS CPU.
14888 @item em4_fpus
14889 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14890 extension.
14892 @item em4_fpuda
14893 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14894 double assist instructions.
14896 @item hs
14897 Compile for ARC HS CPU with no hardware extensions except the atomic
14898 instructions.
14900 @item hs34
14901 Compile for ARC HS34 CPU.
14903 @item hs38
14904 Compile for ARC HS38 CPU.
14906 @item hs38_linux
14907 Compile for ARC HS38 CPU with all hardware extensions on.
14909 @item arc600_norm
14910 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14912 @item arc600_mul32x16
14913 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14914 instructions enabled.
14916 @item arc600_mul64
14917 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14918 instructions enabled.
14920 @item arc601_norm
14921 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14923 @item arc601_mul32x16
14924 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14925 instructions enabled.
14927 @item arc601_mul64
14928 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14929 instructions enabled.
14931 @item nps400
14932 Compile for ARC 700 on NPS400 chip.
14934 @end table
14936 @item -mdpfp
14937 @opindex mdpfp
14938 @itemx -mdpfp-compact
14939 @opindex mdpfp-compact
14940 Generate double-precision FPX instructions, tuned for the compact
14941 implementation.
14943 @item -mdpfp-fast
14944 @opindex mdpfp-fast
14945 Generate double-precision FPX instructions, tuned for the fast
14946 implementation.
14948 @item -mno-dpfp-lrsr
14949 @opindex mno-dpfp-lrsr
14950 Disable @code{lr} and @code{sr} instructions from using FPX extension
14951 aux registers.
14953 @item -mea
14954 @opindex mea
14955 Generate extended arithmetic instructions.  Currently only
14956 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14957 supported.  This is always enabled for @option{-mcpu=ARC700}.
14959 @item -mno-mpy
14960 @opindex mno-mpy
14961 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14962 deprecated.
14964 @item -mmul32x16
14965 @opindex mmul32x16
14966 Generate 32x16-bit multiply and multiply-accumulate instructions.
14968 @item -mmul64
14969 @opindex mmul64
14970 Generate @code{mul64} and @code{mulu64} instructions.  
14971 Only valid for @option{-mcpu=ARC600}.
14973 @item -mnorm
14974 @opindex mnorm
14975 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14976 is in effect.
14978 @item -mspfp
14979 @opindex mspfp
14980 @itemx -mspfp-compact
14981 @opindex mspfp-compact
14982 Generate single-precision FPX instructions, tuned for the compact
14983 implementation.
14985 @item -mspfp-fast
14986 @opindex mspfp-fast
14987 Generate single-precision FPX instructions, tuned for the fast
14988 implementation.
14990 @item -msimd
14991 @opindex msimd
14992 Enable generation of ARC SIMD instructions via target-specific
14993 builtins.  Only valid for @option{-mcpu=ARC700}.
14995 @item -msoft-float
14996 @opindex msoft-float
14997 This option ignored; it is provided for compatibility purposes only.
14998 Software floating-point code is emitted by default, and this default
14999 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
15000 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
15001 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
15003 @item -mswap
15004 @opindex mswap
15005 Generate @code{swap} instructions.
15007 @item -matomic
15008 @opindex matomic
15009 This enables use of the locked load/store conditional extension to implement
15010 atomic memory built-in functions.  Not available for ARC 6xx or ARC
15011 EM cores.
15013 @item -mdiv-rem
15014 @opindex mdiv-rem
15015 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
15017 @item -mcode-density
15018 @opindex mcode-density
15019 Enable code density instructions for ARC EM.  
15020 This option is on by default for ARC HS.
15022 @item -mll64
15023 @opindex mll64
15024 Enable double load/store operations for ARC HS cores.
15026 @item -mtp-regno=@var{regno}
15027 @opindex mtp-regno
15028 Specify thread pointer register number.
15030 @item -mmpy-option=@var{multo}
15031 @opindex mmpy-option
15032 Compile ARCv2 code with a multiplier design option.  You can specify 
15033 the option using either a string or numeric value for @var{multo}.  
15034 @samp{wlh1} is the default value.  The recognized values are:
15036 @table @samp
15037 @item 0
15038 @itemx none
15039 No multiplier available.
15041 @item 1
15042 @itemx w
15043 16x16 multiplier, fully pipelined.
15044 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
15046 @item 2
15047 @itemx wlh1
15048 32x32 multiplier, fully
15049 pipelined (1 stage).  The following instructions are additionally
15050 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15052 @item 3
15053 @itemx wlh2
15054 32x32 multiplier, fully pipelined
15055 (2 stages).  The following instructions are additionally enabled: @code{mpy},
15056 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15058 @item 4
15059 @itemx wlh3
15060 Two 16x16 multipliers, blocking,
15061 sequential.  The following instructions are additionally enabled: @code{mpy},
15062 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15064 @item 5
15065 @itemx wlh4
15066 One 16x16 multiplier, blocking,
15067 sequential.  The following instructions are additionally enabled: @code{mpy},
15068 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15070 @item 6
15071 @itemx wlh5
15072 One 32x4 multiplier, blocking,
15073 sequential.  The following instructions are additionally enabled: @code{mpy},
15074 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
15076 @item 7
15077 @itemx plus_dmpy
15078 ARC HS SIMD support.
15080 @item 8
15081 @itemx plus_macd
15082 ARC HS SIMD support.
15084 @item 9
15085 @itemx plus_qmacw
15086 ARC HS SIMD support.
15088 @end table
15090 This option is only available for ARCv2 cores@.
15092 @item -mfpu=@var{fpu}
15093 @opindex mfpu
15094 Enables support for specific floating-point hardware extensions for ARCv2
15095 cores.  Supported values for @var{fpu} are:
15097 @table @samp
15099 @item fpus
15100 Enables support for single-precision floating-point hardware
15101 extensions@.
15103 @item fpud
15104 Enables support for double-precision floating-point hardware
15105 extensions.  The single-precision floating-point extension is also
15106 enabled.  Not available for ARC EM@.
15108 @item fpuda
15109 Enables support for double-precision floating-point hardware
15110 extensions using double-precision assist instructions.  The single-precision
15111 floating-point extension is also enabled.  This option is
15112 only available for ARC EM@.
15114 @item fpuda_div
15115 Enables support for double-precision floating-point hardware
15116 extensions using double-precision assist instructions.
15117 The single-precision floating-point, square-root, and divide 
15118 extensions are also enabled.  This option is
15119 only available for ARC EM@.
15121 @item fpuda_fma
15122 Enables support for double-precision floating-point hardware
15123 extensions using double-precision assist instructions.
15124 The single-precision floating-point and fused multiply and add 
15125 hardware extensions are also enabled.  This option is
15126 only available for ARC EM@.
15128 @item fpuda_all
15129 Enables support for double-precision floating-point hardware
15130 extensions using double-precision assist instructions.
15131 All single-precision floating-point hardware extensions are also
15132 enabled.  This option is only available for ARC EM@.
15134 @item fpus_div
15135 Enables support for single-precision floating-point, square-root and divide 
15136 hardware extensions@.
15138 @item fpud_div
15139 Enables support for double-precision floating-point, square-root and divide 
15140 hardware extensions.  This option
15141 includes option @samp{fpus_div}. Not available for ARC EM@.
15143 @item fpus_fma
15144 Enables support for single-precision floating-point and 
15145 fused multiply and add hardware extensions@.
15147 @item fpud_fma
15148 Enables support for double-precision floating-point and 
15149 fused multiply and add hardware extensions.  This option
15150 includes option @samp{fpus_fma}.  Not available for ARC EM@.
15152 @item fpus_all
15153 Enables support for all single-precision floating-point hardware
15154 extensions@.
15156 @item fpud_all
15157 Enables support for all single- and double-precision floating-point
15158 hardware extensions.  Not available for ARC EM@.
15160 @end table
15162 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
15163 @opindex mirq-ctrl-saved
15164 Specifies general-purposes registers that the processor automatically
15165 saves/restores on interrupt entry and exit.  @var{register-range} is
15166 specified as two registers separated by a dash.  The register range
15167 always starts with @code{r0}, the upper limit is @code{fp} register.
15168 @var{blink} and @var{lp_count} are optional.  This option is only
15169 valid for ARC EM and ARC HS cores.
15171 @item -mrgf-banked-regs=@var{number}
15172 @opindex mrgf-banked-regs
15173 Specifies the number of registers replicated in second register bank
15174 on entry to fast interrupt.  Fast interrupts are interrupts with the
15175 highest priority level P0.  These interrupts save only PC and STATUS32
15176 registers to avoid memory transactions during interrupt entry and exit
15177 sequences.  Use this option when you are using fast interrupts in an
15178 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
15180 @item -mlpc-width=@var{width}
15181 @opindex mlpc-width
15182 Specify the width of the @code{lp_count} register.  Valid values for
15183 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
15184 fixed to 32 bits.  If the width is less than 32, the compiler does not
15185 attempt to transform loops in your program to use the zero-delay loop
15186 mechanism unless it is known that the @code{lp_count} register can
15187 hold the required loop-counter value.  Depending on the width
15188 specified, the compiler and run-time library might continue to use the
15189 loop mechanism for various needs.  This option defines macro
15190 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
15192 @end table
15194 The following options are passed through to the assembler, and also
15195 define preprocessor macro symbols.
15197 @c Flags used by the assembler, but for which we define preprocessor
15198 @c macro symbols as well.
15199 @table @gcctabopt
15200 @item -mdsp-packa
15201 @opindex mdsp-packa
15202 Passed down to the assembler to enable the DSP Pack A extensions.
15203 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
15204 deprecated.
15206 @item -mdvbf
15207 @opindex mdvbf
15208 Passed down to the assembler to enable the dual Viterbi butterfly
15209 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
15210 option is deprecated.
15212 @c ARC700 4.10 extension instruction
15213 @item -mlock
15214 @opindex mlock
15215 Passed down to the assembler to enable the locked load/store
15216 conditional extension.  Also sets the preprocessor symbol
15217 @code{__Xlock}.
15219 @item -mmac-d16
15220 @opindex mmac-d16
15221 Passed down to the assembler.  Also sets the preprocessor symbol
15222 @code{__Xxmac_d16}.  This option is deprecated.
15224 @item -mmac-24
15225 @opindex mmac-24
15226 Passed down to the assembler.  Also sets the preprocessor symbol
15227 @code{__Xxmac_24}.  This option is deprecated.
15229 @c ARC700 4.10 extension instruction
15230 @item -mrtsc
15231 @opindex mrtsc
15232 Passed down to the assembler to enable the 64-bit time-stamp counter
15233 extension instruction.  Also sets the preprocessor symbol
15234 @code{__Xrtsc}.  This option is deprecated.
15236 @c ARC700 4.10 extension instruction
15237 @item -mswape
15238 @opindex mswape
15239 Passed down to the assembler to enable the swap byte ordering
15240 extension instruction.  Also sets the preprocessor symbol
15241 @code{__Xswape}.
15243 @item -mtelephony
15244 @opindex mtelephony
15245 Passed down to the assembler to enable dual- and single-operand
15246 instructions for telephony.  Also sets the preprocessor symbol
15247 @code{__Xtelephony}.  This option is deprecated.
15249 @item -mxy
15250 @opindex mxy
15251 Passed down to the assembler to enable the XY memory extension.  Also
15252 sets the preprocessor symbol @code{__Xxy}.
15254 @end table
15256 The following options control how the assembly code is annotated:
15258 @c Assembly annotation options
15259 @table @gcctabopt
15260 @item -misize
15261 @opindex misize
15262 Annotate assembler instructions with estimated addresses.
15264 @item -mannotate-align
15265 @opindex mannotate-align
15266 Explain what alignment considerations lead to the decision to make an
15267 instruction short or long.
15269 @end table
15271 The following options are passed through to the linker:
15273 @c options passed through to the linker
15274 @table @gcctabopt
15275 @item -marclinux
15276 @opindex marclinux
15277 Passed through to the linker, to specify use of the @code{arclinux} emulation.
15278 This option is enabled by default in tool chains built for
15279 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
15280 when profiling is not requested.
15282 @item -marclinux_prof
15283 @opindex marclinux_prof
15284 Passed through to the linker, to specify use of the
15285 @code{arclinux_prof} emulation.  This option is enabled by default in
15286 tool chains built for @w{@code{arc-linux-uclibc}} and
15287 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
15289 @end table
15291 The following options control the semantics of generated code:
15293 @c semantically relevant code generation options
15294 @table @gcctabopt
15295 @item -mlong-calls
15296 @opindex mlong-calls
15297 Generate calls as register indirect calls, thus providing access
15298 to the full 32-bit address range.
15300 @item -mmedium-calls
15301 @opindex mmedium-calls
15302 Don't use less than 25-bit addressing range for calls, which is the
15303 offset available for an unconditional branch-and-link
15304 instruction.  Conditional execution of function calls is suppressed, to
15305 allow use of the 25-bit range, rather than the 21-bit range with
15306 conditional branch-and-link.  This is the default for tool chains built
15307 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15309 @item -G @var{num}
15310 @opindex G
15311 Put definitions of externally-visible data in a small data section if
15312 that data is no bigger than @var{num} bytes.  The default value of
15313 @var{num} is 4 for any ARC configuration, or 8 when we have double
15314 load/store operations.
15316 @item -mno-sdata
15317 @opindex mno-sdata
15318 Do not generate sdata references.  This is the default for tool chains
15319 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15320 targets.
15322 @item -mvolatile-cache
15323 @opindex mvolatile-cache
15324 Use ordinarily cached memory accesses for volatile references.  This is the
15325 default.
15327 @item -mno-volatile-cache
15328 @opindex mno-volatile-cache
15329 Enable cache bypass for volatile references.
15331 @end table
15333 The following options fine tune code generation:
15334 @c code generation tuning options
15335 @table @gcctabopt
15336 @item -malign-call
15337 @opindex malign-call
15338 Do alignment optimizations for call instructions.
15340 @item -mauto-modify-reg
15341 @opindex mauto-modify-reg
15342 Enable the use of pre/post modify with register displacement.
15344 @item -mbbit-peephole
15345 @opindex mbbit-peephole
15346 Enable bbit peephole2.
15348 @item -mno-brcc
15349 @opindex mno-brcc
15350 This option disables a target-specific pass in @file{arc_reorg} to
15351 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15352 It has no effect on
15353 generation of these instructions driven by the combiner pass.
15355 @item -mcase-vector-pcrel
15356 @opindex mcase-vector-pcrel
15357 Use PC-relative switch case tables to enable case table shortening.
15358 This is the default for @option{-Os}.
15360 @item -mcompact-casesi
15361 @opindex mcompact-casesi
15362 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15363 and only available for ARCv1 cores.
15365 @item -mno-cond-exec
15366 @opindex mno-cond-exec
15367 Disable the ARCompact-specific pass to generate conditional 
15368 execution instructions.
15370 Due to delay slot scheduling and interactions between operand numbers,
15371 literal sizes, instruction lengths, and the support for conditional execution,
15372 the target-independent pass to generate conditional execution is often lacking,
15373 so the ARC port has kept a special pass around that tries to find more
15374 conditional execution generation opportunities after register allocation,
15375 branch shortening, and delay slot scheduling have been done.  This pass
15376 generally, but not always, improves performance and code size, at the cost of
15377 extra compilation time, which is why there is an option to switch it off.
15378 If you have a problem with call instructions exceeding their allowable
15379 offset range because they are conditionalized, you should consider using
15380 @option{-mmedium-calls} instead.
15382 @item -mearly-cbranchsi
15383 @opindex mearly-cbranchsi
15384 Enable pre-reload use of the @code{cbranchsi} pattern.
15386 @item -mexpand-adddi
15387 @opindex mexpand-adddi
15388 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15389 @code{add.f}, @code{adc} etc.  This option is deprecated.
15391 @item -mindexed-loads
15392 @opindex mindexed-loads
15393 Enable the use of indexed loads.  This can be problematic because some
15394 optimizers then assume that indexed stores exist, which is not
15395 the case.
15397 @item -mlra
15398 @opindex mlra
15399 Enable Local Register Allocation.  This is still experimental for ARC,
15400 so by default the compiler uses standard reload
15401 (i.e. @option{-mno-lra}).
15403 @item -mlra-priority-none
15404 @opindex mlra-priority-none
15405 Don't indicate any priority for target registers.
15407 @item -mlra-priority-compact
15408 @opindex mlra-priority-compact
15409 Indicate target register priority for r0..r3 / r12..r15.
15411 @item -mlra-priority-noncompact
15412 @opindex mlra-priority-noncompact
15413 Reduce target register priority for r0..r3 / r12..r15.
15415 @item -mno-millicode
15416 @opindex mno-millicode
15417 When optimizing for size (using @option{-Os}), prologues and epilogues
15418 that have to save or restore a large number of registers are often
15419 shortened by using call to a special function in libgcc; this is
15420 referred to as a @emph{millicode} call.  As these calls can pose
15421 performance issues, and/or cause linking issues when linking in a
15422 nonstandard way, this option is provided to turn off millicode call
15423 generation.
15425 @item -mmixed-code
15426 @opindex mmixed-code
15427 Tweak register allocation to help 16-bit instruction generation.
15428 This generally has the effect of decreasing the average instruction size
15429 while increasing the instruction count.
15431 @item -mq-class
15432 @opindex mq-class
15433 Enable @samp{q} instruction alternatives.
15434 This is the default for @option{-Os}.
15436 @item -mRcq
15437 @opindex mRcq
15438 Enable @samp{Rcq} constraint handling.  
15439 Most short code generation depends on this.
15440 This is the default.
15442 @item -mRcw
15443 @opindex mRcw
15444 Enable @samp{Rcw} constraint handling.  
15445 Most ccfsm condexec mostly depends on this.
15446 This is the default.
15448 @item -msize-level=@var{level}
15449 @opindex msize-level
15450 Fine-tune size optimization with regards to instruction lengths and alignment.
15451 The recognized values for @var{level} are:
15452 @table @samp
15453 @item 0
15454 No size optimization.  This level is deprecated and treated like @samp{1}.
15456 @item 1
15457 Short instructions are used opportunistically.
15459 @item 2
15460 In addition, alignment of loops and of code after barriers are dropped.
15462 @item 3
15463 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15465 @end table
15467 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15468 the behavior when this is not set is equivalent to level @samp{1}.
15470 @item -mtune=@var{cpu}
15471 @opindex mtune
15472 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15473 by @option{-mcpu=}.
15475 Supported values for @var{cpu} are
15477 @table @samp
15478 @item ARC600
15479 Tune for ARC600 CPU.
15481 @item ARC601
15482 Tune for ARC601 CPU.
15484 @item ARC700
15485 Tune for ARC700 CPU with standard multiplier block.
15487 @item ARC700-xmac
15488 Tune for ARC700 CPU with XMAC block.
15490 @item ARC725D
15491 Tune for ARC725D CPU.
15493 @item ARC750D
15494 Tune for ARC750D CPU.
15496 @end table
15498 @item -mmultcost=@var{num}
15499 @opindex mmultcost
15500 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15501 normal instruction.
15503 @item -munalign-prob-threshold=@var{probability}
15504 @opindex munalign-prob-threshold
15505 Set probability threshold for unaligning branches.
15506 When tuning for @samp{ARC700} and optimizing for speed, branches without
15507 filled delay slot are preferably emitted unaligned and long, unless
15508 profiling indicates that the probability for the branch to be taken
15509 is below @var{probability}.  @xref{Cross-profiling}.
15510 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15512 @end table
15514 The following options are maintained for backward compatibility, but
15515 are now deprecated and will be removed in a future release:
15517 @c Deprecated options
15518 @table @gcctabopt
15520 @item -margonaut
15521 @opindex margonaut
15522 Obsolete FPX.
15524 @item -mbig-endian
15525 @opindex mbig-endian
15526 @itemx -EB
15527 @opindex EB
15528 Compile code for big-endian targets.  Use of these options is now
15529 deprecated.  Big-endian code is supported by configuring GCC to build
15530 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15531 for which big endian is the default.
15533 @item -mlittle-endian
15534 @opindex mlittle-endian
15535 @itemx -EL
15536 @opindex EL
15537 Compile code for little-endian targets.  Use of these options is now
15538 deprecated.  Little-endian code is supported by configuring GCC to build 
15539 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15540 for which little endian is the default.
15542 @item -mbarrel_shifter
15543 @opindex mbarrel_shifter
15544 Replaced by @option{-mbarrel-shifter}.
15546 @item -mdpfp_compact
15547 @opindex mdpfp_compact
15548 Replaced by @option{-mdpfp-compact}.
15550 @item -mdpfp_fast
15551 @opindex mdpfp_fast
15552 Replaced by @option{-mdpfp-fast}.
15554 @item -mdsp_packa
15555 @opindex mdsp_packa
15556 Replaced by @option{-mdsp-packa}.
15558 @item -mEA
15559 @opindex mEA
15560 Replaced by @option{-mea}.
15562 @item -mmac_24
15563 @opindex mmac_24
15564 Replaced by @option{-mmac-24}.
15566 @item -mmac_d16
15567 @opindex mmac_d16
15568 Replaced by @option{-mmac-d16}.
15570 @item -mspfp_compact
15571 @opindex mspfp_compact
15572 Replaced by @option{-mspfp-compact}.
15574 @item -mspfp_fast
15575 @opindex mspfp_fast
15576 Replaced by @option{-mspfp-fast}.
15578 @item -mtune=@var{cpu}
15579 @opindex mtune
15580 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15581 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15582 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15584 @item -multcost=@var{num}
15585 @opindex multcost
15586 Replaced by @option{-mmultcost}.
15588 @end table
15590 @node ARM Options
15591 @subsection ARM Options
15592 @cindex ARM options
15594 These @samp{-m} options are defined for the ARM port:
15596 @table @gcctabopt
15597 @item -mabi=@var{name}
15598 @opindex mabi
15599 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15600 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15602 @item -mapcs-frame
15603 @opindex mapcs-frame
15604 Generate a stack frame that is compliant with the ARM Procedure Call
15605 Standard for all functions, even if this is not strictly necessary for
15606 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15607 with this option causes the stack frames not to be generated for
15608 leaf functions.  The default is @option{-mno-apcs-frame}.
15609 This option is deprecated.
15611 @item -mapcs
15612 @opindex mapcs
15613 This is a synonym for @option{-mapcs-frame} and is deprecated.
15615 @ignore
15616 @c not currently implemented
15617 @item -mapcs-stack-check
15618 @opindex mapcs-stack-check
15619 Generate code to check the amount of stack space available upon entry to
15620 every function (that actually uses some stack space).  If there is
15621 insufficient space available then either the function
15622 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15623 called, depending upon the amount of stack space required.  The runtime
15624 system is required to provide these functions.  The default is
15625 @option{-mno-apcs-stack-check}, since this produces smaller code.
15627 @c not currently implemented
15628 @item -mapcs-reentrant
15629 @opindex mapcs-reentrant
15630 Generate reentrant, position-independent code.  The default is
15631 @option{-mno-apcs-reentrant}.
15632 @end ignore
15634 @item -mthumb-interwork
15635 @opindex mthumb-interwork
15636 Generate code that supports calling between the ARM and Thumb
15637 instruction sets.  Without this option, on pre-v5 architectures, the
15638 two instruction sets cannot be reliably used inside one program.  The
15639 default is @option{-mno-thumb-interwork}, since slightly larger code
15640 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15641 configurations this option is meaningless.
15643 @item -mno-sched-prolog
15644 @opindex mno-sched-prolog
15645 Prevent the reordering of instructions in the function prologue, or the
15646 merging of those instruction with the instructions in the function's
15647 body.  This means that all functions start with a recognizable set
15648 of instructions (or in fact one of a choice from a small set of
15649 different function prologues), and this information can be used to
15650 locate the start of functions inside an executable piece of code.  The
15651 default is @option{-msched-prolog}.
15653 @item -mfloat-abi=@var{name}
15654 @opindex mfloat-abi
15655 Specifies which floating-point ABI to use.  Permissible values
15656 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15658 Specifying @samp{soft} causes GCC to generate output containing
15659 library calls for floating-point operations.
15660 @samp{softfp} allows the generation of code using hardware floating-point
15661 instructions, but still uses the soft-float calling conventions.
15662 @samp{hard} allows generation of floating-point instructions
15663 and uses FPU-specific calling conventions.
15665 The default depends on the specific target configuration.  Note that
15666 the hard-float and soft-float ABIs are not link-compatible; you must
15667 compile your entire program with the same ABI, and link with a
15668 compatible set of libraries.
15670 @item -mlittle-endian
15671 @opindex mlittle-endian
15672 Generate code for a processor running in little-endian mode.  This is
15673 the default for all standard configurations.
15675 @item -mbig-endian
15676 @opindex mbig-endian
15677 Generate code for a processor running in big-endian mode; the default is
15678 to compile code for a little-endian processor.
15680 @item -mbe8
15681 @itemx -mbe32
15682 @opindex mbe8
15683 When linking a big-endian image select between BE8 and BE32 formats.
15684 The option has no effect for little-endian images and is ignored.  The
15685 default is dependent on the selected target architecture.  For ARMv6
15686 and later architectures the default is BE8, for older architectures
15687 the default is BE32.  BE32 format has been deprecated by ARM.
15689 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15690 @opindex march
15691 This specifies the name of the target ARM architecture.  GCC uses this
15692 name to determine what kind of instructions it can emit when generating
15693 assembly code.  This option can be used in conjunction with or instead
15694 of the @option{-mcpu=} option.
15696 Permissible names are:
15697 @samp{armv4t},
15698 @samp{armv5t}, @samp{armv5te},
15699 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15700 @samp{armv6z}, @samp{armv6zk},
15701 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15702 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a},
15703 @samp{armv8.4-a},
15704 @samp{armv7-r},
15705 @samp{armv8-r},
15706 @samp{armv6-m}, @samp{armv6s-m},
15707 @samp{armv7-m}, @samp{armv7e-m},
15708 @samp{armv8-m.base}, @samp{armv8-m.main},
15709 @samp{iwmmxt} and @samp{iwmmxt2}.
15711 Additionally, the following architectures, which lack support for the
15712 Thumb execution state, are recognized but support is deprecated:
15713 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15714 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15716 Many of the architectures support extensions.  These can be added by
15717 appending @samp{+@var{extension}} to the architecture name.  Extension
15718 options are processed in order and capabilities accumulate.  An extension
15719 will also enable any necessary base extensions
15720 upon which it depends.  For example, the @samp{+crypto} extension
15721 will always enable the @samp{+simd} extension.  The exception to the
15722 additive construction is for extensions that are prefixed with
15723 @samp{+no@dots{}}: these extensions disable the specified option and
15724 any other extensions that may depend on the presence of that
15725 extension.
15727 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15728 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15729 entirely disabled by the @samp{+nofp} option that follows it.
15731 Most extension names are generically named, but have an effect that is
15732 dependent upon the architecture to which it is applied.  For example,
15733 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15734 @samp{armv8-a} architectures, but will enable the original ARMv7-A
15735 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A
15736 variant for @samp{armv8-a}.
15738 The table below lists the supported extensions for each architecture.
15739 Architectures not mentioned do not support any extensions.
15741 @table @samp
15742 @item  armv5e
15743 @itemx armv5te
15744 @itemx armv6
15745 @itemx armv6j
15746 @itemx armv6k
15747 @itemx armv6kz
15748 @itemx armv6t2
15749 @itemx armv6z
15750 @itemx armv6zk
15751 @table @samp
15752 @item +fp
15753 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15754 used as an alias for this extension.
15756 @item +nofp
15757 Disable the floating-point instructions.
15758 @end table
15760 @item armv7
15761 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15762 @table @samp
15763 @item +fp
15764 The VFPv3 floating-point instructions, with 16 double-precision
15765 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15766 for this extension.  Note that floating-point is not supported by the
15767 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15768 ARMv7-R architectures.
15770 @item +nofp
15771 Disable the floating-point instructions.
15772 @end table
15774 @item armv7-a
15775 @table @samp
15776 @item +fp
15777 The VFPv3 floating-point instructions, with 16 double-precision
15778 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15779 for this extension.
15781 @item +simd
15782 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15783 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15784 for this extension.
15786 @item +vfpv3
15787 The VFPv3 floating-point instructions, with 32 double-precision
15788 registers.
15790 @item +vfpv3-d16-fp16
15791 The VFPv3 floating-point instructions, with 16 double-precision
15792 registers and the half-precision floating-point conversion operations.
15794 @item +vfpv3-fp16
15795 The VFPv3 floating-point instructions, with 32 double-precision
15796 registers and the half-precision floating-point conversion operations.
15798 @item +vfpv4-d16
15799 The VFPv4 floating-point instructions, with 16 double-precision
15800 registers.
15802 @item +vfpv4
15803 The VFPv4 floating-point instructions, with 32 double-precision
15804 registers.
15806 @item +neon-fp16
15807 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15808 the half-precision floating-point conversion operations.
15810 @item +neon-vfpv4
15811 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15813 @item +nosimd
15814 Disable the Advanced SIMD instructions (does not disable floating point).
15816 @item +nofp
15817 Disable the floating-point and Advanced SIMD instructions.
15818 @end table
15820 @item armv7ve
15821 The extended version of the ARMv7-A architecture with support for
15822 virtualization.
15823 @table @samp
15824 @item +fp
15825 The VFPv4 floating-point instructions, with 16 double-precision registers.
15826 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15828 @item +simd
15829 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15830 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15832 @item +vfpv3-d16
15833 The VFPv3 floating-point instructions, with 16 double-precision
15834 registers.
15836 @item +vfpv3
15837 The VFPv3 floating-point instructions, with 32 double-precision
15838 registers.
15840 @item +vfpv3-d16-fp16
15841 The VFPv3 floating-point instructions, with 16 double-precision
15842 registers and the half-precision floating-point conversion operations.
15844 @item +vfpv3-fp16
15845 The VFPv3 floating-point instructions, with 32 double-precision
15846 registers and the half-precision floating-point conversion operations.
15848 @item +vfpv4-d16
15849 The VFPv4 floating-point instructions, with 16 double-precision
15850 registers.
15852 @item +vfpv4
15853 The VFPv4 floating-point instructions, with 32 double-precision
15854 registers.
15856 @item +neon
15857 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15858 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15860 @item +neon-fp16
15861 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15862 the half-precision floating-point conversion operations.
15864 @item +nosimd
15865 Disable the Advanced SIMD instructions (does not disable floating point).
15867 @item +nofp
15868 Disable the floating-point and Advanced SIMD instructions.
15869 @end table
15871 @item armv8-a
15872 @table @samp
15873 @item +crc
15874 The Cyclic Redundancy Check (CRC) instructions.
15875 @item +simd
15876 The ARMv8-A Advanced SIMD and floating-point instructions.
15877 @item +crypto
15878 The cryptographic instructions.
15879 @item +nocrypto
15880 Disable the cryptographic instructions.
15881 @item +nofp
15882 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15883 @end table
15885 @item armv8.1-a
15886 @table @samp
15887 @item +simd
15888 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15890 @item +crypto
15891 The cryptographic instructions.  This also enables the Advanced SIMD and
15892 floating-point instructions.
15894 @item +nocrypto
15895 Disable the cryptographic instructions.
15897 @item +nofp
15898 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15899 @end table
15901 @item armv8.2-a
15902 @itemx armv8.3-a
15903 @table @samp
15904 @item +fp16
15905 The half-precision floating-point data processing instructions.
15906 This also enables the Advanced SIMD and floating-point instructions.
15908 @item +fp16fml
15909 The half-precision floating-point fmla extension.  This also enables
15910 the half-precision floating-point extension and Advanced SIMD and
15911 floating-point instructions.
15913 @item +simd
15914 The ARMv8.1-A Advanced SIMD and floating-point instructions.
15916 @item +crypto
15917 The cryptographic instructions.  This also enables the Advanced SIMD and
15918 floating-point instructions.
15920 @item +dotprod
15921 Enable the Dot Product extension.  This also enables Advanced SIMD instructions.
15923 @item +nocrypto
15924 Disable the cryptographic extension.
15926 @item +nofp
15927 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15928 @end table
15930 @item armv8.4-a
15931 @table @samp
15932 @item +fp16
15933 The half-precision floating-point data processing instructions.
15934 This also enables the Advanced SIMD and floating-point instructions as well
15935 as the Dot Product extension and the half-precision floating-point fmla
15936 extension.
15938 @item +simd
15939 The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the
15940 Dot Product extension.
15942 @item +crypto
15943 The cryptographic instructions.  This also enables the Advanced SIMD and
15944 floating-point instructions as well as the Dot Product extension.
15946 @item +nocrypto
15947 Disable the cryptographic extension.
15949 @item +nofp
15950 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15951 @end table
15953 @item armv7-r
15954 @table @samp
15955 @item +fp.sp
15956 The single-precision VFPv3 floating-point instructions.  The extension
15957 @samp{+vfpv3xd} can be used as an alias for this extension.
15959 @item +fp
15960 The VFPv3 floating-point instructions with 16 double-precision registers.
15961 The extension +vfpv3-d16 can be used as an alias for this extension.
15963 @item +nofp
15964 Disable the floating-point extension.
15966 @item +idiv
15967 The ARM-state integer division instructions.
15969 @item +noidiv
15970 Disable the ARM-state integer division extension.
15971 @end table
15973 @item armv7e-m
15974 @table @samp
15975 @item +fp
15976 The single-precision VFPv4 floating-point instructions.
15978 @item +fpv5
15979 The single-precision FPv5 floating-point instructions.
15981 @item +fp.dp
15982 The single- and double-precision FPv5 floating-point instructions.
15984 @item +nofp
15985 Disable the floating-point extensions.
15986 @end table
15988 @item  armv8-m.main
15989 @table @samp
15990 @item +dsp
15991 The DSP instructions.
15993 @item +nodsp
15994 Disable the DSP extension.
15996 @item +fp
15997 The single-precision floating-point instructions.
15999 @item +fp.dp
16000 The single- and double-precision floating-point instructions.
16002 @item +nofp
16003 Disable the floating-point extension.
16004 @end table
16006 @item armv8-r
16007 @table @samp
16008 @item +crc
16009 The Cyclic Redundancy Check (CRC) instructions.
16010 @item +fp.sp
16011 The single-precision FPv5 floating-point instructions.
16012 @item +simd
16013 The ARMv8-A Advanced SIMD and floating-point instructions.
16014 @item +crypto
16015 The cryptographic instructions.
16016 @item +nocrypto
16017 Disable the cryptographic instructions.
16018 @item +nofp
16019 Disable the floating-point, Advanced SIMD and cryptographic instructions.
16020 @end table
16022 @end table
16024 @option{-march=native} causes the compiler to auto-detect the architecture
16025 of the build computer.  At present, this feature is only supported on
16026 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16027 is unsuccessful the option has no effect.
16029 @item -mtune=@var{name}
16030 @opindex mtune
16031 This option specifies the name of the target ARM processor for
16032 which GCC should tune the performance of the code.
16033 For some ARM implementations better performance can be obtained by using
16034 this option.
16035 Permissible names are: @samp{arm2}, @samp{arm250},
16036 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
16037 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
16038 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
16039 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
16040 @samp{arm720},
16041 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
16042 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
16043 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
16044 @samp{strongarm1110},
16045 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
16046 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
16047 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
16048 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
16049 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
16050 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
16051 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
16052 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
16053 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
16054 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
16055 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
16056 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
16057 @samp{cortex-r8}, @samp{cortex-r52},
16058 @samp{cortex-m33},
16059 @samp{cortex-m23},
16060 @samp{cortex-m7},
16061 @samp{cortex-m4},
16062 @samp{cortex-m3},
16063 @samp{cortex-m1},
16064 @samp{cortex-m0},
16065 @samp{cortex-m0plus},
16066 @samp{cortex-m1.small-multiply},
16067 @samp{cortex-m0.small-multiply},
16068 @samp{cortex-m0plus.small-multiply},
16069 @samp{exynos-m1},
16070 @samp{marvell-pj4},
16071 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
16072 @samp{fa526}, @samp{fa626},
16073 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
16074 @samp{xgene1}.
16076 Additionally, this option can specify that GCC should tune the performance
16077 of the code for a big.LITTLE system.  Permissible names are:
16078 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
16079 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16080 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
16081 @samp{cortex-a75.cortex-a55}.
16083 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
16084 performance for a blend of processors within architecture @var{arch}.
16085 The aim is to generate code that run well on the current most popular
16086 processors, balancing between optimizations that benefit some CPUs in the
16087 range, and avoiding performance pitfalls of other CPUs.  The effects of
16088 this option may change in future GCC versions as CPU models come and go.
16090 @option{-mtune} permits the same extension options as @option{-mcpu}, but
16091 the extension options do not affect the tuning of the generated code.
16093 @option{-mtune=native} causes the compiler to auto-detect the CPU
16094 of the build computer.  At present, this feature is only supported on
16095 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
16096 unsuccessful the option has no effect.
16098 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
16099 @opindex mcpu
16100 This specifies the name of the target ARM processor.  GCC uses this name
16101 to derive the name of the target ARM architecture (as if specified
16102 by @option{-march}) and the ARM processor type for which to tune for
16103 performance (as if specified by @option{-mtune}).  Where this option
16104 is used in conjunction with @option{-march} or @option{-mtune},
16105 those options take precedence over the appropriate part of this option.
16107 Many of the supported CPUs implement optional architectural
16108 extensions.  Where this is so the architectural extensions are
16109 normally enabled by default.  If implementations that lack the
16110 extension exist, then the extension syntax can be used to disable
16111 those extensions that have been omitted.  For floating-point and
16112 Advanced SIMD (Neon) instructions, the settings of the options
16113 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
16114 floating-point and Advanced SIMD instructions will only be used if
16115 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
16116 @option{-mfpu} other than @samp{auto} will override the available
16117 floating-point and SIMD extension instructions.
16119 For example, @samp{cortex-a9} can be found in three major
16120 configurations: integer only, with just a floating-point unit or with
16121 floating-point and Advanced SIMD.  The default is to enable all the
16122 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
16123 be used to disable just the SIMD or both the SIMD and floating-point
16124 instructions respectively.
16126 Permissible names for this option are the same as those for
16127 @option{-mtune}.
16129 The following extension options are common to the listed CPUs:
16131 @table @samp
16132 @item +nodsp
16133 Disable the DSP instructions on @samp{cortex-m33}.
16135 @item  +nofp
16136 Disables the floating-point instructions on @samp{arm9e},
16137 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
16138 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
16139 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
16140 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
16141 Disables the floating-point and SIMD instructions on
16142 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
16143 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
16144 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
16145 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
16146 @samp{cortex-a53} and @samp{cortex-a55}.
16148 @item +nofp.dp
16149 Disables the double-precision component of the floating-point instructions
16150 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
16152 @item +nosimd
16153 Disables the SIMD (but not floating-point) instructions on
16154 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
16155 and @samp{cortex-a9}.
16157 @item +crypto
16158 Enables the cryptographic instructions on @samp{cortex-a32},
16159 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
16160 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
16161 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
16162 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
16163 @samp{cortex-a75.cortex-a55}.
16164 @end table
16166 Additionally the @samp{generic-armv7-a} pseudo target defaults to
16167 VFPv3 with 16 double-precision registers.  It supports the following
16168 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
16169 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
16170 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
16171 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
16172 @option{-march=armv7-a}.
16174 @option{-mcpu=generic-@var{arch}} is also permissible, and is
16175 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
16176 See @option{-mtune} for more information.
16178 @option{-mcpu=native} causes the compiler to auto-detect the CPU
16179 of the build computer.  At present, this feature is only supported on
16180 GNU/Linux, and not all architectures are recognized.  If the auto-detect
16181 is unsuccessful the option has no effect.
16183 @item -mfpu=@var{name}
16184 @opindex mfpu
16185 This specifies what floating-point hardware (or hardware emulation) is
16186 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
16187 @samp{vfpv3},
16188 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
16189 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
16190 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
16191 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
16192 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
16193 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
16194 is an alias for @samp{vfpv2}.
16196 The setting @samp{auto} is the default and is special.  It causes the
16197 compiler to select the floating-point and Advanced SIMD instructions
16198 based on the settings of @option{-mcpu} and @option{-march}.
16200 If the selected floating-point hardware includes the NEON extension
16201 (e.g. @option{-mfpu=neon}), note that floating-point
16202 operations are not generated by GCC's auto-vectorization pass unless
16203 @option{-funsafe-math-optimizations} is also specified.  This is
16204 because NEON hardware does not fully implement the IEEE 754 standard for
16205 floating-point arithmetic (in particular denormal values are treated as
16206 zero), so the use of NEON instructions may lead to a loss of precision.
16208 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}).
16210 @item -mfp16-format=@var{name}
16211 @opindex mfp16-format
16212 Specify the format of the @code{__fp16} half-precision floating-point type.
16213 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
16214 the default is @samp{none}, in which case the @code{__fp16} type is not
16215 defined.  @xref{Half-Precision}, for more information.
16217 @item -mstructure-size-boundary=@var{n}
16218 @opindex mstructure-size-boundary
16219 The sizes of all structures and unions are rounded up to a multiple
16220 of the number of bits set by this option.  Permissible values are 8, 32
16221 and 64.  The default value varies for different toolchains.  For the COFF
16222 targeted toolchain the default value is 8.  A value of 64 is only allowed
16223 if the underlying ABI supports it.
16225 Specifying a larger number can produce faster, more efficient code, but
16226 can also increase the size of the program.  Different values are potentially
16227 incompatible.  Code compiled with one value cannot necessarily expect to
16228 work with code or libraries compiled with another value, if they exchange
16229 information using structures or unions.
16231 This option is deprecated.
16233 @item -mabort-on-noreturn
16234 @opindex mabort-on-noreturn
16235 Generate a call to the function @code{abort} at the end of a
16236 @code{noreturn} function.  It is executed if the function tries to
16237 return.
16239 @item -mlong-calls
16240 @itemx -mno-long-calls
16241 @opindex mlong-calls
16242 @opindex mno-long-calls
16243 Tells the compiler to perform function calls by first loading the
16244 address of the function into a register and then performing a subroutine
16245 call on this register.  This switch is needed if the target function
16246 lies outside of the 64-megabyte addressing range of the offset-based
16247 version of subroutine call instruction.
16249 Even if this switch is enabled, not all function calls are turned
16250 into long calls.  The heuristic is that static functions, functions
16251 that have the @code{short_call} attribute, functions that are inside
16252 the scope of a @code{#pragma no_long_calls} directive, and functions whose
16253 definitions have already been compiled within the current compilation
16254 unit are not turned into long calls.  The exceptions to this rule are
16255 that weak function definitions, functions with the @code{long_call}
16256 attribute or the @code{section} attribute, and functions that are within
16257 the scope of a @code{#pragma long_calls} directive are always
16258 turned into long calls.
16260 This feature is not enabled by default.  Specifying
16261 @option{-mno-long-calls} restores the default behavior, as does
16262 placing the function calls within the scope of a @code{#pragma
16263 long_calls_off} directive.  Note these switches have no effect on how
16264 the compiler generates code to handle function calls via function
16265 pointers.
16267 @item -msingle-pic-base
16268 @opindex msingle-pic-base
16269 Treat the register used for PIC addressing as read-only, rather than
16270 loading it in the prologue for each function.  The runtime system is
16271 responsible for initializing this register with an appropriate value
16272 before execution begins.
16274 @item -mpic-register=@var{reg}
16275 @opindex mpic-register
16276 Specify the register to be used for PIC addressing.
16277 For standard PIC base case, the default is any suitable register
16278 determined by compiler.  For single PIC base case, the default is
16279 @samp{R9} if target is EABI based or stack-checking is enabled,
16280 otherwise the default is @samp{R10}.
16282 @item -mpic-data-is-text-relative
16283 @opindex mpic-data-is-text-relative
16284 Assume that the displacement between the text and data segments is fixed
16285 at static link time.  This permits using PC-relative addressing
16286 operations to access data known to be in the data segment.  For
16287 non-VxWorks RTP targets, this option is enabled by default.  When
16288 disabled on such targets, it will enable @option{-msingle-pic-base} by
16289 default.
16291 @item -mpoke-function-name
16292 @opindex mpoke-function-name
16293 Write the name of each function into the text section, directly
16294 preceding the function prologue.  The generated code is similar to this:
16296 @smallexample
16297      t0
16298          .ascii "arm_poke_function_name", 0
16299          .align
16300      t1
16301          .word 0xff000000 + (t1 - t0)
16302      arm_poke_function_name
16303          mov     ip, sp
16304          stmfd   sp!, @{fp, ip, lr, pc@}
16305          sub     fp, ip, #4
16306 @end smallexample
16308 When performing a stack backtrace, code can inspect the value of
16309 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
16310 location @code{pc - 12} and the top 8 bits are set, then we know that
16311 there is a function name embedded immediately preceding this location
16312 and has length @code{((pc[-3]) & 0xff000000)}.
16314 @item -mthumb
16315 @itemx -marm
16316 @opindex marm
16317 @opindex mthumb
16319 Select between generating code that executes in ARM and Thumb
16320 states.  The default for most configurations is to generate code
16321 that executes in ARM state, but the default can be changed by
16322 configuring GCC with the @option{--with-mode=}@var{state}
16323 configure option.
16325 You can also override the ARM and Thumb mode for each function
16326 by using the @code{target("thumb")} and @code{target("arm")} function attributes
16327 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
16329 @item -mflip-thumb 
16330 @opindex mflip-thumb
16331 Switch ARM/Thumb modes on alternating functions.
16332 This option is provided for regression testing of mixed Thumb/ARM code
16333 generation, and is not intended for ordinary use in compiling code.
16335 @item -mtpcs-frame
16336 @opindex mtpcs-frame
16337 Generate a stack frame that is compliant with the Thumb Procedure Call
16338 Standard for all non-leaf functions.  (A leaf function is one that does
16339 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
16341 @item -mtpcs-leaf-frame
16342 @opindex mtpcs-leaf-frame
16343 Generate a stack frame that is compliant with the Thumb Procedure Call
16344 Standard for all leaf functions.  (A leaf function is one that does
16345 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
16347 @item -mcallee-super-interworking
16348 @opindex mcallee-super-interworking
16349 Gives all externally visible functions in the file being compiled an ARM
16350 instruction set header which switches to Thumb mode before executing the
16351 rest of the function.  This allows these functions to be called from
16352 non-interworking code.  This option is not valid in AAPCS configurations
16353 because interworking is enabled by default.
16355 @item -mcaller-super-interworking
16356 @opindex mcaller-super-interworking
16357 Allows calls via function pointers (including virtual functions) to
16358 execute correctly regardless of whether the target code has been
16359 compiled for interworking or not.  There is a small overhead in the cost
16360 of executing a function pointer if this option is enabled.  This option
16361 is not valid in AAPCS configurations because interworking is enabled
16362 by default.
16364 @item -mtp=@var{name}
16365 @opindex mtp
16366 Specify the access model for the thread local storage pointer.  The valid
16367 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16368 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16369 (supported in the arm6k architecture), and @samp{auto}, which uses the
16370 best available method for the selected processor.  The default setting is
16371 @samp{auto}.
16373 @item -mtls-dialect=@var{dialect}
16374 @opindex mtls-dialect
16375 Specify the dialect to use for accessing thread local storage.  Two
16376 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16377 @samp{gnu} dialect selects the original GNU scheme for supporting
16378 local and global dynamic TLS models.  The @samp{gnu2} dialect
16379 selects the GNU descriptor scheme, which provides better performance
16380 for shared libraries.  The GNU descriptor scheme is compatible with
16381 the original scheme, but does require new assembler, linker and
16382 library support.  Initial and local exec TLS models are unaffected by
16383 this option and always use the original scheme.
16385 @item -mword-relocations
16386 @opindex mword-relocations
16387 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16388 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16389 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16390 is specified.
16392 @item -mfix-cortex-m3-ldrd
16393 @opindex mfix-cortex-m3-ldrd
16394 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16395 with overlapping destination and base registers are used.  This option avoids
16396 generating these instructions.  This option is enabled by default when
16397 @option{-mcpu=cortex-m3} is specified.
16399 @item -munaligned-access
16400 @itemx -mno-unaligned-access
16401 @opindex munaligned-access
16402 @opindex mno-unaligned-access
16403 Enables (or disables) reading and writing of 16- and 32- bit values
16404 from addresses that are not 16- or 32- bit aligned.  By default
16405 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16406 ARMv8-M Baseline architectures, and enabled for all other
16407 architectures.  If unaligned access is not enabled then words in packed
16408 data structures are accessed a byte at a time.
16410 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16411 generated object file to either true or false, depending upon the
16412 setting of this option.  If unaligned access is enabled then the
16413 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16414 defined.
16416 @item -mneon-for-64bits
16417 @opindex mneon-for-64bits
16418 Enables using Neon to handle scalar 64-bits operations. This is
16419 disabled by default since the cost of moving data from core registers
16420 to Neon is high.
16422 @item -mslow-flash-data
16423 @opindex mslow-flash-data
16424 Assume loading data from flash is slower than fetching instruction.
16425 Therefore literal load is minimized for better performance.
16426 This option is only supported when compiling for ARMv7 M-profile and
16427 off by default.
16429 @item -masm-syntax-unified
16430 @opindex masm-syntax-unified
16431 Assume inline assembler is using unified asm syntax.  The default is
16432 currently off which implies divided syntax.  This option has no impact
16433 on Thumb2. However, this may change in future releases of GCC.
16434 Divided syntax should be considered deprecated.
16436 @item -mrestrict-it
16437 @opindex mrestrict-it
16438 Restricts generation of IT blocks to conform to the rules of ARMv8-A.
16439 IT blocks can only contain a single 16-bit instruction from a select
16440 set of instructions. This option is on by default for ARMv8-A Thumb mode.
16442 @item -mprint-tune-info
16443 @opindex mprint-tune-info
16444 Print CPU tuning information as comment in assembler file.  This is
16445 an option used only for regression testing of the compiler and not
16446 intended for ordinary use in compiling code.  This option is disabled
16447 by default.
16449 @item -mverbose-cost-dump
16450 @opindex mverbose-cost-dump
16451 Enable verbose cost model dumping in the debug dump files.  This option is
16452 provided for use in debugging the compiler.
16454 @item -mpure-code
16455 @opindex mpure-code
16456 Do not allow constant data to be placed in code sections.
16457 Additionally, when compiling for ELF object format give all text sections the
16458 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16459 is only available when generating non-pic code for M-profile targets with the
16460 MOVT instruction.
16462 @item -mcmse
16463 @opindex mcmse
16464 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16465 Development Tools Engineering Specification", which can be found on
16466 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16467 @end table
16469 @node AVR Options
16470 @subsection AVR Options
16471 @cindex AVR Options
16473 These options are defined for AVR implementations:
16475 @table @gcctabopt
16476 @item -mmcu=@var{mcu}
16477 @opindex mmcu
16478 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16480 The default for this option is@tie{}@samp{avr2}.
16482 GCC supports the following AVR devices and ISAs:
16484 @include avr-mmcu.texi
16486 @item -mabsdata
16487 @opindex mabsdata
16489 Assume that all data in static storage can be accessed by LDS / STS
16490 instructions.  This option has only an effect on reduced Tiny devices like
16491 ATtiny40.  See also the @code{absdata}
16492 @ref{AVR Variable Attributes,variable attribute}.
16494 @item -maccumulate-args
16495 @opindex maccumulate-args
16496 Accumulate outgoing function arguments and acquire/release the needed
16497 stack space for outgoing function arguments once in function
16498 prologue/epilogue.  Without this option, outgoing arguments are pushed
16499 before calling a function and popped afterwards.
16501 Popping the arguments after the function call can be expensive on
16502 AVR so that accumulating the stack space might lead to smaller
16503 executables because arguments need not be removed from the
16504 stack after such a function call.
16506 This option can lead to reduced code size for functions that perform
16507 several calls to functions that get their arguments on the stack like
16508 calls to printf-like functions.
16510 @item -mbranch-cost=@var{cost}
16511 @opindex mbranch-cost
16512 Set the branch costs for conditional branch instructions to
16513 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16514 integers. The default branch cost is 0.
16516 @item -mcall-prologues
16517 @opindex mcall-prologues
16518 Functions prologues/epilogues are expanded as calls to appropriate
16519 subroutines.  Code size is smaller.
16521 @item -mgas-isr-prologues
16522 @opindex mgas-isr-prologues
16523 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16524 instruction supported by GNU Binutils.
16525 If this option is on, the feature can still be disabled for individual
16526 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16527 function attribute.  This feature is activated per default
16528 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16529 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16531 @item -mint8
16532 @opindex mint8
16533 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16534 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16535 and @code{long long} is 4 bytes.  Please note that this option does not
16536 conform to the C standards, but it results in smaller code
16537 size.
16539 @item -mmain-is-OS_task
16540 @opindex mmain-is-OS_task
16541 Do not save registers in @code{main}.  The effect is the same like
16542 attaching attribute @ref{AVR Function Attributes,,@code{OS_task}}
16543 to @code{main}. It is activated per default if optimization is on.
16545 @item -mn-flash=@var{num}
16546 @opindex mn-flash
16547 Assume that the flash memory has a size of 
16548 @var{num} times 64@tie{}KiB.
16550 @item -mno-interrupts
16551 @opindex mno-interrupts
16552 Generated code is not compatible with hardware interrupts.
16553 Code size is smaller.
16555 @item -mrelax
16556 @opindex mrelax
16557 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16558 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16559 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16560 the assembler's command line and the @option{--relax} option to the
16561 linker's command line.
16563 Jump relaxing is performed by the linker because jump offsets are not
16564 known before code is located. Therefore, the assembler code generated by the
16565 compiler is the same, but the instructions in the executable may
16566 differ from instructions in the assembler code.
16568 Relaxing must be turned on if linker stubs are needed, see the
16569 section on @code{EIND} and linker stubs below.
16571 @item -mrmw
16572 @opindex mrmw
16573 Assume that the device supports the Read-Modify-Write
16574 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16576 @item -mshort-calls
16577 @opindex mshort-calls
16579 Assume that @code{RJMP} and @code{RCALL} can target the whole
16580 program memory.
16582 This option is used internally for multilib selection.  It is
16583 not an optimization option, and you don't need to set it by hand.
16585 @item -msp8
16586 @opindex msp8
16587 Treat the stack pointer register as an 8-bit register,
16588 i.e.@: assume the high byte of the stack pointer is zero.
16589 In general, you don't need to set this option by hand.
16591 This option is used internally by the compiler to select and
16592 build multilibs for architectures @code{avr2} and @code{avr25}.
16593 These architectures mix devices with and without @code{SPH}.
16594 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16595 the compiler driver adds or removes this option from the compiler
16596 proper's command line, because the compiler then knows if the device
16597 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16598 register or not.
16600 @item -mstrict-X
16601 @opindex mstrict-X
16602 Use address register @code{X} in a way proposed by the hardware.  This means
16603 that @code{X} is only used in indirect, post-increment or
16604 pre-decrement addressing.
16606 Without this option, the @code{X} register may be used in the same way
16607 as @code{Y} or @code{Z} which then is emulated by additional
16608 instructions.  
16609 For example, loading a value with @code{X+const} addressing with a
16610 small non-negative @code{const < 64} to a register @var{Rn} is
16611 performed as
16613 @example
16614 adiw r26, const   ; X += const
16615 ld   @var{Rn}, X        ; @var{Rn} = *X
16616 sbiw r26, const   ; X -= const
16617 @end example
16619 @item -mtiny-stack
16620 @opindex mtiny-stack
16621 Only change the lower 8@tie{}bits of the stack pointer.
16623 @item -mfract-convert-truncate
16624 @opindex mfract-convert-truncate
16625 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16627 @item -nodevicelib
16628 @opindex nodevicelib
16629 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16631 @item -Waddr-space-convert
16632 @opindex Waddr-space-convert
16633 Warn about conversions between address spaces in the case where the
16634 resulting address space is not contained in the incoming address space.
16636 @item -Wmisspelled-isr
16637 @opindex Wmisspelled-isr
16638 Warn if the ISR is misspelled, i.e. without __vector prefix.
16639 Enabled by default.
16640 @end table
16642 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16643 @cindex @code{EIND}
16644 Pointers in the implementation are 16@tie{}bits wide.
16645 The address of a function or label is represented as word address so
16646 that indirect jumps and calls can target any code address in the
16647 range of 64@tie{}Ki words.
16649 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16650 bytes of program memory space, there is a special function register called
16651 @code{EIND} that serves as most significant part of the target address
16652 when @code{EICALL} or @code{EIJMP} instructions are used.
16654 Indirect jumps and calls on these devices are handled as follows by
16655 the compiler and are subject to some limitations:
16657 @itemize @bullet
16659 @item
16660 The compiler never sets @code{EIND}.
16662 @item
16663 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16664 instructions or might read @code{EIND} directly in order to emulate an
16665 indirect call/jump by means of a @code{RET} instruction.
16667 @item
16668 The compiler assumes that @code{EIND} never changes during the startup
16669 code or during the application. In particular, @code{EIND} is not
16670 saved/restored in function or interrupt service routine
16671 prologue/epilogue.
16673 @item
16674 For indirect calls to functions and computed goto, the linker
16675 generates @emph{stubs}. Stubs are jump pads sometimes also called
16676 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16677 The stub contains a direct jump to the desired address.
16679 @item
16680 Linker relaxation must be turned on so that the linker generates
16681 the stubs correctly in all situations. See the compiler option
16682 @option{-mrelax} and the linker option @option{--relax}.
16683 There are corner cases where the linker is supposed to generate stubs
16684 but aborts without relaxation and without a helpful error message.
16686 @item
16687 The default linker script is arranged for code with @code{EIND = 0}.
16688 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16689 linker script has to be used in order to place the sections whose
16690 name start with @code{.trampolines} into the segment where @code{EIND}
16691 points to.
16693 @item
16694 The startup code from libgcc never sets @code{EIND}.
16695 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16696 For the impact of AVR-LibC on @code{EIND}, see the
16697 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16699 @item
16700 It is legitimate for user-specific startup code to set up @code{EIND}
16701 early, for example by means of initialization code located in
16702 section @code{.init3}. Such code runs prior to general startup code
16703 that initializes RAM and calls constructors, but after the bit
16704 of startup code from AVR-LibC that sets @code{EIND} to the segment
16705 where the vector table is located.
16706 @example
16707 #include <avr/io.h>
16709 static void
16710 __attribute__((section(".init3"),naked,used,no_instrument_function))
16711 init3_set_eind (void)
16713   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16714                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16716 @end example
16718 @noindent
16719 The @code{__trampolines_start} symbol is defined in the linker script.
16721 @item
16722 Stubs are generated automatically by the linker if
16723 the following two conditions are met:
16724 @itemize @minus
16726 @item The address of a label is taken by means of the @code{gs} modifier
16727 (short for @emph{generate stubs}) like so:
16728 @example
16729 LDI r24, lo8(gs(@var{func}))
16730 LDI r25, hi8(gs(@var{func}))
16731 @end example
16732 @item The final location of that label is in a code segment
16733 @emph{outside} the segment where the stubs are located.
16734 @end itemize
16736 @item
16737 The compiler emits such @code{gs} modifiers for code labels in the
16738 following situations:
16739 @itemize @minus
16740 @item Taking address of a function or code label.
16741 @item Computed goto.
16742 @item If prologue-save function is used, see @option{-mcall-prologues}
16743 command-line option.
16744 @item Switch/case dispatch tables. If you do not want such dispatch
16745 tables you can specify the @option{-fno-jump-tables} command-line option.
16746 @item C and C++ constructors/destructors called during startup/shutdown.
16747 @item If the tools hit a @code{gs()} modifier explained above.
16748 @end itemize
16750 @item
16751 Jumping to non-symbolic addresses like so is @emph{not} supported:
16753 @example
16754 int main (void)
16756     /* Call function at word address 0x2 */
16757     return ((int(*)(void)) 0x2)();
16759 @end example
16761 Instead, a stub has to be set up, i.e.@: the function has to be called
16762 through a symbol (@code{func_4} in the example):
16764 @example
16765 int main (void)
16767     extern int func_4 (void);
16769     /* Call function at byte address 0x4 */
16770     return func_4();
16772 @end example
16774 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16775 Alternatively, @code{func_4} can be defined in the linker script.
16776 @end itemize
16778 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16779 @cindex @code{RAMPD}
16780 @cindex @code{RAMPX}
16781 @cindex @code{RAMPY}
16782 @cindex @code{RAMPZ}
16783 Some AVR devices support memories larger than the 64@tie{}KiB range
16784 that can be accessed with 16-bit pointers.  To access memory locations
16785 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16786 register is used as high part of the address:
16787 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16788 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16789 register, respectively, to get a wide address. Similarly,
16790 @code{RAMPD} is used together with direct addressing.
16792 @itemize
16793 @item
16794 The startup code initializes the @code{RAMP} special function
16795 registers with zero.
16797 @item
16798 If a @ref{AVR Named Address Spaces,named address space} other than
16799 generic or @code{__flash} is used, then @code{RAMPZ} is set
16800 as needed before the operation.
16802 @item
16803 If the device supports RAM larger than 64@tie{}KiB and the compiler
16804 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16805 is reset to zero after the operation.
16807 @item
16808 If the device comes with a specific @code{RAMP} register, the ISR
16809 prologue/epilogue saves/restores that SFR and initializes it with
16810 zero in case the ISR code might (implicitly) use it.
16812 @item
16813 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16814 If you use inline assembler to read from locations outside the
16815 16-bit address range and change one of the @code{RAMP} registers,
16816 you must reset it to zero after the access.
16818 @end itemize
16820 @subsubsection AVR Built-in Macros
16822 GCC defines several built-in macros so that the user code can test
16823 for the presence or absence of features.  Almost any of the following
16824 built-in macros are deduced from device capabilities and thus
16825 triggered by the @option{-mmcu=} command-line option.
16827 For even more AVR-specific built-in macros see
16828 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16830 @table @code
16832 @item __AVR_ARCH__
16833 Build-in macro that resolves to a decimal number that identifies the
16834 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16835 Possible values are:
16837 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16838 @code{4}, @code{5}, @code{51}, @code{6}
16840 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16841 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16843 respectively and
16845 @code{100},
16846 @code{102}, @code{103}, @code{104},
16847 @code{105}, @code{106}, @code{107}
16849 for @var{mcu}=@code{avrtiny},
16850 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16851 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16852 If @var{mcu} specifies a device, this built-in macro is set
16853 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16854 defined to @code{4}.
16856 @item __AVR_@var{Device}__
16857 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16858 the device's name. For example, @option{-mmcu=atmega8} defines the
16859 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16860 @code{__AVR_ATtiny261A__}, etc.
16862 The built-in macros' names follow
16863 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16864 the device name as from the AVR user manual. The difference between
16865 @var{Device} in the built-in macro and @var{device} in
16866 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16868 If @var{device} is not a device but only a core architecture like
16869 @samp{avr51}, this macro is not defined.
16871 @item __AVR_DEVICE_NAME__
16872 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16873 the device's name. For example, with @option{-mmcu=atmega8} the macro
16874 is defined to @code{atmega8}.
16876 If @var{device} is not a device but only a core architecture like
16877 @samp{avr51}, this macro is not defined.
16879 @item __AVR_XMEGA__
16880 The device / architecture belongs to the XMEGA family of devices.
16882 @item __AVR_HAVE_ELPM__
16883 The device has the @code{ELPM} instruction.
16885 @item __AVR_HAVE_ELPMX__
16886 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16887 R@var{n},Z+} instructions.
16889 @item __AVR_HAVE_MOVW__
16890 The device has the @code{MOVW} instruction to perform 16-bit
16891 register-register moves.
16893 @item __AVR_HAVE_LPMX__
16894 The device has the @code{LPM R@var{n},Z} and
16895 @code{LPM R@var{n},Z+} instructions.
16897 @item __AVR_HAVE_MUL__
16898 The device has a hardware multiplier. 
16900 @item __AVR_HAVE_JMP_CALL__
16901 The device has the @code{JMP} and @code{CALL} instructions.
16902 This is the case for devices with more than 8@tie{}KiB of program
16903 memory.
16905 @item __AVR_HAVE_EIJMP_EICALL__
16906 @itemx __AVR_3_BYTE_PC__
16907 The device has the @code{EIJMP} and @code{EICALL} instructions.
16908 This is the case for devices with more than 128@tie{}KiB of program memory.
16909 This also means that the program counter
16910 (PC) is 3@tie{}bytes wide.
16912 @item __AVR_2_BYTE_PC__
16913 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16914 with up to 128@tie{}KiB of program memory.
16916 @item __AVR_HAVE_8BIT_SP__
16917 @itemx __AVR_HAVE_16BIT_SP__
16918 The stack pointer (SP) register is treated as 8-bit respectively
16919 16-bit register by the compiler.
16920 The definition of these macros is affected by @option{-mtiny-stack}.
16922 @item __AVR_HAVE_SPH__
16923 @itemx __AVR_SP8__
16924 The device has the SPH (high part of stack pointer) special function
16925 register or has an 8-bit stack pointer, respectively.
16926 The definition of these macros is affected by @option{-mmcu=} and
16927 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16928 by @option{-msp8}.
16930 @item __AVR_HAVE_RAMPD__
16931 @itemx __AVR_HAVE_RAMPX__
16932 @itemx __AVR_HAVE_RAMPY__
16933 @itemx __AVR_HAVE_RAMPZ__
16934 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16935 @code{RAMPZ} special function register, respectively.
16937 @item __NO_INTERRUPTS__
16938 This macro reflects the @option{-mno-interrupts} command-line option.
16940 @item __AVR_ERRATA_SKIP__
16941 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16942 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16943 instructions because of a hardware erratum.  Skip instructions are
16944 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16945 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16946 set.
16948 @item __AVR_ISA_RMW__
16949 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16951 @item __AVR_SFR_OFFSET__=@var{offset}
16952 Instructions that can address I/O special function registers directly
16953 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16954 address as if addressed by an instruction to access RAM like @code{LD}
16955 or @code{STS}. This offset depends on the device architecture and has
16956 to be subtracted from the RAM address in order to get the
16957 respective I/O@tie{}address.
16959 @item __AVR_SHORT_CALLS__
16960 The @option{-mshort-calls} command line option is set.
16962 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16963 Some devices support reading from flash memory by means of @code{LD*}
16964 instructions.  The flash memory is seen in the data address space
16965 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16966 is not defined, this feature is not available.  If defined,
16967 the address space is linear and there is no need to put
16968 @code{.rodata} into RAM.  This is handled by the default linker
16969 description file, and is currently available for
16970 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16971 there is no need to use address spaces like @code{__flash} or
16972 features like attribute @code{progmem} and @code{pgm_read_*}.
16974 @item __WITH_AVRLIBC__
16975 The compiler is configured to be used together with AVR-Libc.
16976 See the @option{--with-avrlibc} configure option.
16978 @end table
16980 @node Blackfin Options
16981 @subsection Blackfin Options
16982 @cindex Blackfin Options
16984 @table @gcctabopt
16985 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16986 @opindex mcpu=
16987 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16988 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16989 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16990 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16991 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16992 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16993 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16994 @samp{bf561}, @samp{bf592}.
16996 The optional @var{sirevision} specifies the silicon revision of the target
16997 Blackfin processor.  Any workarounds available for the targeted silicon revision
16998 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16999 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
17000 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
17001 hexadecimal digits representing the major and minor numbers in the silicon
17002 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
17003 is not defined.  If @var{sirevision} is @samp{any}, the
17004 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
17005 If this optional @var{sirevision} is not used, GCC assumes the latest known
17006 silicon revision of the targeted Blackfin processor.
17008 GCC defines a preprocessor macro for the specified @var{cpu}.
17009 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
17010 provided by libgloss to be linked in if @option{-msim} is not given.
17012 Without this option, @samp{bf532} is used as the processor by default.
17014 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
17015 only the preprocessor macro is defined.
17017 @item -msim
17018 @opindex msim
17019 Specifies that the program will be run on the simulator.  This causes
17020 the simulator BSP provided by libgloss to be linked in.  This option
17021 has effect only for @samp{bfin-elf} toolchain.
17022 Certain other options, such as @option{-mid-shared-library} and
17023 @option{-mfdpic}, imply @option{-msim}.
17025 @item -momit-leaf-frame-pointer
17026 @opindex momit-leaf-frame-pointer
17027 Don't keep the frame pointer in a register for leaf functions.  This
17028 avoids the instructions to save, set up and restore frame pointers and
17029 makes an extra register available in leaf functions.
17031 @item -mspecld-anomaly
17032 @opindex mspecld-anomaly
17033 When enabled, the compiler ensures that the generated code does not
17034 contain speculative loads after jump instructions. If this option is used,
17035 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
17037 @item -mno-specld-anomaly
17038 @opindex mno-specld-anomaly
17039 Don't generate extra code to prevent speculative loads from occurring.
17041 @item -mcsync-anomaly
17042 @opindex mcsync-anomaly
17043 When enabled, the compiler ensures that the generated code does not
17044 contain CSYNC or SSYNC instructions too soon after conditional branches.
17045 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
17047 @item -mno-csync-anomaly
17048 @opindex mno-csync-anomaly
17049 Don't generate extra code to prevent CSYNC or SSYNC instructions from
17050 occurring too soon after a conditional branch.
17052 @item -mlow-64k
17053 @opindex mlow-64k
17054 When enabled, the compiler is free to take advantage of the knowledge that
17055 the entire program fits into the low 64k of memory.
17057 @item -mno-low-64k
17058 @opindex mno-low-64k
17059 Assume that the program is arbitrarily large.  This is the default.
17061 @item -mstack-check-l1
17062 @opindex mstack-check-l1
17063 Do stack checking using information placed into L1 scratchpad memory by the
17064 uClinux kernel.
17066 @item -mid-shared-library
17067 @opindex mid-shared-library
17068 Generate code that supports shared libraries via the library ID method.
17069 This allows for execute in place and shared libraries in an environment
17070 without virtual memory management.  This option implies @option{-fPIC}.
17071 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17073 @item -mno-id-shared-library
17074 @opindex mno-id-shared-library
17075 Generate code that doesn't assume ID-based shared libraries are being used.
17076 This is the default.
17078 @item -mleaf-id-shared-library
17079 @opindex mleaf-id-shared-library
17080 Generate code that supports shared libraries via the library ID method,
17081 but assumes that this library or executable won't link against any other
17082 ID shared libraries.  That allows the compiler to use faster code for jumps
17083 and calls.
17085 @item -mno-leaf-id-shared-library
17086 @opindex mno-leaf-id-shared-library
17087 Do not assume that the code being compiled won't link against any ID shared
17088 libraries.  Slower code is generated for jump and call insns.
17090 @item -mshared-library-id=n
17091 @opindex mshared-library-id
17092 Specifies the identification number of the ID-based shared library being
17093 compiled.  Specifying a value of 0 generates more compact code; specifying
17094 other values forces the allocation of that number to the current
17095 library but is no more space- or time-efficient than omitting this option.
17097 @item -msep-data
17098 @opindex msep-data
17099 Generate code that allows the data segment to be located in a different
17100 area of memory from the text segment.  This allows for execute in place in
17101 an environment without virtual memory management by eliminating relocations
17102 against the text section.
17104 @item -mno-sep-data
17105 @opindex mno-sep-data
17106 Generate code that assumes that the data segment follows the text segment.
17107 This is the default.
17109 @item -mlong-calls
17110 @itemx -mno-long-calls
17111 @opindex mlong-calls
17112 @opindex mno-long-calls
17113 Tells the compiler to perform function calls by first loading the
17114 address of the function into a register and then performing a subroutine
17115 call on this register.  This switch is needed if the target function
17116 lies outside of the 24-bit addressing range of the offset-based
17117 version of subroutine call instruction.
17119 This feature is not enabled by default.  Specifying
17120 @option{-mno-long-calls} restores the default behavior.  Note these
17121 switches have no effect on how the compiler generates code to handle
17122 function calls via function pointers.
17124 @item -mfast-fp
17125 @opindex mfast-fp
17126 Link with the fast floating-point library. This library relaxes some of
17127 the IEEE floating-point standard's rules for checking inputs against
17128 Not-a-Number (NAN), in the interest of performance.
17130 @item -minline-plt
17131 @opindex minline-plt
17132 Enable inlining of PLT entries in function calls to functions that are
17133 not known to bind locally.  It has no effect without @option{-mfdpic}.
17135 @item -mmulticore
17136 @opindex mmulticore
17137 Build a standalone application for multicore Blackfin processors. 
17138 This option causes proper start files and link scripts supporting 
17139 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
17140 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
17142 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
17143 selects the one-application-per-core programming model.  Without
17144 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
17145 programming model is used. In this model, the main function of Core B
17146 should be named as @code{coreb_main}.
17148 If this option is not used, the single-core application programming
17149 model is used.
17151 @item -mcorea
17152 @opindex mcorea
17153 Build a standalone application for Core A of BF561 when using
17154 the one-application-per-core programming model. Proper start files
17155 and link scripts are used to support Core A, and the macro
17156 @code{__BFIN_COREA} is defined.
17157 This option can only be used in conjunction with @option{-mmulticore}.
17159 @item -mcoreb
17160 @opindex mcoreb
17161 Build a standalone application for Core B of BF561 when using
17162 the one-application-per-core programming model. Proper start files
17163 and link scripts are used to support Core B, and the macro
17164 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
17165 should be used instead of @code{main}. 
17166 This option can only be used in conjunction with @option{-mmulticore}.
17168 @item -msdram
17169 @opindex msdram
17170 Build a standalone application for SDRAM. Proper start files and
17171 link scripts are used to put the application into SDRAM, and the macro
17172 @code{__BFIN_SDRAM} is defined.
17173 The loader should initialize SDRAM before loading the application.
17175 @item -micplb
17176 @opindex micplb
17177 Assume that ICPLBs are enabled at run time.  This has an effect on certain
17178 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
17179 are enabled; for standalone applications the default is off.
17180 @end table
17182 @node C6X Options
17183 @subsection C6X Options
17184 @cindex C6X Options
17186 @table @gcctabopt
17187 @item -march=@var{name}
17188 @opindex march
17189 This specifies the name of the target architecture.  GCC uses this
17190 name to determine what kind of instructions it can emit when generating
17191 assembly code.  Permissible names are: @samp{c62x},
17192 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
17194 @item -mbig-endian
17195 @opindex mbig-endian
17196 Generate code for a big-endian target.
17198 @item -mlittle-endian
17199 @opindex mlittle-endian
17200 Generate code for a little-endian target.  This is the default.
17202 @item -msim
17203 @opindex msim
17204 Choose startup files and linker script suitable for the simulator.
17206 @item -msdata=default
17207 @opindex msdata=default
17208 Put small global and static data in the @code{.neardata} section,
17209 which is pointed to by register @code{B14}.  Put small uninitialized
17210 global and static data in the @code{.bss} section, which is adjacent
17211 to the @code{.neardata} section.  Put small read-only data into the
17212 @code{.rodata} section.  The corresponding sections used for large
17213 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
17215 @item -msdata=all
17216 @opindex msdata=all
17217 Put all data, not just small objects, into the sections reserved for
17218 small data, and use addressing relative to the @code{B14} register to
17219 access them.
17221 @item -msdata=none
17222 @opindex msdata=none
17223 Make no use of the sections reserved for small data, and use absolute
17224 addresses to access all data.  Put all initialized global and static
17225 data in the @code{.fardata} section, and all uninitialized data in the
17226 @code{.far} section.  Put all constant data into the @code{.const}
17227 section.
17228 @end table
17230 @node CRIS Options
17231 @subsection CRIS Options
17232 @cindex CRIS Options
17234 These options are defined specifically for the CRIS ports.
17236 @table @gcctabopt
17237 @item -march=@var{architecture-type}
17238 @itemx -mcpu=@var{architecture-type}
17239 @opindex march
17240 @opindex mcpu
17241 Generate code for the specified architecture.  The choices for
17242 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
17243 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
17244 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
17245 @samp{v10}.
17247 @item -mtune=@var{architecture-type}
17248 @opindex mtune
17249 Tune to @var{architecture-type} everything applicable about the generated
17250 code, except for the ABI and the set of available instructions.  The
17251 choices for @var{architecture-type} are the same as for
17252 @option{-march=@var{architecture-type}}.
17254 @item -mmax-stack-frame=@var{n}
17255 @opindex mmax-stack-frame
17256 Warn when the stack frame of a function exceeds @var{n} bytes.
17258 @item -metrax4
17259 @itemx -metrax100
17260 @opindex metrax4
17261 @opindex metrax100
17262 The options @option{-metrax4} and @option{-metrax100} are synonyms for
17263 @option{-march=v3} and @option{-march=v8} respectively.
17265 @item -mmul-bug-workaround
17266 @itemx -mno-mul-bug-workaround
17267 @opindex mmul-bug-workaround
17268 @opindex mno-mul-bug-workaround
17269 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
17270 models where it applies.  This option is active by default.
17272 @item -mpdebug
17273 @opindex mpdebug
17274 Enable CRIS-specific verbose debug-related information in the assembly
17275 code.  This option also has the effect of turning off the @samp{#NO_APP}
17276 formatted-code indicator to the assembler at the beginning of the
17277 assembly file.
17279 @item -mcc-init
17280 @opindex mcc-init
17281 Do not use condition-code results from previous instruction; always emit
17282 compare and test instructions before use of condition codes.
17284 @item -mno-side-effects
17285 @opindex mno-side-effects
17286 Do not emit instructions with side effects in addressing modes other than
17287 post-increment.
17289 @item -mstack-align
17290 @itemx -mno-stack-align
17291 @itemx -mdata-align
17292 @itemx -mno-data-align
17293 @itemx -mconst-align
17294 @itemx -mno-const-align
17295 @opindex mstack-align
17296 @opindex mno-stack-align
17297 @opindex mdata-align
17298 @opindex mno-data-align
17299 @opindex mconst-align
17300 @opindex mno-const-align
17301 These options (@samp{no-} options) arrange (eliminate arrangements) for the
17302 stack frame, individual data and constants to be aligned for the maximum
17303 single data access size for the chosen CPU model.  The default is to
17304 arrange for 32-bit alignment.  ABI details such as structure layout are
17305 not affected by these options.
17307 @item -m32-bit
17308 @itemx -m16-bit
17309 @itemx -m8-bit
17310 @opindex m32-bit
17311 @opindex m16-bit
17312 @opindex m8-bit
17313 Similar to the stack- data- and const-align options above, these options
17314 arrange for stack frame, writable data and constants to all be 32-bit,
17315 16-bit or 8-bit aligned.  The default is 32-bit alignment.
17317 @item -mno-prologue-epilogue
17318 @itemx -mprologue-epilogue
17319 @opindex mno-prologue-epilogue
17320 @opindex mprologue-epilogue
17321 With @option{-mno-prologue-epilogue}, the normal function prologue and
17322 epilogue which set up the stack frame are omitted and no return
17323 instructions or return sequences are generated in the code.  Use this
17324 option only together with visual inspection of the compiled code: no
17325 warnings or errors are generated when call-saved registers must be saved,
17326 or storage for local variables needs to be allocated.
17328 @item -mno-gotplt
17329 @itemx -mgotplt
17330 @opindex mno-gotplt
17331 @opindex mgotplt
17332 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
17333 instruction sequences that load addresses for functions from the PLT part
17334 of the GOT rather than (traditional on other architectures) calls to the
17335 PLT@.  The default is @option{-mgotplt}.
17337 @item -melf
17338 @opindex melf
17339 Legacy no-op option only recognized with the cris-axis-elf and
17340 cris-axis-linux-gnu targets.
17342 @item -mlinux
17343 @opindex mlinux
17344 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
17346 @item -sim
17347 @opindex sim
17348 This option, recognized for the cris-axis-elf, arranges
17349 to link with input-output functions from a simulator library.  Code,
17350 initialized data and zero-initialized data are allocated consecutively.
17352 @item -sim2
17353 @opindex sim2
17354 Like @option{-sim}, but pass linker options to locate initialized data at
17355 0x40000000 and zero-initialized data at 0x80000000.
17356 @end table
17358 @node CR16 Options
17359 @subsection CR16 Options
17360 @cindex CR16 Options
17362 These options are defined specifically for the CR16 ports.
17364 @table @gcctabopt
17366 @item -mmac
17367 @opindex mmac
17368 Enable the use of multiply-accumulate instructions. Disabled by default.
17370 @item -mcr16cplus
17371 @itemx -mcr16c
17372 @opindex mcr16cplus
17373 @opindex mcr16c
17374 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17375 is default.
17377 @item -msim
17378 @opindex msim
17379 Links the library libsim.a which is in compatible with simulator. Applicable
17380 to ELF compiler only.
17382 @item -mint32
17383 @opindex mint32
17384 Choose integer type as 32-bit wide.
17386 @item -mbit-ops
17387 @opindex mbit-ops
17388 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17390 @item -mdata-model=@var{model}
17391 @opindex mdata-model
17392 Choose a data model. The choices for @var{model} are @samp{near},
17393 @samp{far} or @samp{medium}. @samp{medium} is default.
17394 However, @samp{far} is not valid with @option{-mcr16c}, as the
17395 CR16C architecture does not support the far data model.
17396 @end table
17398 @node Darwin Options
17399 @subsection Darwin Options
17400 @cindex Darwin options
17402 These options are defined for all architectures running the Darwin operating
17403 system.
17405 FSF GCC on Darwin does not create ``fat'' object files; it creates
17406 an object file for the single architecture that GCC was built to
17407 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17408 @option{-arch} options are used; it does so by running the compiler or
17409 linker multiple times and joining the results together with
17410 @file{lipo}.
17412 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17413 @samp{i686}) is determined by the flags that specify the ISA
17414 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17415 @option{-force_cpusubtype_ALL} option can be used to override this.
17417 The Darwin tools vary in their behavior when presented with an ISA
17418 mismatch.  The assembler, @file{as}, only permits instructions to
17419 be used that are valid for the subtype of the file it is generating,
17420 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17421 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17422 and prints an error if asked to create a shared library with a less
17423 restrictive subtype than its input files (for instance, trying to put
17424 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17425 for executables, @command{ld}, quietly gives the executable the most
17426 restrictive subtype of any of its input files.
17428 @table @gcctabopt
17429 @item -F@var{dir}
17430 @opindex F
17431 Add the framework directory @var{dir} to the head of the list of
17432 directories to be searched for header files.  These directories are
17433 interleaved with those specified by @option{-I} options and are
17434 scanned in a left-to-right order.
17436 A framework directory is a directory with frameworks in it.  A
17437 framework is a directory with a @file{Headers} and/or
17438 @file{PrivateHeaders} directory contained directly in it that ends
17439 in @file{.framework}.  The name of a framework is the name of this
17440 directory excluding the @file{.framework}.  Headers associated with
17441 the framework are found in one of those two directories, with
17442 @file{Headers} being searched first.  A subframework is a framework
17443 directory that is in a framework's @file{Frameworks} directory.
17444 Includes of subframework headers can only appear in a header of a
17445 framework that contains the subframework, or in a sibling subframework
17446 header.  Two subframeworks are siblings if they occur in the same
17447 framework.  A subframework should not have the same name as a
17448 framework; a warning is issued if this is violated.  Currently a
17449 subframework cannot have subframeworks; in the future, the mechanism
17450 may be extended to support this.  The standard frameworks can be found
17451 in @file{/System/Library/Frameworks} and
17452 @file{/Library/Frameworks}.  An example include looks like
17453 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17454 the name of the framework and @file{header.h} is found in the
17455 @file{PrivateHeaders} or @file{Headers} directory.
17457 @item -iframework@var{dir}
17458 @opindex iframework
17459 Like @option{-F} except the directory is a treated as a system
17460 directory.  The main difference between this @option{-iframework} and
17461 @option{-F} is that with @option{-iframework} the compiler does not
17462 warn about constructs contained within header files found via
17463 @var{dir}.  This option is valid only for the C family of languages.
17465 @item -gused
17466 @opindex gused
17467 Emit debugging information for symbols that are used.  For stabs
17468 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17469 This is by default ON@.
17471 @item -gfull
17472 @opindex gfull
17473 Emit debugging information for all symbols and types.
17475 @item -mmacosx-version-min=@var{version}
17476 The earliest version of MacOS X that this executable will run on
17477 is @var{version}.  Typical values of @var{version} include @code{10.1},
17478 @code{10.2}, and @code{10.3.9}.
17480 If the compiler was built to use the system's headers by default,
17481 then the default for this option is the system version on which the
17482 compiler is running, otherwise the default is to make choices that
17483 are compatible with as many systems and code bases as possible.
17485 @item -mkernel
17486 @opindex mkernel
17487 Enable kernel development mode.  The @option{-mkernel} option sets
17488 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17489 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17490 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17491 applicable.  This mode also sets @option{-mno-altivec},
17492 @option{-msoft-float}, @option{-fno-builtin} and
17493 @option{-mlong-branch} for PowerPC targets.
17495 @item -mone-byte-bool
17496 @opindex mone-byte-bool
17497 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17498 By default @code{sizeof(bool)} is @code{4} when compiling for
17499 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17500 option has no effect on x86.
17502 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17503 to generate code that is not binary compatible with code generated
17504 without that switch.  Using this switch may require recompiling all
17505 other modules in a program, including system libraries.  Use this
17506 switch to conform to a non-default data model.
17508 @item -mfix-and-continue
17509 @itemx -ffix-and-continue
17510 @itemx -findirect-data
17511 @opindex mfix-and-continue
17512 @opindex ffix-and-continue
17513 @opindex findirect-data
17514 Generate code suitable for fast turnaround development, such as to
17515 allow GDB to dynamically load @file{.o} files into already-running
17516 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17517 are provided for backwards compatibility.
17519 @item -all_load
17520 @opindex all_load
17521 Loads all members of static archive libraries.
17522 See man ld(1) for more information.
17524 @item -arch_errors_fatal
17525 @opindex arch_errors_fatal
17526 Cause the errors having to do with files that have the wrong architecture
17527 to be fatal.
17529 @item -bind_at_load
17530 @opindex bind_at_load
17531 Causes the output file to be marked such that the dynamic linker will
17532 bind all undefined references when the file is loaded or launched.
17534 @item -bundle
17535 @opindex bundle
17536 Produce a Mach-o bundle format file.
17537 See man ld(1) for more information.
17539 @item -bundle_loader @var{executable}
17540 @opindex bundle_loader
17541 This option specifies the @var{executable} that will load the build
17542 output file being linked.  See man ld(1) for more information.
17544 @item -dynamiclib
17545 @opindex dynamiclib
17546 When passed this option, GCC produces a dynamic library instead of
17547 an executable when linking, using the Darwin @file{libtool} command.
17549 @item -force_cpusubtype_ALL
17550 @opindex force_cpusubtype_ALL
17551 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17552 one controlled by the @option{-mcpu} or @option{-march} option.
17554 @item -allowable_client  @var{client_name}
17555 @itemx -client_name
17556 @itemx -compatibility_version
17557 @itemx -current_version
17558 @itemx -dead_strip
17559 @itemx -dependency-file
17560 @itemx -dylib_file
17561 @itemx -dylinker_install_name
17562 @itemx -dynamic
17563 @itemx -exported_symbols_list
17564 @itemx -filelist
17565 @need 800
17566 @itemx -flat_namespace
17567 @itemx -force_flat_namespace
17568 @itemx -headerpad_max_install_names
17569 @itemx -image_base
17570 @itemx -init
17571 @itemx -install_name
17572 @itemx -keep_private_externs
17573 @itemx -multi_module
17574 @itemx -multiply_defined
17575 @itemx -multiply_defined_unused
17576 @need 800
17577 @itemx -noall_load
17578 @itemx -no_dead_strip_inits_and_terms
17579 @itemx -nofixprebinding
17580 @itemx -nomultidefs
17581 @itemx -noprebind
17582 @itemx -noseglinkedit
17583 @itemx -pagezero_size
17584 @itemx -prebind
17585 @itemx -prebind_all_twolevel_modules
17586 @itemx -private_bundle
17587 @need 800
17588 @itemx -read_only_relocs
17589 @itemx -sectalign
17590 @itemx -sectobjectsymbols
17591 @itemx -whyload
17592 @itemx -seg1addr
17593 @itemx -sectcreate
17594 @itemx -sectobjectsymbols
17595 @itemx -sectorder
17596 @itemx -segaddr
17597 @itemx -segs_read_only_addr
17598 @need 800
17599 @itemx -segs_read_write_addr
17600 @itemx -seg_addr_table
17601 @itemx -seg_addr_table_filename
17602 @itemx -seglinkedit
17603 @itemx -segprot
17604 @itemx -segs_read_only_addr
17605 @itemx -segs_read_write_addr
17606 @itemx -single_module
17607 @itemx -static
17608 @itemx -sub_library
17609 @need 800
17610 @itemx -sub_umbrella
17611 @itemx -twolevel_namespace
17612 @itemx -umbrella
17613 @itemx -undefined
17614 @itemx -unexported_symbols_list
17615 @itemx -weak_reference_mismatches
17616 @itemx -whatsloaded
17617 @opindex allowable_client
17618 @opindex client_name
17619 @opindex compatibility_version
17620 @opindex current_version
17621 @opindex dead_strip
17622 @opindex dependency-file
17623 @opindex dylib_file
17624 @opindex dylinker_install_name
17625 @opindex dynamic
17626 @opindex exported_symbols_list
17627 @opindex filelist
17628 @opindex flat_namespace
17629 @opindex force_flat_namespace
17630 @opindex headerpad_max_install_names
17631 @opindex image_base
17632 @opindex init
17633 @opindex install_name
17634 @opindex keep_private_externs
17635 @opindex multi_module
17636 @opindex multiply_defined
17637 @opindex multiply_defined_unused
17638 @opindex noall_load
17639 @opindex no_dead_strip_inits_and_terms
17640 @opindex nofixprebinding
17641 @opindex nomultidefs
17642 @opindex noprebind
17643 @opindex noseglinkedit
17644 @opindex pagezero_size
17645 @opindex prebind
17646 @opindex prebind_all_twolevel_modules
17647 @opindex private_bundle
17648 @opindex read_only_relocs
17649 @opindex sectalign
17650 @opindex sectobjectsymbols
17651 @opindex whyload
17652 @opindex seg1addr
17653 @opindex sectcreate
17654 @opindex sectobjectsymbols
17655 @opindex sectorder
17656 @opindex segaddr
17657 @opindex segs_read_only_addr
17658 @opindex segs_read_write_addr
17659 @opindex seg_addr_table
17660 @opindex seg_addr_table_filename
17661 @opindex seglinkedit
17662 @opindex segprot
17663 @opindex segs_read_only_addr
17664 @opindex segs_read_write_addr
17665 @opindex single_module
17666 @opindex static
17667 @opindex sub_library
17668 @opindex sub_umbrella
17669 @opindex twolevel_namespace
17670 @opindex umbrella
17671 @opindex undefined
17672 @opindex unexported_symbols_list
17673 @opindex weak_reference_mismatches
17674 @opindex whatsloaded
17675 These options are passed to the Darwin linker.  The Darwin linker man page
17676 describes them in detail.
17677 @end table
17679 @node DEC Alpha Options
17680 @subsection DEC Alpha Options
17682 These @samp{-m} options are defined for the DEC Alpha implementations:
17684 @table @gcctabopt
17685 @item -mno-soft-float
17686 @itemx -msoft-float
17687 @opindex mno-soft-float
17688 @opindex msoft-float
17689 Use (do not use) the hardware floating-point instructions for
17690 floating-point operations.  When @option{-msoft-float} is specified,
17691 functions in @file{libgcc.a} are used to perform floating-point
17692 operations.  Unless they are replaced by routines that emulate the
17693 floating-point operations, or compiled in such a way as to call such
17694 emulations routines, these routines issue floating-point
17695 operations.   If you are compiling for an Alpha without floating-point
17696 operations, you must ensure that the library is built so as not to call
17697 them.
17699 Note that Alpha implementations without floating-point operations are
17700 required to have floating-point registers.
17702 @item -mfp-reg
17703 @itemx -mno-fp-regs
17704 @opindex mfp-reg
17705 @opindex mno-fp-regs
17706 Generate code that uses (does not use) the floating-point register set.
17707 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17708 register set is not used, floating-point operands are passed in integer
17709 registers as if they were integers and floating-point results are passed
17710 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17711 so any function with a floating-point argument or return value called by code
17712 compiled with @option{-mno-fp-regs} must also be compiled with that
17713 option.
17715 A typical use of this option is building a kernel that does not use,
17716 and hence need not save and restore, any floating-point registers.
17718 @item -mieee
17719 @opindex mieee
17720 The Alpha architecture implements floating-point hardware optimized for
17721 maximum performance.  It is mostly compliant with the IEEE floating-point
17722 standard.  However, for full compliance, software assistance is
17723 required.  This option generates code fully IEEE-compliant code
17724 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17725 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17726 defined during compilation.  The resulting code is less efficient but is
17727 able to correctly support denormalized numbers and exceptional IEEE
17728 values such as not-a-number and plus/minus infinity.  Other Alpha
17729 compilers call this option @option{-ieee_with_no_inexact}.
17731 @item -mieee-with-inexact
17732 @opindex mieee-with-inexact
17733 This is like @option{-mieee} except the generated code also maintains
17734 the IEEE @var{inexact-flag}.  Turning on this option causes the
17735 generated code to implement fully-compliant IEEE math.  In addition to
17736 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17737 macro.  On some Alpha implementations the resulting code may execute
17738 significantly slower than the code generated by default.  Since there is
17739 very little code that depends on the @var{inexact-flag}, you should
17740 normally not specify this option.  Other Alpha compilers call this
17741 option @option{-ieee_with_inexact}.
17743 @item -mfp-trap-mode=@var{trap-mode}
17744 @opindex mfp-trap-mode
17745 This option controls what floating-point related traps are enabled.
17746 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17747 The trap mode can be set to one of four values:
17749 @table @samp
17750 @item n
17751 This is the default (normal) setting.  The only traps that are enabled
17752 are the ones that cannot be disabled in software (e.g., division by zero
17753 trap).
17755 @item u
17756 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17757 as well.
17759 @item su
17760 Like @samp{u}, but the instructions are marked to be safe for software
17761 completion (see Alpha architecture manual for details).
17763 @item sui
17764 Like @samp{su}, but inexact traps are enabled as well.
17765 @end table
17767 @item -mfp-rounding-mode=@var{rounding-mode}
17768 @opindex mfp-rounding-mode
17769 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17770 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17773 @table @samp
17774 @item n
17775 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17776 the nearest machine number or towards the even machine number in case
17777 of a tie.
17779 @item m
17780 Round towards minus infinity.
17782 @item c
17783 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17785 @item d
17786 Dynamic rounding mode.  A field in the floating-point control register
17787 (@var{fpcr}, see Alpha architecture reference manual) controls the
17788 rounding mode in effect.  The C library initializes this register for
17789 rounding towards plus infinity.  Thus, unless your program modifies the
17790 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17791 @end table
17793 @item -mtrap-precision=@var{trap-precision}
17794 @opindex mtrap-precision
17795 In the Alpha architecture, floating-point traps are imprecise.  This
17796 means without software assistance it is impossible to recover from a
17797 floating trap and program execution normally needs to be terminated.
17798 GCC can generate code that can assist operating system trap handlers
17799 in determining the exact location that caused a floating-point trap.
17800 Depending on the requirements of an application, different levels of
17801 precisions can be selected:
17803 @table @samp
17804 @item p
17805 Program precision.  This option is the default and means a trap handler
17806 can only identify which program caused a floating-point exception.
17808 @item f
17809 Function precision.  The trap handler can determine the function that
17810 caused a floating-point exception.
17812 @item i
17813 Instruction precision.  The trap handler can determine the exact
17814 instruction that caused a floating-point exception.
17815 @end table
17817 Other Alpha compilers provide the equivalent options called
17818 @option{-scope_safe} and @option{-resumption_safe}.
17820 @item -mieee-conformant
17821 @opindex mieee-conformant
17822 This option marks the generated code as IEEE conformant.  You must not
17823 use this option unless you also specify @option{-mtrap-precision=i} and either
17824 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17825 is to emit the line @samp{.eflag 48} in the function prologue of the
17826 generated assembly file.
17828 @item -mbuild-constants
17829 @opindex mbuild-constants
17830 Normally GCC examines a 32- or 64-bit integer constant to
17831 see if it can construct it from smaller constants in two or three
17832 instructions.  If it cannot, it outputs the constant as a literal and
17833 generates code to load it from the data segment at run time.
17835 Use this option to require GCC to construct @emph{all} integer constants
17836 using code, even if it takes more instructions (the maximum is six).
17838 You typically use this option to build a shared library dynamic
17839 loader.  Itself a shared library, it must relocate itself in memory
17840 before it can find the variables and constants in its own data segment.
17842 @item -mbwx
17843 @itemx -mno-bwx
17844 @itemx -mcix
17845 @itemx -mno-cix
17846 @itemx -mfix
17847 @itemx -mno-fix
17848 @itemx -mmax
17849 @itemx -mno-max
17850 @opindex mbwx
17851 @opindex mno-bwx
17852 @opindex mcix
17853 @opindex mno-cix
17854 @opindex mfix
17855 @opindex mno-fix
17856 @opindex mmax
17857 @opindex mno-max
17858 Indicate whether GCC should generate code to use the optional BWX,
17859 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17860 sets supported by the CPU type specified via @option{-mcpu=} option or that
17861 of the CPU on which GCC was built if none is specified.
17863 @item -mfloat-vax
17864 @itemx -mfloat-ieee
17865 @opindex mfloat-vax
17866 @opindex mfloat-ieee
17867 Generate code that uses (does not use) VAX F and G floating-point
17868 arithmetic instead of IEEE single and double precision.
17870 @item -mexplicit-relocs
17871 @itemx -mno-explicit-relocs
17872 @opindex mexplicit-relocs
17873 @opindex mno-explicit-relocs
17874 Older Alpha assemblers provided no way to generate symbol relocations
17875 except via assembler macros.  Use of these macros does not allow
17876 optimal instruction scheduling.  GNU binutils as of version 2.12
17877 supports a new syntax that allows the compiler to explicitly mark
17878 which relocations should apply to which instructions.  This option
17879 is mostly useful for debugging, as GCC detects the capabilities of
17880 the assembler when it is built and sets the default accordingly.
17882 @item -msmall-data
17883 @itemx -mlarge-data
17884 @opindex msmall-data
17885 @opindex mlarge-data
17886 When @option{-mexplicit-relocs} is in effect, static data is
17887 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17888 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17889 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17890 16-bit relocations off of the @code{$gp} register.  This limits the
17891 size of the small data area to 64KB, but allows the variables to be
17892 directly accessed via a single instruction.
17894 The default is @option{-mlarge-data}.  With this option the data area
17895 is limited to just below 2GB@.  Programs that require more than 2GB of
17896 data must use @code{malloc} or @code{mmap} to allocate the data in the
17897 heap instead of in the program's data segment.
17899 When generating code for shared libraries, @option{-fpic} implies
17900 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17902 @item -msmall-text
17903 @itemx -mlarge-text
17904 @opindex msmall-text
17905 @opindex mlarge-text
17906 When @option{-msmall-text} is used, the compiler assumes that the
17907 code of the entire program (or shared library) fits in 4MB, and is
17908 thus reachable with a branch instruction.  When @option{-msmall-data}
17909 is used, the compiler can assume that all local symbols share the
17910 same @code{$gp} value, and thus reduce the number of instructions
17911 required for a function call from 4 to 1.
17913 The default is @option{-mlarge-text}.
17915 @item -mcpu=@var{cpu_type}
17916 @opindex mcpu
17917 Set the instruction set and instruction scheduling parameters for
17918 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17919 style name or the corresponding chip number.  GCC supports scheduling
17920 parameters for the EV4, EV5 and EV6 family of processors and
17921 chooses the default values for the instruction set from the processor
17922 you specify.  If you do not specify a processor type, GCC defaults
17923 to the processor on which the compiler was built.
17925 Supported values for @var{cpu_type} are
17927 @table @samp
17928 @item ev4
17929 @itemx ev45
17930 @itemx 21064
17931 Schedules as an EV4 and has no instruction set extensions.
17933 @item ev5
17934 @itemx 21164
17935 Schedules as an EV5 and has no instruction set extensions.
17937 @item ev56
17938 @itemx 21164a
17939 Schedules as an EV5 and supports the BWX extension.
17941 @item pca56
17942 @itemx 21164pc
17943 @itemx 21164PC
17944 Schedules as an EV5 and supports the BWX and MAX extensions.
17946 @item ev6
17947 @itemx 21264
17948 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17950 @item ev67
17951 @itemx 21264a
17952 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17953 @end table
17955 Native toolchains also support the value @samp{native},
17956 which selects the best architecture option for the host processor.
17957 @option{-mcpu=native} has no effect if GCC does not recognize
17958 the processor.
17960 @item -mtune=@var{cpu_type}
17961 @opindex mtune
17962 Set only the instruction scheduling parameters for machine type
17963 @var{cpu_type}.  The instruction set is not changed.
17965 Native toolchains also support the value @samp{native},
17966 which selects the best architecture option for the host processor.
17967 @option{-mtune=native} has no effect if GCC does not recognize
17968 the processor.
17970 @item -mmemory-latency=@var{time}
17971 @opindex mmemory-latency
17972 Sets the latency the scheduler should assume for typical memory
17973 references as seen by the application.  This number is highly
17974 dependent on the memory access patterns used by the application
17975 and the size of the external cache on the machine.
17977 Valid options for @var{time} are
17979 @table @samp
17980 @item @var{number}
17981 A decimal number representing clock cycles.
17983 @item L1
17984 @itemx L2
17985 @itemx L3
17986 @itemx main
17987 The compiler contains estimates of the number of clock cycles for
17988 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17989 (also called Dcache, Scache, and Bcache), as well as to main memory.
17990 Note that L3 is only valid for EV5.
17992 @end table
17993 @end table
17995 @node FR30 Options
17996 @subsection FR30 Options
17997 @cindex FR30 Options
17999 These options are defined specifically for the FR30 port.
18001 @table @gcctabopt
18003 @item -msmall-model
18004 @opindex msmall-model
18005 Use the small address space model.  This can produce smaller code, but
18006 it does assume that all symbolic values and addresses fit into a
18007 20-bit range.
18009 @item -mno-lsim
18010 @opindex mno-lsim
18011 Assume that runtime support has been provided and so there is no need
18012 to include the simulator library (@file{libsim.a}) on the linker
18013 command line.
18015 @end table
18017 @node FT32 Options
18018 @subsection FT32 Options
18019 @cindex FT32 Options
18021 These options are defined specifically for the FT32 port.
18023 @table @gcctabopt
18025 @item -msim
18026 @opindex msim
18027 Specifies that the program will be run on the simulator.  This causes
18028 an alternate runtime startup and library to be linked.
18029 You must not use this option when generating programs that will run on
18030 real hardware; you must provide your own runtime library for whatever
18031 I/O functions are needed.
18033 @item -mlra
18034 @opindex mlra
18035 Enable Local Register Allocation.  This is still experimental for FT32,
18036 so by default the compiler uses standard reload.
18038 @item -mnodiv
18039 @opindex mnodiv
18040 Do not use div and mod instructions.
18042 @item -mft32b
18043 @opindex mft32b
18044 Enable use of the extended instructions of the FT32B processor.
18046 @item -mcompress
18047 @opindex mcompress
18048 Compress all code using the Ft32B code compression scheme.
18050 @item -mnopm
18051 @opindex  mnopm
18052 Do not generate code that reads program memory.
18054 @end table
18056 @node FRV Options
18057 @subsection FRV Options
18058 @cindex FRV Options
18060 @table @gcctabopt
18061 @item -mgpr-32
18062 @opindex mgpr-32
18064 Only use the first 32 general-purpose registers.
18066 @item -mgpr-64
18067 @opindex mgpr-64
18069 Use all 64 general-purpose registers.
18071 @item -mfpr-32
18072 @opindex mfpr-32
18074 Use only the first 32 floating-point registers.
18076 @item -mfpr-64
18077 @opindex mfpr-64
18079 Use all 64 floating-point registers.
18081 @item -mhard-float
18082 @opindex mhard-float
18084 Use hardware instructions for floating-point operations.
18086 @item -msoft-float
18087 @opindex msoft-float
18089 Use library routines for floating-point operations.
18091 @item -malloc-cc
18092 @opindex malloc-cc
18094 Dynamically allocate condition code registers.
18096 @item -mfixed-cc
18097 @opindex mfixed-cc
18099 Do not try to dynamically allocate condition code registers, only
18100 use @code{icc0} and @code{fcc0}.
18102 @item -mdword
18103 @opindex mdword
18105 Change ABI to use double word insns.
18107 @item -mno-dword
18108 @opindex mno-dword
18110 Do not use double word instructions.
18112 @item -mdouble
18113 @opindex mdouble
18115 Use floating-point double instructions.
18117 @item -mno-double
18118 @opindex mno-double
18120 Do not use floating-point double instructions.
18122 @item -mmedia
18123 @opindex mmedia
18125 Use media instructions.
18127 @item -mno-media
18128 @opindex mno-media
18130 Do not use media instructions.
18132 @item -mmuladd
18133 @opindex mmuladd
18135 Use multiply and add/subtract instructions.
18137 @item -mno-muladd
18138 @opindex mno-muladd
18140 Do not use multiply and add/subtract instructions.
18142 @item -mfdpic
18143 @opindex mfdpic
18145 Select the FDPIC ABI, which uses function descriptors to represent
18146 pointers to functions.  Without any PIC/PIE-related options, it
18147 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
18148 assumes GOT entries and small data are within a 12-bit range from the
18149 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
18150 are computed with 32 bits.
18151 With a @samp{bfin-elf} target, this option implies @option{-msim}.
18153 @item -minline-plt
18154 @opindex minline-plt
18156 Enable inlining of PLT entries in function calls to functions that are
18157 not known to bind locally.  It has no effect without @option{-mfdpic}.
18158 It's enabled by default if optimizing for speed and compiling for
18159 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
18160 optimization option such as @option{-O3} or above is present in the
18161 command line.
18163 @item -mTLS
18164 @opindex mTLS
18166 Assume a large TLS segment when generating thread-local code.
18168 @item -mtls
18169 @opindex mtls
18171 Do not assume a large TLS segment when generating thread-local code.
18173 @item -mgprel-ro
18174 @opindex mgprel-ro
18176 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
18177 that is known to be in read-only sections.  It's enabled by default,
18178 except for @option{-fpic} or @option{-fpie}: even though it may help
18179 make the global offset table smaller, it trades 1 instruction for 4.
18180 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
18181 one of which may be shared by multiple symbols, and it avoids the need
18182 for a GOT entry for the referenced symbol, so it's more likely to be a
18183 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
18185 @item -multilib-library-pic
18186 @opindex multilib-library-pic
18188 Link with the (library, not FD) pic libraries.  It's implied by
18189 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
18190 @option{-fpic} without @option{-mfdpic}.  You should never have to use
18191 it explicitly.
18193 @item -mlinked-fp
18194 @opindex mlinked-fp
18196 Follow the EABI requirement of always creating a frame pointer whenever
18197 a stack frame is allocated.  This option is enabled by default and can
18198 be disabled with @option{-mno-linked-fp}.
18200 @item -mlong-calls
18201 @opindex mlong-calls
18203 Use indirect addressing to call functions outside the current
18204 compilation unit.  This allows the functions to be placed anywhere
18205 within the 32-bit address space.
18207 @item -malign-labels
18208 @opindex malign-labels
18210 Try to align labels to an 8-byte boundary by inserting NOPs into the
18211 previous packet.  This option only has an effect when VLIW packing
18212 is enabled.  It doesn't create new packets; it merely adds NOPs to
18213 existing ones.
18215 @item -mlibrary-pic
18216 @opindex mlibrary-pic
18218 Generate position-independent EABI code.
18220 @item -macc-4
18221 @opindex macc-4
18223 Use only the first four media accumulator registers.
18225 @item -macc-8
18226 @opindex macc-8
18228 Use all eight media accumulator registers.
18230 @item -mpack
18231 @opindex mpack
18233 Pack VLIW instructions.
18235 @item -mno-pack
18236 @opindex mno-pack
18238 Do not pack VLIW instructions.
18240 @item -mno-eflags
18241 @opindex mno-eflags
18243 Do not mark ABI switches in e_flags.
18245 @item -mcond-move
18246 @opindex mcond-move
18248 Enable the use of conditional-move instructions (default).
18250 This switch is mainly for debugging the compiler and will likely be removed
18251 in a future version.
18253 @item -mno-cond-move
18254 @opindex mno-cond-move
18256 Disable the use of conditional-move instructions.
18258 This switch is mainly for debugging the compiler and will likely be removed
18259 in a future version.
18261 @item -mscc
18262 @opindex mscc
18264 Enable the use of conditional set instructions (default).
18266 This switch is mainly for debugging the compiler and will likely be removed
18267 in a future version.
18269 @item -mno-scc
18270 @opindex mno-scc
18272 Disable the use of conditional set instructions.
18274 This switch is mainly for debugging the compiler and will likely be removed
18275 in a future version.
18277 @item -mcond-exec
18278 @opindex mcond-exec
18280 Enable the use of conditional execution (default).
18282 This switch is mainly for debugging the compiler and will likely be removed
18283 in a future version.
18285 @item -mno-cond-exec
18286 @opindex mno-cond-exec
18288 Disable the use of conditional execution.
18290 This switch is mainly for debugging the compiler and will likely be removed
18291 in a future version.
18293 @item -mvliw-branch
18294 @opindex mvliw-branch
18296 Run a pass to pack branches into VLIW instructions (default).
18298 This switch is mainly for debugging the compiler and will likely be removed
18299 in a future version.
18301 @item -mno-vliw-branch
18302 @opindex mno-vliw-branch
18304 Do not run a pass to pack branches into VLIW instructions.
18306 This switch is mainly for debugging the compiler and will likely be removed
18307 in a future version.
18309 @item -mmulti-cond-exec
18310 @opindex mmulti-cond-exec
18312 Enable optimization of @code{&&} and @code{||} in conditional execution
18313 (default).
18315 This switch is mainly for debugging the compiler and will likely be removed
18316 in a future version.
18318 @item -mno-multi-cond-exec
18319 @opindex mno-multi-cond-exec
18321 Disable optimization of @code{&&} and @code{||} in conditional execution.
18323 This switch is mainly for debugging the compiler and will likely be removed
18324 in a future version.
18326 @item -mnested-cond-exec
18327 @opindex mnested-cond-exec
18329 Enable nested conditional execution optimizations (default).
18331 This switch is mainly for debugging the compiler and will likely be removed
18332 in a future version.
18334 @item -mno-nested-cond-exec
18335 @opindex mno-nested-cond-exec
18337 Disable nested conditional execution optimizations.
18339 This switch is mainly for debugging the compiler and will likely be removed
18340 in a future version.
18342 @item -moptimize-membar
18343 @opindex moptimize-membar
18345 This switch removes redundant @code{membar} instructions from the
18346 compiler-generated code.  It is enabled by default.
18348 @item -mno-optimize-membar
18349 @opindex mno-optimize-membar
18351 This switch disables the automatic removal of redundant @code{membar}
18352 instructions from the generated code.
18354 @item -mtomcat-stats
18355 @opindex mtomcat-stats
18357 Cause gas to print out tomcat statistics.
18359 @item -mcpu=@var{cpu}
18360 @opindex mcpu
18362 Select the processor type for which to generate code.  Possible values are
18363 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
18364 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
18366 @end table
18368 @node GNU/Linux Options
18369 @subsection GNU/Linux Options
18371 These @samp{-m} options are defined for GNU/Linux targets:
18373 @table @gcctabopt
18374 @item -mglibc
18375 @opindex mglibc
18376 Use the GNU C library.  This is the default except
18377 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18378 @samp{*-*-linux-*android*} targets.
18380 @item -muclibc
18381 @opindex muclibc
18382 Use uClibc C library.  This is the default on
18383 @samp{*-*-linux-*uclibc*} targets.
18385 @item -mmusl
18386 @opindex mmusl
18387 Use the musl C library.  This is the default on
18388 @samp{*-*-linux-*musl*} targets.
18390 @item -mbionic
18391 @opindex mbionic
18392 Use Bionic C library.  This is the default on
18393 @samp{*-*-linux-*android*} targets.
18395 @item -mandroid
18396 @opindex mandroid
18397 Compile code compatible with Android platform.  This is the default on
18398 @samp{*-*-linux-*android*} targets.
18400 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18401 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18402 this option makes the GCC driver pass Android-specific options to the linker.
18403 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18404 to be defined.
18406 @item -tno-android-cc
18407 @opindex tno-android-cc
18408 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18409 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18410 @option{-fno-rtti} by default.
18412 @item -tno-android-ld
18413 @opindex tno-android-ld
18414 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18415 linking options to the linker.
18417 @end table
18419 @node H8/300 Options
18420 @subsection H8/300 Options
18422 These @samp{-m} options are defined for the H8/300 implementations:
18424 @table @gcctabopt
18425 @item -mrelax
18426 @opindex mrelax
18427 Shorten some address references at link time, when possible; uses the
18428 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18429 ld, Using ld}, for a fuller description.
18431 @item -mh
18432 @opindex mh
18433 Generate code for the H8/300H@.
18435 @item -ms
18436 @opindex ms
18437 Generate code for the H8S@.
18439 @item -mn
18440 @opindex mn
18441 Generate code for the H8S and H8/300H in the normal mode.  This switch
18442 must be used either with @option{-mh} or @option{-ms}.
18444 @item -ms2600
18445 @opindex ms2600
18446 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18448 @item -mexr
18449 @opindex mexr
18450 Extended registers are stored on stack before execution of function
18451 with monitor attribute. Default option is @option{-mexr}.
18452 This option is valid only for H8S targets.
18454 @item -mno-exr
18455 @opindex mno-exr
18456 Extended registers are not stored on stack before execution of function 
18457 with monitor attribute. Default option is @option{-mno-exr}. 
18458 This option is valid only for H8S targets.
18460 @item -mint32
18461 @opindex mint32
18462 Make @code{int} data 32 bits by default.
18464 @item -malign-300
18465 @opindex malign-300
18466 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18467 The default for the H8/300H and H8S is to align longs and floats on
18468 4-byte boundaries.
18469 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18470 This option has no effect on the H8/300.
18471 @end table
18473 @node HPPA Options
18474 @subsection HPPA Options
18475 @cindex HPPA Options
18477 These @samp{-m} options are defined for the HPPA family of computers:
18479 @table @gcctabopt
18480 @item -march=@var{architecture-type}
18481 @opindex march
18482 Generate code for the specified architecture.  The choices for
18483 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18484 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18485 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18486 architecture option for your machine.  Code compiled for lower numbered
18487 architectures runs on higher numbered architectures, but not the
18488 other way around.
18490 @item -mpa-risc-1-0
18491 @itemx -mpa-risc-1-1
18492 @itemx -mpa-risc-2-0
18493 @opindex mpa-risc-1-0
18494 @opindex mpa-risc-1-1
18495 @opindex mpa-risc-2-0
18496 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18498 @item -mcaller-copies
18499 @opindex mcaller-copies
18500 The caller copies function arguments passed by hidden reference.  This
18501 option should be used with care as it is not compatible with the default
18502 32-bit runtime.  However, only aggregates larger than eight bytes are
18503 passed by hidden reference and the option provides better compatibility
18504 with OpenMP.
18506 @item -mjump-in-delay
18507 @opindex mjump-in-delay
18508 This option is ignored and provided for compatibility purposes only.
18510 @item -mdisable-fpregs
18511 @opindex mdisable-fpregs
18512 Prevent floating-point registers from being used in any manner.  This is
18513 necessary for compiling kernels that perform lazy context switching of
18514 floating-point registers.  If you use this option and attempt to perform
18515 floating-point operations, the compiler aborts.
18517 @item -mdisable-indexing
18518 @opindex mdisable-indexing
18519 Prevent the compiler from using indexing address modes.  This avoids some
18520 rather obscure problems when compiling MIG generated code under MACH@.
18522 @item -mno-space-regs
18523 @opindex mno-space-regs
18524 Generate code that assumes the target has no space registers.  This allows
18525 GCC to generate faster indirect calls and use unscaled index address modes.
18527 Such code is suitable for level 0 PA systems and kernels.
18529 @item -mfast-indirect-calls
18530 @opindex mfast-indirect-calls
18531 Generate code that assumes calls never cross space boundaries.  This
18532 allows GCC to emit code that performs faster indirect calls.
18534 This option does not work in the presence of shared libraries or nested
18535 functions.
18537 @item -mfixed-range=@var{register-range}
18538 @opindex mfixed-range
18539 Generate code treating the given register range as fixed registers.
18540 A fixed register is one that the register allocator cannot use.  This is
18541 useful when compiling kernel code.  A register range is specified as
18542 two registers separated by a dash.  Multiple register ranges can be
18543 specified separated by a comma.
18545 @item -mlong-load-store
18546 @opindex mlong-load-store
18547 Generate 3-instruction load and store sequences as sometimes required by
18548 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18549 the HP compilers.
18551 @item -mportable-runtime
18552 @opindex mportable-runtime
18553 Use the portable calling conventions proposed by HP for ELF systems.
18555 @item -mgas
18556 @opindex mgas
18557 Enable the use of assembler directives only GAS understands.
18559 @item -mschedule=@var{cpu-type}
18560 @opindex mschedule
18561 Schedule code according to the constraints for the machine type
18562 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18563 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18564 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18565 proper scheduling option for your machine.  The default scheduling is
18566 @samp{8000}.
18568 @item -mlinker-opt
18569 @opindex mlinker-opt
18570 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18571 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18572 linkers in which they give bogus error messages when linking some programs.
18574 @item -msoft-float
18575 @opindex msoft-float
18576 Generate output containing library calls for floating point.
18577 @strong{Warning:} the requisite libraries are not available for all HPPA
18578 targets.  Normally the facilities of the machine's usual C compiler are
18579 used, but this cannot be done directly in cross-compilation.  You must make
18580 your own arrangements to provide suitable library functions for
18581 cross-compilation.
18583 @option{-msoft-float} changes the calling convention in the output file;
18584 therefore, it is only useful if you compile @emph{all} of a program with
18585 this option.  In particular, you need to compile @file{libgcc.a}, the
18586 library that comes with GCC, with @option{-msoft-float} in order for
18587 this to work.
18589 @item -msio
18590 @opindex msio
18591 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18592 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18593 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18594 options are available under HP-UX and HI-UX@.
18596 @item -mgnu-ld
18597 @opindex mgnu-ld
18598 Use options specific to GNU @command{ld}.
18599 This passes @option{-shared} to @command{ld} when
18600 building a shared library.  It is the default when GCC is configured,
18601 explicitly or implicitly, with the GNU linker.  This option does not
18602 affect which @command{ld} is called; it only changes what parameters
18603 are passed to that @command{ld}.
18604 The @command{ld} that is called is determined by the
18605 @option{--with-ld} configure option, GCC's program search path, and
18606 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18607 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18608 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18610 @item -mhp-ld
18611 @opindex mhp-ld
18612 Use options specific to HP @command{ld}.
18613 This passes @option{-b} to @command{ld} when building
18614 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18615 links.  It is the default when GCC is configured, explicitly or
18616 implicitly, with the HP linker.  This option does not affect
18617 which @command{ld} is called; it only changes what parameters are passed to that
18618 @command{ld}.
18619 The @command{ld} that is called is determined by the @option{--with-ld}
18620 configure option, GCC's program search path, and finally by the user's
18621 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18622 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18623 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18625 @item -mlong-calls
18626 @opindex mno-long-calls
18627 Generate code that uses long call sequences.  This ensures that a call
18628 is always able to reach linker generated stubs.  The default is to generate
18629 long calls only when the distance from the call site to the beginning
18630 of the function or translation unit, as the case may be, exceeds a
18631 predefined limit set by the branch type being used.  The limits for
18632 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18633 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18634 240,000 bytes.
18636 Distances are measured from the beginning of functions when using the
18637 @option{-ffunction-sections} option, or when using the @option{-mgas}
18638 and @option{-mno-portable-runtime} options together under HP-UX with
18639 the SOM linker.
18641 It is normally not desirable to use this option as it degrades
18642 performance.  However, it may be useful in large applications,
18643 particularly when partial linking is used to build the application.
18645 The types of long calls used depends on the capabilities of the
18646 assembler and linker, and the type of code being generated.  The
18647 impact on systems that support long absolute calls, and long pic
18648 symbol-difference or pc-relative calls should be relatively small.
18649 However, an indirect call is used on 32-bit ELF systems in pic code
18650 and it is quite long.
18652 @item -munix=@var{unix-std}
18653 @opindex march
18654 Generate compiler predefines and select a startfile for the specified
18655 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18656 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18657 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18658 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18659 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18660 and later.
18662 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18663 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18664 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18665 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18666 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18667 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18669 It is @emph{important} to note that this option changes the interfaces
18670 for various library routines.  It also affects the operational behavior
18671 of the C library.  Thus, @emph{extreme} care is needed in using this
18672 option.
18674 Library code that is intended to operate with more than one UNIX
18675 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18676 as appropriate.  Most GNU software doesn't provide this capability.
18678 @item -nolibdld
18679 @opindex nolibdld
18680 Suppress the generation of link options to search libdld.sl when the
18681 @option{-static} option is specified on HP-UX 10 and later.
18683 @item -static
18684 @opindex static
18685 The HP-UX implementation of setlocale in libc has a dependency on
18686 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18687 when the @option{-static} option is specified, special link options
18688 are needed to resolve this dependency.
18690 On HP-UX 10 and later, the GCC driver adds the necessary options to
18691 link with libdld.sl when the @option{-static} option is specified.
18692 This causes the resulting binary to be dynamic.  On the 64-bit port,
18693 the linkers generate dynamic binaries by default in any case.  The
18694 @option{-nolibdld} option can be used to prevent the GCC driver from
18695 adding these link options.
18697 @item -threads
18698 @opindex threads
18699 Add support for multithreading with the @dfn{dce thread} library
18700 under HP-UX@.  This option sets flags for both the preprocessor and
18701 linker.
18702 @end table
18704 @node IA-64 Options
18705 @subsection IA-64 Options
18706 @cindex IA-64 Options
18708 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18710 @table @gcctabopt
18711 @item -mbig-endian
18712 @opindex mbig-endian
18713 Generate code for a big-endian target.  This is the default for HP-UX@.
18715 @item -mlittle-endian
18716 @opindex mlittle-endian
18717 Generate code for a little-endian target.  This is the default for AIX5
18718 and GNU/Linux.
18720 @item -mgnu-as
18721 @itemx -mno-gnu-as
18722 @opindex mgnu-as
18723 @opindex mno-gnu-as
18724 Generate (or don't) code for the GNU assembler.  This is the default.
18725 @c Also, this is the default if the configure option @option{--with-gnu-as}
18726 @c is used.
18728 @item -mgnu-ld
18729 @itemx -mno-gnu-ld
18730 @opindex mgnu-ld
18731 @opindex mno-gnu-ld
18732 Generate (or don't) code for the GNU linker.  This is the default.
18733 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18734 @c is used.
18736 @item -mno-pic
18737 @opindex mno-pic
18738 Generate code that does not use a global pointer register.  The result
18739 is not position independent code, and violates the IA-64 ABI@.
18741 @item -mvolatile-asm-stop
18742 @itemx -mno-volatile-asm-stop
18743 @opindex mvolatile-asm-stop
18744 @opindex mno-volatile-asm-stop
18745 Generate (or don't) a stop bit immediately before and after volatile asm
18746 statements.
18748 @item -mregister-names
18749 @itemx -mno-register-names
18750 @opindex mregister-names
18751 @opindex mno-register-names
18752 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18753 the stacked registers.  This may make assembler output more readable.
18755 @item -mno-sdata
18756 @itemx -msdata
18757 @opindex mno-sdata
18758 @opindex msdata
18759 Disable (or enable) optimizations that use the small data section.  This may
18760 be useful for working around optimizer bugs.
18762 @item -mconstant-gp
18763 @opindex mconstant-gp
18764 Generate code that uses a single constant global pointer value.  This is
18765 useful when compiling kernel code.
18767 @item -mauto-pic
18768 @opindex mauto-pic
18769 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18770 This is useful when compiling firmware code.
18772 @item -minline-float-divide-min-latency
18773 @opindex minline-float-divide-min-latency
18774 Generate code for inline divides of floating-point values
18775 using the minimum latency algorithm.
18777 @item -minline-float-divide-max-throughput
18778 @opindex minline-float-divide-max-throughput
18779 Generate code for inline divides of floating-point values
18780 using the maximum throughput algorithm.
18782 @item -mno-inline-float-divide
18783 @opindex mno-inline-float-divide
18784 Do not generate inline code for divides of floating-point values.
18786 @item -minline-int-divide-min-latency
18787 @opindex minline-int-divide-min-latency
18788 Generate code for inline divides of integer values
18789 using the minimum latency algorithm.
18791 @item -minline-int-divide-max-throughput
18792 @opindex minline-int-divide-max-throughput
18793 Generate code for inline divides of integer values
18794 using the maximum throughput algorithm.
18796 @item -mno-inline-int-divide
18797 @opindex mno-inline-int-divide
18798 Do not generate inline code for divides of integer values.
18800 @item -minline-sqrt-min-latency
18801 @opindex minline-sqrt-min-latency
18802 Generate code for inline square roots
18803 using the minimum latency algorithm.
18805 @item -minline-sqrt-max-throughput
18806 @opindex minline-sqrt-max-throughput
18807 Generate code for inline square roots
18808 using the maximum throughput algorithm.
18810 @item -mno-inline-sqrt
18811 @opindex mno-inline-sqrt
18812 Do not generate inline code for @code{sqrt}.
18814 @item -mfused-madd
18815 @itemx -mno-fused-madd
18816 @opindex mfused-madd
18817 @opindex mno-fused-madd
18818 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18819 instructions.  The default is to use these instructions.
18821 @item -mno-dwarf2-asm
18822 @itemx -mdwarf2-asm
18823 @opindex mno-dwarf2-asm
18824 @opindex mdwarf2-asm
18825 Don't (or do) generate assembler code for the DWARF line number debugging
18826 info.  This may be useful when not using the GNU assembler.
18828 @item -mearly-stop-bits
18829 @itemx -mno-early-stop-bits
18830 @opindex mearly-stop-bits
18831 @opindex mno-early-stop-bits
18832 Allow stop bits to be placed earlier than immediately preceding the
18833 instruction that triggered the stop bit.  This can improve instruction
18834 scheduling, but does not always do so.
18836 @item -mfixed-range=@var{register-range}
18837 @opindex mfixed-range
18838 Generate code treating the given register range as fixed registers.
18839 A fixed register is one that the register allocator cannot use.  This is
18840 useful when compiling kernel code.  A register range is specified as
18841 two registers separated by a dash.  Multiple register ranges can be
18842 specified separated by a comma.
18844 @item -mtls-size=@var{tls-size}
18845 @opindex mtls-size
18846 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18849 @item -mtune=@var{cpu-type}
18850 @opindex mtune
18851 Tune the instruction scheduling for a particular CPU, Valid values are
18852 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18853 and @samp{mckinley}.
18855 @item -milp32
18856 @itemx -mlp64
18857 @opindex milp32
18858 @opindex mlp64
18859 Generate code for a 32-bit or 64-bit environment.
18860 The 32-bit environment sets int, long and pointer to 32 bits.
18861 The 64-bit environment sets int to 32 bits and long and pointer
18862 to 64 bits.  These are HP-UX specific flags.
18864 @item -mno-sched-br-data-spec
18865 @itemx -msched-br-data-spec
18866 @opindex mno-sched-br-data-spec
18867 @opindex msched-br-data-spec
18868 (Dis/En)able data speculative scheduling before reload.
18869 This results in generation of @code{ld.a} instructions and
18870 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18871 The default setting is disabled.
18873 @item -msched-ar-data-spec
18874 @itemx -mno-sched-ar-data-spec
18875 @opindex msched-ar-data-spec
18876 @opindex mno-sched-ar-data-spec
18877 (En/Dis)able data speculative scheduling after reload.
18878 This results in generation of @code{ld.a} instructions and
18879 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18880 The default setting is enabled.
18882 @item -mno-sched-control-spec
18883 @itemx -msched-control-spec
18884 @opindex mno-sched-control-spec
18885 @opindex msched-control-spec
18886 (Dis/En)able control speculative scheduling.  This feature is
18887 available only during region scheduling (i.e.@: before reload).
18888 This results in generation of the @code{ld.s} instructions and
18889 the corresponding check instructions @code{chk.s}.
18890 The default setting is disabled.
18892 @item -msched-br-in-data-spec
18893 @itemx -mno-sched-br-in-data-spec
18894 @opindex msched-br-in-data-spec
18895 @opindex mno-sched-br-in-data-spec
18896 (En/Dis)able speculative scheduling of the instructions that
18897 are dependent on the data speculative loads before reload.
18898 This is effective only with @option{-msched-br-data-spec} enabled.
18899 The default setting is enabled.
18901 @item -msched-ar-in-data-spec
18902 @itemx -mno-sched-ar-in-data-spec
18903 @opindex msched-ar-in-data-spec
18904 @opindex mno-sched-ar-in-data-spec
18905 (En/Dis)able speculative scheduling of the instructions that
18906 are dependent on the data speculative loads after reload.
18907 This is effective only with @option{-msched-ar-data-spec} enabled.
18908 The default setting is enabled.
18910 @item -msched-in-control-spec
18911 @itemx -mno-sched-in-control-spec
18912 @opindex msched-in-control-spec
18913 @opindex mno-sched-in-control-spec
18914 (En/Dis)able speculative scheduling of the instructions that
18915 are dependent on the control speculative loads.
18916 This is effective only with @option{-msched-control-spec} enabled.
18917 The default setting is enabled.
18919 @item -mno-sched-prefer-non-data-spec-insns
18920 @itemx -msched-prefer-non-data-spec-insns
18921 @opindex mno-sched-prefer-non-data-spec-insns
18922 @opindex msched-prefer-non-data-spec-insns
18923 If enabled, data-speculative instructions are chosen for schedule
18924 only if there are no other choices at the moment.  This makes
18925 the use of the data speculation much more conservative.
18926 The default setting is disabled.
18928 @item -mno-sched-prefer-non-control-spec-insns
18929 @itemx -msched-prefer-non-control-spec-insns
18930 @opindex mno-sched-prefer-non-control-spec-insns
18931 @opindex msched-prefer-non-control-spec-insns
18932 If enabled, control-speculative instructions are chosen for schedule
18933 only if there are no other choices at the moment.  This makes
18934 the use of the control speculation much more conservative.
18935 The default setting is disabled.
18937 @item -mno-sched-count-spec-in-critical-path
18938 @itemx -msched-count-spec-in-critical-path
18939 @opindex mno-sched-count-spec-in-critical-path
18940 @opindex msched-count-spec-in-critical-path
18941 If enabled, speculative dependencies are considered during
18942 computation of the instructions priorities.  This makes the use of the
18943 speculation a bit more conservative.
18944 The default setting is disabled.
18946 @item -msched-spec-ldc
18947 @opindex msched-spec-ldc
18948 Use a simple data speculation check.  This option is on by default.
18950 @item -msched-control-spec-ldc
18951 @opindex msched-spec-ldc
18952 Use a simple check for control speculation.  This option is on by default.
18954 @item -msched-stop-bits-after-every-cycle
18955 @opindex msched-stop-bits-after-every-cycle
18956 Place a stop bit after every cycle when scheduling.  This option is on
18957 by default.
18959 @item -msched-fp-mem-deps-zero-cost
18960 @opindex msched-fp-mem-deps-zero-cost
18961 Assume that floating-point stores and loads are not likely to cause a conflict
18962 when placed into the same instruction group.  This option is disabled by
18963 default.
18965 @item -msel-sched-dont-check-control-spec
18966 @opindex msel-sched-dont-check-control-spec
18967 Generate checks for control speculation in selective scheduling.
18968 This flag is disabled by default.
18970 @item -msched-max-memory-insns=@var{max-insns}
18971 @opindex msched-max-memory-insns
18972 Limit on the number of memory insns per instruction group, giving lower
18973 priority to subsequent memory insns attempting to schedule in the same
18974 instruction group. Frequently useful to prevent cache bank conflicts.
18975 The default value is 1.
18977 @item -msched-max-memory-insns-hard-limit
18978 @opindex msched-max-memory-insns-hard-limit
18979 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18980 disallowing more than that number in an instruction group.
18981 Otherwise, the limit is ``soft'', meaning that non-memory operations
18982 are preferred when the limit is reached, but memory operations may still
18983 be scheduled.
18985 @end table
18987 @node LM32 Options
18988 @subsection LM32 Options
18989 @cindex LM32 options
18991 These @option{-m} options are defined for the LatticeMico32 architecture:
18993 @table @gcctabopt
18994 @item -mbarrel-shift-enabled
18995 @opindex mbarrel-shift-enabled
18996 Enable barrel-shift instructions.
18998 @item -mdivide-enabled
18999 @opindex mdivide-enabled
19000 Enable divide and modulus instructions.
19002 @item -mmultiply-enabled
19003 @opindex multiply-enabled
19004 Enable multiply instructions.
19006 @item -msign-extend-enabled
19007 @opindex msign-extend-enabled
19008 Enable sign extend instructions.
19010 @item -muser-enabled
19011 @opindex muser-enabled
19012 Enable user-defined instructions.
19014 @end table
19016 @node M32C Options
19017 @subsection M32C Options
19018 @cindex M32C options
19020 @table @gcctabopt
19021 @item -mcpu=@var{name}
19022 @opindex mcpu=
19023 Select the CPU for which code is generated.  @var{name} may be one of
19024 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
19025 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
19026 the M32C/80 series.
19028 @item -msim
19029 @opindex msim
19030 Specifies that the program will be run on the simulator.  This causes
19031 an alternate runtime library to be linked in which supports, for
19032 example, file I/O@.  You must not use this option when generating
19033 programs that will run on real hardware; you must provide your own
19034 runtime library for whatever I/O functions are needed.
19036 @item -memregs=@var{number}
19037 @opindex memregs=
19038 Specifies the number of memory-based pseudo-registers GCC uses
19039 during code generation.  These pseudo-registers are used like real
19040 registers, so there is a tradeoff between GCC's ability to fit the
19041 code into available registers, and the performance penalty of using
19042 memory instead of registers.  Note that all modules in a program must
19043 be compiled with the same value for this option.  Because of that, you
19044 must not use this option with GCC's default runtime libraries.
19046 @end table
19048 @node M32R/D Options
19049 @subsection M32R/D Options
19050 @cindex M32R/D options
19052 These @option{-m} options are defined for Renesas M32R/D architectures:
19054 @table @gcctabopt
19055 @item -m32r2
19056 @opindex m32r2
19057 Generate code for the M32R/2@.
19059 @item -m32rx
19060 @opindex m32rx
19061 Generate code for the M32R/X@.
19063 @item -m32r
19064 @opindex m32r
19065 Generate code for the M32R@.  This is the default.
19067 @item -mmodel=small
19068 @opindex mmodel=small
19069 Assume all objects live in the lower 16MB of memory (so that their addresses
19070 can be loaded with the @code{ld24} instruction), and assume all subroutines
19071 are reachable with the @code{bl} instruction.
19072 This is the default.
19074 The addressability of a particular object can be set with the
19075 @code{model} attribute.
19077 @item -mmodel=medium
19078 @opindex mmodel=medium
19079 Assume objects may be anywhere in the 32-bit address space (the compiler
19080 generates @code{seth/add3} instructions to load their addresses), and
19081 assume all subroutines are reachable with the @code{bl} instruction.
19083 @item -mmodel=large
19084 @opindex mmodel=large
19085 Assume objects may be anywhere in the 32-bit address space (the compiler
19086 generates @code{seth/add3} instructions to load their addresses), and
19087 assume subroutines may not be reachable with the @code{bl} instruction
19088 (the compiler generates the much slower @code{seth/add3/jl}
19089 instruction sequence).
19091 @item -msdata=none
19092 @opindex msdata=none
19093 Disable use of the small data area.  Variables are put into
19094 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
19095 @code{section} attribute has been specified).
19096 This is the default.
19098 The small data area consists of sections @code{.sdata} and @code{.sbss}.
19099 Objects may be explicitly put in the small data area with the
19100 @code{section} attribute using one of these sections.
19102 @item -msdata=sdata
19103 @opindex msdata=sdata
19104 Put small global and static data in the small data area, but do not
19105 generate special code to reference them.
19107 @item -msdata=use
19108 @opindex msdata=use
19109 Put small global and static data in the small data area, and generate
19110 special instructions to reference them.
19112 @item -G @var{num}
19113 @opindex G
19114 @cindex smaller data references
19115 Put global and static objects less than or equal to @var{num} bytes
19116 into the small data or BSS sections instead of the normal data or BSS
19117 sections.  The default value of @var{num} is 8.
19118 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
19119 for this option to have any effect.
19121 All modules should be compiled with the same @option{-G @var{num}} value.
19122 Compiling with different values of @var{num} may or may not work; if it
19123 doesn't the linker gives an error message---incorrect code is not
19124 generated.
19126 @item -mdebug
19127 @opindex mdebug
19128 Makes the M32R-specific code in the compiler display some statistics
19129 that might help in debugging programs.
19131 @item -malign-loops
19132 @opindex malign-loops
19133 Align all loops to a 32-byte boundary.
19135 @item -mno-align-loops
19136 @opindex mno-align-loops
19137 Do not enforce a 32-byte alignment for loops.  This is the default.
19139 @item -missue-rate=@var{number}
19140 @opindex missue-rate=@var{number}
19141 Issue @var{number} instructions per cycle.  @var{number} can only be 1
19142 or 2.
19144 @item -mbranch-cost=@var{number}
19145 @opindex mbranch-cost=@var{number}
19146 @var{number} can only be 1 or 2.  If it is 1 then branches are
19147 preferred over conditional code, if it is 2, then the opposite applies.
19149 @item -mflush-trap=@var{number}
19150 @opindex mflush-trap=@var{number}
19151 Specifies the trap number to use to flush the cache.  The default is
19152 12.  Valid numbers are between 0 and 15 inclusive.
19154 @item -mno-flush-trap
19155 @opindex mno-flush-trap
19156 Specifies that the cache cannot be flushed by using a trap.
19158 @item -mflush-func=@var{name}
19159 @opindex mflush-func=@var{name}
19160 Specifies the name of the operating system function to call to flush
19161 the cache.  The default is @samp{_flush_cache}, but a function call
19162 is only used if a trap is not available.
19164 @item -mno-flush-func
19165 @opindex mno-flush-func
19166 Indicates that there is no OS function for flushing the cache.
19168 @end table
19170 @node M680x0 Options
19171 @subsection M680x0 Options
19172 @cindex M680x0 options
19174 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
19175 The default settings depend on which architecture was selected when
19176 the compiler was configured; the defaults for the most common choices
19177 are given below.
19179 @table @gcctabopt
19180 @item -march=@var{arch}
19181 @opindex march
19182 Generate code for a specific M680x0 or ColdFire instruction set
19183 architecture.  Permissible values of @var{arch} for M680x0
19184 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
19185 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
19186 architectures are selected according to Freescale's ISA classification
19187 and the permissible values are: @samp{isaa}, @samp{isaaplus},
19188 @samp{isab} and @samp{isac}.
19190 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
19191 code for a ColdFire target.  The @var{arch} in this macro is one of the
19192 @option{-march} arguments given above.
19194 When used together, @option{-march} and @option{-mtune} select code
19195 that runs on a family of similar processors but that is optimized
19196 for a particular microarchitecture.
19198 @item -mcpu=@var{cpu}
19199 @opindex mcpu
19200 Generate code for a specific M680x0 or ColdFire processor.
19201 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
19202 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
19203 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
19204 below, which also classifies the CPUs into families:
19206 @multitable @columnfractions 0.20 0.80
19207 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
19208 @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}
19209 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
19210 @item @samp{5206e} @tab @samp{5206e}
19211 @item @samp{5208} @tab @samp{5207} @samp{5208}
19212 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
19213 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
19214 @item @samp{5216} @tab @samp{5214} @samp{5216}
19215 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
19216 @item @samp{5225} @tab @samp{5224} @samp{5225}
19217 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
19218 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
19219 @item @samp{5249} @tab @samp{5249}
19220 @item @samp{5250} @tab @samp{5250}
19221 @item @samp{5271} @tab @samp{5270} @samp{5271}
19222 @item @samp{5272} @tab @samp{5272}
19223 @item @samp{5275} @tab @samp{5274} @samp{5275}
19224 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
19225 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
19226 @item @samp{5307} @tab @samp{5307}
19227 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
19228 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
19229 @item @samp{5407} @tab @samp{5407}
19230 @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}
19231 @end multitable
19233 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
19234 @var{arch} is compatible with @var{cpu}.  Other combinations of
19235 @option{-mcpu} and @option{-march} are rejected.
19237 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
19238 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
19239 where the value of @var{family} is given by the table above.
19241 @item -mtune=@var{tune}
19242 @opindex mtune
19243 Tune the code for a particular microarchitecture within the
19244 constraints set by @option{-march} and @option{-mcpu}.
19245 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
19246 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
19247 and @samp{cpu32}.  The ColdFire microarchitectures
19248 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
19250 You can also use @option{-mtune=68020-40} for code that needs
19251 to run relatively well on 68020, 68030 and 68040 targets.
19252 @option{-mtune=68020-60} is similar but includes 68060 targets
19253 as well.  These two options select the same tuning decisions as
19254 @option{-m68020-40} and @option{-m68020-60} respectively.
19256 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
19257 when tuning for 680x0 architecture @var{arch}.  It also defines
19258 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
19259 option is used.  If GCC is tuning for a range of architectures,
19260 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
19261 it defines the macros for every architecture in the range.
19263 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
19264 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
19265 of the arguments given above.
19267 @item -m68000
19268 @itemx -mc68000
19269 @opindex m68000
19270 @opindex mc68000
19271 Generate output for a 68000.  This is the default
19272 when the compiler is configured for 68000-based systems.
19273 It is equivalent to @option{-march=68000}.
19275 Use this option for microcontrollers with a 68000 or EC000 core,
19276 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
19278 @item -m68010
19279 @opindex m68010
19280 Generate output for a 68010.  This is the default
19281 when the compiler is configured for 68010-based systems.
19282 It is equivalent to @option{-march=68010}.
19284 @item -m68020
19285 @itemx -mc68020
19286 @opindex m68020
19287 @opindex mc68020
19288 Generate output for a 68020.  This is the default
19289 when the compiler is configured for 68020-based systems.
19290 It is equivalent to @option{-march=68020}.
19292 @item -m68030
19293 @opindex m68030
19294 Generate output for a 68030.  This is the default when the compiler is
19295 configured for 68030-based systems.  It is equivalent to
19296 @option{-march=68030}.
19298 @item -m68040
19299 @opindex m68040
19300 Generate output for a 68040.  This is the default when the compiler is
19301 configured for 68040-based systems.  It is equivalent to
19302 @option{-march=68040}.
19304 This option inhibits the use of 68881/68882 instructions that have to be
19305 emulated by software on the 68040.  Use this option if your 68040 does not
19306 have code to emulate those instructions.
19308 @item -m68060
19309 @opindex m68060
19310 Generate output for a 68060.  This is the default when the compiler is
19311 configured for 68060-based systems.  It is equivalent to
19312 @option{-march=68060}.
19314 This option inhibits the use of 68020 and 68881/68882 instructions that
19315 have to be emulated by software on the 68060.  Use this option if your 68060
19316 does not have code to emulate those instructions.
19318 @item -mcpu32
19319 @opindex mcpu32
19320 Generate output for a CPU32.  This is the default
19321 when the compiler is configured for CPU32-based systems.
19322 It is equivalent to @option{-march=cpu32}.
19324 Use this option for microcontrollers with a
19325 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
19326 68336, 68340, 68341, 68349 and 68360.
19328 @item -m5200
19329 @opindex m5200
19330 Generate output for a 520X ColdFire CPU@.  This is the default
19331 when the compiler is configured for 520X-based systems.
19332 It is equivalent to @option{-mcpu=5206}, and is now deprecated
19333 in favor of that option.
19335 Use this option for microcontroller with a 5200 core, including
19336 the MCF5202, MCF5203, MCF5204 and MCF5206.
19338 @item -m5206e
19339 @opindex m5206e
19340 Generate output for a 5206e ColdFire CPU@.  The option is now
19341 deprecated in favor of the equivalent @option{-mcpu=5206e}.
19343 @item -m528x
19344 @opindex m528x
19345 Generate output for a member of the ColdFire 528X family.
19346 The option is now deprecated in favor of the equivalent
19347 @option{-mcpu=528x}.
19349 @item -m5307
19350 @opindex m5307
19351 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
19352 in favor of the equivalent @option{-mcpu=5307}.
19354 @item -m5407
19355 @opindex m5407
19356 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
19357 in favor of the equivalent @option{-mcpu=5407}.
19359 @item -mcfv4e
19360 @opindex mcfv4e
19361 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
19362 This includes use of hardware floating-point instructions.
19363 The option is equivalent to @option{-mcpu=547x}, and is now
19364 deprecated in favor of that option.
19366 @item -m68020-40
19367 @opindex m68020-40
19368 Generate output for a 68040, without using any of the new instructions.
19369 This results in code that can run relatively efficiently on either a
19370 68020/68881 or a 68030 or a 68040.  The generated code does use the
19371 68881 instructions that are emulated on the 68040.
19373 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19375 @item -m68020-60
19376 @opindex m68020-60
19377 Generate output for a 68060, without using any of the new instructions.
19378 This results in code that can run relatively efficiently on either a
19379 68020/68881 or a 68030 or a 68040.  The generated code does use the
19380 68881 instructions that are emulated on the 68060.
19382 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19384 @item -mhard-float
19385 @itemx -m68881
19386 @opindex mhard-float
19387 @opindex m68881
19388 Generate floating-point instructions.  This is the default for 68020
19389 and above, and for ColdFire devices that have an FPU@.  It defines the
19390 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19391 on ColdFire targets.
19393 @item -msoft-float
19394 @opindex msoft-float
19395 Do not generate floating-point instructions; use library calls instead.
19396 This is the default for 68000, 68010, and 68832 targets.  It is also
19397 the default for ColdFire devices that have no FPU.
19399 @item -mdiv
19400 @itemx -mno-div
19401 @opindex mdiv
19402 @opindex mno-div
19403 Generate (do not generate) ColdFire hardware divide and remainder
19404 instructions.  If @option{-march} is used without @option{-mcpu},
19405 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19406 architectures.  Otherwise, the default is taken from the target CPU
19407 (either the default CPU, or the one specified by @option{-mcpu}).  For
19408 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19409 @option{-mcpu=5206e}.
19411 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19413 @item -mshort
19414 @opindex mshort
19415 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19416 Additionally, parameters passed on the stack are also aligned to a
19417 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19419 @item -mno-short
19420 @opindex mno-short
19421 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19423 @item -mnobitfield
19424 @itemx -mno-bitfield
19425 @opindex mnobitfield
19426 @opindex mno-bitfield
19427 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19428 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19430 @item -mbitfield
19431 @opindex mbitfield
19432 Do use the bit-field instructions.  The @option{-m68020} option implies
19433 @option{-mbitfield}.  This is the default if you use a configuration
19434 designed for a 68020.
19436 @item -mrtd
19437 @opindex mrtd
19438 Use a different function-calling convention, in which functions
19439 that take a fixed number of arguments return with the @code{rtd}
19440 instruction, which pops their arguments while returning.  This
19441 saves one instruction in the caller since there is no need to pop
19442 the arguments there.
19444 This calling convention is incompatible with the one normally
19445 used on Unix, so you cannot use it if you need to call libraries
19446 compiled with the Unix compiler.
19448 Also, you must provide function prototypes for all functions that
19449 take variable numbers of arguments (including @code{printf});
19450 otherwise incorrect code is generated for calls to those
19451 functions.
19453 In addition, seriously incorrect code results if you call a
19454 function with too many arguments.  (Normally, extra arguments are
19455 harmlessly ignored.)
19457 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19458 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19460 @item -mno-rtd
19461 @opindex mno-rtd
19462 Do not use the calling conventions selected by @option{-mrtd}.
19463 This is the default.
19465 @item -malign-int
19466 @itemx -mno-align-int
19467 @opindex malign-int
19468 @opindex mno-align-int
19469 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19470 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19471 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19472 Aligning variables on 32-bit boundaries produces code that runs somewhat
19473 faster on processors with 32-bit busses at the expense of more memory.
19475 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19476 aligns structures containing the above types differently than
19477 most published application binary interface specifications for the m68k.
19479 @item -mpcrel
19480 @opindex mpcrel
19481 Use the pc-relative addressing mode of the 68000 directly, instead of
19482 using a global offset table.  At present, this option implies @option{-fpic},
19483 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19484 not presently supported with @option{-mpcrel}, though this could be supported for
19485 68020 and higher processors.
19487 @item -mno-strict-align
19488 @itemx -mstrict-align
19489 @opindex mno-strict-align
19490 @opindex mstrict-align
19491 Do not (do) assume that unaligned memory references are handled by
19492 the system.
19494 @item -msep-data
19495 Generate code that allows the data segment to be located in a different
19496 area of memory from the text segment.  This allows for execute-in-place in
19497 an environment without virtual memory management.  This option implies
19498 @option{-fPIC}.
19500 @item -mno-sep-data
19501 Generate code that assumes that the data segment follows the text segment.
19502 This is the default.
19504 @item -mid-shared-library
19505 Generate code that supports shared libraries via the library ID method.
19506 This allows for execute-in-place and shared libraries in an environment
19507 without virtual memory management.  This option implies @option{-fPIC}.
19509 @item -mno-id-shared-library
19510 Generate code that doesn't assume ID-based shared libraries are being used.
19511 This is the default.
19513 @item -mshared-library-id=n
19514 Specifies the identification number of the ID-based shared library being
19515 compiled.  Specifying a value of 0 generates more compact code; specifying
19516 other values forces the allocation of that number to the current
19517 library, but is no more space- or time-efficient than omitting this option.
19519 @item -mxgot
19520 @itemx -mno-xgot
19521 @opindex mxgot
19522 @opindex mno-xgot
19523 When generating position-independent code for ColdFire, generate code
19524 that works if the GOT has more than 8192 entries.  This code is
19525 larger and slower than code generated without this option.  On M680x0
19526 processors, this option is not needed; @option{-fPIC} suffices.
19528 GCC normally uses a single instruction to load values from the GOT@.
19529 While this is relatively efficient, it only works if the GOT
19530 is smaller than about 64k.  Anything larger causes the linker
19531 to report an error such as:
19533 @cindex relocation truncated to fit (ColdFire)
19534 @smallexample
19535 relocation truncated to fit: R_68K_GOT16O foobar
19536 @end smallexample
19538 If this happens, you should recompile your code with @option{-mxgot}.
19539 It should then work with very large GOTs.  However, code generated with
19540 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19541 the value of a global symbol.
19543 Note that some linkers, including newer versions of the GNU linker,
19544 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19545 you should only need to use @option{-mxgot} when compiling a single
19546 object file that accesses more than 8192 GOT entries.  Very few do.
19548 These options have no effect unless GCC is generating
19549 position-independent code.
19551 @item -mlong-jump-table-offsets
19552 @opindex mlong-jump-table-offsets
19553 Use 32-bit offsets in @code{switch} tables.  The default is to use
19554 16-bit offsets.
19556 @end table
19558 @node MCore Options
19559 @subsection MCore Options
19560 @cindex MCore options
19562 These are the @samp{-m} options defined for the Motorola M*Core
19563 processors.
19565 @table @gcctabopt
19567 @item -mhardlit
19568 @itemx -mno-hardlit
19569 @opindex mhardlit
19570 @opindex mno-hardlit
19571 Inline constants into the code stream if it can be done in two
19572 instructions or less.
19574 @item -mdiv
19575 @itemx -mno-div
19576 @opindex mdiv
19577 @opindex mno-div
19578 Use the divide instruction.  (Enabled by default).
19580 @item -mrelax-immediate
19581 @itemx -mno-relax-immediate
19582 @opindex mrelax-immediate
19583 @opindex mno-relax-immediate
19584 Allow arbitrary-sized immediates in bit operations.
19586 @item -mwide-bitfields
19587 @itemx -mno-wide-bitfields
19588 @opindex mwide-bitfields
19589 @opindex mno-wide-bitfields
19590 Always treat bit-fields as @code{int}-sized.
19592 @item -m4byte-functions
19593 @itemx -mno-4byte-functions
19594 @opindex m4byte-functions
19595 @opindex mno-4byte-functions
19596 Force all functions to be aligned to a 4-byte boundary.
19598 @item -mcallgraph-data
19599 @itemx -mno-callgraph-data
19600 @opindex mcallgraph-data
19601 @opindex mno-callgraph-data
19602 Emit callgraph information.
19604 @item -mslow-bytes
19605 @itemx -mno-slow-bytes
19606 @opindex mslow-bytes
19607 @opindex mno-slow-bytes
19608 Prefer word access when reading byte quantities.
19610 @item -mlittle-endian
19611 @itemx -mbig-endian
19612 @opindex mlittle-endian
19613 @opindex mbig-endian
19614 Generate code for a little-endian target.
19616 @item -m210
19617 @itemx -m340
19618 @opindex m210
19619 @opindex m340
19620 Generate code for the 210 processor.
19622 @item -mno-lsim
19623 @opindex mno-lsim
19624 Assume that runtime support has been provided and so omit the
19625 simulator library (@file{libsim.a)} from the linker command line.
19627 @item -mstack-increment=@var{size}
19628 @opindex mstack-increment
19629 Set the maximum amount for a single stack increment operation.  Large
19630 values can increase the speed of programs that contain functions
19631 that need a large amount of stack space, but they can also trigger a
19632 segmentation fault if the stack is extended too much.  The default
19633 value is 0x1000.
19635 @end table
19637 @node MeP Options
19638 @subsection MeP Options
19639 @cindex MeP options
19641 @table @gcctabopt
19643 @item -mabsdiff
19644 @opindex mabsdiff
19645 Enables the @code{abs} instruction, which is the absolute difference
19646 between two registers.
19648 @item -mall-opts
19649 @opindex mall-opts
19650 Enables all the optional instructions---average, multiply, divide, bit
19651 operations, leading zero, absolute difference, min/max, clip, and
19652 saturation.
19655 @item -maverage
19656 @opindex maverage
19657 Enables the @code{ave} instruction, which computes the average of two
19658 registers.
19660 @item -mbased=@var{n}
19661 @opindex mbased=
19662 Variables of size @var{n} bytes or smaller are placed in the
19663 @code{.based} section by default.  Based variables use the @code{$tp}
19664 register as a base register, and there is a 128-byte limit to the
19665 @code{.based} section.
19667 @item -mbitops
19668 @opindex mbitops
19669 Enables the bit operation instructions---bit test (@code{btstm}), set
19670 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19671 test-and-set (@code{tas}).
19673 @item -mc=@var{name}
19674 @opindex mc=
19675 Selects which section constant data is placed in.  @var{name} may
19676 be @samp{tiny}, @samp{near}, or @samp{far}.
19678 @item -mclip
19679 @opindex mclip
19680 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19681 useful unless you also provide @option{-mminmax}.
19683 @item -mconfig=@var{name}
19684 @opindex mconfig=
19685 Selects one of the built-in core configurations.  Each MeP chip has
19686 one or more modules in it; each module has a core CPU and a variety of
19687 coprocessors, optional instructions, and peripherals.  The
19688 @code{MeP-Integrator} tool, not part of GCC, provides these
19689 configurations through this option; using this option is the same as
19690 using all the corresponding command-line options.  The default
19691 configuration is @samp{default}.
19693 @item -mcop
19694 @opindex mcop
19695 Enables the coprocessor instructions.  By default, this is a 32-bit
19696 coprocessor.  Note that the coprocessor is normally enabled via the
19697 @option{-mconfig=} option.
19699 @item -mcop32
19700 @opindex mcop32
19701 Enables the 32-bit coprocessor's instructions.
19703 @item -mcop64
19704 @opindex mcop64
19705 Enables the 64-bit coprocessor's instructions.
19707 @item -mivc2
19708 @opindex mivc2
19709 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19711 @item -mdc
19712 @opindex mdc
19713 Causes constant variables to be placed in the @code{.near} section.
19715 @item -mdiv
19716 @opindex mdiv
19717 Enables the @code{div} and @code{divu} instructions.
19719 @item -meb
19720 @opindex meb
19721 Generate big-endian code.
19723 @item -mel
19724 @opindex mel
19725 Generate little-endian code.
19727 @item -mio-volatile
19728 @opindex mio-volatile
19729 Tells the compiler that any variable marked with the @code{io}
19730 attribute is to be considered volatile.
19732 @item -ml
19733 @opindex ml
19734 Causes variables to be assigned to the @code{.far} section by default.
19736 @item -mleadz
19737 @opindex mleadz
19738 Enables the @code{leadz} (leading zero) instruction.
19740 @item -mm
19741 @opindex mm
19742 Causes variables to be assigned to the @code{.near} section by default.
19744 @item -mminmax
19745 @opindex mminmax
19746 Enables the @code{min} and @code{max} instructions.
19748 @item -mmult
19749 @opindex mmult
19750 Enables the multiplication and multiply-accumulate instructions.
19752 @item -mno-opts
19753 @opindex mno-opts
19754 Disables all the optional instructions enabled by @option{-mall-opts}.
19756 @item -mrepeat
19757 @opindex mrepeat
19758 Enables the @code{repeat} and @code{erepeat} instructions, used for
19759 low-overhead looping.
19761 @item -ms
19762 @opindex ms
19763 Causes all variables to default to the @code{.tiny} section.  Note
19764 that there is a 65536-byte limit to this section.  Accesses to these
19765 variables use the @code{%gp} base register.
19767 @item -msatur
19768 @opindex msatur
19769 Enables the saturation instructions.  Note that the compiler does not
19770 currently generate these itself, but this option is included for
19771 compatibility with other tools, like @code{as}.
19773 @item -msdram
19774 @opindex msdram
19775 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19777 @item -msim
19778 @opindex msim
19779 Link the simulator run-time libraries.
19781 @item -msimnovec
19782 @opindex msimnovec
19783 Link the simulator runtime libraries, excluding built-in support
19784 for reset and exception vectors and tables.
19786 @item -mtf
19787 @opindex mtf
19788 Causes all functions to default to the @code{.far} section.  Without
19789 this option, functions default to the @code{.near} section.
19791 @item -mtiny=@var{n}
19792 @opindex mtiny=
19793 Variables that are @var{n} bytes or smaller are allocated to the
19794 @code{.tiny} section.  These variables use the @code{$gp} base
19795 register.  The default for this option is 4, but note that there's a
19796 65536-byte limit to the @code{.tiny} section.
19798 @end table
19800 @node MicroBlaze Options
19801 @subsection MicroBlaze Options
19802 @cindex MicroBlaze Options
19804 @table @gcctabopt
19806 @item -msoft-float
19807 @opindex msoft-float
19808 Use software emulation for floating point (default).
19810 @item -mhard-float
19811 @opindex mhard-float
19812 Use hardware floating-point instructions.
19814 @item -mmemcpy
19815 @opindex mmemcpy
19816 Do not optimize block moves, use @code{memcpy}.
19818 @item -mno-clearbss
19819 @opindex mno-clearbss
19820 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19822 @item -mcpu=@var{cpu-type}
19823 @opindex mcpu=
19824 Use features of, and schedule code for, the given CPU.
19825 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19826 where @var{X} is a major version, @var{YY} is the minor version, and
19827 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19828 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19830 @item -mxl-soft-mul
19831 @opindex mxl-soft-mul
19832 Use software multiply emulation (default).
19834 @item -mxl-soft-div
19835 @opindex mxl-soft-div
19836 Use software emulation for divides (default).
19838 @item -mxl-barrel-shift
19839 @opindex mxl-barrel-shift
19840 Use the hardware barrel shifter.
19842 @item -mxl-pattern-compare
19843 @opindex mxl-pattern-compare
19844 Use pattern compare instructions.
19846 @item -msmall-divides
19847 @opindex msmall-divides
19848 Use table lookup optimization for small signed integer divisions.
19850 @item -mxl-stack-check
19851 @opindex mxl-stack-check
19852 This option is deprecated.  Use @option{-fstack-check} instead.
19854 @item -mxl-gp-opt
19855 @opindex mxl-gp-opt
19856 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19858 @item -mxl-multiply-high
19859 @opindex mxl-multiply-high
19860 Use multiply high instructions for high part of 32x32 multiply.
19862 @item -mxl-float-convert
19863 @opindex mxl-float-convert
19864 Use hardware floating-point conversion instructions.
19866 @item -mxl-float-sqrt
19867 @opindex mxl-float-sqrt
19868 Use hardware floating-point square root instruction.
19870 @item -mbig-endian
19871 @opindex mbig-endian
19872 Generate code for a big-endian target.
19874 @item -mlittle-endian
19875 @opindex mlittle-endian
19876 Generate code for a little-endian target.
19878 @item -mxl-reorder
19879 @opindex mxl-reorder
19880 Use reorder instructions (swap and byte reversed load/store).
19882 @item -mxl-mode-@var{app-model}
19883 Select application model @var{app-model}.  Valid models are
19884 @table @samp
19885 @item executable
19886 normal executable (default), uses startup code @file{crt0.o}.
19888 @item xmdstub
19889 for use with Xilinx Microprocessor Debugger (XMD) based
19890 software intrusive debug agent called xmdstub. This uses startup file
19891 @file{crt1.o} and sets the start address of the program to 0x800.
19893 @item bootstrap
19894 for applications that are loaded using a bootloader.
19895 This model uses startup file @file{crt2.o} which does not contain a processor
19896 reset vector handler. This is suitable for transferring control on a
19897 processor reset to the bootloader rather than the application.
19899 @item novectors
19900 for applications that do not require any of the
19901 MicroBlaze vectors. This option may be useful for applications running
19902 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19903 @end table
19905 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19906 @option{-mxl-mode-@var{app-model}}.
19908 @end table
19910 @node MIPS Options
19911 @subsection MIPS Options
19912 @cindex MIPS options
19914 @table @gcctabopt
19916 @item -EB
19917 @opindex EB
19918 Generate big-endian code.
19920 @item -EL
19921 @opindex EL
19922 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19923 configurations.
19925 @item -march=@var{arch}
19926 @opindex march
19927 Generate code that runs on @var{arch}, which can be the name of a
19928 generic MIPS ISA, or the name of a particular processor.
19929 The ISA names are:
19930 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19931 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19932 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19933 @samp{mips64r5} and @samp{mips64r6}.
19934 The processor names are:
19935 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19936 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19937 @samp{5kc}, @samp{5kf},
19938 @samp{20kc},
19939 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19940 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19941 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19942 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19943 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19944 @samp{i6400},
19945 @samp{interaptiv},
19946 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19947 @samp{m4k},
19948 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19949 @samp{m5100}, @samp{m5101},
19950 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19951 @samp{orion},
19952 @samp{p5600},
19953 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19954 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19955 @samp{rm7000}, @samp{rm9000},
19956 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19957 @samp{sb1},
19958 @samp{sr71000},
19959 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19960 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19961 @samp{xlr} and @samp{xlp}.
19962 The special value @samp{from-abi} selects the
19963 most compatible architecture for the selected ABI (that is,
19964 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19966 The native Linux/GNU toolchain also supports the value @samp{native},
19967 which selects the best architecture option for the host processor.
19968 @option{-march=native} has no effect if GCC does not recognize
19969 the processor.
19971 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19972 (for example, @option{-march=r2k}).  Prefixes are optional, and
19973 @samp{vr} may be written @samp{r}.
19975 Names of the form @samp{@var{n}f2_1} refer to processors with
19976 FPUs clocked at half the rate of the core, names of the form
19977 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19978 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19979 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19980 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19981 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19982 accepted as synonyms for @samp{@var{n}f1_1}.
19984 GCC defines two macros based on the value of this option.  The first
19985 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19986 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19987 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19988 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19989 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19991 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19992 above.  In other words, it has the full prefix and does not
19993 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19994 the macro names the resolved architecture (either @code{"mips1"} or
19995 @code{"mips3"}).  It names the default architecture when no
19996 @option{-march} option is given.
19998 @item -mtune=@var{arch}
19999 @opindex mtune
20000 Optimize for @var{arch}.  Among other things, this option controls
20001 the way instructions are scheduled, and the perceived cost of arithmetic
20002 operations.  The list of @var{arch} values is the same as for
20003 @option{-march}.
20005 When this option is not used, GCC optimizes for the processor
20006 specified by @option{-march}.  By using @option{-march} and
20007 @option{-mtune} together, it is possible to generate code that
20008 runs on a family of processors, but optimize the code for one
20009 particular member of that family.
20011 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
20012 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
20013 @option{-march} ones described above.
20015 @item -mips1
20016 @opindex mips1
20017 Equivalent to @option{-march=mips1}.
20019 @item -mips2
20020 @opindex mips2
20021 Equivalent to @option{-march=mips2}.
20023 @item -mips3
20024 @opindex mips3
20025 Equivalent to @option{-march=mips3}.
20027 @item -mips4
20028 @opindex mips4
20029 Equivalent to @option{-march=mips4}.
20031 @item -mips32
20032 @opindex mips32
20033 Equivalent to @option{-march=mips32}.
20035 @item -mips32r3
20036 @opindex mips32r3
20037 Equivalent to @option{-march=mips32r3}.
20039 @item -mips32r5
20040 @opindex mips32r5
20041 Equivalent to @option{-march=mips32r5}.
20043 @item -mips32r6
20044 @opindex mips32r6
20045 Equivalent to @option{-march=mips32r6}.
20047 @item -mips64
20048 @opindex mips64
20049 Equivalent to @option{-march=mips64}.
20051 @item -mips64r2
20052 @opindex mips64r2
20053 Equivalent to @option{-march=mips64r2}.
20055 @item -mips64r3
20056 @opindex mips64r3
20057 Equivalent to @option{-march=mips64r3}.
20059 @item -mips64r5
20060 @opindex mips64r5
20061 Equivalent to @option{-march=mips64r5}.
20063 @item -mips64r6
20064 @opindex mips64r6
20065 Equivalent to @option{-march=mips64r6}.
20067 @item -mips16
20068 @itemx -mno-mips16
20069 @opindex mips16
20070 @opindex mno-mips16
20071 Generate (do not generate) MIPS16 code.  If GCC is targeting a
20072 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
20074 MIPS16 code generation can also be controlled on a per-function basis
20075 by means of @code{mips16} and @code{nomips16} attributes.
20076 @xref{Function Attributes}, for more information.
20078 @item -mflip-mips16
20079 @opindex mflip-mips16
20080 Generate MIPS16 code on alternating functions.  This option is provided
20081 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
20082 not intended for ordinary use in compiling user code.
20084 @item -minterlink-compressed
20085 @item -mno-interlink-compressed
20086 @opindex minterlink-compressed
20087 @opindex mno-interlink-compressed
20088 Require (do not require) that code using the standard (uncompressed) MIPS ISA
20089 be link-compatible with MIPS16 and microMIPS code, and vice versa.
20091 For example, code using the standard ISA encoding cannot jump directly
20092 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
20093 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
20094 knows that the target of the jump is not compressed.
20096 @item -minterlink-mips16
20097 @itemx -mno-interlink-mips16
20098 @opindex minterlink-mips16
20099 @opindex mno-interlink-mips16
20100 Aliases of @option{-minterlink-compressed} and
20101 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
20102 and are retained for backwards compatibility.
20104 @item -mabi=32
20105 @itemx -mabi=o64
20106 @itemx -mabi=n32
20107 @itemx -mabi=64
20108 @itemx -mabi=eabi
20109 @opindex mabi=32
20110 @opindex mabi=o64
20111 @opindex mabi=n32
20112 @opindex mabi=64
20113 @opindex mabi=eabi
20114 Generate code for the given ABI@.
20116 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
20117 generates 64-bit code when you select a 64-bit architecture, but you
20118 can use @option{-mgp32} to get 32-bit code instead.
20120 For information about the O64 ABI, see
20121 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
20123 GCC supports a variant of the o32 ABI in which floating-point registers
20124 are 64 rather than 32 bits wide.  You can select this combination with
20125 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
20126 and @code{mfhc1} instructions and is therefore only supported for
20127 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
20129 The register assignments for arguments and return values remain the
20130 same, but each scalar value is passed in a single 64-bit register
20131 rather than a pair of 32-bit registers.  For example, scalar
20132 floating-point values are returned in @samp{$f0} only, not a
20133 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
20134 remains the same in that the even-numbered double-precision registers
20135 are saved.
20137 Two additional variants of the o32 ABI are supported to enable
20138 a transition from 32-bit to 64-bit registers.  These are FPXX
20139 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
20140 The FPXX extension mandates that all code must execute correctly
20141 when run using 32-bit or 64-bit registers.  The code can be interlinked
20142 with either FP32 or FP64, but not both.
20143 The FP64A extension is similar to the FP64 extension but forbids the
20144 use of odd-numbered single-precision registers.  This can be used
20145 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
20146 processors and allows both FP32 and FP64A code to interlink and
20147 run in the same process without changing FPU modes.
20149 @item -mabicalls
20150 @itemx -mno-abicalls
20151 @opindex mabicalls
20152 @opindex mno-abicalls
20153 Generate (do not generate) code that is suitable for SVR4-style
20154 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
20155 systems.
20157 @item -mshared
20158 @itemx -mno-shared
20159 Generate (do not generate) code that is fully position-independent,
20160 and that can therefore be linked into shared libraries.  This option
20161 only affects @option{-mabicalls}.
20163 All @option{-mabicalls} code has traditionally been position-independent,
20164 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
20165 as an extension, the GNU toolchain allows executables to use absolute
20166 accesses for locally-binding symbols.  It can also use shorter GP
20167 initialization sequences and generate direct calls to locally-defined
20168 functions.  This mode is selected by @option{-mno-shared}.
20170 @option{-mno-shared} depends on binutils 2.16 or higher and generates
20171 objects that can only be linked by the GNU linker.  However, the option
20172 does not affect the ABI of the final executable; it only affects the ABI
20173 of relocatable objects.  Using @option{-mno-shared} generally makes
20174 executables both smaller and quicker.
20176 @option{-mshared} is the default.
20178 @item -mplt
20179 @itemx -mno-plt
20180 @opindex mplt
20181 @opindex mno-plt
20182 Assume (do not assume) that the static and dynamic linkers
20183 support PLTs and copy relocations.  This option only affects
20184 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
20185 has no effect without @option{-msym32}.
20187 You can make @option{-mplt} the default by configuring
20188 GCC with @option{--with-mips-plt}.  The default is
20189 @option{-mno-plt} otherwise.
20191 @item -mxgot
20192 @itemx -mno-xgot
20193 @opindex mxgot
20194 @opindex mno-xgot
20195 Lift (do not lift) the usual restrictions on the size of the global
20196 offset table.
20198 GCC normally uses a single instruction to load values from the GOT@.
20199 While this is relatively efficient, it only works if the GOT
20200 is smaller than about 64k.  Anything larger causes the linker
20201 to report an error such as:
20203 @cindex relocation truncated to fit (MIPS)
20204 @smallexample
20205 relocation truncated to fit: R_MIPS_GOT16 foobar
20206 @end smallexample
20208 If this happens, you should recompile your code with @option{-mxgot}.
20209 This works with very large GOTs, although the code is also
20210 less efficient, since it takes three instructions to fetch the
20211 value of a global symbol.
20213 Note that some linkers can create multiple GOTs.  If you have such a
20214 linker, you should only need to use @option{-mxgot} when a single object
20215 file accesses more than 64k's worth of GOT entries.  Very few do.
20217 These options have no effect unless GCC is generating position
20218 independent code.
20220 @item -mgp32
20221 @opindex mgp32
20222 Assume that general-purpose registers are 32 bits wide.
20224 @item -mgp64
20225 @opindex mgp64
20226 Assume that general-purpose registers are 64 bits wide.
20228 @item -mfp32
20229 @opindex mfp32
20230 Assume that floating-point registers are 32 bits wide.
20232 @item -mfp64
20233 @opindex mfp64
20234 Assume that floating-point registers are 64 bits wide.
20236 @item -mfpxx
20237 @opindex mfpxx
20238 Do not assume the width of floating-point registers.
20240 @item -mhard-float
20241 @opindex mhard-float
20242 Use floating-point coprocessor instructions.
20244 @item -msoft-float
20245 @opindex msoft-float
20246 Do not use floating-point coprocessor instructions.  Implement
20247 floating-point calculations using library calls instead.
20249 @item -mno-float
20250 @opindex mno-float
20251 Equivalent to @option{-msoft-float}, but additionally asserts that the
20252 program being compiled does not perform any floating-point operations.
20253 This option is presently supported only by some bare-metal MIPS
20254 configurations, where it may select a special set of libraries
20255 that lack all floating-point support (including, for example, the
20256 floating-point @code{printf} formats).  
20257 If code compiled with @option{-mno-float} accidentally contains
20258 floating-point operations, it is likely to suffer a link-time
20259 or run-time failure.
20261 @item -msingle-float
20262 @opindex msingle-float
20263 Assume that the floating-point coprocessor only supports single-precision
20264 operations.
20266 @item -mdouble-float
20267 @opindex mdouble-float
20268 Assume that the floating-point coprocessor supports double-precision
20269 operations.  This is the default.
20271 @item -modd-spreg
20272 @itemx -mno-odd-spreg
20273 @opindex modd-spreg
20274 @opindex mno-odd-spreg
20275 Enable the use of odd-numbered single-precision floating-point registers
20276 for the o32 ABI.  This is the default for processors that are known to
20277 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
20278 is set by default.
20280 @item -mabs=2008
20281 @itemx -mabs=legacy
20282 @opindex mabs=2008
20283 @opindex mabs=legacy
20284 These options control the treatment of the special not-a-number (NaN)
20285 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
20286 @code{neg.@i{fmt}} machine instructions.
20288 By default or when @option{-mabs=legacy} is used the legacy
20289 treatment is selected.  In this case these instructions are considered
20290 arithmetic and avoided where correct operation is required and the
20291 input operand might be a NaN.  A longer sequence of instructions that
20292 manipulate the sign bit of floating-point datum manually is used
20293 instead unless the @option{-ffinite-math-only} option has also been
20294 specified.
20296 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
20297 this case these instructions are considered non-arithmetic and therefore
20298 operating correctly in all cases, including in particular where the
20299 input operand is a NaN.  These instructions are therefore always used
20300 for the respective operations.
20302 @item -mnan=2008
20303 @itemx -mnan=legacy
20304 @opindex mnan=2008
20305 @opindex mnan=legacy
20306 These options control the encoding of the special not-a-number (NaN)
20307 IEEE 754 floating-point data.
20309 The @option{-mnan=legacy} option selects the legacy encoding.  In this
20310 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
20311 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
20312 by the first bit of their trailing significand field being 1.
20314 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
20315 this case qNaNs are denoted by the first bit of their trailing
20316 significand field being 1, whereas sNaNs are denoted by the first bit of
20317 their trailing significand field being 0.
20319 The default is @option{-mnan=legacy} unless GCC has been configured with
20320 @option{--with-nan=2008}.
20322 @item -mllsc
20323 @itemx -mno-llsc
20324 @opindex mllsc
20325 @opindex mno-llsc
20326 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
20327 implement atomic memory built-in functions.  When neither option is
20328 specified, GCC uses the instructions if the target architecture
20329 supports them.
20331 @option{-mllsc} is useful if the runtime environment can emulate the
20332 instructions and @option{-mno-llsc} can be useful when compiling for
20333 nonstandard ISAs.  You can make either option the default by
20334 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
20335 respectively.  @option{--with-llsc} is the default for some
20336 configurations; see the installation documentation for details.
20338 @item -mdsp
20339 @itemx -mno-dsp
20340 @opindex mdsp
20341 @opindex mno-dsp
20342 Use (do not use) revision 1 of the MIPS DSP ASE@.
20343 @xref{MIPS DSP Built-in Functions}.  This option defines the
20344 preprocessor macro @code{__mips_dsp}.  It also defines
20345 @code{__mips_dsp_rev} to 1.
20347 @item -mdspr2
20348 @itemx -mno-dspr2
20349 @opindex mdspr2
20350 @opindex mno-dspr2
20351 Use (do not use) revision 2 of the MIPS DSP ASE@.
20352 @xref{MIPS DSP Built-in Functions}.  This option defines the
20353 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
20354 It also defines @code{__mips_dsp_rev} to 2.
20356 @item -msmartmips
20357 @itemx -mno-smartmips
20358 @opindex msmartmips
20359 @opindex mno-smartmips
20360 Use (do not use) the MIPS SmartMIPS ASE.
20362 @item -mpaired-single
20363 @itemx -mno-paired-single
20364 @opindex mpaired-single
20365 @opindex mno-paired-single
20366 Use (do not use) paired-single floating-point instructions.
20367 @xref{MIPS Paired-Single Support}.  This option requires
20368 hardware floating-point support to be enabled.
20370 @item -mdmx
20371 @itemx -mno-mdmx
20372 @opindex mdmx
20373 @opindex mno-mdmx
20374 Use (do not use) MIPS Digital Media Extension instructions.
20375 This option can only be used when generating 64-bit code and requires
20376 hardware floating-point support to be enabled.
20378 @item -mips3d
20379 @itemx -mno-mips3d
20380 @opindex mips3d
20381 @opindex mno-mips3d
20382 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20383 The option @option{-mips3d} implies @option{-mpaired-single}.
20385 @item -mmicromips
20386 @itemx -mno-micromips
20387 @opindex mmicromips
20388 @opindex mno-mmicromips
20389 Generate (do not generate) microMIPS code.
20391 MicroMIPS code generation can also be controlled on a per-function basis
20392 by means of @code{micromips} and @code{nomicromips} attributes.
20393 @xref{Function Attributes}, for more information.
20395 @item -mmt
20396 @itemx -mno-mt
20397 @opindex mmt
20398 @opindex mno-mt
20399 Use (do not use) MT Multithreading instructions.
20401 @item -mmcu
20402 @itemx -mno-mcu
20403 @opindex mmcu
20404 @opindex mno-mcu
20405 Use (do not use) the MIPS MCU ASE instructions.
20407 @item -meva
20408 @itemx -mno-eva
20409 @opindex meva
20410 @opindex mno-eva
20411 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20413 @item -mvirt
20414 @itemx -mno-virt
20415 @opindex mvirt
20416 @opindex mno-virt
20417 Use (do not use) the MIPS Virtualization (VZ) instructions.
20419 @item -mxpa
20420 @itemx -mno-xpa
20421 @opindex mxpa
20422 @opindex mno-xpa
20423 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20425 @item -mlong64
20426 @opindex mlong64
20427 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20428 an explanation of the default and the way that the pointer size is
20429 determined.
20431 @item -mlong32
20432 @opindex mlong32
20433 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20435 The default size of @code{int}s, @code{long}s and pointers depends on
20436 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20437 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20438 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20439 or the same size as integer registers, whichever is smaller.
20441 @item -msym32
20442 @itemx -mno-sym32
20443 @opindex msym32
20444 @opindex mno-sym32
20445 Assume (do not assume) that all symbols have 32-bit values, regardless
20446 of the selected ABI@.  This option is useful in combination with
20447 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20448 to generate shorter and faster references to symbolic addresses.
20450 @item -G @var{num}
20451 @opindex G
20452 Put definitions of externally-visible data in a small data section
20453 if that data is no bigger than @var{num} bytes.  GCC can then generate
20454 more efficient accesses to the data; see @option{-mgpopt} for details.
20456 The default @option{-G} option depends on the configuration.
20458 @item -mlocal-sdata
20459 @itemx -mno-local-sdata
20460 @opindex mlocal-sdata
20461 @opindex mno-local-sdata
20462 Extend (do not extend) the @option{-G} behavior to local data too,
20463 such as to static variables in C@.  @option{-mlocal-sdata} is the
20464 default for all configurations.
20466 If the linker complains that an application is using too much small data,
20467 you might want to try rebuilding the less performance-critical parts with
20468 @option{-mno-local-sdata}.  You might also want to build large
20469 libraries with @option{-mno-local-sdata}, so that the libraries leave
20470 more room for the main program.
20472 @item -mextern-sdata
20473 @itemx -mno-extern-sdata
20474 @opindex mextern-sdata
20475 @opindex mno-extern-sdata
20476 Assume (do not assume) that externally-defined data is in
20477 a small data section if the size of that data is within the @option{-G} limit.
20478 @option{-mextern-sdata} is the default for all configurations.
20480 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20481 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20482 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20483 is placed in a small data section.  If @var{Var} is defined by another
20484 module, you must either compile that module with a high-enough
20485 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20486 definition.  If @var{Var} is common, you must link the application
20487 with a high-enough @option{-G} setting.
20489 The easiest way of satisfying these restrictions is to compile
20490 and link every module with the same @option{-G} option.  However,
20491 you may wish to build a library that supports several different
20492 small data limits.  You can do this by compiling the library with
20493 the highest supported @option{-G} setting and additionally using
20494 @option{-mno-extern-sdata} to stop the library from making assumptions
20495 about externally-defined data.
20497 @item -mgpopt
20498 @itemx -mno-gpopt
20499 @opindex mgpopt
20500 @opindex mno-gpopt
20501 Use (do not use) GP-relative accesses for symbols that are known to be
20502 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20503 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20504 configurations.
20506 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20507 might not hold the value of @code{_gp}.  For example, if the code is
20508 part of a library that might be used in a boot monitor, programs that
20509 call boot monitor routines pass an unknown value in @code{$gp}.
20510 (In such situations, the boot monitor itself is usually compiled
20511 with @option{-G0}.)
20513 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20514 @option{-mno-extern-sdata}.
20516 @item -membedded-data
20517 @itemx -mno-embedded-data
20518 @opindex membedded-data
20519 @opindex mno-embedded-data
20520 Allocate variables to the read-only data section first if possible, then
20521 next in the small data section if possible, otherwise in data.  This gives
20522 slightly slower code than the default, but reduces the amount of RAM required
20523 when executing, and thus may be preferred for some embedded systems.
20525 @item -muninit-const-in-rodata
20526 @itemx -mno-uninit-const-in-rodata
20527 @opindex muninit-const-in-rodata
20528 @opindex mno-uninit-const-in-rodata
20529 Put uninitialized @code{const} variables in the read-only data section.
20530 This option is only meaningful in conjunction with @option{-membedded-data}.
20532 @item -mcode-readable=@var{setting}
20533 @opindex mcode-readable
20534 Specify whether GCC may generate code that reads from executable sections.
20535 There are three possible settings:
20537 @table @gcctabopt
20538 @item -mcode-readable=yes
20539 Instructions may freely access executable sections.  This is the
20540 default setting.
20542 @item -mcode-readable=pcrel
20543 MIPS16 PC-relative load instructions can access executable sections,
20544 but other instructions must not do so.  This option is useful on 4KSc
20545 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20546 It is also useful on processors that can be configured to have a dual
20547 instruction/data SRAM interface and that, like the M4K, automatically
20548 redirect PC-relative loads to the instruction RAM.
20550 @item -mcode-readable=no
20551 Instructions must not access executable sections.  This option can be
20552 useful on targets that are configured to have a dual instruction/data
20553 SRAM interface but that (unlike the M4K) do not automatically redirect
20554 PC-relative loads to the instruction RAM.
20555 @end table
20557 @item -msplit-addresses
20558 @itemx -mno-split-addresses
20559 @opindex msplit-addresses
20560 @opindex mno-split-addresses
20561 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20562 relocation operators.  This option has been superseded by
20563 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20565 @item -mexplicit-relocs
20566 @itemx -mno-explicit-relocs
20567 @opindex mexplicit-relocs
20568 @opindex mno-explicit-relocs
20569 Use (do not use) assembler relocation operators when dealing with symbolic
20570 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20571 is to use assembler macros instead.
20573 @option{-mexplicit-relocs} is the default if GCC was configured
20574 to use an assembler that supports relocation operators.
20576 @item -mcheck-zero-division
20577 @itemx -mno-check-zero-division
20578 @opindex mcheck-zero-division
20579 @opindex mno-check-zero-division
20580 Trap (do not trap) on integer division by zero.
20582 The default is @option{-mcheck-zero-division}.
20584 @item -mdivide-traps
20585 @itemx -mdivide-breaks
20586 @opindex mdivide-traps
20587 @opindex mdivide-breaks
20588 MIPS systems check for division by zero by generating either a
20589 conditional trap or a break instruction.  Using traps results in
20590 smaller code, but is only supported on MIPS II and later.  Also, some
20591 versions of the Linux kernel have a bug that prevents trap from
20592 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20593 allow conditional traps on architectures that support them and
20594 @option{-mdivide-breaks} to force the use of breaks.
20596 The default is usually @option{-mdivide-traps}, but this can be
20597 overridden at configure time using @option{--with-divide=breaks}.
20598 Divide-by-zero checks can be completely disabled using
20599 @option{-mno-check-zero-division}.
20601 @item -mload-store-pairs
20602 @itemx -mno-load-store-pairs
20603 @opindex mload-store-pairs
20604 @opindex mno-load-store-pairs
20605 Enable (disable) an optimization that pairs consecutive load or store
20606 instructions to enable load/store bonding.  This option is enabled by
20607 default but only takes effect when the selected architecture is known
20608 to support bonding.
20610 @item -mmemcpy
20611 @itemx -mno-memcpy
20612 @opindex mmemcpy
20613 @opindex mno-memcpy
20614 Force (do not force) the use of @code{memcpy} for non-trivial block
20615 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20616 most constant-sized copies.
20618 @item -mlong-calls
20619 @itemx -mno-long-calls
20620 @opindex mlong-calls
20621 @opindex mno-long-calls
20622 Disable (do not disable) use of the @code{jal} instruction.  Calling
20623 functions using @code{jal} is more efficient but requires the caller
20624 and callee to be in the same 256 megabyte segment.
20626 This option has no effect on abicalls code.  The default is
20627 @option{-mno-long-calls}.
20629 @item -mmad
20630 @itemx -mno-mad
20631 @opindex mmad
20632 @opindex mno-mad
20633 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20634 instructions, as provided by the R4650 ISA@.
20636 @item -mimadd
20637 @itemx -mno-imadd
20638 @opindex mimadd
20639 @opindex mno-imadd
20640 Enable (disable) use of the @code{madd} and @code{msub} integer
20641 instructions.  The default is @option{-mimadd} on architectures
20642 that support @code{madd} and @code{msub} except for the 74k 
20643 architecture where it was found to generate slower code.
20645 @item -mfused-madd
20646 @itemx -mno-fused-madd
20647 @opindex mfused-madd
20648 @opindex mno-fused-madd
20649 Enable (disable) use of the floating-point multiply-accumulate
20650 instructions, when they are available.  The default is
20651 @option{-mfused-madd}.
20653 On the R8000 CPU when multiply-accumulate instructions are used,
20654 the intermediate product is calculated to infinite precision
20655 and is not subject to the FCSR Flush to Zero bit.  This may be
20656 undesirable in some circumstances.  On other processors the result
20657 is numerically identical to the equivalent computation using
20658 separate multiply, add, subtract and negate instructions.
20660 @item -nocpp
20661 @opindex nocpp
20662 Tell the MIPS assembler to not run its preprocessor over user
20663 assembler files (with a @samp{.s} suffix) when assembling them.
20665 @item -mfix-24k
20666 @item -mno-fix-24k
20667 @opindex mfix-24k
20668 @opindex mno-fix-24k
20669 Work around the 24K E48 (lost data on stores during refill) errata.
20670 The workarounds are implemented by the assembler rather than by GCC@.
20672 @item -mfix-r4000
20673 @itemx -mno-fix-r4000
20674 @opindex mfix-r4000
20675 @opindex mno-fix-r4000
20676 Work around certain R4000 CPU errata:
20677 @itemize @minus
20678 @item
20679 A double-word or a variable shift may give an incorrect result if executed
20680 immediately after starting an integer division.
20681 @item
20682 A double-word or a variable shift may give an incorrect result if executed
20683 while an integer multiplication is in progress.
20684 @item
20685 An integer division may give an incorrect result if started in a delay slot
20686 of a taken branch or a jump.
20687 @end itemize
20689 @item -mfix-r4400
20690 @itemx -mno-fix-r4400
20691 @opindex mfix-r4400
20692 @opindex mno-fix-r4400
20693 Work around certain R4400 CPU errata:
20694 @itemize @minus
20695 @item
20696 A double-word or a variable shift may give an incorrect result if executed
20697 immediately after starting an integer division.
20698 @end itemize
20700 @item -mfix-r10000
20701 @itemx -mno-fix-r10000
20702 @opindex mfix-r10000
20703 @opindex mno-fix-r10000
20704 Work around certain R10000 errata:
20705 @itemize @minus
20706 @item
20707 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20708 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20709 @end itemize
20711 This option can only be used if the target architecture supports
20712 branch-likely instructions.  @option{-mfix-r10000} is the default when
20713 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20714 otherwise.
20716 @item -mfix-rm7000
20717 @itemx -mno-fix-rm7000
20718 @opindex mfix-rm7000
20719 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20720 workarounds are implemented by the assembler rather than by GCC@.
20722 @item -mfix-vr4120
20723 @itemx -mno-fix-vr4120
20724 @opindex mfix-vr4120
20725 Work around certain VR4120 errata:
20726 @itemize @minus
20727 @item
20728 @code{dmultu} does not always produce the correct result.
20729 @item
20730 @code{div} and @code{ddiv} do not always produce the correct result if one
20731 of the operands is negative.
20732 @end itemize
20733 The workarounds for the division errata rely on special functions in
20734 @file{libgcc.a}.  At present, these functions are only provided by
20735 the @code{mips64vr*-elf} configurations.
20737 Other VR4120 errata require a NOP to be inserted between certain pairs of
20738 instructions.  These errata are handled by the assembler, not by GCC itself.
20740 @item -mfix-vr4130
20741 @opindex mfix-vr4130
20742 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20743 workarounds are implemented by the assembler rather than by GCC,
20744 although GCC avoids using @code{mflo} and @code{mfhi} if the
20745 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20746 instructions are available instead.
20748 @item -mfix-sb1
20749 @itemx -mno-fix-sb1
20750 @opindex mfix-sb1
20751 Work around certain SB-1 CPU core errata.
20752 (This flag currently works around the SB-1 revision 2
20753 ``F1'' and ``F2'' floating-point errata.)
20755 @item -mr10k-cache-barrier=@var{setting}
20756 @opindex mr10k-cache-barrier
20757 Specify whether GCC should insert cache barriers to avoid the
20758 side-effects of speculation on R10K processors.
20760 In common with many processors, the R10K tries to predict the outcome
20761 of a conditional branch and speculatively executes instructions from
20762 the ``taken'' branch.  It later aborts these instructions if the
20763 predicted outcome is wrong.  However, on the R10K, even aborted
20764 instructions can have side effects.
20766 This problem only affects kernel stores and, depending on the system,
20767 kernel loads.  As an example, a speculatively-executed store may load
20768 the target memory into cache and mark the cache line as dirty, even if
20769 the store itself is later aborted.  If a DMA operation writes to the
20770 same area of memory before the ``dirty'' line is flushed, the cached
20771 data overwrites the DMA-ed data.  See the R10K processor manual
20772 for a full description, including other potential problems.
20774 One workaround is to insert cache barrier instructions before every memory
20775 access that might be speculatively executed and that might have side
20776 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20777 controls GCC's implementation of this workaround.  It assumes that
20778 aborted accesses to any byte in the following regions does not have
20779 side effects:
20781 @enumerate
20782 @item
20783 the memory occupied by the current function's stack frame;
20785 @item
20786 the memory occupied by an incoming stack argument;
20788 @item
20789 the memory occupied by an object with a link-time-constant address.
20790 @end enumerate
20792 It is the kernel's responsibility to ensure that speculative
20793 accesses to these regions are indeed safe.
20795 If the input program contains a function declaration such as:
20797 @smallexample
20798 void foo (void);
20799 @end smallexample
20801 then the implementation of @code{foo} must allow @code{j foo} and
20802 @code{jal foo} to be executed speculatively.  GCC honors this
20803 restriction for functions it compiles itself.  It expects non-GCC
20804 functions (such as hand-written assembly code) to do the same.
20806 The option has three forms:
20808 @table @gcctabopt
20809 @item -mr10k-cache-barrier=load-store
20810 Insert a cache barrier before a load or store that might be
20811 speculatively executed and that might have side effects even
20812 if aborted.
20814 @item -mr10k-cache-barrier=store
20815 Insert a cache barrier before a store that might be speculatively
20816 executed and that might have side effects even if aborted.
20818 @item -mr10k-cache-barrier=none
20819 Disable the insertion of cache barriers.  This is the default setting.
20820 @end table
20822 @item -mflush-func=@var{func}
20823 @itemx -mno-flush-func
20824 @opindex mflush-func
20825 Specifies the function to call to flush the I and D caches, or to not
20826 call any such function.  If called, the function must take the same
20827 arguments as the common @code{_flush_func}, that is, the address of the
20828 memory range for which the cache is being flushed, the size of the
20829 memory range, and the number 3 (to flush both caches).  The default
20830 depends on the target GCC was configured for, but commonly is either
20831 @code{_flush_func} or @code{__cpu_flush}.
20833 @item mbranch-cost=@var{num}
20834 @opindex mbranch-cost
20835 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20836 This cost is only a heuristic and is not guaranteed to produce
20837 consistent results across releases.  A zero cost redundantly selects
20838 the default, which is based on the @option{-mtune} setting.
20840 @item -mbranch-likely
20841 @itemx -mno-branch-likely
20842 @opindex mbranch-likely
20843 @opindex mno-branch-likely
20844 Enable or disable use of Branch Likely instructions, regardless of the
20845 default for the selected architecture.  By default, Branch Likely
20846 instructions may be generated if they are supported by the selected
20847 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20848 and processors that implement those architectures; for those, Branch
20849 Likely instructions are not be generated by default because the MIPS32
20850 and MIPS64 architectures specifically deprecate their use.
20852 @item -mcompact-branches=never
20853 @itemx -mcompact-branches=optimal
20854 @itemx -mcompact-branches=always
20855 @opindex mcompact-branches=never
20856 @opindex mcompact-branches=optimal
20857 @opindex mcompact-branches=always
20858 These options control which form of branches will be generated.  The
20859 default is @option{-mcompact-branches=optimal}.
20861 The @option{-mcompact-branches=never} option ensures that compact branch
20862 instructions will never be generated.
20864 The @option{-mcompact-branches=always} option ensures that a compact
20865 branch instruction will be generated if available.  If a compact branch
20866 instruction is not available, a delay slot form of the branch will be
20867 used instead.
20869 This option is supported from MIPS Release 6 onwards.
20871 The @option{-mcompact-branches=optimal} option will cause a delay slot
20872 branch to be used if one is available in the current ISA and the delay
20873 slot is successfully filled.  If the delay slot is not filled, a compact
20874 branch will be chosen if one is available.
20876 @item -mfp-exceptions
20877 @itemx -mno-fp-exceptions
20878 @opindex mfp-exceptions
20879 Specifies whether FP exceptions are enabled.  This affects how
20880 FP instructions are scheduled for some processors.
20881 The default is that FP exceptions are
20882 enabled.
20884 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20885 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20886 FP pipe.
20888 @item -mvr4130-align
20889 @itemx -mno-vr4130-align
20890 @opindex mvr4130-align
20891 The VR4130 pipeline is two-way superscalar, but can only issue two
20892 instructions together if the first one is 8-byte aligned.  When this
20893 option is enabled, GCC aligns pairs of instructions that it
20894 thinks should execute in parallel.
20896 This option only has an effect when optimizing for the VR4130.
20897 It normally makes code faster, but at the expense of making it bigger.
20898 It is enabled by default at optimization level @option{-O3}.
20900 @item -msynci
20901 @itemx -mno-synci
20902 @opindex msynci
20903 Enable (disable) generation of @code{synci} instructions on
20904 architectures that support it.  The @code{synci} instructions (if
20905 enabled) are generated when @code{__builtin___clear_cache} is
20906 compiled.
20908 This option defaults to @option{-mno-synci}, but the default can be
20909 overridden by configuring GCC with @option{--with-synci}.
20911 When compiling code for single processor systems, it is generally safe
20912 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20913 does not invalidate the instruction caches on all cores and may lead
20914 to undefined behavior.
20916 @item -mrelax-pic-calls
20917 @itemx -mno-relax-pic-calls
20918 @opindex mrelax-pic-calls
20919 Try to turn PIC calls that are normally dispatched via register
20920 @code{$25} into direct calls.  This is only possible if the linker can
20921 resolve the destination at link time and if the destination is within
20922 range for a direct call.
20924 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20925 an assembler and a linker that support the @code{.reloc} assembly
20926 directive and @option{-mexplicit-relocs} is in effect.  With
20927 @option{-mno-explicit-relocs}, this optimization can be performed by the
20928 assembler and the linker alone without help from the compiler.
20930 @item -mmcount-ra-address
20931 @itemx -mno-mcount-ra-address
20932 @opindex mmcount-ra-address
20933 @opindex mno-mcount-ra-address
20934 Emit (do not emit) code that allows @code{_mcount} to modify the
20935 calling function's return address.  When enabled, this option extends
20936 the usual @code{_mcount} interface with a new @var{ra-address}
20937 parameter, which has type @code{intptr_t *} and is passed in register
20938 @code{$12}.  @code{_mcount} can then modify the return address by
20939 doing both of the following:
20940 @itemize
20941 @item
20942 Returning the new address in register @code{$31}.
20943 @item
20944 Storing the new address in @code{*@var{ra-address}},
20945 if @var{ra-address} is nonnull.
20946 @end itemize
20948 The default is @option{-mno-mcount-ra-address}.
20950 @item -mframe-header-opt
20951 @itemx -mno-frame-header-opt
20952 @opindex mframe-header-opt
20953 Enable (disable) frame header optimization in the o32 ABI.  When using the
20954 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20955 function to write out register arguments.  When enabled, this optimization
20956 will suppress the allocation of the frame header if it can be determined that
20957 it is unused.
20959 This optimization is off by default at all optimization levels.
20961 @item -mlxc1-sxc1
20962 @itemx -mno-lxc1-sxc1
20963 @opindex mlxc1-sxc1
20964 When applicable, enable (disable) the generation of @code{lwxc1},
20965 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20967 @item -mmadd4
20968 @itemx -mno-madd4
20969 @opindex mmadd4
20970 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20971 @code{madd.d} and related instructions.  Enabled by default.
20973 @end table
20975 @node MMIX Options
20976 @subsection MMIX Options
20977 @cindex MMIX Options
20979 These options are defined for the MMIX:
20981 @table @gcctabopt
20982 @item -mlibfuncs
20983 @itemx -mno-libfuncs
20984 @opindex mlibfuncs
20985 @opindex mno-libfuncs
20986 Specify that intrinsic library functions are being compiled, passing all
20987 values in registers, no matter the size.
20989 @item -mepsilon
20990 @itemx -mno-epsilon
20991 @opindex mepsilon
20992 @opindex mno-epsilon
20993 Generate floating-point comparison instructions that compare with respect
20994 to the @code{rE} epsilon register.
20996 @item -mabi=mmixware
20997 @itemx -mabi=gnu
20998 @opindex mabi=mmixware
20999 @opindex mabi=gnu
21000 Generate code that passes function parameters and return values that (in
21001 the called function) are seen as registers @code{$0} and up, as opposed to
21002 the GNU ABI which uses global registers @code{$231} and up.
21004 @item -mzero-extend
21005 @itemx -mno-zero-extend
21006 @opindex mzero-extend
21007 @opindex mno-zero-extend
21008 When reading data from memory in sizes shorter than 64 bits, use (do not
21009 use) zero-extending load instructions by default, rather than
21010 sign-extending ones.
21012 @item -mknuthdiv
21013 @itemx -mno-knuthdiv
21014 @opindex mknuthdiv
21015 @opindex mno-knuthdiv
21016 Make the result of a division yielding a remainder have the same sign as
21017 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
21018 remainder follows the sign of the dividend.  Both methods are
21019 arithmetically valid, the latter being almost exclusively used.
21021 @item -mtoplevel-symbols
21022 @itemx -mno-toplevel-symbols
21023 @opindex mtoplevel-symbols
21024 @opindex mno-toplevel-symbols
21025 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
21026 code can be used with the @code{PREFIX} assembly directive.
21028 @item -melf
21029 @opindex melf
21030 Generate an executable in the ELF format, rather than the default
21031 @samp{mmo} format used by the @command{mmix} simulator.
21033 @item -mbranch-predict
21034 @itemx -mno-branch-predict
21035 @opindex mbranch-predict
21036 @opindex mno-branch-predict
21037 Use (do not use) the probable-branch instructions, when static branch
21038 prediction indicates a probable branch.
21040 @item -mbase-addresses
21041 @itemx -mno-base-addresses
21042 @opindex mbase-addresses
21043 @opindex mno-base-addresses
21044 Generate (do not generate) code that uses @emph{base addresses}.  Using a
21045 base address automatically generates a request (handled by the assembler
21046 and the linker) for a constant to be set up in a global register.  The
21047 register is used for one or more base address requests within the range 0
21048 to 255 from the value held in the register.  The generally leads to short
21049 and fast code, but the number of different data items that can be
21050 addressed is limited.  This means that a program that uses lots of static
21051 data may require @option{-mno-base-addresses}.
21053 @item -msingle-exit
21054 @itemx -mno-single-exit
21055 @opindex msingle-exit
21056 @opindex mno-single-exit
21057 Force (do not force) generated code to have a single exit point in each
21058 function.
21059 @end table
21061 @node MN10300 Options
21062 @subsection MN10300 Options
21063 @cindex MN10300 options
21065 These @option{-m} options are defined for Matsushita MN10300 architectures:
21067 @table @gcctabopt
21068 @item -mmult-bug
21069 @opindex mmult-bug
21070 Generate code to avoid bugs in the multiply instructions for the MN10300
21071 processors.  This is the default.
21073 @item -mno-mult-bug
21074 @opindex mno-mult-bug
21075 Do not generate code to avoid bugs in the multiply instructions for the
21076 MN10300 processors.
21078 @item -mam33
21079 @opindex mam33
21080 Generate code using features specific to the AM33 processor.
21082 @item -mno-am33
21083 @opindex mno-am33
21084 Do not generate code using features specific to the AM33 processor.  This
21085 is the default.
21087 @item -mam33-2
21088 @opindex mam33-2
21089 Generate code using features specific to the AM33/2.0 processor.
21091 @item -mam34
21092 @opindex mam34
21093 Generate code using features specific to the AM34 processor.
21095 @item -mtune=@var{cpu-type}
21096 @opindex mtune
21097 Use the timing characteristics of the indicated CPU type when
21098 scheduling instructions.  This does not change the targeted processor
21099 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
21100 @samp{am33-2} or @samp{am34}.
21102 @item -mreturn-pointer-on-d0
21103 @opindex mreturn-pointer-on-d0
21104 When generating a function that returns a pointer, return the pointer
21105 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
21106 only in @code{a0}, and attempts to call such functions without a prototype
21107 result in errors.  Note that this option is on by default; use
21108 @option{-mno-return-pointer-on-d0} to disable it.
21110 @item -mno-crt0
21111 @opindex mno-crt0
21112 Do not link in the C run-time initialization object file.
21114 @item -mrelax
21115 @opindex mrelax
21116 Indicate to the linker that it should perform a relaxation optimization pass
21117 to shorten branches, calls and absolute memory addresses.  This option only
21118 has an effect when used on the command line for the final link step.
21120 This option makes symbolic debugging impossible.
21122 @item -mliw
21123 @opindex mliw
21124 Allow the compiler to generate @emph{Long Instruction Word}
21125 instructions if the target is the @samp{AM33} or later.  This is the
21126 default.  This option defines the preprocessor macro @code{__LIW__}.
21128 @item -mnoliw
21129 @opindex mnoliw
21130 Do not allow the compiler to generate @emph{Long Instruction Word}
21131 instructions.  This option defines the preprocessor macro
21132 @code{__NO_LIW__}.
21134 @item -msetlb
21135 @opindex msetlb
21136 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
21137 instructions if the target is the @samp{AM33} or later.  This is the
21138 default.  This option defines the preprocessor macro @code{__SETLB__}.
21140 @item -mnosetlb
21141 @opindex mnosetlb
21142 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
21143 instructions.  This option defines the preprocessor macro
21144 @code{__NO_SETLB__}.
21146 @end table
21148 @node Moxie Options
21149 @subsection Moxie Options
21150 @cindex Moxie Options
21152 @table @gcctabopt
21154 @item -meb
21155 @opindex meb
21156 Generate big-endian code.  This is the default for @samp{moxie-*-*}
21157 configurations.
21159 @item -mel
21160 @opindex mel
21161 Generate little-endian code.
21163 @item -mmul.x
21164 @opindex mmul.x
21165 Generate mul.x and umul.x instructions.  This is the default for
21166 @samp{moxiebox-*-*} configurations.
21168 @item -mno-crt0
21169 @opindex mno-crt0
21170 Do not link in the C run-time initialization object file.
21172 @end table
21174 @node MSP430 Options
21175 @subsection MSP430 Options
21176 @cindex MSP430 Options
21178 These options are defined for the MSP430:
21180 @table @gcctabopt
21182 @item -masm-hex
21183 @opindex masm-hex
21184 Force assembly output to always use hex constants.  Normally such
21185 constants are signed decimals, but this option is available for
21186 testsuite and/or aesthetic purposes.
21188 @item -mmcu=
21189 @opindex mmcu=
21190 Select the MCU to target.  This is used to create a C preprocessor
21191 symbol based upon the MCU name, converted to upper case and pre- and
21192 post-fixed with @samp{__}.  This in turn is used by the
21193 @file{msp430.h} header file to select an MCU-specific supplementary
21194 header file.
21196 The option also sets the ISA to use.  If the MCU name is one that is
21197 known to only support the 430 ISA then that is selected, otherwise the
21198 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
21199 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
21200 name selects the 430X ISA.
21202 In addition an MCU-specific linker script is added to the linker
21203 command line.  The script's name is the name of the MCU with
21204 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
21205 command line defines the C preprocessor symbol @code{__XXX__} and
21206 cause the linker to search for a script called @file{xxx.ld}.
21208 This option is also passed on to the assembler.
21210 @item -mwarn-mcu
21211 @itemx -mno-warn-mcu
21212 @opindex mwarn-mcu
21213 @opindex mno-warn-mcu
21214 This option enables or disables warnings about conflicts between the
21215 MCU name specified by the @option{-mmcu} option and the ISA set by the
21216 @option{-mcpu} option and/or the hardware multiply support set by the
21217 @option{-mhwmult} option.  It also toggles warnings about unrecognized
21218 MCU names.  This option is on by default.
21220 @item -mcpu=
21221 @opindex mcpu=
21222 Specifies the ISA to use.  Accepted values are @samp{msp430},
21223 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
21224 @option{-mmcu=} option should be used to select the ISA.
21226 @item -msim
21227 @opindex msim
21228 Link to the simulator runtime libraries and linker script.  Overrides
21229 any scripts that would be selected by the @option{-mmcu=} option.
21231 @item -mlarge
21232 @opindex mlarge
21233 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
21235 @item -msmall
21236 @opindex msmall
21237 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
21239 @item -mrelax
21240 @opindex mrelax
21241 This option is passed to the assembler and linker, and allows the
21242 linker to perform certain optimizations that cannot be done until
21243 the final link.
21245 @item mhwmult=
21246 @opindex mhwmult=
21247 Describes the type of hardware multiply supported by the target.
21248 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
21249 for the original 16-bit-only multiply supported by early MCUs.
21250 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
21251 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
21252 A value of @samp{auto} can also be given.  This tells GCC to deduce
21253 the hardware multiply support based upon the MCU name provided by the
21254 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
21255 the MCU name is not recognized then no hardware multiply support is
21256 assumed.  @code{auto} is the default setting.
21258 Hardware multiplies are normally performed by calling a library
21259 routine.  This saves space in the generated code.  When compiling at
21260 @option{-O3} or higher however the hardware multiplier is invoked
21261 inline.  This makes for bigger, but faster code.
21263 The hardware multiply routines disable interrupts whilst running and
21264 restore the previous interrupt state when they finish.  This makes
21265 them safe to use inside interrupt handlers as well as in normal code.
21267 @item -minrt
21268 @opindex minrt
21269 Enable the use of a minimum runtime environment - no static
21270 initializers or constructors.  This is intended for memory-constrained
21271 devices.  The compiler includes special symbols in some objects
21272 that tell the linker and runtime which code fragments are required.
21274 @item -mcode-region=
21275 @itemx -mdata-region=
21276 @opindex mcode-region
21277 @opindex mdata-region
21278 These options tell the compiler where to place functions and data that
21279 do not have one of the @code{lower}, @code{upper}, @code{either} or
21280 @code{section} attributes.  Possible values are @code{lower},
21281 @code{upper}, @code{either} or @code{any}.  The first three behave
21282 like the corresponding attribute.  The fourth possible value -
21283 @code{any} - is the default.  It leaves placement entirely up to the
21284 linker script and how it assigns the standard sections
21285 (@code{.text}, @code{.data}, etc) to the memory regions.
21287 @item -msilicon-errata=
21288 @opindex msilicon-errata
21289 This option passes on a request to assembler to enable the fixes for
21290 the named silicon errata.
21292 @item -msilicon-errata-warn=
21293 @opindex msilicon-errata-warn
21294 This option passes on a request to the assembler to enable warning
21295 messages when a silicon errata might need to be applied.
21297 @end table
21299 @node NDS32 Options
21300 @subsection NDS32 Options
21301 @cindex NDS32 Options
21303 These options are defined for NDS32 implementations:
21305 @table @gcctabopt
21307 @item -mbig-endian
21308 @opindex mbig-endian
21309 Generate code in big-endian mode.
21311 @item -mlittle-endian
21312 @opindex mlittle-endian
21313 Generate code in little-endian mode.
21315 @item -mreduced-regs
21316 @opindex mreduced-regs
21317 Use reduced-set registers for register allocation.
21319 @item -mfull-regs
21320 @opindex mfull-regs
21321 Use full-set registers for register allocation.
21323 @item -mcmov
21324 @opindex mcmov
21325 Generate conditional move instructions.
21327 @item -mno-cmov
21328 @opindex mno-cmov
21329 Do not generate conditional move instructions.
21331 @item -mext-perf
21332 @opindex mperf-ext
21333 Generate performance extension instructions.
21335 @item -mno-ext-perf
21336 @opindex mno-perf-ext
21337 Do not generate performance extension instructions.
21339 @item -mext-perf2
21340 @opindex mperf-ext
21341 Generate performance extension 2 instructions.
21343 @item -mno-ext-perf2
21344 @opindex mno-perf-ext
21345 Do not generate performance extension 2 instructions.
21347 @item -mext-string
21348 @opindex mperf-ext
21349 Generate string extension instructions.
21351 @item -mno-ext-string
21352 @opindex mno-perf-ext
21353 Do not generate string extension instructions.
21355 @item -mv3push
21356 @opindex mv3push
21357 Generate v3 push25/pop25 instructions.
21359 @item -mno-v3push
21360 @opindex mno-v3push
21361 Do not generate v3 push25/pop25 instructions.
21363 @item -m16-bit
21364 @opindex m16-bit
21365 Generate 16-bit instructions.
21367 @item -mno-16-bit
21368 @opindex mno-16-bit
21369 Do not generate 16-bit instructions.
21371 @item -misr-vector-size=@var{num}
21372 @opindex misr-vector-size
21373 Specify the size of each interrupt vector, which must be 4 or 16.
21375 @item -mcache-block-size=@var{num}
21376 @opindex mcache-block-size
21377 Specify the size of each cache block,
21378 which must be a power of 2 between 4 and 512.
21380 @item -march=@var{arch}
21381 @opindex march
21382 Specify the name of the target architecture.
21384 @item -mcmodel=@var{code-model}
21385 @opindex mcmodel
21386 Set the code model to one of
21387 @table @asis
21388 @item @samp{small}
21389 All the data and read-only data segments must be within 512KB addressing space.
21390 The text segment must be within 16MB addressing space.
21391 @item @samp{medium}
21392 The data segment must be within 512KB while the read-only data segment can be
21393 within 4GB addressing space.  The text segment should be still within 16MB
21394 addressing space.
21395 @item @samp{large}
21396 All the text and data segments can be within 4GB addressing space.
21397 @end table
21399 @item -mctor-dtor
21400 @opindex mctor-dtor
21401 Enable constructor/destructor feature.
21403 @item -mrelax
21404 @opindex mrelax
21405 Guide linker to relax instructions.
21407 @end table
21409 @node Nios II Options
21410 @subsection Nios II Options
21411 @cindex Nios II options
21412 @cindex Altera Nios II options
21414 These are the options defined for the Altera Nios II processor.
21416 @table @gcctabopt
21418 @item -G @var{num}
21419 @opindex G
21420 @cindex smaller data references
21421 Put global and static objects less than or equal to @var{num} bytes
21422 into the small data or BSS sections instead of the normal data or BSS
21423 sections.  The default value of @var{num} is 8.
21425 @item -mgpopt=@var{option}
21426 @item -mgpopt
21427 @itemx -mno-gpopt
21428 @opindex mgpopt
21429 @opindex mno-gpopt
21430 Generate (do not generate) GP-relative accesses.  The following 
21431 @var{option} names are recognized:
21433 @table @samp
21435 @item none
21436 Do not generate GP-relative accesses.
21438 @item local
21439 Generate GP-relative accesses for small data objects that are not 
21440 external, weak, or uninitialized common symbols.  
21441 Also use GP-relative addressing for objects that
21442 have been explicitly placed in a small data section via a @code{section}
21443 attribute.
21445 @item global
21446 As for @samp{local}, but also generate GP-relative accesses for
21447 small data objects that are external, weak, or common.  If you use this option,
21448 you must ensure that all parts of your program (including libraries) are
21449 compiled with the same @option{-G} setting.
21451 @item data
21452 Generate GP-relative accesses for all data objects in the program.  If you
21453 use this option, the entire data and BSS segments
21454 of your program must fit in 64K of memory and you must use an appropriate
21455 linker script to allocate them within the addressable range of the
21456 global pointer.
21458 @item all
21459 Generate GP-relative addresses for function pointers as well as data
21460 pointers.  If you use this option, the entire text, data, and BSS segments
21461 of your program must fit in 64K of memory and you must use an appropriate
21462 linker script to allocate them within the addressable range of the
21463 global pointer.
21465 @end table
21467 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21468 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21470 The default is @option{-mgpopt} except when @option{-fpic} or
21471 @option{-fPIC} is specified to generate position-independent code.
21472 Note that the Nios II ABI does not permit GP-relative accesses from
21473 shared libraries.
21475 You may need to specify @option{-mno-gpopt} explicitly when building
21476 programs that include large amounts of small data, including large
21477 GOT data sections.  In this case, the 16-bit offset for GP-relative
21478 addressing may not be large enough to allow access to the entire 
21479 small data section.
21481 @item -mgprel-sec=@var{regexp}
21482 @opindex mgprel-sec
21483 This option specifies additional section names that can be accessed via
21484 GP-relative addressing.  It is most useful in conjunction with 
21485 @code{section} attributes on variable declarations 
21486 (@pxref{Common Variable Attributes}) and a custom linker script.  
21487 The @var{regexp} is a POSIX Extended Regular Expression.
21489 This option does not affect the behavior of the @option{-G} option, and 
21490 and the specified sections are in addition to the standard @code{.sdata} 
21491 and @code{.sbss} small-data sections that are recognized by @option{-mgpopt}.
21493 @item -mr0rel-sec=@var{regexp}
21494 @opindex mr0rel-sec
21495 This option specifies names of sections that can be accessed via a 
21496 16-bit offset from @code{r0}; that is, in the low 32K or high 32K 
21497 of the 32-bit address space.  It is most useful in conjunction with 
21498 @code{section} attributes on variable declarations 
21499 (@pxref{Common Variable Attributes}) and a custom linker script.  
21500 The @var{regexp} is a POSIX Extended Regular Expression.
21502 In contrast to the use of GP-relative addressing for small data, 
21503 zero-based addressing is never generated by default and there are no 
21504 conventional section names used in standard linker scripts for sections
21505 in the low or high areas of memory.
21507 @item -mel
21508 @itemx -meb
21509 @opindex mel
21510 @opindex meb
21511 Generate little-endian (default) or big-endian (experimental) code,
21512 respectively.
21514 @item -march=@var{arch}
21515 @opindex march
21516 This specifies the name of the target Nios II architecture.  GCC uses this
21517 name to determine what kind of instructions it can emit when generating
21518 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21520 The preprocessor macro @code{__nios2_arch__} is available to programs,
21521 with value 1 or 2, indicating the targeted ISA level.
21523 @item -mbypass-cache
21524 @itemx -mno-bypass-cache
21525 @opindex mno-bypass-cache
21526 @opindex mbypass-cache
21527 Force all load and store instructions to always bypass cache by 
21528 using I/O variants of the instructions. The default is not to
21529 bypass the cache.
21531 @item -mno-cache-volatile 
21532 @itemx -mcache-volatile       
21533 @opindex mcache-volatile 
21534 @opindex mno-cache-volatile
21535 Volatile memory access bypass the cache using the I/O variants of 
21536 the load and store instructions. The default is not to bypass the cache.
21538 @item -mno-fast-sw-div
21539 @itemx -mfast-sw-div
21540 @opindex mno-fast-sw-div
21541 @opindex mfast-sw-div
21542 Do not use table-based fast divide for small numbers. The default 
21543 is to use the fast divide at @option{-O3} and above.
21545 @item -mno-hw-mul
21546 @itemx -mhw-mul
21547 @itemx -mno-hw-mulx
21548 @itemx -mhw-mulx
21549 @itemx -mno-hw-div
21550 @itemx -mhw-div
21551 @opindex mno-hw-mul
21552 @opindex mhw-mul
21553 @opindex mno-hw-mulx
21554 @opindex mhw-mulx
21555 @opindex mno-hw-div
21556 @opindex mhw-div
21557 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21558 instructions by the compiler. The default is to emit @code{mul}
21559 and not emit @code{div} and @code{mulx}.
21561 @item -mbmx
21562 @itemx -mno-bmx
21563 @itemx -mcdx
21564 @itemx -mno-cdx
21565 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21566 CDX (code density) instructions.  Enabling these instructions also
21567 requires @option{-march=r2}.  Since these instructions are optional
21568 extensions to the R2 architecture, the default is not to emit them.
21570 @item -mcustom-@var{insn}=@var{N}
21571 @itemx -mno-custom-@var{insn}
21572 @opindex mcustom-@var{insn}
21573 @opindex mno-custom-@var{insn}
21574 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21575 custom instruction with encoding @var{N} when generating code that uses 
21576 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21577 instruction 253 for single-precision floating-point add operations instead
21578 of the default behavior of using a library call.
21580 The following values of @var{insn} are supported.  Except as otherwise
21581 noted, floating-point operations are expected to be implemented with
21582 normal IEEE 754 semantics and correspond directly to the C operators or the
21583 equivalent GCC built-in functions (@pxref{Other Builtins}).
21585 Single-precision floating point:
21586 @table @asis
21588 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21589 Binary arithmetic operations.
21591 @item @samp{fnegs}
21592 Unary negation.
21594 @item @samp{fabss}
21595 Unary absolute value.
21597 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21598 Comparison operations.
21600 @item @samp{fmins}, @samp{fmaxs}
21601 Floating-point minimum and maximum.  These instructions are only
21602 generated if @option{-ffinite-math-only} is specified.
21604 @item @samp{fsqrts}
21605 Unary square root operation.
21607 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21608 Floating-point trigonometric and exponential functions.  These instructions
21609 are only generated if @option{-funsafe-math-optimizations} is also specified.
21611 @end table
21613 Double-precision floating point:
21614 @table @asis
21616 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21617 Binary arithmetic operations.
21619 @item @samp{fnegd}
21620 Unary negation.
21622 @item @samp{fabsd}
21623 Unary absolute value.
21625 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21626 Comparison operations.
21628 @item @samp{fmind}, @samp{fmaxd}
21629 Double-precision minimum and maximum.  These instructions are only
21630 generated if @option{-ffinite-math-only} is specified.
21632 @item @samp{fsqrtd}
21633 Unary square root operation.
21635 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21636 Double-precision trigonometric and exponential functions.  These instructions
21637 are only generated if @option{-funsafe-math-optimizations} is also specified.
21639 @end table
21641 Conversions:
21642 @table @asis
21643 @item @samp{fextsd}
21644 Conversion from single precision to double precision.
21646 @item @samp{ftruncds}
21647 Conversion from double precision to single precision.
21649 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21650 Conversion from floating point to signed or unsigned integer types, with
21651 truncation towards zero.
21653 @item @samp{round}
21654 Conversion from single-precision floating point to signed integer,
21655 rounding to the nearest integer and ties away from zero.
21656 This corresponds to the @code{__builtin_lroundf} function when
21657 @option{-fno-math-errno} is used.
21659 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21660 Conversion from signed or unsigned integer types to floating-point types.
21662 @end table
21664 In addition, all of the following transfer instructions for internal
21665 registers X and Y must be provided to use any of the double-precision
21666 floating-point instructions.  Custom instructions taking two
21667 double-precision source operands expect the first operand in the
21668 64-bit register X.  The other operand (or only operand of a unary
21669 operation) is given to the custom arithmetic instruction with the
21670 least significant half in source register @var{src1} and the most
21671 significant half in @var{src2}.  A custom instruction that returns a
21672 double-precision result returns the most significant 32 bits in the
21673 destination register and the other half in 32-bit register Y.  
21674 GCC automatically generates the necessary code sequences to write
21675 register X and/or read register Y when double-precision floating-point
21676 instructions are used.
21678 @table @asis
21680 @item @samp{fwrx}
21681 Write @var{src1} into the least significant half of X and @var{src2} into
21682 the most significant half of X.
21684 @item @samp{fwry}
21685 Write @var{src1} into Y.
21687 @item @samp{frdxhi}, @samp{frdxlo}
21688 Read the most or least (respectively) significant half of X and store it in
21689 @var{dest}.
21691 @item @samp{frdy}
21692 Read the value of Y and store it into @var{dest}.
21693 @end table
21695 Note that you can gain more local control over generation of Nios II custom
21696 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21697 and @code{target("no-custom-@var{insn}")} function attributes
21698 (@pxref{Function Attributes})
21699 or pragmas (@pxref{Function Specific Option Pragmas}).
21701 @item -mcustom-fpu-cfg=@var{name}
21702 @opindex mcustom-fpu-cfg
21704 This option enables a predefined, named set of custom instruction encodings
21705 (see @option{-mcustom-@var{insn}} above).  
21706 Currently, the following sets are defined:
21708 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21709 @gccoptlist{-mcustom-fmuls=252 @gol
21710 -mcustom-fadds=253 @gol
21711 -mcustom-fsubs=254 @gol
21712 -fsingle-precision-constant}
21714 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21715 @gccoptlist{-mcustom-fmuls=252 @gol
21716 -mcustom-fadds=253 @gol
21717 -mcustom-fsubs=254 @gol
21718 -mcustom-fdivs=255 @gol
21719 -fsingle-precision-constant}
21721 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21722 @gccoptlist{-mcustom-floatus=243 @gol
21723 -mcustom-fixsi=244 @gol
21724 -mcustom-floatis=245 @gol
21725 -mcustom-fcmpgts=246 @gol
21726 -mcustom-fcmples=249 @gol
21727 -mcustom-fcmpeqs=250 @gol
21728 -mcustom-fcmpnes=251 @gol
21729 -mcustom-fmuls=252 @gol
21730 -mcustom-fadds=253 @gol
21731 -mcustom-fsubs=254 @gol
21732 -mcustom-fdivs=255 @gol
21733 -fsingle-precision-constant}
21735 Custom instruction assignments given by individual
21736 @option{-mcustom-@var{insn}=} options override those given by
21737 @option{-mcustom-fpu-cfg=}, regardless of the
21738 order of the options on the command line.
21740 Note that you can gain more local control over selection of a FPU
21741 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21742 function attribute (@pxref{Function Attributes})
21743 or pragma (@pxref{Function Specific Option Pragmas}).
21745 @end table
21747 These additional @samp{-m} options are available for the Altera Nios II
21748 ELF (bare-metal) target:
21750 @table @gcctabopt
21752 @item -mhal
21753 @opindex mhal
21754 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21755 startup and termination code, and is typically used in conjunction with
21756 @option{-msys-crt0=} to specify the location of the alternate startup code
21757 provided by the HAL BSP.
21759 @item -msmallc
21760 @opindex msmallc
21761 Link with a limited version of the C library, @option{-lsmallc}, rather than
21762 Newlib.
21764 @item -msys-crt0=@var{startfile}
21765 @opindex msys-crt0
21766 @var{startfile} is the file name of the startfile (crt0) to use 
21767 when linking.  This option is only useful in conjunction with @option{-mhal}.
21769 @item -msys-lib=@var{systemlib}
21770 @opindex msys-lib
21771 @var{systemlib} is the library name of the library that provides
21772 low-level system calls required by the C library,
21773 e.g. @code{read} and @code{write}.
21774 This option is typically used to link with a library provided by a HAL BSP.
21776 @end table
21778 @node Nvidia PTX Options
21779 @subsection Nvidia PTX Options
21780 @cindex Nvidia PTX options
21781 @cindex nvptx options
21783 These options are defined for Nvidia PTX:
21785 @table @gcctabopt
21787 @item -m32
21788 @itemx -m64
21789 @opindex m32
21790 @opindex m64
21791 Generate code for 32-bit or 64-bit ABI.
21793 @item -mmainkernel
21794 @opindex mmainkernel
21795 Link in code for a __main kernel.  This is for stand-alone instead of
21796 offloading execution.
21798 @item -moptimize
21799 @opindex moptimize
21800 Apply partitioned execution optimizations.  This is the default when any
21801 level of optimization is selected.
21803 @item -msoft-stack
21804 @opindex msoft-stack
21805 Generate code that does not use @code{.local} memory
21806 directly for stack storage. Instead, a per-warp stack pointer is
21807 maintained explicitly. This enables variable-length stack allocation (with
21808 variable-length arrays or @code{alloca}), and when global memory is used for
21809 underlying storage, makes it possible to access automatic variables from other
21810 threads, or with atomic instructions. This code generation variant is used
21811 for OpenMP offloading, but the option is exposed on its own for the purpose
21812 of testing the compiler; to generate code suitable for linking into programs
21813 using OpenMP offloading, use option @option{-mgomp}.
21815 @item -muniform-simt
21816 @opindex muniform-simt
21817 Switch to code generation variant that allows to execute all threads in each
21818 warp, while maintaining memory state and side effects as if only one thread
21819 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21820 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21821 current lane index equals the master lane index), and the register being
21822 assigned is copied via a shuffle instruction from the master lane.  Outside of
21823 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21824 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21825 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21826 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21827 with current lane index to compute the master lane index.
21829 @item -mgomp
21830 @opindex mgomp
21831 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21832 @option{-muniform-simt} options, and selects corresponding multilib variant.
21834 @end table
21836 @node PDP-11 Options
21837 @subsection PDP-11 Options
21838 @cindex PDP-11 Options
21840 These options are defined for the PDP-11:
21842 @table @gcctabopt
21843 @item -mfpu
21844 @opindex mfpu
21845 Use hardware FPP floating point.  This is the default.  (FIS floating
21846 point on the PDP-11/40 is not supported.)
21848 @item -msoft-float
21849 @opindex msoft-float
21850 Do not use hardware floating point.
21852 @item -mac0
21853 @opindex mac0
21854 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21856 @item -mno-ac0
21857 @opindex mno-ac0
21858 Return floating-point results in memory.  This is the default.
21860 @item -m40
21861 @opindex m40
21862 Generate code for a PDP-11/40.
21864 @item -m45
21865 @opindex m45
21866 Generate code for a PDP-11/45.  This is the default.
21868 @item -m10
21869 @opindex m10
21870 Generate code for a PDP-11/10.
21872 @item -mbcopy-builtin
21873 @opindex mbcopy-builtin
21874 Use inline @code{movmemhi} patterns for copying memory.  This is the
21875 default.
21877 @item -mbcopy
21878 @opindex mbcopy
21879 Do not use inline @code{movmemhi} patterns for copying memory.
21881 @item -mint16
21882 @itemx -mno-int32
21883 @opindex mint16
21884 @opindex mno-int32
21885 Use 16-bit @code{int}.  This is the default.
21887 @item -mint32
21888 @itemx -mno-int16
21889 @opindex mint32
21890 @opindex mno-int16
21891 Use 32-bit @code{int}.
21893 @item -mfloat64
21894 @itemx -mno-float32
21895 @opindex mfloat64
21896 @opindex mno-float32
21897 Use 64-bit @code{float}.  This is the default.
21899 @item -mfloat32
21900 @itemx -mno-float64
21901 @opindex mfloat32
21902 @opindex mno-float64
21903 Use 32-bit @code{float}.
21905 @item -mabshi
21906 @opindex mabshi
21907 Use @code{abshi2} pattern.  This is the default.
21909 @item -mno-abshi
21910 @opindex mno-abshi
21911 Do not use @code{abshi2} pattern.
21913 @item -mbranch-expensive
21914 @opindex mbranch-expensive
21915 Pretend that branches are expensive.  This is for experimenting with
21916 code generation only.
21918 @item -mbranch-cheap
21919 @opindex mbranch-cheap
21920 Do not pretend that branches are expensive.  This is the default.
21922 @item -munix-asm
21923 @opindex munix-asm
21924 Use Unix assembler syntax.  This is the default when configured for
21925 @samp{pdp11-*-bsd}.
21927 @item -mdec-asm
21928 @opindex mdec-asm
21929 Use DEC assembler syntax.  This is the default when configured for any
21930 PDP-11 target other than @samp{pdp11-*-bsd}.
21931 @end table
21933 @node picoChip Options
21934 @subsection picoChip Options
21935 @cindex picoChip options
21937 These @samp{-m} options are defined for picoChip implementations:
21939 @table @gcctabopt
21941 @item -mae=@var{ae_type}
21942 @opindex mcpu
21943 Set the instruction set, register set, and instruction scheduling
21944 parameters for array element type @var{ae_type}.  Supported values
21945 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21947 @option{-mae=ANY} selects a completely generic AE type.  Code
21948 generated with this option runs on any of the other AE types.  The
21949 code is not as efficient as it would be if compiled for a specific
21950 AE type, and some types of operation (e.g., multiplication) do not
21951 work properly on all types of AE.
21953 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21954 for compiled code, and is the default.
21956 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21957 option may suffer from poor performance of byte (char) manipulation,
21958 since the DSP AE does not provide hardware support for byte load/stores.
21960 @item -msymbol-as-address
21961 Enable the compiler to directly use a symbol name as an address in a
21962 load/store instruction, without first loading it into a
21963 register.  Typically, the use of this option generates larger
21964 programs, which run faster than when the option isn't used.  However, the
21965 results vary from program to program, so it is left as a user option,
21966 rather than being permanently enabled.
21968 @item -mno-inefficient-warnings
21969 Disables warnings about the generation of inefficient code.  These
21970 warnings can be generated, for example, when compiling code that
21971 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21972 no hardware support for byte-level memory operations, so all byte
21973 load/stores must be synthesized from word load/store operations.  This is
21974 inefficient and a warning is generated to indicate
21975 that you should rewrite the code to avoid byte operations, or to target
21976 an AE type that has the necessary hardware support.  This option disables
21977 these warnings.
21979 @end table
21981 @node PowerPC Options
21982 @subsection PowerPC Options
21983 @cindex PowerPC options
21985 These are listed under @xref{RS/6000 and PowerPC Options}.
21987 @node RISC-V Options
21988 @subsection RISC-V Options
21989 @cindex RISC-V Options
21991 These command-line options are defined for RISC-V targets:
21993 @table @gcctabopt
21994 @item -mbranch-cost=@var{n}
21995 @opindex mbranch-cost
21996 Set the cost of branches to roughly @var{n} instructions.
21998 @item -mplt
21999 @itemx -mno-plt
22000 @opindex plt
22001 When generating PIC code, do or don't allow the use of PLTs. Ignored for
22002 non-PIC.  The default is @option{-mplt}.
22004 @item -mabi=@var{ABI-string}
22005 @opindex mabi
22006 Specify integer and floating-point calling convention.  @var{ABI-string}
22007 contains two parts: the size of integer types and the registers used for
22008 floating-point types.  For example @samp{-march=rv64ifd -mabi=lp64d} means that
22009 @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be
22010 32-bit), and that floating-point values up to 64 bits wide are passed in F
22011 registers.  Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still
22012 allows the compiler to generate code that uses the F and D extensions but only
22013 allows floating-point values up to 32 bits long to be passed in registers; or
22014 @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments will be
22015 passed in registers.
22017 The default for this argument is system dependent, users who want a specific
22018 calling convention should specify one explicitly.  The valid calling
22019 conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64},
22020 @samp{lp64f}, and @samp{lp64d}.  Some calling conventions are impossible to
22021 implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is
22022 invalid because the ABI requires 64-bit values be passed in F registers, but F
22023 registers are only 32 bits wide.
22025 @item -mfdiv
22026 @itemx -mno-fdiv
22027 @opindex mfdiv
22028 Do or don't use hardware floating-point divide and square root instructions.
22029 This requires the F or D extensions for floating-point registers.  The default
22030 is to use them if the specified architecture has these instructions.
22032 @item -mdiv
22033 @itemx -mno-div
22034 @opindex mdiv
22035 Do or don't use hardware instructions for integer division.  This requires the
22036 M extension.  The default is to use them if the specified architecture has
22037 these instructions.
22039 @item -march=@var{ISA-string}
22040 @opindex march
22041 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
22042 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
22044 @item -mtune=@var{processor-string}
22045 @opindex mtune
22046 Optimize the output for the given processor, specified by microarchitecture
22047 name.
22049 @item -msmall-data-limit=@var{n}
22050 @opindex msmall-data-limit
22051 Put global and static data smaller than @var{n} bytes into a special section
22052 (on some targets).
22054 @item -msave-restore
22055 @itemx -mno-save-restore
22056 @opindex msave-restore
22057 Do or don't use smaller but slower prologue and epilogue code that uses
22058 library function calls.  The default is to use fast inline prologues and
22059 epilogues.
22061 @item -mstrict-align
22062 @itemx -mno-strict-align
22063 @opindex mstrict-align
22064 Do not or do generate unaligned memory accesses.  The default is set depending
22065 on whether the processor we are optimizing for supports fast unaligned access
22066 or not.
22068 @item -mcmodel=medlow
22069 @opindex mcmodel=medlow
22070 Generate code for the medium-low code model. The program and its statically
22071 defined symbols must lie within a single 2 GiB address range and must lie
22072 between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be
22073 statically or dynamically linked. This is the default code model.
22075 @item -mcmodel=medany
22076 @opindex mcmodel=medany
22077 Generate code for the medium-any code model. The program and its statically
22078 defined symbols must be within any single 2 GiB address range. Programs can be
22079 statically or dynamically linked.
22081 @item -mexplicit-relocs
22082 @itemx -mno-exlicit-relocs
22083 Use or do not use assembler relocation operators when dealing with symbolic
22084 addresses.  The alternative is to use assembler macros instead, which may
22085 limit optimization.
22087 @end table
22089 @node RL78 Options
22090 @subsection RL78 Options
22091 @cindex RL78 Options
22093 @table @gcctabopt
22095 @item -msim
22096 @opindex msim
22097 Links in additional target libraries to support operation within a
22098 simulator.
22100 @item -mmul=none
22101 @itemx -mmul=g10
22102 @itemx -mmul=g13
22103 @itemx -mmul=g14
22104 @itemx -mmul=rl78
22105 @opindex mmul
22106 Specifies the type of hardware multiplication and division support to
22107 be used.  The simplest is @code{none}, which uses software for both
22108 multiplication and division.  This is the default.  The @code{g13}
22109 value is for the hardware multiply/divide peripheral found on the
22110 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
22111 the multiplication and division instructions supported by the RL78/G14
22112 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
22113 the value @code{mg10} is an alias for @code{none}.
22115 In addition a C preprocessor macro is defined, based upon the setting
22116 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
22117 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
22119 @item -mcpu=g10
22120 @itemx -mcpu=g13
22121 @itemx -mcpu=g14
22122 @itemx -mcpu=rl78
22123 @opindex mcpu
22124 Specifies the RL78 core to target.  The default is the G14 core, also
22125 known as an S3 core or just RL78.  The G13 or S2 core does not have
22126 multiply or divide instructions, instead it uses a hardware peripheral
22127 for these operations.  The G10 or S1 core does not have register
22128 banks, so it uses a different calling convention.
22130 If this option is set it also selects the type of hardware multiply
22131 support to use, unless this is overridden by an explicit
22132 @option{-mmul=none} option on the command line.  Thus specifying
22133 @option{-mcpu=g13} enables the use of the G13 hardware multiply
22134 peripheral and specifying @option{-mcpu=g10} disables the use of
22135 hardware multiplications altogether.
22137 Note, although the RL78/G14 core is the default target, specifying
22138 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
22139 change the behavior of the toolchain since it also enables G14
22140 hardware multiply support.  If these options are not specified on the
22141 command line then software multiplication routines will be used even
22142 though the code targets the RL78 core.  This is for backwards
22143 compatibility with older toolchains which did not have hardware
22144 multiply and divide support.
22146 In addition a C preprocessor macro is defined, based upon the setting
22147 of this option.  Possible values are: @code{__RL78_G10__},
22148 @code{__RL78_G13__} or @code{__RL78_G14__}.
22150 @item -mg10
22151 @itemx -mg13
22152 @itemx -mg14
22153 @itemx -mrl78
22154 @opindex mg10
22155 @opindex mg13
22156 @opindex mg14
22157 @opindex mrl78
22158 These are aliases for the corresponding @option{-mcpu=} option.  They
22159 are provided for backwards compatibility.
22161 @item -mallregs
22162 @opindex mallregs
22163 Allow the compiler to use all of the available registers.  By default
22164 registers @code{r24..r31} are reserved for use in interrupt handlers.
22165 With this option enabled these registers can be used in ordinary
22166 functions as well.
22168 @item -m64bit-doubles
22169 @itemx -m32bit-doubles
22170 @opindex m64bit-doubles
22171 @opindex m32bit-doubles
22172 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22173 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22174 @option{-m32bit-doubles}.
22176 @item -msave-mduc-in-interrupts
22177 @item -mno-save-mduc-in-interrupts
22178 @opindex msave-mduc-in-interrupts
22179 @opindex mno-save-mduc-in-interrupts
22180 Specifies that interrupt handler functions should preserve the
22181 MDUC registers.  This is only necessary if normal code might use
22182 the MDUC registers, for example because it performs multiplication
22183 and division operations.  The default is to ignore the MDUC registers
22184 as this makes the interrupt handlers faster.  The target option -mg13
22185 needs to be passed for this to work as this feature is only available
22186 on the G13 target (S2 core).  The MDUC registers will only be saved
22187 if the interrupt handler performs a multiplication or division
22188 operation or it calls another function.
22190 @end table
22192 @node RS/6000 and PowerPC Options
22193 @subsection IBM RS/6000 and PowerPC Options
22194 @cindex RS/6000 and PowerPC Options
22195 @cindex IBM RS/6000 and PowerPC Options
22197 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
22198 @table @gcctabopt
22199 @item -mpowerpc-gpopt
22200 @itemx -mno-powerpc-gpopt
22201 @itemx -mpowerpc-gfxopt
22202 @itemx -mno-powerpc-gfxopt
22203 @need 800
22204 @itemx -mpowerpc64
22205 @itemx -mno-powerpc64
22206 @itemx -mmfcrf
22207 @itemx -mno-mfcrf
22208 @itemx -mpopcntb
22209 @itemx -mno-popcntb
22210 @itemx -mpopcntd
22211 @itemx -mno-popcntd
22212 @itemx -mfprnd
22213 @itemx -mno-fprnd
22214 @need 800
22215 @itemx -mcmpb
22216 @itemx -mno-cmpb
22217 @itemx -mmfpgpr
22218 @itemx -mno-mfpgpr
22219 @itemx -mhard-dfp
22220 @itemx -mno-hard-dfp
22221 @opindex mpowerpc-gpopt
22222 @opindex mno-powerpc-gpopt
22223 @opindex mpowerpc-gfxopt
22224 @opindex mno-powerpc-gfxopt
22225 @opindex mpowerpc64
22226 @opindex mno-powerpc64
22227 @opindex mmfcrf
22228 @opindex mno-mfcrf
22229 @opindex mpopcntb
22230 @opindex mno-popcntb
22231 @opindex mpopcntd
22232 @opindex mno-popcntd
22233 @opindex mfprnd
22234 @opindex mno-fprnd
22235 @opindex mcmpb
22236 @opindex mno-cmpb
22237 @opindex mmfpgpr
22238 @opindex mno-mfpgpr
22239 @opindex mhard-dfp
22240 @opindex mno-hard-dfp
22241 You use these options to specify which instructions are available on the
22242 processor you are using.  The default value of these options is
22243 determined when configuring GCC@.  Specifying the
22244 @option{-mcpu=@var{cpu_type}} overrides the specification of these
22245 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
22246 rather than the options listed above.
22248 Specifying @option{-mpowerpc-gpopt} allows
22249 GCC to use the optional PowerPC architecture instructions in the
22250 General Purpose group, including floating-point square root.  Specifying
22251 @option{-mpowerpc-gfxopt} allows GCC to
22252 use the optional PowerPC architecture instructions in the Graphics
22253 group, including floating-point select.
22255 The @option{-mmfcrf} option allows GCC to generate the move from
22256 condition register field instruction implemented on the POWER4
22257 processor and other processors that support the PowerPC V2.01
22258 architecture.
22259 The @option{-mpopcntb} option allows GCC to generate the popcount and
22260 double-precision FP reciprocal estimate instruction implemented on the
22261 POWER5 processor and other processors that support the PowerPC V2.02
22262 architecture.
22263 The @option{-mpopcntd} option allows GCC to generate the popcount
22264 instruction implemented on the POWER7 processor and other processors
22265 that support the PowerPC V2.06 architecture.
22266 The @option{-mfprnd} option allows GCC to generate the FP round to
22267 integer instructions implemented on the POWER5+ processor and other
22268 processors that support the PowerPC V2.03 architecture.
22269 The @option{-mcmpb} option allows GCC to generate the compare bytes
22270 instruction implemented on the POWER6 processor and other processors
22271 that support the PowerPC V2.05 architecture.
22272 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
22273 general-purpose register instructions implemented on the POWER6X
22274 processor and other processors that support the extended PowerPC V2.05
22275 architecture.
22276 The @option{-mhard-dfp} option allows GCC to generate the decimal
22277 floating-point instructions implemented on some POWER processors.
22279 The @option{-mpowerpc64} option allows GCC to generate the additional
22280 64-bit instructions that are found in the full PowerPC64 architecture
22281 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
22282 @option{-mno-powerpc64}.
22284 @item -mcpu=@var{cpu_type}
22285 @opindex mcpu
22286 Set architecture type, register usage, and
22287 instruction scheduling parameters for machine type @var{cpu_type}.
22288 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
22289 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
22290 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
22291 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
22292 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
22293 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
22294 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
22295 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
22296 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
22297 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
22298 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
22299 and @samp{rs64}.
22301 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
22302 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
22303 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
22304 architecture machine types, with an appropriate, generic processor
22305 model assumed for scheduling purposes.
22307 The other options specify a specific processor.  Code generated under
22308 those options runs best on that processor, and may not run at all on
22309 others.
22311 The @option{-mcpu} options automatically enable or disable the
22312 following options:
22314 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
22315 -mpopcntb -mpopcntd  -mpowerpc64 @gol
22316 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
22317 -msimple-fpu  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
22318 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
22319 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
22321 The particular options set for any particular CPU varies between
22322 compiler versions, depending on what setting seems to produce optimal
22323 code for that CPU; it doesn't necessarily reflect the actual hardware's
22324 capabilities.  If you wish to set an individual option to a particular
22325 value, you may specify it after the @option{-mcpu} option, like
22326 @option{-mcpu=970 -mno-altivec}.
22328 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
22329 not enabled or disabled by the @option{-mcpu} option at present because
22330 AIX does not have full support for these options.  You may still
22331 enable or disable them individually if you're sure it'll work in your
22332 environment.
22334 @item -mtune=@var{cpu_type}
22335 @opindex mtune
22336 Set the instruction scheduling parameters for machine type
22337 @var{cpu_type}, but do not set the architecture type or register usage,
22338 as @option{-mcpu=@var{cpu_type}} does.  The same
22339 values for @var{cpu_type} are used for @option{-mtune} as for
22340 @option{-mcpu}.  If both are specified, the code generated uses the
22341 architecture and registers set by @option{-mcpu}, but the
22342 scheduling parameters set by @option{-mtune}.
22344 @item -mcmodel=small
22345 @opindex mcmodel=small
22346 Generate PowerPC64 code for the small model: The TOC is limited to
22347 64k.
22349 @item -mcmodel=medium
22350 @opindex mcmodel=medium
22351 Generate PowerPC64 code for the medium model: The TOC and other static
22352 data may be up to a total of 4G in size.  This is the default for 64-bit
22353 Linux.
22355 @item -mcmodel=large
22356 @opindex mcmodel=large
22357 Generate PowerPC64 code for the large model: The TOC may be up to 4G
22358 in size.  Other data and code is only limited by the 64-bit address
22359 space.
22361 @item -maltivec
22362 @itemx -mno-altivec
22363 @opindex maltivec
22364 @opindex mno-altivec
22365 Generate code that uses (does not use) AltiVec instructions, and also
22366 enable the use of built-in functions that allow more direct access to
22367 the AltiVec instruction set.  You may also need to set
22368 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
22369 enhancements.
22371 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
22372 @option{-maltivec=be}, the element order for AltiVec intrinsics such
22373 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
22374 match array element order corresponding to the endianness of the
22375 target.  That is, element zero identifies the leftmost element in a
22376 vector register when targeting a big-endian platform, and identifies
22377 the rightmost element in a vector register when targeting a
22378 little-endian platform.
22380 @item -maltivec=be
22381 @opindex maltivec=be
22382 Generate AltiVec instructions using big-endian element order,
22383 regardless of whether the target is big- or little-endian.  This is
22384 the default when targeting a big-endian platform.
22386 The element order is used to interpret element numbers in AltiVec
22387 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22388 @code{vec_insert}.  By default, these match array element order
22389 corresponding to the endianness for the target.
22391 @item -maltivec=le
22392 @opindex maltivec=le
22393 Generate AltiVec instructions using little-endian element order,
22394 regardless of whether the target is big- or little-endian.  This is
22395 the default when targeting a little-endian platform.  This option is
22396 currently ignored when targeting a big-endian platform.
22398 The element order is used to interpret element numbers in AltiVec
22399 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
22400 @code{vec_insert}.  By default, these match array element order
22401 corresponding to the endianness for the target.
22403 @item -mvrsave
22404 @itemx -mno-vrsave
22405 @opindex mvrsave
22406 @opindex mno-vrsave
22407 Generate VRSAVE instructions when generating AltiVec code.
22409 @item -msecure-plt
22410 @opindex msecure-plt
22411 Generate code that allows @command{ld} and @command{ld.so}
22412 to build executables and shared
22413 libraries with non-executable @code{.plt} and @code{.got} sections.
22414 This is a PowerPC
22415 32-bit SYSV ABI option.
22417 @item -mbss-plt
22418 @opindex mbss-plt
22419 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
22420 fills in, and
22421 requires @code{.plt} and @code{.got}
22422 sections that are both writable and executable.
22423 This is a PowerPC 32-bit SYSV ABI option.
22425 @item -misel
22426 @itemx -mno-isel
22427 @opindex misel
22428 @opindex mno-isel
22429 This switch enables or disables the generation of ISEL instructions.
22431 @item -misel=@var{yes/no}
22432 This switch has been deprecated.  Use @option{-misel} and
22433 @option{-mno-isel} instead.
22435 @item -mspe
22436 @itemx -mno-spe
22437 @opindex mspe
22438 @opindex mno-spe
22439 This switch enables or disables the generation of SPE simd
22440 instructions.
22442 @item -mpaired
22443 @itemx -mno-paired
22444 @opindex mpaired
22445 @opindex mno-paired
22446 This switch enables or disables the generation of PAIRED simd
22447 instructions.
22449 @item -mspe=@var{yes/no}
22450 This option has been deprecated.  Use @option{-mspe} and
22451 @option{-mno-spe} instead.
22453 @item -mvsx
22454 @itemx -mno-vsx
22455 @opindex mvsx
22456 @opindex mno-vsx
22457 Generate code that uses (does not use) vector/scalar (VSX)
22458 instructions, and also enable the use of built-in functions that allow
22459 more direct access to the VSX instruction set.
22461 @item -mcrypto
22462 @itemx -mno-crypto
22463 @opindex mcrypto
22464 @opindex mno-crypto
22465 Enable the use (disable) of the built-in functions that allow direct
22466 access to the cryptographic instructions that were added in version
22467 2.07 of the PowerPC ISA.
22469 @item -mdirect-move
22470 @itemx -mno-direct-move
22471 @opindex mdirect-move
22472 @opindex mno-direct-move
22473 Generate code that uses (does not use) the instructions to move data
22474 between the general purpose registers and the vector/scalar (VSX)
22475 registers that were added in version 2.07 of the PowerPC ISA.
22477 @item -mhtm
22478 @itemx -mno-htm
22479 @opindex mhtm
22480 @opindex mno-htm
22481 Enable (disable) the use of the built-in functions that allow direct
22482 access to the Hardware Transactional Memory (HTM) instructions that
22483 were added in version 2.07 of the PowerPC ISA.
22485 @item -mpower8-fusion
22486 @itemx -mno-power8-fusion
22487 @opindex mpower8-fusion
22488 @opindex mno-power8-fusion
22489 Generate code that keeps (does not keeps) some integer operations
22490 adjacent so that the instructions can be fused together on power8 and
22491 later processors.
22493 @item -mpower8-vector
22494 @itemx -mno-power8-vector
22495 @opindex mpower8-vector
22496 @opindex mno-power8-vector
22497 Generate code that uses (does not use) the vector and scalar
22498 instructions that were added in version 2.07 of the PowerPC ISA.  Also
22499 enable the use of built-in functions that allow more direct access to
22500 the vector instructions.
22502 @item -mquad-memory
22503 @itemx -mno-quad-memory
22504 @opindex mquad-memory
22505 @opindex mno-quad-memory
22506 Generate code that uses (does not use) the non-atomic quad word memory
22507 instructions.  The @option{-mquad-memory} option requires use of
22508 64-bit mode.
22510 @item -mquad-memory-atomic
22511 @itemx -mno-quad-memory-atomic
22512 @opindex mquad-memory-atomic
22513 @opindex mno-quad-memory-atomic
22514 Generate code that uses (does not use) the atomic quad word memory
22515 instructions.  The @option{-mquad-memory-atomic} option requires use of
22516 64-bit mode.
22518 @item -mfloat128
22519 @itemx -mno-float128
22520 @opindex mfloat128
22521 @opindex mno-float128
22522 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22523 and use either software emulation for IEEE 128-bit floating point or
22524 hardware instructions.
22526 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
22527 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
22528 use the IEEE 128-bit floating point support.  The IEEE 128-bit
22529 floating point support only works on PowerPC Linux systems.
22531 The default for @option{-mfloat128} is enabled on PowerPC Linux
22532 systems using the VSX instruction set, and disabled on other systems.
22534 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
22535 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
22536 point support will also enable the generation of ISA 3.0 IEEE 128-bit
22537 floating point instructions.  Otherwise, if you do not specify to
22538 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
22539 system, IEEE 128-bit floating point will be done with software
22540 emulation.
22542 @item -mfloat128-hardware
22543 @itemx -mno-float128-hardware
22544 @opindex mfloat128-hardware
22545 @opindex mno-float128-hardware
22546 Enable/disable using ISA 3.0 hardware instructions to support the
22547 @var{__float128} data type.
22549 The default for @option{-mfloat128-hardware} is enabled on PowerPC
22550 Linux systems using the ISA 3.0 instruction set, and disabled on other
22551 systems.
22553 @item -mfloat-gprs=@var{yes/single/double/no}
22554 @itemx -mfloat-gprs
22555 @opindex mfloat-gprs
22556 This switch enables or disables the generation of floating-point
22557 operations on the general-purpose registers for architectures that
22558 support it.
22560 The argument @samp{yes} or @samp{single} enables the use of
22561 single-precision floating-point operations.
22563 The argument @samp{double} enables the use of single and
22564 double-precision floating-point operations.
22566 The argument @samp{no} disables floating-point operations on the
22567 general-purpose registers.
22569 This option is currently only available on the MPC854x.
22571 @item -m32
22572 @itemx -m64
22573 @opindex m32
22574 @opindex m64
22575 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
22576 targets (including GNU/Linux).  The 32-bit environment sets int, long
22577 and pointer to 32 bits and generates code that runs on any PowerPC
22578 variant.  The 64-bit environment sets int to 32 bits and long and
22579 pointer to 64 bits, and generates code for PowerPC64, as for
22580 @option{-mpowerpc64}.
22582 @item -mfull-toc
22583 @itemx -mno-fp-in-toc
22584 @itemx -mno-sum-in-toc
22585 @itemx -mminimal-toc
22586 @opindex mfull-toc
22587 @opindex mno-fp-in-toc
22588 @opindex mno-sum-in-toc
22589 @opindex mminimal-toc
22590 Modify generation of the TOC (Table Of Contents), which is created for
22591 every executable file.  The @option{-mfull-toc} option is selected by
22592 default.  In that case, GCC allocates at least one TOC entry for
22593 each unique non-automatic variable reference in your program.  GCC
22594 also places floating-point constants in the TOC@.  However, only
22595 16,384 entries are available in the TOC@.
22597 If you receive a linker error message that saying you have overflowed
22598 the available TOC space, you can reduce the amount of TOC space used
22599 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22600 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22601 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22602 generate code to calculate the sum of an address and a constant at
22603 run time instead of putting that sum into the TOC@.  You may specify one
22604 or both of these options.  Each causes GCC to produce very slightly
22605 slower and larger code at the expense of conserving TOC space.
22607 If you still run out of space in the TOC even when you specify both of
22608 these options, specify @option{-mminimal-toc} instead.  This option causes
22609 GCC to make only one TOC entry for every file.  When you specify this
22610 option, GCC produces code that is slower and larger but which
22611 uses extremely little TOC space.  You may wish to use this option
22612 only on files that contain less frequently-executed code.
22614 @item -maix64
22615 @itemx -maix32
22616 @opindex maix64
22617 @opindex maix32
22618 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22619 @code{long} type, and the infrastructure needed to support them.
22620 Specifying @option{-maix64} implies @option{-mpowerpc64},
22621 while @option{-maix32} disables the 64-bit ABI and
22622 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22624 @item -mxl-compat
22625 @itemx -mno-xl-compat
22626 @opindex mxl-compat
22627 @opindex mno-xl-compat
22628 Produce code that conforms more closely to IBM XL compiler semantics
22629 when using AIX-compatible ABI@.  Pass floating-point arguments to
22630 prototyped functions beyond the register save area (RSA) on the stack
22631 in addition to argument FPRs.  Do not assume that most significant
22632 double in 128-bit long double value is properly rounded when comparing
22633 values and converting to double.  Use XL symbol names for long double
22634 support routines.
22636 The AIX calling convention was extended but not initially documented to
22637 handle an obscure K&R C case of calling a function that takes the
22638 address of its arguments with fewer arguments than declared.  IBM XL
22639 compilers access floating-point arguments that do not fit in the
22640 RSA from the stack when a subroutine is compiled without
22641 optimization.  Because always storing floating-point arguments on the
22642 stack is inefficient and rarely needed, this option is not enabled by
22643 default and only is necessary when calling subroutines compiled by IBM
22644 XL compilers without optimization.
22646 @item -mpe
22647 @opindex mpe
22648 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22649 application written to use message passing with special startup code to
22650 enable the application to run.  The system must have PE installed in the
22651 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22652 must be overridden with the @option{-specs=} option to specify the
22653 appropriate directory location.  The Parallel Environment does not
22654 support threads, so the @option{-mpe} option and the @option{-pthread}
22655 option are incompatible.
22657 @item -malign-natural
22658 @itemx -malign-power
22659 @opindex malign-natural
22660 @opindex malign-power
22661 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22662 @option{-malign-natural} overrides the ABI-defined alignment of larger
22663 types, such as floating-point doubles, on their natural size-based boundary.
22664 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22665 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22667 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22668 is not supported.
22670 @item -msoft-float
22671 @itemx -mhard-float
22672 @opindex msoft-float
22673 @opindex mhard-float
22674 Generate code that does not use (uses) the floating-point register set.
22675 Software floating-point emulation is provided if you use the
22676 @option{-msoft-float} option, and pass the option to GCC when linking.
22678 @item -msingle-float
22679 @itemx -mdouble-float
22680 @opindex msingle-float
22681 @opindex mdouble-float
22682 Generate code for single- or double-precision floating-point operations.
22683 @option{-mdouble-float} implies @option{-msingle-float}.
22685 @item -msimple-fpu
22686 @opindex msimple-fpu
22687 Do not generate @code{sqrt} and @code{div} instructions for hardware
22688 floating-point unit.
22690 @item -mfpu=@var{name}
22691 @opindex mfpu
22692 Specify type of floating-point unit.  Valid values for @var{name} are
22693 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22694 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22695 @samp{sp_full} (equivalent to @option{-msingle-float}),
22696 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22698 @item -mxilinx-fpu
22699 @opindex mxilinx-fpu
22700 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22702 @item -mmultiple
22703 @itemx -mno-multiple
22704 @opindex mmultiple
22705 @opindex mno-multiple
22706 Generate code that uses (does not use) the load multiple word
22707 instructions and the store multiple word instructions.  These
22708 instructions are generated by default on POWER systems, and not
22709 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22710 PowerPC systems, since those instructions do not work when the
22711 processor is in little-endian mode.  The exceptions are PPC740 and
22712 PPC750 which permit these instructions in little-endian mode.
22714 @item -mupdate
22715 @itemx -mno-update
22716 @opindex mupdate
22717 @opindex mno-update
22718 Generate code that uses (does not use) the load or store instructions
22719 that update the base register to the address of the calculated memory
22720 location.  These instructions are generated by default.  If you use
22721 @option{-mno-update}, there is a small window between the time that the
22722 stack pointer is updated and the address of the previous frame is
22723 stored, which means code that walks the stack frame across interrupts or
22724 signals may get corrupted data.
22726 @item -mavoid-indexed-addresses
22727 @itemx -mno-avoid-indexed-addresses
22728 @opindex mavoid-indexed-addresses
22729 @opindex mno-avoid-indexed-addresses
22730 Generate code that tries to avoid (not avoid) the use of indexed load
22731 or store instructions. These instructions can incur a performance
22732 penalty on Power6 processors in certain situations, such as when
22733 stepping through large arrays that cross a 16M boundary.  This option
22734 is enabled by default when targeting Power6 and disabled otherwise.
22736 @item -mfused-madd
22737 @itemx -mno-fused-madd
22738 @opindex mfused-madd
22739 @opindex mno-fused-madd
22740 Generate code that uses (does not use) the floating-point multiply and
22741 accumulate instructions.  These instructions are generated by default
22742 if hardware floating point is used.  The machine-dependent
22743 @option{-mfused-madd} option is now mapped to the machine-independent
22744 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22745 mapped to @option{-ffp-contract=off}.
22747 @item -mmulhw
22748 @itemx -mno-mulhw
22749 @opindex mmulhw
22750 @opindex mno-mulhw
22751 Generate code that uses (does not use) the half-word multiply and
22752 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22753 These instructions are generated by default when targeting those
22754 processors.
22756 @item -mdlmzb
22757 @itemx -mno-dlmzb
22758 @opindex mdlmzb
22759 @opindex mno-dlmzb
22760 Generate code that uses (does not use) the string-search @samp{dlmzb}
22761 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22762 generated by default when targeting those processors.
22764 @item -mno-bit-align
22765 @itemx -mbit-align
22766 @opindex mno-bit-align
22767 @opindex mbit-align
22768 On System V.4 and embedded PowerPC systems do not (do) force structures
22769 and unions that contain bit-fields to be aligned to the base type of the
22770 bit-field.
22772 For example, by default a structure containing nothing but 8
22773 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22774 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22775 the structure is aligned to a 1-byte boundary and is 1 byte in
22776 size.
22778 @item -mno-strict-align
22779 @itemx -mstrict-align
22780 @opindex mno-strict-align
22781 @opindex mstrict-align
22782 On System V.4 and embedded PowerPC systems do not (do) assume that
22783 unaligned memory references are handled by the system.
22785 @item -mrelocatable
22786 @itemx -mno-relocatable
22787 @opindex mrelocatable
22788 @opindex mno-relocatable
22789 Generate code that allows (does not allow) a static executable to be
22790 relocated to a different address at run time.  A simple embedded
22791 PowerPC system loader should relocate the entire contents of
22792 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22793 a table of 32-bit addresses generated by this option.  For this to
22794 work, all objects linked together must be compiled with
22795 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22796 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22798 @item -mrelocatable-lib
22799 @itemx -mno-relocatable-lib
22800 @opindex mrelocatable-lib
22801 @opindex mno-relocatable-lib
22802 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22803 @code{.fixup} section to allow static executables to be relocated at
22804 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22805 alignment of @option{-mrelocatable}.  Objects compiled with
22806 @option{-mrelocatable-lib} may be linked with objects compiled with
22807 any combination of the @option{-mrelocatable} options.
22809 @item -mno-toc
22810 @itemx -mtoc
22811 @opindex mno-toc
22812 @opindex mtoc
22813 On System V.4 and embedded PowerPC systems do not (do) assume that
22814 register 2 contains a pointer to a global area pointing to the addresses
22815 used in the program.
22817 @item -mlittle
22818 @itemx -mlittle-endian
22819 @opindex mlittle
22820 @opindex mlittle-endian
22821 On System V.4 and embedded PowerPC systems compile code for the
22822 processor in little-endian mode.  The @option{-mlittle-endian} option is
22823 the same as @option{-mlittle}.
22825 @item -mbig
22826 @itemx -mbig-endian
22827 @opindex mbig
22828 @opindex mbig-endian
22829 On System V.4 and embedded PowerPC systems compile code for the
22830 processor in big-endian mode.  The @option{-mbig-endian} option is
22831 the same as @option{-mbig}.
22833 @item -mdynamic-no-pic
22834 @opindex mdynamic-no-pic
22835 On Darwin and Mac OS X systems, compile code so that it is not
22836 relocatable, but that its external references are relocatable.  The
22837 resulting code is suitable for applications, but not shared
22838 libraries.
22840 @item -msingle-pic-base
22841 @opindex msingle-pic-base
22842 Treat the register used for PIC addressing as read-only, rather than
22843 loading it in the prologue for each function.  The runtime system is
22844 responsible for initializing this register with an appropriate value
22845 before execution begins.
22847 @item -mprioritize-restricted-insns=@var{priority}
22848 @opindex mprioritize-restricted-insns
22849 This option controls the priority that is assigned to
22850 dispatch-slot restricted instructions during the second scheduling
22851 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22852 or @samp{2} to assign no, highest, or second-highest (respectively) 
22853 priority to dispatch-slot restricted
22854 instructions.
22856 @item -msched-costly-dep=@var{dependence_type}
22857 @opindex msched-costly-dep
22858 This option controls which dependences are considered costly
22859 by the target during instruction scheduling.  The argument
22860 @var{dependence_type} takes one of the following values:
22862 @table @asis
22863 @item @samp{no}
22864 No dependence is costly.
22866 @item @samp{all}
22867 All dependences are costly.
22869 @item @samp{true_store_to_load}
22870 A true dependence from store to load is costly.
22872 @item @samp{store_to_load}
22873 Any dependence from store to load is costly.
22875 @item @var{number}
22876 Any dependence for which the latency is greater than or equal to 
22877 @var{number} is costly.
22878 @end table
22880 @item -minsert-sched-nops=@var{scheme}
22881 @opindex minsert-sched-nops
22882 This option controls which NOP insertion scheme is used during
22883 the second scheduling pass.  The argument @var{scheme} takes one of the
22884 following values:
22886 @table @asis
22887 @item @samp{no}
22888 Don't insert NOPs.
22890 @item @samp{pad}
22891 Pad with NOPs any dispatch group that has vacant issue slots,
22892 according to the scheduler's grouping.
22894 @item @samp{regroup_exact}
22895 Insert NOPs to force costly dependent insns into
22896 separate groups.  Insert exactly as many NOPs as needed to force an insn
22897 to a new group, according to the estimated processor grouping.
22899 @item @var{number}
22900 Insert NOPs to force costly dependent insns into
22901 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22902 @end table
22904 @item -mcall-sysv
22905 @opindex mcall-sysv
22906 On System V.4 and embedded PowerPC systems compile code using calling
22907 conventions that adhere to the March 1995 draft of the System V
22908 Application Binary Interface, PowerPC processor supplement.  This is the
22909 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22911 @item -mcall-sysv-eabi
22912 @itemx -mcall-eabi
22913 @opindex mcall-sysv-eabi
22914 @opindex mcall-eabi
22915 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22917 @item -mcall-sysv-noeabi
22918 @opindex mcall-sysv-noeabi
22919 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22921 @item -mcall-aixdesc
22922 @opindex m
22923 On System V.4 and embedded PowerPC systems compile code for the AIX
22924 operating system.
22926 @item -mcall-linux
22927 @opindex mcall-linux
22928 On System V.4 and embedded PowerPC systems compile code for the
22929 Linux-based GNU system.
22931 @item -mcall-freebsd
22932 @opindex mcall-freebsd
22933 On System V.4 and embedded PowerPC systems compile code for the
22934 FreeBSD operating system.
22936 @item -mcall-netbsd
22937 @opindex mcall-netbsd
22938 On System V.4 and embedded PowerPC systems compile code for the
22939 NetBSD operating system.
22941 @item -mcall-openbsd
22942 @opindex mcall-netbsd
22943 On System V.4 and embedded PowerPC systems compile code for the
22944 OpenBSD operating system.
22946 @item -maix-struct-return
22947 @opindex maix-struct-return
22948 Return all structures in memory (as specified by the AIX ABI)@.
22950 @item -msvr4-struct-return
22951 @opindex msvr4-struct-return
22952 Return structures smaller than 8 bytes in registers (as specified by the
22953 SVR4 ABI)@.
22955 @item -mabi=@var{abi-type}
22956 @opindex mabi
22957 Extend the current ABI with a particular extension, or remove such extension.
22958 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22959 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22960 @samp{elfv1}, @samp{elfv2}@.
22962 @item -mabi=spe
22963 @opindex mabi=spe
22964 Extend the current ABI with SPE ABI extensions.  This does not change
22965 the default ABI, instead it adds the SPE ABI extensions to the current
22966 ABI@.
22968 @item -mabi=no-spe
22969 @opindex mabi=no-spe
22970 Disable Book-E SPE ABI extensions for the current ABI@.
22972 @item -mabi=ibmlongdouble
22973 @opindex mabi=ibmlongdouble
22974 Change the current ABI to use IBM extended-precision long double.
22975 This is not likely to work if your system defaults to using IEEE
22976 extended-precision long double.  If you change the long double type
22977 from IEEE extended-precision, the compiler will issue a warning unless
22978 you use the @option{-Wno-psabi} option.
22980 @item -mabi=ieeelongdouble
22981 @opindex mabi=ieeelongdouble
22982 Change the current ABI to use IEEE extended-precision long double.
22983 This is not likely to work if your system defaults to using IBM
22984 extended-precision long double.  If you change the long double type
22985 from IBM extended-precision, the compiler will issue a warning unless
22986 you use the @option{-Wno-psabi} option.
22988 @item -mabi=elfv1
22989 @opindex mabi=elfv1
22990 Change the current ABI to use the ELFv1 ABI.
22991 This is the default ABI for big-endian PowerPC 64-bit Linux.
22992 Overriding the default ABI requires special system support and is
22993 likely to fail in spectacular ways.
22995 @item -mabi=elfv2
22996 @opindex mabi=elfv2
22997 Change the current ABI to use the ELFv2 ABI.
22998 This is the default ABI for little-endian PowerPC 64-bit Linux.
22999 Overriding the default ABI requires special system support and is
23000 likely to fail in spectacular ways.
23002 @item -mgnu-attribute
23003 @itemx -mno-gnu-attribute
23004 @opindex mgnu-attribute
23005 @opindex mno-gnu-attribute
23006 Emit .gnu_attribute assembly directives to set tag/value pairs in a
23007 .gnu.attributes section that specify ABI variations in function
23008 parameters or return values.
23010 @item -mprototype
23011 @itemx -mno-prototype
23012 @opindex mprototype
23013 @opindex mno-prototype
23014 On System V.4 and embedded PowerPC systems assume that all calls to
23015 variable argument functions are properly prototyped.  Otherwise, the
23016 compiler must insert an instruction before every non-prototyped call to
23017 set or clear bit 6 of the condition code register (@code{CR}) to
23018 indicate whether floating-point values are passed in the floating-point
23019 registers in case the function takes variable arguments.  With
23020 @option{-mprototype}, only calls to prototyped variable argument functions
23021 set or clear the bit.
23023 @item -msim
23024 @opindex msim
23025 On embedded PowerPC systems, assume that the startup module is called
23026 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
23027 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
23028 configurations.
23030 @item -mmvme
23031 @opindex mmvme
23032 On embedded PowerPC systems, assume that the startup module is called
23033 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
23034 @file{libc.a}.
23036 @item -mads
23037 @opindex mads
23038 On embedded PowerPC systems, assume that the startup module is called
23039 @file{crt0.o} and the standard C libraries are @file{libads.a} and
23040 @file{libc.a}.
23042 @item -myellowknife
23043 @opindex myellowknife
23044 On embedded PowerPC systems, assume that the startup module is called
23045 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
23046 @file{libc.a}.
23048 @item -mvxworks
23049 @opindex mvxworks
23050 On System V.4 and embedded PowerPC systems, specify that you are
23051 compiling for a VxWorks system.
23053 @item -memb
23054 @opindex memb
23055 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
23056 header to indicate that @samp{eabi} extended relocations are used.
23058 @item -meabi
23059 @itemx -mno-eabi
23060 @opindex meabi
23061 @opindex mno-eabi
23062 On System V.4 and embedded PowerPC systems do (do not) adhere to the
23063 Embedded Applications Binary Interface (EABI), which is a set of
23064 modifications to the System V.4 specifications.  Selecting @option{-meabi}
23065 means that the stack is aligned to an 8-byte boundary, a function
23066 @code{__eabi} is called from @code{main} to set up the EABI
23067 environment, and the @option{-msdata} option can use both @code{r2} and
23068 @code{r13} to point to two separate small data areas.  Selecting
23069 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
23070 no EABI initialization function is called from @code{main}, and the
23071 @option{-msdata} option only uses @code{r13} to point to a single
23072 small data area.  The @option{-meabi} option is on by default if you
23073 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
23075 @item -msdata=eabi
23076 @opindex msdata=eabi
23077 On System V.4 and embedded PowerPC systems, put small initialized
23078 @code{const} global and static data in the @code{.sdata2} section, which
23079 is pointed to by register @code{r2}.  Put small initialized
23080 non-@code{const} global and static data in the @code{.sdata} section,
23081 which is pointed to by register @code{r13}.  Put small uninitialized
23082 global and static data in the @code{.sbss} section, which is adjacent to
23083 the @code{.sdata} section.  The @option{-msdata=eabi} option is
23084 incompatible with the @option{-mrelocatable} option.  The
23085 @option{-msdata=eabi} option also sets the @option{-memb} option.
23087 @item -msdata=sysv
23088 @opindex msdata=sysv
23089 On System V.4 and embedded PowerPC systems, put small global and static
23090 data in the @code{.sdata} section, which is pointed to by register
23091 @code{r13}.  Put small uninitialized global and static data in the
23092 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
23093 The @option{-msdata=sysv} option is incompatible with the
23094 @option{-mrelocatable} option.
23096 @item -msdata=default
23097 @itemx -msdata
23098 @opindex msdata=default
23099 @opindex msdata
23100 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
23101 compile code the same as @option{-msdata=eabi}, otherwise compile code the
23102 same as @option{-msdata=sysv}.
23104 @item -msdata=data
23105 @opindex msdata=data
23106 On System V.4 and embedded PowerPC systems, put small global
23107 data in the @code{.sdata} section.  Put small uninitialized global
23108 data in the @code{.sbss} section.  Do not use register @code{r13}
23109 to address small data however.  This is the default behavior unless
23110 other @option{-msdata} options are used.
23112 @item -msdata=none
23113 @itemx -mno-sdata
23114 @opindex msdata=none
23115 @opindex mno-sdata
23116 On embedded PowerPC systems, put all initialized global and static data
23117 in the @code{.data} section, and all uninitialized data in the
23118 @code{.bss} section.
23120 @item -mblock-move-inline-limit=@var{num}
23121 @opindex mblock-move-inline-limit
23122 Inline all block moves (such as calls to @code{memcpy} or structure
23123 copies) less than or equal to @var{num} bytes.  The minimum value for
23124 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
23125 targets.  The default value is target-specific.
23127 @item -G @var{num}
23128 @opindex G
23129 @cindex smaller data references (PowerPC)
23130 @cindex .sdata/.sdata2 references (PowerPC)
23131 On embedded PowerPC systems, put global and static items less than or
23132 equal to @var{num} bytes into the small data or BSS sections instead of
23133 the normal data or BSS section.  By default, @var{num} is 8.  The
23134 @option{-G @var{num}} switch is also passed to the linker.
23135 All modules should be compiled with the same @option{-G @var{num}} value.
23137 @item -mregnames
23138 @itemx -mno-regnames
23139 @opindex mregnames
23140 @opindex mno-regnames
23141 On System V.4 and embedded PowerPC systems do (do not) emit register
23142 names in the assembly language output using symbolic forms.
23144 @item -mlongcall
23145 @itemx -mno-longcall
23146 @opindex mlongcall
23147 @opindex mno-longcall
23148 By default assume that all calls are far away so that a longer and more
23149 expensive calling sequence is required.  This is required for calls
23150 farther than 32 megabytes (33,554,432 bytes) from the current location.
23151 A short call is generated if the compiler knows
23152 the call cannot be that far away.  This setting can be overridden by
23153 the @code{shortcall} function attribute, or by @code{#pragma
23154 longcall(0)}.
23156 Some linkers are capable of detecting out-of-range calls and generating
23157 glue code on the fly.  On these systems, long calls are unnecessary and
23158 generate slower code.  As of this writing, the AIX linker can do this,
23159 as can the GNU linker for PowerPC/64.  It is planned to add this feature
23160 to the GNU linker for 32-bit PowerPC systems as well.
23162 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
23163 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
23164 addresses represent the callee and the branch island.  The
23165 Darwin/PPC linker prefers the first address and generates a @code{bl
23166 callee} if the PPC @code{bl} instruction reaches the callee directly;
23167 otherwise, the linker generates @code{bl L42} to call the branch
23168 island.  The branch island is appended to the body of the
23169 calling function; it computes the full 32-bit address of the callee
23170 and jumps to it.
23172 On Mach-O (Darwin) systems, this option directs the compiler emit to
23173 the glue for every direct call, and the Darwin linker decides whether
23174 to use or discard it.
23176 In the future, GCC may ignore all longcall specifications
23177 when the linker is known to generate glue.
23179 @item -mtls-markers
23180 @itemx -mno-tls-markers
23181 @opindex mtls-markers
23182 @opindex mno-tls-markers
23183 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
23184 specifying the function argument.  The relocation allows the linker to
23185 reliably associate function call with argument setup instructions for
23186 TLS optimization, which in turn allows GCC to better schedule the
23187 sequence.
23189 @item -mrecip
23190 @itemx -mno-recip
23191 @opindex mrecip
23192 This option enables use of the reciprocal estimate and
23193 reciprocal square root estimate instructions with additional
23194 Newton-Raphson steps to increase precision instead of doing a divide or
23195 square root and divide for floating-point arguments.  You should use
23196 the @option{-ffast-math} option when using @option{-mrecip} (or at
23197 least @option{-funsafe-math-optimizations},
23198 @option{-ffinite-math-only}, @option{-freciprocal-math} and
23199 @option{-fno-trapping-math}).  Note that while the throughput of the
23200 sequence is generally higher than the throughput of the non-reciprocal
23201 instruction, the precision of the sequence can be decreased by up to 2
23202 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
23203 roots.
23205 @item -mrecip=@var{opt}
23206 @opindex mrecip=opt
23207 This option controls which reciprocal estimate instructions
23208 may be used.  @var{opt} is a comma-separated list of options, which may
23209 be preceded by a @code{!} to invert the option:
23211 @table @samp
23213 @item all
23214 Enable all estimate instructions.
23216 @item default 
23217 Enable the default instructions, equivalent to @option{-mrecip}.
23219 @item none 
23220 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23222 @item div 
23223 Enable the reciprocal approximation instructions for both 
23224 single and double precision.
23226 @item divf 
23227 Enable the single-precision reciprocal approximation instructions.
23229 @item divd 
23230 Enable the double-precision reciprocal approximation instructions.
23232 @item rsqrt 
23233 Enable the reciprocal square root approximation instructions for both
23234 single and double precision.
23236 @item rsqrtf 
23237 Enable the single-precision reciprocal square root approximation instructions.
23239 @item rsqrtd 
23240 Enable the double-precision reciprocal square root approximation instructions.
23242 @end table
23244 So, for example, @option{-mrecip=all,!rsqrtd} enables
23245 all of the reciprocal estimate instructions, except for the
23246 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
23247 which handle the double-precision reciprocal square root calculations.
23249 @item -mrecip-precision
23250 @itemx -mno-recip-precision
23251 @opindex mrecip-precision
23252 Assume (do not assume) that the reciprocal estimate instructions
23253 provide higher-precision estimates than is mandated by the PowerPC
23254 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
23255 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
23256 The double-precision square root estimate instructions are not generated by
23257 default on low-precision machines, since they do not provide an
23258 estimate that converges after three steps.
23260 @item -mveclibabi=@var{type}
23261 @opindex mveclibabi
23262 Specifies the ABI type to use for vectorizing intrinsics using an
23263 external library.  The only type supported at present is @samp{mass},
23264 which specifies to use IBM's Mathematical Acceleration Subsystem
23265 (MASS) libraries for vectorizing intrinsics using external libraries.
23266 GCC currently emits calls to @code{acosd2}, @code{acosf4},
23267 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
23268 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
23269 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
23270 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
23271 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
23272 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
23273 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
23274 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
23275 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
23276 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
23277 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
23278 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
23279 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
23280 for power7.  Both @option{-ftree-vectorize} and
23281 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
23282 libraries must be specified at link time.
23284 @item -mfriz
23285 @itemx -mno-friz
23286 @opindex mfriz
23287 Generate (do not generate) the @code{friz} instruction when the
23288 @option{-funsafe-math-optimizations} option is used to optimize
23289 rounding of floating-point values to 64-bit integer and back to floating
23290 point.  The @code{friz} instruction does not return the same value if
23291 the floating-point number is too large to fit in an integer.
23293 @item -mpointers-to-nested-functions
23294 @itemx -mno-pointers-to-nested-functions
23295 @opindex mpointers-to-nested-functions
23296 Generate (do not generate) code to load up the static chain register
23297 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
23298 systems where a function pointer points to a 3-word descriptor giving
23299 the function address, TOC value to be loaded in register @code{r2}, and
23300 static chain value to be loaded in register @code{r11}.  The
23301 @option{-mpointers-to-nested-functions} is on by default.  You cannot
23302 call through pointers to nested functions or pointers
23303 to functions compiled in other languages that use the static chain if
23304 you use @option{-mno-pointers-to-nested-functions}.
23306 @item -msave-toc-indirect
23307 @itemx -mno-save-toc-indirect
23308 @opindex msave-toc-indirect
23309 Generate (do not generate) code to save the TOC value in the reserved
23310 stack location in the function prologue if the function calls through
23311 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
23312 saved in the prologue, it is saved just before the call through the
23313 pointer.  The @option{-mno-save-toc-indirect} option is the default.
23315 @item -mcompat-align-parm
23316 @itemx -mno-compat-align-parm
23317 @opindex mcompat-align-parm
23318 Generate (do not generate) code to pass structure parameters with a
23319 maximum alignment of 64 bits, for compatibility with older versions
23320 of GCC.
23322 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
23323 structure parameter on a 128-bit boundary when that structure contained
23324 a member requiring 128-bit alignment.  This is corrected in more
23325 recent versions of GCC.  This option may be used to generate code
23326 that is compatible with functions compiled with older versions of
23327 GCC.
23329 The @option{-mno-compat-align-parm} option is the default.
23331 @item -mstack-protector-guard=@var{guard}
23332 @itemx -mstack-protector-guard-reg=@var{reg}
23333 @itemx -mstack-protector-guard-offset=@var{offset}
23334 @itemx -mstack-protector-guard-symbol=@var{symbol}
23335 @opindex mstack-protector-guard
23336 @opindex mstack-protector-guard-reg
23337 @opindex mstack-protector-guard-offset
23338 @opindex mstack-protector-guard-symbol
23339 Generate stack protection code using canary at @var{guard}.  Supported
23340 locations are @samp{global} for global canary or @samp{tls} for per-thread
23341 canary in the TLS block (the default with GNU libc version 2.4 or later).
23343 With the latter choice the options
23344 @option{-mstack-protector-guard-reg=@var{reg}} and
23345 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
23346 which register to use as base register for reading the canary, and from what
23347 offset from that base register. The default for those is as specified in the
23348 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
23349 the offset with a symbol reference to a canary in the TLS block.
23350 @end table
23352 @node RX Options
23353 @subsection RX Options
23354 @cindex RX Options
23356 These command-line options are defined for RX targets:
23358 @table @gcctabopt
23359 @item -m64bit-doubles
23360 @itemx -m32bit-doubles
23361 @opindex m64bit-doubles
23362 @opindex m32bit-doubles
23363 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
23364 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
23365 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
23366 works on 32-bit values, which is why the default is
23367 @option{-m32bit-doubles}.
23369 @item -fpu
23370 @itemx -nofpu
23371 @opindex fpu
23372 @opindex nofpu
23373 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
23374 floating-point hardware.  The default is enabled for the RX600
23375 series and disabled for the RX200 series.
23377 Floating-point instructions are only generated for 32-bit floating-point 
23378 values, however, so the FPU hardware is not used for doubles if the
23379 @option{-m64bit-doubles} option is used.
23381 @emph{Note} If the @option{-fpu} option is enabled then
23382 @option{-funsafe-math-optimizations} is also enabled automatically.
23383 This is because the RX FPU instructions are themselves unsafe.
23385 @item -mcpu=@var{name}
23386 @opindex mcpu
23387 Selects the type of RX CPU to be targeted.  Currently three types are
23388 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
23389 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
23391 The only difference between @samp{RX600} and @samp{RX610} is that the
23392 @samp{RX610} does not support the @code{MVTIPL} instruction.
23394 The @samp{RX200} series does not have a hardware floating-point unit
23395 and so @option{-nofpu} is enabled by default when this type is
23396 selected.
23398 @item -mbig-endian-data
23399 @itemx -mlittle-endian-data
23400 @opindex mbig-endian-data
23401 @opindex mlittle-endian-data
23402 Store data (but not code) in the big-endian format.  The default is
23403 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
23404 format.
23406 @item -msmall-data-limit=@var{N}
23407 @opindex msmall-data-limit
23408 Specifies the maximum size in bytes of global and static variables
23409 which can be placed into the small data area.  Using the small data
23410 area can lead to smaller and faster code, but the size of area is
23411 limited and it is up to the programmer to ensure that the area does
23412 not overflow.  Also when the small data area is used one of the RX's
23413 registers (usually @code{r13}) is reserved for use pointing to this
23414 area, so it is no longer available for use by the compiler.  This
23415 could result in slower and/or larger code if variables are pushed onto
23416 the stack instead of being held in this register.
23418 Note, common variables (variables that have not been initialized) and
23419 constants are not placed into the small data area as they are assigned
23420 to other sections in the output executable.
23422 The default value is zero, which disables this feature.  Note, this
23423 feature is not enabled by default with higher optimization levels
23424 (@option{-O2} etc) because of the potentially detrimental effects of
23425 reserving a register.  It is up to the programmer to experiment and
23426 discover whether this feature is of benefit to their program.  See the
23427 description of the @option{-mpid} option for a description of how the
23428 actual register to hold the small data area pointer is chosen.
23430 @item -msim
23431 @itemx -mno-sim
23432 @opindex msim
23433 @opindex mno-sim
23434 Use the simulator runtime.  The default is to use the libgloss
23435 board-specific runtime.
23437 @item -mas100-syntax
23438 @itemx -mno-as100-syntax
23439 @opindex mas100-syntax
23440 @opindex mno-as100-syntax
23441 When generating assembler output use a syntax that is compatible with
23442 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
23443 assembler, but it has some restrictions so it is not generated by default.
23445 @item -mmax-constant-size=@var{N}
23446 @opindex mmax-constant-size
23447 Specifies the maximum size, in bytes, of a constant that can be used as
23448 an operand in a RX instruction.  Although the RX instruction set does
23449 allow constants of up to 4 bytes in length to be used in instructions,
23450 a longer value equates to a longer instruction.  Thus in some
23451 circumstances it can be beneficial to restrict the size of constants
23452 that are used in instructions.  Constants that are too big are instead
23453 placed into a constant pool and referenced via register indirection.
23455 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
23456 or 4 means that constants of any size are allowed.
23458 @item -mrelax
23459 @opindex mrelax
23460 Enable linker relaxation.  Linker relaxation is a process whereby the
23461 linker attempts to reduce the size of a program by finding shorter
23462 versions of various instructions.  Disabled by default.
23464 @item -mint-register=@var{N}
23465 @opindex mint-register
23466 Specify the number of registers to reserve for fast interrupt handler
23467 functions.  The value @var{N} can be between 0 and 4.  A value of 1
23468 means that register @code{r13} is reserved for the exclusive use
23469 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
23470 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
23471 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
23472 A value of 0, the default, does not reserve any registers.
23474 @item -msave-acc-in-interrupts
23475 @opindex msave-acc-in-interrupts
23476 Specifies that interrupt handler functions should preserve the
23477 accumulator register.  This is only necessary if normal code might use
23478 the accumulator register, for example because it performs 64-bit
23479 multiplications.  The default is to ignore the accumulator as this
23480 makes the interrupt handlers faster.
23482 @item -mpid
23483 @itemx -mno-pid
23484 @opindex mpid
23485 @opindex mno-pid
23486 Enables the generation of position independent data.  When enabled any
23487 access to constant data is done via an offset from a base address
23488 held in a register.  This allows the location of constant data to be
23489 determined at run time without requiring the executable to be
23490 relocated, which is a benefit to embedded applications with tight
23491 memory constraints.  Data that can be modified is not affected by this
23492 option.
23494 Note, using this feature reserves a register, usually @code{r13}, for
23495 the constant data base address.  This can result in slower and/or
23496 larger code, especially in complicated functions.
23498 The actual register chosen to hold the constant data base address
23499 depends upon whether the @option{-msmall-data-limit} and/or the
23500 @option{-mint-register} command-line options are enabled.  Starting
23501 with register @code{r13} and proceeding downwards, registers are
23502 allocated first to satisfy the requirements of @option{-mint-register},
23503 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
23504 is possible for the small data area register to be @code{r8} if both
23505 @option{-mint-register=4} and @option{-mpid} are specified on the
23506 command line.
23508 By default this feature is not enabled.  The default can be restored
23509 via the @option{-mno-pid} command-line option.
23511 @item -mno-warn-multiple-fast-interrupts
23512 @itemx -mwarn-multiple-fast-interrupts
23513 @opindex mno-warn-multiple-fast-interrupts
23514 @opindex mwarn-multiple-fast-interrupts
23515 Prevents GCC from issuing a warning message if it finds more than one
23516 fast interrupt handler when it is compiling a file.  The default is to
23517 issue a warning for each extra fast interrupt handler found, as the RX
23518 only supports one such interrupt.
23520 @item -mallow-string-insns
23521 @itemx -mno-allow-string-insns
23522 @opindex mallow-string-insns
23523 @opindex mno-allow-string-insns
23524 Enables or disables the use of the string manipulation instructions
23525 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
23526 @code{SWHILE} and also the @code{RMPA} instruction.  These
23527 instructions may prefetch data, which is not safe to do if accessing
23528 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
23529 for more information).
23531 The default is to allow these instructions, but it is not possible for
23532 GCC to reliably detect all circumstances where a string instruction
23533 might be used to access an I/O register, so their use cannot be
23534 disabled automatically.  Instead it is reliant upon the programmer to
23535 use the @option{-mno-allow-string-insns} option if their program
23536 accesses I/O space.
23538 When the instructions are enabled GCC defines the C preprocessor
23539 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
23540 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
23542 @item -mjsr
23543 @itemx -mno-jsr
23544 @opindex mjsr
23545 @opindex mno-jsr
23546 Use only (or not only) @code{JSR} instructions to access functions.
23547 This option can be used when code size exceeds the range of @code{BSR}
23548 instructions.  Note that @option{-mno-jsr} does not mean to not use
23549 @code{JSR} but instead means that any type of branch may be used.
23550 @end table
23552 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
23553 has special significance to the RX port when used with the
23554 @code{interrupt} function attribute.  This attribute indicates a
23555 function intended to process fast interrupts.  GCC ensures
23556 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
23557 and/or @code{r13} and only provided that the normal use of the
23558 corresponding registers have been restricted via the
23559 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
23560 options.
23562 @node S/390 and zSeries Options
23563 @subsection S/390 and zSeries Options
23564 @cindex S/390 and zSeries Options
23566 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
23568 @table @gcctabopt
23569 @item -mhard-float
23570 @itemx -msoft-float
23571 @opindex mhard-float
23572 @opindex msoft-float
23573 Use (do not use) the hardware floating-point instructions and registers
23574 for floating-point operations.  When @option{-msoft-float} is specified,
23575 functions in @file{libgcc.a} are used to perform floating-point
23576 operations.  When @option{-mhard-float} is specified, the compiler
23577 generates IEEE floating-point instructions.  This is the default.
23579 @item -mhard-dfp
23580 @itemx -mno-hard-dfp
23581 @opindex mhard-dfp
23582 @opindex mno-hard-dfp
23583 Use (do not use) the hardware decimal-floating-point instructions for
23584 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
23585 specified, functions in @file{libgcc.a} are used to perform
23586 decimal-floating-point operations.  When @option{-mhard-dfp} is
23587 specified, the compiler generates decimal-floating-point hardware
23588 instructions.  This is the default for @option{-march=z9-ec} or higher.
23590 @item -mlong-double-64
23591 @itemx -mlong-double-128
23592 @opindex mlong-double-64
23593 @opindex mlong-double-128
23594 These switches control the size of @code{long double} type. A size
23595 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23596 type. This is the default.
23598 @item -mbackchain
23599 @itemx -mno-backchain
23600 @opindex mbackchain
23601 @opindex mno-backchain
23602 Store (do not store) the address of the caller's frame as backchain pointer
23603 into the callee's stack frame.
23604 A backchain may be needed to allow debugging using tools that do not understand
23605 DWARF call frame information.
23606 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23607 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23608 the backchain is placed into the topmost word of the 96/160 byte register
23609 save area.
23611 In general, code compiled with @option{-mbackchain} is call-compatible with
23612 code compiled with @option{-mmo-backchain}; however, use of the backchain
23613 for debugging purposes usually requires that the whole binary is built with
23614 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23615 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23616 to build a linux kernel use @option{-msoft-float}.
23618 The default is to not maintain the backchain.
23620 @item -mpacked-stack
23621 @itemx -mno-packed-stack
23622 @opindex mpacked-stack
23623 @opindex mno-packed-stack
23624 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23625 specified, the compiler uses the all fields of the 96/160 byte register save
23626 area only for their default purpose; unused fields still take up stack space.
23627 When @option{-mpacked-stack} is specified, register save slots are densely
23628 packed at the top of the register save area; unused space is reused for other
23629 purposes, allowing for more efficient use of the available stack space.
23630 However, when @option{-mbackchain} is also in effect, the topmost word of
23631 the save area is always used to store the backchain, and the return address
23632 register is always saved two words below the backchain.
23634 As long as the stack frame backchain is not used, code generated with
23635 @option{-mpacked-stack} is call-compatible with code generated with
23636 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23637 S/390 or zSeries generated code that uses the stack frame backchain at run
23638 time, not just for debugging purposes.  Such code is not call-compatible
23639 with code compiled with @option{-mpacked-stack}.  Also, note that the
23640 combination of @option{-mbackchain},
23641 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23642 to build a linux kernel use @option{-msoft-float}.
23644 The default is to not use the packed stack layout.
23646 @item -msmall-exec
23647 @itemx -mno-small-exec
23648 @opindex msmall-exec
23649 @opindex mno-small-exec
23650 Generate (or do not generate) code using the @code{bras} instruction
23651 to do subroutine calls.
23652 This only works reliably if the total executable size does not
23653 exceed 64k.  The default is to use the @code{basr} instruction instead,
23654 which does not have this limitation.
23656 @item -m64
23657 @itemx -m31
23658 @opindex m64
23659 @opindex m31
23660 When @option{-m31} is specified, generate code compliant to the
23661 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23662 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23663 particular to generate 64-bit instructions.  For the @samp{s390}
23664 targets, the default is @option{-m31}, while the @samp{s390x}
23665 targets default to @option{-m64}.
23667 @item -mzarch
23668 @itemx -mesa
23669 @opindex mzarch
23670 @opindex mesa
23671 When @option{-mzarch} is specified, generate code using the
23672 instructions available on z/Architecture.
23673 When @option{-mesa} is specified, generate code using the
23674 instructions available on ESA/390.  Note that @option{-mesa} is
23675 not possible with @option{-m64}.
23676 When generating code compliant to the GNU/Linux for S/390 ABI,
23677 the default is @option{-mesa}.  When generating code compliant
23678 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23680 @item -mhtm
23681 @itemx -mno-htm
23682 @opindex mhtm
23683 @opindex mno-htm
23684 The @option{-mhtm} option enables a set of builtins making use of
23685 instructions available with the transactional execution facility
23686 introduced with the IBM zEnterprise EC12 machine generation
23687 @ref{S/390 System z Built-in Functions}.
23688 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23690 @item -mvx
23691 @itemx -mno-vx
23692 @opindex mvx
23693 @opindex mno-vx
23694 When @option{-mvx} is specified, generate code using the instructions
23695 available with the vector extension facility introduced with the IBM
23696 z13 machine generation.
23697 This option changes the ABI for some vector type values with regard to
23698 alignment and calling conventions.  In case vector type values are
23699 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23700 command will be added to mark the resulting binary with the ABI used.
23701 @option{-mvx} is enabled by default when using @option{-march=z13}.
23703 @item -mzvector
23704 @itemx -mno-zvector
23705 @opindex mzvector
23706 @opindex mno-zvector
23707 The @option{-mzvector} option enables vector language extensions and
23708 builtins using instructions available with the vector extension
23709 facility introduced with the IBM z13 machine generation.
23710 This option adds support for @samp{vector} to be used as a keyword to
23711 define vector type variables and arguments.  @samp{vector} is only
23712 available when GNU extensions are enabled.  It will not be expanded
23713 when requesting strict standard compliance e.g. with @option{-std=c99}.
23714 In addition to the GCC low-level builtins @option{-mzvector} enables
23715 a set of builtins added for compatibility with AltiVec-style
23716 implementations like Power and Cell.  In order to make use of these
23717 builtins the header file @file{vecintrin.h} needs to be included.
23718 @option{-mzvector} is disabled by default.
23720 @item -mmvcle
23721 @itemx -mno-mvcle
23722 @opindex mmvcle
23723 @opindex mno-mvcle
23724 Generate (or do not generate) code using the @code{mvcle} instruction
23725 to perform block moves.  When @option{-mno-mvcle} is specified,
23726 use a @code{mvc} loop instead.  This is the default unless optimizing for
23727 size.
23729 @item -mdebug
23730 @itemx -mno-debug
23731 @opindex mdebug
23732 @opindex mno-debug
23733 Print (or do not print) additional debug information when compiling.
23734 The default is to not print debug information.
23736 @item -march=@var{cpu-type}
23737 @opindex march
23738 Generate code that runs on @var{cpu-type}, which is the name of a
23739 system representing a certain processor type.  Possible values for
23740 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23741 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23742 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23743 @samp{native}.
23745 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23746 @samp{g6} are deprecated and will be removed with future releases.
23748 Specifying @samp{native} as cpu type can be used to select the best
23749 architecture option for the host processor.
23750 @option{-march=native} has no effect if GCC does not recognize the
23751 processor.
23753 @item -mtune=@var{cpu-type}
23754 @opindex mtune
23755 Tune to @var{cpu-type} everything applicable about the generated code,
23756 except for the ABI and the set of available instructions.
23757 The list of @var{cpu-type} values is the same as for @option{-march}.
23758 The default is the value used for @option{-march}.
23760 @item -mtpf-trace
23761 @itemx -mno-tpf-trace
23762 @opindex mtpf-trace
23763 @opindex mno-tpf-trace
23764 Generate code that adds (does not add) in TPF OS specific branches to trace
23765 routines in the operating system.  This option is off by default, even
23766 when compiling for the TPF OS@.
23768 @item -mfused-madd
23769 @itemx -mno-fused-madd
23770 @opindex mfused-madd
23771 @opindex mno-fused-madd
23772 Generate code that uses (does not use) the floating-point multiply and
23773 accumulate instructions.  These instructions are generated by default if
23774 hardware floating point is used.
23776 @item -mwarn-framesize=@var{framesize}
23777 @opindex mwarn-framesize
23778 Emit a warning if the current function exceeds the given frame size.  Because
23779 this is a compile-time check it doesn't need to be a real problem when the program
23780 runs.  It is intended to identify functions that most probably cause
23781 a stack overflow.  It is useful to be used in an environment with limited stack
23782 size e.g.@: the linux kernel.
23784 @item -mwarn-dynamicstack
23785 @opindex mwarn-dynamicstack
23786 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23787 arrays.  This is generally a bad idea with a limited stack size.
23789 @item -mstack-guard=@var{stack-guard}
23790 @itemx -mstack-size=@var{stack-size}
23791 @opindex mstack-guard
23792 @opindex mstack-size
23793 If these options are provided the S/390 back end emits additional instructions in
23794 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23795 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23796 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23797 the frame size of the compiled function is chosen.
23798 These options are intended to be used to help debugging stack overflow problems.
23799 The additionally emitted code causes only little overhead and hence can also be
23800 used in production-like systems without greater performance degradation.  The given
23801 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23802 @var{stack-guard} without exceeding 64k.
23803 In order to be efficient the extra code makes the assumption that the stack starts
23804 at an address aligned to the value given by @var{stack-size}.
23805 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23807 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23808 @opindex mhotpatch
23809 If the hotpatch option is enabled, a ``hot-patching'' function
23810 prologue is generated for all functions in the compilation unit.
23811 The funtion label is prepended with the given number of two-byte
23812 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23813 the label, 2 * @var{post-halfwords} bytes are appended, using the
23814 largest NOP like instructions the architecture allows (maximum
23815 1000000).
23817 If both arguments are zero, hotpatching is disabled.
23819 This option can be overridden for individual functions with the
23820 @code{hotpatch} attribute.
23821 @end table
23823 @node Score Options
23824 @subsection Score Options
23825 @cindex Score Options
23827 These options are defined for Score implementations:
23829 @table @gcctabopt
23830 @item -meb
23831 @opindex meb
23832 Compile code for big-endian mode.  This is the default.
23834 @item -mel
23835 @opindex mel
23836 Compile code for little-endian mode.
23838 @item -mnhwloop
23839 @opindex mnhwloop
23840 Disable generation of @code{bcnz} instructions.
23842 @item -muls
23843 @opindex muls
23844 Enable generation of unaligned load and store instructions.
23846 @item -mmac
23847 @opindex mmac
23848 Enable the use of multiply-accumulate instructions. Disabled by default.
23850 @item -mscore5
23851 @opindex mscore5
23852 Specify the SCORE5 as the target architecture.
23854 @item -mscore5u
23855 @opindex mscore5u
23856 Specify the SCORE5U of the target architecture.
23858 @item -mscore7
23859 @opindex mscore7
23860 Specify the SCORE7 as the target architecture. This is the default.
23862 @item -mscore7d
23863 @opindex mscore7d
23864 Specify the SCORE7D as the target architecture.
23865 @end table
23867 @node SH Options
23868 @subsection SH Options
23870 These @samp{-m} options are defined for the SH implementations:
23872 @table @gcctabopt
23873 @item -m1
23874 @opindex m1
23875 Generate code for the SH1.
23877 @item -m2
23878 @opindex m2
23879 Generate code for the SH2.
23881 @item -m2e
23882 Generate code for the SH2e.
23884 @item -m2a-nofpu
23885 @opindex m2a-nofpu
23886 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23887 that the floating-point unit is not used.
23889 @item -m2a-single-only
23890 @opindex m2a-single-only
23891 Generate code for the SH2a-FPU, in such a way that no double-precision
23892 floating-point operations are used.
23894 @item -m2a-single
23895 @opindex m2a-single
23896 Generate code for the SH2a-FPU assuming the floating-point unit is in
23897 single-precision mode by default.
23899 @item -m2a
23900 @opindex m2a
23901 Generate code for the SH2a-FPU assuming the floating-point unit is in
23902 double-precision mode by default.
23904 @item -m3
23905 @opindex m3
23906 Generate code for the SH3.
23908 @item -m3e
23909 @opindex m3e
23910 Generate code for the SH3e.
23912 @item -m4-nofpu
23913 @opindex m4-nofpu
23914 Generate code for the SH4 without a floating-point unit.
23916 @item -m4-single-only
23917 @opindex m4-single-only
23918 Generate code for the SH4 with a floating-point unit that only
23919 supports single-precision arithmetic.
23921 @item -m4-single
23922 @opindex m4-single
23923 Generate code for the SH4 assuming the floating-point unit is in
23924 single-precision mode by default.
23926 @item -m4
23927 @opindex m4
23928 Generate code for the SH4.
23930 @item -m4-100
23931 @opindex m4-100
23932 Generate code for SH4-100.
23934 @item -m4-100-nofpu
23935 @opindex m4-100-nofpu
23936 Generate code for SH4-100 in such a way that the
23937 floating-point unit is not used.
23939 @item -m4-100-single
23940 @opindex m4-100-single
23941 Generate code for SH4-100 assuming the floating-point unit is in
23942 single-precision mode by default.
23944 @item -m4-100-single-only
23945 @opindex m4-100-single-only
23946 Generate code for SH4-100 in such a way that no double-precision
23947 floating-point operations are used.
23949 @item -m4-200
23950 @opindex m4-200
23951 Generate code for SH4-200.
23953 @item -m4-200-nofpu
23954 @opindex m4-200-nofpu
23955 Generate code for SH4-200 without in such a way that the
23956 floating-point unit is not used.
23958 @item -m4-200-single
23959 @opindex m4-200-single
23960 Generate code for SH4-200 assuming the floating-point unit is in
23961 single-precision mode by default.
23963 @item -m4-200-single-only
23964 @opindex m4-200-single-only
23965 Generate code for SH4-200 in such a way that no double-precision
23966 floating-point operations are used.
23968 @item -m4-300
23969 @opindex m4-300
23970 Generate code for SH4-300.
23972 @item -m4-300-nofpu
23973 @opindex m4-300-nofpu
23974 Generate code for SH4-300 without in such a way that the
23975 floating-point unit is not used.
23977 @item -m4-300-single
23978 @opindex m4-300-single
23979 Generate code for SH4-300 in such a way that no double-precision
23980 floating-point operations are used.
23982 @item -m4-300-single-only
23983 @opindex m4-300-single-only
23984 Generate code for SH4-300 in such a way that no double-precision
23985 floating-point operations are used.
23987 @item -m4-340
23988 @opindex m4-340
23989 Generate code for SH4-340 (no MMU, no FPU).
23991 @item -m4-500
23992 @opindex m4-500
23993 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23994 assembler.
23996 @item -m4a-nofpu
23997 @opindex m4a-nofpu
23998 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23999 floating-point unit is not used.
24001 @item -m4a-single-only
24002 @opindex m4a-single-only
24003 Generate code for the SH4a, in such a way that no double-precision
24004 floating-point operations are used.
24006 @item -m4a-single
24007 @opindex m4a-single
24008 Generate code for the SH4a assuming the floating-point unit is in
24009 single-precision mode by default.
24011 @item -m4a
24012 @opindex m4a
24013 Generate code for the SH4a.
24015 @item -m4al
24016 @opindex m4al
24017 Same as @option{-m4a-nofpu}, except that it implicitly passes
24018 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
24019 instructions at the moment.
24021 @item -mb
24022 @opindex mb
24023 Compile code for the processor in big-endian mode.
24025 @item -ml
24026 @opindex ml
24027 Compile code for the processor in little-endian mode.
24029 @item -mdalign
24030 @opindex mdalign
24031 Align doubles at 64-bit boundaries.  Note that this changes the calling
24032 conventions, and thus some functions from the standard C library do
24033 not work unless you recompile it first with @option{-mdalign}.
24035 @item -mrelax
24036 @opindex mrelax
24037 Shorten some address references at link time, when possible; uses the
24038 linker option @option{-relax}.
24040 @item -mbigtable
24041 @opindex mbigtable
24042 Use 32-bit offsets in @code{switch} tables.  The default is to use
24043 16-bit offsets.
24045 @item -mbitops
24046 @opindex mbitops
24047 Enable the use of bit manipulation instructions on SH2A.
24049 @item -mfmovd
24050 @opindex mfmovd
24051 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
24052 alignment constraints.
24054 @item -mrenesas
24055 @opindex mrenesas
24056 Comply with the calling conventions defined by Renesas.
24058 @item -mno-renesas
24059 @opindex mno-renesas
24060 Comply with the calling conventions defined for GCC before the Renesas
24061 conventions were available.  This option is the default for all
24062 targets of the SH toolchain.
24064 @item -mnomacsave
24065 @opindex mnomacsave
24066 Mark the @code{MAC} register as call-clobbered, even if
24067 @option{-mrenesas} is given.
24069 @item -mieee
24070 @itemx -mno-ieee
24071 @opindex mieee
24072 @opindex mno-ieee
24073 Control the IEEE compliance of floating-point comparisons, which affects the
24074 handling of cases where the result of a comparison is unordered.  By default
24075 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
24076 enabled @option{-mno-ieee} is implicitly set, which results in faster
24077 floating-point greater-equal and less-equal comparisons.  The implicit settings
24078 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
24080 @item -minline-ic_invalidate
24081 @opindex minline-ic_invalidate
24082 Inline code to invalidate instruction cache entries after setting up
24083 nested function trampolines.
24084 This option has no effect if @option{-musermode} is in effect and the selected
24085 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
24086 instruction.
24087 If the selected code generation option does not allow the use of the @code{icbi}
24088 instruction, and @option{-musermode} is not in effect, the inlined code
24089 manipulates the instruction cache address array directly with an associative
24090 write.  This not only requires privileged mode at run time, but it also
24091 fails if the cache line had been mapped via the TLB and has become unmapped.
24093 @item -misize
24094 @opindex misize
24095 Dump instruction size and location in the assembly code.
24097 @item -mpadstruct
24098 @opindex mpadstruct
24099 This option is deprecated.  It pads structures to multiple of 4 bytes,
24100 which is incompatible with the SH ABI@.
24102 @item -matomic-model=@var{model}
24103 @opindex matomic-model=@var{model}
24104 Sets the model of atomic operations and additional parameters as a comma
24105 separated list.  For details on the atomic built-in functions see
24106 @ref{__atomic Builtins}.  The following models and parameters are supported:
24108 @table @samp
24110 @item none
24111 Disable compiler generated atomic sequences and emit library calls for atomic
24112 operations.  This is the default if the target is not @code{sh*-*-linux*}.
24114 @item soft-gusa
24115 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
24116 built-in functions.  The generated atomic sequences require additional support
24117 from the interrupt/exception handling code of the system and are only suitable
24118 for SH3* and SH4* single-core systems.  This option is enabled by default when
24119 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
24120 this option also partially utilizes the hardware atomic instructions
24121 @code{movli.l} and @code{movco.l} to create more efficient code, unless
24122 @samp{strict} is specified.  
24124 @item soft-tcb
24125 Generate software atomic sequences that use a variable in the thread control
24126 block.  This is a variation of the gUSA sequences which can also be used on
24127 SH1* and SH2* targets.  The generated atomic sequences require additional
24128 support from the interrupt/exception handling code of the system and are only
24129 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
24130 parameter has to be specified as well.
24132 @item soft-imask
24133 Generate software atomic sequences that temporarily disable interrupts by
24134 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
24135 in privileged mode and is only suitable for single-core systems.  Additional
24136 support from the interrupt/exception handling code of the system is not
24137 required.  This model is enabled by default when the target is
24138 @code{sh*-*-linux*} and SH1* or SH2*.
24140 @item hard-llcs
24141 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
24142 instructions only.  This is only available on SH4A and is suitable for
24143 multi-core systems.  Since the hardware instructions support only 32 bit atomic
24144 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
24145 Code compiled with this option is also compatible with other software
24146 atomic model interrupt/exception handling systems if executed on an SH4A
24147 system.  Additional support from the interrupt/exception handling code of the
24148 system is not required for this model.
24150 @item gbr-offset=
24151 This parameter specifies the offset in bytes of the variable in the thread
24152 control block structure that should be used by the generated atomic sequences
24153 when the @samp{soft-tcb} model has been selected.  For other models this
24154 parameter is ignored.  The specified value must be an integer multiple of four
24155 and in the range 0-1020.
24157 @item strict
24158 This parameter prevents mixed usage of multiple atomic models, even if they
24159 are compatible, and makes the compiler generate atomic sequences of the
24160 specified model only.
24162 @end table
24164 @item -mtas
24165 @opindex mtas
24166 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
24167 Notice that depending on the particular hardware and software configuration
24168 this can degrade overall performance due to the operand cache line flushes
24169 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
24170 processors the @code{tas.b} instruction must be used with caution since it
24171 can result in data corruption for certain cache configurations.
24173 @item -mprefergot
24174 @opindex mprefergot
24175 When generating position-independent code, emit function calls using
24176 the Global Offset Table instead of the Procedure Linkage Table.
24178 @item -musermode
24179 @itemx -mno-usermode
24180 @opindex musermode
24181 @opindex mno-usermode
24182 Don't allow (allow) the compiler generating privileged mode code.  Specifying
24183 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
24184 inlined code would not work in user mode.  @option{-musermode} is the default
24185 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
24186 @option{-musermode} has no effect, since there is no user mode.
24188 @item -multcost=@var{number}
24189 @opindex multcost=@var{number}
24190 Set the cost to assume for a multiply insn.
24192 @item -mdiv=@var{strategy}
24193 @opindex mdiv=@var{strategy}
24194 Set the division strategy to be used for integer division operations.
24195 @var{strategy} can be one of: 
24197 @table @samp
24199 @item call-div1
24200 Calls a library function that uses the single-step division instruction
24201 @code{div1} to perform the operation.  Division by zero calculates an
24202 unspecified result and does not trap.  This is the default except for SH4,
24203 SH2A and SHcompact.
24205 @item call-fp
24206 Calls a library function that performs the operation in double precision
24207 floating point.  Division by zero causes a floating-point exception.  This is
24208 the default for SHcompact with FPU.  Specifying this for targets that do not
24209 have a double precision FPU defaults to @code{call-div1}.
24211 @item call-table
24212 Calls a library function that uses a lookup table for small divisors and
24213 the @code{div1} instruction with case distinction for larger divisors.  Division
24214 by zero calculates an unspecified result and does not trap.  This is the default
24215 for SH4.  Specifying this for targets that do not have dynamic shift
24216 instructions defaults to @code{call-div1}.
24218 @end table
24220 When a division strategy has not been specified the default strategy is
24221 selected based on the current target.  For SH2A the default strategy is to
24222 use the @code{divs} and @code{divu} instructions instead of library function
24223 calls.
24225 @item -maccumulate-outgoing-args
24226 @opindex maccumulate-outgoing-args
24227 Reserve space once for outgoing arguments in the function prologue rather
24228 than around each call.  Generally beneficial for performance and size.  Also
24229 needed for unwinding to avoid changing the stack frame around conditional code.
24231 @item -mdivsi3_libfunc=@var{name}
24232 @opindex mdivsi3_libfunc=@var{name}
24233 Set the name of the library function used for 32-bit signed division to
24234 @var{name}.
24235 This only affects the name used in the @samp{call} division strategies, and
24236 the compiler still expects the same sets of input/output/clobbered registers as
24237 if this option were not present.
24239 @item -mfixed-range=@var{register-range}
24240 @opindex mfixed-range
24241 Generate code treating the given register range as fixed registers.
24242 A fixed register is one that the register allocator can not use.  This is
24243 useful when compiling kernel code.  A register range is specified as
24244 two registers separated by a dash.  Multiple register ranges can be
24245 specified separated by a comma.
24247 @item -mbranch-cost=@var{num}
24248 @opindex mbranch-cost=@var{num}
24249 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
24250 make the compiler try to generate more branch-free code if possible.  
24251 If not specified the value is selected depending on the processor type that
24252 is being compiled for.
24254 @item -mzdcbranch
24255 @itemx -mno-zdcbranch
24256 @opindex mzdcbranch
24257 @opindex mno-zdcbranch
24258 Assume (do not assume) that zero displacement conditional branch instructions
24259 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
24260 compiler prefers zero displacement branch code sequences.  This is
24261 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
24262 disabled by specifying @option{-mno-zdcbranch}.
24264 @item -mcbranch-force-delay-slot
24265 @opindex mcbranch-force-delay-slot
24266 Force the usage of delay slots for conditional branches, which stuffs the delay
24267 slot with a @code{nop} if a suitable instruction cannot be found.  By default
24268 this option is disabled.  It can be enabled to work around hardware bugs as
24269 found in the original SH7055.
24271 @item -mfused-madd
24272 @itemx -mno-fused-madd
24273 @opindex mfused-madd
24274 @opindex mno-fused-madd
24275 Generate code that uses (does not use) the floating-point multiply and
24276 accumulate instructions.  These instructions are generated by default
24277 if hardware floating point is used.  The machine-dependent
24278 @option{-mfused-madd} option is now mapped to the machine-independent
24279 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
24280 mapped to @option{-ffp-contract=off}.
24282 @item -mfsca
24283 @itemx -mno-fsca
24284 @opindex mfsca
24285 @opindex mno-fsca
24286 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
24287 and cosine approximations.  The option @option{-mfsca} must be used in
24288 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
24289 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
24290 approximations even if @option{-funsafe-math-optimizations} is in effect.
24292 @item -mfsrra
24293 @itemx -mno-fsrra
24294 @opindex mfsrra
24295 @opindex mno-fsrra
24296 Allow or disallow the compiler to emit the @code{fsrra} instruction for
24297 reciprocal square root approximations.  The option @option{-mfsrra} must be used
24298 in combination with @option{-funsafe-math-optimizations} and
24299 @option{-ffinite-math-only}.  It is enabled by default when generating code for
24300 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
24301 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
24302 in effect.
24304 @item -mpretend-cmove
24305 @opindex mpretend-cmove
24306 Prefer zero-displacement conditional branches for conditional move instruction
24307 patterns.  This can result in faster code on the SH4 processor.
24309 @item -mfdpic
24310 @opindex fdpic
24311 Generate code using the FDPIC ABI.
24313 @end table
24315 @node Solaris 2 Options
24316 @subsection Solaris 2 Options
24317 @cindex Solaris 2 options
24319 These @samp{-m} options are supported on Solaris 2:
24321 @table @gcctabopt
24322 @item -mclear-hwcap
24323 @opindex mclear-hwcap
24324 @option{-mclear-hwcap} tells the compiler to remove the hardware
24325 capabilities generated by the Solaris assembler.  This is only necessary
24326 when object files use ISA extensions not supported by the current
24327 machine, but check at runtime whether or not to use them.
24329 @item -mimpure-text
24330 @opindex mimpure-text
24331 @option{-mimpure-text}, used in addition to @option{-shared}, tells
24332 the compiler to not pass @option{-z text} to the linker when linking a
24333 shared object.  Using this option, you can link position-dependent
24334 code into a shared object.
24336 @option{-mimpure-text} suppresses the ``relocations remain against
24337 allocatable but non-writable sections'' linker error message.
24338 However, the necessary relocations trigger copy-on-write, and the
24339 shared object is not actually shared across processes.  Instead of
24340 using @option{-mimpure-text}, you should compile all source code with
24341 @option{-fpic} or @option{-fPIC}.
24343 @end table
24345 These switches are supported in addition to the above on Solaris 2:
24347 @table @gcctabopt
24348 @item -pthreads
24349 @opindex pthreads
24350 This is a synonym for @option{-pthread}.
24351 @end table
24353 @node SPARC Options
24354 @subsection SPARC Options
24355 @cindex SPARC options
24357 These @samp{-m} options are supported on the SPARC:
24359 @table @gcctabopt
24360 @item -mno-app-regs
24361 @itemx -mapp-regs
24362 @opindex mno-app-regs
24363 @opindex mapp-regs
24364 Specify @option{-mapp-regs} to generate output using the global registers
24365 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
24366 global register 1, each global register 2 through 4 is then treated as an
24367 allocable register that is clobbered by function calls.  This is the default.
24369 To be fully SVR4 ABI-compliant at the cost of some performance loss,
24370 specify @option{-mno-app-regs}.  You should compile libraries and system
24371 software with this option.
24373 @item -mflat
24374 @itemx -mno-flat
24375 @opindex mflat
24376 @opindex mno-flat
24377 With @option{-mflat}, the compiler does not generate save/restore instructions
24378 and uses a ``flat'' or single register window model.  This model is compatible
24379 with the regular register window model.  The local registers and the input
24380 registers (0--5) are still treated as ``call-saved'' registers and are
24381 saved on the stack as needed.
24383 With @option{-mno-flat} (the default), the compiler generates save/restore
24384 instructions (except for leaf functions).  This is the normal operating mode.
24386 @item -mfpu
24387 @itemx -mhard-float
24388 @opindex mfpu
24389 @opindex mhard-float
24390 Generate output containing floating-point instructions.  This is the
24391 default.
24393 @item -mno-fpu
24394 @itemx -msoft-float
24395 @opindex mno-fpu
24396 @opindex msoft-float
24397 Generate output containing library calls for floating point.
24398 @strong{Warning:} the requisite libraries are not available for all SPARC
24399 targets.  Normally the facilities of the machine's usual C compiler are
24400 used, but this cannot be done directly in cross-compilation.  You must make
24401 your own arrangements to provide suitable library functions for
24402 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
24403 @samp{sparclite-*-*} do provide software floating-point support.
24405 @option{-msoft-float} changes the calling convention in the output file;
24406 therefore, it is only useful if you compile @emph{all} of a program with
24407 this option.  In particular, you need to compile @file{libgcc.a}, the
24408 library that comes with GCC, with @option{-msoft-float} in order for
24409 this to work.
24411 @item -mhard-quad-float
24412 @opindex mhard-quad-float
24413 Generate output containing quad-word (long double) floating-point
24414 instructions.
24416 @item -msoft-quad-float
24417 @opindex msoft-quad-float
24418 Generate output containing library calls for quad-word (long double)
24419 floating-point instructions.  The functions called are those specified
24420 in the SPARC ABI@.  This is the default.
24422 As of this writing, there are no SPARC implementations that have hardware
24423 support for the quad-word floating-point instructions.  They all invoke
24424 a trap handler for one of these instructions, and then the trap handler
24425 emulates the effect of the instruction.  Because of the trap handler overhead,
24426 this is much slower than calling the ABI library routines.  Thus the
24427 @option{-msoft-quad-float} option is the default.
24429 @item -mno-unaligned-doubles
24430 @itemx -munaligned-doubles
24431 @opindex mno-unaligned-doubles
24432 @opindex munaligned-doubles
24433 Assume that doubles have 8-byte alignment.  This is the default.
24435 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
24436 alignment only if they are contained in another type, or if they have an
24437 absolute address.  Otherwise, it assumes they have 4-byte alignment.
24438 Specifying this option avoids some rare compatibility problems with code
24439 generated by other compilers.  It is not the default because it results
24440 in a performance loss, especially for floating-point code.
24442 @item -muser-mode
24443 @itemx -mno-user-mode
24444 @opindex muser-mode
24445 @opindex mno-user-mode
24446 Do not generate code that can only run in supervisor mode.  This is relevant
24447 only for the @code{casa} instruction emitted for the LEON3 processor.  This
24448 is the default.
24450 @item -mfaster-structs
24451 @itemx -mno-faster-structs
24452 @opindex mfaster-structs
24453 @opindex mno-faster-structs
24454 With @option{-mfaster-structs}, the compiler assumes that structures
24455 should have 8-byte alignment.  This enables the use of pairs of
24456 @code{ldd} and @code{std} instructions for copies in structure
24457 assignment, in place of twice as many @code{ld} and @code{st} pairs.
24458 However, the use of this changed alignment directly violates the SPARC
24459 ABI@.  Thus, it's intended only for use on targets where the developer
24460 acknowledges that their resulting code is not directly in line with
24461 the rules of the ABI@.
24463 @item -mstd-struct-return
24464 @itemx -mno-std-struct-return
24465 @opindex mstd-struct-return
24466 @opindex mno-std-struct-return
24467 With @option{-mstd-struct-return}, the compiler generates checking code
24468 in functions returning structures or unions to detect size mismatches
24469 between the two sides of function calls, as per the 32-bit ABI@.
24471 The default is @option{-mno-std-struct-return}.  This option has no effect
24472 in 64-bit mode.
24474 @item -mlra
24475 @itemx -mno-lra
24476 @opindex mlra
24477 @opindex mno-lra
24478 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
24479 so @option{-mno-lra} needs to be passed to get old Reload.
24481 @item -mcpu=@var{cpu_type}
24482 @opindex mcpu
24483 Set the instruction set, register set, and instruction scheduling parameters
24484 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24485 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
24486 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
24487 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
24488 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
24489 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
24491 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
24492 which selects the best architecture option for the host processor.
24493 @option{-mcpu=native} has no effect if GCC does not recognize
24494 the processor.
24496 Default instruction scheduling parameters are used for values that select
24497 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
24498 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
24500 Here is a list of each supported architecture and their supported
24501 implementations.
24503 @table @asis
24504 @item v7
24505 cypress, leon3v7
24507 @item v8
24508 supersparc, hypersparc, leon, leon3
24510 @item sparclite
24511 f930, f934, sparclite86x
24513 @item sparclet
24514 tsc701
24516 @item v9
24517 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
24518 niagara7, m8
24519 @end table
24521 By default (unless configured otherwise), GCC generates code for the V7
24522 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
24523 additionally optimizes it for the Cypress CY7C602 chip, as used in the
24524 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
24525 SPARCStation 1, 2, IPX etc.
24527 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
24528 architecture.  The only difference from V7 code is that the compiler emits
24529 the integer multiply and integer divide instructions which exist in SPARC-V8
24530 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
24531 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
24532 2000 series.
24534 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
24535 the SPARC architecture.  This adds the integer multiply, integer divide step
24536 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
24537 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
24538 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
24539 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
24540 MB86934 chip, which is the more recent SPARClite with FPU@.
24542 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
24543 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
24544 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
24545 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
24546 optimizes it for the TEMIC SPARClet chip.
24548 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
24549 architecture.  This adds 64-bit integer and floating-point move instructions,
24550 3 additional floating-point condition code registers and conditional move
24551 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
24552 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
24553 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
24554 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
24555 @option{-mcpu=niagara}, the compiler additionally optimizes it for
24556 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
24557 additionally optimizes it for Sun UltraSPARC T2 chips. With
24558 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
24559 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
24560 additionally optimizes it for Sun UltraSPARC T4 chips.  With
24561 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
24562 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
24563 additionally optimizes it for Oracle M8 chips.
24565 @item -mtune=@var{cpu_type}
24566 @opindex mtune
24567 Set the instruction scheduling parameters for machine type
24568 @var{cpu_type}, but do not set the instruction set or register set that the
24569 option @option{-mcpu=@var{cpu_type}} does.
24571 The same values for @option{-mcpu=@var{cpu_type}} can be used for
24572 @option{-mtune=@var{cpu_type}}, but the only useful values are those
24573 that select a particular CPU implementation.  Those are
24574 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
24575 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
24576 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
24577 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
24578 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
24579 and GNU/Linux toolchains, @samp{native} can also be used.
24581 @item -mv8plus
24582 @itemx -mno-v8plus
24583 @opindex mv8plus
24584 @opindex mno-v8plus
24585 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
24586 difference from the V8 ABI is that the global and out registers are
24587 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
24588 mode for all SPARC-V9 processors.
24590 @item -mvis
24591 @itemx -mno-vis
24592 @opindex mvis
24593 @opindex mno-vis
24594 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
24595 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
24597 @item -mvis2
24598 @itemx -mno-vis2
24599 @opindex mvis2
24600 @opindex mno-vis2
24601 With @option{-mvis2}, GCC generates code that takes advantage of
24602 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
24603 default is @option{-mvis2} when targeting a cpu that supports such
24604 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
24605 also sets @option{-mvis}.
24607 @item -mvis3
24608 @itemx -mno-vis3
24609 @opindex mvis3
24610 @opindex mno-vis3
24611 With @option{-mvis3}, GCC generates code that takes advantage of
24612 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24613 default is @option{-mvis3} when targeting a cpu that supports such
24614 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24615 also sets @option{-mvis2} and @option{-mvis}.
24617 @item -mvis4
24618 @itemx -mno-vis4
24619 @opindex mvis4
24620 @opindex mno-vis4
24621 With @option{-mvis4}, GCC generates code that takes advantage of
24622 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24623 default is @option{-mvis4} when targeting a cpu that supports such
24624 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24625 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24627 @item -mvis4b
24628 @itemx -mno-vis4b
24629 @opindex mvis4b
24630 @opindex mno-vis4b
24631 With @option{-mvis4b}, GCC generates code that takes advantage of
24632 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
24633 the additional VIS instructions introduced in the Oracle SPARC
24634 Architecture 2017.  The default is @option{-mvis4b} when targeting a
24635 cpu that supports such instructions, such as m8 and later.  Setting
24636 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
24637 @option{-mvis2} and @option{-mvis}.
24639 @item -mcbcond
24640 @itemx -mno-cbcond
24641 @opindex mcbcond
24642 @opindex mno-cbcond
24643 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24644 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24645 when targeting a CPU that supports such instructions, such as Niagara-4 and
24646 later.
24648 @item -mfmaf
24649 @itemx -mno-fmaf
24650 @opindex mfmaf
24651 @opindex mno-fmaf
24652 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24653 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24654 when targeting a CPU that supports such instructions, such as Niagara-3 and
24655 later.
24657 @item -mfsmuld
24658 @itemx -mno-fsmuld
24659 @opindex mfsmuld
24660 @opindex mno-fsmuld
24661 With @option{-mfsmuld}, GCC generates code that takes advantage of the
24662 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
24663 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
24664 or V9 with FPU except @option{-mcpu=leon}.
24666 @item -mpopc
24667 @itemx -mno-popc
24668 @opindex mpopc
24669 @opindex mno-popc
24670 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24671 Population Count instruction.  The default is @option{-mpopc}
24672 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24673 later.
24675 @item -msubxc
24676 @itemx -mno-subxc
24677 @opindex msubxc
24678 @opindex mno-subxc
24679 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24680 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24681 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24682 later.
24684 @item -mfix-at697f
24685 @opindex mfix-at697f
24686 Enable the documented workaround for the single erratum of the Atmel AT697F
24687 processor (which corresponds to erratum #13 of the AT697E processor).
24689 @item -mfix-ut699
24690 @opindex mfix-ut699
24691 Enable the documented workarounds for the floating-point errata and the data
24692 cache nullify errata of the UT699 processor.
24694 @item -mfix-ut700
24695 @opindex mfix-ut700
24696 Enable the documented workaround for the back-to-back store errata of
24697 the UT699E/UT700 processor.
24699 @item -mfix-gr712rc
24700 @opindex mfix-gr712rc
24701 Enable the documented workaround for the back-to-back store errata of
24702 the GR712RC processor.
24703 @end table
24705 These @samp{-m} options are supported in addition to the above
24706 on SPARC-V9 processors in 64-bit environments:
24708 @table @gcctabopt
24709 @item -m32
24710 @itemx -m64
24711 @opindex m32
24712 @opindex m64
24713 Generate code for a 32-bit or 64-bit environment.
24714 The 32-bit environment sets int, long and pointer to 32 bits.
24715 The 64-bit environment sets int to 32 bits and long and pointer
24716 to 64 bits.
24718 @item -mcmodel=@var{which}
24719 @opindex mcmodel
24720 Set the code model to one of
24722 @table @samp
24723 @item medlow
24724 The Medium/Low code model: 64-bit addresses, programs
24725 must be linked in the low 32 bits of memory.  Programs can be statically
24726 or dynamically linked.
24728 @item medmid
24729 The Medium/Middle code model: 64-bit addresses, programs
24730 must be linked in the low 44 bits of memory, the text and data segments must
24731 be less than 2GB in size and the data segment must be located within 2GB of
24732 the text segment.
24734 @item medany
24735 The Medium/Anywhere code model: 64-bit addresses, programs
24736 may be linked anywhere in memory, the text and data segments must be less
24737 than 2GB in size and the data segment must be located within 2GB of the
24738 text segment.
24740 @item embmedany
24741 The Medium/Anywhere code model for embedded systems:
24742 64-bit addresses, the text and data segments must be less than 2GB in
24743 size, both starting anywhere in memory (determined at link time).  The
24744 global register %g4 points to the base of the data segment.  Programs
24745 are statically linked and PIC is not supported.
24746 @end table
24748 @item -mmemory-model=@var{mem-model}
24749 @opindex mmemory-model
24750 Set the memory model in force on the processor to one of
24752 @table @samp
24753 @item default
24754 The default memory model for the processor and operating system.
24756 @item rmo
24757 Relaxed Memory Order
24759 @item pso
24760 Partial Store Order
24762 @item tso
24763 Total Store Order
24765 @item sc
24766 Sequential Consistency
24767 @end table
24769 These memory models are formally defined in Appendix D of the SPARC-V9
24770 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24772 @item -mstack-bias
24773 @itemx -mno-stack-bias
24774 @opindex mstack-bias
24775 @opindex mno-stack-bias
24776 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24777 frame pointer if present, are offset by @minus{}2047 which must be added back
24778 when making stack frame references.  This is the default in 64-bit mode.
24779 Otherwise, assume no such offset is present.
24780 @end table
24782 @node SPU Options
24783 @subsection SPU Options
24784 @cindex SPU options
24786 These @samp{-m} options are supported on the SPU:
24788 @table @gcctabopt
24789 @item -mwarn-reloc
24790 @itemx -merror-reloc
24791 @opindex mwarn-reloc
24792 @opindex merror-reloc
24794 The loader for SPU does not handle dynamic relocations.  By default, GCC
24795 gives an error when it generates code that requires a dynamic
24796 relocation.  @option{-mno-error-reloc} disables the error,
24797 @option{-mwarn-reloc} generates a warning instead.
24799 @item -msafe-dma
24800 @itemx -munsafe-dma
24801 @opindex msafe-dma
24802 @opindex munsafe-dma
24804 Instructions that initiate or test completion of DMA must not be
24805 reordered with respect to loads and stores of the memory that is being
24806 accessed.
24807 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24808 memory accesses, but that can lead to inefficient code in places where the
24809 memory is known to not change.  Rather than mark the memory as volatile,
24810 you can use @option{-msafe-dma} to tell the compiler to treat
24811 the DMA instructions as potentially affecting all memory.  
24813 @item -mbranch-hints
24814 @opindex mbranch-hints
24816 By default, GCC generates a branch hint instruction to avoid
24817 pipeline stalls for always-taken or probably-taken branches.  A hint
24818 is not generated closer than 8 instructions away from its branch.
24819 There is little reason to disable them, except for debugging purposes,
24820 or to make an object a little bit smaller.
24822 @item -msmall-mem
24823 @itemx -mlarge-mem
24824 @opindex msmall-mem
24825 @opindex mlarge-mem
24827 By default, GCC generates code assuming that addresses are never larger
24828 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24829 a full 32-bit address.
24831 @item -mstdmain
24832 @opindex mstdmain
24834 By default, GCC links against startup code that assumes the SPU-style
24835 main function interface (which has an unconventional parameter list).
24836 With @option{-mstdmain}, GCC links your program against startup
24837 code that assumes a C99-style interface to @code{main}, including a
24838 local copy of @code{argv} strings.
24840 @item -mfixed-range=@var{register-range}
24841 @opindex mfixed-range
24842 Generate code treating the given register range as fixed registers.
24843 A fixed register is one that the register allocator cannot use.  This is
24844 useful when compiling kernel code.  A register range is specified as
24845 two registers separated by a dash.  Multiple register ranges can be
24846 specified separated by a comma.
24848 @item -mea32
24849 @itemx -mea64
24850 @opindex mea32
24851 @opindex mea64
24852 Compile code assuming that pointers to the PPU address space accessed
24853 via the @code{__ea} named address space qualifier are either 32 or 64
24854 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24855 all object code in an executable must be compiled with the same setting.
24857 @item -maddress-space-conversion
24858 @itemx -mno-address-space-conversion
24859 @opindex maddress-space-conversion
24860 @opindex mno-address-space-conversion
24861 Allow/disallow treating the @code{__ea} address space as superset
24862 of the generic address space.  This enables explicit type casts
24863 between @code{__ea} and generic pointer as well as implicit
24864 conversions of generic pointers to @code{__ea} pointers.  The
24865 default is to allow address space pointer conversions.
24867 @item -mcache-size=@var{cache-size}
24868 @opindex mcache-size
24869 This option controls the version of libgcc that the compiler links to an
24870 executable and selects a software-managed cache for accessing variables
24871 in the @code{__ea} address space with a particular cache size.  Possible
24872 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24873 and @samp{128}.  The default cache size is 64KB.
24875 @item -matomic-updates
24876 @itemx -mno-atomic-updates
24877 @opindex matomic-updates
24878 @opindex mno-atomic-updates
24879 This option controls the version of libgcc that the compiler links to an
24880 executable and selects whether atomic updates to the software-managed
24881 cache of PPU-side variables are used.  If you use atomic updates, changes
24882 to a PPU variable from SPU code using the @code{__ea} named address space
24883 qualifier do not interfere with changes to other PPU variables residing
24884 in the same cache line from PPU code.  If you do not use atomic updates,
24885 such interference may occur; however, writing back cache lines is
24886 more efficient.  The default behavior is to use atomic updates.
24888 @item -mdual-nops
24889 @itemx -mdual-nops=@var{n}
24890 @opindex mdual-nops
24891 By default, GCC inserts NOPs to increase dual issue when it expects
24892 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24893 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24894 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24896 @item -mhint-max-nops=@var{n}
24897 @opindex mhint-max-nops
24898 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24899 be at least 8 instructions away from the branch it is affecting.  GCC
24900 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24901 generate the branch hint.
24903 @item -mhint-max-distance=@var{n}
24904 @opindex mhint-max-distance
24905 The encoding of the branch hint instruction limits the hint to be within
24906 256 instructions of the branch it is affecting.  By default, GCC makes
24907 sure it is within 125.
24909 @item -msafe-hints
24910 @opindex msafe-hints
24911 Work around a hardware bug that causes the SPU to stall indefinitely.
24912 By default, GCC inserts the @code{hbrp} instruction to make sure
24913 this stall won't happen.
24915 @end table
24917 @node System V Options
24918 @subsection Options for System V
24920 These additional options are available on System V Release 4 for
24921 compatibility with other compilers on those systems:
24923 @table @gcctabopt
24924 @item -G
24925 @opindex G
24926 Create a shared object.
24927 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24929 @item -Qy
24930 @opindex Qy
24931 Identify the versions of each tool used by the compiler, in a
24932 @code{.ident} assembler directive in the output.
24934 @item -Qn
24935 @opindex Qn
24936 Refrain from adding @code{.ident} directives to the output file (this is
24937 the default).
24939 @item -YP,@var{dirs}
24940 @opindex YP
24941 Search the directories @var{dirs}, and no others, for libraries
24942 specified with @option{-l}.
24944 @item -Ym,@var{dir}
24945 @opindex Ym
24946 Look in the directory @var{dir} to find the M4 preprocessor.
24947 The assembler uses this option.
24948 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24949 @c the generic assembler that comes with Solaris takes just -Ym.
24950 @end table
24952 @node TILE-Gx Options
24953 @subsection TILE-Gx Options
24954 @cindex TILE-Gx options
24956 These @samp{-m} options are supported on the TILE-Gx:
24958 @table @gcctabopt
24959 @item -mcmodel=small
24960 @opindex mcmodel=small
24961 Generate code for the small model.  The distance for direct calls is
24962 limited to 500M in either direction.  PC-relative addresses are 32
24963 bits.  Absolute addresses support the full address range.
24965 @item -mcmodel=large
24966 @opindex mcmodel=large
24967 Generate code for the large model.  There is no limitation on call
24968 distance, pc-relative addresses, or absolute addresses.
24970 @item -mcpu=@var{name}
24971 @opindex mcpu
24972 Selects the type of CPU to be targeted.  Currently the only supported
24973 type is @samp{tilegx}.
24975 @item -m32
24976 @itemx -m64
24977 @opindex m32
24978 @opindex m64
24979 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24980 environment sets int, long, and pointer to 32 bits.  The 64-bit
24981 environment sets int to 32 bits and long and pointer to 64 bits.
24983 @item -mbig-endian
24984 @itemx -mlittle-endian
24985 @opindex mbig-endian
24986 @opindex mlittle-endian
24987 Generate code in big/little endian mode, respectively.
24988 @end table
24990 @node TILEPro Options
24991 @subsection TILEPro Options
24992 @cindex TILEPro options
24994 These @samp{-m} options are supported on the TILEPro:
24996 @table @gcctabopt
24997 @item -mcpu=@var{name}
24998 @opindex mcpu
24999 Selects the type of CPU to be targeted.  Currently the only supported
25000 type is @samp{tilepro}.
25002 @item -m32
25003 @opindex m32
25004 Generate code for a 32-bit environment, which sets int, long, and
25005 pointer to 32 bits.  This is the only supported behavior so the flag
25006 is essentially ignored.
25007 @end table
25009 @node V850 Options
25010 @subsection V850 Options
25011 @cindex V850 Options
25013 These @samp{-m} options are defined for V850 implementations:
25015 @table @gcctabopt
25016 @item -mlong-calls
25017 @itemx -mno-long-calls
25018 @opindex mlong-calls
25019 @opindex mno-long-calls
25020 Treat all calls as being far away (near).  If calls are assumed to be
25021 far away, the compiler always loads the function's address into a
25022 register, and calls indirect through the pointer.
25024 @item -mno-ep
25025 @itemx -mep
25026 @opindex mno-ep
25027 @opindex mep
25028 Do not optimize (do optimize) basic blocks that use the same index
25029 pointer 4 or more times to copy pointer into the @code{ep} register, and
25030 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
25031 option is on by default if you optimize.
25033 @item -mno-prolog-function
25034 @itemx -mprolog-function
25035 @opindex mno-prolog-function
25036 @opindex mprolog-function
25037 Do not use (do use) external functions to save and restore registers
25038 at the prologue and epilogue of a function.  The external functions
25039 are slower, but use less code space if more than one function saves
25040 the same number of registers.  The @option{-mprolog-function} option
25041 is on by default if you optimize.
25043 @item -mspace
25044 @opindex mspace
25045 Try to make the code as small as possible.  At present, this just turns
25046 on the @option{-mep} and @option{-mprolog-function} options.
25048 @item -mtda=@var{n}
25049 @opindex mtda
25050 Put static or global variables whose size is @var{n} bytes or less into
25051 the tiny data area that register @code{ep} points to.  The tiny data
25052 area can hold up to 256 bytes in total (128 bytes for byte references).
25054 @item -msda=@var{n}
25055 @opindex msda
25056 Put static or global variables whose size is @var{n} bytes or less into
25057 the small data area that register @code{gp} points to.  The small data
25058 area can hold up to 64 kilobytes.
25060 @item -mzda=@var{n}
25061 @opindex mzda
25062 Put static or global variables whose size is @var{n} bytes or less into
25063 the first 32 kilobytes of memory.
25065 @item -mv850
25066 @opindex mv850
25067 Specify that the target processor is the V850.
25069 @item -mv850e3v5
25070 @opindex mv850e3v5
25071 Specify that the target processor is the V850E3V5.  The preprocessor
25072 constant @code{__v850e3v5__} is defined if this option is used.
25074 @item -mv850e2v4
25075 @opindex mv850e2v4
25076 Specify that the target processor is the V850E3V5.  This is an alias for
25077 the @option{-mv850e3v5} option.
25079 @item -mv850e2v3
25080 @opindex mv850e2v3
25081 Specify that the target processor is the V850E2V3.  The preprocessor
25082 constant @code{__v850e2v3__} is defined if this option is used.
25084 @item -mv850e2
25085 @opindex mv850e2
25086 Specify that the target processor is the V850E2.  The preprocessor
25087 constant @code{__v850e2__} is defined if this option is used.
25089 @item -mv850e1
25090 @opindex mv850e1
25091 Specify that the target processor is the V850E1.  The preprocessor
25092 constants @code{__v850e1__} and @code{__v850e__} are defined if
25093 this option is used.
25095 @item -mv850es
25096 @opindex mv850es
25097 Specify that the target processor is the V850ES.  This is an alias for
25098 the @option{-mv850e1} option.
25100 @item -mv850e
25101 @opindex mv850e
25102 Specify that the target processor is the V850E@.  The preprocessor
25103 constant @code{__v850e__} is defined if this option is used.
25105 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
25106 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
25107 are defined then a default target processor is chosen and the
25108 relevant @samp{__v850*__} preprocessor constant is defined.
25110 The preprocessor constants @code{__v850} and @code{__v851__} are always
25111 defined, regardless of which processor variant is the target.
25113 @item -mdisable-callt
25114 @itemx -mno-disable-callt
25115 @opindex mdisable-callt
25116 @opindex mno-disable-callt
25117 This option suppresses generation of the @code{CALLT} instruction for the
25118 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
25119 architecture.
25121 This option is enabled by default when the RH850 ABI is
25122 in use (see @option{-mrh850-abi}), and disabled by default when the
25123 GCC ABI is in use.  If @code{CALLT} instructions are being generated
25124 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
25126 @item -mrelax
25127 @itemx -mno-relax
25128 @opindex mrelax
25129 @opindex mno-relax
25130 Pass on (or do not pass on) the @option{-mrelax} command-line option
25131 to the assembler.
25133 @item -mlong-jumps
25134 @itemx -mno-long-jumps
25135 @opindex mlong-jumps
25136 @opindex mno-long-jumps
25137 Disable (or re-enable) the generation of PC-relative jump instructions.
25139 @item -msoft-float
25140 @itemx -mhard-float
25141 @opindex msoft-float
25142 @opindex mhard-float
25143 Disable (or re-enable) the generation of hardware floating point
25144 instructions.  This option is only significant when the target
25145 architecture is @samp{V850E2V3} or higher.  If hardware floating point
25146 instructions are being generated then the C preprocessor symbol
25147 @code{__FPU_OK__} is defined, otherwise the symbol
25148 @code{__NO_FPU__} is defined.
25150 @item -mloop
25151 @opindex mloop
25152 Enables the use of the e3v5 LOOP instruction.  The use of this
25153 instruction is not enabled by default when the e3v5 architecture is
25154 selected because its use is still experimental.
25156 @item -mrh850-abi
25157 @itemx -mghs
25158 @opindex mrh850-abi
25159 @opindex mghs
25160 Enables support for the RH850 version of the V850 ABI.  This is the
25161 default.  With this version of the ABI the following rules apply:
25163 @itemize
25164 @item
25165 Integer sized structures and unions are returned via a memory pointer
25166 rather than a register.
25168 @item
25169 Large structures and unions (more than 8 bytes in size) are passed by
25170 value.
25172 @item
25173 Functions are aligned to 16-bit boundaries.
25175 @item
25176 The @option{-m8byte-align} command-line option is supported.
25178 @item
25179 The @option{-mdisable-callt} command-line option is enabled by
25180 default.  The @option{-mno-disable-callt} command-line option is not
25181 supported.
25182 @end itemize
25184 When this version of the ABI is enabled the C preprocessor symbol
25185 @code{__V850_RH850_ABI__} is defined.
25187 @item -mgcc-abi
25188 @opindex mgcc-abi
25189 Enables support for the old GCC version of the V850 ABI.  With this
25190 version of the ABI the following rules apply:
25192 @itemize
25193 @item
25194 Integer sized structures and unions are returned in register @code{r10}.
25196 @item
25197 Large structures and unions (more than 8 bytes in size) are passed by
25198 reference.
25200 @item
25201 Functions are aligned to 32-bit boundaries, unless optimizing for
25202 size.
25204 @item
25205 The @option{-m8byte-align} command-line option is not supported.
25207 @item
25208 The @option{-mdisable-callt} command-line option is supported but not
25209 enabled by default.
25210 @end itemize
25212 When this version of the ABI is enabled the C preprocessor symbol
25213 @code{__V850_GCC_ABI__} is defined.
25215 @item -m8byte-align
25216 @itemx -mno-8byte-align
25217 @opindex m8byte-align
25218 @opindex mno-8byte-align
25219 Enables support for @code{double} and @code{long long} types to be
25220 aligned on 8-byte boundaries.  The default is to restrict the
25221 alignment of all objects to at most 4-bytes.  When
25222 @option{-m8byte-align} is in effect the C preprocessor symbol
25223 @code{__V850_8BYTE_ALIGN__} is defined.
25225 @item -mbig-switch
25226 @opindex mbig-switch
25227 Generate code suitable for big switch tables.  Use this option only if
25228 the assembler/linker complain about out of range branches within a switch
25229 table.
25231 @item -mapp-regs
25232 @opindex mapp-regs
25233 This option causes r2 and r5 to be used in the code generated by
25234 the compiler.  This setting is the default.
25236 @item -mno-app-regs
25237 @opindex mno-app-regs
25238 This option causes r2 and r5 to be treated as fixed registers.
25240 @end table
25242 @node VAX Options
25243 @subsection VAX Options
25244 @cindex VAX options
25246 These @samp{-m} options are defined for the VAX:
25248 @table @gcctabopt
25249 @item -munix
25250 @opindex munix
25251 Do not output certain jump instructions (@code{aobleq} and so on)
25252 that the Unix assembler for the VAX cannot handle across long
25253 ranges.
25255 @item -mgnu
25256 @opindex mgnu
25257 Do output those jump instructions, on the assumption that the
25258 GNU assembler is being used.
25260 @item -mg
25261 @opindex mg
25262 Output code for G-format floating-point numbers instead of D-format.
25263 @end table
25265 @node Visium Options
25266 @subsection Visium Options
25267 @cindex Visium options
25269 @table @gcctabopt
25271 @item -mdebug
25272 @opindex mdebug
25273 A program which performs file I/O and is destined to run on an MCM target
25274 should be linked with this option.  It causes the libraries libc.a and
25275 libdebug.a to be linked.  The program should be run on the target under
25276 the control of the GDB remote debugging stub.
25278 @item -msim
25279 @opindex msim
25280 A program which performs file I/O and is destined to run on the simulator
25281 should be linked with option.  This causes libraries libc.a and libsim.a to
25282 be linked.
25284 @item -mfpu
25285 @itemx -mhard-float
25286 @opindex mfpu
25287 @opindex mhard-float
25288 Generate code containing floating-point instructions.  This is the
25289 default.
25291 @item -mno-fpu
25292 @itemx -msoft-float
25293 @opindex mno-fpu
25294 @opindex msoft-float
25295 Generate code containing library calls for floating-point.
25297 @option{-msoft-float} changes the calling convention in the output file;
25298 therefore, it is only useful if you compile @emph{all} of a program with
25299 this option.  In particular, you need to compile @file{libgcc.a}, the
25300 library that comes with GCC, with @option{-msoft-float} in order for
25301 this to work.
25303 @item -mcpu=@var{cpu_type}
25304 @opindex mcpu
25305 Set the instruction set, register set, and instruction scheduling parameters
25306 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
25307 @samp{mcm}, @samp{gr5} and @samp{gr6}.
25309 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
25311 By default (unless configured otherwise), GCC generates code for the GR5
25312 variant of the Visium architecture.  
25314 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
25315 architecture.  The only difference from GR5 code is that the compiler will
25316 generate block move instructions.
25318 @item -mtune=@var{cpu_type}
25319 @opindex mtune
25320 Set the instruction scheduling parameters for machine type @var{cpu_type},
25321 but do not set the instruction set or register set that the option
25322 @option{-mcpu=@var{cpu_type}} would.
25324 @item -msv-mode
25325 @opindex msv-mode
25326 Generate code for the supervisor mode, where there are no restrictions on
25327 the access to general registers.  This is the default.
25329 @item -muser-mode
25330 @opindex muser-mode
25331 Generate code for the user mode, where the access to some general registers
25332 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
25333 mode; on the GR6, only registers r29 to r31 are affected.
25334 @end table
25336 @node VMS Options
25337 @subsection VMS Options
25339 These @samp{-m} options are defined for the VMS implementations:
25341 @table @gcctabopt
25342 @item -mvms-return-codes
25343 @opindex mvms-return-codes
25344 Return VMS condition codes from @code{main}. The default is to return POSIX-style
25345 condition (e.g.@ error) codes.
25347 @item -mdebug-main=@var{prefix}
25348 @opindex mdebug-main=@var{prefix}
25349 Flag the first routine whose name starts with @var{prefix} as the main
25350 routine for the debugger.
25352 @item -mmalloc64
25353 @opindex mmalloc64
25354 Default to 64-bit memory allocation routines.
25356 @item -mpointer-size=@var{size}
25357 @opindex mpointer-size=@var{size}
25358 Set the default size of pointers. Possible options for @var{size} are
25359 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
25360 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
25361 The later option disables @code{pragma pointer_size}.
25362 @end table
25364 @node VxWorks Options
25365 @subsection VxWorks Options
25366 @cindex VxWorks Options
25368 The options in this section are defined for all VxWorks targets.
25369 Options specific to the target hardware are listed with the other
25370 options for that target.
25372 @table @gcctabopt
25373 @item -mrtp
25374 @opindex mrtp
25375 GCC can generate code for both VxWorks kernels and real time processes
25376 (RTPs).  This option switches from the former to the latter.  It also
25377 defines the preprocessor macro @code{__RTP__}.
25379 @item -non-static
25380 @opindex non-static
25381 Link an RTP executable against shared libraries rather than static
25382 libraries.  The options @option{-static} and @option{-shared} can
25383 also be used for RTPs (@pxref{Link Options}); @option{-static}
25384 is the default.
25386 @item -Bstatic
25387 @itemx -Bdynamic
25388 @opindex Bstatic
25389 @opindex Bdynamic
25390 These options are passed down to the linker.  They are defined for
25391 compatibility with Diab.
25393 @item -Xbind-lazy
25394 @opindex Xbind-lazy
25395 Enable lazy binding of function calls.  This option is equivalent to
25396 @option{-Wl,-z,now} and is defined for compatibility with Diab.
25398 @item -Xbind-now
25399 @opindex Xbind-now
25400 Disable lazy binding of function calls.  This option is the default and
25401 is defined for compatibility with Diab.
25402 @end table
25404 @node x86 Options
25405 @subsection x86 Options
25406 @cindex x86 Options
25408 These @samp{-m} options are defined for the x86 family of computers.
25410 @table @gcctabopt
25412 @item -march=@var{cpu-type}
25413 @opindex march
25414 Generate instructions for the machine type @var{cpu-type}.  In contrast to
25415 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
25416 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
25417 to generate code that may not run at all on processors other than the one
25418 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
25419 @option{-mtune=@var{cpu-type}}.
25421 The choices for @var{cpu-type} are:
25423 @table @samp
25424 @item native
25425 This selects the CPU to generate code for at compilation time by determining
25426 the processor type of the compiling machine.  Using @option{-march=native}
25427 enables all instruction subsets supported by the local machine (hence
25428 the result might not run on different machines).  Using @option{-mtune=native}
25429 produces code optimized for the local machine under the constraints
25430 of the selected instruction set.  
25432 @item i386
25433 Original Intel i386 CPU@.
25435 @item i486
25436 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
25438 @item i586
25439 @itemx pentium
25440 Intel Pentium CPU with no MMX support.
25442 @item lakemont
25443 Intel Lakemont MCU, based on Intel Pentium CPU.
25445 @item pentium-mmx
25446 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
25448 @item pentiumpro
25449 Intel Pentium Pro CPU@.
25451 @item i686
25452 When used with @option{-march}, the Pentium Pro
25453 instruction set is used, so the code runs on all i686 family chips.
25454 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
25456 @item pentium2
25457 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
25458 support.
25460 @item pentium3
25461 @itemx pentium3m
25462 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
25463 set support.
25465 @item pentium-m
25466 Intel Pentium M; low-power version of Intel Pentium III CPU
25467 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
25469 @item pentium4
25470 @itemx pentium4m
25471 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
25473 @item prescott
25474 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
25475 set support.
25477 @item nocona
25478 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
25479 SSE2 and SSE3 instruction set support.
25481 @item core2
25482 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
25483 instruction set support.
25485 @item nehalem
25486 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25487 SSE4.1, SSE4.2 and POPCNT instruction set support.
25489 @item westmere
25490 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25491 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
25493 @item sandybridge
25494 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25495 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
25497 @item ivybridge
25498 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25499 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
25500 instruction set support.
25502 @item haswell
25503 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25504 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25505 BMI, BMI2 and F16C instruction set support.
25507 @item broadwell
25508 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25509 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25510 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
25512 @item skylake
25513 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25514 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25515 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
25516 XSAVES instruction set support.
25518 @item bonnell
25519 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
25520 instruction set support.
25522 @item silvermont
25523 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25524 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
25526 @item knl
25527 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25528 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25529 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
25530 AVX512CD instruction set support.
25532 @item knm
25533 Intel Knights Mill CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25534 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25535 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25536 AVX5124VNNIW, AVX5124FMAPS and AVX512VPOPCNTDQ instruction set support.
25538 @item skylake-avx512
25539 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25540 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25541 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
25542 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
25544 @item cannonlake
25545 Intel Cannonlake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2,
25546 SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE,
25547 RDRND, FMA, BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC,
25548 XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD, AVX512VBMI,
25549 AVX512IFMA, SHA, CLWB and UMIP instruction set support.
25551 @item k6
25552 AMD K6 CPU with MMX instruction set support.
25554 @item k6-2
25555 @itemx k6-3
25556 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
25558 @item athlon
25559 @itemx athlon-tbird
25560 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
25561 support.
25563 @item athlon-4
25564 @itemx athlon-xp
25565 @itemx athlon-mp
25566 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
25567 instruction set support.
25569 @item k8
25570 @itemx opteron
25571 @itemx athlon64
25572 @itemx athlon-fx
25573 Processors based on the AMD K8 core with x86-64 instruction set support,
25574 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
25575 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
25576 instruction set extensions.)
25578 @item k8-sse3
25579 @itemx opteron-sse3
25580 @itemx athlon64-sse3
25581 Improved versions of AMD K8 cores with SSE3 instruction set support.
25583 @item amdfam10
25584 @itemx barcelona
25585 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
25586 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
25587 instruction set extensions.)
25589 @item bdver1
25590 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
25591 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
25592 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
25593 @item bdver2
25594 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25595 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
25596 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
25597 extensions.)
25598 @item bdver3
25599 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25600 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
25601 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
25602 64-bit instruction set extensions.
25603 @item bdver4
25604 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25605 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
25606 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
25607 SSE4.2, ABM and 64-bit instruction set extensions.
25609 @item znver1
25610 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
25611 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
25612 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
25613 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
25614 instruction set extensions.
25616 @item btver1
25617 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
25618 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
25619 instruction set extensions.)
25621 @item btver2
25622 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
25623 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
25624 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
25626 @item winchip-c6
25627 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
25628 set support.
25630 @item winchip2
25631 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
25632 instruction set support.
25634 @item c3
25635 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
25636 (No scheduling is implemented for this chip.)
25638 @item c3-2
25639 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
25640 (No scheduling is implemented for this chip.)
25642 @item c7
25643 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25644 (No scheduling is implemented for this chip.)
25646 @item samuel-2
25647 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
25648 (No scheduling is implemented for this chip.)
25650 @item nehemiah
25651 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
25652 (No scheduling is implemented for this chip.)
25654 @item esther
25655 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25656 (No scheduling is implemented for this chip.)
25658 @item eden-x2
25659 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25660 (No scheduling is implemented for this chip.)
25662 @item eden-x4
25663 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25664 AVX and AVX2 instruction set support.
25665 (No scheduling is implemented for this chip.)
25667 @item nano
25668 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25669 instruction set support.
25670 (No scheduling is implemented for this chip.)
25672 @item nano-1000
25673 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25674 instruction set support.
25675 (No scheduling is implemented for this chip.)
25677 @item nano-2000
25678 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25679 instruction set support.
25680 (No scheduling is implemented for this chip.)
25682 @item nano-3000
25683 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25684 instruction set support.
25685 (No scheduling is implemented for this chip.)
25687 @item nano-x2
25688 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25689 instruction set support.
25690 (No scheduling is implemented for this chip.)
25692 @item nano-x4
25693 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25694 instruction set support.
25695 (No scheduling is implemented for this chip.)
25697 @item geode
25698 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25699 @end table
25701 @item -mtune=@var{cpu-type}
25702 @opindex mtune
25703 Tune to @var{cpu-type} everything applicable about the generated code, except
25704 for the ABI and the set of available instructions.  
25705 While picking a specific @var{cpu-type} schedules things appropriately
25706 for that particular chip, the compiler does not generate any code that
25707 cannot run on the default machine type unless you use a
25708 @option{-march=@var{cpu-type}} option.
25709 For example, if GCC is configured for i686-pc-linux-gnu
25710 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25711 but still runs on i686 machines.
25713 The choices for @var{cpu-type} are the same as for @option{-march}.
25714 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25716 @table @samp
25717 @item generic
25718 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25719 If you know the CPU on which your code will run, then you should use
25720 the corresponding @option{-mtune} or @option{-march} option instead of
25721 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25722 of your application will have, then you should use this option.
25724 As new processors are deployed in the marketplace, the behavior of this
25725 option will change.  Therefore, if you upgrade to a newer version of
25726 GCC, code generation controlled by this option will change to reflect
25727 the processors
25728 that are most common at the time that version of GCC is released.
25730 There is no @option{-march=generic} option because @option{-march}
25731 indicates the instruction set the compiler can use, and there is no
25732 generic instruction set applicable to all processors.  In contrast,
25733 @option{-mtune} indicates the processor (or, in this case, collection of
25734 processors) for which the code is optimized.
25736 @item intel
25737 Produce code optimized for the most current Intel processors, which are
25738 Haswell and Silvermont for this version of GCC.  If you know the CPU
25739 on which your code will run, then you should use the corresponding
25740 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25741 But, if you want your application performs better on both Haswell and
25742 Silvermont, then you should use this option.
25744 As new Intel processors are deployed in the marketplace, the behavior of
25745 this option will change.  Therefore, if you upgrade to a newer version of
25746 GCC, code generation controlled by this option will change to reflect
25747 the most current Intel processors at the time that version of GCC is
25748 released.
25750 There is no @option{-march=intel} option because @option{-march} indicates
25751 the instruction set the compiler can use, and there is no common
25752 instruction set applicable to all processors.  In contrast,
25753 @option{-mtune} indicates the processor (or, in this case, collection of
25754 processors) for which the code is optimized.
25755 @end table
25757 @item -mcpu=@var{cpu-type}
25758 @opindex mcpu
25759 A deprecated synonym for @option{-mtune}.
25761 @item -mfpmath=@var{unit}
25762 @opindex mfpmath
25763 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25764 for @var{unit} are:
25766 @table @samp
25767 @item 387
25768 Use the standard 387 floating-point coprocessor present on the majority of chips and
25769 emulated otherwise.  Code compiled with this option runs almost everywhere.
25770 The temporary results are computed in 80-bit precision instead of the precision
25771 specified by the type, resulting in slightly different results compared to most
25772 of other chips.  See @option{-ffloat-store} for more detailed description.
25774 This is the default choice for non-Darwin x86-32 targets.
25776 @item sse
25777 Use scalar floating-point instructions present in the SSE instruction set.
25778 This instruction set is supported by Pentium III and newer chips,
25779 and in the AMD line
25780 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25781 instruction set supports only single-precision arithmetic, thus the double and
25782 extended-precision arithmetic are still done using 387.  A later version, present
25783 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25784 arithmetic too.
25786 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25787 or @option{-msse2} switches to enable SSE extensions and make this option
25788 effective.  For the x86-64 compiler, these extensions are enabled by default.
25790 The resulting code should be considerably faster in the majority of cases and avoid
25791 the numerical instability problems of 387 code, but may break some existing
25792 code that expects temporaries to be 80 bits.
25794 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25795 and the default choice for x86-32 targets with the SSE2 instruction set
25796 when @option{-ffast-math} is enabled.
25798 @item sse,387
25799 @itemx sse+387
25800 @itemx both
25801 Attempt to utilize both instruction sets at once.  This effectively doubles the
25802 amount of available registers, and on chips with separate execution units for
25803 387 and SSE the execution resources too.  Use this option with care, as it is
25804 still experimental, because the GCC register allocator does not model separate
25805 functional units well, resulting in unstable performance.
25806 @end table
25808 @item -masm=@var{dialect}
25809 @opindex masm=@var{dialect}
25810 Output assembly instructions using selected @var{dialect}.  Also affects
25811 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25812 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25813 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25814 not support @samp{intel}.
25816 @item -mieee-fp
25817 @itemx -mno-ieee-fp
25818 @opindex mieee-fp
25819 @opindex mno-ieee-fp
25820 Control whether or not the compiler uses IEEE floating-point
25821 comparisons.  These correctly handle the case where the result of a
25822 comparison is unordered.
25824 @item -m80387
25825 @item -mhard-float
25826 @opindex 80387
25827 @opindex mhard-float
25828 Generate output containing 80387 instructions for floating point.
25830 @item -mno-80387
25831 @item -msoft-float
25832 @opindex no-80387
25833 @opindex msoft-float
25834 Generate output containing library calls for floating point.
25836 @strong{Warning:} the requisite libraries are not part of GCC@.
25837 Normally the facilities of the machine's usual C compiler are used, but
25838 this cannot be done directly in cross-compilation.  You must make your
25839 own arrangements to provide suitable library functions for
25840 cross-compilation.
25842 On machines where a function returns floating-point results in the 80387
25843 register stack, some floating-point opcodes may be emitted even if
25844 @option{-msoft-float} is used.
25846 @item -mno-fp-ret-in-387
25847 @opindex mno-fp-ret-in-387
25848 Do not use the FPU registers for return values of functions.
25850 The usual calling convention has functions return values of types
25851 @code{float} and @code{double} in an FPU register, even if there
25852 is no FPU@.  The idea is that the operating system should emulate
25853 an FPU@.
25855 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25856 in ordinary CPU registers instead.
25858 @item -mno-fancy-math-387
25859 @opindex mno-fancy-math-387
25860 Some 387 emulators do not support the @code{sin}, @code{cos} and
25861 @code{sqrt} instructions for the 387.  Specify this option to avoid
25862 generating those instructions.  This option is the default on
25863 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25864 indicates that the target CPU always has an FPU and so the
25865 instruction does not need emulation.  These
25866 instructions are not generated unless you also use the
25867 @option{-funsafe-math-optimizations} switch.
25869 @item -malign-double
25870 @itemx -mno-align-double
25871 @opindex malign-double
25872 @opindex mno-align-double
25873 Control whether GCC aligns @code{double}, @code{long double}, and
25874 @code{long long} variables on a two-word boundary or a one-word
25875 boundary.  Aligning @code{double} variables on a two-word boundary
25876 produces code that runs somewhat faster on a Pentium at the
25877 expense of more memory.
25879 On x86-64, @option{-malign-double} is enabled by default.
25881 @strong{Warning:} if you use the @option{-malign-double} switch,
25882 structures containing the above types are aligned differently than
25883 the published application binary interface specifications for the x86-32
25884 and are not binary compatible with structures in code compiled
25885 without that switch.
25887 @item -m96bit-long-double
25888 @itemx -m128bit-long-double
25889 @opindex m96bit-long-double
25890 @opindex m128bit-long-double
25891 These switches control the size of @code{long double} type.  The x86-32
25892 application binary interface specifies the size to be 96 bits,
25893 so @option{-m96bit-long-double} is the default in 32-bit mode.
25895 Modern architectures (Pentium and newer) prefer @code{long double}
25896 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25897 conforming to the ABI, this is not possible.  So specifying
25898 @option{-m128bit-long-double} aligns @code{long double}
25899 to a 16-byte boundary by padding the @code{long double} with an additional
25900 32-bit zero.
25902 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25903 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25905 Notice that neither of these options enable any extra precision over the x87
25906 standard of 80 bits for a @code{long double}.
25908 @strong{Warning:} if you override the default value for your target ABI, this
25909 changes the size of 
25910 structures and arrays containing @code{long double} variables,
25911 as well as modifying the function calling convention for functions taking
25912 @code{long double}.  Hence they are not binary-compatible
25913 with code compiled without that switch.
25915 @item -mlong-double-64
25916 @itemx -mlong-double-80
25917 @itemx -mlong-double-128
25918 @opindex mlong-double-64
25919 @opindex mlong-double-80
25920 @opindex mlong-double-128
25921 These switches control the size of @code{long double} type. A size
25922 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25923 type. This is the default for 32-bit Bionic C library.  A size
25924 of 128 bits makes the @code{long double} type equivalent to the
25925 @code{__float128} type. This is the default for 64-bit Bionic C library.
25927 @strong{Warning:} if you override the default value for your target ABI, this
25928 changes the size of
25929 structures and arrays containing @code{long double} variables,
25930 as well as modifying the function calling convention for functions taking
25931 @code{long double}.  Hence they are not binary-compatible
25932 with code compiled without that switch.
25934 @item -malign-data=@var{type}
25935 @opindex malign-data
25936 Control how GCC aligns variables.  Supported values for @var{type} are
25937 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25938 and earlier, @samp{abi} uses alignment value as specified by the
25939 psABI, and @samp{cacheline} uses increased alignment value to match
25940 the cache line size.  @samp{compat} is the default.
25942 @item -mlarge-data-threshold=@var{threshold}
25943 @opindex mlarge-data-threshold
25944 When @option{-mcmodel=medium} is specified, data objects larger than
25945 @var{threshold} are placed in the large data section.  This value must be the
25946 same across all objects linked into the binary, and defaults to 65535.
25948 @item -mrtd
25949 @opindex mrtd
25950 Use a different function-calling convention, in which functions that
25951 take a fixed number of arguments return with the @code{ret @var{num}}
25952 instruction, which pops their arguments while returning.  This saves one
25953 instruction in the caller since there is no need to pop the arguments
25954 there.
25956 You can specify that an individual function is called with this calling
25957 sequence with the function attribute @code{stdcall}.  You can also
25958 override the @option{-mrtd} option by using the function attribute
25959 @code{cdecl}.  @xref{Function Attributes}.
25961 @strong{Warning:} this calling convention is incompatible with the one
25962 normally used on Unix, so you cannot use it if you need to call
25963 libraries compiled with the Unix compiler.
25965 Also, you must provide function prototypes for all functions that
25966 take variable numbers of arguments (including @code{printf});
25967 otherwise incorrect code is generated for calls to those
25968 functions.
25970 In addition, seriously incorrect code results if you call a
25971 function with too many arguments.  (Normally, extra arguments are
25972 harmlessly ignored.)
25974 @item -mregparm=@var{num}
25975 @opindex mregparm
25976 Control how many registers are used to pass integer arguments.  By
25977 default, no registers are used to pass arguments, and at most 3
25978 registers can be used.  You can control this behavior for a specific
25979 function by using the function attribute @code{regparm}.
25980 @xref{Function Attributes}.
25982 @strong{Warning:} if you use this switch, and
25983 @var{num} is nonzero, then you must build all modules with the same
25984 value, including any libraries.  This includes the system libraries and
25985 startup modules.
25987 @item -msseregparm
25988 @opindex msseregparm
25989 Use SSE register passing conventions for float and double arguments
25990 and return values.  You can control this behavior for a specific
25991 function by using the function attribute @code{sseregparm}.
25992 @xref{Function Attributes}.
25994 @strong{Warning:} if you use this switch then you must build all
25995 modules with the same value, including any libraries.  This includes
25996 the system libraries and startup modules.
25998 @item -mvect8-ret-in-mem
25999 @opindex mvect8-ret-in-mem
26000 Return 8-byte vectors in memory instead of MMX registers.  This is the
26001 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
26002 Studio compilers until version 12.  Later compiler versions (starting
26003 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
26004 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
26005 you need to remain compatible with existing code produced by those
26006 previous compiler versions or older versions of GCC@.
26008 @item -mpc32
26009 @itemx -mpc64
26010 @itemx -mpc80
26011 @opindex mpc32
26012 @opindex mpc64
26013 @opindex mpc80
26015 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
26016 is specified, the significands of results of floating-point operations are
26017 rounded to 24 bits (single precision); @option{-mpc64} rounds the
26018 significands of results of floating-point operations to 53 bits (double
26019 precision) and @option{-mpc80} rounds the significands of results of
26020 floating-point operations to 64 bits (extended double precision), which is
26021 the default.  When this option is used, floating-point operations in higher
26022 precisions are not available to the programmer without setting the FPU
26023 control word explicitly.
26025 Setting the rounding of floating-point operations to less than the default
26026 80 bits can speed some programs by 2% or more.  Note that some mathematical
26027 libraries assume that extended-precision (80-bit) floating-point operations
26028 are enabled by default; routines in such libraries could suffer significant
26029 loss of accuracy, typically through so-called ``catastrophic cancellation'',
26030 when this option is used to set the precision to less than extended precision.
26032 @item -mstackrealign
26033 @opindex mstackrealign
26034 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
26035 option generates an alternate prologue and epilogue that realigns the
26036 run-time stack if necessary.  This supports mixing legacy codes that keep
26037 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
26038 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
26039 applicable to individual functions.
26041 @item -mpreferred-stack-boundary=@var{num}
26042 @opindex mpreferred-stack-boundary
26043 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
26044 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
26045 the default is 4 (16 bytes or 128 bits).
26047 @strong{Warning:} When generating code for the x86-64 architecture with
26048 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
26049 used to keep the stack boundary aligned to 8 byte boundary.  Since
26050 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
26051 intended to be used in controlled environment where stack space is
26052 important limitation.  This option leads to wrong code when functions
26053 compiled with 16 byte stack alignment (such as functions from a standard
26054 library) are called with misaligned stack.  In this case, SSE
26055 instructions may lead to misaligned memory access traps.  In addition,
26056 variable arguments are handled incorrectly for 16 byte aligned
26057 objects (including x87 long double and __int128), leading to wrong
26058 results.  You must build all modules with
26059 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
26060 includes the system libraries and startup modules.
26062 @item -mincoming-stack-boundary=@var{num}
26063 @opindex mincoming-stack-boundary
26064 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
26065 boundary.  If @option{-mincoming-stack-boundary} is not specified,
26066 the one specified by @option{-mpreferred-stack-boundary} is used.
26068 On Pentium and Pentium Pro, @code{double} and @code{long double} values
26069 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
26070 suffer significant run time performance penalties.  On Pentium III, the
26071 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
26072 properly if it is not 16-byte aligned.
26074 To ensure proper alignment of this values on the stack, the stack boundary
26075 must be as aligned as that required by any value stored on the stack.
26076 Further, every function must be generated such that it keeps the stack
26077 aligned.  Thus calling a function compiled with a higher preferred
26078 stack boundary from a function compiled with a lower preferred stack
26079 boundary most likely misaligns the stack.  It is recommended that
26080 libraries that use callbacks always use the default setting.
26082 This extra alignment does consume extra stack space, and generally
26083 increases code size.  Code that is sensitive to stack space usage, such
26084 as embedded systems and operating system kernels, may want to reduce the
26085 preferred alignment to @option{-mpreferred-stack-boundary=2}.
26087 @need 200
26088 @item -mmmx
26089 @opindex mmmx
26090 @need 200
26091 @itemx -msse
26092 @opindex msse
26093 @need 200
26094 @itemx -msse2
26095 @opindex msse2
26096 @need 200
26097 @itemx -msse3
26098 @opindex msse3
26099 @need 200
26100 @itemx -mssse3
26101 @opindex mssse3
26102 @need 200
26103 @itemx -msse4
26104 @opindex msse4
26105 @need 200
26106 @itemx -msse4a
26107 @opindex msse4a
26108 @need 200
26109 @itemx -msse4.1
26110 @opindex msse4.1
26111 @need 200
26112 @itemx -msse4.2
26113 @opindex msse4.2
26114 @need 200
26115 @itemx -mavx
26116 @opindex mavx
26117 @need 200
26118 @itemx -mavx2
26119 @opindex mavx2
26120 @need 200
26121 @itemx -mavx512f
26122 @opindex mavx512f
26123 @need 200
26124 @itemx -mavx512pf
26125 @opindex mavx512pf
26126 @need 200
26127 @itemx -mavx512er
26128 @opindex mavx512er
26129 @need 200
26130 @itemx -mavx512cd
26131 @opindex mavx512cd
26132 @need 200
26133 @itemx -mavx512vl
26134 @opindex mavx512vl
26135 @need 200
26136 @itemx -mavx512bw
26137 @opindex mavx512bw
26138 @need 200
26139 @itemx -mavx512dq
26140 @opindex mavx512dq
26141 @need 200
26142 @itemx -mavx512ifma
26143 @opindex mavx512ifma
26144 @need 200
26145 @itemx -mavx512vbmi
26146 @opindex mavx512vbmi
26147 @need 200
26148 @itemx -msha
26149 @opindex msha
26150 @need 200
26151 @itemx -maes
26152 @opindex maes
26153 @need 200
26154 @itemx -mpclmul
26155 @opindex mpclmul
26156 @need 200
26157 @itemx -mclfushopt
26158 @opindex mclfushopt
26159 @need 200
26160 @itemx -mfsgsbase
26161 @opindex mfsgsbase
26162 @need 200
26163 @itemx -mrdrnd
26164 @opindex mrdrnd
26165 @need 200
26166 @itemx -mf16c
26167 @opindex mf16c
26168 @need 200
26169 @itemx -mfma
26170 @opindex mfma
26171 @need 200
26172 @itemx -mfma4
26173 @opindex mfma4
26174 @need 200
26175 @itemx -mprefetchwt1
26176 @opindex mprefetchwt1
26177 @need 200
26178 @itemx -mxop
26179 @opindex mxop
26180 @need 200
26181 @itemx -mlwp
26182 @opindex mlwp
26183 @need 200
26184 @itemx -m3dnow
26185 @opindex m3dnow
26186 @need 200
26187 @itemx -m3dnowa
26188 @opindex m3dnowa
26189 @need 200
26190 @itemx -mpopcnt
26191 @opindex mpopcnt
26192 @need 200
26193 @itemx -mabm
26194 @opindex mabm
26195 @need 200
26196 @itemx -mbmi
26197 @opindex mbmi
26198 @need 200
26199 @itemx -mbmi2
26200 @need 200
26201 @itemx -mlzcnt
26202 @opindex mlzcnt
26203 @need 200
26204 @itemx -mfxsr
26205 @opindex mfxsr
26206 @need 200
26207 @itemx -mxsave
26208 @opindex mxsave
26209 @need 200
26210 @itemx -mxsaveopt
26211 @opindex mxsaveopt
26212 @need 200
26213 @itemx -mxsavec
26214 @opindex mxsavec
26215 @need 200
26216 @itemx -mxsaves
26217 @opindex mxsaves
26218 @need 200
26219 @itemx -mrtm
26220 @opindex mrtm
26221 @need 200
26222 @itemx -mtbm
26223 @opindex mtbm
26224 @need 200
26225 @itemx -mmpx
26226 @opindex mmpx
26227 @need 200
26228 @itemx -mmwaitx
26229 @opindex mmwaitx
26230 @need 200
26231 @itemx -mclzero
26232 @opindex mclzero
26233 @need 200
26234 @itemx -mpku
26235 @opindex mpku
26236 @need 200
26237 @itemx -mcet
26238 @opindex mcet
26239 @need 200
26240 @itemx -mavx512vbmi2
26241 @opindex mavx512vbmi2
26242 @need 200
26243 @itemx -mgfni
26244 @opindex mgfni
26245 @need 200
26246 @itemx -mvaes
26247 @opindex mvaes
26248 @need 200
26249 @itemx -mvpclmulqdq
26250 @opindex mvpclmulqdq
26251 @need 200
26252 @itemx -mavx512bitalg
26253 @opindex mavx512bitalg
26254 @need 200
26255 @itemx -mavx512vpopcntdq
26256 @opindex mavx512vpopcntdq
26257 These switches enable the use of instructions in the MMX, SSE,
26258 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
26259 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
26260 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA, AVX512VBMI, BMI, BMI2, VAES,
26261 FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, IBT, SHSTK, AVX512VBMI2,
26262 GFNI, VPCLMULQDQ, AVX512BITALG, AVX512VPOPCNTDQ3DNow!@: or enhanced 3DNow!@:
26263 extended instruction sets.
26264 Each has a corresponding @option{-mno-} option to disable use of these
26265 instructions.
26267 These extensions are also available as built-in functions: see
26268 @ref{x86 Built-in Functions}, for details of the functions enabled and
26269 disabled by these switches.
26271 To generate SSE/SSE2 instructions automatically from floating-point
26272 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
26274 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
26275 generates new AVX instructions or AVX equivalence for all SSEx instructions
26276 when needed.
26278 These options enable GCC to use these extended instructions in
26279 generated code, even without @option{-mfpmath=sse}.  Applications that
26280 perform run-time CPU detection must compile separate files for each
26281 supported architecture, using the appropriate flags.  In particular,
26282 the file containing the CPU detection code should be compiled without
26283 these options.
26285 The @option{-mcet} option turns on the @option{-mibt} and @option{-mshstk}
26286 options.  The @option{-mibt} option enables indirect branch tracking support
26287 and the @option{-mshstk} option enables shadow stack support from
26288 Intel Control-flow Enforcement Technology (CET).  The compiler also provides
26289 a number of built-in functions for fine-grained control in a CET-based
26290 application.  See @xref{x86 Built-in Functions}, for more information.
26292 @item -mdump-tune-features
26293 @opindex mdump-tune-features
26294 This option instructs GCC to dump the names of the x86 performance 
26295 tuning features and default settings. The names can be used in 
26296 @option{-mtune-ctrl=@var{feature-list}}.
26298 @item -mtune-ctrl=@var{feature-list}
26299 @opindex mtune-ctrl=@var{feature-list}
26300 This option is used to do fine grain control of x86 code generation features.
26301 @var{feature-list} is a comma separated list of @var{feature} names. See also
26302 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
26303 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
26304 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
26305 developers. Using it may lead to code paths not covered by testing and can
26306 potentially result in compiler ICEs or runtime errors.
26308 @item -mno-default
26309 @opindex mno-default
26310 This option instructs GCC to turn off all tunable features. See also 
26311 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
26313 @item -mcld
26314 @opindex mcld
26315 This option instructs GCC to emit a @code{cld} instruction in the prologue
26316 of functions that use string instructions.  String instructions depend on
26317 the DF flag to select between autoincrement or autodecrement mode.  While the
26318 ABI specifies the DF flag to be cleared on function entry, some operating
26319 systems violate this specification by not clearing the DF flag in their
26320 exception dispatchers.  The exception handler can be invoked with the DF flag
26321 set, which leads to wrong direction mode when string instructions are used.
26322 This option can be enabled by default on 32-bit x86 targets by configuring
26323 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
26324 instructions can be suppressed with the @option{-mno-cld} compiler option
26325 in this case.
26327 @item -mvzeroupper
26328 @opindex mvzeroupper
26329 This option instructs GCC to emit a @code{vzeroupper} instruction
26330 before a transfer of control flow out of the function to minimize
26331 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
26332 intrinsics.
26334 @item -mprefer-avx128
26335 @opindex mprefer-avx128
26336 This option instructs GCC to use 128-bit AVX instructions instead of
26337 256-bit AVX instructions in the auto-vectorizer.
26339 @item -mprefer-vector-width=@var{opt}
26340 @opindex mprefer-vector-width
26341 This option instructs GCC to use @var{opt}-bit vector width in instructions
26342 instead of default on the selected platform.
26344 @table @samp
26345 @item none
26346 No extra limitations applied to GCC other than defined by the selected platform.
26348 @item 128
26349 Prefer 128-bit vector width for instructions.
26351 @item 256
26352 Prefer 256-bit vector width for instructions.
26354 @item 512
26355 Prefer 512-bit vector width for instructions.
26356 @end table
26358 @item -mcx16
26359 @opindex mcx16
26360 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
26361 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
26362 objects.  This is useful for atomic updates of data structures exceeding one
26363 machine word in size.  The compiler uses this instruction to implement
26364 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
26365 128-bit integers, a library call is always used.
26367 @item -msahf
26368 @opindex msahf
26369 This option enables generation of @code{SAHF} instructions in 64-bit code.
26370 Early Intel Pentium 4 CPUs with Intel 64 support,
26371 prior to the introduction of Pentium 4 G1 step in December 2005,
26372 lacked the @code{LAHF} and @code{SAHF} instructions
26373 which are supported by AMD64.
26374 These are load and store instructions, respectively, for certain status flags.
26375 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
26376 @code{drem}, and @code{remainder} built-in functions;
26377 see @ref{Other Builtins} for details.
26379 @item -mmovbe
26380 @opindex mmovbe
26381 This option enables use of the @code{movbe} instruction to implement
26382 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
26384 @item -mibt
26385 @opindex mibt
26386 This option tells the compiler to use indirect branch tracking support
26387 (for indirect calls and jumps) from x86 Control-flow Enforcement
26388 Technology (CET).  The option has effect only if the
26389 @option{-fcf-protection=full} or @option{-fcf-protection=branch} option
26390 is specified. The option @option{-mibt} is on by default when the
26391 @code{-mcet} option is specified.
26393 @item -mshstk
26394 @opindex mshstk
26395 This option tells the compiler to use shadow stack support (return
26396 address tracking) from x86 Control-flow Enforcement Technology (CET).
26397 The option has effect only if the @option{-fcf-protection=full} or
26398 @option{-fcf-protection=return} option is specified.  The option
26399 @option{-mshstk} is on by default when the @option{-mcet} option is
26400 specified.
26402 @item -mcrc32
26403 @opindex mcrc32
26404 This option enables built-in functions @code{__builtin_ia32_crc32qi},
26405 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
26406 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
26408 @item -mrecip
26409 @opindex mrecip
26410 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
26411 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
26412 with an additional Newton-Raphson step
26413 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
26414 (and their vectorized
26415 variants) for single-precision floating-point arguments.  These instructions
26416 are generated only when @option{-funsafe-math-optimizations} is enabled
26417 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
26418 Note that while the throughput of the sequence is higher than the throughput
26419 of the non-reciprocal instruction, the precision of the sequence can be
26420 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
26422 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
26423 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
26424 combination), and doesn't need @option{-mrecip}.
26426 Also note that GCC emits the above sequence with additional Newton-Raphson step
26427 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
26428 already with @option{-ffast-math} (or the above option combination), and
26429 doesn't need @option{-mrecip}.
26431 @item -mrecip=@var{opt}
26432 @opindex mrecip=opt
26433 This option controls which reciprocal estimate instructions
26434 may be used.  @var{opt} is a comma-separated list of options, which may
26435 be preceded by a @samp{!} to invert the option:
26437 @table @samp
26438 @item all
26439 Enable all estimate instructions.
26441 @item default
26442 Enable the default instructions, equivalent to @option{-mrecip}.
26444 @item none
26445 Disable all estimate instructions, equivalent to @option{-mno-recip}.
26447 @item div
26448 Enable the approximation for scalar division.
26450 @item vec-div
26451 Enable the approximation for vectorized division.
26453 @item sqrt
26454 Enable the approximation for scalar square root.
26456 @item vec-sqrt
26457 Enable the approximation for vectorized square root.
26458 @end table
26460 So, for example, @option{-mrecip=all,!sqrt} enables
26461 all of the reciprocal approximations, except for square root.
26463 @item -mveclibabi=@var{type}
26464 @opindex mveclibabi
26465 Specifies the ABI type to use for vectorizing intrinsics using an
26466 external library.  Supported values for @var{type} are @samp{svml} 
26467 for the Intel short
26468 vector math library and @samp{acml} for the AMD math core library.
26469 To use this option, both @option{-ftree-vectorize} and
26470 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
26471 ABI-compatible library must be specified at link time.
26473 GCC currently emits calls to @code{vmldExp2},
26474 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
26475 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
26476 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
26477 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
26478 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
26479 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
26480 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
26481 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
26482 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
26483 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
26484 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
26485 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
26486 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
26487 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
26488 when @option{-mveclibabi=acml} is used.  
26490 @item -mabi=@var{name}
26491 @opindex mabi
26492 Generate code for the specified calling convention.  Permissible values
26493 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
26494 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
26495 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
26496 You can control this behavior for specific functions by
26497 using the function attributes @code{ms_abi} and @code{sysv_abi}.
26498 @xref{Function Attributes}.
26500 @item -mforce-indirect-call
26501 @opindex mforce-indirect-call
26502 Force all calls to functions to be indirect. This is useful
26503 when using Intel Processor Trace where it generates more precise timing
26504 information for function calls.
26506 @item -mcall-ms2sysv-xlogues
26507 @opindex mcall-ms2sysv-xlogues
26508 @opindex mno-call-ms2sysv-xlogues
26509 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
26510 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
26511 default, the code for saving and restoring these registers is emitted inline,
26512 resulting in fairly lengthy prologues and epilogues.  Using
26513 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
26514 use stubs in the static portion of libgcc to perform these saves and restores,
26515 thus reducing function size at the cost of a few extra instructions.
26517 @item -mtls-dialect=@var{type}
26518 @opindex mtls-dialect
26519 Generate code to access thread-local storage using the @samp{gnu} or
26520 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
26521 @samp{gnu2} is more efficient, but it may add compile- and run-time
26522 requirements that cannot be satisfied on all systems.
26524 @item -mpush-args
26525 @itemx -mno-push-args
26526 @opindex mpush-args
26527 @opindex mno-push-args
26528 Use PUSH operations to store outgoing parameters.  This method is shorter
26529 and usually equally fast as method using SUB/MOV operations and is enabled
26530 by default.  In some cases disabling it may improve performance because of
26531 improved scheduling and reduced dependencies.
26533 @item -maccumulate-outgoing-args
26534 @opindex maccumulate-outgoing-args
26535 If enabled, the maximum amount of space required for outgoing arguments is
26536 computed in the function prologue.  This is faster on most modern CPUs
26537 because of reduced dependencies, improved scheduling and reduced stack usage
26538 when the preferred stack boundary is not equal to 2.  The drawback is a notable
26539 increase in code size.  This switch implies @option{-mno-push-args}.
26541 @item -mthreads
26542 @opindex mthreads
26543 Support thread-safe exception handling on MinGW.  Programs that rely
26544 on thread-safe exception handling must compile and link all code with the
26545 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
26546 @option{-D_MT}; when linking, it links in a special thread helper library
26547 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
26549 @item -mms-bitfields
26550 @itemx -mno-ms-bitfields
26551 @opindex mms-bitfields
26552 @opindex mno-ms-bitfields
26554 Enable/disable bit-field layout compatible with the native Microsoft
26555 Windows compiler.  
26557 If @code{packed} is used on a structure, or if bit-fields are used,
26558 it may be that the Microsoft ABI lays out the structure differently
26559 than the way GCC normally does.  Particularly when moving packed
26560 data between functions compiled with GCC and the native Microsoft compiler
26561 (either via function call or as data in a file), it may be necessary to access
26562 either format.
26564 This option is enabled by default for Microsoft Windows
26565 targets.  This behavior can also be controlled locally by use of variable
26566 or type attributes.  For more information, see @ref{x86 Variable Attributes}
26567 and @ref{x86 Type Attributes}.
26569 The Microsoft structure layout algorithm is fairly simple with the exception
26570 of the bit-field packing.  
26571 The padding and alignment of members of structures and whether a bit-field 
26572 can straddle a storage-unit boundary are determine by these rules:
26574 @enumerate
26575 @item Structure members are stored sequentially in the order in which they are
26576 declared: the first member has the lowest memory address and the last member
26577 the highest.
26579 @item Every data object has an alignment requirement.  The alignment requirement
26580 for all data except structures, unions, and arrays is either the size of the
26581 object or the current packing size (specified with either the
26582 @code{aligned} attribute or the @code{pack} pragma),
26583 whichever is less.  For structures, unions, and arrays,
26584 the alignment requirement is the largest alignment requirement of its members.
26585 Every object is allocated an offset so that:
26587 @smallexample
26588 offset % alignment_requirement == 0
26589 @end smallexample
26591 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
26592 unit if the integral types are the same size and if the next bit-field fits
26593 into the current allocation unit without crossing the boundary imposed by the
26594 common alignment requirements of the bit-fields.
26595 @end enumerate
26597 MSVC interprets zero-length bit-fields in the following ways:
26599 @enumerate
26600 @item If a zero-length bit-field is inserted between two bit-fields that
26601 are normally coalesced, the bit-fields are not coalesced.
26603 For example:
26605 @smallexample
26606 struct
26607  @{
26608    unsigned long bf_1 : 12;
26609    unsigned long : 0;
26610    unsigned long bf_2 : 12;
26611  @} t1;
26612 @end smallexample
26614 @noindent
26615 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
26616 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
26618 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
26619 alignment of the zero-length bit-field is greater than the member that follows it,
26620 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
26622 For example:
26624 @smallexample
26625 struct
26626  @{
26627    char foo : 4;
26628    short : 0;
26629    char bar;
26630  @} t2;
26632 struct
26633  @{
26634    char foo : 4;
26635    short : 0;
26636    double bar;
26637  @} t3;
26638 @end smallexample
26640 @noindent
26641 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
26642 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
26643 bit-field does not affect the alignment of @code{bar} or, as a result, the size
26644 of the structure.
26646 Taking this into account, it is important to note the following:
26648 @enumerate
26649 @item If a zero-length bit-field follows a normal bit-field, the type of the
26650 zero-length bit-field may affect the alignment of the structure as whole. For
26651 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
26652 normal bit-field, and is of type short.
26654 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
26655 still affect the alignment of the structure:
26657 @smallexample
26658 struct
26659  @{
26660    char foo : 6;
26661    long : 0;
26662  @} t4;
26663 @end smallexample
26665 @noindent
26666 Here, @code{t4} takes up 4 bytes.
26667 @end enumerate
26669 @item Zero-length bit-fields following non-bit-field members are ignored:
26671 @smallexample
26672 struct
26673  @{
26674    char foo;
26675    long : 0;
26676    char bar;
26677  @} t5;
26678 @end smallexample
26680 @noindent
26681 Here, @code{t5} takes up 2 bytes.
26682 @end enumerate
26685 @item -mno-align-stringops
26686 @opindex mno-align-stringops
26687 Do not align the destination of inlined string operations.  This switch reduces
26688 code size and improves performance in case the destination is already aligned,
26689 but GCC doesn't know about it.
26691 @item -minline-all-stringops
26692 @opindex minline-all-stringops
26693 By default GCC inlines string operations only when the destination is 
26694 known to be aligned to least a 4-byte boundary.  
26695 This enables more inlining and increases code
26696 size, but may improve performance of code that depends on fast
26697 @code{memcpy}, @code{strlen},
26698 and @code{memset} for short lengths.
26700 @item -minline-stringops-dynamically
26701 @opindex minline-stringops-dynamically
26702 For string operations of unknown size, use run-time checks with
26703 inline code for small blocks and a library call for large blocks.
26705 @item -mstringop-strategy=@var{alg}
26706 @opindex mstringop-strategy=@var{alg}
26707 Override the internal decision heuristic for the particular algorithm to use
26708 for inlining string operations.  The allowed values for @var{alg} are:
26710 @table @samp
26711 @item rep_byte
26712 @itemx rep_4byte
26713 @itemx rep_8byte
26714 Expand using i386 @code{rep} prefix of the specified size.
26716 @item byte_loop
26717 @itemx loop
26718 @itemx unrolled_loop
26719 Expand into an inline loop.
26721 @item libcall
26722 Always use a library call.
26723 @end table
26725 @item -mmemcpy-strategy=@var{strategy}
26726 @opindex mmemcpy-strategy=@var{strategy}
26727 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26728 should be inlined and what inline algorithm to use when the expected size
26729 of the copy operation is known. @var{strategy} 
26730 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26731 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26732 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26733 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26734 in the list must be specified in increasing order.  The minimal byte size for 
26735 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26736 preceding range.
26738 @item -mmemset-strategy=@var{strategy}
26739 @opindex mmemset-strategy=@var{strategy}
26740 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26741 @code{__builtin_memset} expansion.
26743 @item -momit-leaf-frame-pointer
26744 @opindex momit-leaf-frame-pointer
26745 Don't keep the frame pointer in a register for leaf functions.  This
26746 avoids the instructions to save, set up, and restore frame pointers and
26747 makes an extra register available in leaf functions.  The option
26748 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26749 which might make debugging harder.
26751 @item -mtls-direct-seg-refs
26752 @itemx -mno-tls-direct-seg-refs
26753 @opindex mtls-direct-seg-refs
26754 Controls whether TLS variables may be accessed with offsets from the
26755 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26756 or whether the thread base pointer must be added.  Whether or not this
26757 is valid depends on the operating system, and whether it maps the
26758 segment to cover the entire TLS area.
26760 For systems that use the GNU C Library, the default is on.
26762 @item -msse2avx
26763 @itemx -mno-sse2avx
26764 @opindex msse2avx
26765 Specify that the assembler should encode SSE instructions with VEX
26766 prefix.  The option @option{-mavx} turns this on by default.
26768 @item -mfentry
26769 @itemx -mno-fentry
26770 @opindex mfentry
26771 If profiling is active (@option{-pg}), put the profiling
26772 counter call before the prologue.
26773 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26774 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26776 @item -mrecord-mcount
26777 @itemx -mno-record-mcount
26778 @opindex mrecord-mcount
26779 If profiling is active (@option{-pg}), generate a __mcount_loc section
26780 that contains pointers to each profiling call. This is useful for
26781 automatically patching and out calls.
26783 @item -mnop-mcount
26784 @itemx -mno-nop-mcount
26785 @opindex mnop-mcount
26786 If profiling is active (@option{-pg}), generate the calls to
26787 the profiling functions as NOPs. This is useful when they
26788 should be patched in later dynamically. This is likely only
26789 useful together with @option{-mrecord-mcount}.
26791 @item -mskip-rax-setup
26792 @itemx -mno-skip-rax-setup
26793 @opindex mskip-rax-setup
26794 When generating code for the x86-64 architecture with SSE extensions
26795 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26796 register when there are no variable arguments passed in vector registers.
26798 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26799 saving vector registers on stack when passing variable arguments, the
26800 impacts of this option are callees may waste some stack space,
26801 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26802 those issues, regardless the RAX register value.
26804 @item -m8bit-idiv
26805 @itemx -mno-8bit-idiv
26806 @opindex m8bit-idiv
26807 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26808 much faster than 32-bit/64-bit integer divide.  This option generates a
26809 run-time check.  If both dividend and divisor are within range of 0
26810 to 255, 8-bit unsigned integer divide is used instead of
26811 32-bit/64-bit integer divide.
26813 @item -mavx256-split-unaligned-load
26814 @itemx -mavx256-split-unaligned-store
26815 @opindex mavx256-split-unaligned-load
26816 @opindex mavx256-split-unaligned-store
26817 Split 32-byte AVX unaligned load and store.
26819 @item -mstack-protector-guard=@var{guard}
26820 @itemx -mstack-protector-guard-reg=@var{reg}
26821 @itemx -mstack-protector-guard-offset=@var{offset}
26822 @opindex mstack-protector-guard
26823 @opindex mstack-protector-guard-reg
26824 @opindex mstack-protector-guard-offset
26825 Generate stack protection code using canary at @var{guard}.  Supported
26826 locations are @samp{global} for global canary or @samp{tls} for per-thread
26827 canary in the TLS block (the default).  This option has effect only when
26828 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26830 With the latter choice the options
26831 @option{-mstack-protector-guard-reg=@var{reg}} and
26832 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
26833 which segment register (@code{%fs} or @code{%gs}) to use as base register
26834 for reading the canary, and from what offset from that base register.
26835 The default for those is as specified in the relevant ABI.
26837 @item -mmitigate-rop
26838 @opindex mmitigate-rop
26839 Try to avoid generating code sequences that contain unintended return
26840 opcodes, to mitigate against certain forms of attack. At the moment,
26841 this option is limited in what it can do and should not be relied
26842 on to provide serious protection.
26844 @item -mgeneral-regs-only
26845 @opindex mgeneral-regs-only
26846 Generate code that uses only the general-purpose registers.  This
26847 prevents the compiler from using floating-point, vector, mask and bound
26848 registers.
26850 @item -mindirect-branch=@var{choice}
26851 @opindex -mindirect-branch
26852 Convert indirect call and jump with @var{choice}.  The default is
26853 @samp{keep}, which keeps indirect call and jump unmodified.
26854 @samp{thunk} converts indirect call and jump to call and return thunk.
26855 @samp{thunk-inline} converts indirect call and jump to inlined call
26856 and return thunk.  @samp{thunk-extern} converts indirect call and jump
26857 to external call and return thunk provided in a separate object file.
26858 You can control this behavior for a specific function by using the
26859 function attribute @code{indirect_branch}.  @xref{Function Attributes}.
26861 @item -mfunction-return=@var{choice}
26862 @opindex -mfunction-return
26863 Convert function return with @var{choice}.  The default is @samp{keep},
26864 which keeps function return unmodified.  @samp{thunk} converts function
26865 return to call and return thunk.  @samp{thunk-inline} converts function
26866 return to inlined call and return thunk.  @samp{thunk-extern} converts
26867 function return to external call and return thunk provided in a separate
26868 object file.  You can control this behavior for a specific function by
26869 using the function attribute @code{function_return}.
26870 @xref{Function Attributes}.
26872 @item -mindirect-branch-register
26873 @opindex -mindirect-branch-register
26874 Force indirect call and jump via register.
26876 @end table
26878 These @samp{-m} switches are supported in addition to the above
26879 on x86-64 processors in 64-bit environments.
26881 @table @gcctabopt
26882 @item -m32
26883 @itemx -m64
26884 @itemx -mx32
26885 @itemx -m16
26886 @itemx -miamcu
26887 @opindex m32
26888 @opindex m64
26889 @opindex mx32
26890 @opindex m16
26891 @opindex miamcu
26892 Generate code for a 16-bit, 32-bit or 64-bit environment.
26893 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26894 to 32 bits, and
26895 generates code that runs on any i386 system.
26897 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26898 types to 64 bits, and generates code for the x86-64 architecture.
26899 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26900 and @option{-mdynamic-no-pic} options.
26902 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26903 to 32 bits, and
26904 generates code for the x86-64 architecture.
26906 The @option{-m16} option is the same as @option{-m32}, except for that
26907 it outputs the @code{.code16gcc} assembly directive at the beginning of
26908 the assembly output so that the binary can run in 16-bit mode.
26910 The @option{-miamcu} option generates code which conforms to Intel MCU
26911 psABI.  It requires the @option{-m32} option to be turned on.
26913 @item -mno-red-zone
26914 @opindex mno-red-zone
26915 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26916 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26917 stack pointer that is not modified by signal or interrupt handlers
26918 and therefore can be used for temporary data without adjusting the stack
26919 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26921 @item -mcmodel=small
26922 @opindex mcmodel=small
26923 Generate code for the small code model: the program and its symbols must
26924 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26925 Programs can be statically or dynamically linked.  This is the default
26926 code model.
26928 @item -mcmodel=kernel
26929 @opindex mcmodel=kernel
26930 Generate code for the kernel code model.  The kernel runs in the
26931 negative 2 GB of the address space.
26932 This model has to be used for Linux kernel code.
26934 @item -mcmodel=medium
26935 @opindex mcmodel=medium
26936 Generate code for the medium model: the program is linked in the lower 2
26937 GB of the address space.  Small symbols are also placed there.  Symbols
26938 with sizes larger than @option{-mlarge-data-threshold} are put into
26939 large data or BSS sections and can be located above 2GB.  Programs can
26940 be statically or dynamically linked.
26942 @item -mcmodel=large
26943 @opindex mcmodel=large
26944 Generate code for the large model.  This model makes no assumptions
26945 about addresses and sizes of sections.
26947 @item -maddress-mode=long
26948 @opindex maddress-mode=long
26949 Generate code for long address mode.  This is only supported for 64-bit
26950 and x32 environments.  It is the default address mode for 64-bit
26951 environments.
26953 @item -maddress-mode=short
26954 @opindex maddress-mode=short
26955 Generate code for short address mode.  This is only supported for 32-bit
26956 and x32 environments.  It is the default address mode for 32-bit and
26957 x32 environments.
26958 @end table
26960 @node x86 Windows Options
26961 @subsection x86 Windows Options
26962 @cindex x86 Windows Options
26963 @cindex Windows Options for x86
26965 These additional options are available for Microsoft Windows targets:
26967 @table @gcctabopt
26968 @item -mconsole
26969 @opindex mconsole
26970 This option
26971 specifies that a console application is to be generated, by
26972 instructing the linker to set the PE header subsystem type
26973 required for console applications.
26974 This option is available for Cygwin and MinGW targets and is
26975 enabled by default on those targets.
26977 @item -mdll
26978 @opindex mdll
26979 This option is available for Cygwin and MinGW targets.  It
26980 specifies that a DLL---a dynamic link library---is to be
26981 generated, enabling the selection of the required runtime
26982 startup object and entry point.
26984 @item -mnop-fun-dllimport
26985 @opindex mnop-fun-dllimport
26986 This option is available for Cygwin and MinGW targets.  It
26987 specifies that the @code{dllimport} attribute should be ignored.
26989 @item -mthread
26990 @opindex mthread
26991 This option is available for MinGW targets. It specifies
26992 that MinGW-specific thread support is to be used.
26994 @item -municode
26995 @opindex municode
26996 This option is available for MinGW-w64 targets.  It causes
26997 the @code{UNICODE} preprocessor macro to be predefined, and
26998 chooses Unicode-capable runtime startup code.
27000 @item -mwin32
27001 @opindex mwin32
27002 This option is available for Cygwin and MinGW targets.  It
27003 specifies that the typical Microsoft Windows predefined macros are to
27004 be set in the pre-processor, but does not influence the choice
27005 of runtime library/startup code.
27007 @item -mwindows
27008 @opindex mwindows
27009 This option is available for Cygwin and MinGW targets.  It
27010 specifies that a GUI application is to be generated by
27011 instructing the linker to set the PE header subsystem type
27012 appropriately.
27014 @item -fno-set-stack-executable
27015 @opindex fno-set-stack-executable
27016 This option is available for MinGW targets. It specifies that
27017 the executable flag for the stack used by nested functions isn't
27018 set. This is necessary for binaries running in kernel mode of
27019 Microsoft Windows, as there the User32 API, which is used to set executable
27020 privileges, isn't available.
27022 @item -fwritable-relocated-rdata
27023 @opindex fno-writable-relocated-rdata
27024 This option is available for MinGW and Cygwin targets.  It specifies
27025 that relocated-data in read-only section is put into the @code{.data}
27026 section.  This is a necessary for older runtimes not supporting
27027 modification of @code{.rdata} sections for pseudo-relocation.
27029 @item -mpe-aligned-commons
27030 @opindex mpe-aligned-commons
27031 This option is available for Cygwin and MinGW targets.  It
27032 specifies that the GNU extension to the PE file format that
27033 permits the correct alignment of COMMON variables should be
27034 used when generating code.  It is enabled by default if
27035 GCC detects that the target assembler found during configuration
27036 supports the feature.
27037 @end table
27039 See also under @ref{x86 Options} for standard options.
27041 @node Xstormy16 Options
27042 @subsection Xstormy16 Options
27043 @cindex Xstormy16 Options
27045 These options are defined for Xstormy16:
27047 @table @gcctabopt
27048 @item -msim
27049 @opindex msim
27050 Choose startup files and linker script suitable for the simulator.
27051 @end table
27053 @node Xtensa Options
27054 @subsection Xtensa Options
27055 @cindex Xtensa Options
27057 These options are supported for Xtensa targets:
27059 @table @gcctabopt
27060 @item -mconst16
27061 @itemx -mno-const16
27062 @opindex mconst16
27063 @opindex mno-const16
27064 Enable or disable use of @code{CONST16} instructions for loading
27065 constant values.  The @code{CONST16} instruction is currently not a
27066 standard option from Tensilica.  When enabled, @code{CONST16}
27067 instructions are always used in place of the standard @code{L32R}
27068 instructions.  The use of @code{CONST16} is enabled by default only if
27069 the @code{L32R} instruction is not available.
27071 @item -mfused-madd
27072 @itemx -mno-fused-madd
27073 @opindex mfused-madd
27074 @opindex mno-fused-madd
27075 Enable or disable use of fused multiply/add and multiply/subtract
27076 instructions in the floating-point option.  This has no effect if the
27077 floating-point option is not also enabled.  Disabling fused multiply/add
27078 and multiply/subtract instructions forces the compiler to use separate
27079 instructions for the multiply and add/subtract operations.  This may be
27080 desirable in some cases where strict IEEE 754-compliant results are
27081 required: the fused multiply add/subtract instructions do not round the
27082 intermediate result, thereby producing results with @emph{more} bits of
27083 precision than specified by the IEEE standard.  Disabling fused multiply
27084 add/subtract instructions also ensures that the program output is not
27085 sensitive to the compiler's ability to combine multiply and add/subtract
27086 operations.
27088 @item -mserialize-volatile
27089 @itemx -mno-serialize-volatile
27090 @opindex mserialize-volatile
27091 @opindex mno-serialize-volatile
27092 When this option is enabled, GCC inserts @code{MEMW} instructions before
27093 @code{volatile} memory references to guarantee sequential consistency.
27094 The default is @option{-mserialize-volatile}.  Use
27095 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
27097 @item -mforce-no-pic
27098 @opindex mforce-no-pic
27099 For targets, like GNU/Linux, where all user-mode Xtensa code must be
27100 position-independent code (PIC), this option disables PIC for compiling
27101 kernel code.
27103 @item -mtext-section-literals
27104 @itemx -mno-text-section-literals
27105 @opindex mtext-section-literals
27106 @opindex mno-text-section-literals
27107 These options control the treatment of literal pools.  The default is
27108 @option{-mno-text-section-literals}, which places literals in a separate
27109 section in the output file.  This allows the literal pool to be placed
27110 in a data RAM/ROM, and it also allows the linker to combine literal
27111 pools from separate object files to remove redundant literals and
27112 improve code size.  With @option{-mtext-section-literals}, the literals
27113 are interspersed in the text section in order to keep them as close as
27114 possible to their references.  This may be necessary for large assembly
27115 files.  Literals for each function are placed right before that function.
27117 @item -mauto-litpools
27118 @itemx -mno-auto-litpools
27119 @opindex mauto-litpools
27120 @opindex mno-auto-litpools
27121 These options control the treatment of literal pools.  The default is
27122 @option{-mno-auto-litpools}, which places literals in a separate
27123 section in the output file unless @option{-mtext-section-literals} is
27124 used.  With @option{-mauto-litpools} the literals are interspersed in
27125 the text section by the assembler.  Compiler does not produce explicit
27126 @code{.literal} directives and loads literals into registers with
27127 @code{MOVI} instructions instead of @code{L32R} to let the assembler
27128 do relaxation and place literals as necessary.  This option allows
27129 assembler to create several literal pools per function and assemble
27130 very big functions, which may not be possible with
27131 @option{-mtext-section-literals}.
27133 @item -mtarget-align
27134 @itemx -mno-target-align
27135 @opindex mtarget-align
27136 @opindex mno-target-align
27137 When this option is enabled, GCC instructs the assembler to
27138 automatically align instructions to reduce branch penalties at the
27139 expense of some code density.  The assembler attempts to widen density
27140 instructions to align branch targets and the instructions following call
27141 instructions.  If there are not enough preceding safe density
27142 instructions to align a target, no widening is performed.  The
27143 default is @option{-mtarget-align}.  These options do not affect the
27144 treatment of auto-aligned instructions like @code{LOOP}, which the
27145 assembler always aligns, either by widening density instructions or
27146 by inserting NOP instructions.
27148 @item -mlongcalls
27149 @itemx -mno-longcalls
27150 @opindex mlongcalls
27151 @opindex mno-longcalls
27152 When this option is enabled, GCC instructs the assembler to translate
27153 direct calls to indirect calls unless it can determine that the target
27154 of a direct call is in the range allowed by the call instruction.  This
27155 translation typically occurs for calls to functions in other source
27156 files.  Specifically, the assembler translates a direct @code{CALL}
27157 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
27158 The default is @option{-mno-longcalls}.  This option should be used in
27159 programs where the call target can potentially be out of range.  This
27160 option is implemented in the assembler, not the compiler, so the
27161 assembly code generated by GCC still shows direct call
27162 instructions---look at the disassembled object code to see the actual
27163 instructions.  Note that the assembler uses an indirect call for
27164 every cross-file call, not just those that really are out of range.
27165 @end table
27167 @node zSeries Options
27168 @subsection zSeries Options
27169 @cindex zSeries options
27171 These are listed under @xref{S/390 and zSeries Options}.
27174 @c man end
27176 @node Spec Files
27177 @section Specifying Subprocesses and the Switches to Pass to Them
27178 @cindex Spec Files
27180 @command{gcc} is a driver program.  It performs its job by invoking a
27181 sequence of other programs to do the work of compiling, assembling and
27182 linking.  GCC interprets its command-line parameters and uses these to
27183 deduce which programs it should invoke, and which command-line options
27184 it ought to place on their command lines.  This behavior is controlled
27185 by @dfn{spec strings}.  In most cases there is one spec string for each
27186 program that GCC can invoke, but a few programs have multiple spec
27187 strings to control their behavior.  The spec strings built into GCC can
27188 be overridden by using the @option{-specs=} command-line switch to specify
27189 a spec file.
27191 @dfn{Spec files} are plain-text files that are used to construct spec
27192 strings.  They consist of a sequence of directives separated by blank
27193 lines.  The type of directive is determined by the first non-whitespace
27194 character on the line, which can be one of the following:
27196 @table @code
27197 @item %@var{command}
27198 Issues a @var{command} to the spec file processor.  The commands that can
27199 appear here are:
27201 @table @code
27202 @item %include <@var{file}>
27203 @cindex @code{%include}
27204 Search for @var{file} and insert its text at the current point in the
27205 specs file.
27207 @item %include_noerr <@var{file}>
27208 @cindex @code{%include_noerr}
27209 Just like @samp{%include}, but do not generate an error message if the include
27210 file cannot be found.
27212 @item %rename @var{old_name} @var{new_name}
27213 @cindex @code{%rename}
27214 Rename the spec string @var{old_name} to @var{new_name}.
27216 @end table
27218 @item *[@var{spec_name}]:
27219 This tells the compiler to create, override or delete the named spec
27220 string.  All lines after this directive up to the next directive or
27221 blank line are considered to be the text for the spec string.  If this
27222 results in an empty string then the spec is deleted.  (Or, if the
27223 spec did not exist, then nothing happens.)  Otherwise, if the spec
27224 does not currently exist a new spec is created.  If the spec does
27225 exist then its contents are overridden by the text of this
27226 directive, unless the first character of that text is the @samp{+}
27227 character, in which case the text is appended to the spec.
27229 @item [@var{suffix}]:
27230 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
27231 and up to the next directive or blank line are considered to make up the
27232 spec string for the indicated suffix.  When the compiler encounters an
27233 input file with the named suffix, it processes the spec string in
27234 order to work out how to compile that file.  For example:
27236 @smallexample
27237 .ZZ:
27238 z-compile -input %i
27239 @end smallexample
27241 This says that any input file whose name ends in @samp{.ZZ} should be
27242 passed to the program @samp{z-compile}, which should be invoked with the
27243 command-line switch @option{-input} and with the result of performing the
27244 @samp{%i} substitution.  (See below.)
27246 As an alternative to providing a spec string, the text following a
27247 suffix directive can be one of the following:
27249 @table @code
27250 @item @@@var{language}
27251 This says that the suffix is an alias for a known @var{language}.  This is
27252 similar to using the @option{-x} command-line switch to GCC to specify a
27253 language explicitly.  For example:
27255 @smallexample
27256 .ZZ:
27257 @@c++
27258 @end smallexample
27260 Says that .ZZ files are, in fact, C++ source files.
27262 @item #@var{name}
27263 This causes an error messages saying:
27265 @smallexample
27266 @var{name} compiler not installed on this system.
27267 @end smallexample
27268 @end table
27270 GCC already has an extensive list of suffixes built into it.
27271 This directive adds an entry to the end of the list of suffixes, but
27272 since the list is searched from the end backwards, it is effectively
27273 possible to override earlier entries using this technique.
27275 @end table
27277 GCC has the following spec strings built into it.  Spec files can
27278 override these strings or create their own.  Note that individual
27279 targets can also add their own spec strings to this list.
27281 @smallexample
27282 asm          Options to pass to the assembler
27283 asm_final    Options to pass to the assembler post-processor
27284 cpp          Options to pass to the C preprocessor
27285 cc1          Options to pass to the C compiler
27286 cc1plus      Options to pass to the C++ compiler
27287 endfile      Object files to include at the end of the link
27288 link         Options to pass to the linker
27289 lib          Libraries to include on the command line to the linker
27290 libgcc       Decides which GCC support library to pass to the linker
27291 linker       Sets the name of the linker
27292 predefines   Defines to be passed to the C preprocessor
27293 signed_char  Defines to pass to CPP to say whether @code{char} is signed
27294              by default
27295 startfile    Object files to include at the start of the link
27296 @end smallexample
27298 Here is a small example of a spec file:
27300 @smallexample
27301 %rename lib                 old_lib
27303 *lib:
27304 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
27305 @end smallexample
27307 This example renames the spec called @samp{lib} to @samp{old_lib} and
27308 then overrides the previous definition of @samp{lib} with a new one.
27309 The new definition adds in some extra command-line options before
27310 including the text of the old definition.
27312 @dfn{Spec strings} are a list of command-line options to be passed to their
27313 corresponding program.  In addition, the spec strings can contain
27314 @samp{%}-prefixed sequences to substitute variable text or to
27315 conditionally insert text into the command line.  Using these constructs
27316 it is possible to generate quite complex command lines.
27318 Here is a table of all defined @samp{%}-sequences for spec
27319 strings.  Note that spaces are not generated automatically around the
27320 results of expanding these sequences.  Therefore you can concatenate them
27321 together or combine them with constant text in a single argument.
27323 @table @code
27324 @item %%
27325 Substitute one @samp{%} into the program name or argument.
27327 @item %i
27328 Substitute the name of the input file being processed.
27330 @item %b
27331 Substitute the basename of the input file being processed.
27332 This is the substring up to (and not including) the last period
27333 and not including the directory.
27335 @item %B
27336 This is the same as @samp{%b}, but include the file suffix (text after
27337 the last period).
27339 @item %d
27340 Marks the argument containing or following the @samp{%d} as a
27341 temporary file name, so that that file is deleted if GCC exits
27342 successfully.  Unlike @samp{%g}, this contributes no text to the
27343 argument.
27345 @item %g@var{suffix}
27346 Substitute a file name that has suffix @var{suffix} and is chosen
27347 once per compilation, and mark the argument in the same way as
27348 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
27349 name is now chosen in a way that is hard to predict even when previously
27350 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
27351 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
27352 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
27353 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
27354 was simply substituted with a file name chosen once per compilation,
27355 without regard to any appended suffix (which was therefore treated
27356 just like ordinary text), making such attacks more likely to succeed.
27358 @item %u@var{suffix}
27359 Like @samp{%g}, but generates a new temporary file name
27360 each time it appears instead of once per compilation.
27362 @item %U@var{suffix}
27363 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
27364 new one if there is no such last file name.  In the absence of any
27365 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
27366 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
27367 involves the generation of two distinct file names, one
27368 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
27369 simply substituted with a file name chosen for the previous @samp{%u},
27370 without regard to any appended suffix.
27372 @item %j@var{suffix}
27373 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
27374 writable, and if @option{-save-temps} is not used; 
27375 otherwise, substitute the name
27376 of a temporary file, just like @samp{%u}.  This temporary file is not
27377 meant for communication between processes, but rather as a junk
27378 disposal mechanism.
27380 @item %|@var{suffix}
27381 @itemx %m@var{suffix}
27382 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
27383 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
27384 all.  These are the two most common ways to instruct a program that it
27385 should read from standard input or write to standard output.  If you
27386 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
27387 construct: see for example @file{f/lang-specs.h}.
27389 @item %.@var{SUFFIX}
27390 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
27391 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
27392 terminated by the next space or %.
27394 @item %w
27395 Marks the argument containing or following the @samp{%w} as the
27396 designated output file of this compilation.  This puts the argument
27397 into the sequence of arguments that @samp{%o} substitutes.
27399 @item %o
27400 Substitutes the names of all the output files, with spaces
27401 automatically placed around them.  You should write spaces
27402 around the @samp{%o} as well or the results are undefined.
27403 @samp{%o} is for use in the specs for running the linker.
27404 Input files whose names have no recognized suffix are not compiled
27405 at all, but they are included among the output files, so they are
27406 linked.
27408 @item %O
27409 Substitutes the suffix for object files.  Note that this is
27410 handled specially when it immediately follows @samp{%g, %u, or %U},
27411 because of the need for those to form complete file names.  The
27412 handling is such that @samp{%O} is treated exactly as if it had already
27413 been substituted, except that @samp{%g, %u, and %U} do not currently
27414 support additional @var{suffix} characters following @samp{%O} as they do
27415 following, for example, @samp{.o}.
27417 @item %p
27418 Substitutes the standard macro predefinitions for the
27419 current target machine.  Use this when running @command{cpp}.
27421 @item %P
27422 Like @samp{%p}, but puts @samp{__} before and after the name of each
27423 predefined macro, except for macros that start with @samp{__} or with
27424 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
27427 @item %I
27428 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
27429 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
27430 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
27431 and @option{-imultilib} as necessary.
27433 @item %s
27434 Current argument is the name of a library or startup file of some sort.
27435 Search for that file in a standard list of directories and substitute
27436 the full name found.  The current working directory is included in the
27437 list of directories scanned.
27439 @item %T
27440 Current argument is the name of a linker script.  Search for that file
27441 in the current list of directories to scan for libraries. If the file
27442 is located insert a @option{--script} option into the command line
27443 followed by the full path name found.  If the file is not found then
27444 generate an error message.  Note: the current working directory is not
27445 searched.
27447 @item %e@var{str}
27448 Print @var{str} as an error message.  @var{str} is terminated by a newline.
27449 Use this when inconsistent options are detected.
27451 @item %(@var{name})
27452 Substitute the contents of spec string @var{name} at this point.
27454 @item %x@{@var{option}@}
27455 Accumulate an option for @samp{%X}.
27457 @item %X
27458 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
27459 spec string.
27461 @item %Y
27462 Output the accumulated assembler options specified by @option{-Wa}.
27464 @item %Z
27465 Output the accumulated preprocessor options specified by @option{-Wp}.
27467 @item %a
27468 Process the @code{asm} spec.  This is used to compute the
27469 switches to be passed to the assembler.
27471 @item %A
27472 Process the @code{asm_final} spec.  This is a spec string for
27473 passing switches to an assembler post-processor, if such a program is
27474 needed.
27476 @item %l
27477 Process the @code{link} spec.  This is the spec for computing the
27478 command line passed to the linker.  Typically it makes use of the
27479 @samp{%L %G %S %D and %E} sequences.
27481 @item %D
27482 Dump out a @option{-L} option for each directory that GCC believes might
27483 contain startup files.  If the target supports multilibs then the
27484 current multilib directory is prepended to each of these paths.
27486 @item %L
27487 Process the @code{lib} spec.  This is a spec string for deciding which
27488 libraries are included on the command line to the linker.
27490 @item %G
27491 Process the @code{libgcc} spec.  This is a spec string for deciding
27492 which GCC support library is included on the command line to the linker.
27494 @item %S
27495 Process the @code{startfile} spec.  This is a spec for deciding which
27496 object files are the first ones passed to the linker.  Typically
27497 this might be a file named @file{crt0.o}.
27499 @item %E
27500 Process the @code{endfile} spec.  This is a spec string that specifies
27501 the last object files that are passed to the linker.
27503 @item %C
27504 Process the @code{cpp} spec.  This is used to construct the arguments
27505 to be passed to the C preprocessor.
27507 @item %1
27508 Process the @code{cc1} spec.  This is used to construct the options to be
27509 passed to the actual C compiler (@command{cc1}).
27511 @item %2
27512 Process the @code{cc1plus} spec.  This is used to construct the options to be
27513 passed to the actual C++ compiler (@command{cc1plus}).
27515 @item %*
27516 Substitute the variable part of a matched option.  See below.
27517 Note that each comma in the substituted string is replaced by
27518 a single space.
27520 @item %<S
27521 Remove all occurrences of @code{-S} from the command line.  Note---this
27522 command is position dependent.  @samp{%} commands in the spec string
27523 before this one see @code{-S}, @samp{%} commands in the spec string
27524 after this one do not.
27526 @item %:@var{function}(@var{args})
27527 Call the named function @var{function}, passing it @var{args}.
27528 @var{args} is first processed as a nested spec string, then split
27529 into an argument vector in the usual fashion.  The function returns
27530 a string which is processed as if it had appeared literally as part
27531 of the current spec.
27533 The following built-in spec functions are provided:
27535 @table @code
27536 @item @code{getenv}
27537 The @code{getenv} spec function takes two arguments: an environment
27538 variable name and a string.  If the environment variable is not
27539 defined, a fatal error is issued.  Otherwise, the return value is the
27540 value of the environment variable concatenated with the string.  For
27541 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
27543 @smallexample
27544 %:getenv(TOPDIR /include)
27545 @end smallexample
27547 expands to @file{/path/to/top/include}.
27549 @item @code{if-exists}
27550 The @code{if-exists} spec function takes one argument, an absolute
27551 pathname to a file.  If the file exists, @code{if-exists} returns the
27552 pathname.  Here is a small example of its usage:
27554 @smallexample
27555 *startfile:
27556 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
27557 @end smallexample
27559 @item @code{if-exists-else}
27560 The @code{if-exists-else} spec function is similar to the @code{if-exists}
27561 spec function, except that it takes two arguments.  The first argument is
27562 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
27563 returns the pathname.  If it does not exist, it returns the second argument.
27564 This way, @code{if-exists-else} can be used to select one file or another,
27565 based on the existence of the first.  Here is a small example of its usage:
27567 @smallexample
27568 *startfile:
27569 crt0%O%s %:if-exists(crti%O%s) \
27570 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
27571 @end smallexample
27573 @item @code{replace-outfile}
27574 The @code{replace-outfile} spec function takes two arguments.  It looks for the
27575 first argument in the outfiles array and replaces it with the second argument.  Here
27576 is a small example of its usage:
27578 @smallexample
27579 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
27580 @end smallexample
27582 @item @code{remove-outfile}
27583 The @code{remove-outfile} spec function takes one argument.  It looks for the
27584 first argument in the outfiles array and removes it.  Here is a small example
27585 its usage:
27587 @smallexample
27588 %:remove-outfile(-lm)
27589 @end smallexample
27591 @item @code{pass-through-libs}
27592 The @code{pass-through-libs} spec function takes any number of arguments.  It
27593 finds any @option{-l} options and any non-options ending in @file{.a} (which it
27594 assumes are the names of linker input library archive files) and returns a
27595 result containing all the found arguments each prepended by
27596 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
27597 intended to be passed to the LTO linker plugin.
27599 @smallexample
27600 %:pass-through-libs(%G %L %G)
27601 @end smallexample
27603 @item @code{print-asm-header}
27604 The @code{print-asm-header} function takes no arguments and simply
27605 prints a banner like:
27607 @smallexample
27608 Assembler options
27609 =================
27611 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
27612 @end smallexample
27614 It is used to separate compiler options from assembler options
27615 in the @option{--target-help} output.
27616 @end table
27618 @item %@{S@}
27619 Substitutes the @code{-S} switch, if that switch is given to GCC@.
27620 If that switch is not specified, this substitutes nothing.  Note that
27621 the leading dash is omitted when specifying this option, and it is
27622 automatically inserted if the substitution is performed.  Thus the spec
27623 string @samp{%@{foo@}} matches the command-line option @option{-foo}
27624 and outputs the command-line option @option{-foo}.
27626 @item %W@{S@}
27627 Like %@{@code{S}@} but mark last argument supplied within as a file to be
27628 deleted on failure.
27630 @item %@{S*@}
27631 Substitutes all the switches specified to GCC whose names start
27632 with @code{-S}, but which also take an argument.  This is used for
27633 switches like @option{-o}, @option{-D}, @option{-I}, etc.
27634 GCC considers @option{-o foo} as being
27635 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
27636 text, including the space.  Thus two arguments are generated.
27638 @item %@{S*&T*@}
27639 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
27640 (the order of @code{S} and @code{T} in the spec is not significant).
27641 There can be any number of ampersand-separated variables; for each the
27642 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
27644 @item %@{S:X@}
27645 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
27647 @item %@{!S:X@}
27648 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
27650 @item %@{S*:X@}
27651 Substitutes @code{X} if one or more switches whose names start with
27652 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
27653 once, no matter how many such switches appeared.  However, if @code{%*}
27654 appears somewhere in @code{X}, then @code{X} is substituted once
27655 for each matching switch, with the @code{%*} replaced by the part of
27656 that switch matching the @code{*}.
27658 If @code{%*} appears as the last part of a spec sequence then a space
27659 is added after the end of the last substitution.  If there is more
27660 text in the sequence, however, then a space is not generated.  This
27661 allows the @code{%*} substitution to be used as part of a larger
27662 string.  For example, a spec string like this:
27664 @smallexample
27665 %@{mcu=*:--script=%*/memory.ld@}
27666 @end smallexample
27668 @noindent
27669 when matching an option like @option{-mcu=newchip} produces:
27671 @smallexample
27672 --script=newchip/memory.ld
27673 @end smallexample
27675 @item %@{.S:X@}
27676 Substitutes @code{X}, if processing a file with suffix @code{S}.
27678 @item %@{!.S:X@}
27679 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
27681 @item %@{,S:X@}
27682 Substitutes @code{X}, if processing a file for language @code{S}.
27684 @item %@{!,S:X@}
27685 Substitutes @code{X}, if not processing a file for language @code{S}.
27687 @item %@{S|P:X@}
27688 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
27689 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
27690 @code{*} sequences as well, although they have a stronger binding than
27691 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
27692 alternatives must be starred, and only the first matching alternative
27693 is substituted.
27695 For example, a spec string like this:
27697 @smallexample
27698 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
27699 @end smallexample
27701 @noindent
27702 outputs the following command-line options from the following input
27703 command-line options:
27705 @smallexample
27706 fred.c        -foo -baz
27707 jim.d         -bar -boggle
27708 -d fred.c     -foo -baz -boggle
27709 -d jim.d      -bar -baz -boggle
27710 @end smallexample
27712 @item %@{S:X; T:Y; :D@}
27714 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
27715 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
27716 be as many clauses as you need.  This may be combined with @code{.},
27717 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
27720 @end table
27722 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
27723 or similar construct can use a backslash to ignore the special meaning
27724 of the character following it, thus allowing literal matching of a
27725 character that is otherwise specially treated.  For example,
27726 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
27727 @option{-std=iso9899:1999} option is given.
27729 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
27730 construct may contain other nested @samp{%} constructs or spaces, or
27731 even newlines.  They are processed as usual, as described above.
27732 Trailing white space in @code{X} is ignored.  White space may also
27733 appear anywhere on the left side of the colon in these constructs,
27734 except between @code{.} or @code{*} and the corresponding word.
27736 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
27737 handled specifically in these constructs.  If another value of
27738 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
27739 @option{-W} switch is found later in the command line, the earlier
27740 switch value is ignored, except with @{@code{S}*@} where @code{S} is
27741 just one letter, which passes all matching options.
27743 The character @samp{|} at the beginning of the predicate text is used to
27744 indicate that a command should be piped to the following command, but
27745 only if @option{-pipe} is specified.
27747 It is built into GCC which switches take arguments and which do not.
27748 (You might think it would be useful to generalize this to allow each
27749 compiler's spec to say which switches take arguments.  But this cannot
27750 be done in a consistent fashion.  GCC cannot even decide which input
27751 files have been specified without knowing which switches take arguments,
27752 and it must know which input files to compile in order to tell which
27753 compilers to run).
27755 GCC also knows implicitly that arguments starting in @option{-l} are to be
27756 treated as compiler output files, and passed to the linker in their
27757 proper position among the other output files.
27759 @node Environment Variables
27760 @section Environment Variables Affecting GCC
27761 @cindex environment variables
27763 @c man begin ENVIRONMENT
27764 This section describes several environment variables that affect how GCC
27765 operates.  Some of them work by specifying directories or prefixes to use
27766 when searching for various kinds of files.  Some are used to specify other
27767 aspects of the compilation environment.
27769 Note that you can also specify places to search using options such as
27770 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27771 take precedence over places specified using environment variables, which
27772 in turn take precedence over those specified by the configuration of GCC@.
27773 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27774 GNU Compiler Collection (GCC) Internals}.
27776 @table @env
27777 @item LANG
27778 @itemx LC_CTYPE
27779 @c @itemx LC_COLLATE
27780 @itemx LC_MESSAGES
27781 @c @itemx LC_MONETARY
27782 @c @itemx LC_NUMERIC
27783 @c @itemx LC_TIME
27784 @itemx LC_ALL
27785 @findex LANG
27786 @findex LC_CTYPE
27787 @c @findex LC_COLLATE
27788 @findex LC_MESSAGES
27789 @c @findex LC_MONETARY
27790 @c @findex LC_NUMERIC
27791 @c @findex LC_TIME
27792 @findex LC_ALL
27793 @cindex locale
27794 These environment variables control the way that GCC uses
27795 localization information which allows GCC to work with different
27796 national conventions.  GCC inspects the locale categories
27797 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27798 so.  These locale categories can be set to any value supported by your
27799 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27800 Kingdom encoded in UTF-8.
27802 The @env{LC_CTYPE} environment variable specifies character
27803 classification.  GCC uses it to determine the character boundaries in
27804 a string; this is needed for some multibyte encodings that contain quote
27805 and escape characters that are otherwise interpreted as a string
27806 end or escape.
27808 The @env{LC_MESSAGES} environment variable specifies the language to
27809 use in diagnostic messages.
27811 If the @env{LC_ALL} environment variable is set, it overrides the value
27812 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27813 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27814 environment variable.  If none of these variables are set, GCC
27815 defaults to traditional C English behavior.
27817 @item TMPDIR
27818 @findex TMPDIR
27819 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27820 files.  GCC uses temporary files to hold the output of one stage of
27821 compilation which is to be used as input to the next stage: for example,
27822 the output of the preprocessor, which is the input to the compiler
27823 proper.
27825 @item GCC_COMPARE_DEBUG
27826 @findex GCC_COMPARE_DEBUG
27827 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27828 @option{-fcompare-debug} to the compiler driver.  See the documentation
27829 of this option for more details.
27831 @item GCC_EXEC_PREFIX
27832 @findex GCC_EXEC_PREFIX
27833 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27834 names of the subprograms executed by the compiler.  No slash is added
27835 when this prefix is combined with the name of a subprogram, but you can
27836 specify a prefix that ends with a slash if you wish.
27838 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27839 an appropriate prefix to use based on the pathname it is invoked with.
27841 If GCC cannot find the subprogram using the specified prefix, it
27842 tries looking in the usual places for the subprogram.
27844 The default value of @env{GCC_EXEC_PREFIX} is
27845 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27846 the installed compiler. In many cases @var{prefix} is the value
27847 of @code{prefix} when you ran the @file{configure} script.
27849 Other prefixes specified with @option{-B} take precedence over this prefix.
27851 This prefix is also used for finding files such as @file{crt0.o} that are
27852 used for linking.
27854 In addition, the prefix is used in an unusual way in finding the
27855 directories to search for header files.  For each of the standard
27856 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27857 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27858 replacing that beginning with the specified prefix to produce an
27859 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27860 @file{foo/bar} just before it searches the standard directory 
27861 @file{/usr/local/lib/bar}.
27862 If a standard directory begins with the configured
27863 @var{prefix} then the value of @var{prefix} is replaced by
27864 @env{GCC_EXEC_PREFIX} when looking for header files.
27866 @item COMPILER_PATH
27867 @findex COMPILER_PATH
27868 The value of @env{COMPILER_PATH} is a colon-separated list of
27869 directories, much like @env{PATH}.  GCC tries the directories thus
27870 specified when searching for subprograms, if it cannot find the
27871 subprograms using @env{GCC_EXEC_PREFIX}.
27873 @item LIBRARY_PATH
27874 @findex LIBRARY_PATH
27875 The value of @env{LIBRARY_PATH} is a colon-separated list of
27876 directories, much like @env{PATH}.  When configured as a native compiler,
27877 GCC tries the directories thus specified when searching for special
27878 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27879 using GCC also uses these directories when searching for ordinary
27880 libraries for the @option{-l} option (but directories specified with
27881 @option{-L} come first).
27883 @item LANG
27884 @findex LANG
27885 @cindex locale definition
27886 This variable is used to pass locale information to the compiler.  One way in
27887 which this information is used is to determine the character set to be used
27888 when character literals, string literals and comments are parsed in C and C++.
27889 When the compiler is configured to allow multibyte characters,
27890 the following values for @env{LANG} are recognized:
27892 @table @samp
27893 @item C-JIS
27894 Recognize JIS characters.
27895 @item C-SJIS
27896 Recognize SJIS characters.
27897 @item C-EUCJP
27898 Recognize EUCJP characters.
27899 @end table
27901 If @env{LANG} is not defined, or if it has some other value, then the
27902 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27903 recognize and translate multibyte characters.
27904 @end table
27906 @noindent
27907 Some additional environment variables affect the behavior of the
27908 preprocessor.
27910 @include cppenv.texi
27912 @c man end
27914 @node Precompiled Headers
27915 @section Using Precompiled Headers
27916 @cindex precompiled headers
27917 @cindex speed of compilation
27919 Often large projects have many header files that are included in every
27920 source file.  The time the compiler takes to process these header files
27921 over and over again can account for nearly all of the time required to
27922 build the project.  To make builds faster, GCC allows you to
27923 @dfn{precompile} a header file.
27925 To create a precompiled header file, simply compile it as you would any
27926 other file, if necessary using the @option{-x} option to make the driver
27927 treat it as a C or C++ header file.  You may want to use a
27928 tool like @command{make} to keep the precompiled header up-to-date when
27929 the headers it contains change.
27931 A precompiled header file is searched for when @code{#include} is
27932 seen in the compilation.  As it searches for the included file
27933 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27934 compiler looks for a precompiled header in each directory just before it
27935 looks for the include file in that directory.  The name searched for is
27936 the name specified in the @code{#include} with @samp{.gch} appended.  If
27937 the precompiled header file cannot be used, it is ignored.
27939 For instance, if you have @code{#include "all.h"}, and you have
27940 @file{all.h.gch} in the same directory as @file{all.h}, then the
27941 precompiled header file is used if possible, and the original
27942 header is used otherwise.
27944 Alternatively, you might decide to put the precompiled header file in a
27945 directory and use @option{-I} to ensure that directory is searched
27946 before (or instead of) the directory containing the original header.
27947 Then, if you want to check that the precompiled header file is always
27948 used, you can put a file of the same name as the original header in this
27949 directory containing an @code{#error} command.
27951 This also works with @option{-include}.  So yet another way to use
27952 precompiled headers, good for projects not designed with precompiled
27953 header files in mind, is to simply take most of the header files used by
27954 a project, include them from another header file, precompile that header
27955 file, and @option{-include} the precompiled header.  If the header files
27956 have guards against multiple inclusion, they are skipped because
27957 they've already been included (in the precompiled header).
27959 If you need to precompile the same header file for different
27960 languages, targets, or compiler options, you can instead make a
27961 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27962 header in the directory, perhaps using @option{-o}.  It doesn't matter
27963 what you call the files in the directory; every precompiled header in
27964 the directory is considered.  The first precompiled header
27965 encountered in the directory that is valid for this compilation is
27966 used; they're searched in no particular order.
27968 There are many other possibilities, limited only by your imagination,
27969 good sense, and the constraints of your build system.
27971 A precompiled header file can be used only when these conditions apply:
27973 @itemize
27974 @item
27975 Only one precompiled header can be used in a particular compilation.
27977 @item
27978 A precompiled header cannot be used once the first C token is seen.  You
27979 can have preprocessor directives before a precompiled header; you cannot
27980 include a precompiled header from inside another header.
27982 @item
27983 The precompiled header file must be produced for the same language as
27984 the current compilation.  You cannot use a C precompiled header for a C++
27985 compilation.
27987 @item
27988 The precompiled header file must have been produced by the same compiler
27989 binary as the current compilation is using.
27991 @item
27992 Any macros defined before the precompiled header is included must
27993 either be defined in the same way as when the precompiled header was
27994 generated, or must not affect the precompiled header, which usually
27995 means that they don't appear in the precompiled header at all.
27997 The @option{-D} option is one way to define a macro before a
27998 precompiled header is included; using a @code{#define} can also do it.
27999 There are also some options that define macros implicitly, like
28000 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
28001 defined this way.
28003 @item If debugging information is output when using the precompiled
28004 header, using @option{-g} or similar, the same kind of debugging information
28005 must have been output when building the precompiled header.  However,
28006 a precompiled header built using @option{-g} can be used in a compilation
28007 when no debugging information is being output.
28009 @item The same @option{-m} options must generally be used when building
28010 and using the precompiled header.  @xref{Submodel Options},
28011 for any cases where this rule is relaxed.
28013 @item Each of the following options must be the same when building and using
28014 the precompiled header:
28016 @gccoptlist{-fexceptions}
28018 @item
28019 Some other command-line options starting with @option{-f},
28020 @option{-p}, or @option{-O} must be defined in the same way as when
28021 the precompiled header was generated.  At present, it's not clear
28022 which options are safe to change and which are not; the safest choice
28023 is to use exactly the same options when generating and using the
28024 precompiled header.  The following are known to be safe:
28026 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
28027 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
28028 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
28029 -pedantic-errors}
28031 @end itemize
28033 For all of these except the last, the compiler automatically
28034 ignores the precompiled header if the conditions aren't met.  If you
28035 find an option combination that doesn't work and doesn't cause the
28036 precompiled header to be ignored, please consider filing a bug report,
28037 see @ref{Bugs}.
28039 If you do use differing options when generating and using the
28040 precompiled header, the actual behavior is a mixture of the
28041 behavior for the options.  For instance, if you use @option{-g} to
28042 generate the precompiled header but not when using it, you may or may
28043 not get debugging information for routines in the precompiled header.