* config/i386/i386.c (ix86_adjust_stack_and_probe_stack_clash): New.
[official-gcc.git] / gcc / doc / invoke.texi
blobf0f9559b0243975f3fb2f72e9df23ac1209fc3c0
1 @c Copyright (C) 1988-2017 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2017 Free Software Foundation, Inc.
13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation License, Version 1.3 or
15 any later version published by the Free Software Foundation; with the
16 Invariant Sections being ``GNU General Public License'' and ``Funding
17 Free Software'', the Front-Cover texts being (a) (see below), and with
18 the Back-Cover Texts being (b) (see below).  A copy of the license is
19 included in the gfdl(7) man page.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
27      You have freedom to copy and modify this GNU Manual, like GNU
28      software.  Copies published by the Free Software Foundation raise
29      funds for GNU development.
30 @c man end
31 @c Set file name and title for the man page.
32 @setfilename gcc
33 @settitle GNU project C and C++ compiler
34 @c man begin SYNOPSIS
35 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
36     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
37     [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}]
38     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
39     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
40     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
41     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
69 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75 @xref{Overall Options,,Options Controlling the Kind of Output}.
77 Other options are passed on to one or more stages of processing.  Some options
78 control the preprocessor and others the compiler itself.  Yet other
79 options control the assembler and linker; most of these are not
80 documented here, since you rarely need to use any of them.
82 @cindex C compilation options
83 Most of the command-line options that you can use with GCC are useful
84 for C programs; when an option is only useful with another language
85 (usually C++), the explanation says so explicitly.  If the description
86 for a particular option does not mention a source language, you can use
87 that option with all supported languages.
89 @cindex cross compiling
90 @cindex specifying machine version
91 @cindex specifying compiler version and target machine
92 @cindex compiler version, specifying
93 @cindex target machine, specifying
94 The usual way to run GCC is to run the executable called @command{gcc}, or
95 @command{@var{machine}-gcc} when cross-compiling, or
96 @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC.
97 When you compile C++ programs, you should invoke GCC as @command{g++} 
98 instead.  @xref{Invoking G++,,Compiling C++ Programs}, 
99 for information about the differences in behavior between @command{gcc} 
100 and @code{g++} when compiling C++ programs.
102 @cindex grouping options
103 @cindex options, grouping
104 The @command{gcc} program accepts options and file names as operands.  Many
105 options have multi-letter names; therefore multiple single-letter options
106 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
107 -v}}.
109 @cindex order of options
110 @cindex options, order
111 You can mix options and other arguments.  For the most part, the order
112 you use doesn't matter.  Order does matter when you use several
113 options of the same kind; for example, if you specify @option{-L} more
114 than once, the directories are searched in the order specified.  Also,
115 the placement of the @option{-l} option is significant.
117 Many options have long names starting with @samp{-f} or with
118 @samp{-W}---for example,
119 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
120 these have both positive and negative forms; the negative form of
121 @option{-ffoo} is @option{-fno-foo}.  This manual documents
122 only one of these two forms, whichever one is not the default.
124 @c man end
126 @xref{Option Index}, for an index to GCC's options.
128 @menu
129 * Option Summary::      Brief list of all options, without explanations.
130 * Overall Options::     Controlling the kind of output:
131                         an executable, object files, assembler files,
132                         or preprocessed source.
133 * Invoking G++::        Compiling C++ programs.
134 * C Dialect Options::   Controlling the variant of C language compiled.
135 * C++ Dialect Options:: Variations on C++.
136 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
137                         and Objective-C++.
138 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
139                         be formatted.
140 * Warning Options::     How picky should the compiler be?
141 * Debugging Options::   Producing debuggable code.
142 * Optimize Options::    How much optimization?
143 * Instrumentation Options:: Enabling profiling and extra run-time error checking.
144 * Preprocessor Options:: Controlling header files and macro definitions.
145                          Also, getting dependency information for Make.
146 * Assembler Options::   Passing options to the assembler.
147 * Link Options::        Specifying libraries and so on.
148 * Directory Options::   Where to find header files and libraries.
149                         Where to find the compiler executable files.
150 * Code Gen Options::    Specifying conventions for function calls, data layout
151                         and register usage.
152 * Developer Options::   Printing GCC configuration info, statistics, and
153                         debugging dumps.
154 * Submodel Options::    Target-specific options, such as compiling for a
155                         specific processor variant.
156 * Spec Files::          How to pass switches to sub-processes.
157 * Environment Variables:: Env vars that affect GCC.
158 * Precompiled Headers:: Compiling a header once, and using it many times.
159 @end menu
161 @c man begin OPTIONS
163 @node Option Summary
164 @section Option Summary
166 Here is a summary of all the options, grouped by type.  Explanations are
167 in the following sections.
169 @table @emph
170 @item Overall Options
171 @xref{Overall Options,,Options Controlling the Kind of Output}.
172 @gccoptlist{-c  -S  -E  -o @var{file}  -x @var{language}  @gol
173 -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  --version @gol
174 -pass-exit-codes  -pipe  -specs=@var{file}  -wrapper  @gol
175 @@@var{file}  -fplugin=@var{file}  -fplugin-arg-@var{name}=@var{arg}  @gol
176 -fdump-ada-spec@r{[}-slim@r{]}  -fada-spec-parent=@var{unit}  -fdump-go-spec=@var{file}}
178 @item C Language Options
179 @xref{C Dialect Options,,Options Controlling C Dialect}.
180 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
181 -fpermitted-flt-eval-methods=@var{standard} @gol
182 -aux-info @var{filename}  -fallow-parameterless-variadic-functions @gol
183 -fno-asm  -fno-builtin  -fno-builtin-@var{function}  -fgimple@gol
184 -fhosted  -ffreestanding  -fopenacc  -fopenmp  -fopenmp-simd @gol
185 -fms-extensions  -fplan9-extensions  -fsso-struct=@var{endianness} @gol
186 -fallow-single-precision  -fcond-mismatch  -flax-vector-conversions @gol
187 -fsigned-bitfields  -fsigned-char @gol
188 -funsigned-bitfields  -funsigned-char}
190 @item C++ Language Options
191 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
192 @gccoptlist{-fabi-version=@var{n}  -fno-access-control @gol
193 -faligned-new=@var{n}  -fargs-in-order=@var{n}  -fcheck-new @gol
194 -fconstexpr-depth=@var{n}  -fconstexpr-loop-limit=@var{n} @gol
195 -ffriend-injection @gol
196 -fno-elide-constructors @gol
197 -fno-enforce-eh-specs @gol
198 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
199 -fno-implicit-templates @gol
200 -fno-implicit-inline-templates @gol
201 -fno-implement-inlines  -fms-extensions @gol
202 -fnew-inheriting-ctors @gol
203 -fnew-ttp-matching @gol
204 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
205 -fno-optional-diags  -fpermissive @gol
206 -fno-pretty-templates @gol
207 -frepo  -fno-rtti  -fsized-deallocation @gol
208 -ftemplate-backtrace-limit=@var{n} @gol
209 -ftemplate-depth=@var{n} @gol
210 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
211 -fno-weak  -nostdinc++ @gol
212 -fvisibility-inlines-hidden @gol
213 -fvisibility-ms-compat @gol
214 -fext-numeric-literals @gol
215 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
216 -Wdelete-non-virtual-dtor  -Wliteral-suffix  -Wmultiple-inheritance @gol
217 -Wnamespaces  -Wnarrowing @gol
218 -Wnoexcept  -Wnoexcept-type  -Wclass-memaccess @gol
219 -Wnon-virtual-dtor  -Wreorder  -Wregister @gol
220 -Weffc++  -Wstrict-null-sentinel  -Wtemplates @gol
221 -Wno-non-template-friend  -Wold-style-cast @gol
222 -Woverloaded-virtual  -Wno-pmf-conversions @gol
223 -Wsign-promo  -Wvirtual-inheritance}
225 @item Objective-C and Objective-C++ Language Options
226 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
227 Objective-C and Objective-C++ Dialects}.
228 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
229 -fgnu-runtime  -fnext-runtime @gol
230 -fno-nil-receivers @gol
231 -fobjc-abi-version=@var{n} @gol
232 -fobjc-call-cxx-cdtors @gol
233 -fobjc-direct-dispatch @gol
234 -fobjc-exceptions @gol
235 -fobjc-gc @gol
236 -fobjc-nilcheck @gol
237 -fobjc-std=objc1 @gol
238 -fno-local-ivars @gol
239 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
240 -freplace-objc-classes @gol
241 -fzero-link @gol
242 -gen-decls @gol
243 -Wassign-intercept @gol
244 -Wno-protocol  -Wselector @gol
245 -Wstrict-selector-match @gol
246 -Wundeclared-selector}
248 @item Diagnostic Message Formatting Options
249 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
250 @gccoptlist{-fmessage-length=@var{n}  @gol
251 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
252 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
253 -fno-diagnostics-show-option  -fno-diagnostics-show-caret @gol
254 -fdiagnostics-parseable-fixits  -fdiagnostics-generate-patch @gol
255 -fdiagnostics-show-template-tree -fno-elide-type @gol
256 -fno-show-column}
258 @item Warning Options
259 @xref{Warning Options,,Options to Request or Suppress Warnings}.
260 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
261 -pedantic-errors @gol
262 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
263 -Walloc-zero  -Walloc-size-larger-than=@var{n}
264 -Walloca  -Walloca-larger-than=@var{n} @gol
265 -Wno-aggressive-loop-optimizations  -Warray-bounds  -Warray-bounds=@var{n} @gol
266 -Wno-attributes  -Wbool-compare  -Wbool-operation @gol
267 -Wno-builtin-declaration-mismatch @gol
268 -Wno-builtin-macro-redefined  -Wc90-c99-compat  -Wc99-c11-compat @gol
269 -Wc++-compat  -Wc++11-compat  -Wc++14-compat  @gol
270 -Wcast-align  -Wcast-align=strict  -Wcast-qual  @gol
271 -Wchar-subscripts  -Wchkp  -Wcatch-value  -Wcatch-value=@var{n} @gol
272 -Wclobbered  -Wcomment  -Wconditionally-supported @gol
273 -Wconversion  -Wcoverage-mismatch  -Wno-cpp  -Wdangling-else  -Wdate-time @gol
274 -Wdelete-incomplete @gol
275 -Wno-deprecated  -Wno-deprecated-declarations  -Wno-designated-init @gol
276 -Wdisabled-optimization @gol
277 -Wno-discarded-qualifiers  -Wno-discarded-array-qualifiers @gol
278 -Wno-div-by-zero  -Wdouble-promotion @gol
279 -Wduplicated-branches  -Wduplicated-cond @gol
280 -Wempty-body  -Wenum-compare  -Wno-endif-labels  -Wexpansion-to-defined @gol
281 -Werror  -Werror=*  -Wextra-semi  -Wfatal-errors @gol
282 -Wfloat-equal  -Wformat  -Wformat=2 @gol
283 -Wno-format-contains-nul  -Wno-format-extra-args  @gol
284 -Wformat-nonliteral -Wformat-overflow=@var{n} @gol
285 -Wformat-security  -Wformat-signedness  -Wformat-truncation=@var{n} @gol
286 -Wformat-y2k  -Wframe-address @gol
287 -Wframe-larger-than=@var{len}  -Wno-free-nonheap-object  -Wjump-misses-init @gol
288 -Wif-not-aligned @gol
289 -Wignored-qualifiers  -Wignored-attributes  -Wincompatible-pointer-types @gol
290 -Wimplicit  -Wimplicit-fallthrough  -Wimplicit-fallthrough=@var{n} @gol
291 -Wimplicit-function-declaration  -Wimplicit-int @gol
292 -Winit-self  -Winline  -Wno-int-conversion  -Wint-in-bool-context @gol
293 -Wno-int-to-pointer-cast  -Winvalid-memory-model  -Wno-invalid-offsetof @gol
294 -Winvalid-pch  -Wlarger-than=@var{len} @gol
295 -Wlogical-op  -Wlogical-not-parentheses  -Wlong-long @gol
296 -Wmain  -Wmaybe-uninitialized  -Wmemset-elt-size  -Wmemset-transposed-args @gol
297 -Wmisleading-indentation  -Wmissing-braces @gol
298 -Wmissing-field-initializers  -Wmissing-include-dirs @gol
299 -Wno-multichar  -Wmultistatement-macros  -Wnonnull  -Wnonnull-compare @gol
300 -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
301 -Wnull-dereference  -Wodr  -Wno-overflow  -Wopenmp-simd  @gol
302 -Woverride-init-side-effects  -Woverlength-strings @gol
303 -Wpacked  -Wpacked-bitfield-compat -Wpacked-not-aligned -Wpadded @gol
304 -Wparentheses  -Wno-pedantic-ms-format @gol
305 -Wplacement-new  -Wplacement-new=@var{n} @gol
306 -Wpointer-arith  -Wpointer-compare  -Wno-pointer-to-int-cast @gol
307 -Wno-pragmas  -Wredundant-decls  -Wrestrict  -Wno-return-local-addr @gol
308 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
309 -Wshadow=global,  -Wshadow=local,  -Wshadow=compatible-local @gol
310 -Wshift-overflow  -Wshift-overflow=@var{n} @gol
311 -Wshift-count-negative  -Wshift-count-overflow  -Wshift-negative-value @gol
312 -Wsign-compare  -Wsign-conversion  -Wfloat-conversion @gol
313 -Wno-scalar-storage-order  -Wsizeof-pointer-div @gol
314 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
315 -Wstack-protector  -Wstack-usage=@var{len}  -Wstrict-aliasing @gol
316 -Wstrict-aliasing=n  -Wstrict-overflow  -Wstrict-overflow=@var{n} @gol
317 -Wstringop-overflow=@var{n} @gol
318 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
319 -Wsuggest-final-types @gol  -Wsuggest-final-methods  -Wsuggest-override @gol
320 -Wmissing-format-attribute  -Wsubobject-linkage @gol
321 -Wswitch  -Wswitch-bool  -Wswitch-default  -Wswitch-enum @gol
322 -Wswitch-unreachable  -Wsync-nand @gol
323 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
324 -Wtype-limits  -Wundef @gol
325 -Wuninitialized  -Wunknown-pragmas  -Wunsafe-loop-optimizations @gol
326 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
327 -Wunused-label  -Wunused-local-typedefs  -Wunused-macros @gol
328 -Wunused-parameter  -Wno-unused-result @gol
329 -Wunused-value  -Wunused-variable @gol
330 -Wunused-const-variable  -Wunused-const-variable=@var{n} @gol
331 -Wunused-but-set-parameter  -Wunused-but-set-variable @gol
332 -Wuseless-cast  -Wvariadic-macros  -Wvector-operation-performance @gol
333 -Wvla  -Wvla-larger-than=@var{n}  -Wvolatile-register-var  -Wwrite-strings @gol
334 -Wzero-as-null-pointer-constant  -Whsa}
336 @item C and Objective-C-only Warning Options
337 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
338 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
339 -Wold-style-declaration  -Wold-style-definition @gol
340 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
341 -Wdeclaration-after-statement  -Wpointer-sign}
343 @item Debugging Options
344 @xref{Debugging Options,,Options for Debugging Your Program}.
345 @gccoptlist{-g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-@var{version} @gol
346 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
347 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
348 -gcolumn-info  -gno-column-info @gol
349 -gvms  -gxcoff  -gxcoff+  -gz@r{[}=@var{type}@r{]} @gol
350 -fdebug-prefix-map=@var{old}=@var{new}  -fdebug-types-section @gol
351 -fno-eliminate-unused-debug-types @gol
352 -femit-struct-debug-baseonly  -femit-struct-debug-reduced @gol
353 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
354 -feliminate-unused-debug-symbols  -femit-class-debug-always @gol
355 -fno-merge-debug-strings  -fno-dwarf2-cfi-asm @gol
356 -fvar-tracking  -fvar-tracking-assignments}
358 @item Optimization Options
359 @xref{Optimize Options,,Options that Control Optimization}.
360 @gccoptlist{-faggressive-loop-optimizations  -falign-functions[=@var{n}] @gol
361 -falign-jumps[=@var{n}] @gol
362 -falign-labels[=@var{n}]  -falign-loops[=@var{n}] @gol
363 -fassociative-math  -fauto-profile  -fauto-profile[=@var{path}] @gol
364 -fauto-inc-dec  -fbranch-probabilities @gol
365 -fbranch-target-load-optimize  -fbranch-target-load-optimize2 @gol
366 -fbtr-bb-exclusive  -fcaller-saves @gol
367 -fcombine-stack-adjustments  -fconserve-stack @gol
368 -fcompare-elim  -fcprop-registers  -fcrossjumping @gol
369 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-fortran-rules @gol
370 -fcx-limited-range @gol
371 -fdata-sections  -fdce  -fdelayed-branch @gol
372 -fdelete-null-pointer-checks  -fdevirtualize  -fdevirtualize-speculatively @gol
373 -fdevirtualize-at-ltrans  -fdse @gol
374 -fearly-inlining  -fipa-sra  -fexpensive-optimizations  -ffat-lto-objects @gol
375 -ffast-math  -ffinite-math-only  -ffloat-store  -fexcess-precision=@var{style} @gol
376 -fforward-propagate  -ffp-contract=@var{style}  -ffunction-sections @gol
377 -fgcse  -fgcse-after-reload  -fgcse-las  -fgcse-lm  -fgraphite-identity @gol
378 -fgcse-sm  -fhoist-adjacent-loads  -fif-conversion @gol
379 -fif-conversion2  -findirect-inlining @gol
380 -finline-functions  -finline-functions-called-once  -finline-limit=@var{n} @gol
381 -finline-small-functions  -fipa-cp  -fipa-cp-clone @gol
382 -fipa-bit-cp -fipa-vrp @gol
383 -fipa-pta  -fipa-profile  -fipa-pure-const  -fipa-reference  -fipa-icf @gol
384 -fira-algorithm=@var{algorithm} @gol
385 -fira-region=@var{region}  -fira-hoist-pressure @gol
386 -fira-loop-pressure  -fno-ira-share-save-slots @gol
387 -fno-ira-share-spill-slots @gol
388 -fisolate-erroneous-paths-dereference  -fisolate-erroneous-paths-attribute @gol
389 -fivopts  -fkeep-inline-functions  -fkeep-static-functions @gol
390 -fkeep-static-consts  -flimit-function-alignment  -flive-range-shrinkage @gol
391 -floop-block  -floop-interchange  -floop-strip-mine @gol
392 -floop-unroll-and-jam  -floop-nest-optimize @gol
393 -floop-parallelize-all  -flra-remat  -flto  -flto-compression-level @gol
394 -flto-partition=@var{alg}  -fmerge-all-constants @gol
395 -fmerge-constants  -fmodulo-sched  -fmodulo-sched-allow-regmoves @gol
396 -fmove-loop-invariants  -fno-branch-count-reg @gol
397 -fno-defer-pop  -fno-fp-int-builtin-inexact  -fno-function-cse @gol
398 -fno-guess-branch-probability  -fno-inline  -fno-math-errno  -fno-peephole @gol
399 -fno-peephole2  -fno-printf-return-value  -fno-sched-interblock @gol
400 -fno-sched-spec  -fno-signed-zeros @gol
401 -fno-toplevel-reorder  -fno-trapping-math  -fno-zero-initialized-in-bss @gol
402 -fomit-frame-pointer  -foptimize-sibling-calls @gol
403 -fpartial-inlining  -fpeel-loops  -fpredictive-commoning @gol
404 -fprefetch-loop-arrays @gol
405 -fprofile-correction @gol
406 -fprofile-use  -fprofile-use=@var{path}  -fprofile-values @gol
407 -fprofile-reorder-functions @gol
408 -freciprocal-math  -free  -frename-registers  -freorder-blocks @gol
409 -freorder-blocks-algorithm=@var{algorithm} @gol
410 -freorder-blocks-and-partition  -freorder-functions @gol
411 -frerun-cse-after-loop  -freschedule-modulo-scheduled-loops @gol
412 -frounding-math  -fsched2-use-superblocks  -fsched-pressure @gol
413 -fsched-spec-load  -fsched-spec-load-dangerous @gol
414 -fsched-stalled-insns-dep[=@var{n}]  -fsched-stalled-insns[=@var{n}] @gol
415 -fsched-group-heuristic  -fsched-critical-path-heuristic @gol
416 -fsched-spec-insn-heuristic  -fsched-rank-heuristic @gol
417 -fsched-last-insn-heuristic  -fsched-dep-count-heuristic @gol
418 -fschedule-fusion @gol
419 -fschedule-insns  -fschedule-insns2  -fsection-anchors @gol
420 -fselective-scheduling  -fselective-scheduling2 @gol
421 -fsel-sched-pipelining  -fsel-sched-pipelining-outer-loops @gol
422 -fsemantic-interposition  -fshrink-wrap  -fshrink-wrap-separate @gol
423 -fsignaling-nans @gol
424 -fsingle-precision-constant  -fsplit-ivs-in-unroller  -fsplit-loops@gol
425 -fsplit-paths @gol
426 -fsplit-wide-types  -fssa-backprop  -fssa-phiopt @gol
427 -fstdarg-opt  -fstore-merging  -fstrict-aliasing @gol
428 -fthread-jumps  -ftracer  -ftree-bit-ccp @gol
429 -ftree-builtin-call-dce  -ftree-ccp  -ftree-ch @gol
430 -ftree-coalesce-vars  -ftree-copy-prop  -ftree-dce  -ftree-dominator-opts @gol
431 -ftree-dse  -ftree-forwprop  -ftree-fre  -fcode-hoisting @gol
432 -ftree-loop-if-convert  -ftree-loop-im @gol
433 -ftree-phiprop  -ftree-loop-distribution  -ftree-loop-distribute-patterns @gol
434 -ftree-loop-ivcanon  -ftree-loop-linear  -ftree-loop-optimize @gol
435 -ftree-loop-vectorize @gol
436 -ftree-parallelize-loops=@var{n}  -ftree-pre  -ftree-partial-pre  -ftree-pta @gol
437 -ftree-reassoc  -ftree-sink  -ftree-slsr  -ftree-sra @gol
438 -ftree-switch-conversion  -ftree-tail-merge @gol
439 -ftree-ter  -ftree-vectorize  -ftree-vrp  -funconstrained-commons @gol
440 -funit-at-a-time  -funroll-all-loops  -funroll-loops @gol
441 -funsafe-math-optimizations  -funswitch-loops @gol
442 -fipa-ra  -fvariable-expansion-in-unroller  -fvect-cost-model  -fvpt @gol
443 -fweb  -fwhole-program  -fwpa  -fuse-linker-plugin @gol
444 --param @var{name}=@var{value}
445 -O  -O0  -O1  -O2  -O3  -Os  -Ofast  -Og}
447 @item Program Instrumentation Options
448 @xref{Instrumentation Options,,Program Instrumentation Options}.
449 @gccoptlist{-p  -pg  -fprofile-arcs  --coverage  -ftest-coverage @gol
450 -fprofile-abs-path @gol
451 -fprofile-dir=@var{path}  -fprofile-generate  -fprofile-generate=@var{path} @gol
452 -fsanitize=@var{style}  -fsanitize-recover  -fsanitize-recover=@var{style} @gol
453 -fasan-shadow-offset=@var{number}  -fsanitize-sections=@var{s1},@var{s2},... @gol
454 -fsanitize-undefined-trap-on-error  -fbounds-check @gol
455 -fcheck-pointer-bounds  -fchkp-check-incomplete-type @gol
456 -fchkp-first-field-has-own-bounds  -fchkp-narrow-bounds @gol
457 -fchkp-narrow-to-innermost-array  -fchkp-optimize @gol
458 -fchkp-use-fast-string-functions  -fchkp-use-nochk-string-functions @gol
459 -fchkp-use-static-bounds  -fchkp-use-static-const-bounds @gol
460 -fchkp-treat-zero-dynamic-size-as-infinite  -fchkp-check-read @gol
461 -fchkp-check-read  -fchkp-check-write  -fchkp-store-bounds @gol
462 -fchkp-instrument-calls  -fchkp-instrument-marked-only @gol
463 -fchkp-use-wrappers  -fchkp-flexible-struct-trailing-arrays@gol
464 -fstack-protector  -fstack-protector-all  -fstack-protector-strong @gol
465 -fstack-protector-explicit  -fstack-check @gol
466 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
467 -fno-stack-limit  -fsplit-stack @gol
468 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
469 -fvtv-counts  -fvtv-debug @gol
470 -finstrument-functions @gol
471 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
472 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}}
474 @item Preprocessor Options
475 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
476 @gccoptlist{-A@var{question}=@var{answer} @gol
477 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
478 -C  -CC  -D@var{macro}@r{[}=@var{defn}@r{]} @gol
479 -dD  -dI  -dM  -dN  -dU @gol
480 -fdebug-cpp  -fdirectives-only  -fdollars-in-identifiers  @gol
481 -fexec-charset=@var{charset}  -fextended-identifiers  @gol
482 -finput-charset=@var{charset}  -fno-canonical-system-headers @gol
483 -fpch-deps  -fpch-preprocess  -fpreprocessed @gol
484 -ftabstop=@var{width}  -ftrack-macro-expansion  @gol
485 -fwide-exec-charset=@var{charset}  -fworking-directory @gol
486 -H  -imacros @var{file}  -include @var{file} @gol
487 -M  -MD  -MF  -MG  -MM  -MMD  -MP  -MQ  -MT @gol
488 -no-integrated-cpp  -P  -pthread  -remap @gol
489 -traditional  -traditional-cpp  -trigraphs @gol
490 -U@var{macro}  -undef  @gol
491 -Wp,@var{option}  -Xpreprocessor @var{option}}
493 @item Assembler Options
494 @xref{Assembler Options,,Passing Options to the Assembler}.
495 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
497 @item Linker Options
498 @xref{Link Options,,Options for Linking}.
499 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker}  -l@var{library} @gol
500 -nostartfiles  -nodefaultlibs  -nostdlib  -pie  -pthread  -rdynamic @gol
501 -s  -static -static-pie -static-libgcc  -static-libstdc++ @gol
502 -static-libasan  -static-libtsan  -static-liblsan  -static-libubsan @gol
503 -static-libmpx  -static-libmpxwrappers @gol
504 -shared  -shared-libgcc  -symbolic @gol
505 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
506 -u @var{symbol}  -z @var{keyword}}
508 @item Directory Options
509 @xref{Directory Options,,Options for Directory Search}.
510 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I- @gol
511 -idirafter @var{dir} @gol
512 -imacros @var{file}  -imultilib @var{dir} @gol
513 -iplugindir=@var{dir}  -iprefix @var{file} @gol
514 -iquote @var{dir}  -isysroot @var{dir}  -isystem @var{dir} @gol
515 -iwithprefix @var{dir}  -iwithprefixbefore @var{dir}  @gol
516 -L@var{dir}  -no-canonical-prefixes  --no-sysroot-suffix @gol
517 -nostdinc  -nostdinc++  --sysroot=@var{dir}}
519 @item Code Generation Options
520 @xref{Code Gen Options,,Options for Code Generation Conventions}.
521 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
522 -ffixed-@var{reg}  -fexceptions @gol
523 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
524 -fasynchronous-unwind-tables @gol
525 -fno-gnu-unique @gol
526 -finhibit-size-directive  -fno-common  -fno-ident @gol
527 -fpcc-struct-return  -fpic  -fPIC  -fpie  -fPIE  -fno-plt @gol
528 -fno-jump-tables @gol
529 -frecord-gcc-switches @gol
530 -freg-struct-return  -fshort-enums  -fshort-wchar @gol
531 -fverbose-asm  -fpack-struct[=@var{n}]  @gol
532 -fleading-underscore  -ftls-model=@var{model} @gol
533 -fstack-reuse=@var{reuse_level} @gol
534 -ftrampolines  -ftrapv  -fwrapv @gol
535 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
536 -fstrict-volatile-bitfields  -fsync-libcalls}
538 @item Developer Options
539 @xref{Developer Options,,GCC Developer Options}.
540 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
541 -dumpfullversion  -fchecking  -fchecking=@var{n}  -fdbg-cnt-list @gol
542 -fdbg-cnt=@var{counter-value-list} @gol
543 -fdisable-ipa-@var{pass_name} @gol
544 -fdisable-rtl-@var{pass_name} @gol
545 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
546 -fdisable-tree-@var{pass_name} @gol
547 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
548 -fdump-noaddr  -fdump-unnumbered  -fdump-unnumbered-links @gol
549 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
550 -fdump-final-insns@r{[}=@var{file}@r{]}
551 -fdump-ipa-all  -fdump-ipa-cgraph  -fdump-ipa-inline @gol
552 -fdump-lang-all @gol
553 -fdump-lang-@var{switch} @gol
554 -fdump-lang-@var{switch}-@var{options} @gol
555 -fdump-lang-@var{switch}-@var{options}=@var{filename} @gol
556 -fdump-passes @gol
557 -fdump-rtl-@var{pass}  -fdump-rtl-@var{pass}=@var{filename} @gol
558 -fdump-statistics @gol
559 -fdump-tree-all @gol
560 -fdump-tree-@var{switch} @gol
561 -fdump-tree-@var{switch}-@var{options} @gol
562 -fdump-tree-@var{switch}-@var{options}=@var{filename} @gol
563 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
564 -fenable-@var{kind}-@var{pass} @gol
565 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
566 -fira-verbose=@var{n} @gol
567 -flto-report  -flto-report-wpa  -fmem-report-wpa @gol
568 -fmem-report  -fpre-ipa-mem-report  -fpost-ipa-mem-report @gol
569 -fopt-info  -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
570 -fprofile-report @gol
571 -frandom-seed=@var{string}  -fsched-verbose=@var{n} @gol
572 -fsel-sched-verbose  -fsel-sched-dump-cfg  -fsel-sched-pipelining-verbose @gol
573 -fstats  -fstack-usage  -ftime-report  -ftime-report-details @gol
574 -fvar-tracking-assignments-toggle  -gtoggle @gol
575 -print-file-name=@var{library}  -print-libgcc-file-name @gol
576 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
577 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
578 -print-sysroot  -print-sysroot-headers-suffix @gol
579 -save-temps  -save-temps=cwd  -save-temps=obj  -time@r{[}=@var{file}@r{]}}
581 @item Machine-Dependent Options
582 @xref{Submodel Options,,Machine-Dependent Options}.
583 @c This list is ordered alphanumerically by subsection name.
584 @c Try and put the significant identifier (CPU or system) first,
585 @c so users have a clue at guessing where the ones they want will be.
587 @emph{AArch64 Options}
588 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
589 -mgeneral-regs-only @gol
590 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
591 -mstrict-align @gol
592 -momit-leaf-frame-pointer @gol
593 -mtls-dialect=desc  -mtls-dialect=traditional @gol
594 -mtls-size=@var{size} @gol
595 -mfix-cortex-a53-835769  -mfix-cortex-a53-843419 @gol
596 -mlow-precision-recip-sqrt  -mlow-precision-sqrt  -mlow-precision-div @gol
597 -mpc-relative-literal-loads @gol
598 -msign-return-address=@var{scope} @gol
599 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}  -moverride=@var{string}}
601 @emph{Adapteva Epiphany Options}
602 @gccoptlist{-mhalf-reg-file  -mprefer-short-insn-regs @gol
603 -mbranch-cost=@var{num}  -mcmove  -mnops=@var{num}  -msoft-cmpsf @gol
604 -msplit-lohi  -mpost-inc  -mpost-modify  -mstack-offset=@var{num} @gol
605 -mround-nearest  -mlong-calls  -mshort-calls  -msmall16 @gol
606 -mfp-mode=@var{mode}  -mvect-double  -max-vect-align=@var{num} @gol
607 -msplit-vecmove-early  -m1reg-@var{reg}}
609 @emph{ARC Options}
610 @gccoptlist{-mbarrel-shifter @gol
611 -mcpu=@var{cpu}  -mA6  -mARC600  -mA7  -mARC700 @gol
612 -mdpfp  -mdpfp-compact  -mdpfp-fast  -mno-dpfp-lrsr @gol
613 -mea  -mno-mpy  -mmul32x16  -mmul64  -matomic @gol
614 -mnorm  -mspfp  -mspfp-compact  -mspfp-fast  -msimd  -msoft-float  -mswap @gol
615 -mcrc  -mdsp-packa  -mdvbf  -mlock  -mmac-d16  -mmac-24  -mrtsc  -mswape @gol
616 -mtelephony  -mxy  -misize  -mannotate-align  -marclinux  -marclinux_prof @gol
617 -mlong-calls  -mmedium-calls  -msdata -mirq-ctrl-saved @gol
618 -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} @gol
619 -mvolatile-cache  -mtp-regno=@var{regno} @gol
620 -malign-call  -mauto-modify-reg  -mbbit-peephole  -mno-brcc @gol
621 -mcase-vector-pcrel  -mcompact-casesi  -mno-cond-exec  -mearly-cbranchsi @gol
622 -mexpand-adddi  -mindexed-loads  -mlra  -mlra-priority-none @gol
623 -mlra-priority-compact mlra-priority-noncompact  -mno-millicode @gol
624 -mmixed-code  -mq-class  -mRcq  -mRcw  -msize-level=@var{level} @gol
625 -mtune=@var{cpu}  -mmultcost=@var{num} @gol
626 -munalign-prob-threshold=@var{probability}  -mmpy-option=@var{multo} @gol
627 -mdiv-rem  -mcode-density  -mll64  -mfpu=@var{fpu}}
629 @emph{ARM Options}
630 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
631 -mabi=@var{name} @gol
632 -mapcs-stack-check  -mno-apcs-stack-check @gol
633 -mapcs-reentrant  -mno-apcs-reentrant @gol
634 -msched-prolog  -mno-sched-prolog @gol
635 -mlittle-endian  -mbig-endian @gol
636 -mbe8 -mbe32 @gol
637 -mfloat-abi=@var{name} @gol
638 -mfp16-format=@var{name}
639 -mthumb-interwork  -mno-thumb-interwork @gol
640 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
641 -mtune=@var{name}  -mprint-tune-info @gol
642 -mstructure-size-boundary=@var{n} @gol
643 -mabort-on-noreturn @gol
644 -mlong-calls  -mno-long-calls @gol
645 -msingle-pic-base  -mno-single-pic-base @gol
646 -mpic-register=@var{reg} @gol
647 -mnop-fun-dllimport @gol
648 -mpoke-function-name @gol
649 -mthumb  -marm @gol
650 -mtpcs-frame  -mtpcs-leaf-frame @gol
651 -mcaller-super-interworking  -mcallee-super-interworking @gol
652 -mtp=@var{name}  -mtls-dialect=@var{dialect} @gol
653 -mword-relocations @gol
654 -mfix-cortex-m3-ldrd @gol
655 -munaligned-access @gol
656 -mneon-for-64bits @gol
657 -mslow-flash-data @gol
658 -masm-syntax-unified @gol
659 -mrestrict-it @gol
660 -mpure-code @gol
661 -mcmse}
663 @emph{AVR Options}
664 @gccoptlist{-mmcu=@var{mcu}  -mabsdata  -maccumulate-args @gol
665 -mbranch-cost=@var{cost} @gol
666 -mcall-prologues  -mgas-isr-prologues  -mint8 @gol
667 -mn_flash=@var{size}  -mno-interrupts @gol
668 -mrelax  -mrmw  -mstrict-X  -mtiny-stack  -mfract-convert-truncate @gol
669 -mshort-calls  -nodevicelib @gol
670 -Waddr-space-convert  -Wmisspelled-isr}
672 @emph{Blackfin Options}
673 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
674 -msim  -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
675 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
676 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
677 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
678 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
679 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
680 -mfast-fp  -minline-plt  -mmulticore  -mcorea  -mcoreb  -msdram @gol
681 -micplb}
683 @emph{C6X Options}
684 @gccoptlist{-mbig-endian  -mlittle-endian  -march=@var{cpu} @gol
685 -msim  -msdata=@var{sdata-type}}
687 @emph{CRIS Options}
688 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
689 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
690 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
691 -mstack-align  -mdata-align  -mconst-align @gol
692 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
693 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
694 -mmul-bug-workaround  -mno-mul-bug-workaround}
696 @emph{CR16 Options}
697 @gccoptlist{-mmac @gol
698 -mcr16cplus  -mcr16c @gol
699 -msim  -mint32  -mbit-ops
700 -mdata-model=@var{model}}
702 @emph{Darwin Options}
703 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
704 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
705 -client_name  -compatibility_version  -current_version @gol
706 -dead_strip @gol
707 -dependency-file  -dylib_file  -dylinker_install_name @gol
708 -dynamic  -dynamiclib  -exported_symbols_list @gol
709 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
710 -force_flat_namespace  -headerpad_max_install_names @gol
711 -iframework @gol
712 -image_base  -init  -install_name  -keep_private_externs @gol
713 -multi_module  -multiply_defined  -multiply_defined_unused @gol
714 -noall_load   -no_dead_strip_inits_and_terms @gol
715 -nofixprebinding  -nomultidefs  -noprebind  -noseglinkedit @gol
716 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
717 -private_bundle  -read_only_relocs  -sectalign @gol
718 -sectobjectsymbols  -whyload  -seg1addr @gol
719 -sectcreate  -sectobjectsymbols  -sectorder @gol
720 -segaddr  -segs_read_only_addr  -segs_read_write_addr @gol
721 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
722 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
723 -single_module  -static  -sub_library  -sub_umbrella @gol
724 -twolevel_namespace  -umbrella  -undefined @gol
725 -unexported_symbols_list  -weak_reference_mismatches @gol
726 -whatsloaded  -F  -gused  -gfull  -mmacosx-version-min=@var{version} @gol
727 -mkernel  -mone-byte-bool}
729 @emph{DEC Alpha Options}
730 @gccoptlist{-mno-fp-regs  -msoft-float @gol
731 -mieee  -mieee-with-inexact  -mieee-conformant @gol
732 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
733 -mtrap-precision=@var{mode}  -mbuild-constants @gol
734 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
735 -mbwx  -mmax  -mfix  -mcix @gol
736 -mfloat-vax  -mfloat-ieee @gol
737 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
738 -msmall-text  -mlarge-text @gol
739 -mmemory-latency=@var{time}}
741 @emph{FR30 Options}
742 @gccoptlist{-msmall-model  -mno-lsim}
744 @emph{FT32 Options}
745 @gccoptlist{-msim  -mlra  -mnodiv}
747 @emph{FRV Options}
748 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
749 -mhard-float  -msoft-float @gol
750 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
751 -mdouble  -mno-double @gol
752 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
753 -mfdpic  -minline-plt  -mgprel-ro  -multilib-library-pic @gol
754 -mlinked-fp  -mlong-calls  -malign-labels @gol
755 -mlibrary-pic  -macc-4  -macc-8 @gol
756 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
757 -moptimize-membar  -mno-optimize-membar @gol
758 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
759 -mvliw-branch  -mno-vliw-branch @gol
760 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
761 -mno-nested-cond-exec  -mtomcat-stats @gol
762 -mTLS  -mtls @gol
763 -mcpu=@var{cpu}}
765 @emph{GNU/Linux Options}
766 @gccoptlist{-mglibc  -muclibc  -mmusl  -mbionic  -mandroid @gol
767 -tno-android-cc  -tno-android-ld}
769 @emph{H8/300 Options}
770 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr  -mno-exr  -mint32  -malign-300}
772 @emph{HPPA Options}
773 @gccoptlist{-march=@var{architecture-type} @gol
774 -mcaller-copies  -mdisable-fpregs  -mdisable-indexing @gol
775 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
776 -mfixed-range=@var{register-range} @gol
777 -mjump-in-delay  -mlinker-opt  -mlong-calls @gol
778 -mlong-load-store  -mno-disable-fpregs @gol
779 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
780 -mno-jump-in-delay  -mno-long-load-store @gol
781 -mno-portable-runtime  -mno-soft-float @gol
782 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
783 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
784 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
785 -munix=@var{unix-std}  -nolibdld  -static  -threads}
787 @emph{IA-64 Options}
788 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
789 -mvolatile-asm-stop  -mregister-names  -msdata  -mno-sdata @gol
790 -mconstant-gp  -mauto-pic  -mfused-madd @gol
791 -minline-float-divide-min-latency @gol
792 -minline-float-divide-max-throughput @gol
793 -mno-inline-float-divide @gol
794 -minline-int-divide-min-latency @gol
795 -minline-int-divide-max-throughput  @gol
796 -mno-inline-int-divide @gol
797 -minline-sqrt-min-latency  -minline-sqrt-max-throughput @gol
798 -mno-inline-sqrt @gol
799 -mdwarf2-asm  -mearly-stop-bits @gol
800 -mfixed-range=@var{register-range}  -mtls-size=@var{tls-size} @gol
801 -mtune=@var{cpu-type}  -milp32  -mlp64 @gol
802 -msched-br-data-spec  -msched-ar-data-spec  -msched-control-spec @gol
803 -msched-br-in-data-spec  -msched-ar-in-data-spec  -msched-in-control-spec @gol
804 -msched-spec-ldc  -msched-spec-control-ldc @gol
805 -msched-prefer-non-data-spec-insns  -msched-prefer-non-control-spec-insns @gol
806 -msched-stop-bits-after-every-cycle  -msched-count-spec-in-critical-path @gol
807 -msel-sched-dont-check-control-spec  -msched-fp-mem-deps-zero-cost @gol
808 -msched-max-memory-insns-hard-limit  -msched-max-memory-insns=@var{max-insns}}
810 @emph{LM32 Options}
811 @gccoptlist{-mbarrel-shift-enabled  -mdivide-enabled  -mmultiply-enabled @gol
812 -msign-extend-enabled  -muser-enabled}
814 @emph{M32R/D Options}
815 @gccoptlist{-m32r2  -m32rx  -m32r @gol
816 -mdebug @gol
817 -malign-loops  -mno-align-loops @gol
818 -missue-rate=@var{number} @gol
819 -mbranch-cost=@var{number} @gol
820 -mmodel=@var{code-size-model-type} @gol
821 -msdata=@var{sdata-type} @gol
822 -mno-flush-func  -mflush-func=@var{name} @gol
823 -mno-flush-trap  -mflush-trap=@var{number} @gol
824 -G @var{num}}
826 @emph{M32C Options}
827 @gccoptlist{-mcpu=@var{cpu}  -msim  -memregs=@var{number}}
829 @emph{M680x0 Options}
830 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
831 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
832 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
833 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
834 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
835 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
836 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
837 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
838 -mxgot  -mno-xgot  -mlong-jump-table-offsets}
840 @emph{MCore Options}
841 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
842 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
843 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
844 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
845 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
847 @emph{MeP Options}
848 @gccoptlist{-mabsdiff  -mall-opts  -maverage  -mbased=@var{n}  -mbitops @gol
849 -mc=@var{n}  -mclip  -mconfig=@var{name}  -mcop  -mcop32  -mcop64  -mivc2 @gol
850 -mdc  -mdiv  -meb  -mel  -mio-volatile  -ml  -mleadz  -mm  -mminmax @gol
851 -mmult  -mno-opts  -mrepeat  -ms  -msatur  -msdram  -msim  -msimnovec  -mtf @gol
852 -mtiny=@var{n}}
854 @emph{MicroBlaze Options}
855 @gccoptlist{-msoft-float  -mhard-float  -msmall-divides  -mcpu=@var{cpu} @gol
856 -mmemcpy  -mxl-soft-mul  -mxl-soft-div  -mxl-barrel-shift @gol
857 -mxl-pattern-compare  -mxl-stack-check  -mxl-gp-opt  -mno-clearbss @gol
858 -mxl-multiply-high  -mxl-float-convert  -mxl-float-sqrt @gol
859 -mbig-endian  -mlittle-endian  -mxl-reorder  -mxl-mode-@var{app-model}}
861 @emph{MIPS Options}
862 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
863 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
864 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
865 -mips16  -mno-mips16  -mflip-mips16 @gol
866 -minterlink-compressed  -mno-interlink-compressed @gol
867 -minterlink-mips16  -mno-interlink-mips16 @gol
868 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
869 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
870 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
871 -mno-float  -msingle-float  -mdouble-float @gol
872 -modd-spreg  -mno-odd-spreg @gol
873 -mabs=@var{mode}  -mnan=@var{encoding} @gol
874 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
875 -mmcu  -mmno-mcu @gol
876 -meva  -mno-eva @gol
877 -mvirt  -mno-virt @gol
878 -mxpa  -mno-xpa @gol
879 -mmicromips  -mno-micromips @gol
880 -mmsa  -mno-msa @gol
881 -mfpu=@var{fpu-type} @gol
882 -msmartmips  -mno-smartmips @gol
883 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
884 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
885 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
886 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
887 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
888 -membedded-data  -mno-embedded-data @gol
889 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
890 -mcode-readable=@var{setting} @gol
891 -msplit-addresses  -mno-split-addresses @gol
892 -mexplicit-relocs  -mno-explicit-relocs @gol
893 -mcheck-zero-division  -mno-check-zero-division @gol
894 -mdivide-traps  -mdivide-breaks @gol
895 -mload-store-pairs  -mno-load-store-pairs @gol
896 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
897 -mmad  -mno-mad  -mimadd  -mno-imadd  -mfused-madd  -mno-fused-madd  -nocpp @gol
898 -mfix-24k  -mno-fix-24k @gol
899 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
900 -mfix-r10000  -mno-fix-r10000  -mfix-rm7000  -mno-fix-rm7000 @gol
901 -mfix-vr4120  -mno-fix-vr4120 @gol
902 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
903 -mflush-func=@var{func}  -mno-flush-func @gol
904 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
905 -mcompact-branches=@var{policy} @gol
906 -mfp-exceptions  -mno-fp-exceptions @gol
907 -mvr4130-align  -mno-vr4130-align  -msynci  -mno-synci @gol
908 -mlxc1-sxc1 -mno-lxc1-sxc1 -mmadd4 -mno-madd4 @gol
909 -mrelax-pic-calls  -mno-relax-pic-calls  -mmcount-ra-address @gol
910 -mframe-header-opt  -mno-frame-header-opt}
912 @emph{MMIX Options}
913 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
914 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
915 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
916 -mno-base-addresses  -msingle-exit  -mno-single-exit}
918 @emph{MN10300 Options}
919 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
920 -mno-am33  -mam33  -mam33-2  -mam34 @gol
921 -mtune=@var{cpu-type} @gol
922 -mreturn-pointer-on-d0 @gol
923 -mno-crt0  -mrelax  -mliw  -msetlb}
925 @emph{Moxie Options}
926 @gccoptlist{-meb  -mel  -mmul.x  -mno-crt0}
928 @emph{MSP430 Options}
929 @gccoptlist{-msim  -masm-hex  -mmcu=  -mcpu=  -mlarge  -msmall  -mrelax @gol
930 -mwarn-mcu @gol
931 -mcode-region=  -mdata-region= @gol
932 -msilicon-errata=  -msilicon-errata-warn= @gol
933 -mhwmult=  -minrt}
935 @emph{NDS32 Options}
936 @gccoptlist{-mbig-endian  -mlittle-endian @gol
937 -mreduced-regs  -mfull-regs @gol
938 -mcmov  -mno-cmov @gol
939 -mperf-ext  -mno-perf-ext @gol
940 -mv3push  -mno-v3push @gol
941 -m16bit  -mno-16bit @gol
942 -misr-vector-size=@var{num} @gol
943 -mcache-block-size=@var{num} @gol
944 -march=@var{arch} @gol
945 -mcmodel=@var{code-model} @gol
946 -mctor-dtor  -mrelax}
948 @emph{Nios II Options}
949 @gccoptlist{-G @var{num}  -mgpopt=@var{option}  -mgpopt  -mno-gpopt @gol
950 -mel  -meb @gol
951 -mno-bypass-cache  -mbypass-cache @gol
952 -mno-cache-volatile  -mcache-volatile @gol
953 -mno-fast-sw-div  -mfast-sw-div @gol
954 -mhw-mul  -mno-hw-mul  -mhw-mulx  -mno-hw-mulx  -mno-hw-div  -mhw-div @gol
955 -mcustom-@var{insn}=@var{N}  -mno-custom-@var{insn} @gol
956 -mcustom-fpu-cfg=@var{name} @gol
957 -mhal  -msmallc  -msys-crt0=@var{name}  -msys-lib=@var{name} @gol
958 -march=@var{arch}  -mbmx  -mno-bmx  -mcdx  -mno-cdx}
960 @emph{Nvidia PTX Options}
961 @gccoptlist{-m32  -m64  -mmainkernel  -moptimize}
963 @emph{PDP-11 Options}
964 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
965 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
966 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
967 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
968 -mbranch-expensive  -mbranch-cheap @gol
969 -munix-asm  -mdec-asm}
971 @emph{picoChip Options}
972 @gccoptlist{-mae=@var{ae_type}  -mvliw-lookahead=@var{N} @gol
973 -msymbol-as-address  -mno-inefficient-warnings}
975 @emph{PowerPC Options}
976 See RS/6000 and PowerPC Options.
978 @emph{RISC-V Options}
979 @gccoptlist{-mbranch-cost=@var{N-instruction} @gol
980 -mmemcpy  -mno-memcpy @gol
981 -mplt  -mno-plt @gol
982 -mabi=@var{ABI-string} @gol
983 -mfdiv  -mno-fdiv @gol
984 -mdiv  -mno-div @gol
985 -march=@var{ISA-string} @gol
986 -mtune=@var{processor-string} @gol
987 -msmall-data-limit=@var{N-bytes} @gol
988 -msave-restore  -mno-save-restore @gol
989 -mstrict-align -mno-strict-align @gol
990 -mcmodel=@var{code-model} @gol
991 -mexplicit-relocs  -mno-explicit-relocs @gol}
993 @emph{RL78 Options}
994 @gccoptlist{-msim  -mmul=none  -mmul=g13  -mmul=g14  -mallregs @gol
995 -mcpu=g10  -mcpu=g13  -mcpu=g14  -mg10  -mg13  -mg14 @gol
996 -m64bit-doubles  -m32bit-doubles  -msave-mduc-in-interrupts}
998 @emph{RS/6000 and PowerPC Options}
999 @gccoptlist{-mcpu=@var{cpu-type} @gol
1000 -mtune=@var{cpu-type} @gol
1001 -mcmodel=@var{code-model} @gol
1002 -mpowerpc64 @gol
1003 -maltivec  -mno-altivec @gol
1004 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
1005 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
1006 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mpopcntd  -mno-popcntd @gol
1007 -mfprnd  -mno-fprnd @gol
1008 -mcmpb  -mno-cmpb  -mmfpgpr  -mno-mfpgpr  -mhard-dfp  -mno-hard-dfp @gol
1009 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
1010 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
1011 -malign-power  -malign-natural @gol
1012 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
1013 -msingle-float  -mdouble-float  -msimple-fpu @gol
1014 -mstring  -mno-string  -mupdate  -mno-update @gol
1015 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
1016 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
1017 -mstrict-align  -mno-strict-align  -mrelocatable @gol
1018 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
1019 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
1020 -mdynamic-no-pic  -maltivec  -mswdiv  -msingle-pic-base @gol
1021 -mprioritize-restricted-insns=@var{priority} @gol
1022 -msched-costly-dep=@var{dependence_type} @gol
1023 -minsert-sched-nops=@var{scheme} @gol
1024 -mcall-sysv  -mcall-netbsd @gol
1025 -maix-struct-return  -msvr4-struct-return @gol
1026 -mabi=@var{abi-type}  -msecure-plt  -mbss-plt @gol
1027 -mblock-move-inline-limit=@var{num} @gol
1028 -misel  -mno-isel @gol
1029 -misel=yes  -misel=no @gol
1030 -mspe  -mno-spe @gol
1031 -mspe=yes  -mspe=no @gol
1032 -mpaired @gol
1033 -mvrsave  -mno-vrsave @gol
1034 -mmulhw  -mno-mulhw @gol
1035 -mdlmzb  -mno-dlmzb @gol
1036 -mfloat-gprs=yes  -mfloat-gprs=no  -mfloat-gprs=single  -mfloat-gprs=double @gol
1037 -mprototype  -mno-prototype @gol
1038 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
1039 -msdata=@var{opt}  -mvxworks  -G @var{num} @gol
1040 -mrecip  -mrecip=@var{opt}  -mno-recip  -mrecip-precision @gol
1041 -mno-recip-precision @gol
1042 -mveclibabi=@var{type}  -mfriz  -mno-friz @gol
1043 -mpointers-to-nested-functions  -mno-pointers-to-nested-functions @gol
1044 -msave-toc-indirect  -mno-save-toc-indirect @gol
1045 -mpower8-fusion  -mno-mpower8-fusion  -mpower8-vector  -mno-power8-vector @gol
1046 -mcrypto  -mno-crypto  -mhtm  -mno-htm  -mdirect-move  -mno-direct-move @gol
1047 -mquad-memory  -mno-quad-memory @gol
1048 -mquad-memory-atomic  -mno-quad-memory-atomic @gol
1049 -mcompat-align-parm  -mno-compat-align-parm @gol
1050 -mfloat128  -mno-float128  -mfloat128-hardware  -mno-float128-hardware @gol
1051 -mgnu-attribute  -mno-gnu-attribute @gol
1052 -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} @gol
1053 -mstack-protector-guard-offset=@var{offset}}
1055 @emph{RX Options}
1056 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
1057 -mcpu=@gol
1058 -mbig-endian-data  -mlittle-endian-data @gol
1059 -msmall-data @gol
1060 -msim  -mno-sim@gol
1061 -mas100-syntax  -mno-as100-syntax@gol
1062 -mrelax@gol
1063 -mmax-constant-size=@gol
1064 -mint-register=@gol
1065 -mpid@gol
1066 -mallow-string-insns  -mno-allow-string-insns@gol
1067 -mjsr@gol
1068 -mno-warn-multiple-fast-interrupts@gol
1069 -msave-acc-in-interrupts}
1071 @emph{S/390 and zSeries Options}
1072 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1073 -mhard-float  -msoft-float  -mhard-dfp  -mno-hard-dfp @gol
1074 -mlong-double-64  -mlong-double-128 @gol
1075 -mbackchain  -mno-backchain  -mpacked-stack  -mno-packed-stack @gol
1076 -msmall-exec  -mno-small-exec  -mmvcle  -mno-mvcle @gol
1077 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
1078 -mhtm  -mvx  -mzvector @gol
1079 -mtpf-trace  -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
1080 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size  -mstack-guard @gol
1081 -mhotpatch=@var{halfwords},@var{halfwords}}
1083 @emph{Score Options}
1084 @gccoptlist{-meb  -mel @gol
1085 -mnhwloop @gol
1086 -muls @gol
1087 -mmac @gol
1088 -mscore5  -mscore5u  -mscore7  -mscore7d}
1090 @emph{SH Options}
1091 @gccoptlist{-m1  -m2  -m2e @gol
1092 -m2a-nofpu  -m2a-single-only  -m2a-single  -m2a @gol
1093 -m3  -m3e @gol
1094 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
1095 -m4a-nofpu  -m4a-single-only  -m4a-single  -m4a  -m4al @gol
1096 -mb  -ml  -mdalign  -mrelax @gol
1097 -mbigtable  -mfmovd  -mrenesas  -mno-renesas  -mnomacsave @gol
1098 -mieee  -mno-ieee  -mbitops  -misize  -minline-ic_invalidate  -mpadstruct @gol
1099 -mprefergot  -musermode  -multcost=@var{number}  -mdiv=@var{strategy} @gol
1100 -mdivsi3_libfunc=@var{name}  -mfixed-range=@var{register-range} @gol
1101 -maccumulate-outgoing-args @gol
1102 -matomic-model=@var{atomic-model} @gol
1103 -mbranch-cost=@var{num}  -mzdcbranch  -mno-zdcbranch @gol
1104 -mcbranch-force-delay-slot @gol
1105 -mfused-madd  -mno-fused-madd  -mfsca  -mno-fsca  -mfsrra  -mno-fsrra @gol
1106 -mpretend-cmove  -mtas}
1108 @emph{Solaris 2 Options}
1109 @gccoptlist{-mclear-hwcap  -mno-clear-hwcap  -mimpure-text  -mno-impure-text @gol
1110 -pthreads}
1112 @emph{SPARC Options}
1113 @gccoptlist{-mcpu=@var{cpu-type} @gol
1114 -mtune=@var{cpu-type} @gol
1115 -mcmodel=@var{code-model} @gol
1116 -mmemory-model=@var{mem-model} @gol
1117 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1118 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1119 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1120 -mhard-quad-float  -msoft-quad-float @gol
1121 -mstack-bias  -mno-stack-bias @gol
1122 -mstd-struct-return  -mno-std-struct-return @gol
1123 -munaligned-doubles  -mno-unaligned-doubles @gol
1124 -muser-mode  -mno-user-mode @gol
1125 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1126 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1127 -mvis4 -mno-vis4 -mvis4b -mno-vis4b @gol
1128 -mcbcond  -mno-cbcond  -mfmaf  -mno-fmaf  -mfsmuld  -mno-fsmuld  @gol
1129 -mpopc  -mno-popc  -msubxc  -mno-subxc @gol
1130 -mfix-at697f  -mfix-ut699  -mfix-ut700  -mfix-gr712rc @gol
1131 -mlra  -mno-lra}
1133 @emph{SPU Options}
1134 @gccoptlist{-mwarn-reloc  -merror-reloc @gol
1135 -msafe-dma  -munsafe-dma @gol
1136 -mbranch-hints @gol
1137 -msmall-mem  -mlarge-mem  -mstdmain @gol
1138 -mfixed-range=@var{register-range} @gol
1139 -mea32  -mea64 @gol
1140 -maddress-space-conversion  -mno-address-space-conversion @gol
1141 -mcache-size=@var{cache-size} @gol
1142 -matomic-updates  -mno-atomic-updates}
1144 @emph{System V Options}
1145 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1147 @emph{TILE-Gx Options}
1148 @gccoptlist{-mcpu=CPU  -m32  -m64  -mbig-endian  -mlittle-endian @gol
1149 -mcmodel=@var{code-model}}
1151 @emph{TILEPro Options}
1152 @gccoptlist{-mcpu=@var{cpu}  -m32}
1154 @emph{V850 Options}
1155 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1156 -mprolog-function  -mno-prolog-function  -mspace @gol
1157 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1158 -mapp-regs  -mno-app-regs @gol
1159 -mdisable-callt  -mno-disable-callt @gol
1160 -mv850e2v3  -mv850e2  -mv850e1  -mv850es @gol
1161 -mv850e  -mv850  -mv850e3v5 @gol
1162 -mloop @gol
1163 -mrelax @gol
1164 -mlong-jumps @gol
1165 -msoft-float @gol
1166 -mhard-float @gol
1167 -mgcc-abi @gol
1168 -mrh850-abi @gol
1169 -mbig-switch}
1171 @emph{VAX Options}
1172 @gccoptlist{-mg  -mgnu  -munix}
1174 @emph{Visium Options}
1175 @gccoptlist{-mdebug  -msim  -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1176 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type}  -msv-mode  -muser-mode}
1178 @emph{VMS Options}
1179 @gccoptlist{-mvms-return-codes  -mdebug-main=@var{prefix}  -mmalloc64 @gol
1180 -mpointer-size=@var{size}}
1182 @emph{VxWorks Options}
1183 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1184 -Xbind-lazy  -Xbind-now}
1186 @emph{x86 Options}
1187 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1188 -mtune-ctrl=@var{feature-list}  -mdump-tune-features  -mno-default @gol
1189 -mfpmath=@var{unit} @gol
1190 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1191 -mno-fp-ret-in-387  -m80387  -mhard-float  -msoft-float @gol
1192 -mno-wide-multiply  -mrtd  -malign-double @gol
1193 -mpreferred-stack-boundary=@var{num} @gol
1194 -mincoming-stack-boundary=@var{num} @gol
1195 -mcld  -mcx16  -msahf  -mmovbe  -mcrc32 @gol
1196 -mrecip  -mrecip=@var{opt} @gol
1197 -mvzeroupper  -mprefer-avx128 @gol
1198 -mmmx  -msse  -msse2  -msse3  -mssse3  -msse4.1  -msse4.2  -msse4  -mavx @gol
1199 -mavx2  -mavx512f  -mavx512pf  -mavx512er  -mavx512cd  -mavx512vl @gol
1200 -mavx512bw  -mavx512dq  -mavx512ifma  -mavx512vbmi  -msha  -maes @gol
1201 -mpclmul  -mfsgsbase  -mrdrnd  -mf16c  -mfma @gol
1202 -mprefetchwt1  -mclflushopt  -mxsavec  -mxsaves @gol
1203 -msse4a  -m3dnow  -m3dnowa  -mpopcnt  -mabm  -mbmi  -mtbm  -mfma4  -mxop @gol
1204 -mlzcnt  -mbmi2  -mfxsr  -mxsave  -mxsaveopt  -mrtm  -mlwp  -mmpx  @gol
1205 -mmwaitx  -mclzero  -mpku  -mthreads @gol
1206 -mms-bitfields  -mno-align-stringops  -minline-all-stringops @gol
1207 -minline-stringops-dynamically  -mstringop-strategy=@var{alg} @gol
1208 -mmemcpy-strategy=@var{strategy}  -mmemset-strategy=@var{strategy} @gol
1209 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1210 -m96bit-long-double  -mlong-double-64  -mlong-double-80  -mlong-double-128 @gol
1211 -mregparm=@var{num}  -msseregparm @gol
1212 -mveclibabi=@var{type}  -mvect8-ret-in-mem @gol
1213 -mpc32  -mpc64  -mpc80  -mstackrealign @gol
1214 -momit-leaf-frame-pointer  -mno-red-zone  -mno-tls-direct-seg-refs @gol
1215 -mcmodel=@var{code-model}  -mabi=@var{name}  -maddress-mode=@var{mode} @gol
1216 -m32  -m64  -mx32  -m16  -miamcu  -mlarge-data-threshold=@var{num} @gol
1217 -msse2avx  -mfentry  -mrecord-mcount  -mnop-mcount  -m8bit-idiv @gol
1218 -mavx256-split-unaligned-load  -mavx256-split-unaligned-store @gol
1219 -malign-data=@var{type}  -mstack-protector-guard=@var{guard} @gol
1220 -mstack-protector-guard-reg=@var{reg} @gol
1221 -mstack-protector-guard-offset=@var{offset} @gol
1222 -mstack-protector-guard-symbol=@var{symbol} -mmitigate-rop @gol
1223 -mgeneral-regs-only  -mcall-ms2sysv-xlogues}
1225 @emph{x86 Windows Options}
1226 @gccoptlist{-mconsole  -mcygwin  -mno-cygwin  -mdll @gol
1227 -mnop-fun-dllimport  -mthread @gol
1228 -municode  -mwin32  -mwindows  -fno-set-stack-executable}
1230 @emph{Xstormy16 Options}
1231 @gccoptlist{-msim}
1233 @emph{Xtensa Options}
1234 @gccoptlist{-mconst16  -mno-const16 @gol
1235 -mfused-madd  -mno-fused-madd @gol
1236 -mforce-no-pic @gol
1237 -mserialize-volatile  -mno-serialize-volatile @gol
1238 -mtext-section-literals  -mno-text-section-literals @gol
1239 -mauto-litpools  -mno-auto-litpools @gol
1240 -mtarget-align  -mno-target-align @gol
1241 -mlongcalls  -mno-longcalls}
1243 @emph{zSeries Options}
1244 See S/390 and zSeries Options.
1245 @end table
1248 @node Overall Options
1249 @section Options Controlling the Kind of Output
1251 Compilation can involve up to four stages: preprocessing, compilation
1252 proper, assembly and linking, always in that order.  GCC is capable of
1253 preprocessing and compiling several files either into several
1254 assembler input files, or into one assembler input file; then each
1255 assembler input file produces an object file, and linking combines all
1256 the object files (those newly compiled, and those specified as input)
1257 into an executable file.
1259 @cindex file name suffix
1260 For any given input file, the file name suffix determines what kind of
1261 compilation is done:
1263 @table @gcctabopt
1264 @item @var{file}.c
1265 C source code that must be preprocessed.
1267 @item @var{file}.i
1268 C source code that should not be preprocessed.
1270 @item @var{file}.ii
1271 C++ source code that should not be preprocessed.
1273 @item @var{file}.m
1274 Objective-C source code.  Note that you must link with the @file{libobjc}
1275 library to make an Objective-C program work.
1277 @item @var{file}.mi
1278 Objective-C source code that should not be preprocessed.
1280 @item @var{file}.mm
1281 @itemx @var{file}.M
1282 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1283 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1284 to a literal capital M@.
1286 @item @var{file}.mii
1287 Objective-C++ source code that should not be preprocessed.
1289 @item @var{file}.h
1290 C, C++, Objective-C or Objective-C++ header file to be turned into a
1291 precompiled header (default), or C, C++ header file to be turned into an
1292 Ada spec (via the @option{-fdump-ada-spec} switch).
1294 @item @var{file}.cc
1295 @itemx @var{file}.cp
1296 @itemx @var{file}.cxx
1297 @itemx @var{file}.cpp
1298 @itemx @var{file}.CPP
1299 @itemx @var{file}.c++
1300 @itemx @var{file}.C
1301 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1302 the last two letters must both be literally @samp{x}.  Likewise,
1303 @samp{.C} refers to a literal capital C@.
1305 @item @var{file}.mm
1306 @itemx @var{file}.M
1307 Objective-C++ source code that must be preprocessed.
1309 @item @var{file}.mii
1310 Objective-C++ source code that should not be preprocessed.
1312 @item @var{file}.hh
1313 @itemx @var{file}.H
1314 @itemx @var{file}.hp
1315 @itemx @var{file}.hxx
1316 @itemx @var{file}.hpp
1317 @itemx @var{file}.HPP
1318 @itemx @var{file}.h++
1319 @itemx @var{file}.tcc
1320 C++ header file to be turned into a precompiled header or Ada spec.
1322 @item @var{file}.f
1323 @itemx @var{file}.for
1324 @itemx @var{file}.ftn
1325 Fixed form Fortran source code that should not be preprocessed.
1327 @item @var{file}.F
1328 @itemx @var{file}.FOR
1329 @itemx @var{file}.fpp
1330 @itemx @var{file}.FPP
1331 @itemx @var{file}.FTN
1332 Fixed form Fortran source code that must be preprocessed (with the traditional
1333 preprocessor).
1335 @item @var{file}.f90
1336 @itemx @var{file}.f95
1337 @itemx @var{file}.f03
1338 @itemx @var{file}.f08
1339 Free form Fortran source code that should not be preprocessed.
1341 @item @var{file}.F90
1342 @itemx @var{file}.F95
1343 @itemx @var{file}.F03
1344 @itemx @var{file}.F08
1345 Free form Fortran source code that must be preprocessed (with the
1346 traditional preprocessor).
1348 @item @var{file}.go
1349 Go source code.
1351 @item @var{file}.brig
1352 BRIG files (binary representation of HSAIL).
1354 @item @var{file}.ads
1355 Ada source code file that contains a library unit declaration (a
1356 declaration of a package, subprogram, or generic, or a generic
1357 instantiation), or a library unit renaming declaration (a package,
1358 generic, or subprogram renaming declaration).  Such files are also
1359 called @dfn{specs}.
1361 @item @var{file}.adb
1362 Ada source code file containing a library unit body (a subprogram or
1363 package body).  Such files are also called @dfn{bodies}.
1365 @c GCC also knows about some suffixes for languages not yet included:
1366 @c Pascal:
1367 @c @var{file}.p
1368 @c @var{file}.pas
1369 @c Ratfor:
1370 @c @var{file}.r
1372 @item @var{file}.s
1373 Assembler code.
1375 @item @var{file}.S
1376 @itemx @var{file}.sx
1377 Assembler code that must be preprocessed.
1379 @item @var{other}
1380 An object file to be fed straight into linking.
1381 Any file name with no recognized suffix is treated this way.
1382 @end table
1384 @opindex x
1385 You can specify the input language explicitly with the @option{-x} option:
1387 @table @gcctabopt
1388 @item -x @var{language}
1389 Specify explicitly the @var{language} for the following input files
1390 (rather than letting the compiler choose a default based on the file
1391 name suffix).  This option applies to all following input files until
1392 the next @option{-x} option.  Possible values for @var{language} are:
1393 @smallexample
1394 c  c-header  cpp-output
1395 c++  c++-header  c++-cpp-output
1396 objective-c  objective-c-header  objective-c-cpp-output
1397 objective-c++ objective-c++-header objective-c++-cpp-output
1398 assembler  assembler-with-cpp
1400 f77  f77-cpp-input f95  f95-cpp-input
1402 brig
1403 @end smallexample
1405 @item -x none
1406 Turn off any specification of a language, so that subsequent files are
1407 handled according to their file name suffixes (as they are if @option{-x}
1408 has not been used at all).
1409 @end table
1411 If you only want some of the stages of compilation, you can use
1412 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1413 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1414 @command{gcc} is to stop.  Note that some combinations (for example,
1415 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1417 @table @gcctabopt
1418 @item -c
1419 @opindex c
1420 Compile or assemble the source files, but do not link.  The linking
1421 stage simply is not done.  The ultimate output is in the form of an
1422 object file for each source file.
1424 By default, the object file name for a source file is made by replacing
1425 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1427 Unrecognized input files, not requiring compilation or assembly, are
1428 ignored.
1430 @item -S
1431 @opindex S
1432 Stop after the stage of compilation proper; do not assemble.  The output
1433 is in the form of an assembler code file for each non-assembler input
1434 file specified.
1436 By default, the assembler file name for a source file is made by
1437 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1439 Input files that don't require compilation are ignored.
1441 @item -E
1442 @opindex E
1443 Stop after the preprocessing stage; do not run the compiler proper.  The
1444 output is in the form of preprocessed source code, which is sent to the
1445 standard output.
1447 Input files that don't require preprocessing are ignored.
1449 @cindex output file option
1450 @item -o @var{file}
1451 @opindex o
1452 Place output in file @var{file}.  This applies to whatever
1453 sort of output is being produced, whether it be an executable file,
1454 an object file, an assembler file or preprocessed C code.
1456 If @option{-o} is not specified, the default is to put an executable
1457 file in @file{a.out}, the object file for
1458 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1459 assembler file in @file{@var{source}.s}, a precompiled header file in
1460 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1461 standard output.
1463 @item -v
1464 @opindex v
1465 Print (on standard error output) the commands executed to run the stages
1466 of compilation.  Also print the version number of the compiler driver
1467 program and of the preprocessor and the compiler proper.
1469 @item -###
1470 @opindex ###
1471 Like @option{-v} except the commands are not executed and arguments
1472 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1473 This is useful for shell scripts to capture the driver-generated command lines.
1475 @item --help
1476 @opindex help
1477 Print (on the standard output) a description of the command-line options
1478 understood by @command{gcc}.  If the @option{-v} option is also specified
1479 then @option{--help} is also passed on to the various processes
1480 invoked by @command{gcc}, so that they can display the command-line options
1481 they accept.  If the @option{-Wextra} option has also been specified
1482 (prior to the @option{--help} option), then command-line options that
1483 have no documentation associated with them are also displayed.
1485 @item --target-help
1486 @opindex target-help
1487 Print (on the standard output) a description of target-specific command-line
1488 options for each tool.  For some targets extra target-specific
1489 information may also be printed.
1491 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1492 Print (on the standard output) a description of the command-line
1493 options understood by the compiler that fit into all specified classes
1494 and qualifiers.  These are the supported classes:
1496 @table @asis
1497 @item @samp{optimizers}
1498 Display all of the optimization options supported by the
1499 compiler.
1501 @item @samp{warnings}
1502 Display all of the options controlling warning messages
1503 produced by the compiler.
1505 @item @samp{target}
1506 Display target-specific options.  Unlike the
1507 @option{--target-help} option however, target-specific options of the
1508 linker and assembler are not displayed.  This is because those
1509 tools do not currently support the extended @option{--help=} syntax.
1511 @item @samp{params}
1512 Display the values recognized by the @option{--param}
1513 option.
1515 @item @var{language}
1516 Display the options supported for @var{language}, where
1517 @var{language} is the name of one of the languages supported in this
1518 version of GCC@.
1520 @item @samp{common}
1521 Display the options that are common to all languages.
1522 @end table
1524 These are the supported qualifiers:
1526 @table @asis
1527 @item @samp{undocumented}
1528 Display only those options that are undocumented.
1530 @item @samp{joined}
1531 Display options taking an argument that appears after an equal
1532 sign in the same continuous piece of text, such as:
1533 @samp{--help=target}.
1535 @item @samp{separate}
1536 Display options taking an argument that appears as a separate word
1537 following the original option, such as: @samp{-o output-file}.
1538 @end table
1540 Thus for example to display all the undocumented target-specific
1541 switches supported by the compiler, use:
1543 @smallexample
1544 --help=target,undocumented
1545 @end smallexample
1547 The sense of a qualifier can be inverted by prefixing it with the
1548 @samp{^} character, so for example to display all binary warning
1549 options (i.e., ones that are either on or off and that do not take an
1550 argument) that have a description, use:
1552 @smallexample
1553 --help=warnings,^joined,^undocumented
1554 @end smallexample
1556 The argument to @option{--help=} should not consist solely of inverted
1557 qualifiers.
1559 Combining several classes is possible, although this usually
1560 restricts the output so much that there is nothing to display.  One
1561 case where it does work, however, is when one of the classes is
1562 @var{target}.  For example, to display all the target-specific
1563 optimization options, use:
1565 @smallexample
1566 --help=target,optimizers
1567 @end smallexample
1569 The @option{--help=} option can be repeated on the command line.  Each
1570 successive use displays its requested class of options, skipping
1571 those that have already been displayed.
1573 If the @option{-Q} option appears on the command line before the
1574 @option{--help=} option, then the descriptive text displayed by
1575 @option{--help=} is changed.  Instead of describing the displayed
1576 options, an indication is given as to whether the option is enabled,
1577 disabled or set to a specific value (assuming that the compiler
1578 knows this at the point where the @option{--help=} option is used).
1580 Here is a truncated example from the ARM port of @command{gcc}:
1582 @smallexample
1583   % gcc -Q -mabi=2 --help=target -c
1584   The following options are target specific:
1585   -mabi=                                2
1586   -mabort-on-noreturn                   [disabled]
1587   -mapcs                                [disabled]
1588 @end smallexample
1590 The output is sensitive to the effects of previous command-line
1591 options, so for example it is possible to find out which optimizations
1592 are enabled at @option{-O2} by using:
1594 @smallexample
1595 -Q -O2 --help=optimizers
1596 @end smallexample
1598 Alternatively you can discover which binary optimizations are enabled
1599 by @option{-O3} by using:
1601 @smallexample
1602 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1603 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1604 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1605 @end smallexample
1607 @item --version
1608 @opindex version
1609 Display the version number and copyrights of the invoked GCC@.
1611 @item -pass-exit-codes
1612 @opindex pass-exit-codes
1613 Normally the @command{gcc} program exits with the code of 1 if any
1614 phase of the compiler returns a non-success return code.  If you specify
1615 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1616 the numerically highest error produced by any phase returning an error
1617 indication.  The C, C++, and Fortran front ends return 4 if an internal
1618 compiler error is encountered.
1620 @item -pipe
1621 @opindex pipe
1622 Use pipes rather than temporary files for communication between the
1623 various stages of compilation.  This fails to work on some systems where
1624 the assembler is unable to read from a pipe; but the GNU assembler has
1625 no trouble.
1627 @item -specs=@var{file}
1628 @opindex specs
1629 Process @var{file} after the compiler reads in the standard @file{specs}
1630 file, in order to override the defaults which the @command{gcc} driver
1631 program uses when determining what switches to pass to @command{cc1},
1632 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
1633 @option{-specs=@var{file}} can be specified on the command line, and they
1634 are processed in order, from left to right.  @xref{Spec Files}, for
1635 information about the format of the @var{file}.
1637 @item -wrapper
1638 @opindex wrapper
1639 Invoke all subcommands under a wrapper program.  The name of the
1640 wrapper program and its parameters are passed as a comma separated
1641 list.
1643 @smallexample
1644 gcc -c t.c -wrapper gdb,--args
1645 @end smallexample
1647 @noindent
1648 This invokes all subprograms of @command{gcc} under
1649 @samp{gdb --args}, thus the invocation of @command{cc1} is
1650 @samp{gdb --args cc1 @dots{}}.
1652 @item -fplugin=@var{name}.so
1653 @opindex fplugin
1654 Load the plugin code in file @var{name}.so, assumed to be a
1655 shared object to be dlopen'd by the compiler.  The base name of
1656 the shared object file is used to identify the plugin for the
1657 purposes of argument parsing (See
1658 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1659 Each plugin should define the callback functions specified in the
1660 Plugins API.
1662 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1663 @opindex fplugin-arg
1664 Define an argument called @var{key} with a value of @var{value}
1665 for the plugin called @var{name}.
1667 @item -fdump-ada-spec@r{[}-slim@r{]}
1668 @opindex fdump-ada-spec
1669 For C and C++ source and include files, generate corresponding Ada specs.
1670 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1671 GNAT User's Guide}, which provides detailed documentation on this feature.
1673 @item -fada-spec-parent=@var{unit}
1674 @opindex fada-spec-parent
1675 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1676 Ada specs as child units of parent @var{unit}.
1678 @item -fdump-go-spec=@var{file}
1679 @opindex fdump-go-spec
1680 For input files in any language, generate corresponding Go
1681 declarations in @var{file}.  This generates Go @code{const},
1682 @code{type}, @code{var}, and @code{func} declarations which may be a
1683 useful way to start writing a Go interface to code written in some
1684 other language.
1686 @include @value{srcdir}/../libiberty/at-file.texi
1687 @end table
1689 @node Invoking G++
1690 @section Compiling C++ Programs
1692 @cindex suffixes for C++ source
1693 @cindex C++ source file suffixes
1694 C++ source files conventionally use one of the suffixes @samp{.C},
1695 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1696 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1697 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1698 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1699 files with these names and compiles them as C++ programs even if you
1700 call the compiler the same way as for compiling C programs (usually
1701 with the name @command{gcc}).
1703 @findex g++
1704 @findex c++
1705 However, the use of @command{gcc} does not add the C++ library.
1706 @command{g++} is a program that calls GCC and automatically specifies linking
1707 against the C++ library.  It treats @samp{.c},
1708 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1709 files unless @option{-x} is used.  This program is also useful when
1710 precompiling a C header file with a @samp{.h} extension for use in C++
1711 compilations.  On many systems, @command{g++} is also installed with
1712 the name @command{c++}.
1714 @cindex invoking @command{g++}
1715 When you compile C++ programs, you may specify many of the same
1716 command-line options that you use for compiling programs in any
1717 language; or command-line options meaningful for C and related
1718 languages; or options that are meaningful only for C++ programs.
1719 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1720 explanations of options for languages related to C@.
1721 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1722 explanations of options that are meaningful only for C++ programs.
1724 @node C Dialect Options
1725 @section Options Controlling C Dialect
1726 @cindex dialect options
1727 @cindex language dialect options
1728 @cindex options, dialect
1730 The following options control the dialect of C (or languages derived
1731 from C, such as C++, Objective-C and Objective-C++) that the compiler
1732 accepts:
1734 @table @gcctabopt
1735 @cindex ANSI support
1736 @cindex ISO support
1737 @item -ansi
1738 @opindex ansi
1739 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1740 equivalent to @option{-std=c++98}.
1742 This turns off certain features of GCC that are incompatible with ISO
1743 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1744 such as the @code{asm} and @code{typeof} keywords, and
1745 predefined macros such as @code{unix} and @code{vax} that identify the
1746 type of system you are using.  It also enables the undesirable and
1747 rarely used ISO trigraph feature.  For the C compiler,
1748 it disables recognition of C++ style @samp{//} comments as well as
1749 the @code{inline} keyword.
1751 The alternate keywords @code{__asm__}, @code{__extension__},
1752 @code{__inline__} and @code{__typeof__} continue to work despite
1753 @option{-ansi}.  You would not want to use them in an ISO C program, of
1754 course, but it is useful to put them in header files that might be included
1755 in compilations done with @option{-ansi}.  Alternate predefined macros
1756 such as @code{__unix__} and @code{__vax__} are also available, with or
1757 without @option{-ansi}.
1759 The @option{-ansi} option does not cause non-ISO programs to be
1760 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1761 addition to @option{-ansi}.  @xref{Warning Options}.
1763 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1764 option is used.  Some header files may notice this macro and refrain
1765 from declaring certain functions or defining certain macros that the
1766 ISO standard doesn't call for; this is to avoid interfering with any
1767 programs that might use these names for other things.
1769 Functions that are normally built in but do not have semantics
1770 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1771 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1772 built-in functions provided by GCC}, for details of the functions
1773 affected.
1775 @item -std=
1776 @opindex std
1777 Determine the language standard. @xref{Standards,,Language Standards
1778 Supported by GCC}, for details of these standard versions.  This option
1779 is currently only supported when compiling C or C++.
1781 The compiler can accept several base standards, such as @samp{c90} or
1782 @samp{c++98}, and GNU dialects of those standards, such as
1783 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1784 compiler accepts all programs following that standard plus those
1785 using GNU extensions that do not contradict it.  For example,
1786 @option{-std=c90} turns off certain features of GCC that are
1787 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1788 keywords, but not other GNU extensions that do not have a meaning in
1789 ISO C90, such as omitting the middle term of a @code{?:}
1790 expression. On the other hand, when a GNU dialect of a standard is
1791 specified, all features supported by the compiler are enabled, even when
1792 those features change the meaning of the base standard.  As a result, some
1793 strict-conforming programs may be rejected.  The particular standard
1794 is used by @option{-Wpedantic} to identify which features are GNU
1795 extensions given that version of the standard. For example
1796 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1797 comments, while @option{-std=gnu99 -Wpedantic} does not.
1799 A value for this option must be provided; possible values are
1801 @table @samp
1802 @item c90
1803 @itemx c89
1804 @itemx iso9899:1990
1805 Support all ISO C90 programs (certain GNU extensions that conflict
1806 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1808 @item iso9899:199409
1809 ISO C90 as modified in amendment 1.
1811 @item c99
1812 @itemx c9x
1813 @itemx iso9899:1999
1814 @itemx iso9899:199x
1815 ISO C99.  This standard is substantially completely supported, modulo
1816 bugs and floating-point issues
1817 (mainly but not entirely relating to optional C99 features from
1818 Annexes F and G).  See
1819 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1820 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1822 @item c11
1823 @itemx c1x
1824 @itemx iso9899:2011
1825 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1826 substantially completely supported, modulo bugs, floating-point issues
1827 (mainly but not entirely relating to optional C11 features from
1828 Annexes F and G) and the optional Annexes K (Bounds-checking
1829 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1831 @item gnu90
1832 @itemx gnu89
1833 GNU dialect of ISO C90 (including some C99 features).
1835 @item gnu99
1836 @itemx gnu9x
1837 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1839 @item gnu11
1840 @itemx gnu1x
1841 GNU dialect of ISO C11.  This is the default for C code.
1842 The name @samp{gnu1x} is deprecated.
1844 @item c++98
1845 @itemx c++03
1846 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1847 additional defect reports. Same as @option{-ansi} for C++ code.
1849 @item gnu++98
1850 @itemx gnu++03
1851 GNU dialect of @option{-std=c++98}.
1853 @item c++11
1854 @itemx c++0x
1855 The 2011 ISO C++ standard plus amendments.
1856 The name @samp{c++0x} is deprecated.
1858 @item gnu++11
1859 @itemx gnu++0x
1860 GNU dialect of @option{-std=c++11}.
1861 The name @samp{gnu++0x} is deprecated.
1863 @item c++14
1864 @itemx c++1y
1865 The 2014 ISO C++ standard plus amendments.
1866 The name @samp{c++1y} is deprecated.
1868 @item gnu++14
1869 @itemx gnu++1y
1870 GNU dialect of @option{-std=c++14}.
1871 This is the default for C++ code.
1872 The name @samp{gnu++1y} is deprecated.
1874 @item c++17
1875 @itemx c++1z
1876 The 2017 ISO C++ standard plus amendments.
1877 The name @samp{c++1z} is deprecated.
1879 @item gnu++17
1880 @itemx gnu++1z
1881 GNU dialect of @option{-std=c++17}.
1882 The name @samp{gnu++1z} is deprecated.
1884 @item c++2a
1885 The next revision of the ISO C++ standard, tentatively planned for
1886 2020.  Support is highly experimental, and will almost certainly
1887 change in incompatible ways in future releases.
1889 @item gnu++2a
1890 GNU dialect of @option{-std=c++2a}.  Support is highly experimental,
1891 and will almost certainly change in incompatible ways in future
1892 releases.
1893 @end table
1895 @item -fgnu89-inline
1896 @opindex fgnu89-inline
1897 The option @option{-fgnu89-inline} tells GCC to use the traditional
1898 GNU semantics for @code{inline} functions when in C99 mode.
1899 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1900 Using this option is roughly equivalent to adding the
1901 @code{gnu_inline} function attribute to all inline functions
1902 (@pxref{Function Attributes}).
1904 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1905 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1906 specifies the default behavior).
1907 This option is not supported in @option{-std=c90} or
1908 @option{-std=gnu90} mode.
1910 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1911 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1912 in effect for @code{inline} functions.  @xref{Common Predefined
1913 Macros,,,cpp,The C Preprocessor}.
1915 @item -fpermitted-flt-eval-methods=@var{style}
1916 @opindex fpermitted-flt-eval-methods
1917 @opindex fpermitted-flt-eval-methods=c11
1918 @opindex fpermitted-flt-eval-methods=ts-18661-3
1919 ISO/IEC TS 18661-3 defines new permissible values for
1920 @code{FLT_EVAL_METHOD} that indicate that operations and constants with
1921 a semantic type that is an interchange or extended format should be
1922 evaluated to the precision and range of that type.  These new values are
1923 a superset of those permitted under C99/C11, which does not specify the
1924 meaning of other positive values of @code{FLT_EVAL_METHOD}.  As such, code
1925 conforming to C11 may not have been written expecting the possibility of
1926 the new values.
1928 @option{-fpermitted-flt-eval-methods} specifies whether the compiler
1929 should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11,
1930 or the extended set of values specified in ISO/IEC TS 18661-3.
1932 @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate.
1934 The default when in a standards compliant mode (@option{-std=c11} or similar)
1935 is @option{-fpermitted-flt-eval-methods=c11}.  The default when in a GNU
1936 dialect (@option{-std=gnu11} or similar) is
1937 @option{-fpermitted-flt-eval-methods=ts-18661-3}.
1939 @item -aux-info @var{filename}
1940 @opindex aux-info
1941 Output to the given filename prototyped declarations for all functions
1942 declared and/or defined in a translation unit, including those in header
1943 files.  This option is silently ignored in any language other than C@.
1945 Besides declarations, the file indicates, in comments, the origin of
1946 each declaration (source file and line), whether the declaration was
1947 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1948 @samp{O} for old, respectively, in the first character after the line
1949 number and the colon), and whether it came from a declaration or a
1950 definition (@samp{C} or @samp{F}, respectively, in the following
1951 character).  In the case of function definitions, a K&R-style list of
1952 arguments followed by their declarations is also provided, inside
1953 comments, after the declaration.
1955 @item -fallow-parameterless-variadic-functions
1956 @opindex fallow-parameterless-variadic-functions
1957 Accept variadic functions without named parameters.
1959 Although it is possible to define such a function, this is not very
1960 useful as it is not possible to read the arguments.  This is only
1961 supported for C as this construct is allowed by C++.
1963 @item -fno-asm
1964 @opindex fno-asm
1965 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1966 keyword, so that code can use these words as identifiers.  You can use
1967 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1968 instead.  @option{-ansi} implies @option{-fno-asm}.
1970 In C++, this switch only affects the @code{typeof} keyword, since
1971 @code{asm} and @code{inline} are standard keywords.  You may want to
1972 use the @option{-fno-gnu-keywords} flag instead, which has the same
1973 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1974 switch only affects the @code{asm} and @code{typeof} keywords, since
1975 @code{inline} is a standard keyword in ISO C99.
1977 @item -fno-builtin
1978 @itemx -fno-builtin-@var{function}
1979 @opindex fno-builtin
1980 @cindex built-in functions
1981 Don't recognize built-in functions that do not begin with
1982 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1983 functions provided by GCC}, for details of the functions affected,
1984 including those which are not built-in functions when @option{-ansi} or
1985 @option{-std} options for strict ISO C conformance are used because they
1986 do not have an ISO standard meaning.
1988 GCC normally generates special code to handle certain built-in functions
1989 more efficiently; for instance, calls to @code{alloca} may become single
1990 instructions which adjust the stack directly, and calls to @code{memcpy}
1991 may become inline copy loops.  The resulting code is often both smaller
1992 and faster, but since the function calls no longer appear as such, you
1993 cannot set a breakpoint on those calls, nor can you change the behavior
1994 of the functions by linking with a different library.  In addition,
1995 when a function is recognized as a built-in function, GCC may use
1996 information about that function to warn about problems with calls to
1997 that function, or to generate more efficient code, even if the
1998 resulting code still contains calls to that function.  For example,
1999 warnings are given with @option{-Wformat} for bad calls to
2000 @code{printf} when @code{printf} is built in and @code{strlen} is
2001 known not to modify global memory.
2003 With the @option{-fno-builtin-@var{function}} option
2004 only the built-in function @var{function} is
2005 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
2006 function is named that is not built-in in this version of GCC, this
2007 option is ignored.  There is no corresponding
2008 @option{-fbuiltin-@var{function}} option; if you wish to enable
2009 built-in functions selectively when using @option{-fno-builtin} or
2010 @option{-ffreestanding}, you may define macros such as:
2012 @smallexample
2013 #define abs(n)          __builtin_abs ((n))
2014 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
2015 @end smallexample
2017 @item -fgimple
2018 @opindex fgimple
2020 Enable parsing of function definitions marked with @code{__GIMPLE}.
2021 This is an experimental feature that allows unit testing of GIMPLE
2022 passes.
2024 @item -fhosted
2025 @opindex fhosted
2026 @cindex hosted environment
2028 Assert that compilation targets a hosted environment.  This implies
2029 @option{-fbuiltin}.  A hosted environment is one in which the
2030 entire standard library is available, and in which @code{main} has a return
2031 type of @code{int}.  Examples are nearly everything except a kernel.
2032 This is equivalent to @option{-fno-freestanding}.
2034 @item -ffreestanding
2035 @opindex ffreestanding
2036 @cindex hosted environment
2038 Assert that compilation targets a freestanding environment.  This
2039 implies @option{-fno-builtin}.  A freestanding environment
2040 is one in which the standard library may not exist, and program startup may
2041 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
2042 This is equivalent to @option{-fno-hosted}.
2044 @xref{Standards,,Language Standards Supported by GCC}, for details of
2045 freestanding and hosted environments.
2047 @item -fopenacc
2048 @opindex fopenacc
2049 @cindex OpenACC accelerator programming
2050 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
2051 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
2052 compiler generates accelerated code according to the OpenACC Application
2053 Programming Interface v2.0 @w{@uref{https://www.openacc.org}}.  This option
2054 implies @option{-pthread}, and thus is only supported on targets that
2055 have support for @option{-pthread}.
2057 @item -fopenacc-dim=@var{geom}
2058 @opindex fopenacc-dim
2059 @cindex OpenACC accelerator programming
2060 Specify default compute dimensions for parallel offload regions that do
2061 not explicitly specify.  The @var{geom} value is a triple of
2062 ':'-separated sizes, in order 'gang', 'worker' and, 'vector'.  A size
2063 can be omitted, to use a target-specific default value.
2065 @item -fopenmp
2066 @opindex fopenmp
2067 @cindex OpenMP parallel
2068 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
2069 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
2070 compiler generates parallel code according to the OpenMP Application
2071 Program Interface v4.5 @w{@uref{http://www.openmp.org/}}.  This option
2072 implies @option{-pthread}, and thus is only supported on targets that
2073 have support for @option{-pthread}. @option{-fopenmp} implies
2074 @option{-fopenmp-simd}.
2076 @item -fopenmp-simd
2077 @opindex fopenmp-simd
2078 @cindex OpenMP SIMD
2079 @cindex SIMD
2080 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
2081 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
2082 are ignored.
2084 @item -fcilkplus
2085 @opindex fcilkplus
2086 @cindex Enable Cilk Plus
2087 Enable the usage of Cilk Plus language extension features for C/C++.
2088 When the option @option{-fcilkplus} is specified, enable the usage of
2089 the Cilk Plus Language extension features for C/C++.  The present
2090 implementation follows ABI version 1.2.  This is an experimental
2091 feature that is only partially complete, and whose interface may
2092 change in future versions of GCC as the official specification
2093 changes.  Currently, all features but @code{_Cilk_for} have been
2094 implemented.
2096 @item -fgnu-tm
2097 @opindex fgnu-tm
2098 When the option @option{-fgnu-tm} is specified, the compiler
2099 generates code for the Linux variant of Intel's current Transactional
2100 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
2101 an experimental feature whose interface may change in future versions
2102 of GCC, as the official specification changes.  Please note that not
2103 all architectures are supported for this feature.
2105 For more information on GCC's support for transactional memory,
2106 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
2107 Transactional Memory Library}.
2109 Note that the transactional memory feature is not supported with
2110 non-call exceptions (@option{-fnon-call-exceptions}).
2112 @item -fms-extensions
2113 @opindex fms-extensions
2114 Accept some non-standard constructs used in Microsoft header files.
2116 In C++ code, this allows member names in structures to be similar
2117 to previous types declarations.
2119 @smallexample
2120 typedef int UOW;
2121 struct ABC @{
2122   UOW UOW;
2124 @end smallexample
2126 Some cases of unnamed fields in structures and unions are only
2127 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2128 fields within structs/unions}, for details.
2130 Note that this option is off for all targets but x86 
2131 targets using ms-abi.
2133 @item -fplan9-extensions
2134 @opindex fplan9-extensions
2135 Accept some non-standard constructs used in Plan 9 code.
2137 This enables @option{-fms-extensions}, permits passing pointers to
2138 structures with anonymous fields to functions that expect pointers to
2139 elements of the type of the field, and permits referring to anonymous
2140 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2141 struct/union fields within structs/unions}, for details.  This is only
2142 supported for C, not C++.
2144 @item -fcond-mismatch
2145 @opindex fcond-mismatch
2146 Allow conditional expressions with mismatched types in the second and
2147 third arguments.  The value of such an expression is void.  This option
2148 is not supported for C++.
2150 @item -flax-vector-conversions
2151 @opindex flax-vector-conversions
2152 Allow implicit conversions between vectors with differing numbers of
2153 elements and/or incompatible element types.  This option should not be
2154 used for new code.
2156 @item -funsigned-char
2157 @opindex funsigned-char
2158 Let the type @code{char} be unsigned, like @code{unsigned char}.
2160 Each kind of machine has a default for what @code{char} should
2161 be.  It is either like @code{unsigned char} by default or like
2162 @code{signed char} by default.
2164 Ideally, a portable program should always use @code{signed char} or
2165 @code{unsigned char} when it depends on the signedness of an object.
2166 But many programs have been written to use plain @code{char} and
2167 expect it to be signed, or expect it to be unsigned, depending on the
2168 machines they were written for.  This option, and its inverse, let you
2169 make such a program work with the opposite default.
2171 The type @code{char} is always a distinct type from each of
2172 @code{signed char} or @code{unsigned char}, even though its behavior
2173 is always just like one of those two.
2175 @item -fsigned-char
2176 @opindex fsigned-char
2177 Let the type @code{char} be signed, like @code{signed char}.
2179 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2180 the negative form of @option{-funsigned-char}.  Likewise, the option
2181 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2183 @item -fsigned-bitfields
2184 @itemx -funsigned-bitfields
2185 @itemx -fno-signed-bitfields
2186 @itemx -fno-unsigned-bitfields
2187 @opindex fsigned-bitfields
2188 @opindex funsigned-bitfields
2189 @opindex fno-signed-bitfields
2190 @opindex fno-unsigned-bitfields
2191 These options control whether a bit-field is signed or unsigned, when the
2192 declaration does not use either @code{signed} or @code{unsigned}.  By
2193 default, such a bit-field is signed, because this is consistent: the
2194 basic integer types such as @code{int} are signed types.
2196 @item -fsso-struct=@var{endianness}
2197 @opindex fsso-struct
2198 Set the default scalar storage order of structures and unions to the
2199 specified endianness.  The accepted values are @samp{big-endian},
2200 @samp{little-endian} and @samp{native} for the native endianness of
2201 the target (the default).  This option is not supported for C++.
2203 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2204 code that is not binary compatible with code generated without it if the
2205 specified endianness is not the native endianness of the target.
2206 @end table
2208 @node C++ Dialect Options
2209 @section Options Controlling C++ Dialect
2211 @cindex compiler options, C++
2212 @cindex C++ options, command-line
2213 @cindex options, C++
2214 This section describes the command-line options that are only meaningful
2215 for C++ programs.  You can also use most of the GNU compiler options
2216 regardless of what language your program is in.  For example, you
2217 might compile a file @file{firstClass.C} like this:
2219 @smallexample
2220 g++ -g -fstrict-enums -O -c firstClass.C
2221 @end smallexample
2223 @noindent
2224 In this example, only @option{-fstrict-enums} is an option meant
2225 only for C++ programs; you can use the other options with any
2226 language supported by GCC@.
2228 Some options for compiling C programs, such as @option{-std}, are also
2229 relevant for C++ programs.
2230 @xref{C Dialect Options,,Options Controlling C Dialect}.
2232 Here is a list of options that are @emph{only} for compiling C++ programs:
2234 @table @gcctabopt
2236 @item -fabi-version=@var{n}
2237 @opindex fabi-version
2238 Use version @var{n} of the C++ ABI@.  The default is version 0.
2240 Version 0 refers to the version conforming most closely to
2241 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2242 will change in different versions of G++ as ABI bugs are fixed.
2244 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2246 Version 2 is the version of the C++ ABI that first appeared in G++
2247 3.4, and was the default through G++ 4.9.
2249 Version 3 corrects an error in mangling a constant address as a
2250 template argument.
2252 Version 4, which first appeared in G++ 4.5, implements a standard
2253 mangling for vector types.
2255 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2256 attribute const/volatile on function pointer types, decltype of a
2257 plain decl, and use of a function parameter in the declaration of
2258 another parameter.
2260 Version 6, which first appeared in G++ 4.7, corrects the promotion
2261 behavior of C++11 scoped enums and the mangling of template argument
2262 packs, const/static_cast, prefix ++ and --, and a class scope function
2263 used as a template argument.
2265 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2266 builtin type and corrects the mangling of lambdas in default argument
2267 scope.
2269 Version 8, which first appeared in G++ 4.9, corrects the substitution
2270 behavior of function types with function-cv-qualifiers.
2272 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2273 @code{nullptr_t}.
2275 Version 10, which first appeared in G++ 6.1, adds mangling of
2276 attributes that affect type identity, such as ia32 calling convention
2277 attributes (e.g. @samp{stdcall}).
2279 Version 11, which first appeared in G++ 7, corrects the mangling of
2280 sizeof... expressions and operator names.  For multiple entities with
2281 the same name within a function, that are declared in different scopes,
2282 the mangling now changes starting with the twelfth occurrence.  It also
2283 implies @option{-fnew-inheriting-ctors}.
2285 See also @option{-Wabi}.
2287 @item -fabi-compat-version=@var{n}
2288 @opindex fabi-compat-version
2289 On targets that support strong aliases, G++
2290 works around mangling changes by creating an alias with the correct
2291 mangled name when defining a symbol with an incorrect mangled name.
2292 This switch specifies which ABI version to use for the alias.
2294 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2295 compatibility).  If another ABI version is explicitly selected, this
2296 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2297 use @option{-fabi-compat-version=2}.
2299 If this option is not provided but @option{-Wabi=@var{n}} is, that
2300 version is used for compatibility aliases.  If this option is provided
2301 along with @option{-Wabi} (without the version), the version from this
2302 option is used for the warning.
2304 @item -fno-access-control
2305 @opindex fno-access-control
2306 Turn off all access checking.  This switch is mainly useful for working
2307 around bugs in the access control code.
2309 @item -faligned-new
2310 @opindex faligned-new
2311 Enable support for C++17 @code{new} of types that require more
2312 alignment than @code{void* ::operator new(std::size_t)} provides.  A
2313 numeric argument such as @code{-faligned-new=32} can be used to
2314 specify how much alignment (in bytes) is provided by that function,
2315 but few users will need to override the default of
2316 @code{alignof(std::max_align_t)}.
2318 This flag is enabled by default for @option{-std=c++17}.
2320 @item -fcheck-new
2321 @opindex fcheck-new
2322 Check that the pointer returned by @code{operator new} is non-null
2323 before attempting to modify the storage allocated.  This check is
2324 normally unnecessary because the C++ standard specifies that
2325 @code{operator new} only returns @code{0} if it is declared
2326 @code{throw()}, in which case the compiler always checks the
2327 return value even without this option.  In all other cases, when
2328 @code{operator new} has a non-empty exception specification, memory
2329 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2330 @samp{new (nothrow)}.
2332 @item -fconcepts
2333 @opindex fconcepts
2334 Enable support for the C++ Extensions for Concepts Technical
2335 Specification, ISO 19217 (2015), which allows code like
2337 @smallexample
2338 template <class T> concept bool Addable = requires (T t) @{ t + t; @};
2339 template <Addable T> T add (T a, T b) @{ return a + b; @}
2340 @end smallexample
2342 @item -fconstexpr-depth=@var{n}
2343 @opindex fconstexpr-depth
2344 Set the maximum nested evaluation depth for C++11 constexpr functions
2345 to @var{n}.  A limit is needed to detect endless recursion during
2346 constant expression evaluation.  The minimum specified by the standard
2347 is 512.
2349 @item -fconstexpr-loop-limit=@var{n}
2350 @opindex fconstexpr-loop-limit
2351 Set the maximum number of iterations for a loop in C++14 constexpr functions
2352 to @var{n}.  A limit is needed to detect infinite loops during
2353 constant expression evaluation.  The default is 262144 (1<<18).
2355 @item -fdeduce-init-list
2356 @opindex fdeduce-init-list
2357 Enable deduction of a template type parameter as
2358 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2360 @smallexample
2361 template <class T> auto forward(T t) -> decltype (realfn (t))
2363   return realfn (t);
2366 void f()
2368   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2370 @end smallexample
2372 This deduction was implemented as a possible extension to the
2373 originally proposed semantics for the C++11 standard, but was not part
2374 of the final standard, so it is disabled by default.  This option is
2375 deprecated, and may be removed in a future version of G++.
2377 @item -ffriend-injection
2378 @opindex ffriend-injection
2379 Inject friend functions into the enclosing namespace, so that they are
2380 visible outside the scope of the class in which they are declared.
2381 Friend functions were documented to work this way in the old Annotated
2382 C++ Reference Manual.  
2383 However, in ISO C++ a friend function that is not declared
2384 in an enclosing scope can only be found using argument dependent
2385 lookup.  GCC defaults to the standard behavior.
2387 This option is for compatibility, and may be removed in a future
2388 release of G++.
2390 @item -fno-elide-constructors
2391 @opindex fno-elide-constructors
2392 The C++ standard allows an implementation to omit creating a temporary
2393 that is only used to initialize another object of the same type.
2394 Specifying this option disables that optimization, and forces G++ to
2395 call the copy constructor in all cases.  This option also causes G++
2396 to call trivial member functions which otherwise would be expanded inline.
2398 In C++17, the compiler is required to omit these temporaries, but this
2399 option still affects trivial member functions.
2401 @item -fno-enforce-eh-specs
2402 @opindex fno-enforce-eh-specs
2403 Don't generate code to check for violation of exception specifications
2404 at run time.  This option violates the C++ standard, but may be useful
2405 for reducing code size in production builds, much like defining
2406 @code{NDEBUG}.  This does not give user code permission to throw
2407 exceptions in violation of the exception specifications; the compiler
2408 still optimizes based on the specifications, so throwing an
2409 unexpected exception results in undefined behavior at run time.
2411 @item -fextern-tls-init
2412 @itemx -fno-extern-tls-init
2413 @opindex fextern-tls-init
2414 @opindex fno-extern-tls-init
2415 The C++11 and OpenMP standards allow @code{thread_local} and
2416 @code{threadprivate} variables to have dynamic (runtime)
2417 initialization.  To support this, any use of such a variable goes
2418 through a wrapper function that performs any necessary initialization.
2419 When the use and definition of the variable are in the same
2420 translation unit, this overhead can be optimized away, but when the
2421 use is in a different translation unit there is significant overhead
2422 even if the variable doesn't actually need dynamic initialization.  If
2423 the programmer can be sure that no use of the variable in a
2424 non-defining TU needs to trigger dynamic initialization (either
2425 because the variable is statically initialized, or a use of the
2426 variable in the defining TU will be executed before any uses in
2427 another TU), they can avoid this overhead with the
2428 @option{-fno-extern-tls-init} option.
2430 On targets that support symbol aliases, the default is
2431 @option{-fextern-tls-init}.  On targets that do not support symbol
2432 aliases, the default is @option{-fno-extern-tls-init}.
2434 @item -ffor-scope
2435 @itemx -fno-for-scope
2436 @opindex ffor-scope
2437 @opindex fno-for-scope
2438 If @option{-ffor-scope} is specified, the scope of variables declared in
2439 a @i{for-init-statement} is limited to the @code{for} loop itself,
2440 as specified by the C++ standard.
2441 If @option{-fno-for-scope} is specified, the scope of variables declared in
2442 a @i{for-init-statement} extends to the end of the enclosing scope,
2443 as was the case in old versions of G++, and other (traditional)
2444 implementations of C++.
2446 If neither flag is given, the default is to follow the standard,
2447 but to allow and give a warning for old-style code that would
2448 otherwise be invalid, or have different behavior.
2450 @item -fno-gnu-keywords
2451 @opindex fno-gnu-keywords
2452 Do not recognize @code{typeof} as a keyword, so that code can use this
2453 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2454 This option is implied by the strict ISO C++ dialects: @option{-ansi},
2455 @option{-std=c++98}, @option{-std=c++11}, etc.
2457 @item -fno-implicit-templates
2458 @opindex fno-implicit-templates
2459 Never emit code for non-inline templates that are instantiated
2460 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2461 @xref{Template Instantiation}, for more information.
2463 @item -fno-implicit-inline-templates
2464 @opindex fno-implicit-inline-templates
2465 Don't emit code for implicit instantiations of inline templates, either.
2466 The default is to handle inlines differently so that compiles with and
2467 without optimization need the same set of explicit instantiations.
2469 @item -fno-implement-inlines
2470 @opindex fno-implement-inlines
2471 To save space, do not emit out-of-line copies of inline functions
2472 controlled by @code{#pragma implementation}.  This causes linker
2473 errors if these functions are not inlined everywhere they are called.
2475 @item -fms-extensions
2476 @opindex fms-extensions
2477 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2478 int and getting a pointer to member function via non-standard syntax.
2480 @item -fnew-inheriting-ctors
2481 @opindex fnew-inheriting-ctors
2482 Enable the P0136 adjustment to the semantics of C++11 constructor
2483 inheritance.  This is part of C++17 but also considered to be a Defect
2484 Report against C++11 and C++14.  This flag is enabled by default
2485 unless @option{-fabi-version=10} or lower is specified.
2487 @item -fnew-ttp-matching
2488 @opindex fnew-ttp-matching
2489 Enable the P0522 resolution to Core issue 150, template template
2490 parameters and default arguments: this allows a template with default
2491 template arguments as an argument for a template template parameter
2492 with fewer template parameters.  This flag is enabled by default for
2493 @option{-std=c++17}.
2495 @item -fno-nonansi-builtins
2496 @opindex fno-nonansi-builtins
2497 Disable built-in declarations of functions that are not mandated by
2498 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2499 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2501 @item -fnothrow-opt
2502 @opindex fnothrow-opt
2503 Treat a @code{throw()} exception specification as if it were a
2504 @code{noexcept} specification to reduce or eliminate the text size
2505 overhead relative to a function with no exception specification.  If
2506 the function has local variables of types with non-trivial
2507 destructors, the exception specification actually makes the
2508 function smaller because the EH cleanups for those variables can be
2509 optimized away.  The semantic effect is that an exception thrown out of
2510 a function with such an exception specification results in a call
2511 to @code{terminate} rather than @code{unexpected}.
2513 @item -fno-operator-names
2514 @opindex fno-operator-names
2515 Do not treat the operator name keywords @code{and}, @code{bitand},
2516 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2517 synonyms as keywords.
2519 @item -fno-optional-diags
2520 @opindex fno-optional-diags
2521 Disable diagnostics that the standard says a compiler does not need to
2522 issue.  Currently, the only such diagnostic issued by G++ is the one for
2523 a name having multiple meanings within a class.
2525 @item -fpermissive
2526 @opindex fpermissive
2527 Downgrade some diagnostics about nonconformant code from errors to
2528 warnings.  Thus, using @option{-fpermissive} allows some
2529 nonconforming code to compile.
2531 @item -fno-pretty-templates
2532 @opindex fno-pretty-templates
2533 When an error message refers to a specialization of a function
2534 template, the compiler normally prints the signature of the
2535 template followed by the template arguments and any typedefs or
2536 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2537 rather than @code{void f(int)}) so that it's clear which template is
2538 involved.  When an error message refers to a specialization of a class
2539 template, the compiler omits any template arguments that match
2540 the default template arguments for that template.  If either of these
2541 behaviors make it harder to understand the error message rather than
2542 easier, you can use @option{-fno-pretty-templates} to disable them.
2544 @item -frepo
2545 @opindex frepo
2546 Enable automatic template instantiation at link time.  This option also
2547 implies @option{-fno-implicit-templates}.  @xref{Template
2548 Instantiation}, for more information.
2550 @item -fno-rtti
2551 @opindex fno-rtti
2552 Disable generation of information about every class with virtual
2553 functions for use by the C++ run-time type identification features
2554 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2555 of the language, you can save some space by using this flag.  Note that
2556 exception handling uses the same information, but G++ generates it as
2557 needed. The @code{dynamic_cast} operator can still be used for casts that
2558 do not require run-time type information, i.e.@: casts to @code{void *} or to
2559 unambiguous base classes.
2561 @item -fsized-deallocation
2562 @opindex fsized-deallocation
2563 Enable the built-in global declarations
2564 @smallexample
2565 void operator delete (void *, std::size_t) noexcept;
2566 void operator delete[] (void *, std::size_t) noexcept;
2567 @end smallexample
2568 as introduced in C++14.  This is useful for user-defined replacement
2569 deallocation functions that, for example, use the size of the object
2570 to make deallocation faster.  Enabled by default under
2571 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2572 warns about places that might want to add a definition.
2574 @item -fstrict-enums
2575 @opindex fstrict-enums
2576 Allow the compiler to optimize using the assumption that a value of
2577 enumerated type can only be one of the values of the enumeration (as
2578 defined in the C++ standard; basically, a value that can be
2579 represented in the minimum number of bits needed to represent all the
2580 enumerators).  This assumption may not be valid if the program uses a
2581 cast to convert an arbitrary integer value to the enumerated type.
2583 @item -fstrong-eval-order
2584 @opindex fstrong-eval-order
2585 Evaluate member access, array subscripting, and shift expressions in
2586 left-to-right order, and evaluate assignment in right-to-left order,
2587 as adopted for C++17.  Enabled by default with @option{-std=c++17}.
2588 @option{-fstrong-eval-order=some} enables just the ordering of member
2589 access and shift expressions, and is the default without
2590 @option{-std=c++17}.
2592 @item -ftemplate-backtrace-limit=@var{n}
2593 @opindex ftemplate-backtrace-limit
2594 Set the maximum number of template instantiation notes for a single
2595 warning or error to @var{n}.  The default value is 10.
2597 @item -ftemplate-depth=@var{n}
2598 @opindex ftemplate-depth
2599 Set the maximum instantiation depth for template classes to @var{n}.
2600 A limit on the template instantiation depth is needed to detect
2601 endless recursions during template class instantiation.  ANSI/ISO C++
2602 conforming programs must not rely on a maximum depth greater than 17
2603 (changed to 1024 in C++11).  The default value is 900, as the compiler
2604 can run out of stack space before hitting 1024 in some situations.
2606 @item -fno-threadsafe-statics
2607 @opindex fno-threadsafe-statics
2608 Do not emit the extra code to use the routines specified in the C++
2609 ABI for thread-safe initialization of local statics.  You can use this
2610 option to reduce code size slightly in code that doesn't need to be
2611 thread-safe.
2613 @item -fuse-cxa-atexit
2614 @opindex fuse-cxa-atexit
2615 Register destructors for objects with static storage duration with the
2616 @code{__cxa_atexit} function rather than the @code{atexit} function.
2617 This option is required for fully standards-compliant handling of static
2618 destructors, but only works if your C library supports
2619 @code{__cxa_atexit}.
2621 @item -fno-use-cxa-get-exception-ptr
2622 @opindex fno-use-cxa-get-exception-ptr
2623 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2624 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2625 if the runtime routine is not available.
2627 @item -fvisibility-inlines-hidden
2628 @opindex fvisibility-inlines-hidden
2629 This switch declares that the user does not attempt to compare
2630 pointers to inline functions or methods where the addresses of the two functions
2631 are taken in different shared objects.
2633 The effect of this is that GCC may, effectively, mark inline methods with
2634 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2635 appear in the export table of a DSO and do not require a PLT indirection
2636 when used within the DSO@.  Enabling this option can have a dramatic effect
2637 on load and link times of a DSO as it massively reduces the size of the
2638 dynamic export table when the library makes heavy use of templates.
2640 The behavior of this switch is not quite the same as marking the
2641 methods as hidden directly, because it does not affect static variables
2642 local to the function or cause the compiler to deduce that
2643 the function is defined in only one shared object.
2645 You may mark a method as having a visibility explicitly to negate the
2646 effect of the switch for that method.  For example, if you do want to
2647 compare pointers to a particular inline method, you might mark it as
2648 having default visibility.  Marking the enclosing class with explicit
2649 visibility has no effect.
2651 Explicitly instantiated inline methods are unaffected by this option
2652 as their linkage might otherwise cross a shared library boundary.
2653 @xref{Template Instantiation}.
2655 @item -fvisibility-ms-compat
2656 @opindex fvisibility-ms-compat
2657 This flag attempts to use visibility settings to make GCC's C++
2658 linkage model compatible with that of Microsoft Visual Studio.
2660 The flag makes these changes to GCC's linkage model:
2662 @enumerate
2663 @item
2664 It sets the default visibility to @code{hidden}, like
2665 @option{-fvisibility=hidden}.
2667 @item
2668 Types, but not their members, are not hidden by default.
2670 @item
2671 The One Definition Rule is relaxed for types without explicit
2672 visibility specifications that are defined in more than one
2673 shared object: those declarations are permitted if they are
2674 permitted when this option is not used.
2675 @end enumerate
2677 In new code it is better to use @option{-fvisibility=hidden} and
2678 export those classes that are intended to be externally visible.
2679 Unfortunately it is possible for code to rely, perhaps accidentally,
2680 on the Visual Studio behavior.
2682 Among the consequences of these changes are that static data members
2683 of the same type with the same name but defined in different shared
2684 objects are different, so changing one does not change the other;
2685 and that pointers to function members defined in different shared
2686 objects may not compare equal.  When this flag is given, it is a
2687 violation of the ODR to define types with the same name differently.
2689 @item -fno-weak
2690 @opindex fno-weak
2691 Do not use weak symbol support, even if it is provided by the linker.
2692 By default, G++ uses weak symbols if they are available.  This
2693 option exists only for testing, and should not be used by end-users;
2694 it results in inferior code and has no benefits.  This option may
2695 be removed in a future release of G++.
2697 @item -nostdinc++
2698 @opindex nostdinc++
2699 Do not search for header files in the standard directories specific to
2700 C++, but do still search the other standard directories.  (This option
2701 is used when building the C++ library.)
2702 @end table
2704 In addition, these optimization, warning, and code generation options
2705 have meanings only for C++ programs:
2707 @table @gcctabopt
2708 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2709 @opindex Wabi
2710 @opindex Wno-abi
2711 Warn when G++ it generates code that is probably not compatible with
2712 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2713 ABI with each major release, normally @option{-Wabi} will warn only if
2714 there is a check added later in a release series for an ABI issue
2715 discovered since the initial release.  @option{-Wabi} will warn about
2716 more things if an older ABI version is selected (with
2717 @option{-fabi-version=@var{n}}).
2719 @option{-Wabi} can also be used with an explicit version number to
2720 warn about compatibility with a particular @option{-fabi-version}
2721 level, e.g. @option{-Wabi=2} to warn about changes relative to
2722 @option{-fabi-version=2}.
2724 If an explicit version number is provided and
2725 @option{-fabi-compat-version} is not specified, the version number
2726 from this option is used for compatibility aliases.  If no explicit
2727 version number is provided with this option, but
2728 @option{-fabi-compat-version} is specified, that version number is
2729 used for ABI warnings.
2731 Although an effort has been made to warn about
2732 all such cases, there are probably some cases that are not warned about,
2733 even though G++ is generating incompatible code.  There may also be
2734 cases where warnings are emitted even though the code that is generated
2735 is compatible.
2737 You should rewrite your code to avoid these warnings if you are
2738 concerned about the fact that code generated by G++ may not be binary
2739 compatible with code generated by other compilers.
2741 Known incompatibilities in @option{-fabi-version=2} (which was the
2742 default from GCC 3.4 to 4.9) include:
2744 @itemize @bullet
2746 @item
2747 A template with a non-type template parameter of reference type was
2748 mangled incorrectly:
2749 @smallexample
2750 extern int N;
2751 template <int &> struct S @{@};
2752 void n (S<N>) @{2@}
2753 @end smallexample
2755 This was fixed in @option{-fabi-version=3}.
2757 @item
2758 SIMD vector types declared using @code{__attribute ((vector_size))} were
2759 mangled in a non-standard way that does not allow for overloading of
2760 functions taking vectors of different sizes.
2762 The mangling was changed in @option{-fabi-version=4}.
2764 @item
2765 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2766 qualifiers, and @code{decltype} of a plain declaration was folded away.
2768 These mangling issues were fixed in @option{-fabi-version=5}.
2770 @item
2771 Scoped enumerators passed as arguments to a variadic function are
2772 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2773 On most targets this does not actually affect the parameter passing
2774 ABI, as there is no way to pass an argument smaller than @code{int}.
2776 Also, the ABI changed the mangling of template argument packs,
2777 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2778 a class scope function used as a template argument.
2780 These issues were corrected in @option{-fabi-version=6}.
2782 @item
2783 Lambdas in default argument scope were mangled incorrectly, and the
2784 ABI changed the mangling of @code{nullptr_t}.
2786 These issues were corrected in @option{-fabi-version=7}.
2788 @item
2789 When mangling a function type with function-cv-qualifiers, the
2790 un-qualified function type was incorrectly treated as a substitution
2791 candidate.
2793 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2795 @item
2796 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2797 unaligned accesses.  Note that this did not affect the ABI of a
2798 function with a @code{nullptr_t} parameter, as parameters have a
2799 minimum alignment.
2801 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2803 @item
2804 Target-specific attributes that affect the identity of a type, such as
2805 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2806 did not affect the mangled name, leading to name collisions when
2807 function pointers were used as template arguments.
2809 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2811 @end itemize
2813 It also warns about psABI-related changes.  The known psABI changes at this
2814 point include:
2816 @itemize @bullet
2818 @item
2819 For SysV/x86-64, unions with @code{long double} members are 
2820 passed in memory as specified in psABI.  For example:
2822 @smallexample
2823 union U @{
2824   long double ld;
2825   int i;
2827 @end smallexample
2829 @noindent
2830 @code{union U} is always passed in memory.
2832 @end itemize
2834 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2835 @opindex Wabi-tag
2836 @opindex -Wabi-tag
2837 Warn when a type with an ABI tag is used in a context that does not
2838 have that ABI tag.  See @ref{C++ Attributes} for more information
2839 about ABI tags.
2841 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2842 @opindex Wctor-dtor-privacy
2843 @opindex Wno-ctor-dtor-privacy
2844 Warn when a class seems unusable because all the constructors or
2845 destructors in that class are private, and it has neither friends nor
2846 public static member functions.  Also warn if there are no non-private
2847 methods, and there's at least one private member function that isn't
2848 a constructor or destructor.
2850 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2851 @opindex Wdelete-non-virtual-dtor
2852 @opindex Wno-delete-non-virtual-dtor
2853 Warn when @code{delete} is used to destroy an instance of a class that
2854 has virtual functions and non-virtual destructor. It is unsafe to delete
2855 an instance of a derived class through a pointer to a base class if the
2856 base class does not have a virtual destructor.  This warning is enabled
2857 by @option{-Wall}.
2859 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2860 @opindex Wliteral-suffix
2861 @opindex Wno-literal-suffix
2862 Warn when a string or character literal is followed by a ud-suffix which does
2863 not begin with an underscore.  As a conforming extension, GCC treats such
2864 suffixes as separate preprocessing tokens in order to maintain backwards
2865 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2866 For example:
2868 @smallexample
2869 #define __STDC_FORMAT_MACROS
2870 #include <inttypes.h>
2871 #include <stdio.h>
2873 int main() @{
2874   int64_t i64 = 123;
2875   printf("My int64: %" PRId64"\n", i64);
2877 @end smallexample
2879 In this case, @code{PRId64} is treated as a separate preprocessing token.
2881 Additionally, warn when a user-defined literal operator is declared with
2882 a literal suffix identifier that doesn't begin with an underscore. Literal
2883 suffix identifiers that don't begin with an underscore are reserved for
2884 future standardization.
2886 This warning is enabled by default.
2888 @item -Wlto-type-mismatch
2889 @opindex Wlto-type-mismatch
2890 @opindex Wno-lto-type-mismatch
2892 During the link-time optimization warn about type mismatches in
2893 global declarations from different compilation units.
2894 Requires @option{-flto} to be enabled.  Enabled by default.
2896 @item -Wno-narrowing @r{(C++ and Objective-C++ only)}
2897 @opindex Wnarrowing
2898 @opindex Wno-narrowing
2899 For C++11 and later standards, narrowing conversions are diagnosed by default,
2900 as required by the standard.  A narrowing conversion from a constant produces
2901 an error, and a narrowing conversion from a non-constant produces a warning,
2902 but @option{-Wno-narrowing} suppresses the diagnostic.
2903 Note that this does not affect the meaning of well-formed code;
2904 narrowing conversions are still considered ill-formed in SFINAE contexts.
2906 With @option{-Wnarrowing} in C++98, warn when a narrowing
2907 conversion prohibited by C++11 occurs within
2908 @samp{@{ @}}, e.g.
2910 @smallexample
2911 int i = @{ 2.2 @}; // error: narrowing from double to int
2912 @end smallexample
2914 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2916 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2917 @opindex Wnoexcept
2918 @opindex Wno-noexcept
2919 Warn when a noexcept-expression evaluates to false because of a call
2920 to a function that does not have a non-throwing exception
2921 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2922 the compiler to never throw an exception.
2924 @item -Wnoexcept-type @r{(C++ and Objective-C++ only)}
2925 @opindex Wnoexcept-type
2926 @opindex Wno-noexcept-type
2927 Warn if the C++17 feature making @code{noexcept} part of a function
2928 type changes the mangled name of a symbol relative to C++14.  Enabled
2929 by @option{-Wabi} and @option{-Wc++17-compat}.
2931 @smallexample
2932 template <class T> void f(T t) @{ t(); @};
2933 void g() noexcept;
2934 void h() @{ f(g); @} // in C++14 calls f<void(*)()>, in C++17 calls f<void(*)()noexcept>
2935 @end smallexample
2937 @item -Wclass-memaccess @r{(C++ and Objective-C++ only)}
2938 @opindex Wclass-memaccess
2939 Warn when the destination of a call to a raw memory function such as
2940 @code{memset} or @code{memcpy} is an object of class type writing into which
2941 might bypass the class non-trivial or deleted constructor or copy assignment,
2942 violate const-correctness or encapsulation, or corrupt the virtual table.
2943 Modifying the representation of such objects may violate invariants maintained
2944 by member functions of the class.  For example, the call to @code{memset}
2945 below is undefined becase it modifies a non-trivial class object and is,
2946 therefore, diagnosed.  The safe way to either initialize or clear the storage
2947 of objects of such types is by using the appropriate constructor or assignment
2948 operator, if one is available.
2949 @smallexample
2950 std::string str = "abc";
2951 memset (&str, 0, 3);
2952 @end smallexample
2953 The @option{-Wclass-memaccess} option is enabled by @option{-Wall}.
2955 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2956 @opindex Wnon-virtual-dtor
2957 @opindex Wno-non-virtual-dtor
2958 Warn when a class has virtual functions and an accessible non-virtual
2959 destructor itself or in an accessible polymorphic base class, in which
2960 case it is possible but unsafe to delete an instance of a derived
2961 class through a pointer to the class itself or base class.  This
2962 warning is automatically enabled if @option{-Weffc++} is specified.
2964 @item -Wregister @r{(C++ and Objective-C++ only)}
2965 @opindex Wregister
2966 @opindex Wno-register
2967 Warn on uses of the @code{register} storage class specifier, except
2968 when it is part of the GNU @ref{Explicit Register Variables} extension.
2969 The use of the @code{register} keyword as storage class specifier has
2970 been deprecated in C++11 and removed in C++17.
2971 Enabled by default with @option{-std=c++17}.
2973 @item -Wreorder @r{(C++ and Objective-C++ only)}
2974 @opindex Wreorder
2975 @opindex Wno-reorder
2976 @cindex reordering, warning
2977 @cindex warning for reordering of member initializers
2978 Warn when the order of member initializers given in the code does not
2979 match the order in which they must be executed.  For instance:
2981 @smallexample
2982 struct A @{
2983   int i;
2984   int j;
2985   A(): j (0), i (1) @{ @}
2987 @end smallexample
2989 @noindent
2990 The compiler rearranges the member initializers for @code{i}
2991 and @code{j} to match the declaration order of the members, emitting
2992 a warning to that effect.  This warning is enabled by @option{-Wall}.
2994 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2995 @opindex fext-numeric-literals
2996 @opindex fno-ext-numeric-literals
2997 Accept imaginary, fixed-point, or machine-defined
2998 literal number suffixes as GNU extensions.
2999 When this option is turned off these suffixes are treated
3000 as C++11 user-defined literal numeric suffixes.
3001 This is on by default for all pre-C++11 dialects and all GNU dialects:
3002 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
3003 @option{-std=gnu++14}.
3004 This option is off by default
3005 for ISO C++11 onwards (@option{-std=c++11}, ...).
3006 @end table
3008 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
3010 @table @gcctabopt
3011 @item -Weffc++ @r{(C++ and Objective-C++ only)}
3012 @opindex Weffc++
3013 @opindex Wno-effc++
3014 Warn about violations of the following style guidelines from Scott Meyers'
3015 @cite{Effective C++} series of books:
3017 @itemize @bullet
3018 @item
3019 Define a copy constructor and an assignment operator for classes
3020 with dynamically-allocated memory.
3022 @item
3023 Prefer initialization to assignment in constructors.
3025 @item
3026 Have @code{operator=} return a reference to @code{*this}.
3028 @item
3029 Don't try to return a reference when you must return an object.
3031 @item
3032 Distinguish between prefix and postfix forms of increment and
3033 decrement operators.
3035 @item
3036 Never overload @code{&&}, @code{||}, or @code{,}.
3038 @end itemize
3040 This option also enables @option{-Wnon-virtual-dtor}, which is also
3041 one of the effective C++ recommendations.  However, the check is
3042 extended to warn about the lack of virtual destructor in accessible
3043 non-polymorphic bases classes too.
3045 When selecting this option, be aware that the standard library
3046 headers do not obey all of these guidelines; use @samp{grep -v}
3047 to filter out those warnings.
3049 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
3050 @opindex Wstrict-null-sentinel
3051 @opindex Wno-strict-null-sentinel
3052 Warn about the use of an uncasted @code{NULL} as sentinel.  When
3053 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
3054 to @code{__null}.  Although it is a null pointer constant rather than a
3055 null pointer, it is guaranteed to be of the same size as a pointer.
3056 But this use is not portable across different compilers.
3058 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
3059 @opindex Wno-non-template-friend
3060 @opindex Wnon-template-friend
3061 Disable warnings when non-template friend functions are declared
3062 within a template.  In very old versions of GCC that predate implementation
3063 of the ISO standard, declarations such as 
3064 @samp{friend int foo(int)}, where the name of the friend is an unqualified-id,
3065 could be interpreted as a particular specialization of a template
3066 function; the warning exists to diagnose compatibility problems, 
3067 and is enabled by default.
3069 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
3070 @opindex Wold-style-cast
3071 @opindex Wno-old-style-cast
3072 Warn if an old-style (C-style) cast to a non-void type is used within
3073 a C++ program.  The new-style casts (@code{dynamic_cast},
3074 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
3075 less vulnerable to unintended effects and much easier to search for.
3077 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
3078 @opindex Woverloaded-virtual
3079 @opindex Wno-overloaded-virtual
3080 @cindex overloaded virtual function, warning
3081 @cindex warning for overloaded virtual function
3082 Warn when a function declaration hides virtual functions from a
3083 base class.  For example, in:
3085 @smallexample
3086 struct A @{
3087   virtual void f();
3090 struct B: public A @{
3091   void f(int);
3093 @end smallexample
3095 the @code{A} class version of @code{f} is hidden in @code{B}, and code
3096 like:
3098 @smallexample
3099 B* b;
3100 b->f();
3101 @end smallexample
3103 @noindent
3104 fails to compile.
3106 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
3107 @opindex Wno-pmf-conversions
3108 @opindex Wpmf-conversions
3109 Disable the diagnostic for converting a bound pointer to member function
3110 to a plain pointer.
3112 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
3113 @opindex Wsign-promo
3114 @opindex Wno-sign-promo
3115 Warn when overload resolution chooses a promotion from unsigned or
3116 enumerated type to a signed type, over a conversion to an unsigned type of
3117 the same size.  Previous versions of G++ tried to preserve
3118 unsignedness, but the standard mandates the current behavior.
3120 @item -Wtemplates @r{(C++ and Objective-C++ only)}
3121 @opindex Wtemplates
3122 Warn when a primary template declaration is encountered.  Some coding
3123 rules disallow templates, and this may be used to enforce that rule.
3124 The warning is inactive inside a system header file, such as the STL, so
3125 one can still use the STL.  One may also instantiate or specialize
3126 templates.
3128 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
3129 @opindex Wmultiple-inheritance
3130 Warn when a class is defined with multiple direct base classes.  Some
3131 coding rules disallow multiple inheritance, and this may be used to
3132 enforce that rule.  The warning is inactive inside a system header file,
3133 such as the STL, so one can still use the STL.  One may also define
3134 classes that indirectly use multiple inheritance.
3136 @item -Wvirtual-inheritance
3137 @opindex Wvirtual-inheritance
3138 Warn when a class is defined with a virtual direct base class.  Some
3139 coding rules disallow multiple inheritance, and this may be used to
3140 enforce that rule.  The warning is inactive inside a system header file,
3141 such as the STL, so one can still use the STL.  One may also define
3142 classes that indirectly use virtual inheritance.
3144 @item -Wnamespaces
3145 @opindex Wnamespaces
3146 Warn when a namespace definition is opened.  Some coding rules disallow
3147 namespaces, and this may be used to enforce that rule.  The warning is
3148 inactive inside a system header file, such as the STL, so one can still
3149 use the STL.  One may also use using directives and qualified names.
3151 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
3152 @opindex Wterminate
3153 @opindex Wno-terminate
3154 Disable the warning about a throw-expression that will immediately
3155 result in a call to @code{terminate}.
3156 @end table
3158 @node Objective-C and Objective-C++ Dialect Options
3159 @section Options Controlling Objective-C and Objective-C++ Dialects
3161 @cindex compiler options, Objective-C and Objective-C++
3162 @cindex Objective-C and Objective-C++ options, command-line
3163 @cindex options, Objective-C and Objective-C++
3164 (NOTE: This manual does not describe the Objective-C and Objective-C++
3165 languages themselves.  @xref{Standards,,Language Standards
3166 Supported by GCC}, for references.)
3168 This section describes the command-line options that are only meaningful
3169 for Objective-C and Objective-C++ programs.  You can also use most of
3170 the language-independent GNU compiler options.
3171 For example, you might compile a file @file{some_class.m} like this:
3173 @smallexample
3174 gcc -g -fgnu-runtime -O -c some_class.m
3175 @end smallexample
3177 @noindent
3178 In this example, @option{-fgnu-runtime} is an option meant only for
3179 Objective-C and Objective-C++ programs; you can use the other options with
3180 any language supported by GCC@.
3182 Note that since Objective-C is an extension of the C language, Objective-C
3183 compilations may also use options specific to the C front-end (e.g.,
3184 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3185 C++-specific options (e.g., @option{-Wabi}).
3187 Here is a list of options that are @emph{only} for compiling Objective-C
3188 and Objective-C++ programs:
3190 @table @gcctabopt
3191 @item -fconstant-string-class=@var{class-name}
3192 @opindex fconstant-string-class
3193 Use @var{class-name} as the name of the class to instantiate for each
3194 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3195 class name is @code{NXConstantString} if the GNU runtime is being used, and
3196 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3197 @option{-fconstant-cfstrings} option, if also present, overrides the
3198 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3199 to be laid out as constant CoreFoundation strings.
3201 @item -fgnu-runtime
3202 @opindex fgnu-runtime
3203 Generate object code compatible with the standard GNU Objective-C
3204 runtime.  This is the default for most types of systems.
3206 @item -fnext-runtime
3207 @opindex fnext-runtime
3208 Generate output compatible with the NeXT runtime.  This is the default
3209 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3210 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3211 used.
3213 @item -fno-nil-receivers
3214 @opindex fno-nil-receivers
3215 Assume that all Objective-C message dispatches (@code{[receiver
3216 message:arg]}) in this translation unit ensure that the receiver is
3217 not @code{nil}.  This allows for more efficient entry points in the
3218 runtime to be used.  This option is only available in conjunction with
3219 the NeXT runtime and ABI version 0 or 1.
3221 @item -fobjc-abi-version=@var{n}
3222 @opindex fobjc-abi-version
3223 Use version @var{n} of the Objective-C ABI for the selected runtime.
3224 This option is currently supported only for the NeXT runtime.  In that
3225 case, Version 0 is the traditional (32-bit) ABI without support for
3226 properties and other Objective-C 2.0 additions.  Version 1 is the
3227 traditional (32-bit) ABI with support for properties and other
3228 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3229 nothing is specified, the default is Version 0 on 32-bit target
3230 machines, and Version 2 on 64-bit target machines.
3232 @item -fobjc-call-cxx-cdtors
3233 @opindex fobjc-call-cxx-cdtors
3234 For each Objective-C class, check if any of its instance variables is a
3235 C++ object with a non-trivial default constructor.  If so, synthesize a
3236 special @code{- (id) .cxx_construct} instance method which runs
3237 non-trivial default constructors on any such instance variables, in order,
3238 and then return @code{self}.  Similarly, check if any instance variable
3239 is a C++ object with a non-trivial destructor, and if so, synthesize a
3240 special @code{- (void) .cxx_destruct} method which runs
3241 all such default destructors, in reverse order.
3243 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3244 methods thusly generated only operate on instance variables
3245 declared in the current Objective-C class, and not those inherited
3246 from superclasses.  It is the responsibility of the Objective-C
3247 runtime to invoke all such methods in an object's inheritance
3248 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3249 by the runtime immediately after a new object instance is allocated;
3250 the @code{- (void) .cxx_destruct} methods are invoked immediately
3251 before the runtime deallocates an object instance.
3253 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3254 support for invoking the @code{- (id) .cxx_construct} and
3255 @code{- (void) .cxx_destruct} methods.
3257 @item -fobjc-direct-dispatch
3258 @opindex fobjc-direct-dispatch
3259 Allow fast jumps to the message dispatcher.  On Darwin this is
3260 accomplished via the comm page.
3262 @item -fobjc-exceptions
3263 @opindex fobjc-exceptions
3264 Enable syntactic support for structured exception handling in
3265 Objective-C, similar to what is offered by C++.  This option
3266 is required to use the Objective-C keywords @code{@@try},
3267 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3268 @code{@@synchronized}.  This option is available with both the GNU
3269 runtime and the NeXT runtime (but not available in conjunction with
3270 the NeXT runtime on Mac OS X 10.2 and earlier).
3272 @item -fobjc-gc
3273 @opindex fobjc-gc
3274 Enable garbage collection (GC) in Objective-C and Objective-C++
3275 programs.  This option is only available with the NeXT runtime; the
3276 GNU runtime has a different garbage collection implementation that
3277 does not require special compiler flags.
3279 @item -fobjc-nilcheck
3280 @opindex fobjc-nilcheck
3281 For the NeXT runtime with version 2 of the ABI, check for a nil
3282 receiver in method invocations before doing the actual method call.
3283 This is the default and can be disabled using
3284 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3285 checked for nil in this way no matter what this flag is set to.
3286 Currently this flag does nothing when the GNU runtime, or an older
3287 version of the NeXT runtime ABI, is used.
3289 @item -fobjc-std=objc1
3290 @opindex fobjc-std
3291 Conform to the language syntax of Objective-C 1.0, the language
3292 recognized by GCC 4.0.  This only affects the Objective-C additions to
3293 the C/C++ language; it does not affect conformance to C/C++ standards,
3294 which is controlled by the separate C/C++ dialect option flags.  When
3295 this option is used with the Objective-C or Objective-C++ compiler,
3296 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3297 This is useful if you need to make sure that your Objective-C code can
3298 be compiled with older versions of GCC@.
3300 @item -freplace-objc-classes
3301 @opindex freplace-objc-classes
3302 Emit a special marker instructing @command{ld(1)} not to statically link in
3303 the resulting object file, and allow @command{dyld(1)} to load it in at
3304 run time instead.  This is used in conjunction with the Fix-and-Continue
3305 debugging mode, where the object file in question may be recompiled and
3306 dynamically reloaded in the course of program execution, without the need
3307 to restart the program itself.  Currently, Fix-and-Continue functionality
3308 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3309 and later.
3311 @item -fzero-link
3312 @opindex fzero-link
3313 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3314 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3315 compile time) with static class references that get initialized at load time,
3316 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3317 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3318 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3319 for individual class implementations to be modified during program execution.
3320 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3321 regardless of command-line options.
3323 @item -fno-local-ivars
3324 @opindex fno-local-ivars
3325 @opindex flocal-ivars
3326 By default instance variables in Objective-C can be accessed as if
3327 they were local variables from within the methods of the class they're
3328 declared in.  This can lead to shadowing between instance variables
3329 and other variables declared either locally inside a class method or
3330 globally with the same name.  Specifying the @option{-fno-local-ivars}
3331 flag disables this behavior thus avoiding variable shadowing issues.
3333 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3334 @opindex fivar-visibility
3335 Set the default instance variable visibility to the specified option
3336 so that instance variables declared outside the scope of any access
3337 modifier directives default to the specified visibility.
3339 @item -gen-decls
3340 @opindex gen-decls
3341 Dump interface declarations for all classes seen in the source file to a
3342 file named @file{@var{sourcename}.decl}.
3344 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3345 @opindex Wassign-intercept
3346 @opindex Wno-assign-intercept
3347 Warn whenever an Objective-C assignment is being intercepted by the
3348 garbage collector.
3350 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3351 @opindex Wno-protocol
3352 @opindex Wprotocol
3353 If a class is declared to implement a protocol, a warning is issued for
3354 every method in the protocol that is not implemented by the class.  The
3355 default behavior is to issue a warning for every method not explicitly
3356 implemented in the class, even if a method implementation is inherited
3357 from the superclass.  If you use the @option{-Wno-protocol} option, then
3358 methods inherited from the superclass are considered to be implemented,
3359 and no warning is issued for them.
3361 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3362 @opindex Wselector
3363 @opindex Wno-selector
3364 Warn if multiple methods of different types for the same selector are
3365 found during compilation.  The check is performed on the list of methods
3366 in the final stage of compilation.  Additionally, a check is performed
3367 for each selector appearing in a @code{@@selector(@dots{})}
3368 expression, and a corresponding method for that selector has been found
3369 during compilation.  Because these checks scan the method table only at
3370 the end of compilation, these warnings are not produced if the final
3371 stage of compilation is not reached, for example because an error is
3372 found during compilation, or because the @option{-fsyntax-only} option is
3373 being used.
3375 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3376 @opindex Wstrict-selector-match
3377 @opindex Wno-strict-selector-match
3378 Warn if multiple methods with differing argument and/or return types are
3379 found for a given selector when attempting to send a message using this
3380 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3381 is off (which is the default behavior), the compiler omits such warnings
3382 if any differences found are confined to types that share the same size
3383 and alignment.
3385 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3386 @opindex Wundeclared-selector
3387 @opindex Wno-undeclared-selector
3388 Warn if a @code{@@selector(@dots{})} expression referring to an
3389 undeclared selector is found.  A selector is considered undeclared if no
3390 method with that name has been declared before the
3391 @code{@@selector(@dots{})} expression, either explicitly in an
3392 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3393 an @code{@@implementation} section.  This option always performs its
3394 checks as soon as a @code{@@selector(@dots{})} expression is found,
3395 while @option{-Wselector} only performs its checks in the final stage of
3396 compilation.  This also enforces the coding style convention
3397 that methods and selectors must be declared before being used.
3399 @item -print-objc-runtime-info
3400 @opindex print-objc-runtime-info
3401 Generate C header describing the largest structure that is passed by
3402 value, if any.
3404 @end table
3406 @node Diagnostic Message Formatting Options
3407 @section Options to Control Diagnostic Messages Formatting
3408 @cindex options to control diagnostics formatting
3409 @cindex diagnostic messages
3410 @cindex message formatting
3412 Traditionally, diagnostic messages have been formatted irrespective of
3413 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3414 options described below
3415 to control the formatting algorithm for diagnostic messages, 
3416 e.g.@: how many characters per line, how often source location
3417 information should be reported.  Note that some language front ends may not
3418 honor these options.
3420 @table @gcctabopt
3421 @item -fmessage-length=@var{n}
3422 @opindex fmessage-length
3423 Try to format error messages so that they fit on lines of about
3424 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3425 done; each error message appears on a single line.  This is the
3426 default for all front ends.
3428 @item -fdiagnostics-show-location=once
3429 @opindex fdiagnostics-show-location
3430 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3431 reporter to emit source location information @emph{once}; that is, in
3432 case the message is too long to fit on a single physical line and has to
3433 be wrapped, the source location won't be emitted (as prefix) again,
3434 over and over, in subsequent continuation lines.  This is the default
3435 behavior.
3437 @item -fdiagnostics-show-location=every-line
3438 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3439 messages reporter to emit the same source location information (as
3440 prefix) for physical lines that result from the process of breaking
3441 a message which is too long to fit on a single line.
3443 @item -fdiagnostics-color[=@var{WHEN}]
3444 @itemx -fno-diagnostics-color
3445 @opindex fdiagnostics-color
3446 @cindex highlight, color
3447 @vindex GCC_COLORS @r{environment variable}
3448 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3449 or @samp{auto}.  The default depends on how the compiler has been configured,
3450 it can be any of the above @var{WHEN} options or also @samp{never}
3451 if @env{GCC_COLORS} environment variable isn't present in the environment,
3452 and @samp{auto} otherwise.
3453 @samp{auto} means to use color only when the standard error is a terminal.
3454 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3455 aliases for @option{-fdiagnostics-color=always} and
3456 @option{-fdiagnostics-color=never}, respectively.
3458 The colors are defined by the environment variable @env{GCC_COLORS}.
3459 Its value is a colon-separated list of capabilities and Select Graphic
3460 Rendition (SGR) substrings. SGR commands are interpreted by the
3461 terminal or terminal emulator.  (See the section in the documentation
3462 of your text terminal for permitted values and their meanings as
3463 character attributes.)  These substring values are integers in decimal
3464 representation and can be concatenated with semicolons.
3465 Common values to concatenate include
3466 @samp{1} for bold,
3467 @samp{4} for underline,
3468 @samp{5} for blink,
3469 @samp{7} for inverse,
3470 @samp{39} for default foreground color,
3471 @samp{30} to @samp{37} for foreground colors,
3472 @samp{90} to @samp{97} for 16-color mode foreground colors,
3473 @samp{38;5;0} to @samp{38;5;255}
3474 for 88-color and 256-color modes foreground colors,
3475 @samp{49} for default background color,
3476 @samp{40} to @samp{47} for background colors,
3477 @samp{100} to @samp{107} for 16-color mode background colors,
3478 and @samp{48;5;0} to @samp{48;5;255}
3479 for 88-color and 256-color modes background colors.
3481 The default @env{GCC_COLORS} is
3482 @smallexample
3483 error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
3484 quote=01:fixit-insert=32:fixit-delete=31:\
3485 diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\
3486 type-diff=01;32
3487 @end smallexample
3488 @noindent
3489 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3490 @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue,
3491 @samp{01} is bold, and @samp{31} is red.
3492 Setting @env{GCC_COLORS} to the empty string disables colors.
3493 Supported capabilities are as follows.
3495 @table @code
3496 @item error=
3497 @vindex error GCC_COLORS @r{capability}
3498 SGR substring for error: markers.
3500 @item warning=
3501 @vindex warning GCC_COLORS @r{capability}
3502 SGR substring for warning: markers.
3504 @item note=
3505 @vindex note GCC_COLORS @r{capability}
3506 SGR substring for note: markers.
3508 @item range1=
3509 @vindex range1 GCC_COLORS @r{capability}
3510 SGR substring for first additional range.
3512 @item range2=
3513 @vindex range2 GCC_COLORS @r{capability}
3514 SGR substring for second additional range.
3516 @item locus=
3517 @vindex locus GCC_COLORS @r{capability}
3518 SGR substring for location information, @samp{file:line} or
3519 @samp{file:line:column} etc.
3521 @item quote=
3522 @vindex quote GCC_COLORS @r{capability}
3523 SGR substring for information printed within quotes.
3525 @item fixit-insert=
3526 @vindex fixit-insert GCC_COLORS @r{capability}
3527 SGR substring for fix-it hints suggesting text to
3528 be inserted or replaced.
3530 @item fixit-delete=
3531 @vindex fixit-delete GCC_COLORS @r{capability}
3532 SGR substring for fix-it hints suggesting text to
3533 be deleted.
3535 @item diff-filename=
3536 @vindex diff-filename GCC_COLORS @r{capability}
3537 SGR substring for filename headers within generated patches.
3539 @item diff-hunk=
3540 @vindex diff-hunk GCC_COLORS @r{capability}
3541 SGR substring for the starts of hunks within generated patches.
3543 @item diff-delete=
3544 @vindex diff-delete GCC_COLORS @r{capability}
3545 SGR substring for deleted lines within generated patches.
3547 @item diff-insert=
3548 @vindex diff-insert GCC_COLORS @r{capability}
3549 SGR substring for inserted lines within generated patches.
3551 @item type-diff=
3552 @vindex type-diff GCC_COLORS @r{capability}
3553 SGR substring for highlighting mismatching types within template
3554 arguments in the C++ frontend.
3555 @end table
3557 @item -fno-diagnostics-show-option
3558 @opindex fno-diagnostics-show-option
3559 @opindex fdiagnostics-show-option
3560 By default, each diagnostic emitted includes text indicating the
3561 command-line option that directly controls the diagnostic (if such an
3562 option is known to the diagnostic machinery).  Specifying the
3563 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3565 @item -fno-diagnostics-show-caret
3566 @opindex fno-diagnostics-show-caret
3567 @opindex fdiagnostics-show-caret
3568 By default, each diagnostic emitted includes the original source line
3569 and a caret @samp{^} indicating the column.  This option suppresses this
3570 information.  The source line is truncated to @var{n} characters, if
3571 the @option{-fmessage-length=n} option is given.  When the output is done
3572 to the terminal, the width is limited to the width given by the
3573 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3575 @item -fdiagnostics-parseable-fixits
3576 @opindex fdiagnostics-parseable-fixits
3577 Emit fix-it hints in a machine-parseable format, suitable for consumption
3578 by IDEs.  For each fix-it, a line will be printed after the relevant
3579 diagnostic, starting with the string ``fix-it:''.  For example:
3581 @smallexample
3582 fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all"
3583 @end smallexample
3585 The location is expressed as a half-open range, expressed as a count of
3586 bytes, starting at byte 1 for the initial column.  In the above example,
3587 bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the
3588 given string:
3590 @smallexample
3591 00000000011111111112222222222
3592 12345678901234567890123456789
3593   gtk_widget_showall (dlg);
3594   ^^^^^^^^^^^^^^^^^^
3595   gtk_widget_show_all
3596 @end smallexample
3598 The filename and replacement string escape backslash as ``\\", tab as ``\t'',
3599 newline as ``\n'', double quotes as ``\"'', non-printable characters as octal
3600 (e.g. vertical tab as ``\013'').
3602 An empty replacement string indicates that the given range is to be removed.
3603 An empty range (e.g. ``45:3-45:3'') indicates that the string is to
3604 be inserted at the given position.
3606 @item -fdiagnostics-generate-patch
3607 @opindex fdiagnostics-generate-patch
3608 Print fix-it hints to stderr in unified diff format, after any diagnostics
3609 are printed.  For example:
3611 @smallexample
3612 --- test.c
3613 +++ test.c
3614 @@ -42,5 +42,5 @@
3616  void show_cb(GtkDialog *dlg)
3617  @{
3618 -  gtk_widget_showall(dlg);
3619 +  gtk_widget_show_all(dlg);
3620  @}
3622 @end smallexample
3624 The diff may or may not be colorized, following the same rules
3625 as for diagnostics (see @option{-fdiagnostics-color}).
3627 @item -fdiagnostics-show-template-tree
3628 @opindex fdiagnostics-show-template-tree
3630 In the C++ frontend, when printing diagnostics showing mismatching
3631 template types, such as:
3633 @smallexample
3634   could not convert 'std::map<int, std::vector<double> >()'
3635     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3636 @end smallexample
3638 the @option{-fdiagnostics-show-template-tree} flag enables printing a
3639 tree-like structure showing the common and differing parts of the types,
3640 such as:
3642 @smallexample
3643   map<
3644     [...],
3645     vector<
3646       [double != float]>>
3647 @end smallexample
3649 The parts that differ are highlighted with color (``double'' and
3650 ``float'' in this case).
3652 @item -fno-elide-type
3653 @opindex fno-elide-type
3654 @opindex felide-type
3655 By default when the C++ frontend prints diagnostics showing mismatching
3656 template types, common parts of the types are printed as ``[...]'' to
3657 simplify the error message.  For example:
3659 @smallexample
3660   could not convert 'std::map<int, std::vector<double> >()'
3661     from 'map<[...],vector<double>>' to 'map<[...],vector<float>>
3662 @end smallexample
3664 Specifying the @option{-fno-elide-type} flag suppresses that behavior.
3665 This flag also affects the output of the
3666 @option{-fdiagnostics-show-template-tree} flag.
3668 @item -fno-show-column
3669 @opindex fno-show-column
3670 Do not print column numbers in diagnostics.  This may be necessary if
3671 diagnostics are being scanned by a program that does not understand the
3672 column numbers, such as @command{dejagnu}.
3674 @end table
3676 @node Warning Options
3677 @section Options to Request or Suppress Warnings
3678 @cindex options to control warnings
3679 @cindex warning messages
3680 @cindex messages, warning
3681 @cindex suppressing warnings
3683 Warnings are diagnostic messages that report constructions that
3684 are not inherently erroneous but that are risky or suggest there
3685 may have been an error.
3687 The following language-independent options do not enable specific
3688 warnings but control the kinds of diagnostics produced by GCC@.
3690 @table @gcctabopt
3691 @cindex syntax checking
3692 @item -fsyntax-only
3693 @opindex fsyntax-only
3694 Check the code for syntax errors, but don't do anything beyond that.
3696 @item -fmax-errors=@var{n}
3697 @opindex fmax-errors
3698 Limits the maximum number of error messages to @var{n}, at which point
3699 GCC bails out rather than attempting to continue processing the source
3700 code.  If @var{n} is 0 (the default), there is no limit on the number
3701 of error messages produced.  If @option{-Wfatal-errors} is also
3702 specified, then @option{-Wfatal-errors} takes precedence over this
3703 option.
3705 @item -w
3706 @opindex w
3707 Inhibit all warning messages.
3709 @item -Werror
3710 @opindex Werror
3711 @opindex Wno-error
3712 Make all warnings into errors.
3714 @item -Werror=
3715 @opindex Werror=
3716 @opindex Wno-error=
3717 Make the specified warning into an error.  The specifier for a warning
3718 is appended; for example @option{-Werror=switch} turns the warnings
3719 controlled by @option{-Wswitch} into errors.  This switch takes a
3720 negative form, to be used to negate @option{-Werror} for specific
3721 warnings; for example @option{-Wno-error=switch} makes
3722 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3723 is in effect.
3725 The warning message for each controllable warning includes the
3726 option that controls the warning.  That option can then be used with
3727 @option{-Werror=} and @option{-Wno-error=} as described above.
3728 (Printing of the option in the warning message can be disabled using the
3729 @option{-fno-diagnostics-show-option} flag.)
3731 Note that specifying @option{-Werror=}@var{foo} automatically implies
3732 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3733 imply anything.
3735 @item -Wfatal-errors
3736 @opindex Wfatal-errors
3737 @opindex Wno-fatal-errors
3738 This option causes the compiler to abort compilation on the first error
3739 occurred rather than trying to keep going and printing further error
3740 messages.
3742 @end table
3744 You can request many specific warnings with options beginning with
3745 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3746 implicit declarations.  Each of these specific warning options also
3747 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3748 example, @option{-Wno-implicit}.  This manual lists only one of the
3749 two forms, whichever is not the default.  For further
3750 language-specific options also refer to @ref{C++ Dialect Options} and
3751 @ref{Objective-C and Objective-C++ Dialect Options}.
3753 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3754 options, such as @option{-Wunused}, which may turn on further options,
3755 such as @option{-Wunused-value}. The combined effect of positive and
3756 negative forms is that more specific options have priority over less
3757 specific ones, independently of their position in the command-line. For
3758 options of the same specificity, the last one takes effect. Options
3759 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3760 as if they appeared at the end of the command-line.
3762 When an unrecognized warning option is requested (e.g.,
3763 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3764 that the option is not recognized.  However, if the @option{-Wno-} form
3765 is used, the behavior is slightly different: no diagnostic is
3766 produced for @option{-Wno-unknown-warning} unless other diagnostics
3767 are being produced.  This allows the use of new @option{-Wno-} options
3768 with old compilers, but if something goes wrong, the compiler
3769 warns that an unrecognized option is present.
3771 @table @gcctabopt
3772 @item -Wpedantic
3773 @itemx -pedantic
3774 @opindex pedantic
3775 @opindex Wpedantic
3776 Issue all the warnings demanded by strict ISO C and ISO C++;
3777 reject all programs that use forbidden extensions, and some other
3778 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3779 version of the ISO C standard specified by any @option{-std} option used.
3781 Valid ISO C and ISO C++ programs should compile properly with or without
3782 this option (though a rare few require @option{-ansi} or a
3783 @option{-std} option specifying the required version of ISO C)@.  However,
3784 without this option, certain GNU extensions and traditional C and C++
3785 features are supported as well.  With this option, they are rejected.
3787 @option{-Wpedantic} does not cause warning messages for use of the
3788 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3789 warnings are also disabled in the expression that follows
3790 @code{__extension__}.  However, only system header files should use
3791 these escape routes; application programs should avoid them.
3792 @xref{Alternate Keywords}.
3794 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3795 C conformance.  They soon find that it does not do quite what they want:
3796 it finds some non-ISO practices, but not all---only those for which
3797 ISO C @emph{requires} a diagnostic, and some others for which
3798 diagnostics have been added.
3800 A feature to report any failure to conform to ISO C might be useful in
3801 some instances, but would require considerable additional work and would
3802 be quite different from @option{-Wpedantic}.  We don't have plans to
3803 support such a feature in the near future.
3805 Where the standard specified with @option{-std} represents a GNU
3806 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3807 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3808 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3809 where they are required by the base standard.  (It does not make sense
3810 for such warnings to be given only for features not in the specified GNU
3811 C dialect, since by definition the GNU dialects of C include all
3812 features the compiler supports with the given option, and there would be
3813 nothing to warn about.)
3815 @item -pedantic-errors
3816 @opindex pedantic-errors
3817 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3818 requires a diagnostic, in some cases where there is undefined behavior
3819 at compile-time and in some other cases that do not prevent compilation
3820 of programs that are valid according to the standard. This is not
3821 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3822 by this option and not enabled by the latter and vice versa.
3824 @item -Wall
3825 @opindex Wall
3826 @opindex Wno-all
3827 This enables all the warnings about constructions that some users
3828 consider questionable, and that are easy to avoid (or modify to
3829 prevent the warning), even in conjunction with macros.  This also
3830 enables some language-specific warnings described in @ref{C++ Dialect
3831 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3833 @option{-Wall} turns on the following warning flags:
3835 @gccoptlist{-Waddress   @gol
3836 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3837 -Wbool-compare  @gol
3838 -Wbool-operation  @gol
3839 -Wc++11-compat  -Wc++14-compat  @gol
3840 -Wcatch-value @r{(C++ and Objective-C++ only)}  @gol
3841 -Wchar-subscripts  @gol
3842 -Wcomment  @gol
3843 -Wduplicate-decl-specifier @r{(C and Objective-C only)} @gol
3844 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3845 -Wformat   @gol
3846 -Wint-in-bool-context  @gol
3847 -Wimplicit @r{(C and Objective-C only)} @gol
3848 -Wimplicit-int @r{(C and Objective-C only)} @gol
3849 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3850 -Winit-self @r{(only for C++)} @gol
3851 -Wlogical-not-parentheses @gol
3852 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3853 -Wmaybe-uninitialized @gol
3854 -Wmemset-elt-size @gol
3855 -Wmemset-transposed-args @gol
3856 -Wmisleading-indentation @r{(only for C/C++)} @gol
3857 -Wmissing-braces @r{(only for C/ObjC)} @gol
3858 -Wmultistatement-macros  @gol
3859 -Wnarrowing @r{(only for C++)}  @gol
3860 -Wnonnull  @gol
3861 -Wnonnull-compare  @gol
3862 -Wopenmp-simd @gol
3863 -Wparentheses  @gol
3864 -Wpointer-sign  @gol
3865 -Wreorder   @gol
3866 -Wreturn-type  @gol
3867 -Wsequence-point  @gol
3868 -Wsign-compare @r{(only in C++)}  @gol
3869 -Wsizeof-pointer-div @gol
3870 -Wsizeof-pointer-memaccess @gol
3871 -Wstrict-aliasing  @gol
3872 -Wstrict-overflow=1  @gol
3873 -Wswitch  @gol
3874 -Wtautological-compare  @gol
3875 -Wtrigraphs  @gol
3876 -Wuninitialized  @gol
3877 -Wunknown-pragmas  @gol
3878 -Wunused-function  @gol
3879 -Wunused-label     @gol
3880 -Wunused-value     @gol
3881 -Wunused-variable  @gol
3882 -Wvolatile-register-var @gol
3885 Note that some warning flags are not implied by @option{-Wall}.  Some of
3886 them warn about constructions that users generally do not consider
3887 questionable, but which occasionally you might wish to check for;
3888 others warn about constructions that are necessary or hard to avoid in
3889 some cases, and there is no simple way to modify the code to suppress
3890 the warning. Some of them are enabled by @option{-Wextra} but many of
3891 them must be enabled individually.
3893 @item -Wextra
3894 @opindex W
3895 @opindex Wextra
3896 @opindex Wno-extra
3897 This enables some extra warning flags that are not enabled by
3898 @option{-Wall}. (This option used to be called @option{-W}.  The older
3899 name is still supported, but the newer name is more descriptive.)
3901 @gccoptlist{-Wclobbered  @gol
3902 -Wempty-body  @gol
3903 -Wignored-qualifiers @gol
3904 -Wimplicit-fallthrough=3 @gol
3905 -Wmissing-field-initializers  @gol
3906 -Wmissing-parameter-type @r{(C only)}  @gol
3907 -Wold-style-declaration @r{(C only)}  @gol
3908 -Woverride-init  @gol
3909 -Wsign-compare @r{(C only)} @gol
3910 -Wtype-limits  @gol
3911 -Wuninitialized  @gol
3912 -Wshift-negative-value @r{(in C++03 and in C99 and newer)}  @gol
3913 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3914 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3917 The option @option{-Wextra} also prints warning messages for the
3918 following cases:
3920 @itemize @bullet
3922 @item
3923 A pointer is compared against integer zero with @code{<}, @code{<=},
3924 @code{>}, or @code{>=}.
3926 @item
3927 (C++ only) An enumerator and a non-enumerator both appear in a
3928 conditional expression.
3930 @item
3931 (C++ only) Ambiguous virtual bases.
3933 @item
3934 (C++ only) Subscripting an array that has been declared @code{register}.
3936 @item
3937 (C++ only) Taking the address of a variable that has been declared
3938 @code{register}.
3940 @item
3941 (C++ only) A base class is not initialized in the copy constructor
3942 of a derived class.
3944 @end itemize
3946 @item -Wchar-subscripts
3947 @opindex Wchar-subscripts
3948 @opindex Wno-char-subscripts
3949 Warn if an array subscript has type @code{char}.  This is a common cause
3950 of error, as programmers often forget that this type is signed on some
3951 machines.
3952 This warning is enabled by @option{-Wall}.
3954 @item -Wchkp
3955 @opindex Wchkp
3956 Warn about an invalid memory access that is found by Pointer Bounds Checker
3957 (@option{-fcheck-pointer-bounds}).
3959 @item -Wno-coverage-mismatch
3960 @opindex Wno-coverage-mismatch
3961 Warn if feedback profiles do not match when using the
3962 @option{-fprofile-use} option.
3963 If a source file is changed between compiling with @option{-fprofile-gen} and
3964 with @option{-fprofile-use}, the files with the profile feedback can fail
3965 to match the source file and GCC cannot use the profile feedback
3966 information.  By default, this warning is enabled and is treated as an
3967 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3968 warning or @option{-Wno-error=coverage-mismatch} can be used to
3969 disable the error.  Disabling the error for this warning can result in
3970 poorly optimized code and is useful only in the
3971 case of very minor changes such as bug fixes to an existing code-base.
3972 Completely disabling the warning is not recommended.
3974 @item -Wno-cpp
3975 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3977 Suppress warning messages emitted by @code{#warning} directives.
3979 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3980 @opindex Wdouble-promotion
3981 @opindex Wno-double-promotion
3982 Give a warning when a value of type @code{float} is implicitly
3983 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3984 floating-point unit implement @code{float} in hardware, but emulate
3985 @code{double} in software.  On such a machine, doing computations
3986 using @code{double} values is much more expensive because of the
3987 overhead required for software emulation.
3989 It is easy to accidentally do computations with @code{double} because
3990 floating-point literals are implicitly of type @code{double}.  For
3991 example, in:
3992 @smallexample
3993 @group
3994 float area(float radius)
3996    return 3.14159 * radius * radius;
3998 @end group
3999 @end smallexample
4000 the compiler performs the entire computation with @code{double}
4001 because the floating-point literal is a @code{double}.
4003 @item -Wduplicate-decl-specifier @r{(C and Objective-C only)}
4004 @opindex Wduplicate-decl-specifier
4005 @opindex Wno-duplicate-decl-specifier
4006 Warn if a declaration has duplicate @code{const}, @code{volatile},
4007 @code{restrict} or @code{_Atomic} specifier.  This warning is enabled by
4008 @option{-Wall}.
4010 @item -Wformat
4011 @itemx -Wformat=@var{n}
4012 @opindex Wformat
4013 @opindex Wno-format
4014 @opindex ffreestanding
4015 @opindex fno-builtin
4016 @opindex Wformat=
4017 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
4018 the arguments supplied have types appropriate to the format string
4019 specified, and that the conversions specified in the format string make
4020 sense.  This includes standard functions, and others specified by format
4021 attributes (@pxref{Function Attributes}), in the @code{printf},
4022 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
4023 not in the C standard) families (or other target-specific families).
4024 Which functions are checked without format attributes having been
4025 specified depends on the standard version selected, and such checks of
4026 functions without the attribute specified are disabled by
4027 @option{-ffreestanding} or @option{-fno-builtin}.
4029 The formats are checked against the format features supported by GNU
4030 libc version 2.2.  These include all ISO C90 and C99 features, as well
4031 as features from the Single Unix Specification and some BSD and GNU
4032 extensions.  Other library implementations may not support all these
4033 features; GCC does not support warning about features that go beyond a
4034 particular library's limitations.  However, if @option{-Wpedantic} is used
4035 with @option{-Wformat}, warnings are given about format features not
4036 in the selected standard version (but not for @code{strfmon} formats,
4037 since those are not in any version of the C standard).  @xref{C Dialect
4038 Options,,Options Controlling C Dialect}.
4040 @table @gcctabopt
4041 @item -Wformat=1
4042 @itemx -Wformat
4043 @opindex Wformat
4044 @opindex Wformat=1
4045 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
4046 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
4047 @option{-Wformat} also checks for null format arguments for several
4048 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
4049 aspects of this level of format checking can be disabled by the
4050 options: @option{-Wno-format-contains-nul},
4051 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
4052 @option{-Wformat} is enabled by @option{-Wall}.
4054 @item -Wno-format-contains-nul
4055 @opindex Wno-format-contains-nul
4056 @opindex Wformat-contains-nul
4057 If @option{-Wformat} is specified, do not warn about format strings that
4058 contain NUL bytes.
4060 @item -Wno-format-extra-args
4061 @opindex Wno-format-extra-args
4062 @opindex Wformat-extra-args
4063 If @option{-Wformat} is specified, do not warn about excess arguments to a
4064 @code{printf} or @code{scanf} format function.  The C standard specifies
4065 that such arguments are ignored.
4067 Where the unused arguments lie between used arguments that are
4068 specified with @samp{$} operand number specifications, normally
4069 warnings are still given, since the implementation could not know what
4070 type to pass to @code{va_arg} to skip the unused arguments.  However,
4071 in the case of @code{scanf} formats, this option suppresses the
4072 warning if the unused arguments are all pointers, since the Single
4073 Unix Specification says that such unused arguments are allowed.
4075 @item -Wformat-overflow
4076 @itemx -Wformat-overflow=@var{level}
4077 @opindex Wformat-overflow
4078 @opindex Wno-format-overflow
4079 Warn about calls to formatted input/output functions such as @code{sprintf}
4080 and @code{vsprintf} that might overflow the destination buffer.  When the
4081 exact number of bytes written by a format directive cannot be determined
4082 at compile-time it is estimated based on heuristics that depend on the
4083 @var{level} argument and on optimization.  While enabling optimization
4084 will in most cases improve the accuracy of the warning, it may also
4085 result in false positives.
4087 @table @gcctabopt
4088 @item -Wformat-overflow
4089 @item -Wformat-overflow=1
4090 @opindex Wformat-overflow
4091 @opindex Wno-format-overflow
4092 Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat}
4093 employs a conservative approach that warns only about calls that most
4094 likely overflow the buffer.  At this level, numeric arguments to format
4095 directives with unknown values are assumed to have the value of one, and
4096 strings of unknown length to be empty.  Numeric arguments that are known
4097 to be bounded to a subrange of their type, or string arguments whose output
4098 is bounded either by their directive's precision or by a finite set of
4099 string literals, are assumed to take on the value within the range that
4100 results in the most bytes on output.  For example, the call to @code{sprintf}
4101 below is diagnosed because even with both @var{a} and @var{b} equal to zero,
4102 the terminating NUL character (@code{'\0'}) appended by the function
4103 to the destination buffer will be written past its end.  Increasing
4104 the size of the buffer by a single byte is sufficient to avoid the
4105 warning, though it may not be sufficient to avoid the overflow.
4107 @smallexample
4108 void f (int a, int b)
4110   char buf [12];
4111   sprintf (buf, "a = %i, b = %i\n", a, b);
4113 @end smallexample
4115 @item -Wformat-overflow=2
4116 Level @var{2} warns also about calls that might overflow the destination
4117 buffer given an argument of sufficient length or magnitude.  At level
4118 @var{2}, unknown numeric arguments are assumed to have the minimum
4119 representable value for signed types with a precision greater than 1, and
4120 the maximum representable value otherwise.  Unknown string arguments whose
4121 length cannot be assumed to be bounded either by the directive's precision,
4122 or by a finite set of string literals they may evaluate to, or the character
4123 array they may point to, are assumed to be 1 character long.
4125 At level @var{2}, the call in the example above is again diagnosed, but
4126 this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first
4127 @code{%i} directive will write some of its digits beyond the end of
4128 the destination buffer.  To make the call safe regardless of the values
4129 of the two variables, the size of the destination buffer must be increased
4130 to at least 34 bytes.  GCC includes the minimum size of the buffer in
4131 an informational note following the warning.
4133 An alternative to increasing the size of the destination buffer is to
4134 constrain the range of formatted values.  The maximum length of string
4135 arguments can be bounded by specifying the precision in the format
4136 directive.  When numeric arguments of format directives can be assumed
4137 to be bounded by less than the precision of their type, choosing
4138 an appropriate length modifier to the format specifier will reduce
4139 the required buffer size.  For example, if @var{a} and @var{b} in the
4140 example above can be assumed to be within the precision of
4141 the @code{short int} type then using either the @code{%hi} format
4142 directive or casting the argument to @code{short} reduces the maximum
4143 required size of the buffer to 24 bytes.
4145 @smallexample
4146 void f (int a, int b)
4148   char buf [23];
4149   sprintf (buf, "a = %hi, b = %i\n", a, (short)b);
4151 @end smallexample
4152 @end table
4154 @item -Wno-format-zero-length
4155 @opindex Wno-format-zero-length
4156 @opindex Wformat-zero-length
4157 If @option{-Wformat} is specified, do not warn about zero-length formats.
4158 The C standard specifies that zero-length formats are allowed.
4161 @item -Wformat=2
4162 @opindex Wformat=2
4163 Enable @option{-Wformat} plus additional format checks.  Currently
4164 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
4165 -Wformat-y2k}.
4167 @item -Wformat-nonliteral
4168 @opindex Wformat-nonliteral
4169 @opindex Wno-format-nonliteral
4170 If @option{-Wformat} is specified, also warn if the format string is not a
4171 string literal and so cannot be checked, unless the format function
4172 takes its format arguments as a @code{va_list}.
4174 @item -Wformat-security
4175 @opindex Wformat-security
4176 @opindex Wno-format-security
4177 If @option{-Wformat} is specified, also warn about uses of format
4178 functions that represent possible security problems.  At present, this
4179 warns about calls to @code{printf} and @code{scanf} functions where the
4180 format string is not a string literal and there are no format arguments,
4181 as in @code{printf (foo);}.  This may be a security hole if the format
4182 string came from untrusted input and contains @samp{%n}.  (This is
4183 currently a subset of what @option{-Wformat-nonliteral} warns about, but
4184 in future warnings may be added to @option{-Wformat-security} that are not
4185 included in @option{-Wformat-nonliteral}.)
4187 @item -Wformat-signedness
4188 @opindex Wformat-signedness
4189 @opindex Wno-format-signedness
4190 If @option{-Wformat} is specified, also warn if the format string
4191 requires an unsigned argument and the argument is signed and vice versa.
4193 @item -Wformat-truncation
4194 @itemx -Wformat-truncation=@var{level}
4195 @opindex Wformat-truncation
4196 @opindex Wno-format-truncation
4197 Warn about calls to formatted input/output functions such as @code{snprintf}
4198 and @code{vsnprintf} that might result in output truncation.  When the exact
4199 number of bytes written by a format directive cannot be determined at
4200 compile-time it is estimated based on heuristics that depend on
4201 the @var{level} argument and on optimization.  While enabling optimization
4202 will in most cases improve the accuracy of the warning, it may also result
4203 in false positives.  Except as noted otherwise, the option uses the same
4204 logic @option{-Wformat-overflow}.
4206 @table @gcctabopt
4207 @item -Wformat-truncation
4208 @item -Wformat-truncation=1
4209 @opindex Wformat-truncation
4210 @opindex Wno-format-overflow
4211 Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat}
4212 employs a conservative approach that warns only about calls to bounded
4213 functions whose return value is unused and that will most likely result
4214 in output truncation.
4216 @item -Wformat-truncation=2
4217 Level @var{2} warns also about calls to bounded functions whose return
4218 value is used and that might result in truncation given an argument of
4219 sufficient length or magnitude.
4220 @end table
4222 @item -Wformat-y2k
4223 @opindex Wformat-y2k
4224 @opindex Wno-format-y2k
4225 If @option{-Wformat} is specified, also warn about @code{strftime}
4226 formats that may yield only a two-digit year.
4227 @end table
4229 @item -Wnonnull
4230 @opindex Wnonnull
4231 @opindex Wno-nonnull
4232 Warn about passing a null pointer for arguments marked as
4233 requiring a non-null value by the @code{nonnull} function attribute.
4235 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
4236 can be disabled with the @option{-Wno-nonnull} option.
4238 @item -Wnonnull-compare
4239 @opindex Wnonnull-compare
4240 @opindex Wno-nonnull-compare
4241 Warn when comparing an argument marked with the @code{nonnull}
4242 function attribute against null inside the function.
4244 @option{-Wnonnull-compare} is included in @option{-Wall}.  It
4245 can be disabled with the @option{-Wno-nonnull-compare} option.
4247 @item -Wnull-dereference
4248 @opindex Wnull-dereference
4249 @opindex Wno-null-dereference
4250 Warn if the compiler detects paths that trigger erroneous or
4251 undefined behavior due to dereferencing a null pointer.  This option
4252 is only active when @option{-fdelete-null-pointer-checks} is active,
4253 which is enabled by optimizations in most targets.  The precision of
4254 the warnings depends on the optimization options used.
4256 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
4257 @opindex Winit-self
4258 @opindex Wno-init-self
4259 Warn about uninitialized variables that are initialized with themselves.
4260 Note this option can only be used with the @option{-Wuninitialized} option.
4262 For example, GCC warns about @code{i} being uninitialized in the
4263 following snippet only when @option{-Winit-self} has been specified:
4264 @smallexample
4265 @group
4266 int f()
4268   int i = i;
4269   return i;
4271 @end group
4272 @end smallexample
4274 This warning is enabled by @option{-Wall} in C++.
4276 @item -Wimplicit-int @r{(C and Objective-C only)}
4277 @opindex Wimplicit-int
4278 @opindex Wno-implicit-int
4279 Warn when a declaration does not specify a type.
4280 This warning is enabled by @option{-Wall}.
4282 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
4283 @opindex Wimplicit-function-declaration
4284 @opindex Wno-implicit-function-declaration
4285 Give a warning whenever a function is used before being declared. In
4286 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
4287 enabled by default and it is made into an error by
4288 @option{-pedantic-errors}. This warning is also enabled by
4289 @option{-Wall}.
4291 @item -Wimplicit @r{(C and Objective-C only)}
4292 @opindex Wimplicit
4293 @opindex Wno-implicit
4294 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
4295 This warning is enabled by @option{-Wall}.
4297 @item -Wimplicit-fallthrough
4298 @opindex Wimplicit-fallthrough
4299 @opindex Wno-implicit-fallthrough
4300 @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3}
4301 and @option{-Wno-implicit-fallthrough} is the same as
4302 @option{-Wimplicit-fallthrough=0}.
4304 @item -Wimplicit-fallthrough=@var{n}
4305 @opindex Wimplicit-fallthrough=
4306 Warn when a switch case falls through.  For example:
4308 @smallexample
4309 @group
4310 switch (cond)
4311   @{
4312   case 1:
4313     a = 1;
4314     break;
4315   case 2:
4316     a = 2;
4317   case 3:
4318     a = 3;
4319     break;
4320   @}
4321 @end group
4322 @end smallexample
4324 This warning does not warn when the last statement of a case cannot
4325 fall through, e.g. when there is a return statement or a call to function
4326 declared with the noreturn attribute.  @option{-Wimplicit-fallthrough=}
4327 also takes into account control flow statements, such as ifs, and only
4328 warns when appropriate.  E.g.@:
4330 @smallexample
4331 @group
4332 switch (cond)
4333   @{
4334   case 1:
4335     if (i > 3) @{
4336       bar (5);
4337       break;
4338     @} else if (i < 1) @{
4339       bar (0);
4340     @} else
4341       return;
4342   default:
4343     @dots{}
4344   @}
4345 @end group
4346 @end smallexample
4348 Since there are occasions where a switch case fall through is desirable,
4349 GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is
4350 to be used along with a null statement to suppress this warning that
4351 would normally occur:
4353 @smallexample
4354 @group
4355 switch (cond)
4356   @{
4357   case 1:
4358     bar (0);
4359     __attribute__ ((fallthrough));
4360   default:
4361     @dots{}
4362   @}
4363 @end group
4364 @end smallexample
4366 C++17 provides a standard way to suppress the @option{-Wimplicit-fallthrough}
4367 warning using @code{[[fallthrough]];} instead of the GNU attribute.  In C++11
4368 or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension.
4369 Instead of these attributes, it is also possible to add a fallthrough comment
4370 to silence the warning.  The whole body of the C or C++ style comment should
4371 match the given regular expressions listed below.  The option argument @var{n}
4372 specifies what kind of comments are accepted:
4374 @itemize @bullet
4376 @item @option{-Wimplicit-fallthrough=0} disables the warning altogether.
4378 @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular
4379 expression, any comment is used as fallthrough comment.
4381 @item @option{-Wimplicit-fallthrough=2} case insensitively matches
4382 @code{.*falls?[ \t-]*thr(ough|u).*} regular expression.
4384 @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the
4385 following regular expressions:
4387 @itemize @bullet
4389 @item @code{-fallthrough}
4391 @item @code{@@fallthrough@@}
4393 @item @code{lint -fallthrough[ \t]*}
4395 @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?}
4397 @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4399 @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?}
4401 @end itemize
4403 @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the
4404 following regular expressions:
4406 @itemize @bullet
4408 @item @code{-fallthrough}
4410 @item @code{@@fallthrough@@}
4412 @item @code{lint -fallthrough[ \t]*}
4414 @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*}
4416 @end itemize
4418 @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as
4419 fallthrough comments, only attributes disable the warning.
4421 @end itemize
4423 The comment needs to be followed after optional whitespace and other comments
4424 by @code{case} or @code{default} keywords or by a user label that precedes some
4425 @code{case} or @code{default} label.
4427 @smallexample
4428 @group
4429 switch (cond)
4430   @{
4431   case 1:
4432     bar (0);
4433     /* FALLTHRU */
4434   default:
4435     @dots{}
4436   @}
4437 @end group
4438 @end smallexample
4440 The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}.
4442 @item -Wif-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
4443 @opindex Wif-not-aligned
4444 @opindex Wno-if-not-aligned
4445 Control if warning triggered by the @code{warn_if_not_aligned} attribute
4446 should be issued.  This is is enabled by default.
4447 Use @option{-Wno-if-not-aligned} to disable it.
4449 @item -Wignored-qualifiers @r{(C and C++ only)}
4450 @opindex Wignored-qualifiers
4451 @opindex Wno-ignored-qualifiers
4452 Warn if the return type of a function has a type qualifier
4453 such as @code{const}.  For ISO C such a type qualifier has no effect,
4454 since the value returned by a function is not an lvalue.
4455 For C++, the warning is only emitted for scalar types or @code{void}.
4456 ISO C prohibits qualified @code{void} return types on function
4457 definitions, so such return types always receive a warning
4458 even without this option.
4460 This warning is also enabled by @option{-Wextra}.
4462 @item -Wignored-attributes @r{(C and C++ only)}
4463 @opindex Wignored-attributes
4464 @opindex Wno-ignored-attributes
4465 Warn when an attribute is ignored.  This is different from the
4466 @option{-Wattributes} option in that it warns whenever the compiler decides
4467 to drop an attribute, not that the attribute is either unknown, used in a
4468 wrong place, etc.  This warning is enabled by default.
4470 @item -Wmain
4471 @opindex Wmain
4472 @opindex Wno-main
4473 Warn if the type of @code{main} is suspicious.  @code{main} should be
4474 a function with external linkage, returning int, taking either zero
4475 arguments, two, or three arguments of appropriate types.  This warning
4476 is enabled by default in C++ and is enabled by either @option{-Wall}
4477 or @option{-Wpedantic}.
4479 @item -Wmisleading-indentation @r{(C and C++ only)}
4480 @opindex Wmisleading-indentation
4481 @opindex Wno-misleading-indentation
4482 Warn when the indentation of the code does not reflect the block structure.
4483 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
4484 @code{for} clauses with a guarded statement that does not use braces,
4485 followed by an unguarded statement with the same indentation.
4487 In the following example, the call to ``bar'' is misleadingly indented as
4488 if it were guarded by the ``if'' conditional.
4490 @smallexample
4491   if (some_condition ())
4492     foo ();
4493     bar ();  /* Gotcha: this is not guarded by the "if".  */
4494 @end smallexample
4496 In the case of mixed tabs and spaces, the warning uses the
4497 @option{-ftabstop=} option to determine if the statements line up
4498 (defaulting to 8).
4500 The warning is not issued for code involving multiline preprocessor logic
4501 such as the following example.
4503 @smallexample
4504   if (flagA)
4505     foo (0);
4506 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
4507   if (flagB)
4508 #endif
4509     foo (1);
4510 @end smallexample
4512 The warning is not issued after a @code{#line} directive, since this
4513 typically indicates autogenerated code, and no assumptions can be made
4514 about the layout of the file that the directive references.
4516 This warning is enabled by @option{-Wall} in C and C++.
4518 @item -Wmissing-braces
4519 @opindex Wmissing-braces
4520 @opindex Wno-missing-braces
4521 Warn if an aggregate or union initializer is not fully bracketed.  In
4522 the following example, the initializer for @code{a} is not fully
4523 bracketed, but that for @code{b} is fully bracketed.  This warning is
4524 enabled by @option{-Wall} in C.
4526 @smallexample
4527 int a[2][2] = @{ 0, 1, 2, 3 @};
4528 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
4529 @end smallexample
4531 This warning is enabled by @option{-Wall}.
4533 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
4534 @opindex Wmissing-include-dirs
4535 @opindex Wno-missing-include-dirs
4536 Warn if a user-supplied include directory does not exist.
4538 @item -Wmultistatement-macros
4539 @opindex Wmultistatement-macros
4540 @opindex Wno-multistatement-macros
4541 Warn about unsafe multiple statement macros that appear to be guarded
4542 by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or
4543 @code{while}, in which only the first statement is actually guarded after
4544 the macro is expanded.
4546 For example:
4548 @smallexample
4549 #define DOIT x++; y++
4550 if (c)
4551   DOIT;
4552 @end smallexample
4554 will increment @code{y} unconditionally, not just when @code{c} holds.
4555 The can usually be fixed by wrapping the macro in a do-while loop:
4556 @smallexample
4557 #define DOIT do @{ x++; y++; @} while (0)
4558 if (c)
4559   DOIT;
4560 @end smallexample
4562 This warning is enabled by @option{-Wall} in C and C++.
4564 @item -Wparentheses
4565 @opindex Wparentheses
4566 @opindex Wno-parentheses
4567 Warn if parentheses are omitted in certain contexts, such
4568 as when there is an assignment in a context where a truth value
4569 is expected, or when operators are nested whose precedence people
4570 often get confused about.
4572 Also warn if a comparison like @code{x<=y<=z} appears; this is
4573 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
4574 interpretation from that of ordinary mathematical notation.
4576 Also warn for dangerous uses of the GNU extension to
4577 @code{?:} with omitted middle operand. When the condition
4578 in the @code{?}: operator is a boolean expression, the omitted value is
4579 always 1.  Often programmers expect it to be a value computed
4580 inside the conditional expression instead.
4582 This warning is enabled by @option{-Wall}.
4584 @item -Wsequence-point
4585 @opindex Wsequence-point
4586 @opindex Wno-sequence-point
4587 Warn about code that may have undefined semantics because of violations
4588 of sequence point rules in the C and C++ standards.
4590 The C and C++ standards define the order in which expressions in a C/C++
4591 program are evaluated in terms of @dfn{sequence points}, which represent
4592 a partial ordering between the execution of parts of the program: those
4593 executed before the sequence point, and those executed after it.  These
4594 occur after the evaluation of a full expression (one which is not part
4595 of a larger expression), after the evaluation of the first operand of a
4596 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4597 function is called (but after the evaluation of its arguments and the
4598 expression denoting the called function), and in certain other places.
4599 Other than as expressed by the sequence point rules, the order of
4600 evaluation of subexpressions of an expression is not specified.  All
4601 these rules describe only a partial order rather than a total order,
4602 since, for example, if two functions are called within one expression
4603 with no sequence point between them, the order in which the functions
4604 are called is not specified.  However, the standards committee have
4605 ruled that function calls do not overlap.
4607 It is not specified when between sequence points modifications to the
4608 values of objects take effect.  Programs whose behavior depends on this
4609 have undefined behavior; the C and C++ standards specify that ``Between
4610 the previous and next sequence point an object shall have its stored
4611 value modified at most once by the evaluation of an expression.
4612 Furthermore, the prior value shall be read only to determine the value
4613 to be stored.''.  If a program breaks these rules, the results on any
4614 particular implementation are entirely unpredictable.
4616 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4617 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4618 diagnosed by this option, and it may give an occasional false positive
4619 result, but in general it has been found fairly effective at detecting
4620 this sort of problem in programs.
4622 The C++17 standard will define the order of evaluation of operands in
4623 more cases: in particular it requires that the right-hand side of an
4624 assignment be evaluated before the left-hand side, so the above
4625 examples are no longer undefined.  But this warning will still warn
4626 about them, to help people avoid writing code that is undefined in C
4627 and earlier revisions of C++.
4629 The standard is worded confusingly, therefore there is some debate
4630 over the precise meaning of the sequence point rules in subtle cases.
4631 Links to discussions of the problem, including proposed formal
4632 definitions, may be found on the GCC readings page, at
4633 @uref{http://gcc.gnu.org/@/readings.html}.
4635 This warning is enabled by @option{-Wall} for C and C++.
4637 @item -Wno-return-local-addr
4638 @opindex Wno-return-local-addr
4639 @opindex Wreturn-local-addr
4640 Do not warn about returning a pointer (or in C++, a reference) to a
4641 variable that goes out of scope after the function returns.
4643 @item -Wreturn-type
4644 @opindex Wreturn-type
4645 @opindex Wno-return-type
4646 Warn whenever a function is defined with a return type that defaults
4647 to @code{int}.  Also warn about any @code{return} statement with no
4648 return value in a function whose return type is not @code{void}
4649 (falling off the end of the function body is considered returning
4650 without a value).
4652 For C only, warn about a @code{return} statement with an expression in a
4653 function whose return type is @code{void}, unless the expression type is
4654 also @code{void}.  As a GNU extension, the latter case is accepted
4655 without a warning unless @option{-Wpedantic} is used.
4657 For C++, a function without return type always produces a diagnostic
4658 message, even when @option{-Wno-return-type} is specified.  The only
4659 exceptions are @code{main} and functions defined in system headers.
4661 This warning is enabled by @option{-Wall}.
4663 @item -Wshift-count-negative
4664 @opindex Wshift-count-negative
4665 @opindex Wno-shift-count-negative
4666 Warn if shift count is negative. This warning is enabled by default.
4668 @item -Wshift-count-overflow
4669 @opindex Wshift-count-overflow
4670 @opindex Wno-shift-count-overflow
4671 Warn if shift count >= width of type. This warning is enabled by default.
4673 @item -Wshift-negative-value
4674 @opindex Wshift-negative-value
4675 @opindex Wno-shift-negative-value
4676 Warn if left shifting a negative value.  This warning is enabled by
4677 @option{-Wextra} in C99 and C++11 modes (and newer).
4679 @item -Wshift-overflow
4680 @itemx -Wshift-overflow=@var{n}
4681 @opindex Wshift-overflow
4682 @opindex Wno-shift-overflow
4683 Warn about left shift overflows.  This warning is enabled by
4684 default in C99 and C++11 modes (and newer).
4686 @table @gcctabopt
4687 @item -Wshift-overflow=1
4688 This is the warning level of @option{-Wshift-overflow} and is enabled
4689 by default in C99 and C++11 modes (and newer).  This warning level does
4690 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4691 an overflow is still rejected in contexts where an integer constant expression
4692 is required.)
4694 @item -Wshift-overflow=2
4695 This warning level also warns about left-shifting 1 into the sign bit,
4696 unless C++14 mode is active.
4697 @end table
4699 @item -Wswitch
4700 @opindex Wswitch
4701 @opindex Wno-switch
4702 Warn whenever a @code{switch} statement has an index of enumerated type
4703 and lacks a @code{case} for one or more of the named codes of that
4704 enumeration.  (The presence of a @code{default} label prevents this
4705 warning.)  @code{case} labels outside the enumeration range also
4706 provoke warnings when this option is used (even if there is a
4707 @code{default} label).
4708 This warning is enabled by @option{-Wall}.
4710 @item -Wswitch-default
4711 @opindex Wswitch-default
4712 @opindex Wno-switch-default
4713 Warn whenever a @code{switch} statement does not have a @code{default}
4714 case.
4716 @item -Wswitch-enum
4717 @opindex Wswitch-enum
4718 @opindex Wno-switch-enum
4719 Warn whenever a @code{switch} statement has an index of enumerated type
4720 and lacks a @code{case} for one or more of the named codes of that
4721 enumeration.  @code{case} labels outside the enumeration range also
4722 provoke warnings when this option is used.  The only difference
4723 between @option{-Wswitch} and this option is that this option gives a
4724 warning about an omitted enumeration code even if there is a
4725 @code{default} label.
4727 @item -Wswitch-bool
4728 @opindex Wswitch-bool
4729 @opindex Wno-switch-bool
4730 Warn whenever a @code{switch} statement has an index of boolean type
4731 and the case values are outside the range of a boolean type.
4732 It is possible to suppress this warning by casting the controlling
4733 expression to a type other than @code{bool}.  For example:
4734 @smallexample
4735 @group
4736 switch ((int) (a == 4))
4737   @{
4738   @dots{}
4739   @}
4740 @end group
4741 @end smallexample
4742 This warning is enabled by default for C and C++ programs.
4744 @item -Wswitch-unreachable
4745 @opindex Wswitch-unreachable
4746 @opindex Wno-switch-unreachable
4747 Warn whenever a @code{switch} statement contains statements between the
4748 controlling expression and the first case label, which will never be
4749 executed.  For example:
4750 @smallexample
4751 @group
4752 switch (cond)
4753   @{
4754    i = 15;
4755   @dots{}
4756    case 5:
4757   @dots{}
4758   @}
4759 @end group
4760 @end smallexample
4761 @option{-Wswitch-unreachable} does not warn if the statement between the
4762 controlling expression and the first case label is just a declaration:
4763 @smallexample
4764 @group
4765 switch (cond)
4766   @{
4767    int i;
4768   @dots{}
4769    case 5:
4770    i = 5;
4771   @dots{}
4772   @}
4773 @end group
4774 @end smallexample
4775 This warning is enabled by default for C and C++ programs.
4777 @item -Wsync-nand @r{(C and C++ only)}
4778 @opindex Wsync-nand
4779 @opindex Wno-sync-nand
4780 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4781 built-in functions are used.  These functions changed semantics in GCC 4.4.
4783 @item -Wunused-but-set-parameter
4784 @opindex Wunused-but-set-parameter
4785 @opindex Wno-unused-but-set-parameter
4786 Warn whenever a function parameter is assigned to, but otherwise unused
4787 (aside from its declaration).
4789 To suppress this warning use the @code{unused} attribute
4790 (@pxref{Variable Attributes}).
4792 This warning is also enabled by @option{-Wunused} together with
4793 @option{-Wextra}.
4795 @item -Wunused-but-set-variable
4796 @opindex Wunused-but-set-variable
4797 @opindex Wno-unused-but-set-variable
4798 Warn whenever a local variable is assigned to, but otherwise unused
4799 (aside from its declaration).
4800 This warning is enabled by @option{-Wall}.
4802 To suppress this warning use the @code{unused} attribute
4803 (@pxref{Variable Attributes}).
4805 This warning is also enabled by @option{-Wunused}, which is enabled
4806 by @option{-Wall}.
4808 @item -Wunused-function
4809 @opindex Wunused-function
4810 @opindex Wno-unused-function
4811 Warn whenever a static function is declared but not defined or a
4812 non-inline static function is unused.
4813 This warning is enabled by @option{-Wall}.
4815 @item -Wunused-label
4816 @opindex Wunused-label
4817 @opindex Wno-unused-label
4818 Warn whenever a label is declared but not used.
4819 This warning is enabled by @option{-Wall}.
4821 To suppress this warning use the @code{unused} attribute
4822 (@pxref{Variable Attributes}).
4824 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4825 @opindex Wunused-local-typedefs
4826 Warn when a typedef locally defined in a function is not used.
4827 This warning is enabled by @option{-Wall}.
4829 @item -Wunused-parameter
4830 @opindex Wunused-parameter
4831 @opindex Wno-unused-parameter
4832 Warn whenever a function parameter is unused aside from its declaration.
4834 To suppress this warning use the @code{unused} attribute
4835 (@pxref{Variable Attributes}).
4837 @item -Wno-unused-result
4838 @opindex Wunused-result
4839 @opindex Wno-unused-result
4840 Do not warn if a caller of a function marked with attribute
4841 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4842 its return value. The default is @option{-Wunused-result}.
4844 @item -Wunused-variable
4845 @opindex Wunused-variable
4846 @opindex Wno-unused-variable
4847 Warn whenever a local or static variable is unused aside from its
4848 declaration. This option implies @option{-Wunused-const-variable=1} for C,
4849 but not for C++. This warning is enabled by @option{-Wall}.
4851 To suppress this warning use the @code{unused} attribute
4852 (@pxref{Variable Attributes}).
4854 @item -Wunused-const-variable
4855 @itemx -Wunused-const-variable=@var{n}
4856 @opindex Wunused-const-variable
4857 @opindex Wno-unused-const-variable
4858 Warn whenever a constant static variable is unused aside from its declaration.
4859 @option{-Wunused-const-variable=1} is enabled by @option{-Wunused-variable}
4860 for C, but not for C++. In C this declares variable storage, but in C++ this
4861 is not an error since const variables take the place of @code{#define}s.
4863 To suppress this warning use the @code{unused} attribute
4864 (@pxref{Variable Attributes}).
4866 @table @gcctabopt
4867 @item -Wunused-const-variable=1
4868 This is the warning level that is enabled by @option{-Wunused-variable} for
4869 C.  It warns only about unused static const variables defined in the main
4870 compilation unit, but not about static const variables declared in any
4871 header included.
4873 @item -Wunused-const-variable=2
4874 This warning level also warns for unused constant static variables in
4875 headers (excluding system headers).  This is the warning level of
4876 @option{-Wunused-const-variable} and must be explicitly requested since
4877 in C++ this isn't an error and in C it might be harder to clean up all
4878 headers included.
4879 @end table
4881 @item -Wunused-value
4882 @opindex Wunused-value
4883 @opindex Wno-unused-value
4884 Warn whenever a statement computes a result that is explicitly not
4885 used. To suppress this warning cast the unused expression to
4886 @code{void}. This includes an expression-statement or the left-hand
4887 side of a comma expression that contains no side effects. For example,
4888 an expression such as @code{x[i,j]} causes a warning, while
4889 @code{x[(void)i,j]} does not.
4891 This warning is enabled by @option{-Wall}.
4893 @item -Wunused
4894 @opindex Wunused
4895 @opindex Wno-unused
4896 All the above @option{-Wunused} options combined.
4898 In order to get a warning about an unused function parameter, you must
4899 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4900 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4902 @item -Wuninitialized
4903 @opindex Wuninitialized
4904 @opindex Wno-uninitialized
4905 Warn if an automatic variable is used without first being initialized
4906 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4907 warn if a non-static reference or non-static @code{const} member
4908 appears in a class without constructors.
4910 If you want to warn about code that uses the uninitialized value of the
4911 variable in its own initializer, use the @option{-Winit-self} option.
4913 These warnings occur for individual uninitialized or clobbered
4914 elements of structure, union or array variables as well as for
4915 variables that are uninitialized or clobbered as a whole.  They do
4916 not occur for variables or elements declared @code{volatile}.  Because
4917 these warnings depend on optimization, the exact variables or elements
4918 for which there are warnings depends on the precise optimization
4919 options and version of GCC used.
4921 Note that there may be no warning about a variable that is used only
4922 to compute a value that itself is never used, because such
4923 computations may be deleted by data flow analysis before the warnings
4924 are printed.
4926 @item -Winvalid-memory-model
4927 @opindex Winvalid-memory-model
4928 @opindex Wno-invalid-memory-model
4929 Warn for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins},
4930 and the C11 atomic generic functions with a memory consistency argument
4931 that is either invalid for the operation or outside the range of values
4932 of the @code{memory_order} enumeration.  For example, since the
4933 @code{__atomic_store} and @code{__atomic_store_n} built-ins are only
4934 defined for the relaxed, release, and sequentially consistent memory
4935 orders the following code is diagnosed:
4937 @smallexample
4938 void store (int *i)
4940   __atomic_store_n (i, 0, memory_order_consume);
4942 @end smallexample
4944 @option{-Winvalid-memory-model} is enabled by default.
4946 @item -Wmaybe-uninitialized
4947 @opindex Wmaybe-uninitialized
4948 @opindex Wno-maybe-uninitialized
4949 For an automatic variable, if there exists a path from the function
4950 entry to a use of the variable that is initialized, but there exist
4951 some other paths for which the variable is not initialized, the compiler
4952 emits a warning if it cannot prove the uninitialized paths are not
4953 executed at run time. These warnings are made optional because GCC is
4954 not smart enough to see all the reasons why the code might be correct
4955 in spite of appearing to have an error.  Here is one example of how
4956 this can happen:
4958 @smallexample
4959 @group
4961   int x;
4962   switch (y)
4963     @{
4964     case 1: x = 1;
4965       break;
4966     case 2: x = 4;
4967       break;
4968     case 3: x = 5;
4969     @}
4970   foo (x);
4972 @end group
4973 @end smallexample
4975 @noindent
4976 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4977 always initialized, but GCC doesn't know this. To suppress the
4978 warning, you need to provide a default case with assert(0) or
4979 similar code.
4981 @cindex @code{longjmp} warnings
4982 This option also warns when a non-volatile automatic variable might be
4983 changed by a call to @code{longjmp}.  These warnings as well are possible
4984 only in optimizing compilation.
4986 The compiler sees only the calls to @code{setjmp}.  It cannot know
4987 where @code{longjmp} will be called; in fact, a signal handler could
4988 call it at any point in the code.  As a result, you may get a warning
4989 even when there is in fact no problem because @code{longjmp} cannot
4990 in fact be called at the place that would cause a problem.
4992 Some spurious warnings can be avoided if you declare all the functions
4993 you use that never return as @code{noreturn}.  @xref{Function
4994 Attributes}.
4996 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4998 @item -Wunknown-pragmas
4999 @opindex Wunknown-pragmas
5000 @opindex Wno-unknown-pragmas
5001 @cindex warning for unknown pragmas
5002 @cindex unknown pragmas, warning
5003 @cindex pragmas, warning of unknown
5004 Warn when a @code{#pragma} directive is encountered that is not understood by 
5005 GCC@.  If this command-line option is used, warnings are even issued
5006 for unknown pragmas in system header files.  This is not the case if
5007 the warnings are only enabled by the @option{-Wall} command-line option.
5009 @item -Wno-pragmas
5010 @opindex Wno-pragmas
5011 @opindex Wpragmas
5012 Do not warn about misuses of pragmas, such as incorrect parameters,
5013 invalid syntax, or conflicts between pragmas.  See also
5014 @option{-Wunknown-pragmas}.
5016 @item -Wstrict-aliasing
5017 @opindex Wstrict-aliasing
5018 @opindex Wno-strict-aliasing
5019 This option is only active when @option{-fstrict-aliasing} is active.
5020 It warns about code that might break the strict aliasing rules that the
5021 compiler is using for optimization.  The warning does not catch all
5022 cases, but does attempt to catch the more common pitfalls.  It is
5023 included in @option{-Wall}.
5024 It is equivalent to @option{-Wstrict-aliasing=3}
5026 @item -Wstrict-aliasing=n
5027 @opindex Wstrict-aliasing=n
5028 This option is only active when @option{-fstrict-aliasing} is active.
5029 It warns about code that might break the strict aliasing rules that the
5030 compiler is using for optimization.
5031 Higher levels correspond to higher accuracy (fewer false positives).
5032 Higher levels also correspond to more effort, similar to the way @option{-O} 
5033 works.
5034 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
5036 Level 1: Most aggressive, quick, least accurate.
5037 Possibly useful when higher levels
5038 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
5039 false negatives.  However, it has many false positives.
5040 Warns for all pointer conversions between possibly incompatible types,
5041 even if never dereferenced.  Runs in the front end only.
5043 Level 2: Aggressive, quick, not too precise.
5044 May still have many false positives (not as many as level 1 though),
5045 and few false negatives (but possibly more than level 1).
5046 Unlike level 1, it only warns when an address is taken.  Warns about
5047 incomplete types.  Runs in the front end only.
5049 Level 3 (default for @option{-Wstrict-aliasing}):
5050 Should have very few false positives and few false
5051 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
5052 Takes care of the common pun+dereference pattern in the front end:
5053 @code{*(int*)&some_float}.
5054 If optimization is enabled, it also runs in the back end, where it deals
5055 with multiple statement cases using flow-sensitive points-to information.
5056 Only warns when the converted pointer is dereferenced.
5057 Does not warn about incomplete types.
5059 @item -Wstrict-overflow
5060 @itemx -Wstrict-overflow=@var{n}
5061 @opindex Wstrict-overflow
5062 @opindex Wno-strict-overflow
5063 This option is only active when signed overflow is undefined.
5064 It warns about cases where the compiler optimizes based on the
5065 assumption that signed overflow does not occur.  Note that it does not
5066 warn about all cases where the code might overflow: it only warns
5067 about cases where the compiler implements some optimization.  Thus
5068 this warning depends on the optimization level.
5070 An optimization that assumes that signed overflow does not occur is
5071 perfectly safe if the values of the variables involved are such that
5072 overflow never does, in fact, occur.  Therefore this warning can
5073 easily give a false positive: a warning about code that is not
5074 actually a problem.  To help focus on important issues, several
5075 warning levels are defined.  No warnings are issued for the use of
5076 undefined signed overflow when estimating how many iterations a loop
5077 requires, in particular when determining whether a loop will be
5078 executed at all.
5080 @table @gcctabopt
5081 @item -Wstrict-overflow=1
5082 Warn about cases that are both questionable and easy to avoid.  For
5083 example the compiler simplifies
5084 @code{x + 1 > x} to @code{1}.  This level of
5085 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
5086 are not, and must be explicitly requested.
5088 @item -Wstrict-overflow=2
5089 Also warn about other cases where a comparison is simplified to a
5090 constant.  For example: @code{abs (x) >= 0}.  This can only be
5091 simplified when signed integer overflow is undefined, because
5092 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
5093 zero.  @option{-Wstrict-overflow} (with no level) is the same as
5094 @option{-Wstrict-overflow=2}.
5096 @item -Wstrict-overflow=3
5097 Also warn about other cases where a comparison is simplified.  For
5098 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
5100 @item -Wstrict-overflow=4
5101 Also warn about other simplifications not covered by the above cases.
5102 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
5104 @item -Wstrict-overflow=5
5105 Also warn about cases where the compiler reduces the magnitude of a
5106 constant involved in a comparison.  For example: @code{x + 2 > y} is
5107 simplified to @code{x + 1 >= y}.  This is reported only at the
5108 highest warning level because this simplification applies to many
5109 comparisons, so this warning level gives a very large number of
5110 false positives.
5111 @end table
5113 @item -Wstringop-overflow
5114 @itemx -Wstringop-overflow=@var{type}
5115 @opindex Wstringop-overflow
5116 @opindex Wno-stringop-overflow
5117 Warn for calls to string manipulation functions such as @code{memcpy} and
5118 @code{strcpy} that are determined to overflow the destination buffer.  The
5119 optional argument is one greater than the type of Object Size Checking to
5120 perform to determine the size of the destination.  @xref{Object Size Checking}.
5121 The argument is meaningful only for functions that operate on character arrays
5122 but not for raw memory functions like @code{memcpy} which always make use
5123 of Object Size type-0.  The option also warns for calls that specify a size
5124 in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes.
5125 The option produces the best results with optimization enabled but can detect
5126 a small subset of simple buffer overflows even without optimization in
5127 calls to the GCC built-in functions like @code{__builtin_memcpy} that
5128 correspond to the standard functions.  In any case, the option warns about
5129 just a subset of buffer overflows detected by the corresponding overflow
5130 checking built-ins.  For example, the option will issue a warning for
5131 the @code{strcpy} call below because it copies at least 5 characters
5132 (the string @code{"blue"} including the terminating NUL) into the buffer
5133 of size 4.
5135 @smallexample
5136 enum Color @{ blue, purple, yellow @};
5137 const char* f (enum Color clr)
5139   static char buf [4];
5140   const char *str;
5141   switch (clr)
5142     @{
5143       case blue: str = "blue"; break;
5144       case purple: str = "purple"; break;
5145       case yellow: str = "yellow"; break;
5146     @}
5148   return strcpy (buf, str);   // warning here
5150 @end smallexample
5152 Option @option{-Wstringop-overflow=2} is enabled by default.
5154 @table @gcctabopt
5155 @item -Wstringop-overflow
5156 @item -Wstringop-overflow=1
5157 @opindex Wstringop-overflow
5158 @opindex Wno-stringop-overflow
5159 The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking
5160 to determine the sizes of destination objects.  This is the default setting
5161 of the option.  At this setting the option will not warn for writes past
5162 the end of subobjects of larger objects accessed by pointers unless the
5163 size of the largest surrounding object is known.  When the destination may
5164 be one of several objects it is assumed to be the largest one of them.  On
5165 Linux systems, when optimization is enabled at this setting the option warns
5166 for the same code as when the @code{_FORTIFY_SOURCE} macro is defined to
5167 a non-zero value.
5169 @item -Wstringop-overflow=2
5170 The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking
5171 to determine the sizes of destination objects.  At this setting the option
5172 will warn about overflows when writing to members of the largest complete
5173 objects whose exact size is known.  It will, however, not warn for excessive
5174 writes to the same members of unknown objects referenced by pointers since
5175 they may point to arrays containing unknown numbers of elements.
5177 @item -Wstringop-overflow=3
5178 The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking
5179 to determine the sizes of destination objects.  At this setting the option
5180 warns about overflowing the smallest object or data member.  This is the
5181 most restrictive setting of the option that may result in warnings for safe
5182 code.
5184 @item -Wstringop-overflow=4
5185 The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking
5186 to determine the sizes of destination objects.  At this setting the option
5187 will warn about overflowing any data members, and when the destination is
5188 one of several objects it uses the size of the largest of them to decide
5189 whether to issue a warning.  Similarly to @option{-Wstringop-overflow=3} this
5190 setting of the option may result in warnings for benign code.
5191 @end table
5193 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
5194 @opindex Wsuggest-attribute=
5195 @opindex Wno-suggest-attribute=
5196 Warn for cases where adding an attribute may be beneficial. The
5197 attributes currently supported are listed below.
5199 @table @gcctabopt
5200 @item -Wsuggest-attribute=pure
5201 @itemx -Wsuggest-attribute=const
5202 @itemx -Wsuggest-attribute=noreturn
5203 @opindex Wsuggest-attribute=pure
5204 @opindex Wno-suggest-attribute=pure
5205 @opindex Wsuggest-attribute=const
5206 @opindex Wno-suggest-attribute=const
5207 @opindex Wsuggest-attribute=noreturn
5208 @opindex Wno-suggest-attribute=noreturn
5210 Warn about functions that might be candidates for attributes
5211 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
5212 functions visible in other compilation units or (in the case of @code{pure} and
5213 @code{const}) if it cannot prove that the function returns normally. A function
5214 returns normally if it doesn't contain an infinite loop or return abnormally
5215 by throwing, calling @code{abort} or trapping.  This analysis requires option
5216 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
5217 higher.  Higher optimization levels improve the accuracy of the analysis.
5219 @item -Wsuggest-attribute=format
5220 @itemx -Wmissing-format-attribute
5221 @opindex Wsuggest-attribute=format
5222 @opindex Wmissing-format-attribute
5223 @opindex Wno-suggest-attribute=format
5224 @opindex Wno-missing-format-attribute
5225 @opindex Wformat
5226 @opindex Wno-format
5228 Warn about function pointers that might be candidates for @code{format}
5229 attributes.  Note these are only possible candidates, not absolute ones.
5230 GCC guesses that function pointers with @code{format} attributes that
5231 are used in assignment, initialization, parameter passing or return
5232 statements should have a corresponding @code{format} attribute in the
5233 resulting type.  I.e.@: the left-hand side of the assignment or
5234 initialization, the type of the parameter variable, or the return type
5235 of the containing function respectively should also have a @code{format}
5236 attribute to avoid the warning.
5238 GCC also warns about function definitions that might be
5239 candidates for @code{format} attributes.  Again, these are only
5240 possible candidates.  GCC guesses that @code{format} attributes
5241 might be appropriate for any function that calls a function like
5242 @code{vprintf} or @code{vscanf}, but this might not always be the
5243 case, and some functions for which @code{format} attributes are
5244 appropriate may not be detected.
5245 @end table
5247 @item -Wsuggest-final-types
5248 @opindex Wno-suggest-final-types
5249 @opindex Wsuggest-final-types
5250 Warn about types with virtual methods where code quality would be improved
5251 if the type were declared with the C++11 @code{final} specifier, 
5252 or, if possible,
5253 declared in an anonymous namespace. This allows GCC to more aggressively
5254 devirtualize the polymorphic calls. This warning is more effective with link
5255 time optimization, where the information about the class hierarchy graph is
5256 more complete.
5258 @item -Wsuggest-final-methods
5259 @opindex Wno-suggest-final-methods
5260 @opindex Wsuggest-final-methods
5261 Warn about virtual methods where code quality would be improved if the method
5262 were declared with the C++11 @code{final} specifier, 
5263 or, if possible, its type were
5264 declared in an anonymous namespace or with the @code{final} specifier.
5265 This warning is
5266 more effective with link-time optimization, where the information about the
5267 class hierarchy graph is more complete. It is recommended to first consider
5268 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
5269 annotations.
5271 @item -Wsuggest-override
5272 Warn about overriding virtual functions that are not marked with the override
5273 keyword.
5275 @item -Walloc-zero
5276 @opindex Wno-alloc-zero
5277 @opindex Walloc-zero
5278 Warn about calls to allocation functions decorated with attribute
5279 @code{alloc_size} that specify zero bytes, including those to the built-in
5280 forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc},
5281 @code{malloc}, and @code{realloc}.  Because the behavior of these functions
5282 when called with a zero size differs among implementations (and in the case
5283 of @code{realloc} has been deprecated) relying on it may result in subtle
5284 portability bugs and should be avoided.
5286 @item -Walloc-size-larger-than=@var{n}
5287 Warn about calls to functions decorated with attribute @code{alloc_size}
5288 that attempt to allocate objects larger than the specified number of bytes,
5289 or where the result of the size computation in an integer type with infinite
5290 precision would exceed @code{SIZE_MAX / 2}.  The option argument @var{n}
5291 may end in one of the standard suffixes designating a multiple of bytes
5292 such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively,
5293 @code{MB} and @code{MiB} for megabyte and mebibyte, and so on.
5294 @xref{Function Attributes}.
5296 @item -Walloca
5297 @opindex Wno-alloca
5298 @opindex Walloca
5299 This option warns on all uses of @code{alloca} in the source.
5301 @item -Walloca-larger-than=@var{n}
5302 This option warns on calls to @code{alloca} that are not bounded by a
5303 controlling predicate limiting its argument of integer type to at most
5304 @var{n} bytes, or calls to @code{alloca} where the bound is unknown.
5305 Arguments of non-integer types are considered unbounded even if they
5306 appear to be constrained to the expected range.
5308 For example, a bounded case of @code{alloca} could be:
5310 @smallexample
5311 void func (size_t n)
5313   void *p;
5314   if (n <= 1000)
5315     p = alloca (n);
5316   else
5317     p = malloc (n);
5318   f (p);
5320 @end smallexample
5322 In the above example, passing @code{-Walloca-larger-than=1000} would not
5323 issue a warning because the call to @code{alloca} is known to be at most
5324 1000 bytes.  However, if @code{-Walloca-larger-than=500} were passed,
5325 the compiler would emit a warning.
5327 Unbounded uses, on the other hand, are uses of @code{alloca} with no
5328 controlling predicate constraining its integer argument.  For example:
5330 @smallexample
5331 void func ()
5333   void *p = alloca (n);
5334   f (p);
5336 @end smallexample
5338 If @code{-Walloca-larger-than=500} were passed, the above would trigger
5339 a warning, but this time because of the lack of bounds checking.
5341 Note, that even seemingly correct code involving signed integers could
5342 cause a warning:
5344 @smallexample
5345 void func (signed int n)
5347   if (n < 500)
5348     @{
5349       p = alloca (n);
5350       f (p);
5351     @}
5353 @end smallexample
5355 In the above example, @var{n} could be negative, causing a larger than
5356 expected argument to be implicitly cast into the @code{alloca} call.
5358 This option also warns when @code{alloca} is used in a loop.
5360 This warning is not enabled by @option{-Wall}, and is only active when
5361 @option{-ftree-vrp} is active (default for @option{-O2} and above).
5363 See also @option{-Wvla-larger-than=@var{n}}.
5365 @item -Warray-bounds
5366 @itemx -Warray-bounds=@var{n}
5367 @opindex Wno-array-bounds
5368 @opindex Warray-bounds
5369 This option is only active when @option{-ftree-vrp} is active
5370 (default for @option{-O2} and above). It warns about subscripts to arrays
5371 that are always out of bounds. This warning is enabled by @option{-Wall}.
5373 @table @gcctabopt
5374 @item -Warray-bounds=1
5375 This is the warning level of @option{-Warray-bounds} and is enabled
5376 by @option{-Wall}; higher levels are not, and must be explicitly requested.
5378 @item -Warray-bounds=2
5379 This warning level also warns about out of bounds access for
5380 arrays at the end of a struct and for arrays accessed through
5381 pointers. This warning level may give a larger number of
5382 false positives and is deactivated by default.
5383 @end table
5385 @item -Wbool-compare
5386 @opindex Wno-bool-compare
5387 @opindex Wbool-compare
5388 Warn about boolean expression compared with an integer value different from
5389 @code{true}/@code{false}.  For instance, the following comparison is
5390 always false:
5391 @smallexample
5392 int n = 5;
5393 @dots{}
5394 if ((n > 1) == 2) @{ @dots{} @}
5395 @end smallexample
5396 This warning is enabled by @option{-Wall}.
5398 @item -Wbool-operation
5399 @opindex Wno-bool-operation
5400 @opindex Wbool-operation
5401 Warn about suspicious operations on expressions of a boolean type.  For
5402 instance, bitwise negation of a boolean is very likely a bug in the program.
5403 For C, this warning also warns about incrementing or decrementing a boolean,
5404 which rarely makes sense.  (In C++, decrementing a boolean is always invalid.
5405 Incrementing a boolean is invalid in C++17, and deprecated otherwise.)
5407 This warning is enabled by @option{-Wall}.
5409 @item -Wduplicated-branches
5410 @opindex Wno-duplicated-branches
5411 @opindex Wduplicated-branches
5412 Warn when an if-else has identical branches.  This warning detects cases like
5413 @smallexample
5414 if (p != NULL)
5415   return 0;
5416 else
5417   return 0;
5418 @end smallexample
5419 It doesn't warn when both branches contain just a null statement.  This warning
5420 also warn for conditional operators:
5421 @smallexample
5422   int i = x ? *p : *p;
5423 @end smallexample
5425 @item -Wduplicated-cond
5426 @opindex Wno-duplicated-cond
5427 @opindex Wduplicated-cond
5428 Warn about duplicated conditions in an if-else-if chain.  For instance,
5429 warn for the following code:
5430 @smallexample
5431 if (p->q != NULL) @{ @dots{} @}
5432 else if (p->q != NULL) @{ @dots{} @}
5433 @end smallexample
5435 @item -Wframe-address
5436 @opindex Wno-frame-address
5437 @opindex Wframe-address
5438 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
5439 is called with an argument greater than 0.  Such calls may return indeterminate
5440 values or crash the program.  The warning is included in @option{-Wall}.
5442 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
5443 @opindex Wno-discarded-qualifiers
5444 @opindex Wdiscarded-qualifiers
5445 Do not warn if type qualifiers on pointers are being discarded.
5446 Typically, the compiler warns if a @code{const char *} variable is
5447 passed to a function that takes a @code{char *} parameter.  This option
5448 can be used to suppress such a warning.
5450 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
5451 @opindex Wno-discarded-array-qualifiers
5452 @opindex Wdiscarded-array-qualifiers
5453 Do not warn if type qualifiers on arrays which are pointer targets
5454 are being discarded. Typically, the compiler warns if a
5455 @code{const int (*)[]} variable is passed to a function that
5456 takes a @code{int (*)[]} parameter.  This option can be used to
5457 suppress such a warning.
5459 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
5460 @opindex Wno-incompatible-pointer-types
5461 @opindex Wincompatible-pointer-types
5462 Do not warn when there is a conversion between pointers that have incompatible
5463 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
5464 which warns for pointer argument passing or assignment with different
5465 signedness.
5467 @item -Wno-int-conversion @r{(C and Objective-C only)}
5468 @opindex Wno-int-conversion
5469 @opindex Wint-conversion
5470 Do not warn about incompatible integer to pointer and pointer to integer
5471 conversions.  This warning is about implicit conversions; for explicit
5472 conversions the warnings @option{-Wno-int-to-pointer-cast} and
5473 @option{-Wno-pointer-to-int-cast} may be used.
5475 @item -Wno-div-by-zero
5476 @opindex Wno-div-by-zero
5477 @opindex Wdiv-by-zero
5478 Do not warn about compile-time integer division by zero.  Floating-point
5479 division by zero is not warned about, as it can be a legitimate way of
5480 obtaining infinities and NaNs.
5482 @item -Wsystem-headers
5483 @opindex Wsystem-headers
5484 @opindex Wno-system-headers
5485 @cindex warnings from system headers
5486 @cindex system headers, warnings from
5487 Print warning messages for constructs found in system header files.
5488 Warnings from system headers are normally suppressed, on the assumption
5489 that they usually do not indicate real problems and would only make the
5490 compiler output harder to read.  Using this command-line option tells
5491 GCC to emit warnings from system headers as if they occurred in user
5492 code.  However, note that using @option{-Wall} in conjunction with this
5493 option does @emph{not} warn about unknown pragmas in system
5494 headers---for that, @option{-Wunknown-pragmas} must also be used.
5496 @item -Wtautological-compare
5497 @opindex Wtautological-compare
5498 @opindex Wno-tautological-compare
5499 Warn if a self-comparison always evaluates to true or false.  This
5500 warning detects various mistakes such as:
5501 @smallexample
5502 int i = 1;
5503 @dots{}
5504 if (i > i) @{ @dots{} @}
5505 @end smallexample
5507 This warning also warns about bitwise comparisons that always evaluate
5508 to true or false, for instance:
5509 @smallexample
5510 if ((a & 16) == 10) @{ @dots{} @}
5511 @end smallexample
5512 will always be false.
5514 This warning is enabled by @option{-Wall}.
5516 @item -Wtrampolines
5517 @opindex Wtrampolines
5518 @opindex Wno-trampolines
5519 Warn about trampolines generated for pointers to nested functions.
5520 A trampoline is a small piece of data or code that is created at run
5521 time on the stack when the address of a nested function is taken, and is
5522 used to call the nested function indirectly.  For some targets, it is
5523 made up of data only and thus requires no special treatment.  But, for
5524 most targets, it is made up of code and thus requires the stack to be
5525 made executable in order for the program to work properly.
5527 @item -Wfloat-equal
5528 @opindex Wfloat-equal
5529 @opindex Wno-float-equal
5530 Warn if floating-point values are used in equality comparisons.
5532 The idea behind this is that sometimes it is convenient (for the
5533 programmer) to consider floating-point values as approximations to
5534 infinitely precise real numbers.  If you are doing this, then you need
5535 to compute (by analyzing the code, or in some other way) the maximum or
5536 likely maximum error that the computation introduces, and allow for it
5537 when performing comparisons (and when producing output, but that's a
5538 different problem).  In particular, instead of testing for equality, you
5539 should check to see whether the two values have ranges that overlap; and
5540 this is done with the relational operators, so equality comparisons are
5541 probably mistaken.
5543 @item -Wtraditional @r{(C and Objective-C only)}
5544 @opindex Wtraditional
5545 @opindex Wno-traditional
5546 Warn about certain constructs that behave differently in traditional and
5547 ISO C@.  Also warn about ISO C constructs that have no traditional C
5548 equivalent, and/or problematic constructs that should be avoided.
5550 @itemize @bullet
5551 @item
5552 Macro parameters that appear within string literals in the macro body.
5553 In traditional C macro replacement takes place within string literals,
5554 but in ISO C it does not.
5556 @item
5557 In traditional C, some preprocessor directives did not exist.
5558 Traditional preprocessors only considered a line to be a directive
5559 if the @samp{#} appeared in column 1 on the line.  Therefore
5560 @option{-Wtraditional} warns about directives that traditional C
5561 understands but ignores because the @samp{#} does not appear as the
5562 first character on the line.  It also suggests you hide directives like
5563 @code{#pragma} not understood by traditional C by indenting them.  Some
5564 traditional implementations do not recognize @code{#elif}, so this option
5565 suggests avoiding it altogether.
5567 @item
5568 A function-like macro that appears without arguments.
5570 @item
5571 The unary plus operator.
5573 @item
5574 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
5575 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
5576 constants.)  Note, these suffixes appear in macros defined in the system
5577 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
5578 Use of these macros in user code might normally lead to spurious
5579 warnings, however GCC's integrated preprocessor has enough context to
5580 avoid warning in these cases.
5582 @item
5583 A function declared external in one block and then used after the end of
5584 the block.
5586 @item
5587 A @code{switch} statement has an operand of type @code{long}.
5589 @item
5590 A non-@code{static} function declaration follows a @code{static} one.
5591 This construct is not accepted by some traditional C compilers.
5593 @item
5594 The ISO type of an integer constant has a different width or
5595 signedness from its traditional type.  This warning is only issued if
5596 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
5597 typically represent bit patterns, are not warned about.
5599 @item
5600 Usage of ISO string concatenation is detected.
5602 @item
5603 Initialization of automatic aggregates.
5605 @item
5606 Identifier conflicts with labels.  Traditional C lacks a separate
5607 namespace for labels.
5609 @item
5610 Initialization of unions.  If the initializer is zero, the warning is
5611 omitted.  This is done under the assumption that the zero initializer in
5612 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
5613 initializer warnings and relies on default initialization to zero in the
5614 traditional C case.
5616 @item
5617 Conversions by prototypes between fixed/floating-point values and vice
5618 versa.  The absence of these prototypes when compiling with traditional
5619 C causes serious problems.  This is a subset of the possible
5620 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
5622 @item
5623 Use of ISO C style function definitions.  This warning intentionally is
5624 @emph{not} issued for prototype declarations or variadic functions
5625 because these ISO C features appear in your code when using
5626 libiberty's traditional C compatibility macros, @code{PARAMS} and
5627 @code{VPARAMS}.  This warning is also bypassed for nested functions
5628 because that feature is already a GCC extension and thus not relevant to
5629 traditional C compatibility.
5630 @end itemize
5632 @item -Wtraditional-conversion @r{(C and Objective-C only)}
5633 @opindex Wtraditional-conversion
5634 @opindex Wno-traditional-conversion
5635 Warn if a prototype causes a type conversion that is different from what
5636 would happen to the same argument in the absence of a prototype.  This
5637 includes conversions of fixed point to floating and vice versa, and
5638 conversions changing the width or signedness of a fixed-point argument
5639 except when the same as the default promotion.
5641 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
5642 @opindex Wdeclaration-after-statement
5643 @opindex Wno-declaration-after-statement
5644 Warn when a declaration is found after a statement in a block.  This
5645 construct, known from C++, was introduced with ISO C99 and is by default
5646 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
5648 @item -Wshadow
5649 @opindex Wshadow
5650 @opindex Wno-shadow
5651 Warn whenever a local variable or type declaration shadows another
5652 variable, parameter, type, class member (in C++), or instance variable
5653 (in Objective-C) or whenever a built-in function is shadowed. Note
5654 that in C++, the compiler warns if a local variable shadows an
5655 explicit typedef, but not if it shadows a struct/class/enum.
5656 Same as @option{-Wshadow=global}.
5658 @item -Wno-shadow-ivar @r{(Objective-C only)}
5659 @opindex Wno-shadow-ivar
5660 @opindex Wshadow-ivar
5661 Do not warn whenever a local variable shadows an instance variable in an
5662 Objective-C method.
5664 @item -Wshadow=global
5665 @opindex Wshadow=local
5666 The default for @option{-Wshadow}. Warns for any (global) shadowing.
5668 @item -Wshadow=local
5669 @opindex Wshadow=local
5670 Warn when a local variable shadows another local variable or parameter.
5671 This warning is enabled by @option{-Wshadow=global}.
5673 @item -Wshadow=compatible-local
5674 @opindex Wshadow=compatible-local
5675 Warn when a local variable shadows another local variable or parameter
5676 whose type is compatible with that of the shadowing variable. In C++,
5677 type compatibility here means the type of the shadowing variable can be
5678 converted to that of the shadowed variable. The creation of this flag
5679 (in addition to @option{-Wshadow=local}) is based on the idea that when
5680 a local variable shadows another one of incompatible type, it is most
5681 likely intentional, not a bug or typo, as shown in the following example:
5683 @smallexample
5684 @group
5685 for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i)
5687   for (int i = 0; i < N; ++i)
5688   @{
5689     ...
5690   @}
5691   ...
5693 @end group
5694 @end smallexample
5696 Since the two variable @code{i} in the example above have incompatible types,
5697 enabling only @option{-Wshadow=compatible-local} will not emit a warning.
5698 Because their types are incompatible, if a programmer accidentally uses one
5699 in place of the other, type checking will catch that and emit an error or
5700 warning. So not warning (about shadowing) in this case will not lead to
5701 undetected bugs. Use of this flag instead of @option{-Wshadow=local} can
5702 possibly reduce the number of warnings triggered by intentional shadowing.
5704 This warning is enabled by @option{-Wshadow=local}.
5706 @item -Wlarger-than=@var{len}
5707 @opindex Wlarger-than=@var{len}
5708 @opindex Wlarger-than-@var{len}
5709 Warn whenever an object of larger than @var{len} bytes is defined.
5711 @item -Wframe-larger-than=@var{len}
5712 @opindex Wframe-larger-than
5713 Warn if the size of a function frame is larger than @var{len} bytes.
5714 The computation done to determine the stack frame size is approximate
5715 and not conservative.
5716 The actual requirements may be somewhat greater than @var{len}
5717 even if you do not get a warning.  In addition, any space allocated
5718 via @code{alloca}, variable-length arrays, or related constructs
5719 is not included by the compiler when determining
5720 whether or not to issue a warning.
5722 @item -Wno-free-nonheap-object
5723 @opindex Wno-free-nonheap-object
5724 @opindex Wfree-nonheap-object
5725 Do not warn when attempting to free an object that was not allocated
5726 on the heap.
5728 @item -Wstack-usage=@var{len}
5729 @opindex Wstack-usage
5730 Warn if the stack usage of a function might be larger than @var{len} bytes.
5731 The computation done to determine the stack usage is conservative.
5732 Any space allocated via @code{alloca}, variable-length arrays, or related
5733 constructs is included by the compiler when determining whether or not to
5734 issue a warning.
5736 The message is in keeping with the output of @option{-fstack-usage}.
5738 @itemize
5739 @item
5740 If the stack usage is fully static but exceeds the specified amount, it's:
5742 @smallexample
5743   warning: stack usage is 1120 bytes
5744 @end smallexample
5745 @item
5746 If the stack usage is (partly) dynamic but bounded, it's:
5748 @smallexample
5749   warning: stack usage might be 1648 bytes
5750 @end smallexample
5751 @item
5752 If the stack usage is (partly) dynamic and not bounded, it's:
5754 @smallexample
5755   warning: stack usage might be unbounded
5756 @end smallexample
5757 @end itemize
5759 @item -Wunsafe-loop-optimizations
5760 @opindex Wunsafe-loop-optimizations
5761 @opindex Wno-unsafe-loop-optimizations
5762 Warn if the loop cannot be optimized because the compiler cannot
5763 assume anything on the bounds of the loop indices.  With
5764 @option{-funsafe-loop-optimizations} warn if the compiler makes
5765 such assumptions.
5767 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
5768 @opindex Wno-pedantic-ms-format
5769 @opindex Wpedantic-ms-format
5770 When used in combination with @option{-Wformat}
5771 and @option{-pedantic} without GNU extensions, this option
5772 disables the warnings about non-ISO @code{printf} / @code{scanf} format
5773 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
5774 which depend on the MS runtime.
5776 @item -Waligned-new
5777 @opindex Waligned-new
5778 @opindex Wno-aligned-new
5779 Warn about a new-expression of a type that requires greater alignment
5780 than the @code{alignof(std::max_align_t)} but uses an allocation
5781 function without an explicit alignment parameter. This option is
5782 enabled by @option{-Wall}.
5784 Normally this only warns about global allocation functions, but
5785 @option{-Waligned-new=all} also warns about class member allocation
5786 functions.
5788 @item -Wplacement-new
5789 @itemx -Wplacement-new=@var{n}
5790 @opindex Wplacement-new
5791 @opindex Wno-placement-new
5792 Warn about placement new expressions with undefined behavior, such as
5793 constructing an object in a buffer that is smaller than the type of
5794 the object.  For example, the placement new expression below is diagnosed
5795 because it attempts to construct an array of 64 integers in a buffer only
5796 64 bytes large.
5797 @smallexample
5798 char buf [64];
5799 new (buf) int[64];
5800 @end smallexample
5801 This warning is enabled by default.
5803 @table @gcctabopt
5804 @item -Wplacement-new=1
5805 This is the default warning level of @option{-Wplacement-new}.  At this
5806 level the warning is not issued for some strictly undefined constructs that
5807 GCC allows as extensions for compatibility with legacy code.  For example,
5808 the following @code{new} expression is not diagnosed at this level even
5809 though it has undefined behavior according to the C++ standard because
5810 it writes past the end of the one-element array.
5811 @smallexample
5812 struct S @{ int n, a[1]; @};
5813 S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]);
5814 new (s->a)int [32]();
5815 @end smallexample
5817 @item -Wplacement-new=2
5818 At this level, in addition to diagnosing all the same constructs as at level
5819 1, a diagnostic is also issued for placement new expressions that construct
5820 an object in the last member of structure whose type is an array of a single
5821 element and whose size is less than the size of the object being constructed.
5822 While the previous example would be diagnosed, the following construct makes
5823 use of the flexible member array extension to avoid the warning at level 2.
5824 @smallexample
5825 struct S @{ int n, a[]; @};
5826 S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]);
5827 new (s->a)int [32]();
5828 @end smallexample
5830 @end table
5832 @item -Wpointer-arith
5833 @opindex Wpointer-arith
5834 @opindex Wno-pointer-arith
5835 Warn about anything that depends on the ``size of'' a function type or
5836 of @code{void}.  GNU C assigns these types a size of 1, for
5837 convenience in calculations with @code{void *} pointers and pointers
5838 to functions.  In C++, warn also when an arithmetic operation involves
5839 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
5841 @item -Wpointer-compare
5842 @opindex Wpointer-compare
5843 @opindex Wno-pointer-compare
5844 Warn if a pointer is compared with a zero character constant.  This usually
5845 means that the pointer was meant to be dereferenced.  For example:
5847 @smallexample
5848 const char *p = foo ();
5849 if (p == '\0')
5850   return 42;
5851 @end smallexample
5853 Note that the code above is invalid in C++11.
5855 This warning is enabled by default.
5857 @item -Wtype-limits
5858 @opindex Wtype-limits
5859 @opindex Wno-type-limits
5860 Warn if a comparison is always true or always false due to the limited
5861 range of the data type, but do not warn for constant expressions.  For
5862 example, warn if an unsigned variable is compared against zero with
5863 @code{<} or @code{>=}.  This warning is also enabled by
5864 @option{-Wextra}.
5866 @include cppwarnopts.texi
5868 @item -Wbad-function-cast @r{(C and Objective-C only)}
5869 @opindex Wbad-function-cast
5870 @opindex Wno-bad-function-cast
5871 Warn when a function call is cast to a non-matching type.
5872 For example, warn if a call to a function returning an integer type 
5873 is cast to a pointer type.
5875 @item -Wc90-c99-compat @r{(C and Objective-C only)}
5876 @opindex Wc90-c99-compat
5877 @opindex Wno-c90-c99-compat
5878 Warn about features not present in ISO C90, but present in ISO C99.
5879 For instance, warn about use of variable length arrays, @code{long long}
5880 type, @code{bool} type, compound literals, designated initializers, and so
5881 on.  This option is independent of the standards mode.  Warnings are disabled
5882 in the expression that follows @code{__extension__}.
5884 @item -Wc99-c11-compat @r{(C and Objective-C only)}
5885 @opindex Wc99-c11-compat
5886 @opindex Wno-c99-c11-compat
5887 Warn about features not present in ISO C99, but present in ISO C11.
5888 For instance, warn about use of anonymous structures and unions,
5889 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
5890 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
5891 and so on.  This option is independent of the standards mode.  Warnings are
5892 disabled in the expression that follows @code{__extension__}.
5894 @item -Wc++-compat @r{(C and Objective-C only)}
5895 @opindex Wc++-compat
5896 Warn about ISO C constructs that are outside of the common subset of
5897 ISO C and ISO C++, e.g.@: request for implicit conversion from
5898 @code{void *} to a pointer to non-@code{void} type.
5900 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
5901 @opindex Wc++11-compat
5902 Warn about C++ constructs whose meaning differs between ISO C++ 1998
5903 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
5904 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
5905 enabled by @option{-Wall}.
5907 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
5908 @opindex Wc++14-compat
5909 Warn about C++ constructs whose meaning differs between ISO C++ 2011
5910 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
5912 @item -Wc++17-compat @r{(C++ and Objective-C++ only)}
5913 @opindex Wc++17-compat
5914 Warn about C++ constructs whose meaning differs between ISO C++ 2014
5915 and ISO C++ 2017.  This warning is enabled by @option{-Wall}.
5917 @item -Wcast-qual
5918 @opindex Wcast-qual
5919 @opindex Wno-cast-qual
5920 Warn whenever a pointer is cast so as to remove a type qualifier from
5921 the target type.  For example, warn if a @code{const char *} is cast
5922 to an ordinary @code{char *}.
5924 Also warn when making a cast that introduces a type qualifier in an
5925 unsafe way.  For example, casting @code{char **} to @code{const char **}
5926 is unsafe, as in this example:
5928 @smallexample
5929   /* p is char ** value.  */
5930   const char **q = (const char **) p;
5931   /* Assignment of readonly string to const char * is OK.  */
5932   *q = "string";
5933   /* Now char** pointer points to read-only memory.  */
5934   **p = 'b';
5935 @end smallexample
5937 @item -Wcast-align
5938 @opindex Wcast-align
5939 @opindex Wno-cast-align
5940 Warn whenever a pointer is cast such that the required alignment of the
5941 target is increased.  For example, warn if a @code{char *} is cast to
5942 an @code{int *} on machines where integers can only be accessed at
5943 two- or four-byte boundaries.
5945 @item -Wcast-align=strict
5946 @opindex Wcast-align=strict
5947 Warn whenever a pointer is cast such that the required alignment of the
5948 target is increased.  For example, warn if a @code{char *} is cast to
5949 an @code{int *} regardless of the target machine.
5951 @item -Wwrite-strings
5952 @opindex Wwrite-strings
5953 @opindex Wno-write-strings
5954 When compiling C, give string constants the type @code{const
5955 char[@var{length}]} so that copying the address of one into a
5956 non-@code{const} @code{char *} pointer produces a warning.  These
5957 warnings help you find at compile time code that can try to write
5958 into a string constant, but only if you have been very careful about
5959 using @code{const} in declarations and prototypes.  Otherwise, it is
5960 just a nuisance. This is why we did not make @option{-Wall} request
5961 these warnings.
5963 When compiling C++, warn about the deprecated conversion from string
5964 literals to @code{char *}.  This warning is enabled by default for C++
5965 programs.
5967 @item -Wcatch-value
5968 @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)}
5969 @opindex Wcatch-value
5970 @opindex Wno-catch-value
5971 Warn about catch handlers that do not catch via reference.
5972 With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short)
5973 warn about polymorphic class types that are caught by value.
5974 With @option{-Wcatch-value=2} warn about all class types that are caught
5975 by value. With @option{-Wcatch-value=3} warn about all types that are
5976 not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}.
5978 @item -Wclobbered
5979 @opindex Wclobbered
5980 @opindex Wno-clobbered
5981 Warn for variables that might be changed by @code{longjmp} or
5982 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5984 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5985 @opindex Wconditionally-supported
5986 @opindex Wno-conditionally-supported
5987 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5989 @item -Wconversion
5990 @opindex Wconversion
5991 @opindex Wno-conversion
5992 Warn for implicit conversions that may alter a value. This includes
5993 conversions between real and integer, like @code{abs (x)} when
5994 @code{x} is @code{double}; conversions between signed and unsigned,
5995 like @code{unsigned ui = -1}; and conversions to smaller types, like
5996 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5997 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5998 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5999 conversions between signed and unsigned integers can be disabled by
6000 using @option{-Wno-sign-conversion}.
6002 For C++, also warn for confusing overload resolution for user-defined
6003 conversions; and conversions that never use a type conversion
6004 operator: conversions to @code{void}, the same type, a base class or a
6005 reference to them. Warnings about conversions between signed and
6006 unsigned integers are disabled by default in C++ unless
6007 @option{-Wsign-conversion} is explicitly enabled.
6009 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
6010 @opindex Wconversion-null
6011 @opindex Wno-conversion-null
6012 Do not warn for conversions between @code{NULL} and non-pointer
6013 types. @option{-Wconversion-null} is enabled by default.
6015 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
6016 @opindex Wzero-as-null-pointer-constant
6017 @opindex Wno-zero-as-null-pointer-constant
6018 Warn when a literal @samp{0} is used as null pointer constant.  This can
6019 be useful to facilitate the conversion to @code{nullptr} in C++11.
6021 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
6022 @opindex Wsubobject-linkage
6023 @opindex Wno-subobject-linkage
6024 Warn if a class type has a base or a field whose type uses the anonymous
6025 namespace or depends on a type with no linkage.  If a type A depends on
6026 a type B with no or internal linkage, defining it in multiple
6027 translation units would be an ODR violation because the meaning of B
6028 is different in each translation unit.  If A only appears in a single
6029 translation unit, the best way to silence the warning is to give it
6030 internal linkage by putting it in an anonymous namespace as well.  The
6031 compiler doesn't give this warning for types defined in the main .C
6032 file, as those are unlikely to have multiple definitions.
6033 @option{-Wsubobject-linkage} is enabled by default.
6035 @item -Wdangling-else
6036 @opindex Wdangling-else
6037 @opindex Wno-dangling-else
6038 Warn about constructions where there may be confusion to which
6039 @code{if} statement an @code{else} branch belongs.  Here is an example of
6040 such a case:
6042 @smallexample
6043 @group
6045   if (a)
6046     if (b)
6047       foo ();
6048   else
6049     bar ();
6051 @end group
6052 @end smallexample
6054 In C/C++, every @code{else} branch belongs to the innermost possible
6055 @code{if} statement, which in this example is @code{if (b)}.  This is
6056 often not what the programmer expected, as illustrated in the above
6057 example by indentation the programmer chose.  When there is the
6058 potential for this confusion, GCC issues a warning when this flag
6059 is specified.  To eliminate the warning, add explicit braces around
6060 the innermost @code{if} statement so there is no way the @code{else}
6061 can belong to the enclosing @code{if}.  The resulting code
6062 looks like this:
6064 @smallexample
6065 @group
6067   if (a)
6068     @{
6069       if (b)
6070         foo ();
6071       else
6072         bar ();
6073     @}
6075 @end group
6076 @end smallexample
6078 This warning is enabled by @option{-Wparentheses}.
6080 @item -Wdate-time
6081 @opindex Wdate-time
6082 @opindex Wno-date-time
6083 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
6084 are encountered as they might prevent bit-wise-identical reproducible
6085 compilations.
6087 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
6088 @opindex Wdelete-incomplete
6089 @opindex Wno-delete-incomplete
6090 Warn when deleting a pointer to incomplete type, which may cause
6091 undefined behavior at runtime.  This warning is enabled by default.
6093 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
6094 @opindex Wuseless-cast
6095 @opindex Wno-useless-cast
6096 Warn when an expression is casted to its own type.
6098 @item -Wempty-body
6099 @opindex Wempty-body
6100 @opindex Wno-empty-body
6101 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
6102 while} statement.  This warning is also enabled by @option{-Wextra}.
6104 @item -Wenum-compare
6105 @opindex Wenum-compare
6106 @opindex Wno-enum-compare
6107 Warn about a comparison between values of different enumerated types.
6108 In C++ enumerated type mismatches in conditional expressions are also
6109 diagnosed and the warning is enabled by default.  In C this warning is 
6110 enabled by @option{-Wall}.
6112 @item -Wextra-semi @r{(C++, Objective-C++ only)}
6113 @opindex Wextra-semi
6114 @opindex Wno-extra-semi
6115 Warn about redundant semicolon after in-class function definition.
6117 @item -Wjump-misses-init @r{(C, Objective-C only)}
6118 @opindex Wjump-misses-init
6119 @opindex Wno-jump-misses-init
6120 Warn if a @code{goto} statement or a @code{switch} statement jumps
6121 forward across the initialization of a variable, or jumps backward to a
6122 label after the variable has been initialized.  This only warns about
6123 variables that are initialized when they are declared.  This warning is
6124 only supported for C and Objective-C; in C++ this sort of branch is an
6125 error in any case.
6127 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
6128 can be disabled with the @option{-Wno-jump-misses-init} option.
6130 @item -Wsign-compare
6131 @opindex Wsign-compare
6132 @opindex Wno-sign-compare
6133 @cindex warning for comparison of signed and unsigned values
6134 @cindex comparison of signed and unsigned values, warning
6135 @cindex signed and unsigned values, comparison warning
6136 Warn when a comparison between signed and unsigned values could produce
6137 an incorrect result when the signed value is converted to unsigned.
6138 In C++, this warning is also enabled by @option{-Wall}.  In C, it is
6139 also enabled by @option{-Wextra}.
6141 @item -Wsign-conversion
6142 @opindex Wsign-conversion
6143 @opindex Wno-sign-conversion
6144 Warn for implicit conversions that may change the sign of an integer
6145 value, like assigning a signed integer expression to an unsigned
6146 integer variable. An explicit cast silences the warning. In C, this
6147 option is enabled also by @option{-Wconversion}.
6149 @item -Wfloat-conversion
6150 @opindex Wfloat-conversion
6151 @opindex Wno-float-conversion
6152 Warn for implicit conversions that reduce the precision of a real value.
6153 This includes conversions from real to integer, and from higher precision
6154 real to lower precision real values.  This option is also enabled by
6155 @option{-Wconversion}.
6157 @item -Wno-scalar-storage-order
6158 @opindex -Wno-scalar-storage-order
6159 @opindex -Wscalar-storage-order
6160 Do not warn on suspicious constructs involving reverse scalar storage order.
6162 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
6163 @opindex Wsized-deallocation
6164 @opindex Wno-sized-deallocation
6165 Warn about a definition of an unsized deallocation function
6166 @smallexample
6167 void operator delete (void *) noexcept;
6168 void operator delete[] (void *) noexcept;
6169 @end smallexample
6170 without a definition of the corresponding sized deallocation function
6171 @smallexample
6172 void operator delete (void *, std::size_t) noexcept;
6173 void operator delete[] (void *, std::size_t) noexcept;
6174 @end smallexample
6175 or vice versa.  Enabled by @option{-Wextra} along with
6176 @option{-fsized-deallocation}.
6178 @item -Wsizeof-pointer-div
6179 @opindex Wsizeof-pointer-div
6180 @opindex Wno-sizeof-pointer-div
6181 Warn for suspicious divisions of two sizeof expressions that divide
6182 the pointer size by the element size, which is the usual way to compute
6183 the array size but won't work out correctly with pointers.  This warning
6184 warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is
6185 not an array, but a pointer.  This warning is enabled by @option{-Wall}.
6187 @item -Wsizeof-pointer-memaccess
6188 @opindex Wsizeof-pointer-memaccess
6189 @opindex Wno-sizeof-pointer-memaccess
6190 Warn for suspicious length parameters to certain string and memory built-in
6191 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
6192 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
6193 but a pointer, and suggests a possible fix, or about
6194 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
6195 @option{-Wall}.
6197 @item -Wsizeof-array-argument
6198 @opindex Wsizeof-array-argument
6199 @opindex Wno-sizeof-array-argument
6200 Warn when the @code{sizeof} operator is applied to a parameter that is
6201 declared as an array in a function definition.  This warning is enabled by
6202 default for C and C++ programs.
6204 @item -Wmemset-elt-size
6205 @opindex Wmemset-elt-size
6206 @opindex Wno-memset-elt-size
6207 Warn for suspicious calls to the @code{memset} built-in function, if the
6208 first argument references an array, and the third argument is a number
6209 equal to the number of elements, but not equal to the size of the array
6210 in memory.  This indicates that the user has omitted a multiplication by
6211 the element size.  This warning is enabled by @option{-Wall}.
6213 @item -Wmemset-transposed-args
6214 @opindex Wmemset-transposed-args
6215 @opindex Wno-memset-transposed-args
6216 Warn for suspicious calls to the @code{memset} built-in function, if the
6217 second argument is not zero and the third argument is zero.  This warns e.g.@
6218 about @code{memset (buf, sizeof buf, 0)} where most probably
6219 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
6220 is only emitted if the third argument is literal zero.  If it is some
6221 expression that is folded to zero, a cast of zero to some type, etc., 
6222 it is far less likely that the user has mistakenly exchanged the arguments 
6223 and no warning is emitted.  This warning is enabled by @option{-Wall}.
6225 @item -Waddress
6226 @opindex Waddress
6227 @opindex Wno-address
6228 Warn about suspicious uses of memory addresses. These include using
6229 the address of a function in a conditional expression, such as
6230 @code{void func(void); if (func)}, and comparisons against the memory
6231 address of a string literal, such as @code{if (x == "abc")}.  Such
6232 uses typically indicate a programmer error: the address of a function
6233 always evaluates to true, so their use in a conditional usually
6234 indicate that the programmer forgot the parentheses in a function
6235 call; and comparisons against string literals result in unspecified
6236 behavior and are not portable in C, so they usually indicate that the
6237 programmer intended to use @code{strcmp}.  This warning is enabled by
6238 @option{-Wall}.
6240 @item -Wlogical-op
6241 @opindex Wlogical-op
6242 @opindex Wno-logical-op
6243 Warn about suspicious uses of logical operators in expressions.
6244 This includes using logical operators in contexts where a
6245 bit-wise operator is likely to be expected.  Also warns when
6246 the operands of a logical operator are the same:
6247 @smallexample
6248 extern int a;
6249 if (a < 0 && a < 0) @{ @dots{} @}
6250 @end smallexample
6252 @item -Wlogical-not-parentheses
6253 @opindex Wlogical-not-parentheses
6254 @opindex Wno-logical-not-parentheses
6255 Warn about logical not used on the left hand side operand of a comparison.
6256 This option does not warn if the right operand is considered to be a boolean
6257 expression.  Its purpose is to detect suspicious code like the following:
6258 @smallexample
6259 int a;
6260 @dots{}
6261 if (!a > 1) @{ @dots{} @}
6262 @end smallexample
6264 It is possible to suppress the warning by wrapping the LHS into
6265 parentheses:
6266 @smallexample
6267 if ((!a) > 1) @{ @dots{} @}
6268 @end smallexample
6270 This warning is enabled by @option{-Wall}.
6272 @item -Waggregate-return
6273 @opindex Waggregate-return
6274 @opindex Wno-aggregate-return
6275 Warn if any functions that return structures or unions are defined or
6276 called.  (In languages where you can return an array, this also elicits
6277 a warning.)
6279 @item -Wno-aggressive-loop-optimizations
6280 @opindex Wno-aggressive-loop-optimizations
6281 @opindex Waggressive-loop-optimizations
6282 Warn if in a loop with constant number of iterations the compiler detects
6283 undefined behavior in some statement during one or more of the iterations.
6285 @item -Wno-attributes
6286 @opindex Wno-attributes
6287 @opindex Wattributes
6288 Do not warn if an unexpected @code{__attribute__} is used, such as
6289 unrecognized attributes, function attributes applied to variables,
6290 etc.  This does not stop errors for incorrect use of supported
6291 attributes.
6293 @item -Wno-builtin-declaration-mismatch
6294 @opindex Wno-builtin-declaration-mismatch
6295 @opindex Wbuiltin-declaration-mismatch
6296 Warn if a built-in function is declared with the wrong signature.
6297 This warning is enabled by default.
6299 @item -Wno-builtin-macro-redefined
6300 @opindex Wno-builtin-macro-redefined
6301 @opindex Wbuiltin-macro-redefined
6302 Do not warn if certain built-in macros are redefined.  This suppresses
6303 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
6304 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
6306 @item -Wstrict-prototypes @r{(C and Objective-C only)}
6307 @opindex Wstrict-prototypes
6308 @opindex Wno-strict-prototypes
6309 Warn if a function is declared or defined without specifying the
6310 argument types.  (An old-style function definition is permitted without
6311 a warning if preceded by a declaration that specifies the argument
6312 types.)
6314 @item -Wold-style-declaration @r{(C and Objective-C only)}
6315 @opindex Wold-style-declaration
6316 @opindex Wno-old-style-declaration
6317 Warn for obsolescent usages, according to the C Standard, in a
6318 declaration. For example, warn if storage-class specifiers like
6319 @code{static} are not the first things in a declaration.  This warning
6320 is also enabled by @option{-Wextra}.
6322 @item -Wold-style-definition @r{(C and Objective-C only)}
6323 @opindex Wold-style-definition
6324 @opindex Wno-old-style-definition
6325 Warn if an old-style function definition is used.  A warning is given
6326 even if there is a previous prototype.
6328 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
6329 @opindex Wmissing-parameter-type
6330 @opindex Wno-missing-parameter-type
6331 A function parameter is declared without a type specifier in K&R-style
6332 functions:
6334 @smallexample
6335 void foo(bar) @{ @}
6336 @end smallexample
6338 This warning is also enabled by @option{-Wextra}.
6340 @item -Wmissing-prototypes @r{(C and Objective-C only)}
6341 @opindex Wmissing-prototypes
6342 @opindex Wno-missing-prototypes
6343 Warn if a global function is defined without a previous prototype
6344 declaration.  This warning is issued even if the definition itself
6345 provides a prototype.  Use this option to detect global functions
6346 that do not have a matching prototype declaration in a header file.
6347 This option is not valid for C++ because all function declarations
6348 provide prototypes and a non-matching declaration declares an
6349 overload rather than conflict with an earlier declaration.
6350 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
6352 @item -Wmissing-declarations
6353 @opindex Wmissing-declarations
6354 @opindex Wno-missing-declarations
6355 Warn if a global function is defined without a previous declaration.
6356 Do so even if the definition itself provides a prototype.
6357 Use this option to detect global functions that are not declared in
6358 header files.  In C, no warnings are issued for functions with previous
6359 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
6360 missing prototypes.  In C++, no warnings are issued for function templates,
6361 or for inline functions, or for functions in anonymous namespaces.
6363 @item -Wmissing-field-initializers
6364 @opindex Wmissing-field-initializers
6365 @opindex Wno-missing-field-initializers
6366 @opindex W
6367 @opindex Wextra
6368 @opindex Wno-extra
6369 Warn if a structure's initializer has some fields missing.  For
6370 example, the following code causes such a warning, because
6371 @code{x.h} is implicitly zero:
6373 @smallexample
6374 struct s @{ int f, g, h; @};
6375 struct s x = @{ 3, 4 @};
6376 @end smallexample
6378 This option does not warn about designated initializers, so the following
6379 modification does not trigger a warning:
6381 @smallexample
6382 struct s @{ int f, g, h; @};
6383 struct s x = @{ .f = 3, .g = 4 @};
6384 @end smallexample
6386 In C this option does not warn about the universal zero initializer
6387 @samp{@{ 0 @}}:
6389 @smallexample
6390 struct s @{ int f, g, h; @};
6391 struct s x = @{ 0 @};
6392 @end smallexample
6394 Likewise, in C++ this option does not warn about the empty @{ @}
6395 initializer, for example:
6397 @smallexample
6398 struct s @{ int f, g, h; @};
6399 s x = @{ @};
6400 @end smallexample
6402 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
6403 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
6405 @item -Wno-multichar
6406 @opindex Wno-multichar
6407 @opindex Wmultichar
6408 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
6409 Usually they indicate a typo in the user's code, as they have
6410 implementation-defined values, and should not be used in portable code.
6412 @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]}
6413 @opindex Wnormalized=
6414 @opindex Wnormalized
6415 @opindex Wno-normalized
6416 @cindex NFC
6417 @cindex NFKC
6418 @cindex character set, input normalization
6419 In ISO C and ISO C++, two identifiers are different if they are
6420 different sequences of characters.  However, sometimes when characters
6421 outside the basic ASCII character set are used, you can have two
6422 different character sequences that look the same.  To avoid confusion,
6423 the ISO 10646 standard sets out some @dfn{normalization rules} which
6424 when applied ensure that two sequences that look the same are turned into
6425 the same sequence.  GCC can warn you if you are using identifiers that
6426 have not been normalized; this option controls that warning.
6428 There are four levels of warning supported by GCC@.  The default is
6429 @option{-Wnormalized=nfc}, which warns about any identifier that is
6430 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
6431 recommended form for most uses.  It is equivalent to
6432 @option{-Wnormalized}.
6434 Unfortunately, there are some characters allowed in identifiers by
6435 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
6436 identifiers.  That is, there's no way to use these symbols in portable
6437 ISO C or C++ and have all your identifiers in NFC@.
6438 @option{-Wnormalized=id} suppresses the warning for these characters.
6439 It is hoped that future versions of the standards involved will correct
6440 this, which is why this option is not the default.
6442 You can switch the warning off for all characters by writing
6443 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
6444 only do this if you are using some other normalization scheme (like
6445 ``D''), because otherwise you can easily create bugs that are
6446 literally impossible to see.
6448 Some characters in ISO 10646 have distinct meanings but look identical
6449 in some fonts or display methodologies, especially once formatting has
6450 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
6451 LETTER N'', displays just like a regular @code{n} that has been
6452 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
6453 normalization scheme to convert all these into a standard form as
6454 well, and GCC warns if your code is not in NFKC if you use
6455 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
6456 about every identifier that contains the letter O because it might be
6457 confused with the digit 0, and so is not the default, but may be
6458 useful as a local coding convention if the programming environment 
6459 cannot be fixed to display these characters distinctly.
6461 @item -Wno-deprecated
6462 @opindex Wno-deprecated
6463 @opindex Wdeprecated
6464 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
6466 @item -Wno-deprecated-declarations
6467 @opindex Wno-deprecated-declarations
6468 @opindex Wdeprecated-declarations
6469 Do not warn about uses of functions (@pxref{Function Attributes}),
6470 variables (@pxref{Variable Attributes}), and types (@pxref{Type
6471 Attributes}) marked as deprecated by using the @code{deprecated}
6472 attribute.
6474 @item -Wno-overflow
6475 @opindex Wno-overflow
6476 @opindex Woverflow
6477 Do not warn about compile-time overflow in constant expressions.
6479 @item -Wno-odr
6480 @opindex Wno-odr
6481 @opindex Wodr
6482 Warn about One Definition Rule violations during link-time optimization.
6483 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
6485 @item -Wopenmp-simd
6486 @opindex Wopenm-simd
6487 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
6488 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
6489 option can be used to relax the cost model.
6491 @item -Woverride-init @r{(C and Objective-C only)}
6492 @opindex Woverride-init
6493 @opindex Wno-override-init
6494 @opindex W
6495 @opindex Wextra
6496 @opindex Wno-extra
6497 Warn if an initialized field without side effects is overridden when
6498 using designated initializers (@pxref{Designated Inits, , Designated
6499 Initializers}).
6501 This warning is included in @option{-Wextra}.  To get other
6502 @option{-Wextra} warnings without this one, use @option{-Wextra
6503 -Wno-override-init}.
6505 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
6506 @opindex Woverride-init-side-effects
6507 @opindex Wno-override-init-side-effects
6508 Warn if an initialized field with side effects is overridden when
6509 using designated initializers (@pxref{Designated Inits, , Designated
6510 Initializers}).  This warning is enabled by default.
6512 @item -Wpacked
6513 @opindex Wpacked
6514 @opindex Wno-packed
6515 Warn if a structure is given the packed attribute, but the packed
6516 attribute has no effect on the layout or size of the structure.
6517 Such structures may be mis-aligned for little benefit.  For
6518 instance, in this code, the variable @code{f.x} in @code{struct bar}
6519 is misaligned even though @code{struct bar} does not itself
6520 have the packed attribute:
6522 @smallexample
6523 @group
6524 struct foo @{
6525   int x;
6526   char a, b, c, d;
6527 @} __attribute__((packed));
6528 struct bar @{
6529   char z;
6530   struct foo f;
6532 @end group
6533 @end smallexample
6535 @item -Wpacked-bitfield-compat
6536 @opindex Wpacked-bitfield-compat
6537 @opindex Wno-packed-bitfield-compat
6538 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
6539 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
6540 the change can lead to differences in the structure layout.  GCC
6541 informs you when the offset of such a field has changed in GCC 4.4.
6542 For example there is no longer a 4-bit padding between field @code{a}
6543 and @code{b} in this structure:
6545 @smallexample
6546 struct foo
6548   char a:4;
6549   char b:8;
6550 @} __attribute__ ((packed));
6551 @end smallexample
6553 This warning is enabled by default.  Use
6554 @option{-Wno-packed-bitfield-compat} to disable this warning.
6556 @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)}
6557 @opindex Wpacked-not-aligned
6558 @opindex Wno-packed-not-aligned
6559 Warn if a structure field with explicitly specified alignment in a
6560 packed struct or union is misaligned.  For example, a warning will
6561 be issued on @code{struct S}, like, @code{warning: alignment 1 of
6562 'struct S' is less than 8}, in this code:
6564 @smallexample
6565 @group
6566 struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @};
6567 struct __attribute__ ((packed)) S @{
6568   struct S8 s8;
6570 @end group
6571 @end smallexample
6573 This warning is enabled by @option{-Wall}.
6575 @item -Wpadded
6576 @opindex Wpadded
6577 @opindex Wno-padded
6578 Warn if padding is included in a structure, either to align an element
6579 of the structure or to align the whole structure.  Sometimes when this
6580 happens it is possible to rearrange the fields of the structure to
6581 reduce the padding and so make the structure smaller.
6583 @item -Wredundant-decls
6584 @opindex Wredundant-decls
6585 @opindex Wno-redundant-decls
6586 Warn if anything is declared more than once in the same scope, even in
6587 cases where multiple declaration is valid and changes nothing.
6589 @item -Wrestrict
6590 @opindex Wrestrict
6591 @opindex Wno-restrict
6592 Warn when an argument passed to a restrict-qualified parameter
6593 aliases with another argument.
6595 @item -Wnested-externs @r{(C and Objective-C only)}
6596 @opindex Wnested-externs
6597 @opindex Wno-nested-externs
6598 Warn if an @code{extern} declaration is encountered within a function.
6600 @item -Wno-inherited-variadic-ctor
6601 @opindex Winherited-variadic-ctor
6602 @opindex Wno-inherited-variadic-ctor
6603 Suppress warnings about use of C++11 inheriting constructors when the
6604 base class inherited from has a C variadic constructor; the warning is
6605 on by default because the ellipsis is not inherited.
6607 @item -Winline
6608 @opindex Winline
6609 @opindex Wno-inline
6610 Warn if a function that is declared as inline cannot be inlined.
6611 Even with this option, the compiler does not warn about failures to
6612 inline functions declared in system headers.
6614 The compiler uses a variety of heuristics to determine whether or not
6615 to inline a function.  For example, the compiler takes into account
6616 the size of the function being inlined and the amount of inlining
6617 that has already been done in the current function.  Therefore,
6618 seemingly insignificant changes in the source program can cause the
6619 warnings produced by @option{-Winline} to appear or disappear.
6621 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
6622 @opindex Wno-invalid-offsetof
6623 @opindex Winvalid-offsetof
6624 Suppress warnings from applying the @code{offsetof} macro to a non-POD
6625 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
6626 to a non-standard-layout type is undefined.  In existing C++ implementations,
6627 however, @code{offsetof} typically gives meaningful results.
6628 This flag is for users who are aware that they are
6629 writing nonportable code and who have deliberately chosen to ignore the
6630 warning about it.
6632 The restrictions on @code{offsetof} may be relaxed in a future version
6633 of the C++ standard.
6635 @item -Wint-in-bool-context
6636 @opindex Wint-in-bool-context
6637 @opindex Wno-int-in-bool-context
6638 Warn for suspicious use of integer values where boolean values are expected,
6639 such as conditional expressions (?:) using non-boolean integer constants in
6640 boolean context, like @code{if (a <= b ? 2 : 3)}.  Or left shifting of signed
6641 integers in boolean context, like @code{for (a = 0; 1 << a; a++);}.  Likewise
6642 for all kinds of multiplications regardless of the data type.
6643 This warning is enabled by @option{-Wall}.
6645 @item -Wno-int-to-pointer-cast
6646 @opindex Wno-int-to-pointer-cast
6647 @opindex Wint-to-pointer-cast
6648 Suppress warnings from casts to pointer type of an integer of a
6649 different size. In C++, casting to a pointer type of smaller size is
6650 an error. @option{Wint-to-pointer-cast} is enabled by default.
6653 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
6654 @opindex Wno-pointer-to-int-cast
6655 @opindex Wpointer-to-int-cast
6656 Suppress warnings from casts from a pointer to an integer type of a
6657 different size.
6659 @item -Winvalid-pch
6660 @opindex Winvalid-pch
6661 @opindex Wno-invalid-pch
6662 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
6663 the search path but cannot be used.
6665 @item -Wlong-long
6666 @opindex Wlong-long
6667 @opindex Wno-long-long
6668 Warn if @code{long long} type is used.  This is enabled by either
6669 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
6670 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
6672 @item -Wvariadic-macros
6673 @opindex Wvariadic-macros
6674 @opindex Wno-variadic-macros
6675 Warn if variadic macros are used in ISO C90 mode, or if the GNU
6676 alternate syntax is used in ISO C99 mode.  This is enabled by either
6677 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
6678 messages, use @option{-Wno-variadic-macros}.
6680 @item -Wvarargs
6681 @opindex Wvarargs
6682 @opindex Wno-varargs
6683 Warn upon questionable usage of the macros used to handle variable
6684 arguments like @code{va_start}.  This is default.  To inhibit the
6685 warning messages, use @option{-Wno-varargs}.
6687 @item -Wvector-operation-performance
6688 @opindex Wvector-operation-performance
6689 @opindex Wno-vector-operation-performance
6690 Warn if vector operation is not implemented via SIMD capabilities of the
6691 architecture.  Mainly useful for the performance tuning.
6692 Vector operation can be implemented @code{piecewise}, which means that the
6693 scalar operation is performed on every vector element; 
6694 @code{in parallel}, which means that the vector operation is implemented
6695 using scalars of wider type, which normally is more performance efficient;
6696 and @code{as a single scalar}, which means that vector fits into a
6697 scalar type.
6699 @item -Wno-virtual-move-assign
6700 @opindex Wvirtual-move-assign
6701 @opindex Wno-virtual-move-assign
6702 Suppress warnings about inheriting from a virtual base with a
6703 non-trivial C++11 move assignment operator.  This is dangerous because
6704 if the virtual base is reachable along more than one path, it is
6705 moved multiple times, which can mean both objects end up in the
6706 moved-from state.  If the move assignment operator is written to avoid
6707 moving from a moved-from object, this warning can be disabled.
6709 @item -Wvla
6710 @opindex Wvla
6711 @opindex Wno-vla
6712 Warn if a variable-length array is used in the code.
6713 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
6714 the variable-length array.
6716 @item -Wvla-larger-than=@var{n}
6717 If this option is used, the compiler will warn on uses of
6718 variable-length arrays where the size is either unbounded, or bounded
6719 by an argument that can be larger than @var{n} bytes.  This is similar
6720 to how @option{-Walloca-larger-than=@var{n}} works, but with
6721 variable-length arrays.
6723 Note that GCC may optimize small variable-length arrays of a known
6724 value into plain arrays, so this warning may not get triggered for
6725 such arrays.
6727 This warning is not enabled by @option{-Wall}, and is only active when
6728 @option{-ftree-vrp} is active (default for @option{-O2} and above).
6730 See also @option{-Walloca-larger-than=@var{n}}.
6732 @item -Wvolatile-register-var
6733 @opindex Wvolatile-register-var
6734 @opindex Wno-volatile-register-var
6735 Warn if a register variable is declared volatile.  The volatile
6736 modifier does not inhibit all optimizations that may eliminate reads
6737 and/or writes to register variables.  This warning is enabled by
6738 @option{-Wall}.
6740 @item -Wdisabled-optimization
6741 @opindex Wdisabled-optimization
6742 @opindex Wno-disabled-optimization
6743 Warn if a requested optimization pass is disabled.  This warning does
6744 not generally indicate that there is anything wrong with your code; it
6745 merely indicates that GCC's optimizers are unable to handle the code
6746 effectively.  Often, the problem is that your code is too big or too
6747 complex; GCC refuses to optimize programs when the optimization
6748 itself is likely to take inordinate amounts of time.
6750 @item -Wpointer-sign @r{(C and Objective-C only)}
6751 @opindex Wpointer-sign
6752 @opindex Wno-pointer-sign
6753 Warn for pointer argument passing or assignment with different signedness.
6754 This option is only supported for C and Objective-C@.  It is implied by
6755 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
6756 @option{-Wno-pointer-sign}.
6758 @item -Wstack-protector
6759 @opindex Wstack-protector
6760 @opindex Wno-stack-protector
6761 This option is only active when @option{-fstack-protector} is active.  It
6762 warns about functions that are not protected against stack smashing.
6764 @item -Woverlength-strings
6765 @opindex Woverlength-strings
6766 @opindex Wno-overlength-strings
6767 Warn about string constants that are longer than the ``minimum
6768 maximum'' length specified in the C standard.  Modern compilers
6769 generally allow string constants that are much longer than the
6770 standard's minimum limit, but very portable programs should avoid
6771 using longer strings.
6773 The limit applies @emph{after} string constant concatenation, and does
6774 not count the trailing NUL@.  In C90, the limit was 509 characters; in
6775 C99, it was raised to 4095.  C++98 does not specify a normative
6776 minimum maximum, so we do not diagnose overlength strings in C++@.
6778 This option is implied by @option{-Wpedantic}, and can be disabled with
6779 @option{-Wno-overlength-strings}.
6781 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
6782 @opindex Wunsuffixed-float-constants
6784 Issue a warning for any floating constant that does not have
6785 a suffix.  When used together with @option{-Wsystem-headers} it
6786 warns about such constants in system header files.  This can be useful
6787 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
6788 from the decimal floating-point extension to C99.
6790 @item -Wno-designated-init @r{(C and Objective-C only)}
6791 Suppress warnings when a positional initializer is used to initialize
6792 a structure that has been marked with the @code{designated_init}
6793 attribute.
6795 @item -Whsa
6796 Issue a warning when HSAIL cannot be emitted for the compiled function or
6797 OpenMP construct.
6799 @end table
6801 @node Debugging Options
6802 @section Options for Debugging Your Program
6803 @cindex options, debugging
6804 @cindex debugging information options
6806 To tell GCC to emit extra information for use by a debugger, in almost 
6807 all cases you need only to add @option{-g} to your other options.
6809 GCC allows you to use @option{-g} with
6810 @option{-O}.  The shortcuts taken by optimized code may occasionally
6811 be surprising: some variables you declared may not exist
6812 at all; flow of control may briefly move where you did not expect it;
6813 some statements may not be executed because they compute constant
6814 results or their values are already at hand; some statements may
6815 execute in different places because they have been moved out of loops.
6816 Nevertheless it is possible to debug optimized output.  This makes
6817 it reasonable to use the optimizer for programs that might have bugs.
6819 If you are not using some other optimization option, consider
6820 using @option{-Og} (@pxref{Optimize Options}) with @option{-g}.  
6821 With no @option{-O} option at all, some compiler passes that collect
6822 information useful for debugging do not run at all, so that
6823 @option{-Og} may result in a better debugging experience.
6825 @table @gcctabopt
6826 @item -g
6827 @opindex g
6828 Produce debugging information in the operating system's native format
6829 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
6830 information.
6832 On most systems that use stabs format, @option{-g} enables use of extra
6833 debugging information that only GDB can use; this extra information
6834 makes debugging work better in GDB but probably makes other debuggers
6835 crash or
6836 refuse to read the program.  If you want to control for certain whether
6837 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
6838 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
6840 @item -ggdb
6841 @opindex ggdb
6842 Produce debugging information for use by GDB@.  This means to use the
6843 most expressive format available (DWARF, stabs, or the native format
6844 if neither of those are supported), including GDB extensions if at all
6845 possible.
6847 @item -gdwarf
6848 @itemx -gdwarf-@var{version}
6849 @opindex gdwarf
6850 Produce debugging information in DWARF format (if that is supported).
6851 The value of @var{version} may be either 2, 3, 4 or 5; the default version
6852 for most targets is 4.  DWARF Version 5 is only experimental.
6854 Note that with DWARF Version 2, some ports require and always
6855 use some non-conflicting DWARF 3 extensions in the unwind tables.
6857 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
6858 for maximum benefit.
6860 GCC no longer supports DWARF Version 1, which is substantially
6861 different than Version 2 and later.  For historical reasons, some
6862 other DWARF-related options such as
6863 @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2
6864 in their names, but apply to all currently-supported versions of DWARF.
6866 @item -gstabs
6867 @opindex gstabs
6868 Produce debugging information in stabs format (if that is supported),
6869 without GDB extensions.  This is the format used by DBX on most BSD
6870 systems.  On MIPS, Alpha and System V Release 4 systems this option
6871 produces stabs debugging output that is not understood by DBX or SDB@.
6872 On System V Release 4 systems this option requires the GNU assembler.
6874 @item -gstabs+
6875 @opindex gstabs+
6876 Produce debugging information in stabs format (if that is supported),
6877 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6878 use of these extensions is likely to make other debuggers crash or
6879 refuse to read the program.
6881 @item -gcoff
6882 @opindex gcoff
6883 Produce debugging information in COFF format (if that is supported).
6884 This is the format used by SDB on most System V systems prior to
6885 System V Release 4.
6887 @item -gxcoff
6888 @opindex gxcoff
6889 Produce debugging information in XCOFF format (if that is supported).
6890 This is the format used by the DBX debugger on IBM RS/6000 systems.
6892 @item -gxcoff+
6893 @opindex gxcoff+
6894 Produce debugging information in XCOFF format (if that is supported),
6895 using GNU extensions understood only by the GNU debugger (GDB)@.  The
6896 use of these extensions is likely to make other debuggers crash or
6897 refuse to read the program, and may cause assemblers other than the GNU
6898 assembler (GAS) to fail with an error.
6900 @item -gvms
6901 @opindex gvms
6902 Produce debugging information in Alpha/VMS debug format (if that is
6903 supported).  This is the format used by DEBUG on Alpha/VMS systems.
6905 @item -g@var{level}
6906 @itemx -ggdb@var{level}
6907 @itemx -gstabs@var{level}
6908 @itemx -gcoff@var{level}
6909 @itemx -gxcoff@var{level}
6910 @itemx -gvms@var{level}
6911 Request debugging information and also use @var{level} to specify how
6912 much information.  The default level is 2.
6914 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
6915 @option{-g}.
6917 Level 1 produces minimal information, enough for making backtraces in
6918 parts of the program that you don't plan to debug.  This includes
6919 descriptions of functions and external variables, and line number
6920 tables, but no information about local variables.
6922 Level 3 includes extra information, such as all the macro definitions
6923 present in the program.  Some debuggers support macro expansion when
6924 you use @option{-g3}.
6926 @option{-gdwarf} does not accept a concatenated debug level, to avoid
6927 confusion with @option{-gdwarf-@var{level}}.
6928 Instead use an additional @option{-g@var{level}} option to change the
6929 debug level for DWARF.
6931 @item -feliminate-unused-debug-symbols
6932 @opindex feliminate-unused-debug-symbols
6933 Produce debugging information in stabs format (if that is supported),
6934 for only symbols that are actually used.
6936 @item -femit-class-debug-always
6937 @opindex femit-class-debug-always
6938 Instead of emitting debugging information for a C++ class in only one
6939 object file, emit it in all object files using the class.  This option
6940 should be used only with debuggers that are unable to handle the way GCC
6941 normally emits debugging information for classes because using this
6942 option increases the size of debugging information by as much as a
6943 factor of two.
6945 @item -fno-merge-debug-strings
6946 @opindex fmerge-debug-strings
6947 @opindex fno-merge-debug-strings
6948 Direct the linker to not merge together strings in the debugging
6949 information that are identical in different object files.  Merging is
6950 not supported by all assemblers or linkers.  Merging decreases the size
6951 of the debug information in the output file at the cost of increasing
6952 link processing time.  Merging is enabled by default.
6954 @item -fdebug-prefix-map=@var{old}=@var{new}
6955 @opindex fdebug-prefix-map
6956 When compiling files in directory @file{@var{old}}, record debugging
6957 information describing them as in @file{@var{new}} instead.
6959 @item -fvar-tracking
6960 @opindex fvar-tracking
6961 Run variable tracking pass.  It computes where variables are stored at each
6962 position in code.  Better debugging information is then generated
6963 (if the debugging information format supports this information).
6965 It is enabled by default when compiling with optimization (@option{-Os},
6966 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6967 the debug info format supports it.
6969 @item -fvar-tracking-assignments
6970 @opindex fvar-tracking-assignments
6971 @opindex fno-var-tracking-assignments
6972 Annotate assignments to user variables early in the compilation and
6973 attempt to carry the annotations over throughout the compilation all the
6974 way to the end, in an attempt to improve debug information while
6975 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6977 It can be enabled even if var-tracking is disabled, in which case
6978 annotations are created and maintained, but discarded at the end.
6979 By default, this flag is enabled together with @option{-fvar-tracking},
6980 except when selective scheduling is enabled.
6982 @item -gsplit-dwarf
6983 @opindex gsplit-dwarf
6984 Separate as much DWARF debugging information as possible into a
6985 separate output file with the extension @file{.dwo}.  This option allows
6986 the build system to avoid linking files with debug information.  To
6987 be useful, this option requires a debugger capable of reading @file{.dwo}
6988 files.
6990 @item -gpubnames
6991 @opindex gpubnames
6992 Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections.
6994 @item -ggnu-pubnames
6995 @opindex ggnu-pubnames
6996 Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format
6997 suitable for conversion into a GDB@ index.  This option is only useful
6998 with a linker that can produce GDB@ index version 7.
7000 @item -fdebug-types-section
7001 @opindex fdebug-types-section
7002 @opindex fno-debug-types-section
7003 When using DWARF Version 4 or higher, type DIEs can be put into
7004 their own @code{.debug_types} section instead of making them part of the
7005 @code{.debug_info} section.  It is more efficient to put them in a separate
7006 comdat sections since the linker can then remove duplicates.
7007 But not all DWARF consumers support @code{.debug_types} sections yet
7008 and on some objects @code{.debug_types} produces larger instead of smaller
7009 debugging information.
7011 @item -grecord-gcc-switches
7012 @item -gno-record-gcc-switches
7013 @opindex grecord-gcc-switches
7014 @opindex gno-record-gcc-switches
7015 This switch causes the command-line options used to invoke the
7016 compiler that may affect code generation to be appended to the
7017 DW_AT_producer attribute in DWARF debugging information.  The options
7018 are concatenated with spaces separating them from each other and from
7019 the compiler version.  
7020 It is enabled by default.
7021 See also @option{-frecord-gcc-switches} for another
7022 way of storing compiler options into the object file.  
7024 @item -gstrict-dwarf
7025 @opindex gstrict-dwarf
7026 Disallow using extensions of later DWARF standard version than selected
7027 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
7028 DWARF extensions from later standard versions is allowed.
7030 @item -gno-strict-dwarf
7031 @opindex gno-strict-dwarf
7032 Allow using extensions of later DWARF standard version than selected with
7033 @option{-gdwarf-@var{version}}.
7035 @item -gcolumn-info
7036 @item -gno-column-info
7037 @opindex gcolumn-info
7038 @opindex gno-column-info
7039 Emit location column information into DWARF debugging information, rather
7040 than just file and line.
7041 This option is disabled by default.
7043 @item -gz@r{[}=@var{type}@r{]}
7044 @opindex gz
7045 Produce compressed debug sections in DWARF format, if that is supported.
7046 If @var{type} is not given, the default type depends on the capabilities
7047 of the assembler and linker used.  @var{type} may be one of
7048 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
7049 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
7050 compression in traditional GNU format).  If the linker doesn't support
7051 writing compressed debug sections, the option is rejected.  Otherwise,
7052 if the assembler does not support them, @option{-gz} is silently ignored
7053 when producing object files.
7055 @item -femit-struct-debug-baseonly
7056 @opindex femit-struct-debug-baseonly
7057 Emit debug information for struct-like types
7058 only when the base name of the compilation source file
7059 matches the base name of file in which the struct is defined.
7061 This option substantially reduces the size of debugging information,
7062 but at significant potential loss in type information to the debugger.
7063 See @option{-femit-struct-debug-reduced} for a less aggressive option.
7064 See @option{-femit-struct-debug-detailed} for more detailed control.
7066 This option works only with DWARF debug output.
7068 @item -femit-struct-debug-reduced
7069 @opindex femit-struct-debug-reduced
7070 Emit debug information for struct-like types
7071 only when the base name of the compilation source file
7072 matches the base name of file in which the type is defined,
7073 unless the struct is a template or defined in a system header.
7075 This option significantly reduces the size of debugging information,
7076 with some potential loss in type information to the debugger.
7077 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
7078 See @option{-femit-struct-debug-detailed} for more detailed control.
7080 This option works only with DWARF debug output.
7082 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
7083 @opindex femit-struct-debug-detailed
7084 Specify the struct-like types
7085 for which the compiler generates debug information.
7086 The intent is to reduce duplicate struct debug information
7087 between different object files within the same program.
7089 This option is a detailed version of
7090 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
7091 which serves for most needs.
7093 A specification has the syntax@*
7094 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
7096 The optional first word limits the specification to
7097 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
7098 A struct type is used directly when it is the type of a variable, member.
7099 Indirect uses arise through pointers to structs.
7100 That is, when use of an incomplete struct is valid, the use is indirect.
7101 An example is
7102 @samp{struct one direct; struct two * indirect;}.
7104 The optional second word limits the specification to
7105 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
7106 Generic structs are a bit complicated to explain.
7107 For C++, these are non-explicit specializations of template classes,
7108 or non-template classes within the above.
7109 Other programming languages have generics,
7110 but @option{-femit-struct-debug-detailed} does not yet implement them.
7112 The third word specifies the source files for those
7113 structs for which the compiler should emit debug information.
7114 The values @samp{none} and @samp{any} have the normal meaning.
7115 The value @samp{base} means that
7116 the base of name of the file in which the type declaration appears
7117 must match the base of the name of the main compilation file.
7118 In practice, this means that when compiling @file{foo.c}, debug information
7119 is generated for types declared in that file and @file{foo.h},
7120 but not other header files.
7121 The value @samp{sys} means those types satisfying @samp{base}
7122 or declared in system or compiler headers.
7124 You may need to experiment to determine the best settings for your application.
7126 The default is @option{-femit-struct-debug-detailed=all}.
7128 This option works only with DWARF debug output.
7130 @item -fno-dwarf2-cfi-asm
7131 @opindex fdwarf2-cfi-asm
7132 @opindex fno-dwarf2-cfi-asm
7133 Emit DWARF unwind info as compiler generated @code{.eh_frame} section
7134 instead of using GAS @code{.cfi_*} directives.
7136 @item -fno-eliminate-unused-debug-types
7137 @opindex feliminate-unused-debug-types
7138 @opindex fno-eliminate-unused-debug-types
7139 Normally, when producing DWARF output, GCC avoids producing debug symbol 
7140 output for types that are nowhere used in the source file being compiled.
7141 Sometimes it is useful to have GCC emit debugging
7142 information for all types declared in a compilation
7143 unit, regardless of whether or not they are actually used
7144 in that compilation unit, for example 
7145 if, in the debugger, you want to cast a value to a type that is
7146 not actually used in your program (but is declared).  More often,
7147 however, this results in a significant amount of wasted space.
7148 @end table
7150 @node Optimize Options
7151 @section Options That Control Optimization
7152 @cindex optimize options
7153 @cindex options, optimization
7155 These options control various sorts of optimizations.
7157 Without any optimization option, the compiler's goal is to reduce the
7158 cost of compilation and to make debugging produce the expected
7159 results.  Statements are independent: if you stop the program with a
7160 breakpoint between statements, you can then assign a new value to any
7161 variable or change the program counter to any other statement in the
7162 function and get exactly the results you expect from the source
7163 code.
7165 Turning on optimization flags makes the compiler attempt to improve
7166 the performance and/or code size at the expense of compilation time
7167 and possibly the ability to debug the program.
7169 The compiler performs optimization based on the knowledge it has of the
7170 program.  Compiling multiple files at once to a single output file mode allows
7171 the compiler to use information gained from all of the files when compiling
7172 each of them.
7174 Not all optimizations are controlled directly by a flag.  Only
7175 optimizations that have a flag are listed in this section.
7177 Most optimizations are only enabled if an @option{-O} level is set on
7178 the command line.  Otherwise they are disabled, even if individual
7179 optimization flags are specified.
7181 Depending on the target and how GCC was configured, a slightly different
7182 set of optimizations may be enabled at each @option{-O} level than
7183 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7184 to find out the exact set of optimizations that are enabled at each level.
7185 @xref{Overall Options}, for examples.
7187 @table @gcctabopt
7188 @item -O
7189 @itemx -O1
7190 @opindex O
7191 @opindex O1
7192 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7193 more memory for a large function.
7195 With @option{-O}, the compiler tries to reduce code size and execution
7196 time, without performing any optimizations that take a great deal of
7197 compilation time.
7199 @option{-O} turns on the following optimization flags:
7200 @gccoptlist{
7201 -fauto-inc-dec @gol
7202 -fbranch-count-reg @gol
7203 -fcombine-stack-adjustments @gol
7204 -fcompare-elim @gol
7205 -fcprop-registers @gol
7206 -fdce @gol
7207 -fdefer-pop @gol
7208 -fdelayed-branch @gol
7209 -fdse @gol
7210 -fforward-propagate @gol
7211 -fguess-branch-probability @gol
7212 -fif-conversion2 @gol
7213 -fif-conversion @gol
7214 -finline-functions-called-once @gol
7215 -fipa-pure-const @gol
7216 -fipa-profile @gol
7217 -fipa-reference @gol
7218 -fmerge-constants @gol
7219 -fmove-loop-invariants @gol
7220 -freorder-blocks @gol
7221 -fshrink-wrap @gol
7222 -fshrink-wrap-separate @gol
7223 -fsplit-wide-types @gol
7224 -fssa-backprop @gol
7225 -fssa-phiopt @gol
7226 -ftree-bit-ccp @gol
7227 -ftree-ccp @gol
7228 -ftree-ch @gol
7229 -ftree-coalesce-vars @gol
7230 -ftree-copy-prop @gol
7231 -ftree-dce @gol
7232 -ftree-dominator-opts @gol
7233 -ftree-dse @gol
7234 -ftree-forwprop @gol
7235 -ftree-fre @gol
7236 -ftree-phiprop @gol
7237 -ftree-sink @gol
7238 -ftree-slsr @gol
7239 -ftree-sra @gol
7240 -ftree-pta @gol
7241 -ftree-ter @gol
7242 -funit-at-a-time}
7244 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7245 where doing so does not interfere with debugging.
7247 @item -O2
7248 @opindex O2
7249 Optimize even more.  GCC performs nearly all supported optimizations
7250 that do not involve a space-speed tradeoff.
7251 As compared to @option{-O}, this option increases both compilation time
7252 and the performance of the generated code.
7254 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7255 also turns on the following optimization flags:
7256 @gccoptlist{-fthread-jumps @gol
7257 -falign-functions  -falign-jumps @gol
7258 -falign-loops  -falign-labels @gol
7259 -fcaller-saves @gol
7260 -fcrossjumping @gol
7261 -fcse-follow-jumps  -fcse-skip-blocks @gol
7262 -fdelete-null-pointer-checks @gol
7263 -fdevirtualize -fdevirtualize-speculatively @gol
7264 -fexpensive-optimizations @gol
7265 -fgcse  -fgcse-lm  @gol
7266 -fhoist-adjacent-loads @gol
7267 -finline-small-functions @gol
7268 -findirect-inlining @gol
7269 -fipa-cp @gol
7270 -fipa-bit-cp @gol
7271 -fipa-vrp @gol
7272 -fipa-sra @gol
7273 -fipa-icf @gol
7274 -fisolate-erroneous-paths-dereference @gol
7275 -flra-remat @gol
7276 -foptimize-sibling-calls @gol
7277 -foptimize-strlen @gol
7278 -fpartial-inlining @gol
7279 -fpeephole2 @gol
7280 -freorder-blocks-algorithm=stc @gol
7281 -freorder-blocks-and-partition -freorder-functions @gol
7282 -frerun-cse-after-loop  @gol
7283 -fsched-interblock  -fsched-spec @gol
7284 -fschedule-insns  -fschedule-insns2 @gol
7285 -fstore-merging @gol
7286 -fstrict-aliasing @gol
7287 -ftree-builtin-call-dce @gol
7288 -ftree-switch-conversion -ftree-tail-merge @gol
7289 -fcode-hoisting @gol
7290 -ftree-pre @gol
7291 -ftree-vrp @gol
7292 -fipa-ra}
7294 Please note the warning under @option{-fgcse} about
7295 invoking @option{-O2} on programs that use computed gotos.
7297 @item -O3
7298 @opindex O3
7299 Optimize yet more.  @option{-O3} turns on all optimizations specified
7300 by @option{-O2} and also turns on the following optimization flags:
7301 @gccoptlist{-finline-functions @gol
7302 -funswitch-loops @gol
7303 -fpredictive-commoning @gol
7304 -fgcse-after-reload @gol
7305 -ftree-loop-vectorize @gol
7306 -ftree-loop-distribution @gol
7307 -ftree-loop-distribute-patterns @gol
7308 -fsplit-paths @gol
7309 -ftree-slp-vectorize @gol
7310 -fvect-cost-model @gol
7311 -ftree-partial-pre @gol
7312 -fpeel-loops @gol
7313 -fipa-cp-clone}
7315 @item -O0
7316 @opindex O0
7317 Reduce compilation time and make debugging produce the expected
7318 results.  This is the default.
7320 @item -Os
7321 @opindex Os
7322 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7323 do not typically increase code size.  It also performs further
7324 optimizations designed to reduce code size.
7326 @option{-Os} disables the following optimization flags:
7327 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7328 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7329 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7331 @item -Ofast
7332 @opindex Ofast
7333 Disregard strict standards compliance.  @option{-Ofast} enables all
7334 @option{-O3} optimizations.  It also enables optimizations that are not
7335 valid for all standard-compliant programs.
7336 It turns on @option{-ffast-math} and the Fortran-specific
7337 @option{-fstack-arrays}, unless @option{-fmax-stack-var-size} is
7338 specified, and @option{-fno-protect-parens}.
7340 @item -Og
7341 @opindex Og
7342 Optimize debugging experience.  @option{-Og} enables optimizations
7343 that do not interfere with debugging. It should be the optimization
7344 level of choice for the standard edit-compile-debug cycle, offering
7345 a reasonable level of optimization while maintaining fast compilation
7346 and a good debugging experience.
7347 @end table
7349 If you use multiple @option{-O} options, with or without level numbers,
7350 the last such option is the one that is effective.
7352 Options of the form @option{-f@var{flag}} specify machine-independent
7353 flags.  Most flags have both positive and negative forms; the negative
7354 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7355 below, only one of the forms is listed---the one you typically 
7356 use.  You can figure out the other form by either removing @samp{no-}
7357 or adding it.
7359 The following options control specific optimizations.  They are either
7360 activated by @option{-O} options or are related to ones that are.  You
7361 can use the following flags in the rare cases when ``fine-tuning'' of
7362 optimizations to be performed is desired.
7364 @table @gcctabopt
7365 @item -fno-defer-pop
7366 @opindex fno-defer-pop
7367 Always pop the arguments to each function call as soon as that function
7368 returns.  For machines that must pop arguments after a function call,
7369 the compiler normally lets arguments accumulate on the stack for several
7370 function calls and pops them all at once.
7372 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7374 @item -fforward-propagate
7375 @opindex fforward-propagate
7376 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7377 instructions and checks if the result can be simplified.  If loop unrolling
7378 is active, two passes are performed and the second is scheduled after
7379 loop unrolling.
7381 This option is enabled by default at optimization levels @option{-O},
7382 @option{-O2}, @option{-O3}, @option{-Os}.
7384 @item -ffp-contract=@var{style}
7385 @opindex ffp-contract
7386 @option{-ffp-contract=off} disables floating-point expression contraction.
7387 @option{-ffp-contract=fast} enables floating-point expression contraction
7388 such as forming of fused multiply-add operations if the target has
7389 native support for them.
7390 @option{-ffp-contract=on} enables floating-point expression contraction
7391 if allowed by the language standard.  This is currently not implemented
7392 and treated equal to @option{-ffp-contract=off}.
7394 The default is @option{-ffp-contract=fast}.
7396 @item -fomit-frame-pointer
7397 @opindex fomit-frame-pointer
7398 Don't keep the frame pointer in a register for functions that
7399 don't need one.  This avoids the instructions to save, set up and
7400 restore frame pointers; it also makes an extra register available
7401 in many functions.  @strong{It also makes debugging impossible on
7402 some machines.}
7404 On some machines, such as the VAX, this flag has no effect, because
7405 the standard calling sequence automatically handles the frame pointer
7406 and nothing is saved by pretending it doesn't exist.  The
7407 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7408 whether a target machine supports this flag.  @xref{Registers,,Register
7409 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7411 The default setting (when not optimizing for
7412 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7413 @option{-fomit-frame-pointer}.  You can configure GCC with the
7414 @option{--enable-frame-pointer} configure option to change the default.
7416 Note that @option{-fno-omit-frame-pointer} doesn't force a new stack
7417 frame for all functions if it isn't otherwise needed, and hence doesn't
7418 guarantee a new frame pointer for all functions.
7420 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7422 @item -foptimize-sibling-calls
7423 @opindex foptimize-sibling-calls
7424 Optimize sibling and tail recursive calls.
7426 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7428 @item -foptimize-strlen
7429 @opindex foptimize-strlen
7430 Optimize various standard C string functions (e.g. @code{strlen},
7431 @code{strchr} or @code{strcpy}) and
7432 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7434 Enabled at levels @option{-O2}, @option{-O3}.
7436 @item -fno-inline
7437 @opindex fno-inline
7438 Do not expand any functions inline apart from those marked with
7439 the @code{always_inline} attribute.  This is the default when not
7440 optimizing.
7442 Single functions can be exempted from inlining by marking them
7443 with the @code{noinline} attribute.
7445 @item -finline-small-functions
7446 @opindex finline-small-functions
7447 Integrate functions into their callers when their body is smaller than expected
7448 function call code (so overall size of program gets smaller).  The compiler
7449 heuristically decides which functions are simple enough to be worth integrating
7450 in this way.  This inlining applies to all functions, even those not declared
7451 inline.
7453 Enabled at level @option{-O2}.
7455 @item -findirect-inlining
7456 @opindex findirect-inlining
7457 Inline also indirect calls that are discovered to be known at compile
7458 time thanks to previous inlining.  This option has any effect only
7459 when inlining itself is turned on by the @option{-finline-functions}
7460 or @option{-finline-small-functions} options.
7462 Enabled at level @option{-O2}.
7464 @item -finline-functions
7465 @opindex finline-functions
7466 Consider all functions for inlining, even if they are not declared inline.
7467 The compiler heuristically decides which functions are worth integrating
7468 in this way.
7470 If all calls to a given function are integrated, and the function is
7471 declared @code{static}, then the function is normally not output as
7472 assembler code in its own right.
7474 Enabled at level @option{-O3}.
7476 @item -finline-functions-called-once
7477 @opindex finline-functions-called-once
7478 Consider all @code{static} functions called once for inlining into their
7479 caller even if they are not marked @code{inline}.  If a call to a given
7480 function is integrated, then the function is not output as assembler code
7481 in its own right.
7483 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7485 @item -fearly-inlining
7486 @opindex fearly-inlining
7487 Inline functions marked by @code{always_inline} and functions whose body seems
7488 smaller than the function call overhead early before doing
7489 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7490 makes profiling significantly cheaper and usually inlining faster on programs
7491 having large chains of nested wrapper functions.
7493 Enabled by default.
7495 @item -fipa-sra
7496 @opindex fipa-sra
7497 Perform interprocedural scalar replacement of aggregates, removal of
7498 unused parameters and replacement of parameters passed by reference
7499 by parameters passed by value.
7501 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7503 @item -finline-limit=@var{n}
7504 @opindex finline-limit
7505 By default, GCC limits the size of functions that can be inlined.  This flag
7506 allows coarse control of this limit.  @var{n} is the size of functions that
7507 can be inlined in number of pseudo instructions.
7509 Inlining is actually controlled by a number of parameters, which may be
7510 specified individually by using @option{--param @var{name}=@var{value}}.
7511 The @option{-finline-limit=@var{n}} option sets some of these parameters
7512 as follows:
7514 @table @gcctabopt
7515 @item max-inline-insns-single
7516 is set to @var{n}/2.
7517 @item max-inline-insns-auto
7518 is set to @var{n}/2.
7519 @end table
7521 See below for a documentation of the individual
7522 parameters controlling inlining and for the defaults of these parameters.
7524 @emph{Note:} there may be no value to @option{-finline-limit} that results
7525 in default behavior.
7527 @emph{Note:} pseudo instruction represents, in this particular context, an
7528 abstract measurement of function's size.  In no way does it represent a count
7529 of assembly instructions and as such its exact meaning might change from one
7530 release to an another.
7532 @item -fno-keep-inline-dllexport
7533 @opindex fno-keep-inline-dllexport
7534 This is a more fine-grained version of @option{-fkeep-inline-functions},
7535 which applies only to functions that are declared using the @code{dllexport}
7536 attribute or declspec.  @xref{Function Attributes,,Declaring Attributes of
7537 Functions}.
7539 @item -fkeep-inline-functions
7540 @opindex fkeep-inline-functions
7541 In C, emit @code{static} functions that are declared @code{inline}
7542 into the object file, even if the function has been inlined into all
7543 of its callers.  This switch does not affect functions using the
7544 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7545 inline functions into the object file.
7547 @item -fkeep-static-functions
7548 @opindex fkeep-static-functions
7549 Emit @code{static} functions into the object file, even if the function
7550 is never used.
7552 @item -fkeep-static-consts
7553 @opindex fkeep-static-consts
7554 Emit variables declared @code{static const} when optimization isn't turned
7555 on, even if the variables aren't referenced.
7557 GCC enables this option by default.  If you want to force the compiler to
7558 check if a variable is referenced, regardless of whether or not
7559 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7561 @item -fmerge-constants
7562 @opindex fmerge-constants
7563 Attempt to merge identical constants (string constants and floating-point
7564 constants) across compilation units.
7566 This option is the default for optimized compilation if the assembler and
7567 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7568 behavior.
7570 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7572 @item -fmerge-all-constants
7573 @opindex fmerge-all-constants
7574 Attempt to merge identical constants and identical variables.
7576 This option implies @option{-fmerge-constants}.  In addition to
7577 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7578 arrays or initialized constant variables with integral or floating-point
7579 types.  Languages like C or C++ require each variable, including multiple
7580 instances of the same variable in recursive calls, to have distinct locations,
7581 so using this option results in non-conforming
7582 behavior.
7584 @item -fmodulo-sched
7585 @opindex fmodulo-sched
7586 Perform swing modulo scheduling immediately before the first scheduling
7587 pass.  This pass looks at innermost loops and reorders their
7588 instructions by overlapping different iterations.
7590 @item -fmodulo-sched-allow-regmoves
7591 @opindex fmodulo-sched-allow-regmoves
7592 Perform more aggressive SMS-based modulo scheduling with register moves
7593 allowed.  By setting this flag certain anti-dependences edges are
7594 deleted, which triggers the generation of reg-moves based on the
7595 life-range analysis.  This option is effective only with
7596 @option{-fmodulo-sched} enabled.
7598 @item -fno-branch-count-reg
7599 @opindex fno-branch-count-reg
7600 Avoid running a pass scanning for opportunities to use ``decrement and
7601 branch'' instructions on a count register instead of generating sequences
7602 of instructions that decrement a register, compare it against zero, and
7603 then branch based upon the result.  This option is only meaningful on
7604 architectures that support such instructions, which include x86, PowerPC,
7605 IA-64 and S/390.  Note that the @option{-fno-branch-count-reg} option
7606 doesn't remove the decrement and branch instructions from the generated
7607 instruction stream introduced by other optimization passes.
7609 Enabled by default at @option{-O1} and higher.
7611 The default is @option{-fbranch-count-reg}.
7613 @item -fno-function-cse
7614 @opindex fno-function-cse
7615 Do not put function addresses in registers; make each instruction that
7616 calls a constant function contain the function's address explicitly.
7618 This option results in less efficient code, but some strange hacks
7619 that alter the assembler output may be confused by the optimizations
7620 performed when this option is not used.
7622 The default is @option{-ffunction-cse}
7624 @item -fno-zero-initialized-in-bss
7625 @opindex fno-zero-initialized-in-bss
7626 If the target supports a BSS section, GCC by default puts variables that
7627 are initialized to zero into BSS@.  This can save space in the resulting
7628 code.
7630 This option turns off this behavior because some programs explicitly
7631 rely on variables going to the data section---e.g., so that the
7632 resulting executable can find the beginning of that section and/or make
7633 assumptions based on that.
7635 The default is @option{-fzero-initialized-in-bss}.
7637 @item -fthread-jumps
7638 @opindex fthread-jumps
7639 Perform optimizations that check to see if a jump branches to a
7640 location where another comparison subsumed by the first is found.  If
7641 so, the first branch is redirected to either the destination of the
7642 second branch or a point immediately following it, depending on whether
7643 the condition is known to be true or false.
7645 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7647 @item -fsplit-wide-types
7648 @opindex fsplit-wide-types
7649 When using a type that occupies multiple registers, such as @code{long
7650 long} on a 32-bit system, split the registers apart and allocate them
7651 independently.  This normally generates better code for those types,
7652 but may make debugging more difficult.
7654 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7655 @option{-Os}.
7657 @item -fcse-follow-jumps
7658 @opindex fcse-follow-jumps
7659 In common subexpression elimination (CSE), scan through jump instructions
7660 when the target of the jump is not reached by any other path.  For
7661 example, when CSE encounters an @code{if} statement with an
7662 @code{else} clause, CSE follows the jump when the condition
7663 tested is false.
7665 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7667 @item -fcse-skip-blocks
7668 @opindex fcse-skip-blocks
7669 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7670 follow jumps that conditionally skip over blocks.  When CSE
7671 encounters a simple @code{if} statement with no else clause,
7672 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7673 body of the @code{if}.
7675 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7677 @item -frerun-cse-after-loop
7678 @opindex frerun-cse-after-loop
7679 Re-run common subexpression elimination after loop optimizations are
7680 performed.
7682 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7684 @item -fgcse
7685 @opindex fgcse
7686 Perform a global common subexpression elimination pass.
7687 This pass also performs global constant and copy propagation.
7689 @emph{Note:} When compiling a program using computed gotos, a GCC
7690 extension, you may get better run-time performance if you disable
7691 the global common subexpression elimination pass by adding
7692 @option{-fno-gcse} to the command line.
7694 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7696 @item -fgcse-lm
7697 @opindex fgcse-lm
7698 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7699 attempts to move loads that are only killed by stores into themselves.  This
7700 allows a loop containing a load/store sequence to be changed to a load outside
7701 the loop, and a copy/store within the loop.
7703 Enabled by default when @option{-fgcse} is enabled.
7705 @item -fgcse-sm
7706 @opindex fgcse-sm
7707 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7708 global common subexpression elimination.  This pass attempts to move
7709 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7710 loops containing a load/store sequence can be changed to a load before
7711 the loop and a store after the loop.
7713 Not enabled at any optimization level.
7715 @item -fgcse-las
7716 @opindex fgcse-las
7717 When @option{-fgcse-las} is enabled, the global common subexpression
7718 elimination pass eliminates redundant loads that come after stores to the
7719 same memory location (both partial and full redundancies).
7721 Not enabled at any optimization level.
7723 @item -fgcse-after-reload
7724 @opindex fgcse-after-reload
7725 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7726 pass is performed after reload.  The purpose of this pass is to clean up
7727 redundant spilling.
7729 @item -faggressive-loop-optimizations
7730 @opindex faggressive-loop-optimizations
7731 This option tells the loop optimizer to use language constraints to
7732 derive bounds for the number of iterations of a loop.  This assumes that
7733 loop code does not invoke undefined behavior by for example causing signed
7734 integer overflows or out-of-bound array accesses.  The bounds for the
7735 number of iterations of a loop are used to guide loop unrolling and peeling
7736 and loop exit test optimizations.
7737 This option is enabled by default.
7739 @item -funconstrained-commons
7740 @opindex funconstrained-commons
7741 This option tells the compiler that variables declared in common blocks
7742 (e.g. Fortran) may later be overridden with longer trailing arrays. This
7743 prevents certain optimizations that depend on knowing the array bounds.
7745 @item -fcrossjumping
7746 @opindex fcrossjumping
7747 Perform cross-jumping transformation.
7748 This transformation unifies equivalent code and saves code size.  The
7749 resulting code may or may not perform better than without cross-jumping.
7751 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7753 @item -fauto-inc-dec
7754 @opindex fauto-inc-dec
7755 Combine increments or decrements of addresses with memory accesses.
7756 This pass is always skipped on architectures that do not have
7757 instructions to support this.  Enabled by default at @option{-O} and
7758 higher on architectures that support this.
7760 @item -fdce
7761 @opindex fdce
7762 Perform dead code elimination (DCE) on RTL@.
7763 Enabled by default at @option{-O} and higher.
7765 @item -fdse
7766 @opindex fdse
7767 Perform dead store elimination (DSE) on RTL@.
7768 Enabled by default at @option{-O} and higher.
7770 @item -fif-conversion
7771 @opindex fif-conversion
7772 Attempt to transform conditional jumps into branch-less equivalents.  This
7773 includes use of conditional moves, min, max, set flags and abs instructions, and
7774 some tricks doable by standard arithmetics.  The use of conditional execution
7775 on chips where it is available is controlled by @option{-fif-conversion2}.
7777 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7779 @item -fif-conversion2
7780 @opindex fif-conversion2
7781 Use conditional execution (where available) to transform conditional jumps into
7782 branch-less equivalents.
7784 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7786 @item -fdeclone-ctor-dtor
7787 @opindex fdeclone-ctor-dtor
7788 The C++ ABI requires multiple entry points for constructors and
7789 destructors: one for a base subobject, one for a complete object, and
7790 one for a virtual destructor that calls operator delete afterwards.
7791 For a hierarchy with virtual bases, the base and complete variants are
7792 clones, which means two copies of the function.  With this option, the
7793 base and complete variants are changed to be thunks that call a common
7794 implementation.
7796 Enabled by @option{-Os}.
7798 @item -fdelete-null-pointer-checks
7799 @opindex fdelete-null-pointer-checks
7800 Assume that programs cannot safely dereference null pointers, and that
7801 no code or data element resides at address zero.
7802 This option enables simple constant
7803 folding optimizations at all optimization levels.  In addition, other
7804 optimization passes in GCC use this flag to control global dataflow
7805 analyses that eliminate useless checks for null pointers; these assume
7806 that a memory access to address zero always results in a trap, so
7807 that if a pointer is checked after it has already been dereferenced,
7808 it cannot be null.
7810 Note however that in some environments this assumption is not true.
7811 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7812 for programs that depend on that behavior.
7814 This option is enabled by default on most targets.  On Nios II ELF, it
7815 defaults to off.  On AVR and CR16, this option is completely disabled.  
7817 Passes that use the dataflow information
7818 are enabled independently at different optimization levels.
7820 @item -fdevirtualize
7821 @opindex fdevirtualize
7822 Attempt to convert calls to virtual functions to direct calls.  This
7823 is done both within a procedure and interprocedurally as part of
7824 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7825 propagation (@option{-fipa-cp}).
7826 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7828 @item -fdevirtualize-speculatively
7829 @opindex fdevirtualize-speculatively
7830 Attempt to convert calls to virtual functions to speculative direct calls.
7831 Based on the analysis of the type inheritance graph, determine for a given call
7832 the set of likely targets. If the set is small, preferably of size 1, change
7833 the call into a conditional deciding between direct and indirect calls.  The
7834 speculative calls enable more optimizations, such as inlining.  When they seem
7835 useless after further optimization, they are converted back into original form.
7837 @item -fdevirtualize-at-ltrans
7838 @opindex fdevirtualize-at-ltrans
7839 Stream extra information needed for aggressive devirtualization when running
7840 the link-time optimizer in local transformation mode.  
7841 This option enables more devirtualization but
7842 significantly increases the size of streamed data. For this reason it is
7843 disabled by default.
7845 @item -fexpensive-optimizations
7846 @opindex fexpensive-optimizations
7847 Perform a number of minor optimizations that are relatively expensive.
7849 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7851 @item -free
7852 @opindex free
7853 Attempt to remove redundant extension instructions.  This is especially
7854 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7855 registers after writing to their lower 32-bit half.
7857 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7858 @option{-O3}, @option{-Os}.
7860 @item -fno-lifetime-dse
7861 @opindex fno-lifetime-dse
7862 In C++ the value of an object is only affected by changes within its
7863 lifetime: when the constructor begins, the object has an indeterminate
7864 value, and any changes during the lifetime of the object are dead when
7865 the object is destroyed.  Normally dead store elimination will take
7866 advantage of this; if your code relies on the value of the object
7867 storage persisting beyond the lifetime of the object, you can use this
7868 flag to disable this optimization.  To preserve stores before the
7869 constructor starts (e.g. because your operator new clears the object
7870 storage) but still treat the object as dead after the destructor you,
7871 can use @option{-flifetime-dse=1}.  The default behavior can be
7872 explicitly selected with @option{-flifetime-dse=2}.
7873 @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}.
7875 @item -flive-range-shrinkage
7876 @opindex flive-range-shrinkage
7877 Attempt to decrease register pressure through register live range
7878 shrinkage.  This is helpful for fast processors with small or moderate
7879 size register sets.
7881 @item -fira-algorithm=@var{algorithm}
7882 @opindex fira-algorithm
7883 Use the specified coloring algorithm for the integrated register
7884 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7885 specifies Chow's priority coloring, or @samp{CB}, which specifies
7886 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7887 for all architectures, but for those targets that do support it, it is
7888 the default because it generates better code.
7890 @item -fira-region=@var{region}
7891 @opindex fira-region
7892 Use specified regions for the integrated register allocator.  The
7893 @var{region} argument should be one of the following:
7895 @table @samp
7897 @item all
7898 Use all loops as register allocation regions.
7899 This can give the best results for machines with a small and/or
7900 irregular register set.
7902 @item mixed
7903 Use all loops except for loops with small register pressure 
7904 as the regions.  This value usually gives
7905 the best results in most cases and for most architectures,
7906 and is enabled by default when compiling with optimization for speed
7907 (@option{-O}, @option{-O2}, @dots{}).
7909 @item one
7910 Use all functions as a single region.  
7911 This typically results in the smallest code size, and is enabled by default for
7912 @option{-Os} or @option{-O0}.
7914 @end table
7916 @item -fira-hoist-pressure
7917 @opindex fira-hoist-pressure
7918 Use IRA to evaluate register pressure in the code hoisting pass for
7919 decisions to hoist expressions.  This option usually results in smaller
7920 code, but it can slow the compiler down.
7922 This option is enabled at level @option{-Os} for all targets.
7924 @item -fira-loop-pressure
7925 @opindex fira-loop-pressure
7926 Use IRA to evaluate register pressure in loops for decisions to move
7927 loop invariants.  This option usually results in generation
7928 of faster and smaller code on machines with large register files (>= 32
7929 registers), but it can slow the compiler down.
7931 This option is enabled at level @option{-O3} for some targets.
7933 @item -fno-ira-share-save-slots
7934 @opindex fno-ira-share-save-slots
7935 Disable sharing of stack slots used for saving call-used hard
7936 registers living through a call.  Each hard register gets a
7937 separate stack slot, and as a result function stack frames are
7938 larger.
7940 @item -fno-ira-share-spill-slots
7941 @opindex fno-ira-share-spill-slots
7942 Disable sharing of stack slots allocated for pseudo-registers.  Each
7943 pseudo-register that does not get a hard register gets a separate
7944 stack slot, and as a result function stack frames are larger.
7946 @item -flra-remat
7947 @opindex flra-remat
7948 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7949 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7950 values if it is profitable.
7952 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7954 @item -fdelayed-branch
7955 @opindex fdelayed-branch
7956 If supported for the target machine, attempt to reorder instructions
7957 to exploit instruction slots available after delayed branch
7958 instructions.
7960 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7962 @item -fschedule-insns
7963 @opindex fschedule-insns
7964 If supported for the target machine, attempt to reorder instructions to
7965 eliminate execution stalls due to required data being unavailable.  This
7966 helps machines that have slow floating point or memory load instructions
7967 by allowing other instructions to be issued until the result of the load
7968 or floating-point instruction is required.
7970 Enabled at levels @option{-O2}, @option{-O3}.
7972 @item -fschedule-insns2
7973 @opindex fschedule-insns2
7974 Similar to @option{-fschedule-insns}, but requests an additional pass of
7975 instruction scheduling after register allocation has been done.  This is
7976 especially useful on machines with a relatively small number of
7977 registers and where memory load instructions take more than one cycle.
7979 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7981 @item -fno-sched-interblock
7982 @opindex fno-sched-interblock
7983 Don't schedule instructions across basic blocks.  This is normally
7984 enabled by default when scheduling before register allocation, i.e.@:
7985 with @option{-fschedule-insns} or at @option{-O2} or higher.
7987 @item -fno-sched-spec
7988 @opindex fno-sched-spec
7989 Don't allow speculative motion of non-load instructions.  This is normally
7990 enabled by default when scheduling before register allocation, i.e.@:
7991 with @option{-fschedule-insns} or at @option{-O2} or higher.
7993 @item -fsched-pressure
7994 @opindex fsched-pressure
7995 Enable register pressure sensitive insn scheduling before register
7996 allocation.  This only makes sense when scheduling before register
7997 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7998 @option{-O2} or higher.  Usage of this option can improve the
7999 generated code and decrease its size by preventing register pressure
8000 increase above the number of available hard registers and subsequent
8001 spills in register allocation.
8003 @item -fsched-spec-load
8004 @opindex fsched-spec-load
8005 Allow speculative motion of some load instructions.  This only makes
8006 sense when scheduling before register allocation, i.e.@: with
8007 @option{-fschedule-insns} or at @option{-O2} or higher.
8009 @item -fsched-spec-load-dangerous
8010 @opindex fsched-spec-load-dangerous
8011 Allow speculative motion of more load instructions.  This only makes
8012 sense when scheduling before register allocation, i.e.@: with
8013 @option{-fschedule-insns} or at @option{-O2} or higher.
8015 @item -fsched-stalled-insns
8016 @itemx -fsched-stalled-insns=@var{n}
8017 @opindex fsched-stalled-insns
8018 Define how many insns (if any) can be moved prematurely from the queue
8019 of stalled insns into the ready list during the second scheduling pass.
8020 @option{-fno-sched-stalled-insns} means that no insns are moved
8021 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8022 on how many queued insns can be moved prematurely.
8023 @option{-fsched-stalled-insns} without a value is equivalent to
8024 @option{-fsched-stalled-insns=1}.
8026 @item -fsched-stalled-insns-dep
8027 @itemx -fsched-stalled-insns-dep=@var{n}
8028 @opindex fsched-stalled-insns-dep
8029 Define how many insn groups (cycles) are examined for a dependency
8030 on a stalled insn that is a candidate for premature removal from the queue
8031 of stalled insns.  This has an effect only during the second scheduling pass,
8032 and only if @option{-fsched-stalled-insns} is used.
8033 @option{-fno-sched-stalled-insns-dep} is equivalent to
8034 @option{-fsched-stalled-insns-dep=0}.
8035 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8036 @option{-fsched-stalled-insns-dep=1}.
8038 @item -fsched2-use-superblocks
8039 @opindex fsched2-use-superblocks
8040 When scheduling after register allocation, use superblock scheduling.
8041 This allows motion across basic block boundaries,
8042 resulting in faster schedules.  This option is experimental, as not all machine
8043 descriptions used by GCC model the CPU closely enough to avoid unreliable
8044 results from the algorithm.
8046 This only makes sense when scheduling after register allocation, i.e.@: with
8047 @option{-fschedule-insns2} or at @option{-O2} or higher.
8049 @item -fsched-group-heuristic
8050 @opindex fsched-group-heuristic
8051 Enable the group heuristic in the scheduler.  This heuristic favors
8052 the instruction that belongs to a schedule group.  This is enabled
8053 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8054 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8056 @item -fsched-critical-path-heuristic
8057 @opindex fsched-critical-path-heuristic
8058 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8059 instructions on the critical path.  This is enabled by default when
8060 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8061 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8063 @item -fsched-spec-insn-heuristic
8064 @opindex fsched-spec-insn-heuristic
8065 Enable the speculative instruction heuristic in the scheduler.  This
8066 heuristic favors speculative instructions with greater dependency weakness.
8067 This is enabled by default when scheduling is enabled, i.e.@:
8068 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8069 or at @option{-O2} or higher.
8071 @item -fsched-rank-heuristic
8072 @opindex fsched-rank-heuristic
8073 Enable the rank heuristic in the scheduler.  This heuristic favors
8074 the instruction belonging to a basic block with greater size or frequency.
8075 This is enabled by default when scheduling is enabled, i.e.@:
8076 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8077 at @option{-O2} or higher.
8079 @item -fsched-last-insn-heuristic
8080 @opindex fsched-last-insn-heuristic
8081 Enable the last-instruction heuristic in the scheduler.  This heuristic
8082 favors the instruction that is less dependent on the last instruction
8083 scheduled.  This is enabled by default when scheduling is enabled,
8084 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8085 at @option{-O2} or higher.
8087 @item -fsched-dep-count-heuristic
8088 @opindex fsched-dep-count-heuristic
8089 Enable the dependent-count heuristic in the scheduler.  This heuristic
8090 favors the instruction that has more instructions depending on it.
8091 This is enabled by default when scheduling is enabled, i.e.@:
8092 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8093 at @option{-O2} or higher.
8095 @item -freschedule-modulo-scheduled-loops
8096 @opindex freschedule-modulo-scheduled-loops
8097 Modulo scheduling is performed before traditional scheduling.  If a loop
8098 is modulo scheduled, later scheduling passes may change its schedule.  
8099 Use this option to control that behavior.
8101 @item -fselective-scheduling
8102 @opindex fselective-scheduling
8103 Schedule instructions using selective scheduling algorithm.  Selective
8104 scheduling runs instead of the first scheduler pass.
8106 @item -fselective-scheduling2
8107 @opindex fselective-scheduling2
8108 Schedule instructions using selective scheduling algorithm.  Selective
8109 scheduling runs instead of the second scheduler pass.
8111 @item -fsel-sched-pipelining
8112 @opindex fsel-sched-pipelining
8113 Enable software pipelining of innermost loops during selective scheduling.
8114 This option has no effect unless one of @option{-fselective-scheduling} or
8115 @option{-fselective-scheduling2} is turned on.
8117 @item -fsel-sched-pipelining-outer-loops
8118 @opindex fsel-sched-pipelining-outer-loops
8119 When pipelining loops during selective scheduling, also pipeline outer loops.
8120 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8122 @item -fsemantic-interposition
8123 @opindex fsemantic-interposition
8124 Some object formats, like ELF, allow interposing of symbols by the 
8125 dynamic linker.
8126 This means that for symbols exported from the DSO, the compiler cannot perform
8127 interprocedural propagation, inlining and other optimizations in anticipation
8128 that the function or variable in question may change. While this feature is
8129 useful, for example, to rewrite memory allocation functions by a debugging
8130 implementation, it is expensive in the terms of code quality.
8131 With @option{-fno-semantic-interposition} the compiler assumes that 
8132 if interposition happens for functions the overwriting function will have 
8133 precisely the same semantics (and side effects). 
8134 Similarly if interposition happens
8135 for variables, the constructor of the variable will be the same. The flag
8136 has no effect for functions explicitly declared inline 
8137 (where it is never allowed for interposition to change semantics) 
8138 and for symbols explicitly declared weak.
8140 @item -fshrink-wrap
8141 @opindex fshrink-wrap
8142 Emit function prologues only before parts of the function that need it,
8143 rather than at the top of the function.  This flag is enabled by default at
8144 @option{-O} and higher.
8146 @item -fshrink-wrap-separate
8147 @opindex fshrink-wrap-separate
8148 Shrink-wrap separate parts of the prologue and epilogue separately, so that
8149 those parts are only executed when needed.
8150 This option is on by default, but has no effect unless @option{-fshrink-wrap}
8151 is also turned on and the target supports this.
8153 @item -fcaller-saves
8154 @opindex fcaller-saves
8155 Enable allocation of values to registers that are clobbered by
8156 function calls, by emitting extra instructions to save and restore the
8157 registers around such calls.  Such allocation is done only when it
8158 seems to result in better code.
8160 This option is always enabled by default on certain machines, usually
8161 those which have no call-preserved registers to use instead.
8163 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8165 @item -fcombine-stack-adjustments
8166 @opindex fcombine-stack-adjustments
8167 Tracks stack adjustments (pushes and pops) and stack memory references
8168 and then tries to find ways to combine them.
8170 Enabled by default at @option{-O1} and higher.
8172 @item -fipa-ra
8173 @opindex fipa-ra
8174 Use caller save registers for allocation if those registers are not used by
8175 any called function.  In that case it is not necessary to save and restore
8176 them around calls.  This is only possible if called functions are part of
8177 same compilation unit as current function and they are compiled before it.
8179 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option
8180 is disabled if generated code will be instrumented for profiling
8181 (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known
8182 exactly (this happens on targets that do not expose prologues
8183 and epilogues in RTL).
8185 @item -fconserve-stack
8186 @opindex fconserve-stack
8187 Attempt to minimize stack usage.  The compiler attempts to use less
8188 stack space, even if that makes the program slower.  This option
8189 implies setting the @option{large-stack-frame} parameter to 100
8190 and the @option{large-stack-frame-growth} parameter to 400.
8192 @item -ftree-reassoc
8193 @opindex ftree-reassoc
8194 Perform reassociation on trees.  This flag is enabled by default
8195 at @option{-O} and higher.
8197 @item -fcode-hoisting
8198 @opindex fcode-hoisting
8199 Perform code hoisting.  Code hoisting tries to move the
8200 evaluation of expressions executed on all paths to the function exit
8201 as early as possible.  This is especially useful as a code size
8202 optimization, but it often helps for code speed as well.
8203 This flag is enabled by default at @option{-O2} and higher.
8205 @item -ftree-pre
8206 @opindex ftree-pre
8207 Perform partial redundancy elimination (PRE) on trees.  This flag is
8208 enabled by default at @option{-O2} and @option{-O3}.
8210 @item -ftree-partial-pre
8211 @opindex ftree-partial-pre
8212 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8213 enabled by default at @option{-O3}.
8215 @item -ftree-forwprop
8216 @opindex ftree-forwprop
8217 Perform forward propagation on trees.  This flag is enabled by default
8218 at @option{-O} and higher.
8220 @item -ftree-fre
8221 @opindex ftree-fre
8222 Perform full redundancy elimination (FRE) on trees.  The difference
8223 between FRE and PRE is that FRE only considers expressions
8224 that are computed on all paths leading to the redundant computation.
8225 This analysis is faster than PRE, though it exposes fewer redundancies.
8226 This flag is enabled by default at @option{-O} and higher.
8228 @item -ftree-phiprop
8229 @opindex ftree-phiprop
8230 Perform hoisting of loads from conditional pointers on trees.  This
8231 pass is enabled by default at @option{-O} and higher.
8233 @item -fhoist-adjacent-loads
8234 @opindex fhoist-adjacent-loads
8235 Speculatively hoist loads from both branches of an if-then-else if the
8236 loads are from adjacent locations in the same structure and the target
8237 architecture has a conditional move instruction.  This flag is enabled
8238 by default at @option{-O2} and higher.
8240 @item -ftree-copy-prop
8241 @opindex ftree-copy-prop
8242 Perform copy propagation on trees.  This pass eliminates unnecessary
8243 copy operations.  This flag is enabled by default at @option{-O} and
8244 higher.
8246 @item -fipa-pure-const
8247 @opindex fipa-pure-const
8248 Discover which functions are pure or constant.
8249 Enabled by default at @option{-O} and higher.
8251 @item -fipa-reference
8252 @opindex fipa-reference
8253 Discover which static variables do not escape the
8254 compilation unit.
8255 Enabled by default at @option{-O} and higher.
8257 @item -fipa-pta
8258 @opindex fipa-pta
8259 Perform interprocedural pointer analysis and interprocedural modification
8260 and reference analysis.  This option can cause excessive memory and
8261 compile-time usage on large compilation units.  It is not enabled by
8262 default at any optimization level.
8264 @item -fipa-profile
8265 @opindex fipa-profile
8266 Perform interprocedural profile propagation.  The functions called only from
8267 cold functions are marked as cold. Also functions executed once (such as
8268 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8269 functions and loop less parts of functions executed once are then optimized for
8270 size.
8271 Enabled by default at @option{-O} and higher.
8273 @item -fipa-cp
8274 @opindex fipa-cp
8275 Perform interprocedural constant propagation.
8276 This optimization analyzes the program to determine when values passed
8277 to functions are constants and then optimizes accordingly.
8278 This optimization can substantially increase performance
8279 if the application has constants passed to functions.
8280 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8282 @item -fipa-cp-clone
8283 @opindex fipa-cp-clone
8284 Perform function cloning to make interprocedural constant propagation stronger.
8285 When enabled, interprocedural constant propagation performs function cloning
8286 when externally visible function can be called with constant arguments.
8287 Because this optimization can create multiple copies of functions,
8288 it may significantly increase code size
8289 (see @option{--param ipcp-unit-growth=@var{value}}).
8290 This flag is enabled by default at @option{-O3}.
8292 @item -fipa-bit-cp
8293 @opindex -fipa-bit-cp
8294 When enabled, perform interprocedural bitwise constant
8295 propagation. This flag is enabled by default at @option{-O2}. It
8296 requires that @option{-fipa-cp} is enabled.
8298 @item -fipa-vrp
8299 @opindex -fipa-vrp
8300 When enabled, perform interprocedural propagation of value
8301 ranges. This flag is enabled by default at @option{-O2}. It requires
8302 that @option{-fipa-cp} is enabled.
8304 @item -fipa-icf
8305 @opindex fipa-icf
8306 Perform Identical Code Folding for functions and read-only variables.
8307 The optimization reduces code size and may disturb unwind stacks by replacing
8308 a function by equivalent one with a different name. The optimization works
8309 more effectively with link-time optimization enabled.
8311 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8312 works on different levels and thus the optimizations are not same - there are
8313 equivalences that are found only by GCC and equivalences found only by Gold.
8315 This flag is enabled by default at @option{-O2} and @option{-Os}.
8317 @item -fisolate-erroneous-paths-dereference
8318 @opindex fisolate-erroneous-paths-dereference
8319 Detect paths that trigger erroneous or undefined behavior due to
8320 dereferencing a null pointer.  Isolate those paths from the main control
8321 flow and turn the statement with erroneous or undefined behavior into a trap.
8322 This flag is enabled by default at @option{-O2} and higher and depends on
8323 @option{-fdelete-null-pointer-checks} also being enabled.
8325 @item -fisolate-erroneous-paths-attribute
8326 @opindex fisolate-erroneous-paths-attribute
8327 Detect paths that trigger erroneous or undefined behavior due a null value
8328 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8329 attribute.  Isolate those paths from the main control flow and turn the
8330 statement with erroneous or undefined behavior into a trap.  This is not
8331 currently enabled, but may be enabled by @option{-O2} in the future.
8333 @item -ftree-sink
8334 @opindex ftree-sink
8335 Perform forward store motion on trees.  This flag is
8336 enabled by default at @option{-O} and higher.
8338 @item -ftree-bit-ccp
8339 @opindex ftree-bit-ccp
8340 Perform sparse conditional bit constant propagation on trees and propagate
8341 pointer alignment information.
8342 This pass only operates on local scalar variables and is enabled by default
8343 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8345 @item -ftree-ccp
8346 @opindex ftree-ccp
8347 Perform sparse conditional constant propagation (CCP) on trees.  This
8348 pass only operates on local scalar variables and is enabled by default
8349 at @option{-O} and higher.
8351 @item -fssa-backprop
8352 @opindex fssa-backprop
8353 Propagate information about uses of a value up the definition chain
8354 in order to simplify the definitions.  For example, this pass strips
8355 sign operations if the sign of a value never matters.  The flag is
8356 enabled by default at @option{-O} and higher.
8358 @item -fssa-phiopt
8359 @opindex fssa-phiopt
8360 Perform pattern matching on SSA PHI nodes to optimize conditional
8361 code.  This pass is enabled by default at @option{-O} and higher.
8363 @item -ftree-switch-conversion
8364 @opindex ftree-switch-conversion
8365 Perform conversion of simple initializations in a switch to
8366 initializations from a scalar array.  This flag is enabled by default
8367 at @option{-O2} and higher.
8369 @item -ftree-tail-merge
8370 @opindex ftree-tail-merge
8371 Look for identical code sequences.  When found, replace one with a jump to the
8372 other.  This optimization is known as tail merging or cross jumping.  This flag
8373 is enabled by default at @option{-O2} and higher.  The compilation time
8374 in this pass can
8375 be limited using @option{max-tail-merge-comparisons} parameter and
8376 @option{max-tail-merge-iterations} parameter.
8378 @item -ftree-dce
8379 @opindex ftree-dce
8380 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8381 default at @option{-O} and higher.
8383 @item -ftree-builtin-call-dce
8384 @opindex ftree-builtin-call-dce
8385 Perform conditional dead code elimination (DCE) for calls to built-in functions
8386 that may set @code{errno} but are otherwise side-effect free.  This flag is
8387 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8388 specified.
8390 @item -ftree-dominator-opts
8391 @opindex ftree-dominator-opts
8392 Perform a variety of simple scalar cleanups (constant/copy
8393 propagation, redundancy elimination, range propagation and expression
8394 simplification) based on a dominator tree traversal.  This also
8395 performs jump threading (to reduce jumps to jumps). This flag is
8396 enabled by default at @option{-O} and higher.
8398 @item -ftree-dse
8399 @opindex ftree-dse
8400 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8401 a memory location that is later overwritten by another store without
8402 any intervening loads.  In this case the earlier store can be deleted.  This
8403 flag is enabled by default at @option{-O} and higher.
8405 @item -ftree-ch
8406 @opindex ftree-ch
8407 Perform loop header copying on trees.  This is beneficial since it increases
8408 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8409 is enabled by default at @option{-O} and higher.  It is not enabled
8410 for @option{-Os}, since it usually increases code size.
8412 @item -ftree-loop-optimize
8413 @opindex ftree-loop-optimize
8414 Perform loop optimizations on trees.  This flag is enabled by default
8415 at @option{-O} and higher.
8417 @item -ftree-loop-linear
8418 @itemx -floop-interchange
8419 @itemx -floop-strip-mine
8420 @itemx -floop-block
8421 @itemx -floop-unroll-and-jam
8422 @opindex ftree-loop-linear
8423 @opindex floop-interchange
8424 @opindex floop-strip-mine
8425 @opindex floop-block
8426 @opindex floop-unroll-and-jam
8427 Perform loop nest optimizations.  Same as
8428 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8429 to be configured with @option{--with-isl} to enable the Graphite loop
8430 transformation infrastructure.
8432 @item -fgraphite-identity
8433 @opindex fgraphite-identity
8434 Enable the identity transformation for graphite.  For every SCoP we generate
8435 the polyhedral representation and transform it back to gimple.  Using
8436 @option{-fgraphite-identity} we can check the costs or benefits of the
8437 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8438 are also performed by the code generator isl, like index splitting and
8439 dead code elimination in loops.
8441 @item -floop-nest-optimize
8442 @opindex floop-nest-optimize
8443 Enable the isl based loop nest optimizer.  This is a generic loop nest
8444 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8445 structure optimized for data-locality and parallelism.  This option
8446 is experimental.
8448 @item -floop-parallelize-all
8449 @opindex floop-parallelize-all
8450 Use the Graphite data dependence analysis to identify loops that can
8451 be parallelized.  Parallelize all the loops that can be analyzed to
8452 not contain loop carried dependences without checking that it is
8453 profitable to parallelize the loops.
8455 @item -ftree-coalesce-vars
8456 @opindex ftree-coalesce-vars
8457 While transforming the program out of the SSA representation, attempt to
8458 reduce copying by coalescing versions of different user-defined
8459 variables, instead of just compiler temporaries.  This may severely
8460 limit the ability to debug an optimized program compiled with
8461 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8462 prevents SSA coalescing of user variables.  This option is enabled by
8463 default if optimization is enabled, and it does very little otherwise.
8465 @item -ftree-loop-if-convert
8466 @opindex ftree-loop-if-convert
8467 Attempt to transform conditional jumps in the innermost loops to
8468 branch-less equivalents.  The intent is to remove control-flow from
8469 the innermost loops in order to improve the ability of the
8470 vectorization pass to handle these loops.  This is enabled by default
8471 if vectorization is enabled.
8473 @item -ftree-loop-distribution
8474 @opindex ftree-loop-distribution
8475 Perform loop distribution.  This flag can improve cache performance on
8476 big loop bodies and allow further loop optimizations, like
8477 parallelization or vectorization, to take place.  For example, the loop
8478 @smallexample
8479 DO I = 1, N
8480   A(I) = B(I) + C
8481   D(I) = E(I) * F
8482 ENDDO
8483 @end smallexample
8484 is transformed to
8485 @smallexample
8486 DO I = 1, N
8487    A(I) = B(I) + C
8488 ENDDO
8489 DO I = 1, N
8490    D(I) = E(I) * F
8491 ENDDO
8492 @end smallexample
8494 @item -ftree-loop-distribute-patterns
8495 @opindex ftree-loop-distribute-patterns
8496 Perform loop distribution of patterns that can be code generated with
8497 calls to a library.  This flag is enabled by default at @option{-O3}.
8499 This pass distributes the initialization loops and generates a call to
8500 memset zero.  For example, the loop
8501 @smallexample
8502 DO I = 1, N
8503   A(I) = 0
8504   B(I) = A(I) + I
8505 ENDDO
8506 @end smallexample
8507 is transformed to
8508 @smallexample
8509 DO I = 1, N
8510    A(I) = 0
8511 ENDDO
8512 DO I = 1, N
8513    B(I) = A(I) + I
8514 ENDDO
8515 @end smallexample
8516 and the initialization loop is transformed into a call to memset zero.
8518 @item -ftree-loop-im
8519 @opindex ftree-loop-im
8520 Perform loop invariant motion on trees.  This pass moves only invariants that
8521 are hard to handle at RTL level (function calls, operations that expand to
8522 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8523 operands of conditions that are invariant out of the loop, so that we can use
8524 just trivial invariantness analysis in loop unswitching.  The pass also includes
8525 store motion.
8527 @item -ftree-loop-ivcanon
8528 @opindex ftree-loop-ivcanon
8529 Create a canonical counter for number of iterations in loops for which
8530 determining number of iterations requires complicated analysis.  Later
8531 optimizations then may determine the number easily.  Useful especially
8532 in connection with unrolling.
8534 @item -fivopts
8535 @opindex fivopts
8536 Perform induction variable optimizations (strength reduction, induction
8537 variable merging and induction variable elimination) on trees.
8539 @item -ftree-parallelize-loops=n
8540 @opindex ftree-parallelize-loops
8541 Parallelize loops, i.e., split their iteration space to run in n threads.
8542 This is only possible for loops whose iterations are independent
8543 and can be arbitrarily reordered.  The optimization is only
8544 profitable on multiprocessor machines, for loops that are CPU-intensive,
8545 rather than constrained e.g.@: by memory bandwidth.  This option
8546 implies @option{-pthread}, and thus is only supported on targets
8547 that have support for @option{-pthread}.
8549 @item -ftree-pta
8550 @opindex ftree-pta
8551 Perform function-local points-to analysis on trees.  This flag is
8552 enabled by default at @option{-O} and higher.
8554 @item -ftree-sra
8555 @opindex ftree-sra
8556 Perform scalar replacement of aggregates.  This pass replaces structure
8557 references with scalars to prevent committing structures to memory too
8558 early.  This flag is enabled by default at @option{-O} and higher.
8560 @item -fstore-merging
8561 @opindex fstore-merging
8562 Perform merging of narrow stores to consecutive memory addresses.  This pass
8563 merges contiguous stores of immediate values narrower than a word into fewer
8564 wider stores to reduce the number of instructions.  This is enabled by default
8565 at @option{-O2} and higher as well as @option{-Os}.
8567 @item -ftree-ter
8568 @opindex ftree-ter
8569 Perform temporary expression replacement during the SSA->normal phase.  Single
8570 use/single def temporaries are replaced at their use location with their
8571 defining expression.  This results in non-GIMPLE code, but gives the expanders
8572 much more complex trees to work on resulting in better RTL generation.  This is
8573 enabled by default at @option{-O} and higher.
8575 @item -ftree-slsr
8576 @opindex ftree-slsr
8577 Perform straight-line strength reduction on trees.  This recognizes related
8578 expressions involving multiplications and replaces them by less expensive
8579 calculations when possible.  This is enabled by default at @option{-O} and
8580 higher.
8582 @item -ftree-vectorize
8583 @opindex ftree-vectorize
8584 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8585 and @option{-ftree-slp-vectorize} if not explicitly specified.
8587 @item -ftree-loop-vectorize
8588 @opindex ftree-loop-vectorize
8589 Perform loop vectorization on trees. This flag is enabled by default at
8590 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8592 @item -ftree-slp-vectorize
8593 @opindex ftree-slp-vectorize
8594 Perform basic block vectorization on trees. This flag is enabled by default at
8595 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8597 @item -fvect-cost-model=@var{model}
8598 @opindex fvect-cost-model
8599 Alter the cost model used for vectorization.  The @var{model} argument
8600 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
8601 With the @samp{unlimited} model the vectorized code-path is assumed
8602 to be profitable while with the @samp{dynamic} model a runtime check
8603 guards the vectorized code-path to enable it only for iteration
8604 counts that will likely execute faster than when executing the original
8605 scalar loop.  The @samp{cheap} model disables vectorization of
8606 loops where doing so would be cost prohibitive for example due to
8607 required runtime checks for data dependence or alignment but otherwise
8608 is equal to the @samp{dynamic} model.
8609 The default cost model depends on other optimization flags and is
8610 either @samp{dynamic} or @samp{cheap}.
8612 @item -fsimd-cost-model=@var{model}
8613 @opindex fsimd-cost-model
8614 Alter the cost model used for vectorization of loops marked with the OpenMP
8615 or Cilk Plus simd directive.  The @var{model} argument should be one of
8616 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
8617 have the same meaning as described in @option{-fvect-cost-model} and by
8618 default a cost model defined with @option{-fvect-cost-model} is used.
8620 @item -ftree-vrp
8621 @opindex ftree-vrp
8622 Perform Value Range Propagation on trees.  This is similar to the
8623 constant propagation pass, but instead of values, ranges of values are
8624 propagated.  This allows the optimizers to remove unnecessary range
8625 checks like array bound checks and null pointer checks.  This is
8626 enabled by default at @option{-O2} and higher.  Null pointer check
8627 elimination is only done if @option{-fdelete-null-pointer-checks} is
8628 enabled.
8630 @item -fsplit-paths
8631 @opindex fsplit-paths
8632 Split paths leading to loop backedges.  This can improve dead code
8633 elimination and common subexpression elimination.  This is enabled by
8634 default at @option{-O2} and above.
8636 @item -fsplit-ivs-in-unroller
8637 @opindex fsplit-ivs-in-unroller
8638 Enables expression of values of induction variables in later iterations
8639 of the unrolled loop using the value in the first iteration.  This breaks
8640 long dependency chains, thus improving efficiency of the scheduling passes.
8642 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8643 same effect.  However, that is not reliable in cases where the loop body
8644 is more complicated than a single basic block.  It also does not work at all
8645 on some architectures due to restrictions in the CSE pass.
8647 This optimization is enabled by default.
8649 @item -fvariable-expansion-in-unroller
8650 @opindex fvariable-expansion-in-unroller
8651 With this option, the compiler creates multiple copies of some
8652 local variables when unrolling a loop, which can result in superior code.
8654 @item -fpartial-inlining
8655 @opindex fpartial-inlining
8656 Inline parts of functions.  This option has any effect only
8657 when inlining itself is turned on by the @option{-finline-functions}
8658 or @option{-finline-small-functions} options.
8660 Enabled at level @option{-O2}.
8662 @item -fpredictive-commoning
8663 @opindex fpredictive-commoning
8664 Perform predictive commoning optimization, i.e., reusing computations
8665 (especially memory loads and stores) performed in previous
8666 iterations of loops.
8668 This option is enabled at level @option{-O3}.
8670 @item -fprefetch-loop-arrays
8671 @opindex fprefetch-loop-arrays
8672 If supported by the target machine, generate instructions to prefetch
8673 memory to improve the performance of loops that access large arrays.
8675 This option may generate better or worse code; results are highly
8676 dependent on the structure of loops within the source code.
8678 Disabled at level @option{-Os}.
8680 @item -fno-printf-return-value
8681 @opindex fno-printf-return-value
8682 Do not substitute constants for known return value of formatted output
8683 functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and
8684 @code{vsnprintf} (but not @code{printf} of @code{fprintf}).  This
8685 transformation allows GCC to optimize or even eliminate branches based
8686 on the known return value of these functions called with arguments that
8687 are either constant, or whose values are known to be in a range that
8688 makes determining the exact return value possible.  For example, when
8689 @option{-fprintf-return-value} is in effect, both the branch and the
8690 body of the @code{if} statement (but not the call to @code{snprint})
8691 can be optimized away when @code{i} is a 32-bit or smaller integer
8692 because the return value is guaranteed to be at most 8.
8694 @smallexample
8695 char buf[9];
8696 if (snprintf (buf, "%08x", i) >= sizeof buf)
8697   @dots{}
8698 @end smallexample
8700 The @option{-fprintf-return-value} option relies on other optimizations
8701 and yields best results with @option{-O2}.  It works in tandem with the
8702 @option{-Wformat-overflow} and @option{-Wformat-truncation} options.
8703 The @option{-fprintf-return-value} option is enabled by default.
8705 @item -fno-peephole
8706 @itemx -fno-peephole2
8707 @opindex fno-peephole
8708 @opindex fno-peephole2
8709 Disable any machine-specific peephole optimizations.  The difference
8710 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8711 are implemented in the compiler; some targets use one, some use the
8712 other, a few use both.
8714 @option{-fpeephole} is enabled by default.
8715 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8717 @item -fno-guess-branch-probability
8718 @opindex fno-guess-branch-probability
8719 Do not guess branch probabilities using heuristics.
8721 GCC uses heuristics to guess branch probabilities if they are
8722 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8723 heuristics are based on the control flow graph.  If some branch probabilities
8724 are specified by @code{__builtin_expect}, then the heuristics are
8725 used to guess branch probabilities for the rest of the control flow graph,
8726 taking the @code{__builtin_expect} info into account.  The interactions
8727 between the heuristics and @code{__builtin_expect} can be complex, and in
8728 some cases, it may be useful to disable the heuristics so that the effects
8729 of @code{__builtin_expect} are easier to understand.
8731 The default is @option{-fguess-branch-probability} at levels
8732 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8734 @item -freorder-blocks
8735 @opindex freorder-blocks
8736 Reorder basic blocks in the compiled function in order to reduce number of
8737 taken branches and improve code locality.
8739 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8741 @item -freorder-blocks-algorithm=@var{algorithm}
8742 @opindex freorder-blocks-algorithm
8743 Use the specified algorithm for basic block reordering.  The
8744 @var{algorithm} argument can be @samp{simple}, which does not increase
8745 code size (except sometimes due to secondary effects like alignment),
8746 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
8747 put all often executed code together, minimizing the number of branches
8748 executed by making extra copies of code.
8750 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
8751 @samp{stc} at levels @option{-O2}, @option{-O3}.
8753 @item -freorder-blocks-and-partition
8754 @opindex freorder-blocks-and-partition
8755 In addition to reordering basic blocks in the compiled function, in order
8756 to reduce number of taken branches, partitions hot and cold basic blocks
8757 into separate sections of the assembly and @file{.o} files, to improve
8758 paging and cache locality performance.
8760 This optimization is automatically turned off in the presence of
8761 exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined
8762 section attribute and on any architecture that does not support named
8763 sections.  When @option{-fsplit-stack} is used this option is not
8764 enabled by default (to avoid linker errors), but may be enabled
8765 explicitly (if using a working linker).
8767 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8769 @item -freorder-functions
8770 @opindex freorder-functions
8771 Reorder functions in the object file in order to
8772 improve code locality.  This is implemented by using special
8773 subsections @code{.text.hot} for most frequently executed functions and
8774 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8775 the linker so object file format must support named sections and linker must
8776 place them in a reasonable way.
8778 Also profile feedback must be available to make this option effective.  See
8779 @option{-fprofile-arcs} for details.
8781 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8783 @item -fstrict-aliasing
8784 @opindex fstrict-aliasing
8785 Allow the compiler to assume the strictest aliasing rules applicable to
8786 the language being compiled.  For C (and C++), this activates
8787 optimizations based on the type of expressions.  In particular, an
8788 object of one type is assumed never to reside at the same address as an
8789 object of a different type, unless the types are almost the same.  For
8790 example, an @code{unsigned int} can alias an @code{int}, but not a
8791 @code{void*} or a @code{double}.  A character type may alias any other
8792 type.
8794 @anchor{Type-punning}Pay special attention to code like this:
8795 @smallexample
8796 union a_union @{
8797   int i;
8798   double d;
8801 int f() @{
8802   union a_union t;
8803   t.d = 3.0;
8804   return t.i;
8806 @end smallexample
8807 The practice of reading from a different union member than the one most
8808 recently written to (called ``type-punning'') is common.  Even with
8809 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8810 is accessed through the union type.  So, the code above works as
8811 expected.  @xref{Structures unions enumerations and bit-fields
8812 implementation}.  However, this code might not:
8813 @smallexample
8814 int f() @{
8815   union a_union t;
8816   int* ip;
8817   t.d = 3.0;
8818   ip = &t.i;
8819   return *ip;
8821 @end smallexample
8823 Similarly, access by taking the address, casting the resulting pointer
8824 and dereferencing the result has undefined behavior, even if the cast
8825 uses a union type, e.g.:
8826 @smallexample
8827 int f() @{
8828   double d = 3.0;
8829   return ((union a_union *) &d)->i;
8831 @end smallexample
8833 The @option{-fstrict-aliasing} option is enabled at levels
8834 @option{-O2}, @option{-O3}, @option{-Os}.
8836 @item -falign-functions
8837 @itemx -falign-functions=@var{n}
8838 @opindex falign-functions
8839 Align the start of functions to the next power-of-two greater than
8840 @var{n}, skipping up to @var{n} bytes.  For instance,
8841 @option{-falign-functions=32} aligns functions to the next 32-byte
8842 boundary, but @option{-falign-functions=24} aligns to the next
8843 32-byte boundary only if this can be done by skipping 23 bytes or less.
8845 @option{-fno-align-functions} and @option{-falign-functions=1} are
8846 equivalent and mean that functions are not aligned.
8848 Some assemblers only support this flag when @var{n} is a power of two;
8849 in that case, it is rounded up.
8851 If @var{n} is not specified or is zero, use a machine-dependent default.
8853 Enabled at levels @option{-O2}, @option{-O3}.
8855 @item -flimit-function-alignment
8856 If this option is enabled, the compiler tries to avoid unnecessarily
8857 overaligning functions. It attempts to instruct the assembler to align
8858 by the amount specified by @option{-falign-functions}, but not to
8859 skip more bytes than the size of the function.
8861 @item -falign-labels
8862 @itemx -falign-labels=@var{n}
8863 @opindex falign-labels
8864 Align all branch targets to a power-of-two boundary, skipping up to
8865 @var{n} bytes like @option{-falign-functions}.  This option can easily
8866 make code slower, because it must insert dummy operations for when the
8867 branch target is reached in the usual flow of the code.
8869 @option{-fno-align-labels} and @option{-falign-labels=1} are
8870 equivalent and mean that labels are not aligned.
8872 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8873 are greater than this value, then their values are used instead.
8875 If @var{n} is not specified or is zero, use a machine-dependent default
8876 which is very likely to be @samp{1}, meaning no alignment.
8878 Enabled at levels @option{-O2}, @option{-O3}.
8880 @item -falign-loops
8881 @itemx -falign-loops=@var{n}
8882 @opindex falign-loops
8883 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8884 like @option{-falign-functions}.  If the loops are
8885 executed many times, this makes up for any execution of the dummy
8886 operations.
8888 @option{-fno-align-loops} and @option{-falign-loops=1} are
8889 equivalent and mean that loops are not aligned.
8891 If @var{n} is not specified or is zero, use a machine-dependent default.
8893 Enabled at levels @option{-O2}, @option{-O3}.
8895 @item -falign-jumps
8896 @itemx -falign-jumps=@var{n}
8897 @opindex falign-jumps
8898 Align branch targets to a power-of-two boundary, for branch targets
8899 where the targets can only be reached by jumping, skipping up to @var{n}
8900 bytes like @option{-falign-functions}.  In this case, no dummy operations
8901 need be executed.
8903 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8904 equivalent and mean that loops are not aligned.
8906 If @var{n} is not specified or is zero, use a machine-dependent default.
8908 Enabled at levels @option{-O2}, @option{-O3}.
8910 @item -funit-at-a-time
8911 @opindex funit-at-a-time
8912 This option is left for compatibility reasons. @option{-funit-at-a-time}
8913 has no effect, while @option{-fno-unit-at-a-time} implies
8914 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8916 Enabled by default.
8918 @item -fno-toplevel-reorder
8919 @opindex fno-toplevel-reorder
8920 Do not reorder top-level functions, variables, and @code{asm}
8921 statements.  Output them in the same order that they appear in the
8922 input file.  When this option is used, unreferenced static variables
8923 are not removed.  This option is intended to support existing code
8924 that relies on a particular ordering.  For new code, it is better to
8925 use attributes when possible.
8927 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8928 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8929 targets.
8931 @item -fweb
8932 @opindex fweb
8933 Constructs webs as commonly used for register allocation purposes and assign
8934 each web individual pseudo register.  This allows the register allocation pass
8935 to operate on pseudos directly, but also strengthens several other optimization
8936 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8937 however, make debugging impossible, since variables no longer stay in a
8938 ``home register''.
8940 Enabled by default with @option{-funroll-loops}.
8942 @item -fwhole-program
8943 @opindex fwhole-program
8944 Assume that the current compilation unit represents the whole program being
8945 compiled.  All public functions and variables with the exception of @code{main}
8946 and those merged by attribute @code{externally_visible} become static functions
8947 and in effect are optimized more aggressively by interprocedural optimizers.
8949 This option should not be used in combination with @option{-flto}.
8950 Instead relying on a linker plugin should provide safer and more precise
8951 information.
8953 @item -flto[=@var{n}]
8954 @opindex flto
8955 This option runs the standard link-time optimizer.  When invoked
8956 with source code, it generates GIMPLE (one of GCC's internal
8957 representations) and writes it to special ELF sections in the object
8958 file.  When the object files are linked together, all the function
8959 bodies are read from these ELF sections and instantiated as if they
8960 had been part of the same translation unit.
8962 To use the link-time optimizer, @option{-flto} and optimization
8963 options should be specified at compile time and during the final link.
8964 It is recommended that you compile all the files participating in the
8965 same link with the same options and also specify those options at
8966 link time.  
8967 For example:
8969 @smallexample
8970 gcc -c -O2 -flto foo.c
8971 gcc -c -O2 -flto bar.c
8972 gcc -o myprog -flto -O2 foo.o bar.o
8973 @end smallexample
8975 The first two invocations to GCC save a bytecode representation
8976 of GIMPLE into special ELF sections inside @file{foo.o} and
8977 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8978 @file{foo.o} and @file{bar.o}, merges the two files into a single
8979 internal image, and compiles the result as usual.  Since both
8980 @file{foo.o} and @file{bar.o} are merged into a single image, this
8981 causes all the interprocedural analyses and optimizations in GCC to
8982 work across the two files as if they were a single one.  This means,
8983 for example, that the inliner is able to inline functions in
8984 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8986 Another (simpler) way to enable link-time optimization is:
8988 @smallexample
8989 gcc -o myprog -flto -O2 foo.c bar.c
8990 @end smallexample
8992 The above generates bytecode for @file{foo.c} and @file{bar.c},
8993 merges them together into a single GIMPLE representation and optimizes
8994 them as usual to produce @file{myprog}.
8996 The only important thing to keep in mind is that to enable link-time
8997 optimizations you need to use the GCC driver to perform the link step.
8998 GCC then automatically performs link-time optimization if any of the
8999 objects involved were compiled with the @option{-flto} command-line option.  
9000 You generally
9001 should specify the optimization options to be used for link-time
9002 optimization though GCC tries to be clever at guessing an
9003 optimization level to use from the options used at compile time
9004 if you fail to specify one at link time.  You can always override
9005 the automatic decision to do link-time optimization
9006 by passing @option{-fno-lto} to the link command.
9008 To make whole program optimization effective, it is necessary to make
9009 certain whole program assumptions.  The compiler needs to know
9010 what functions and variables can be accessed by libraries and runtime
9011 outside of the link-time optimized unit.  When supported by the linker,
9012 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9013 to the compiler about used and externally visible symbols.  When
9014 the linker plugin is not available, @option{-fwhole-program} should be
9015 used to allow the compiler to make these assumptions, which leads
9016 to more aggressive optimization decisions.
9018 When @option{-fuse-linker-plugin} is not enabled, when a file is
9019 compiled with @option{-flto}, the generated object file is larger than
9020 a regular object file because it contains GIMPLE bytecodes and the usual
9021 final code (see @option{-ffat-lto-objects}.  This means that
9022 object files with LTO information can be linked as normal object
9023 files; if @option{-fno-lto} is passed to the linker, no
9024 interprocedural optimizations are applied.  Note that when
9025 @option{-fno-fat-lto-objects} is enabled the compile stage is faster
9026 but you cannot perform a regular, non-LTO link on them.
9028 Additionally, the optimization flags used to compile individual files
9029 are not necessarily related to those used at link time.  For instance,
9031 @smallexample
9032 gcc -c -O0 -ffat-lto-objects -flto foo.c
9033 gcc -c -O0 -ffat-lto-objects -flto bar.c
9034 gcc -o myprog -O3 foo.o bar.o
9035 @end smallexample
9037 This produces individual object files with unoptimized assembler
9038 code, but the resulting binary @file{myprog} is optimized at
9039 @option{-O3}.  If, instead, the final binary is generated with
9040 @option{-fno-lto}, then @file{myprog} is not optimized.
9042 When producing the final binary, GCC only
9043 applies link-time optimizations to those files that contain bytecode.
9044 Therefore, you can mix and match object files and libraries with
9045 GIMPLE bytecodes and final object code.  GCC automatically selects
9046 which files to optimize in LTO mode and which files to link without
9047 further processing.
9049 There are some code generation flags preserved by GCC when
9050 generating bytecodes, as they need to be used during the final link
9051 stage.  Generally options specified at link time override those
9052 specified at compile time.
9054 If you do not specify an optimization level option @option{-O} at
9055 link time, then GCC uses the highest optimization level 
9056 used when compiling the object files.
9058 Currently, the following options and their settings are taken from
9059 the first object file that explicitly specifies them: 
9060 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9061 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9062 and all the @option{-m} target flags.
9064 Certain ABI-changing flags are required to match in all compilation units,
9065 and trying to override this at link time with a conflicting value
9066 is ignored.  This includes options such as @option{-freg-struct-return}
9067 and @option{-fpcc-struct-return}. 
9069 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9070 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9071 are passed through to the link stage and merged conservatively for
9072 conflicting translation units.  Specifically
9073 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9074 precedence; and for example @option{-ffp-contract=off} takes precedence
9075 over @option{-ffp-contract=fast}.  You can override them at link time.
9077 If LTO encounters objects with C linkage declared with incompatible
9078 types in separate translation units to be linked together (undefined
9079 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9080 issued.  The behavior is still undefined at run time.  Similar
9081 diagnostics may be raised for other languages.
9083 Another feature of LTO is that it is possible to apply interprocedural
9084 optimizations on files written in different languages:
9086 @smallexample
9087 gcc -c -flto foo.c
9088 g++ -c -flto bar.cc
9089 gfortran -c -flto baz.f90
9090 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9091 @end smallexample
9093 Notice that the final link is done with @command{g++} to get the C++
9094 runtime libraries and @option{-lgfortran} is added to get the Fortran
9095 runtime libraries.  In general, when mixing languages in LTO mode, you
9096 should use the same link command options as when mixing languages in a
9097 regular (non-LTO) compilation.
9099 If object files containing GIMPLE bytecode are stored in a library archive, say
9100 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9101 are using a linker with plugin support.  To create static libraries suitable
9102 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9103 and @command{ranlib}; 
9104 to show the symbols of object files with GIMPLE bytecode, use
9105 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9106 and @command{nm} have been compiled with plugin support.  At link time, use the the
9107 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9108 the LTO optimization process:
9110 @smallexample
9111 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9112 @end smallexample
9114 With the linker plugin enabled, the linker extracts the needed
9115 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9116 to make them part of the aggregated GIMPLE image to be optimized.
9118 If you are not using a linker with plugin support and/or do not
9119 enable the linker plugin, then the objects inside @file{libfoo.a}
9120 are extracted and linked as usual, but they do not participate
9121 in the LTO optimization process.  In order to make a static library suitable
9122 for both LTO optimization and usual linkage, compile its object files with
9123 @option{-flto} @option{-ffat-lto-objects}.
9125 Link-time optimizations do not require the presence of the whole program to
9126 operate.  If the program does not require any symbols to be exported, it is
9127 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9128 the interprocedural optimizers to use more aggressive assumptions which may
9129 lead to improved optimization opportunities.
9130 Use of @option{-fwhole-program} is not needed when linker plugin is
9131 active (see @option{-fuse-linker-plugin}).
9133 The current implementation of LTO makes no
9134 attempt to generate bytecode that is portable between different
9135 types of hosts.  The bytecode files are versioned and there is a
9136 strict version check, so bytecode files generated in one version of
9137 GCC do not work with an older or newer version of GCC.
9139 Link-time optimization does not work well with generation of debugging
9140 information.  Combining @option{-flto} with
9141 @option{-g} is currently experimental and expected to produce unexpected
9142 results.
9144 If you specify the optional @var{n}, the optimization and code
9145 generation done at link time is executed in parallel using @var{n}
9146 parallel jobs by utilizing an installed @command{make} program.  The
9147 environment variable @env{MAKE} may be used to override the program
9148 used.  The default value for @var{n} is 1.
9150 You can also specify @option{-flto=jobserver} to use GNU make's
9151 job server mode to determine the number of parallel jobs. This
9152 is useful when the Makefile calling GCC is already executing in parallel.
9153 You must prepend a @samp{+} to the command recipe in the parent Makefile
9154 for this to work.  This option likely only works if @env{MAKE} is
9155 GNU make.
9157 @item -flto-partition=@var{alg}
9158 @opindex flto-partition
9159 Specify the partitioning algorithm used by the link-time optimizer.
9160 The value is either @samp{1to1} to specify a partitioning mirroring
9161 the original source files or @samp{balanced} to specify partitioning
9162 into equally sized chunks (whenever possible) or @samp{max} to create
9163 new partition for every symbol where possible.  Specifying @samp{none}
9164 as an algorithm disables partitioning and streaming completely. 
9165 The default value is @samp{balanced}. While @samp{1to1} can be used
9166 as an workaround for various code ordering issues, the @samp{max}
9167 partitioning is intended for internal testing only.
9168 The value @samp{one} specifies that exactly one partition should be
9169 used while the value @samp{none} bypasses partitioning and executes
9170 the link-time optimization step directly from the WPA phase.
9172 @item -flto-odr-type-merging
9173 @opindex flto-odr-type-merging
9174 Enable streaming of mangled types names of C++ types and their unification
9175 at link time.  This increases size of LTO object files, but enables
9176 diagnostics about One Definition Rule violations.
9178 @item -flto-compression-level=@var{n}
9179 @opindex flto-compression-level
9180 This option specifies the level of compression used for intermediate
9181 language written to LTO object files, and is only meaningful in
9182 conjunction with LTO mode (@option{-flto}).  Valid
9183 values are 0 (no compression) to 9 (maximum compression).  Values
9184 outside this range are clamped to either 0 or 9.  If the option is not
9185 given, a default balanced compression setting is used.
9187 @item -fuse-linker-plugin
9188 @opindex fuse-linker-plugin
9189 Enables the use of a linker plugin during link-time optimization.  This
9190 option relies on plugin support in the linker, which is available in gold
9191 or in GNU ld 2.21 or newer.
9193 This option enables the extraction of object files with GIMPLE bytecode out
9194 of library archives. This improves the quality of optimization by exposing
9195 more code to the link-time optimizer.  This information specifies what
9196 symbols can be accessed externally (by non-LTO object or during dynamic
9197 linking).  Resulting code quality improvements on binaries (and shared
9198 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9199 See @option{-flto} for a description of the effect of this flag and how to
9200 use it.
9202 This option is enabled by default when LTO support in GCC is enabled
9203 and GCC was configured for use with
9204 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9206 @item -ffat-lto-objects
9207 @opindex ffat-lto-objects
9208 Fat LTO objects are object files that contain both the intermediate language
9209 and the object code. This makes them usable for both LTO linking and normal
9210 linking. This option is effective only when compiling with @option{-flto}
9211 and is ignored at link time.
9213 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9214 requires the complete toolchain to be aware of LTO. It requires a linker with
9215 linker plugin support for basic functionality.  Additionally,
9216 @command{nm}, @command{ar} and @command{ranlib}
9217 need to support linker plugins to allow a full-featured build environment
9218 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9219 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9220 to these tools. With non fat LTO makefiles need to be modified to use them.
9222 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9223 support.
9225 @item -fcompare-elim
9226 @opindex fcompare-elim
9227 After register allocation and post-register allocation instruction splitting,
9228 identify arithmetic instructions that compute processor flags similar to a
9229 comparison operation based on that arithmetic.  If possible, eliminate the
9230 explicit comparison operation.
9232 This pass only applies to certain targets that cannot explicitly represent
9233 the comparison operation before register allocation is complete.
9235 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9237 @item -fcprop-registers
9238 @opindex fcprop-registers
9239 After register allocation and post-register allocation instruction splitting,
9240 perform a copy-propagation pass to try to reduce scheduling dependencies
9241 and occasionally eliminate the copy.
9243 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9245 @item -fprofile-correction
9246 @opindex fprofile-correction
9247 Profiles collected using an instrumented binary for multi-threaded programs may
9248 be inconsistent due to missed counter updates. When this option is specified,
9249 GCC uses heuristics to correct or smooth out such inconsistencies. By
9250 default, GCC emits an error message when an inconsistent profile is detected.
9252 @item -fprofile-use
9253 @itemx -fprofile-use=@var{path}
9254 @opindex fprofile-use
9255 Enable profile feedback-directed optimizations, 
9256 and the following optimizations
9257 which are generally profitable only with profile feedback available:
9258 @option{-fbranch-probabilities}, @option{-fvpt},
9259 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9260 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9262 Before you can use this option, you must first generate profiling information.
9263 @xref{Instrumentation Options}, for information about the
9264 @option{-fprofile-generate} option.
9266 By default, GCC emits an error message if the feedback profiles do not
9267 match the source code.  This error can be turned into a warning by using
9268 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9269 code.
9271 If @var{path} is specified, GCC looks at the @var{path} to find
9272 the profile feedback data files. See @option{-fprofile-dir}.
9274 @item -fauto-profile
9275 @itemx -fauto-profile=@var{path}
9276 @opindex fauto-profile
9277 Enable sampling-based feedback-directed optimizations, 
9278 and the following optimizations
9279 which are generally profitable only with profile feedback available:
9280 @option{-fbranch-probabilities}, @option{-fvpt},
9281 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9282 @option{-ftree-vectorize},
9283 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9284 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9285 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9287 @var{path} is the name of a file containing AutoFDO profile information.
9288 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9290 Producing an AutoFDO profile data file requires running your program
9291 with the @command{perf} utility on a supported GNU/Linux target system.
9292 For more information, see @uref{https://perf.wiki.kernel.org/}.
9294 E.g.
9295 @smallexample
9296 perf record -e br_inst_retired:near_taken -b -o perf.data \
9297     -- your_program
9298 @end smallexample
9300 Then use the @command{create_gcov} tool to convert the raw profile data
9301 to a format that can be used by GCC.@  You must also supply the 
9302 unstripped binary for your program to this tool.  
9303 See @uref{https://github.com/google/autofdo}.
9305 E.g.
9306 @smallexample
9307 create_gcov --binary=your_program.unstripped --profile=perf.data \
9308     --gcov=profile.afdo
9309 @end smallexample
9310 @end table
9312 The following options control compiler behavior regarding floating-point 
9313 arithmetic.  These options trade off between speed and
9314 correctness.  All must be specifically enabled.
9316 @table @gcctabopt
9317 @item -ffloat-store
9318 @opindex ffloat-store
9319 Do not store floating-point variables in registers, and inhibit other
9320 options that might change whether a floating-point value is taken from a
9321 register or memory.
9323 @cindex floating-point precision
9324 This option prevents undesirable excess precision on machines such as
9325 the 68000 where the floating registers (of the 68881) keep more
9326 precision than a @code{double} is supposed to have.  Similarly for the
9327 x86 architecture.  For most programs, the excess precision does only
9328 good, but a few programs rely on the precise definition of IEEE floating
9329 point.  Use @option{-ffloat-store} for such programs, after modifying
9330 them to store all pertinent intermediate computations into variables.
9332 @item -fexcess-precision=@var{style}
9333 @opindex fexcess-precision
9334 This option allows further control over excess precision on machines
9335 where floating-point operations occur in a format with more precision or
9336 range than the IEEE standard and interchange floating-point types.  By
9337 default, @option{-fexcess-precision=fast} is in effect; this means that
9338 operations may be carried out in a wider precision than the types specified
9339 in the source if that would result in faster code, and it is unpredictable
9340 when rounding to the types specified in the source code takes place.
9341 When compiling C, if @option{-fexcess-precision=standard} is specified then
9342 excess precision follows the rules specified in ISO C99; in particular,
9343 both casts and assignments cause values to be rounded to their
9344 semantic types (whereas @option{-ffloat-store} only affects
9345 assignments).  This option is enabled by default for C if a strict
9346 conformance option such as @option{-std=c99} is used.
9347 @option{-ffast-math} enables @option{-fexcess-precision=fast} by default
9348 regardless of whether a strict conformance option is used.
9350 @opindex mfpmath
9351 @option{-fexcess-precision=standard} is not implemented for languages
9352 other than C.  On the x86, it has no effect if @option{-mfpmath=sse}
9353 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9354 semantics apply without excess precision, and in the latter, rounding
9355 is unpredictable.
9357 @item -ffast-math
9358 @opindex ffast-math
9359 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9360 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9361 @option{-fno-signaling-nans}, @option{-fcx-limited-range} and
9362 @option{-fexcess-precision=fast}.
9364 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9366 This option is not turned on by any @option{-O} option besides
9367 @option{-Ofast} since it can result in incorrect output for programs
9368 that depend on an exact implementation of IEEE or ISO rules/specifications
9369 for math functions. It may, however, yield faster code for programs
9370 that do not require the guarantees of these specifications.
9372 @item -fno-math-errno
9373 @opindex fno-math-errno
9374 Do not set @code{errno} after calling math functions that are executed
9375 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9376 IEEE exceptions for math error handling may want to use this flag
9377 for speed while maintaining IEEE arithmetic compatibility.
9379 This option is not turned on by any @option{-O} option since
9380 it can result in incorrect output for programs that depend on
9381 an exact implementation of IEEE or ISO rules/specifications for
9382 math functions. It may, however, yield faster code for programs
9383 that do not require the guarantees of these specifications.
9385 The default is @option{-fmath-errno}.
9387 On Darwin systems, the math library never sets @code{errno}.  There is
9388 therefore no reason for the compiler to consider the possibility that
9389 it might, and @option{-fno-math-errno} is the default.
9391 @item -funsafe-math-optimizations
9392 @opindex funsafe-math-optimizations
9394 Allow optimizations for floating-point arithmetic that (a) assume
9395 that arguments and results are valid and (b) may violate IEEE or
9396 ANSI standards.  When used at link time, it may include libraries
9397 or startup files that change the default FPU control word or other
9398 similar optimizations.
9400 This option is not turned on by any @option{-O} option since
9401 it can result in incorrect output for programs that depend on
9402 an exact implementation of IEEE or ISO rules/specifications for
9403 math functions. It may, however, yield faster code for programs
9404 that do not require the guarantees of these specifications.
9405 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9406 @option{-fassociative-math} and @option{-freciprocal-math}.
9408 The default is @option{-fno-unsafe-math-optimizations}.
9410 @item -fassociative-math
9411 @opindex fassociative-math
9413 Allow re-association of operands in series of floating-point operations.
9414 This violates the ISO C and C++ language standard by possibly changing
9415 computation result.  NOTE: re-ordering may change the sign of zero as
9416 well as ignore NaNs and inhibit or create underflow or overflow (and
9417 thus cannot be used on code that relies on rounding behavior like
9418 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9419 and thus may not be used when ordered comparisons are required.
9420 This option requires that both @option{-fno-signed-zeros} and
9421 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9422 much sense with @option{-frounding-math}. For Fortran the option
9423 is automatically enabled when both @option{-fno-signed-zeros} and
9424 @option{-fno-trapping-math} are in effect.
9426 The default is @option{-fno-associative-math}.
9428 @item -freciprocal-math
9429 @opindex freciprocal-math
9431 Allow the reciprocal of a value to be used instead of dividing by
9432 the value if this enables optimizations.  For example @code{x / y}
9433 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9434 is subject to common subexpression elimination.  Note that this loses
9435 precision and increases the number of flops operating on the value.
9437 The default is @option{-fno-reciprocal-math}.
9439 @item -ffinite-math-only
9440 @opindex ffinite-math-only
9441 Allow optimizations for floating-point arithmetic that assume
9442 that arguments and results are not NaNs or +-Infs.
9444 This option is not turned on by any @option{-O} option since
9445 it can result in incorrect output for programs that depend on
9446 an exact implementation of IEEE or ISO rules/specifications for
9447 math functions. It may, however, yield faster code for programs
9448 that do not require the guarantees of these specifications.
9450 The default is @option{-fno-finite-math-only}.
9452 @item -fno-signed-zeros
9453 @opindex fno-signed-zeros
9454 Allow optimizations for floating-point arithmetic that ignore the
9455 signedness of zero.  IEEE arithmetic specifies the behavior of
9456 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9457 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9458 This option implies that the sign of a zero result isn't significant.
9460 The default is @option{-fsigned-zeros}.
9462 @item -fno-trapping-math
9463 @opindex fno-trapping-math
9464 Compile code assuming that floating-point operations cannot generate
9465 user-visible traps.  These traps include division by zero, overflow,
9466 underflow, inexact result and invalid operation.  This option requires
9467 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9468 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9470 This option should never be turned on by any @option{-O} option since
9471 it can result in incorrect output for programs that depend on
9472 an exact implementation of IEEE or ISO rules/specifications for
9473 math functions.
9475 The default is @option{-ftrapping-math}.
9477 @item -frounding-math
9478 @opindex frounding-math
9479 Disable transformations and optimizations that assume default floating-point
9480 rounding behavior.  This is round-to-zero for all floating point
9481 to integer conversions, and round-to-nearest for all other arithmetic
9482 truncations.  This option should be specified for programs that change
9483 the FP rounding mode dynamically, or that may be executed with a
9484 non-default rounding mode.  This option disables constant folding of
9485 floating-point expressions at compile time (which may be affected by
9486 rounding mode) and arithmetic transformations that are unsafe in the
9487 presence of sign-dependent rounding modes.
9489 The default is @option{-fno-rounding-math}.
9491 This option is experimental and does not currently guarantee to
9492 disable all GCC optimizations that are affected by rounding mode.
9493 Future versions of GCC may provide finer control of this setting
9494 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9495 will be used to specify the default state for @code{FENV_ACCESS}.
9497 @item -fsignaling-nans
9498 @opindex fsignaling-nans
9499 Compile code assuming that IEEE signaling NaNs may generate user-visible
9500 traps during floating-point operations.  Setting this option disables
9501 optimizations that may change the number of exceptions visible with
9502 signaling NaNs.  This option implies @option{-ftrapping-math}.
9504 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9505 be defined.
9507 The default is @option{-fno-signaling-nans}.
9509 This option is experimental and does not currently guarantee to
9510 disable all GCC optimizations that affect signaling NaN behavior.
9512 @item -fno-fp-int-builtin-inexact
9513 @opindex fno-fp-int-builtin-inexact
9514 Do not allow the built-in functions @code{ceil}, @code{floor},
9515 @code{round} and @code{trunc}, and their @code{float} and @code{long
9516 double} variants, to generate code that raises the ``inexact''
9517 floating-point exception for noninteger arguments.  ISO C99 and C11
9518 allow these functions to raise the ``inexact'' exception, but ISO/IEC
9519 TS 18661-1:2014, the C bindings to IEEE 754-2008, does not allow these
9520 functions to do so.
9522 The default is @option{-ffp-int-builtin-inexact}, allowing the
9523 exception to be raised.  This option does nothing unless
9524 @option{-ftrapping-math} is in effect.
9526 Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions
9527 generate a call to a library function then the ``inexact'' exception
9528 may be raised if the library implementation does not follow TS 18661.
9530 @item -fsingle-precision-constant
9531 @opindex fsingle-precision-constant
9532 Treat floating-point constants as single precision instead of
9533 implicitly converting them to double-precision constants.
9535 @item -fcx-limited-range
9536 @opindex fcx-limited-range
9537 When enabled, this option states that a range reduction step is not
9538 needed when performing complex division.  Also, there is no checking
9539 whether the result of a complex multiplication or division is @code{NaN
9540 + I*NaN}, with an attempt to rescue the situation in that case.  The
9541 default is @option{-fno-cx-limited-range}, but is enabled by
9542 @option{-ffast-math}.
9544 This option controls the default setting of the ISO C99
9545 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9546 all languages.
9548 @item -fcx-fortran-rules
9549 @opindex fcx-fortran-rules
9550 Complex multiplication and division follow Fortran rules.  Range
9551 reduction is done as part of complex division, but there is no checking
9552 whether the result of a complex multiplication or division is @code{NaN
9553 + I*NaN}, with an attempt to rescue the situation in that case.
9555 The default is @option{-fno-cx-fortran-rules}.
9557 @end table
9559 The following options control optimizations that may improve
9560 performance, but are not enabled by any @option{-O} options.  This
9561 section includes experimental options that may produce broken code.
9563 @table @gcctabopt
9564 @item -fbranch-probabilities
9565 @opindex fbranch-probabilities
9566 After running a program compiled with @option{-fprofile-arcs}
9567 (@pxref{Instrumentation Options}),
9568 you can compile it a second time using
9569 @option{-fbranch-probabilities}, to improve optimizations based on
9570 the number of times each branch was taken.  When a program
9571 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9572 counts to a file called @file{@var{sourcename}.gcda} for each source
9573 file.  The information in this data file is very dependent on the
9574 structure of the generated code, so you must use the same source code
9575 and the same optimization options for both compilations.
9577 With @option{-fbranch-probabilities}, GCC puts a
9578 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9579 These can be used to improve optimization.  Currently, they are only
9580 used in one place: in @file{reorg.c}, instead of guessing which path a
9581 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9582 exactly determine which path is taken more often.
9584 @item -fprofile-values
9585 @opindex fprofile-values
9586 If combined with @option{-fprofile-arcs}, it adds code so that some
9587 data about values of expressions in the program is gathered.
9589 With @option{-fbranch-probabilities}, it reads back the data gathered
9590 from profiling values of expressions for usage in optimizations.
9592 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9594 @item -fprofile-reorder-functions
9595 @opindex fprofile-reorder-functions
9596 Function reordering based on profile instrumentation collects
9597 first time of execution of a function and orders these functions
9598 in ascending order.
9600 Enabled with @option{-fprofile-use}.
9602 @item -fvpt
9603 @opindex fvpt
9604 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9605 to add code to gather information about values of expressions.
9607 With @option{-fbranch-probabilities}, it reads back the data gathered
9608 and actually performs the optimizations based on them.
9609 Currently the optimizations include specialization of division operations
9610 using the knowledge about the value of the denominator.
9612 @item -frename-registers
9613 @opindex frename-registers
9614 Attempt to avoid false dependencies in scheduled code by making use
9615 of registers left over after register allocation.  This optimization
9616 most benefits processors with lots of registers.  Depending on the
9617 debug information format adopted by the target, however, it can
9618 make debugging impossible, since variables no longer stay in
9619 a ``home register''.
9621 Enabled by default with @option{-funroll-loops}.
9623 @item -fschedule-fusion
9624 @opindex fschedule-fusion
9625 Performs a target dependent pass over the instruction stream to schedule
9626 instructions of same type together because target machine can execute them
9627 more efficiently if they are adjacent to each other in the instruction flow.
9629 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9631 @item -ftracer
9632 @opindex ftracer
9633 Perform tail duplication to enlarge superblock size.  This transformation
9634 simplifies the control flow of the function allowing other optimizations to do
9635 a better job.
9637 Enabled with @option{-fprofile-use}.
9639 @item -funroll-loops
9640 @opindex funroll-loops
9641 Unroll loops whose number of iterations can be determined at compile time or
9642 upon entry to the loop.  @option{-funroll-loops} implies
9643 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9644 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9645 a small constant number of iterations).  This option makes code larger, and may
9646 or may not make it run faster.
9648 Enabled with @option{-fprofile-use}.
9650 @item -funroll-all-loops
9651 @opindex funroll-all-loops
9652 Unroll all loops, even if their number of iterations is uncertain when
9653 the loop is entered.  This usually makes programs run more slowly.
9654 @option{-funroll-all-loops} implies the same options as
9655 @option{-funroll-loops}.
9657 @item -fpeel-loops
9658 @opindex fpeel-loops
9659 Peels loops for which there is enough information that they do not
9660 roll much (from profile feedback or static analysis).  It also turns on
9661 complete loop peeling (i.e.@: complete removal of loops with small constant
9662 number of iterations).
9664 Enabled with @option{-O3} and/or @option{-fprofile-use}.
9666 @item -fmove-loop-invariants
9667 @opindex fmove-loop-invariants
9668 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9669 at level @option{-O1}
9671 @item -fsplit-loops
9672 @opindex fsplit-loops
9673 Split a loop into two if it contains a condition that's always true
9674 for one side of the iteration space and false for the other.
9676 @item -funswitch-loops
9677 @opindex funswitch-loops
9678 Move branches with loop invariant conditions out of the loop, with duplicates
9679 of the loop on both branches (modified according to result of the condition).
9681 @item -ffunction-sections
9682 @itemx -fdata-sections
9683 @opindex ffunction-sections
9684 @opindex fdata-sections
9685 Place each function or data item into its own section in the output
9686 file if the target supports arbitrary sections.  The name of the
9687 function or the name of the data item determines the section's name
9688 in the output file.
9690 Use these options on systems where the linker can perform optimizations
9691 to improve locality of reference in the instruction space.  Most systems
9692 using the ELF object format and SPARC processors running Solaris 2 have
9693 linkers with such optimizations.  AIX may have these optimizations in
9694 the future.
9696 Only use these options when there are significant benefits from doing
9697 so.  When you specify these options, the assembler and linker
9698 create larger object and executable files and are also slower.
9699 You cannot use @command{gprof} on all systems if you
9700 specify this option, and you may have problems with debugging if
9701 you specify both this option and @option{-g}.
9703 @item -fbranch-target-load-optimize
9704 @opindex fbranch-target-load-optimize
9705 Perform branch target register load optimization before prologue / epilogue
9706 threading.
9707 The use of target registers can typically be exposed only during reload,
9708 thus hoisting loads out of loops and doing inter-block scheduling needs
9709 a separate optimization pass.
9711 @item -fbranch-target-load-optimize2
9712 @opindex fbranch-target-load-optimize2
9713 Perform branch target register load optimization after prologue / epilogue
9714 threading.
9716 @item -fbtr-bb-exclusive
9717 @opindex fbtr-bb-exclusive
9718 When performing branch target register load optimization, don't reuse
9719 branch target registers within any basic block.
9721 @item -fstdarg-opt
9722 @opindex fstdarg-opt
9723 Optimize the prologue of variadic argument functions with respect to usage of
9724 those arguments.
9726 @item -fsection-anchors
9727 @opindex fsection-anchors
9728 Try to reduce the number of symbolic address calculations by using
9729 shared ``anchor'' symbols to address nearby objects.  This transformation
9730 can help to reduce the number of GOT entries and GOT accesses on some
9731 targets.
9733 For example, the implementation of the following function @code{foo}:
9735 @smallexample
9736 static int a, b, c;
9737 int foo (void) @{ return a + b + c; @}
9738 @end smallexample
9740 @noindent
9741 usually calculates the addresses of all three variables, but if you
9742 compile it with @option{-fsection-anchors}, it accesses the variables
9743 from a common anchor point instead.  The effect is similar to the
9744 following pseudocode (which isn't valid C):
9746 @smallexample
9747 int foo (void)
9749   register int *xr = &x;
9750   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9752 @end smallexample
9754 Not all targets support this option.
9756 @item --param @var{name}=@var{value}
9757 @opindex param
9758 In some places, GCC uses various constants to control the amount of
9759 optimization that is done.  For example, GCC does not inline functions
9760 that contain more than a certain number of instructions.  You can
9761 control some of these constants on the command line using the
9762 @option{--param} option.
9764 The names of specific parameters, and the meaning of the values, are
9765 tied to the internals of the compiler, and are subject to change
9766 without notice in future releases.
9768 In each case, the @var{value} is an integer.  The allowable choices for
9769 @var{name} are:
9771 @table @gcctabopt
9772 @item predictable-branch-outcome
9773 When branch is predicted to be taken with probability lower than this threshold
9774 (in percent), then it is considered well predictable. The default is 10.
9776 @item max-rtl-if-conversion-insns
9777 RTL if-conversion tries to remove conditional branches around a block and
9778 replace them with conditionally executed instructions.  This parameter
9779 gives the maximum number of instructions in a block which should be
9780 considered for if-conversion.  The default is 10, though the compiler will
9781 also use other heuristics to decide whether if-conversion is likely to be
9782 profitable.
9784 @item max-rtl-if-conversion-predictable-cost
9785 @item max-rtl-if-conversion-unpredictable-cost
9786 RTL if-conversion will try to remove conditional branches around a block
9787 and replace them with conditionally executed instructions.  These parameters
9788 give the maximum permissible cost for the sequence that would be generated
9789 by if-conversion depending on whether the branch is statically determined
9790 to be predictable or not.  The units for this parameter are the same as
9791 those for the GCC internal seq_cost metric.  The compiler will try to
9792 provide a reasonable default for this parameter using the BRANCH_COST
9793 target macro.
9795 @item max-crossjump-edges
9796 The maximum number of incoming edges to consider for cross-jumping.
9797 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9798 the number of edges incoming to each block.  Increasing values mean
9799 more aggressive optimization, making the compilation time increase with
9800 probably small improvement in executable size.
9802 @item min-crossjump-insns
9803 The minimum number of instructions that must be matched at the end
9804 of two blocks before cross-jumping is performed on them.  This
9805 value is ignored in the case where all instructions in the block being
9806 cross-jumped from are matched.  The default value is 5.
9808 @item max-grow-copy-bb-insns
9809 The maximum code size expansion factor when copying basic blocks
9810 instead of jumping.  The expansion is relative to a jump instruction.
9811 The default value is 8.
9813 @item max-goto-duplication-insns
9814 The maximum number of instructions to duplicate to a block that jumps
9815 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9816 passes, GCC factors computed gotos early in the compilation process,
9817 and unfactors them as late as possible.  Only computed jumps at the
9818 end of a basic blocks with no more than max-goto-duplication-insns are
9819 unfactored.  The default value is 8.
9821 @item max-delay-slot-insn-search
9822 The maximum number of instructions to consider when looking for an
9823 instruction to fill a delay slot.  If more than this arbitrary number of
9824 instructions are searched, the time savings from filling the delay slot
9825 are minimal, so stop searching.  Increasing values mean more
9826 aggressive optimization, making the compilation time increase with probably
9827 small improvement in execution time.
9829 @item max-delay-slot-live-search
9830 When trying to fill delay slots, the maximum number of instructions to
9831 consider when searching for a block with valid live register
9832 information.  Increasing this arbitrarily chosen value means more
9833 aggressive optimization, increasing the compilation time.  This parameter
9834 should be removed when the delay slot code is rewritten to maintain the
9835 control-flow graph.
9837 @item max-gcse-memory
9838 The approximate maximum amount of memory that can be allocated in
9839 order to perform the global common subexpression elimination
9840 optimization.  If more memory than specified is required, the
9841 optimization is not done.
9843 @item max-gcse-insertion-ratio
9844 If the ratio of expression insertions to deletions is larger than this value
9845 for any expression, then RTL PRE inserts or removes the expression and thus
9846 leaves partially redundant computations in the instruction stream.  The default value is 20.
9848 @item max-pending-list-length
9849 The maximum number of pending dependencies scheduling allows
9850 before flushing the current state and starting over.  Large functions
9851 with few branches or calls can create excessively large lists which
9852 needlessly consume memory and resources.
9854 @item max-modulo-backtrack-attempts
9855 The maximum number of backtrack attempts the scheduler should make
9856 when modulo scheduling a loop.  Larger values can exponentially increase
9857 compilation time.
9859 @item max-inline-insns-single
9860 Several parameters control the tree inliner used in GCC@.
9861 This number sets the maximum number of instructions (counted in GCC's
9862 internal representation) in a single function that the tree inliner
9863 considers for inlining.  This only affects functions declared
9864 inline and methods implemented in a class declaration (C++).
9865 The default value is 400.
9867 @item max-inline-insns-auto
9868 When you use @option{-finline-functions} (included in @option{-O3}),
9869 a lot of functions that would otherwise not be considered for inlining
9870 by the compiler are investigated.  To those functions, a different
9871 (more restrictive) limit compared to functions declared inline can
9872 be applied.
9873 The default value is 40.
9875 @item inline-min-speedup
9876 When estimated performance improvement of caller + callee runtime exceeds this
9877 threshold (in percent), the function can be inlined regardless of the limit on
9878 @option{--param max-inline-insns-single} and @option{--param
9879 max-inline-insns-auto}.
9881 @item large-function-insns
9882 The limit specifying really large functions.  For functions larger than this
9883 limit after inlining, inlining is constrained by
9884 @option{--param large-function-growth}.  This parameter is useful primarily
9885 to avoid extreme compilation time caused by non-linear algorithms used by the
9886 back end.
9887 The default value is 2700.
9889 @item large-function-growth
9890 Specifies maximal growth of large function caused by inlining in percents.
9891 The default value is 100 which limits large function growth to 2.0 times
9892 the original size.
9894 @item large-unit-insns
9895 The limit specifying large translation unit.  Growth caused by inlining of
9896 units larger than this limit is limited by @option{--param inline-unit-growth}.
9897 For small units this might be too tight.
9898 For example, consider a unit consisting of function A
9899 that is inline and B that just calls A three times.  If B is small relative to
9900 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9901 large units consisting of small inlineable functions, however, the overall unit
9902 growth limit is needed to avoid exponential explosion of code size.  Thus for
9903 smaller units, the size is increased to @option{--param large-unit-insns}
9904 before applying @option{--param inline-unit-growth}.  The default is 10000.
9906 @item inline-unit-growth
9907 Specifies maximal overall growth of the compilation unit caused by inlining.
9908 The default value is 20 which limits unit growth to 1.2 times the original
9909 size. Cold functions (either marked cold via an attribute or by profile
9910 feedback) are not accounted into the unit size.
9912 @item ipcp-unit-growth
9913 Specifies maximal overall growth of the compilation unit caused by
9914 interprocedural constant propagation.  The default value is 10 which limits
9915 unit growth to 1.1 times the original size.
9917 @item large-stack-frame
9918 The limit specifying large stack frames.  While inlining the algorithm is trying
9919 to not grow past this limit too much.  The default value is 256 bytes.
9921 @item large-stack-frame-growth
9922 Specifies maximal growth of large stack frames caused by inlining in percents.
9923 The default value is 1000 which limits large stack frame growth to 11 times
9924 the original size.
9926 @item max-inline-insns-recursive
9927 @itemx max-inline-insns-recursive-auto
9928 Specifies the maximum number of instructions an out-of-line copy of a
9929 self-recursive inline
9930 function can grow into by performing recursive inlining.
9932 @option{--param max-inline-insns-recursive} applies to functions
9933 declared inline.
9934 For functions not declared inline, recursive inlining
9935 happens only when @option{-finline-functions} (included in @option{-O3}) is
9936 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
9937 default value is 450.
9939 @item max-inline-recursive-depth
9940 @itemx max-inline-recursive-depth-auto
9941 Specifies the maximum recursion depth used for recursive inlining.
9943 @option{--param max-inline-recursive-depth} applies to functions
9944 declared inline.  For functions not declared inline, recursive inlining
9945 happens only when @option{-finline-functions} (included in @option{-O3}) is
9946 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
9947 default value is 8.
9949 @item min-inline-recursive-probability
9950 Recursive inlining is profitable only for function having deep recursion
9951 in average and can hurt for function having little recursion depth by
9952 increasing the prologue size or complexity of function body to other
9953 optimizers.
9955 When profile feedback is available (see @option{-fprofile-generate}) the actual
9956 recursion depth can be guessed from the probability that function recurses
9957 via a given call expression.  This parameter limits inlining only to call
9958 expressions whose probability exceeds the given threshold (in percents).
9959 The default value is 10.
9961 @item early-inlining-insns
9962 Specify growth that the early inliner can make.  In effect it increases
9963 the amount of inlining for code having a large abstraction penalty.
9964 The default value is 14.
9966 @item max-early-inliner-iterations
9967 Limit of iterations of the early inliner.  This basically bounds
9968 the number of nested indirect calls the early inliner can resolve.
9969 Deeper chains are still handled by late inlining.
9971 @item comdat-sharing-probability
9972 Probability (in percent) that C++ inline function with comdat visibility
9973 are shared across multiple compilation units.  The default value is 20.
9975 @item profile-func-internal-id
9976 A parameter to control whether to use function internal id in profile
9977 database lookup. If the value is 0, the compiler uses an id that
9978 is based on function assembler name and filename, which makes old profile
9979 data more tolerant to source changes such as function reordering etc.
9980 The default value is 0.
9982 @item min-vect-loop-bound
9983 The minimum number of iterations under which loops are not vectorized
9984 when @option{-ftree-vectorize} is used.  The number of iterations after
9985 vectorization needs to be greater than the value specified by this option
9986 to allow vectorization.  The default value is 0.
9988 @item gcse-cost-distance-ratio
9989 Scaling factor in calculation of maximum distance an expression
9990 can be moved by GCSE optimizations.  This is currently supported only in the
9991 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9992 is with simple expressions, i.e., the expressions that have cost
9993 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9994 hoisting of simple expressions.  The default value is 10.
9996 @item gcse-unrestricted-cost
9997 Cost, roughly measured as the cost of a single typical machine
9998 instruction, at which GCSE optimizations do not constrain
9999 the distance an expression can travel.  This is currently
10000 supported only in the code hoisting pass.  The lesser the cost,
10001 the more aggressive code hoisting is.  Specifying 0 
10002 allows all expressions to travel unrestricted distances.
10003 The default value is 3.
10005 @item max-hoist-depth
10006 The depth of search in the dominator tree for expressions to hoist.
10007 This is used to avoid quadratic behavior in hoisting algorithm.
10008 The value of 0 does not limit on the search, but may slow down compilation
10009 of huge functions.  The default value is 30.
10011 @item max-tail-merge-comparisons
10012 The maximum amount of similar bbs to compare a bb with.  This is used to
10013 avoid quadratic behavior in tree tail merging.  The default value is 10.
10015 @item max-tail-merge-iterations
10016 The maximum amount of iterations of the pass over the function.  This is used to
10017 limit compilation time in tree tail merging.  The default value is 2.
10019 @item store-merging-allow-unaligned
10020 Allow the store merging pass to introduce unaligned stores if it is legal to
10021 do so.  The default value is 1.
10023 @item max-stores-to-merge
10024 The maximum number of stores to attempt to merge into wider stores in the store
10025 merging pass.  The minimum value is 2 and the default is 64.
10027 @item max-unrolled-insns
10028 The maximum number of instructions that a loop may have to be unrolled.
10029 If a loop is unrolled, this parameter also determines how many times
10030 the loop code is unrolled.
10032 @item max-average-unrolled-insns
10033 The maximum number of instructions biased by probabilities of their execution
10034 that a loop may have to be unrolled.  If a loop is unrolled,
10035 this parameter also determines how many times the loop code is unrolled.
10037 @item max-unroll-times
10038 The maximum number of unrollings of a single loop.
10040 @item max-peeled-insns
10041 The maximum number of instructions that a loop may have to be peeled.
10042 If a loop is peeled, this parameter also determines how many times
10043 the loop code is peeled.
10045 @item max-peel-times
10046 The maximum number of peelings of a single loop.
10048 @item max-peel-branches
10049 The maximum number of branches on the hot path through the peeled sequence.
10051 @item max-completely-peeled-insns
10052 The maximum number of insns of a completely peeled loop.
10054 @item max-completely-peel-times
10055 The maximum number of iterations of a loop to be suitable for complete peeling.
10057 @item max-completely-peel-loop-nest-depth
10058 The maximum depth of a loop nest suitable for complete peeling.
10060 @item max-unswitch-insns
10061 The maximum number of insns of an unswitched loop.
10063 @item max-unswitch-level
10064 The maximum number of branches unswitched in a single loop.
10066 @item max-loop-headers-insns
10067 The maximum number of insns in loop header duplicated by the copy loop headers
10068 pass.
10070 @item lim-expensive
10071 The minimum cost of an expensive expression in the loop invariant motion.
10073 @item iv-consider-all-candidates-bound
10074 Bound on number of candidates for induction variables, below which
10075 all candidates are considered for each use in induction variable
10076 optimizations.  If there are more candidates than this,
10077 only the most relevant ones are considered to avoid quadratic time complexity.
10079 @item iv-max-considered-uses
10080 The induction variable optimizations give up on loops that contain more
10081 induction variable uses.
10083 @item iv-always-prune-cand-set-bound
10084 If the number of candidates in the set is smaller than this value,
10085 always try to remove unnecessary ivs from the set
10086 when adding a new one.
10088 @item avg-loop-niter
10089 Average number of iterations of a loop.
10091 @item dse-max-object-size
10092 Maximum size (in bytes) of objects tracked bytewise by dead store elimination.
10093 Larger values may result in larger compilation times.
10095 @item scev-max-expr-size
10096 Bound on size of expressions used in the scalar evolutions analyzer.
10097 Large expressions slow the analyzer.
10099 @item scev-max-expr-complexity
10100 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10101 Complex expressions slow the analyzer.
10103 @item max-tree-if-conversion-phi-args
10104 Maximum number of arguments in a PHI supported by TREE if conversion
10105 unless the loop is marked with simd pragma.
10107 @item vect-max-version-for-alignment-checks
10108 The maximum number of run-time checks that can be performed when
10109 doing loop versioning for alignment in the vectorizer.
10111 @item vect-max-version-for-alias-checks
10112 The maximum number of run-time checks that can be performed when
10113 doing loop versioning for alias in the vectorizer.
10115 @item vect-max-peeling-for-alignment
10116 The maximum number of loop peels to enhance access alignment
10117 for vectorizer. Value -1 means no limit.
10119 @item max-iterations-to-track
10120 The maximum number of iterations of a loop the brute-force algorithm
10121 for analysis of the number of iterations of the loop tries to evaluate.
10123 @item hot-bb-count-ws-permille
10124 A basic block profile count is considered hot if it contributes to 
10125 the given permillage (i.e. 0...1000) of the entire profiled execution.
10127 @item hot-bb-frequency-fraction
10128 Select fraction of the entry block frequency of executions of basic block in
10129 function given basic block needs to have to be considered hot.
10131 @item max-predicted-iterations
10132 The maximum number of loop iterations we predict statically.  This is useful
10133 in cases where a function contains a single loop with known bound and
10134 another loop with unknown bound.
10135 The known number of iterations is predicted correctly, while
10136 the unknown number of iterations average to roughly 10.  This means that the
10137 loop without bounds appears artificially cold relative to the other one.
10139 @item builtin-expect-probability
10140 Control the probability of the expression having the specified value. This
10141 parameter takes a percentage (i.e. 0 ... 100) as input.
10142 The default probability of 90 is obtained empirically.
10144 @item align-threshold
10146 Select fraction of the maximal frequency of executions of a basic block in
10147 a function to align the basic block.
10149 @item align-loop-iterations
10151 A loop expected to iterate at least the selected number of iterations is
10152 aligned.
10154 @item tracer-dynamic-coverage
10155 @itemx tracer-dynamic-coverage-feedback
10157 This value is used to limit superblock formation once the given percentage of
10158 executed instructions is covered.  This limits unnecessary code size
10159 expansion.
10161 The @option{tracer-dynamic-coverage-feedback} parameter
10162 is used only when profile
10163 feedback is available.  The real profiles (as opposed to statically estimated
10164 ones) are much less balanced allowing the threshold to be larger value.
10166 @item tracer-max-code-growth
10167 Stop tail duplication once code growth has reached given percentage.  This is
10168 a rather artificial limit, as most of the duplicates are eliminated later in
10169 cross jumping, so it may be set to much higher values than is the desired code
10170 growth.
10172 @item tracer-min-branch-ratio
10174 Stop reverse growth when the reverse probability of best edge is less than this
10175 threshold (in percent).
10177 @item tracer-min-branch-probability
10178 @itemx tracer-min-branch-probability-feedback
10180 Stop forward growth if the best edge has probability lower than this
10181 threshold.
10183 Similarly to @option{tracer-dynamic-coverage} two parameters are
10184 provided.  @option{tracer-min-branch-probability-feedback} is used for
10185 compilation with profile feedback and @option{tracer-min-branch-probability}
10186 compilation without.  The value for compilation with profile feedback
10187 needs to be more conservative (higher) in order to make tracer
10188 effective.
10190 @item stack-clash-protection-guard-size
10191 Specify the size of the operating system provided stack guard as
10192 2 raised to @var{num} bytes.  The default value is 12 (4096 bytes).
10193 Acceptable values are between 12 and 30.  Higher values may reduce the
10194 number of explicit probes, but a value larger than the operating system
10195 provided guard will leave code vulnerable to stack clash style attacks.
10197 @item stack-clash-protection-probe-interval
10198 Stack clash protection involves probing stack space as it is allocated.  This
10199 param controls the maximum distance between probes into the stack as 2 raised
10200 to @var{num} bytes.  Acceptable values are between 10 and 16 and defaults to
10201 12.  Higher values may reduce the number of explicit probes, but a value
10202 larger than the operating system provided guard will leave code vulnerable to
10203 stack clash style attacks.
10205 @item max-cse-path-length
10207 The maximum number of basic blocks on path that CSE considers.
10208 The default is 10.
10210 @item max-cse-insns
10211 The maximum number of instructions CSE processes before flushing.
10212 The default is 1000.
10214 @item ggc-min-expand
10216 GCC uses a garbage collector to manage its own memory allocation.  This
10217 parameter specifies the minimum percentage by which the garbage
10218 collector's heap should be allowed to expand between collections.
10219 Tuning this may improve compilation speed; it has no effect on code
10220 generation.
10222 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10223 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10224 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10225 GCC is not able to calculate RAM on a particular platform, the lower
10226 bound of 30% is used.  Setting this parameter and
10227 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10228 every opportunity.  This is extremely slow, but can be useful for
10229 debugging.
10231 @item ggc-min-heapsize
10233 Minimum size of the garbage collector's heap before it begins bothering
10234 to collect garbage.  The first collection occurs after the heap expands
10235 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10236 tuning this may improve compilation speed, and has no effect on code
10237 generation.
10239 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10240 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10241 with a lower bound of 4096 (four megabytes) and an upper bound of
10242 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10243 particular platform, the lower bound is used.  Setting this parameter
10244 very large effectively disables garbage collection.  Setting this
10245 parameter and @option{ggc-min-expand} to zero causes a full collection
10246 to occur at every opportunity.
10248 @item max-reload-search-insns
10249 The maximum number of instruction reload should look backward for equivalent
10250 register.  Increasing values mean more aggressive optimization, making the
10251 compilation time increase with probably slightly better performance.
10252 The default value is 100.
10254 @item max-cselib-memory-locations
10255 The maximum number of memory locations cselib should take into account.
10256 Increasing values mean more aggressive optimization, making the compilation time
10257 increase with probably slightly better performance.  The default value is 500.
10259 @item max-sched-ready-insns
10260 The maximum number of instructions ready to be issued the scheduler should
10261 consider at any given time during the first scheduling pass.  Increasing
10262 values mean more thorough searches, making the compilation time increase
10263 with probably little benefit.  The default value is 100.
10265 @item max-sched-region-blocks
10266 The maximum number of blocks in a region to be considered for
10267 interblock scheduling.  The default value is 10.
10269 @item max-pipeline-region-blocks
10270 The maximum number of blocks in a region to be considered for
10271 pipelining in the selective scheduler.  The default value is 15.
10273 @item max-sched-region-insns
10274 The maximum number of insns in a region to be considered for
10275 interblock scheduling.  The default value is 100.
10277 @item max-pipeline-region-insns
10278 The maximum number of insns in a region to be considered for
10279 pipelining in the selective scheduler.  The default value is 200.
10281 @item min-spec-prob
10282 The minimum probability (in percents) of reaching a source block
10283 for interblock speculative scheduling.  The default value is 40.
10285 @item max-sched-extend-regions-iters
10286 The maximum number of iterations through CFG to extend regions.
10287 A value of 0 (the default) disables region extensions.
10289 @item max-sched-insn-conflict-delay
10290 The maximum conflict delay for an insn to be considered for speculative motion.
10291 The default value is 3.
10293 @item sched-spec-prob-cutoff
10294 The minimal probability of speculation success (in percents), so that
10295 speculative insns are scheduled.
10296 The default value is 40.
10298 @item sched-state-edge-prob-cutoff
10299 The minimum probability an edge must have for the scheduler to save its
10300 state across it.
10301 The default value is 10.
10303 @item sched-mem-true-dep-cost
10304 Minimal distance (in CPU cycles) between store and load targeting same
10305 memory locations.  The default value is 1.
10307 @item selsched-max-lookahead
10308 The maximum size of the lookahead window of selective scheduling.  It is a
10309 depth of search for available instructions.
10310 The default value is 50.
10312 @item selsched-max-sched-times
10313 The maximum number of times that an instruction is scheduled during
10314 selective scheduling.  This is the limit on the number of iterations
10315 through which the instruction may be pipelined.  The default value is 2.
10317 @item selsched-insns-to-rename
10318 The maximum number of best instructions in the ready list that are considered
10319 for renaming in the selective scheduler.  The default value is 2.
10321 @item sms-min-sc
10322 The minimum value of stage count that swing modulo scheduler
10323 generates.  The default value is 2.
10325 @item max-last-value-rtl
10326 The maximum size measured as number of RTLs that can be recorded in an expression
10327 in combiner for a pseudo register as last known value of that register.  The default
10328 is 10000.
10330 @item max-combine-insns
10331 The maximum number of instructions the RTL combiner tries to combine.
10332 The default value is 2 at @option{-Og} and 4 otherwise.
10334 @item integer-share-limit
10335 Small integer constants can use a shared data structure, reducing the
10336 compiler's memory usage and increasing its speed.  This sets the maximum
10337 value of a shared integer constant.  The default value is 256.
10339 @item ssp-buffer-size
10340 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10341 protection when @option{-fstack-protection} is used.
10343 @item min-size-for-stack-sharing
10344 The minimum size of variables taking part in stack slot sharing when not
10345 optimizing. The default value is 32.
10347 @item max-jump-thread-duplication-stmts
10348 Maximum number of statements allowed in a block that needs to be
10349 duplicated when threading jumps.
10351 @item max-fields-for-field-sensitive
10352 Maximum number of fields in a structure treated in
10353 a field sensitive manner during pointer analysis.  The default is zero
10354 for @option{-O0} and @option{-O1},
10355 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10357 @item prefetch-latency
10358 Estimate on average number of instructions that are executed before
10359 prefetch finishes.  The distance prefetched ahead is proportional
10360 to this constant.  Increasing this number may also lead to less
10361 streams being prefetched (see @option{simultaneous-prefetches}).
10363 @item simultaneous-prefetches
10364 Maximum number of prefetches that can run at the same time.
10366 @item l1-cache-line-size
10367 The size of cache line in L1 cache, in bytes.
10369 @item l1-cache-size
10370 The size of L1 cache, in kilobytes.
10372 @item l2-cache-size
10373 The size of L2 cache, in kilobytes.
10375 @item min-insn-to-prefetch-ratio
10376 The minimum ratio between the number of instructions and the
10377 number of prefetches to enable prefetching in a loop.
10379 @item prefetch-min-insn-to-mem-ratio
10380 The minimum ratio between the number of instructions and the
10381 number of memory references to enable prefetching in a loop.
10383 @item use-canonical-types
10384 Whether the compiler should use the ``canonical'' type system.  By
10385 default, this should always be 1, which uses a more efficient internal
10386 mechanism for comparing types in C++ and Objective-C++.  However, if
10387 bugs in the canonical type system are causing compilation failures,
10388 set this value to 0 to disable canonical types.
10390 @item switch-conversion-max-branch-ratio
10391 Switch initialization conversion refuses to create arrays that are
10392 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10393 branches in the switch.
10395 @item max-partial-antic-length
10396 Maximum length of the partial antic set computed during the tree
10397 partial redundancy elimination optimization (@option{-ftree-pre}) when
10398 optimizing at @option{-O3} and above.  For some sorts of source code
10399 the enhanced partial redundancy elimination optimization can run away,
10400 consuming all of the memory available on the host machine.  This
10401 parameter sets a limit on the length of the sets that are computed,
10402 which prevents the runaway behavior.  Setting a value of 0 for
10403 this parameter allows an unlimited set length.
10405 @item sccvn-max-scc-size
10406 Maximum size of a strongly connected component (SCC) during SCCVN
10407 processing.  If this limit is hit, SCCVN processing for the whole
10408 function is not done and optimizations depending on it are
10409 disabled.  The default maximum SCC size is 10000.
10411 @item sccvn-max-alias-queries-per-access
10412 Maximum number of alias-oracle queries we perform when looking for
10413 redundancies for loads and stores.  If this limit is hit the search
10414 is aborted and the load or store is not considered redundant.  The
10415 number of queries is algorithmically limited to the number of
10416 stores on all paths from the load to the function entry.
10417 The default maximum number of queries is 1000.
10419 @item ira-max-loops-num
10420 IRA uses regional register allocation by default.  If a function
10421 contains more loops than the number given by this parameter, only at most
10422 the given number of the most frequently-executed loops form regions
10423 for regional register allocation.  The default value of the
10424 parameter is 100.
10426 @item ira-max-conflict-table-size 
10427 Although IRA uses a sophisticated algorithm to compress the conflict
10428 table, the table can still require excessive amounts of memory for
10429 huge functions.  If the conflict table for a function could be more
10430 than the size in MB given by this parameter, the register allocator
10431 instead uses a faster, simpler, and lower-quality
10432 algorithm that does not require building a pseudo-register conflict table.  
10433 The default value of the parameter is 2000.
10435 @item ira-loop-reserved-regs
10436 IRA can be used to evaluate more accurate register pressure in loops
10437 for decisions to move loop invariants (see @option{-O3}).  The number
10438 of available registers reserved for some other purposes is given
10439 by this parameter.  The default value of the parameter is 2, which is
10440 the minimal number of registers needed by typical instructions.
10441 This value is the best found from numerous experiments.
10443 @item lra-inheritance-ebb-probability-cutoff
10444 LRA tries to reuse values reloaded in registers in subsequent insns.
10445 This optimization is called inheritance.  EBB is used as a region to
10446 do this optimization.  The parameter defines a minimal fall-through
10447 edge probability in percentage used to add BB to inheritance EBB in
10448 LRA.  The default value of the parameter is 40.  The value was chosen
10449 from numerous runs of SPEC2000 on x86-64.
10451 @item loop-invariant-max-bbs-in-loop
10452 Loop invariant motion can be very expensive, both in compilation time and
10453 in amount of needed compile-time memory, with very large loops.  Loops
10454 with more basic blocks than this parameter won't have loop invariant
10455 motion optimization performed on them.  The default value of the
10456 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10458 @item loop-max-datarefs-for-datadeps
10459 Building data dependencies is expensive for very large loops.  This
10460 parameter limits the number of data references in loops that are
10461 considered for data dependence analysis.  These large loops are no
10462 handled by the optimizations using loop data dependencies.
10463 The default value is 1000.
10465 @item max-vartrack-size
10466 Sets a maximum number of hash table slots to use during variable
10467 tracking dataflow analysis of any function.  If this limit is exceeded
10468 with variable tracking at assignments enabled, analysis for that
10469 function is retried without it, after removing all debug insns from
10470 the function.  If the limit is exceeded even without debug insns, var
10471 tracking analysis is completely disabled for the function.  Setting
10472 the parameter to zero makes it unlimited.
10474 @item max-vartrack-expr-depth
10475 Sets a maximum number of recursion levels when attempting to map
10476 variable names or debug temporaries to value expressions.  This trades
10477 compilation time for more complete debug information.  If this is set too
10478 low, value expressions that are available and could be represented in
10479 debug information may end up not being used; setting this higher may
10480 enable the compiler to find more complex debug expressions, but compile
10481 time and memory use may grow.  The default is 12.
10483 @item min-nondebug-insn-uid
10484 Use uids starting at this parameter for nondebug insns.  The range below
10485 the parameter is reserved exclusively for debug insns created by
10486 @option{-fvar-tracking-assignments}, but debug insns may get
10487 (non-overlapping) uids above it if the reserved range is exhausted.
10489 @item ipa-sra-ptr-growth-factor
10490 IPA-SRA replaces a pointer to an aggregate with one or more new
10491 parameters only when their cumulative size is less or equal to
10492 @option{ipa-sra-ptr-growth-factor} times the size of the original
10493 pointer parameter.
10495 @item sra-max-scalarization-size-Ospeed
10496 @item sra-max-scalarization-size-Osize
10497 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10498 replace scalar parts of aggregates with uses of independent scalar
10499 variables.  These parameters control the maximum size, in storage units,
10500 of aggregate which is considered for replacement when compiling for
10501 speed
10502 (@option{sra-max-scalarization-size-Ospeed}) or size
10503 (@option{sra-max-scalarization-size-Osize}) respectively.
10505 @item tm-max-aggregate-size
10506 When making copies of thread-local variables in a transaction, this
10507 parameter specifies the size in bytes after which variables are
10508 saved with the logging functions as opposed to save/restore code
10509 sequence pairs.  This option only applies when using
10510 @option{-fgnu-tm}.
10512 @item graphite-max-nb-scop-params
10513 To avoid exponential effects in the Graphite loop transforms, the
10514 number of parameters in a Static Control Part (SCoP) is bounded.  The
10515 default value is 10 parameters.  A variable whose value is unknown at
10516 compilation time and defined outside a SCoP is a parameter of the SCoP.
10518 @item graphite-max-bbs-per-function
10519 To avoid exponential effects in the detection of SCoPs, the size of
10520 the functions analyzed by Graphite is bounded.  The default value is
10521 100 basic blocks.
10523 @item loop-block-tile-size
10524 Loop blocking or strip mining transforms, enabled with
10525 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10526 loop in the loop nest by a given number of iterations.  The strip
10527 length can be changed using the @option{loop-block-tile-size}
10528 parameter.  The default value is 51 iterations.
10530 @item loop-unroll-jam-size
10531 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10532 default value is 4.
10534 @item loop-unroll-jam-depth
10535 Specify the dimension to be unrolled (counting from the most inner loop)
10536 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10538 @item ipa-cp-value-list-size
10539 IPA-CP attempts to track all possible values and types passed to a function's
10540 parameter in order to propagate them and perform devirtualization.
10541 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10542 stores per one formal parameter of a function.
10544 @item ipa-cp-eval-threshold
10545 IPA-CP calculates its own score of cloning profitability heuristics
10546 and performs those cloning opportunities with scores that exceed
10547 @option{ipa-cp-eval-threshold}.
10549 @item ipa-cp-recursion-penalty
10550 Percentage penalty the recursive functions will receive when they
10551 are evaluated for cloning.
10553 @item ipa-cp-single-call-penalty
10554 Percentage penalty functions containing a single call to another
10555 function will receive when they are evaluated for cloning.
10558 @item ipa-max-agg-items
10559 IPA-CP is also capable to propagate a number of scalar values passed
10560 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10561 number of such values per one parameter.
10563 @item ipa-cp-loop-hint-bonus
10564 When IPA-CP determines that a cloning candidate would make the number
10565 of iterations of a loop known, it adds a bonus of
10566 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10567 the candidate.
10569 @item ipa-cp-array-index-hint-bonus
10570 When IPA-CP determines that a cloning candidate would make the index of
10571 an array access known, it adds a bonus of
10572 @option{ipa-cp-array-index-hint-bonus} to the profitability
10573 score of the candidate.
10575 @item ipa-max-aa-steps
10576 During its analysis of function bodies, IPA-CP employs alias analysis
10577 in order to track values pointed to by function parameters.  In order
10578 not spend too much time analyzing huge functions, it gives up and
10579 consider all memory clobbered after examining
10580 @option{ipa-max-aa-steps} statements modifying memory.
10582 @item lto-partitions
10583 Specify desired number of partitions produced during WHOPR compilation.
10584 The number of partitions should exceed the number of CPUs used for compilation.
10585 The default value is 32.
10587 @item lto-min-partition
10588 Size of minimal partition for WHOPR (in estimated instructions).
10589 This prevents expenses of splitting very small programs into too many
10590 partitions.
10592 @item lto-max-partition
10593 Size of max partition for WHOPR (in estimated instructions).
10594 to provide an upper bound for individual size of partition.
10595 Meant to be used only with balanced partitioning.
10597 @item cxx-max-namespaces-for-diagnostic-help
10598 The maximum number of namespaces to consult for suggestions when C++
10599 name lookup fails for an identifier.  The default is 1000.
10601 @item sink-frequency-threshold
10602 The maximum relative execution frequency (in percents) of the target block
10603 relative to a statement's original block to allow statement sinking of a
10604 statement.  Larger numbers result in more aggressive statement sinking.
10605 The default value is 75.  A small positive adjustment is applied for
10606 statements with memory operands as those are even more profitable so sink.
10608 @item max-stores-to-sink
10609 The maximum number of conditional store pairs that can be sunk.  Set to 0
10610 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10611 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10613 @item allow-store-data-races
10614 Allow optimizers to introduce new data races on stores.
10615 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10616 at optimization level @option{-Ofast}.
10618 @item case-values-threshold
10619 The smallest number of different values for which it is best to use a
10620 jump-table instead of a tree of conditional branches.  If the value is
10621 0, use the default for the machine.  The default is 0.
10623 @item tree-reassoc-width
10624 Set the maximum number of instructions executed in parallel in
10625 reassociated tree. This parameter overrides target dependent
10626 heuristics used by default if has non zero value.
10628 @item sched-pressure-algorithm
10629 Choose between the two available implementations of
10630 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10631 and is the more likely to prevent instructions from being reordered.
10632 Algorithm 2 was designed to be a compromise between the relatively
10633 conservative approach taken by algorithm 1 and the rather aggressive
10634 approach taken by the default scheduler.  It relies more heavily on
10635 having a regular register file and accurate register pressure classes.
10636 See @file{haifa-sched.c} in the GCC sources for more details.
10638 The default choice depends on the target.
10640 @item max-slsr-cand-scan
10641 Set the maximum number of existing candidates that are considered when
10642 seeking a basis for a new straight-line strength reduction candidate.
10644 @item asan-globals
10645 Enable buffer overflow detection for global objects.  This kind
10646 of protection is enabled by default if you are using
10647 @option{-fsanitize=address} option.
10648 To disable global objects protection use @option{--param asan-globals=0}.
10650 @item asan-stack
10651 Enable buffer overflow detection for stack objects.  This kind of
10652 protection is enabled by default when using @option{-fsanitize=address}.
10653 To disable stack protection use @option{--param asan-stack=0} option.
10655 @item asan-instrument-reads
10656 Enable buffer overflow detection for memory reads.  This kind of
10657 protection is enabled by default when using @option{-fsanitize=address}.
10658 To disable memory reads protection use
10659 @option{--param asan-instrument-reads=0}.
10661 @item asan-instrument-writes
10662 Enable buffer overflow detection for memory writes.  This kind of
10663 protection is enabled by default when using @option{-fsanitize=address}.
10664 To disable memory writes protection use
10665 @option{--param asan-instrument-writes=0} option.
10667 @item asan-memintrin
10668 Enable detection for built-in functions.  This kind of protection
10669 is enabled by default when using @option{-fsanitize=address}.
10670 To disable built-in functions protection use
10671 @option{--param asan-memintrin=0}.
10673 @item asan-use-after-return
10674 Enable detection of use-after-return.  This kind of protection
10675 is enabled by default when using the @option{-fsanitize=address} option.
10676 To disable it use @option{--param asan-use-after-return=0}.
10678 Note: By default the check is disabled at run time.  To enable it,
10679 add @code{detect_stack_use_after_return=1} to the environment variable
10680 @env{ASAN_OPTIONS}.
10682 @item asan-instrumentation-with-call-threshold
10683 If number of memory accesses in function being instrumented
10684 is greater or equal to this number, use callbacks instead of inline checks.
10685 E.g. to disable inline code use
10686 @option{--param asan-instrumentation-with-call-threshold=0}.
10688 @item use-after-scope-direct-emission-threshold
10689 If the size of a local variable in bytes is smaller or equal to this
10690 number, directly poison (or unpoison) shadow memory instead of using
10691 run-time callbacks.  The default value is 256.
10693 @item chkp-max-ctor-size
10694 Static constructors generated by Pointer Bounds Checker may become very
10695 large and significantly increase compile time at optimization level
10696 @option{-O1} and higher.  This parameter is a maximum number of statements
10697 in a single generated constructor.  Default value is 5000.
10699 @item max-fsm-thread-path-insns
10700 Maximum number of instructions to copy when duplicating blocks on a
10701 finite state automaton jump thread path.  The default is 100.
10703 @item max-fsm-thread-length
10704 Maximum number of basic blocks on a finite state automaton jump thread
10705 path.  The default is 10.
10707 @item max-fsm-thread-paths
10708 Maximum number of new jump thread paths to create for a finite state
10709 automaton.  The default is 50.
10711 @item parloops-chunk-size
10712 Chunk size of omp schedule for loops parallelized by parloops.  The default
10713 is 0.
10715 @item parloops-schedule
10716 Schedule type of omp schedule for loops parallelized by parloops (static,
10717 dynamic, guided, auto, runtime).  The default is static.
10719 @item max-ssa-name-query-depth
10720 Maximum depth of recursion when querying properties of SSA names in things
10721 like fold routines.  One level of recursion corresponds to following a
10722 use-def chain.
10724 @item hsa-gen-debug-stores
10725 Enable emission of special debug stores within HSA kernels which are
10726 then read and reported by libgomp plugin.  Generation of these stores
10727 is disabled by default, use @option{--param hsa-gen-debug-stores=1} to
10728 enable it.
10730 @item max-speculative-devirt-maydefs
10731 The maximum number of may-defs we analyze when looking for a must-def
10732 specifying the dynamic type of an object that invokes a virtual call
10733 we may be able to devirtualize speculatively.
10735 @item max-vrp-switch-assertions
10736 The maximum number of assertions to add along the default edge of a switch
10737 statement during VRP.  The default is 10.
10738 @end table
10739 @end table
10741 @node Instrumentation Options
10742 @section Program Instrumentation Options
10743 @cindex instrumentation options
10744 @cindex program instrumentation options
10745 @cindex run-time error checking options
10746 @cindex profiling options
10747 @cindex options, program instrumentation
10748 @cindex options, run-time error checking
10749 @cindex options, profiling
10751 GCC supports a number of command-line options that control adding
10752 run-time instrumentation to the code it normally generates.  
10753 For example, one purpose of instrumentation is collect profiling
10754 statistics for use in finding program hot spots, code coverage
10755 analysis, or profile-guided optimizations.
10756 Another class of program instrumentation is adding run-time checking 
10757 to detect programming errors like invalid pointer
10758 dereferences or out-of-bounds array accesses, as well as deliberately
10759 hostile attacks such as stack smashing or C++ vtable hijacking.
10760 There is also a general hook which can be used to implement other
10761 forms of tracing or function-level instrumentation for debug or
10762 program analysis purposes.
10764 @table @gcctabopt
10765 @cindex @command{prof}
10766 @item -p
10767 @opindex p
10768 Generate extra code to write profile information suitable for the
10769 analysis program @command{prof}.  You must use this option when compiling
10770 the source files you want data about, and you must also use it when
10771 linking.
10773 @cindex @command{gprof}
10774 @item -pg
10775 @opindex pg
10776 Generate extra code to write profile information suitable for the
10777 analysis program @command{gprof}.  You must use this option when compiling
10778 the source files you want data about, and you must also use it when
10779 linking.
10781 @item -fprofile-arcs
10782 @opindex fprofile-arcs
10783 Add code so that program flow @dfn{arcs} are instrumented.  During
10784 execution the program records how many times each branch and call is
10785 executed and how many times it is taken or returns.  On targets that support
10786 constructors with priority support, profiling properly handles constructors,
10787 destructors and C++ constructors (and destructors) of classes which are used
10788 as a type of a global variable.
10790 When the compiled
10791 program exits it saves this data to a file called
10792 @file{@var{auxname}.gcda} for each source file.  The data may be used for
10793 profile-directed optimizations (@option{-fbranch-probabilities}), or for
10794 test coverage analysis (@option{-ftest-coverage}).  Each object file's
10795 @var{auxname} is generated from the name of the output file, if
10796 explicitly specified and it is not the final executable, otherwise it is
10797 the basename of the source file.  In both cases any suffix is removed
10798 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
10799 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
10800 @xref{Cross-profiling}.
10802 @cindex @command{gcov}
10803 @item --coverage
10804 @opindex coverage
10806 This option is used to compile and link code instrumented for coverage
10807 analysis.  The option is a synonym for @option{-fprofile-arcs}
10808 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
10809 linking).  See the documentation for those options for more details.
10811 @itemize
10813 @item
10814 Compile the source files with @option{-fprofile-arcs} plus optimization
10815 and code generation options.  For test coverage analysis, use the
10816 additional @option{-ftest-coverage} option.  You do not need to profile
10817 every source file in a program.
10819 @item
10820 Compile the source files additionally with @option{-fprofile-abs-path}
10821 to create absolute path names in the @file{.gcno} files.  This allows
10822 @command{gcov} to find the correct sources in projects where compilations
10823 occur with different working directories.
10825 @item
10826 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
10827 (the latter implies the former).
10829 @item
10830 Run the program on a representative workload to generate the arc profile
10831 information.  This may be repeated any number of times.  You can run
10832 concurrent instances of your program, and provided that the file system
10833 supports locking, the data files will be correctly updated.  Also
10834 @code{fork} calls are detected and correctly handled (double counting
10835 will not happen).
10837 @item
10838 For profile-directed optimizations, compile the source files again with
10839 the same optimization and code generation options plus
10840 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
10841 Control Optimization}).
10843 @item
10844 For test coverage analysis, use @command{gcov} to produce human readable
10845 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
10846 @command{gcov} documentation for further information.
10848 @end itemize
10850 With @option{-fprofile-arcs}, for each function of your program GCC
10851 creates a program flow graph, then finds a spanning tree for the graph.
10852 Only arcs that are not on the spanning tree have to be instrumented: the
10853 compiler adds code to count the number of times that these arcs are
10854 executed.  When an arc is the only exit or only entrance to a block, the
10855 instrumentation code can be added to the block; otherwise, a new basic
10856 block must be created to hold the instrumentation code.
10858 @need 2000
10859 @item -ftest-coverage
10860 @opindex ftest-coverage
10861 Produce a notes file that the @command{gcov} code-coverage utility
10862 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
10863 show program coverage.  Each source file's note file is called
10864 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
10865 above for a description of @var{auxname} and instructions on how to
10866 generate test coverage data.  Coverage data matches the source files
10867 more closely if you do not optimize.
10869 @item -fprofile-abs-path
10870 @opindex fprofile-abs-path
10871 Automatically convert relative source file names to absolute path names
10872 in the @file{.gcno} files.  This allows @command{gcov} to find the correct
10873 sources in projects where compilations occur with different working
10874 directories.
10876 @item -fprofile-dir=@var{path}
10877 @opindex fprofile-dir
10879 Set the directory to search for the profile data files in to @var{path}.
10880 This option affects only the profile data generated by
10881 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
10882 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
10883 and its related options.  Both absolute and relative paths can be used.
10884 By default, GCC uses the current directory as @var{path}, thus the
10885 profile data file appears in the same directory as the object file.
10887 @item -fprofile-generate
10888 @itemx -fprofile-generate=@var{path}
10889 @opindex fprofile-generate
10891 Enable options usually used for instrumenting application to produce
10892 profile useful for later recompilation with profile feedback based
10893 optimization.  You must use @option{-fprofile-generate} both when
10894 compiling and when linking your program.
10896 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
10898 If @var{path} is specified, GCC looks at the @var{path} to find
10899 the profile feedback data files. See @option{-fprofile-dir}.
10901 To optimize the program based on the collected profile information, use
10902 @option{-fprofile-use}.  @xref{Optimize Options}, for more information.
10904 @item -fprofile-update=@var{method}
10905 @opindex fprofile-update
10907 Alter the update method for an application instrumented for profile
10908 feedback based optimization.  The @var{method} argument should be one of
10909 @samp{single}, @samp{atomic} or @samp{prefer-atomic}.
10910 The first one is useful for single-threaded applications,
10911 while the second one prevents profile corruption by emitting thread-safe code.
10913 @strong{Warning:} When an application does not properly join all threads
10914 (or creates an detached thread), a profile file can be still corrupted.
10916 Using @samp{prefer-atomic} would be transformed either to @samp{atomic},
10917 when supported by a target, or to @samp{single} otherwise.  The GCC driver
10918 automatically selects @samp{prefer-atomic} when @option{-pthread}
10919 is present in the command line.
10921 @item -fsanitize=address
10922 @opindex fsanitize=address
10923 Enable AddressSanitizer, a fast memory error detector.
10924 Memory access instructions are instrumented to detect
10925 out-of-bounds and use-after-free bugs.
10926 The option enables @option{-fsanitize-address-use-after-scope}.
10927 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
10928 more details.  The run-time behavior can be influenced using the
10929 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
10930 the available options are shown at startup of the instrumented program.  See
10931 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
10932 for a list of supported options.
10933 The option cannot be combined with @option{-fsanitize=thread}
10934 and/or @option{-fcheck-pointer-bounds}.
10936 @item -fsanitize=kernel-address
10937 @opindex fsanitize=kernel-address
10938 Enable AddressSanitizer for Linux kernel.
10939 See @uref{https://github.com/google/kasan/wiki} for more details.
10940 The option cannot be combined with @option{-fcheck-pointer-bounds}.
10942 @item -fsanitize=thread
10943 @opindex fsanitize=thread
10944 Enable ThreadSanitizer, a fast data race detector.
10945 Memory access instructions are instrumented to detect
10946 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
10947 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
10948 environment variable; see
10949 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
10950 supported options.
10951 The option cannot be combined with @option{-fsanitize=address},
10952 @option{-fsanitize=leak} and/or @option{-fcheck-pointer-bounds}.
10954 Note that sanitized atomic builtins cannot throw exceptions when
10955 operating on invalid memory addresses with non-call exceptions
10956 (@option{-fnon-call-exceptions}).
10958 @item -fsanitize=leak
10959 @opindex fsanitize=leak
10960 Enable LeakSanitizer, a memory leak detector.
10961 This option only matters for linking of executables and
10962 the executable is linked against a library that overrides @code{malloc}
10963 and other allocator functions.  See
10964 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
10965 details.  The run-time behavior can be influenced using the
10966 @env{LSAN_OPTIONS} environment variable.
10967 The option cannot be combined with @option{-fsanitize=thread}.
10969 @item -fsanitize=undefined
10970 @opindex fsanitize=undefined
10971 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
10972 Various computations are instrumented to detect undefined behavior
10973 at runtime.  Current suboptions are:
10975 @table @gcctabopt
10977 @item -fsanitize=shift
10978 @opindex fsanitize=shift
10979 This option enables checking that the result of a shift operation is
10980 not undefined.  Note that what exactly is considered undefined differs
10981 slightly between C and C++, as well as between ISO C90 and C99, etc.
10982 This option has two suboptions, @option{-fsanitize=shift-base} and
10983 @option{-fsanitize=shift-exponent}.
10985 @item -fsanitize=shift-exponent
10986 @opindex fsanitize=shift-exponent
10987 This option enables checking that the second argument of a shift operation
10988 is not negative and is smaller than the precision of the promoted first
10989 argument.
10991 @item -fsanitize=shift-base
10992 @opindex fsanitize=shift-base
10993 If the second argument of a shift operation is within range, check that the
10994 result of a shift operation is not undefined.  Note that what exactly is
10995 considered undefined differs slightly between C and C++, as well as between
10996 ISO C90 and C99, etc.
10998 @item -fsanitize=integer-divide-by-zero
10999 @opindex fsanitize=integer-divide-by-zero
11000 Detect integer division by zero as well as @code{INT_MIN / -1} division.
11002 @item -fsanitize=unreachable
11003 @opindex fsanitize=unreachable
11004 With this option, the compiler turns the @code{__builtin_unreachable}
11005 call into a diagnostics message call instead.  When reaching the
11006 @code{__builtin_unreachable} call, the behavior is undefined.
11008 @item -fsanitize=vla-bound
11009 @opindex fsanitize=vla-bound
11010 This option instructs the compiler to check that the size of a variable
11011 length array is positive.
11013 @item -fsanitize=null
11014 @opindex fsanitize=null
11015 This option enables pointer checking.  Particularly, the application
11016 built with this option turned on will issue an error message when it
11017 tries to dereference a NULL pointer, or if a reference (possibly an
11018 rvalue reference) is bound to a NULL pointer, or if a method is invoked
11019 on an object pointed by a NULL pointer.
11021 @item -fsanitize=return
11022 @opindex fsanitize=return
11023 This option enables return statement checking.  Programs
11024 built with this option turned on will issue an error message
11025 when the end of a non-void function is reached without actually
11026 returning a value.  This option works in C++ only.
11028 @item -fsanitize=signed-integer-overflow
11029 @opindex fsanitize=signed-integer-overflow
11030 This option enables signed integer overflow checking.  We check that
11031 the result of @code{+}, @code{*}, and both unary and binary @code{-}
11032 does not overflow in the signed arithmetics.  Note, integer promotion
11033 rules must be taken into account.  That is, the following is not an
11034 overflow:
11035 @smallexample
11036 signed char a = SCHAR_MAX;
11037 a++;
11038 @end smallexample
11040 @item -fsanitize=bounds
11041 @opindex fsanitize=bounds
11042 This option enables instrumentation of array bounds.  Various out of bounds
11043 accesses are detected.  Flexible array members, flexible array member-like
11044 arrays, and initializers of variables with static storage are not instrumented.
11045 The option cannot be combined with @option{-fcheck-pointer-bounds}.
11047 @item -fsanitize=bounds-strict
11048 @opindex fsanitize=bounds-strict
11049 This option enables strict instrumentation of array bounds.  Most out of bounds
11050 accesses are detected, including flexible array members and flexible array
11051 member-like arrays.  Initializers of variables with static storage are not
11052 instrumented.  The option cannot be combined
11053 with @option{-fcheck-pointer-bounds}.
11055 @item -fsanitize=alignment
11056 @opindex fsanitize=alignment
11058 This option enables checking of alignment of pointers when they are
11059 dereferenced, or when a reference is bound to insufficiently aligned target,
11060 or when a method or constructor is invoked on insufficiently aligned object.
11062 @item -fsanitize=object-size
11063 @opindex fsanitize=object-size
11064 This option enables instrumentation of memory references using the
11065 @code{__builtin_object_size} function.  Various out of bounds pointer
11066 accesses are detected.
11068 @item -fsanitize=float-divide-by-zero
11069 @opindex fsanitize=float-divide-by-zero
11070 Detect floating-point division by zero.  Unlike other similar options,
11071 @option{-fsanitize=float-divide-by-zero} is not enabled by
11072 @option{-fsanitize=undefined}, since floating-point division by zero can
11073 be a legitimate way of obtaining infinities and NaNs.
11075 @item -fsanitize=float-cast-overflow
11076 @opindex fsanitize=float-cast-overflow
11077 This option enables floating-point type to integer conversion checking.
11078 We check that the result of the conversion does not overflow.
11079 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
11080 not enabled by @option{-fsanitize=undefined}.
11081 This option does not work well with @code{FE_INVALID} exceptions enabled.
11083 @item -fsanitize=nonnull-attribute
11084 @opindex fsanitize=nonnull-attribute
11086 This option enables instrumentation of calls, checking whether null values
11087 are not passed to arguments marked as requiring a non-null value by the
11088 @code{nonnull} function attribute.
11090 @item -fsanitize=returns-nonnull-attribute
11091 @opindex fsanitize=returns-nonnull-attribute
11093 This option enables instrumentation of return statements in functions
11094 marked with @code{returns_nonnull} function attribute, to detect returning
11095 of null values from such functions.
11097 @item -fsanitize=bool
11098 @opindex fsanitize=bool
11100 This option enables instrumentation of loads from bool.  If a value other
11101 than 0/1 is loaded, a run-time error is issued.
11103 @item -fsanitize=enum
11104 @opindex fsanitize=enum
11106 This option enables instrumentation of loads from an enum type.  If
11107 a value outside the range of values for the enum type is loaded,
11108 a run-time error is issued.
11110 @item -fsanitize=vptr
11111 @opindex fsanitize=vptr
11113 This option enables instrumentation of C++ member function calls, member
11114 accesses and some conversions between pointers to base and derived classes,
11115 to verify the referenced object has the correct dynamic type.
11117 @item -fsanitize=pointer-overflow
11118 @opindex fsanitize=pointer-overflow
11120 This option enables instrumentation of pointer arithmetics.  If the pointer
11121 arithmetics overflows, a run-time error is issued.
11123 @end table
11125 While @option{-ftrapv} causes traps for signed overflows to be emitted,
11126 @option{-fsanitize=undefined} gives a diagnostic message.
11127 This currently works only for the C family of languages.
11129 @item -fno-sanitize=all
11130 @opindex fno-sanitize=all
11132 This option disables all previously enabled sanitizers.
11133 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
11134 together.
11136 @item -fasan-shadow-offset=@var{number}
11137 @opindex fasan-shadow-offset
11138 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
11139 It is useful for experimenting with different shadow memory layouts in
11140 Kernel AddressSanitizer.
11142 @item -fsanitize-sections=@var{s1},@var{s2},...
11143 @opindex fsanitize-sections
11144 Sanitize global variables in selected user-defined sections.  @var{si} may
11145 contain wildcards.
11147 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
11148 @opindex fsanitize-recover
11149 @opindex fno-sanitize-recover
11150 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
11151 mentioned in comma-separated list of @var{opts}.  Enabling this option
11152 for a sanitizer component causes it to attempt to continue
11153 running the program as if no error happened.  This means multiple
11154 runtime errors can be reported in a single program run, and the exit
11155 code of the program may indicate success even when errors
11156 have been reported.  The @option{-fno-sanitize-recover=} option
11157 can be used to alter
11158 this behavior: only the first detected error is reported
11159 and program then exits with a non-zero exit code.
11161 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
11162 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
11163 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero},
11164 @option{-fsanitize=bounds-strict},
11165 @option{-fsanitize=kernel-address} and @option{-fsanitize=address}.
11166 For these sanitizers error recovery is turned on by default,
11167 except @option{-fsanitize=address}, for which this feature is experimental.
11168 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
11169 accepted, the former enables recovery for all sanitizers that support it,
11170 the latter disables recovery for all sanitizers that support it.
11172 Even if a recovery mode is turned on the compiler side, it needs to be also
11173 enabled on the runtime library side, otherwise the failures are still fatal.
11174 The runtime library defaults to @code{halt_on_error=0} for
11175 ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for
11176 AddressSanitizer is @code{halt_on_error=1}. This can be overridden through
11177 setting the @code{halt_on_error} flag in the corresponding environment variable.
11179 Syntax without an explicit @var{opts} parameter is deprecated.  It is
11180 equivalent to specifying an @var{opts} list of:
11182 @smallexample
11183 undefined,float-cast-overflow,float-divide-by-zero,bounds-strict
11184 @end smallexample
11186 @item -fsanitize-address-use-after-scope
11187 @opindex fsanitize-address-use-after-scope
11188 Enable sanitization of local variables to detect use-after-scope bugs.
11189 The option sets @option{-fstack-reuse} to @samp{none}.
11191 @item -fsanitize-undefined-trap-on-error
11192 @opindex fsanitize-undefined-trap-on-error
11193 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
11194 report undefined behavior using @code{__builtin_trap} rather than
11195 a @code{libubsan} library routine.  The advantage of this is that the
11196 @code{libubsan} library is not needed and is not linked in, so this
11197 is usable even in freestanding environments.
11199 @item -fsanitize-coverage=trace-pc
11200 @opindex fsanitize-coverage=trace-pc
11201 Enable coverage-guided fuzzing code instrumentation.
11202 Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block.
11204 @item -fsanitize-coverage=trace-cmp
11205 @opindex fsanitize-coverage=trace-cmp
11206 Enable dataflow guided fuzzing code instrumentation.
11207 Inserts a call to @code{__sanitizer_cov_trace_cmp1},
11208 @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or
11209 @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands
11210 variable or @code{__sanitizer_cov_trace_const_cmp1},
11211 @code{__sanitizer_cov_trace_const_cmp2},
11212 @code{__sanitizer_cov_trace_const_cmp4} or
11213 @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one
11214 operand constant, @code{__sanitizer_cov_trace_cmpf} or
11215 @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and
11216 @code{__sanitizer_cov_trace_switch} for switch statements.
11218 @item -fbounds-check
11219 @opindex fbounds-check
11220 For front ends that support it, generate additional code to check that
11221 indices used to access arrays are within the declared range.  This is
11222 currently only supported by the Fortran front end, where this option
11223 defaults to false.
11225 @item -fcheck-pointer-bounds
11226 @opindex fcheck-pointer-bounds
11227 @opindex fno-check-pointer-bounds
11228 @cindex Pointer Bounds Checker options
11229 Enable Pointer Bounds Checker instrumentation.  Each memory reference
11230 is instrumented with checks of the pointer used for memory access against
11231 bounds associated with that pointer.  
11233 Currently there
11234 is only an implementation for Intel MPX available, thus x86 GNU/Linux target
11235 and @option{-mmpx} are required to enable this feature.  
11236 MPX-based instrumentation requires
11237 a runtime library to enable MPX in hardware and handle bounds
11238 violation signals.  By default when @option{-fcheck-pointer-bounds}
11239 and @option{-mmpx} options are used to link a program, the GCC driver
11240 links against the @file{libmpx} and @file{libmpxwrappers} libraries.
11241 Bounds checking on calls to dynamic libraries requires a linker
11242 with @option{-z bndplt} support; if GCC was configured with a linker
11243 without support for this option (including the Gold linker and older
11244 versions of ld), a warning is given if you link with @option{-mmpx}
11245 without also specifying @option{-static}, since the overall effectiveness
11246 of the bounds checking protection is reduced.
11247 See also @option{-static-libmpxwrappers}.
11249 MPX-based instrumentation
11250 may be used for debugging and also may be included in production code
11251 to increase program security.  Depending on usage, you may
11252 have different requirements for the runtime library.  The current version
11253 of the MPX runtime library is more oriented for use as a debugging
11254 tool.  MPX runtime library usage implies @option{-lpthread}.  See
11255 also @option{-static-libmpx}.  The runtime library  behavior can be
11256 influenced using various @env{CHKP_RT_*} environment variables.  See
11257 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
11258 for more details.
11260 Generated instrumentation may be controlled by various
11261 @option{-fchkp-*} options and by the @code{bnd_variable_size}
11262 structure field attribute (@pxref{Type Attributes}) and
11263 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
11264 (@pxref{Function Attributes}).  GCC also provides a number of built-in
11265 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
11266 Bounds Checker builtins}, for more information.
11268 @item -fchkp-check-incomplete-type
11269 @opindex fchkp-check-incomplete-type
11270 @opindex fno-chkp-check-incomplete-type
11271 Generate pointer bounds checks for variables with incomplete type.
11272 Enabled by default.
11274 @item -fchkp-narrow-bounds
11275 @opindex fchkp-narrow-bounds
11276 @opindex fno-chkp-narrow-bounds
11277 Controls bounds used by Pointer Bounds Checker for pointers to object
11278 fields.  If narrowing is enabled then field bounds are used.  Otherwise
11279 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
11280 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
11282 @item -fchkp-first-field-has-own-bounds
11283 @opindex fchkp-first-field-has-own-bounds
11284 @opindex fno-chkp-first-field-has-own-bounds
11285 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
11286 first field in the structure.  By default a pointer to the first field has
11287 the same bounds as a pointer to the whole structure.
11289 @item -fchkp-flexible-struct-trailing-arrays
11290 @opindex fchkp-flexible-struct-trailing-arrays
11291 @opindex fno-chkp-flexible-struct-trailing-arrays
11292 Forces Pointer Bounds Checker to treat all trailing arrays in structures as
11293 possibly flexible.  By default only array fields with zero length or that are
11294 marked with attribute bnd_variable_size are treated as flexible.
11296 @item -fchkp-narrow-to-innermost-array
11297 @opindex fchkp-narrow-to-innermost-array
11298 @opindex fno-chkp-narrow-to-innermost-array
11299 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
11300 case of nested static array access.  By default this option is disabled and
11301 bounds of the outermost array are used.
11303 @item -fchkp-optimize
11304 @opindex fchkp-optimize
11305 @opindex fno-chkp-optimize
11306 Enables Pointer Bounds Checker optimizations.  Enabled by default at
11307 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
11309 @item -fchkp-use-fast-string-functions
11310 @opindex fchkp-use-fast-string-functions
11311 @opindex fno-chkp-use-fast-string-functions
11312 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
11313 by Pointer Bounds Checker.  Disabled by default.
11315 @item -fchkp-use-nochk-string-functions
11316 @opindex fchkp-use-nochk-string-functions
11317 @opindex fno-chkp-use-nochk-string-functions
11318 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
11319 by Pointer Bounds Checker.  Disabled by default.
11321 @item -fchkp-use-static-bounds
11322 @opindex fchkp-use-static-bounds
11323 @opindex fno-chkp-use-static-bounds
11324 Allow Pointer Bounds Checker to generate static bounds holding
11325 bounds of static variables.  Enabled by default.
11327 @item -fchkp-use-static-const-bounds
11328 @opindex fchkp-use-static-const-bounds
11329 @opindex fno-chkp-use-static-const-bounds
11330 Use statically-initialized bounds for constant bounds instead of
11331 generating them each time they are required.  By default enabled when
11332 @option{-fchkp-use-static-bounds} is enabled.
11334 @item -fchkp-treat-zero-dynamic-size-as-infinite
11335 @opindex fchkp-treat-zero-dynamic-size-as-infinite
11336 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
11337 With this option, objects with incomplete type whose
11338 dynamically-obtained size is zero are treated as having infinite size
11339 instead by Pointer Bounds
11340 Checker.  This option may be helpful if a program is linked with a library
11341 missing size information for some symbols.  Disabled by default.
11343 @item -fchkp-check-read
11344 @opindex fchkp-check-read
11345 @opindex fno-chkp-check-read
11346 Instructs Pointer Bounds Checker to generate checks for all read
11347 accesses to memory.  Enabled by default.
11349 @item -fchkp-check-write
11350 @opindex fchkp-check-write
11351 @opindex fno-chkp-check-write
11352 Instructs Pointer Bounds Checker to generate checks for all write
11353 accesses to memory.  Enabled by default.
11355 @item -fchkp-store-bounds
11356 @opindex fchkp-store-bounds
11357 @opindex fno-chkp-store-bounds
11358 Instructs Pointer Bounds Checker to generate bounds stores for
11359 pointer writes.  Enabled by default.
11361 @item -fchkp-instrument-calls
11362 @opindex fchkp-instrument-calls
11363 @opindex fno-chkp-instrument-calls
11364 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
11365 Enabled by default.
11367 @item -fchkp-instrument-marked-only
11368 @opindex fchkp-instrument-marked-only
11369 @opindex fno-chkp-instrument-marked-only
11370 Instructs Pointer Bounds Checker to instrument only functions
11371 marked with the @code{bnd_instrument} attribute
11372 (@pxref{Function Attributes}).  Disabled by default.
11374 @item -fchkp-use-wrappers
11375 @opindex fchkp-use-wrappers
11376 @opindex fno-chkp-use-wrappers
11377 Allows Pointer Bounds Checker to replace calls to built-in functions
11378 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
11379 is used to link a program, the GCC driver automatically links
11380 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
11381 Enabled by default.
11383 @item -fstack-protector
11384 @opindex fstack-protector
11385 Emit extra code to check for buffer overflows, such as stack smashing
11386 attacks.  This is done by adding a guard variable to functions with
11387 vulnerable objects.  This includes functions that call @code{alloca}, and
11388 functions with buffers larger than 8 bytes.  The guards are initialized
11389 when a function is entered and then checked when the function exits.
11390 If a guard check fails, an error message is printed and the program exits.
11392 @item -fstack-protector-all
11393 @opindex fstack-protector-all
11394 Like @option{-fstack-protector} except that all functions are protected.
11396 @item -fstack-protector-strong
11397 @opindex fstack-protector-strong
11398 Like @option{-fstack-protector} but includes additional functions to
11399 be protected --- those that have local array definitions, or have
11400 references to local frame addresses.
11402 @item -fstack-protector-explicit
11403 @opindex fstack-protector-explicit
11404 Like @option{-fstack-protector} but only protects those functions which
11405 have the @code{stack_protect} attribute.
11407 @item -fstack-check
11408 @opindex fstack-check
11409 Generate code to verify that you do not go beyond the boundary of the
11410 stack.  You should specify this flag if you are running in an
11411 environment with multiple threads, but you only rarely need to specify it in
11412 a single-threaded environment since stack overflow is automatically
11413 detected on nearly all systems if there is only one stack.
11415 Note that this switch does not actually cause checking to be done; the
11416 operating system or the language runtime must do that.  The switch causes
11417 generation of code to ensure that they see the stack being extended.
11419 You can additionally specify a string parameter: @samp{no} means no
11420 checking, @samp{generic} means force the use of old-style checking,
11421 @samp{specific} means use the best checking method and is equivalent
11422 to bare @option{-fstack-check}.
11424 Old-style checking is a generic mechanism that requires no specific
11425 target support in the compiler but comes with the following drawbacks:
11427 @enumerate
11428 @item
11429 Modified allocation strategy for large objects: they are always
11430 allocated dynamically if their size exceeds a fixed threshold.  Note this
11431 may change the semantics of some code.
11433 @item
11434 Fixed limit on the size of the static frame of functions: when it is
11435 topped by a particular function, stack checking is not reliable and
11436 a warning is issued by the compiler.
11438 @item
11439 Inefficiency: because of both the modified allocation strategy and the
11440 generic implementation, code performance is hampered.
11441 @end enumerate
11443 Note that old-style stack checking is also the fallback method for
11444 @samp{specific} if no target support has been added in the compiler.
11446 @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion
11447 and stack overflows.  @samp{specific} is an excellent choice when compiling
11448 Ada code.  It is not generally sufficient to protect against stack-clash
11449 attacks.  To protect against those you want @samp{-fstack-clash-protection}.
11451 @item -fstack-clash-protection
11452 @opindex fstack-clash-protection
11453 Generate code to prevent stack clash style attacks.  When this option is
11454 enabled, the compiler will only allocate one page of stack space at a time
11455 and each page is accessed immediately after allocation.  Thus, it prevents
11456 allocations from jumping over any stack guard page provided by the
11457 operating system.
11459 Most targets do not fully support stack clash protection.  However, on
11460 those targets @option{-fstack-clash-protection} will protect dynamic stack
11461 allocations.  @option{-fstack-clash-protection} may also provide limited
11462 protection for static stack allocations if the target supports
11463 @option{-fstack-check=specific}.
11465 @item -fstack-limit-register=@var{reg}
11466 @itemx -fstack-limit-symbol=@var{sym}
11467 @itemx -fno-stack-limit
11468 @opindex fstack-limit-register
11469 @opindex fstack-limit-symbol
11470 @opindex fno-stack-limit
11471 Generate code to ensure that the stack does not grow beyond a certain value,
11472 either the value of a register or the address of a symbol.  If a larger
11473 stack is required, a signal is raised at run time.  For most targets,
11474 the signal is raised before the stack overruns the boundary, so
11475 it is possible to catch the signal without taking special precautions.
11477 For instance, if the stack starts at absolute address @samp{0x80000000}
11478 and grows downwards, you can use the flags
11479 @option{-fstack-limit-symbol=__stack_limit} and
11480 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11481 of 128KB@.  Note that this may only work with the GNU linker.
11483 You can locally override stack limit checking by using the
11484 @code{no_stack_limit} function attribute (@pxref{Function Attributes}).
11486 @item -fsplit-stack
11487 @opindex fsplit-stack
11488 Generate code to automatically split the stack before it overflows.
11489 The resulting program has a discontiguous stack which can only
11490 overflow if the program is unable to allocate any more memory.  This
11491 is most useful when running threaded programs, as it is no longer
11492 necessary to calculate a good stack size to use for each thread.  This
11493 is currently only implemented for the x86 targets running
11494 GNU/Linux.
11496 When code compiled with @option{-fsplit-stack} calls code compiled
11497 without @option{-fsplit-stack}, there may not be much stack space
11498 available for the latter code to run.  If compiling all code,
11499 including library code, with @option{-fsplit-stack} is not an option,
11500 then the linker can fix up these calls so that the code compiled
11501 without @option{-fsplit-stack} always has a large stack.  Support for
11502 this is implemented in the gold linker in GNU binutils release 2.21
11503 and later.
11505 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
11506 @opindex fvtable-verify
11507 This option is only available when compiling C++ code.
11508 It turns on (or off, if using @option{-fvtable-verify=none}) the security
11509 feature that verifies at run time, for every virtual call, that
11510 the vtable pointer through which the call is made is valid for the type of
11511 the object, and has not been corrupted or overwritten.  If an invalid vtable
11512 pointer is detected at run time, an error is reported and execution of the
11513 program is immediately halted.
11515 This option causes run-time data structures to be built at program startup,
11516 which are used for verifying the vtable pointers.  
11517 The options @samp{std} and @samp{preinit}
11518 control the timing of when these data structures are built.  In both cases the
11519 data structures are built before execution reaches @code{main}.  Using
11520 @option{-fvtable-verify=std} causes the data structures to be built after
11521 shared libraries have been loaded and initialized.
11522 @option{-fvtable-verify=preinit} causes them to be built before shared
11523 libraries have been loaded and initialized.
11525 If this option appears multiple times in the command line with different
11526 values specified, @samp{none} takes highest priority over both @samp{std} and
11527 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
11529 @item -fvtv-debug
11530 @opindex fvtv-debug
11531 When used in conjunction with @option{-fvtable-verify=std} or 
11532 @option{-fvtable-verify=preinit}, causes debug versions of the 
11533 runtime functions for the vtable verification feature to be called.  
11534 This flag also causes the compiler to log information about which 
11535 vtable pointers it finds for each class.
11536 This information is written to a file named @file{vtv_set_ptr_data.log} 
11537 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
11538 if that is defined or the current working directory otherwise.
11540 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
11541 file, be sure to delete any existing one.
11543 @item -fvtv-counts
11544 @opindex fvtv-counts
11545 This is a debugging flag.  When used in conjunction with
11546 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
11547 causes the compiler to keep track of the total number of virtual calls
11548 it encounters and the number of verifications it inserts.  It also
11549 counts the number of calls to certain run-time library functions
11550 that it inserts and logs this information for each compilation unit.
11551 The compiler writes this information to a file named
11552 @file{vtv_count_data.log} in the directory named by the environment
11553 variable @env{VTV_LOGS_DIR} if that is defined or the current working
11554 directory otherwise.  It also counts the size of the vtable pointer sets
11555 for each class, and writes this information to @file{vtv_class_set_sizes.log}
11556 in the same directory.
11558 Note:  This feature @emph{appends} data to the log files.  To get fresh log
11559 files, be sure to delete any existing ones.
11561 @item -finstrument-functions
11562 @opindex finstrument-functions
11563 Generate instrumentation calls for entry and exit to functions.  Just
11564 after function entry and just before function exit, the following
11565 profiling functions are called with the address of the current
11566 function and its call site.  (On some platforms,
11567 @code{__builtin_return_address} does not work beyond the current
11568 function, so the call site information may not be available to the
11569 profiling functions otherwise.)
11571 @smallexample
11572 void __cyg_profile_func_enter (void *this_fn,
11573                                void *call_site);
11574 void __cyg_profile_func_exit  (void *this_fn,
11575                                void *call_site);
11576 @end smallexample
11578 The first argument is the address of the start of the current function,
11579 which may be looked up exactly in the symbol table.
11581 This instrumentation is also done for functions expanded inline in other
11582 functions.  The profiling calls indicate where, conceptually, the
11583 inline function is entered and exited.  This means that addressable
11584 versions of such functions must be available.  If all your uses of a
11585 function are expanded inline, this may mean an additional expansion of
11586 code size.  If you use @code{extern inline} in your C code, an
11587 addressable version of such functions must be provided.  (This is
11588 normally the case anyway, but if you get lucky and the optimizer always
11589 expands the functions inline, you might have gotten away without
11590 providing static copies.)
11592 A function may be given the attribute @code{no_instrument_function}, in
11593 which case this instrumentation is not done.  This can be used, for
11594 example, for the profiling functions listed above, high-priority
11595 interrupt routines, and any functions from which the profiling functions
11596 cannot safely be called (perhaps signal handlers, if the profiling
11597 routines generate output or allocate memory).
11599 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
11600 @opindex finstrument-functions-exclude-file-list
11602 Set the list of functions that are excluded from instrumentation (see
11603 the description of @option{-finstrument-functions}).  If the file that
11604 contains a function definition matches with one of @var{file}, then
11605 that function is not instrumented.  The match is done on substrings:
11606 if the @var{file} parameter is a substring of the file name, it is
11607 considered to be a match.
11609 For example:
11611 @smallexample
11612 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
11613 @end smallexample
11615 @noindent
11616 excludes any inline function defined in files whose pathnames
11617 contain @file{/bits/stl} or @file{include/sys}.
11619 If, for some reason, you want to include letter @samp{,} in one of
11620 @var{sym}, write @samp{\,}. For example,
11621 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
11622 (note the single quote surrounding the option).
11624 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
11625 @opindex finstrument-functions-exclude-function-list
11627 This is similar to @option{-finstrument-functions-exclude-file-list},
11628 but this option sets the list of function names to be excluded from
11629 instrumentation.  The function name to be matched is its user-visible
11630 name, such as @code{vector<int> blah(const vector<int> &)}, not the
11631 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
11632 match is done on substrings: if the @var{sym} parameter is a substring
11633 of the function name, it is considered to be a match.  For C99 and C++
11634 extended identifiers, the function name must be given in UTF-8, not
11635 using universal character names.
11637 @item -fpatchable-function-entry=@var{N}[,@var{M}]
11638 @opindex fpatchable-function-entry
11639 Generate @var{N} NOPs right at the beginning
11640 of each function, with the function entry point before the @var{M}th NOP.
11641 If @var{M} is omitted, it defaults to @code{0} so the
11642 function entry points to the address just at the first NOP.
11643 The NOP instructions reserve extra space which can be used to patch in
11644 any desired instrumentation at run time, provided that the code segment
11645 is writable.  The amount of space is controllable indirectly via
11646 the number of NOPs; the NOP instruction used corresponds to the instruction
11647 emitted by the internal GCC back-end interface @code{gen_nop}.  This behavior
11648 is target-specific and may also depend on the architecture variant and/or
11649 other compilation options.
11651 For run-time identification, the starting addresses of these areas,
11652 which correspond to their respective function entries minus @var{M},
11653 are additionally collected in the @code{__patchable_function_entries}
11654 section of the resulting binary.
11656 Note that the value of @code{__attribute__ ((patchable_function_entry
11657 (N,M)))} takes precedence over command-line option
11658 @option{-fpatchable-function-entry=N,M}.  This can be used to increase
11659 the area size or to remove it completely on a single function.
11660 If @code{N=0}, no pad location is recorded.
11662 The NOP instructions are inserted at---and maybe before, depending on
11663 @var{M}---the function entry address, even before the prologue.
11665 @end table
11668 @node Preprocessor Options
11669 @section Options Controlling the Preprocessor
11670 @cindex preprocessor options
11671 @cindex options, preprocessor
11673 These options control the C preprocessor, which is run on each C source
11674 file before actual compilation.
11676 If you use the @option{-E} option, nothing is done except preprocessing.
11677 Some of these options make sense only together with @option{-E} because
11678 they cause the preprocessor output to be unsuitable for actual
11679 compilation.
11681 In addition to the options listed here, there are a number of options 
11682 to control search paths for include files documented in 
11683 @ref{Directory Options}.  
11684 Options to control preprocessor diagnostics are listed in 
11685 @ref{Warning Options}.
11687 @table @gcctabopt
11688 @include cppopts.texi
11690 @item -Wp,@var{option}
11691 @opindex Wp
11692 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11693 and pass @var{option} directly through to the preprocessor.  If
11694 @var{option} contains commas, it is split into multiple options at the
11695 commas.  However, many options are modified, translated or interpreted
11696 by the compiler driver before being passed to the preprocessor, and
11697 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11698 interface is undocumented and subject to change, so whenever possible
11699 you should avoid using @option{-Wp} and let the driver handle the
11700 options instead.
11702 @item -Xpreprocessor @var{option}
11703 @opindex Xpreprocessor
11704 Pass @var{option} as an option to the preprocessor.  You can use this to
11705 supply system-specific preprocessor options that GCC does not 
11706 recognize.
11708 If you want to pass an option that takes an argument, you must use
11709 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11711 @item -no-integrated-cpp
11712 @opindex no-integrated-cpp
11713 Perform preprocessing as a separate pass before compilation.
11714 By default, GCC performs preprocessing as an integrated part of
11715 input tokenization and parsing.
11716 If this option is provided, the appropriate language front end
11717 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11718 and Objective-C, respectively) is instead invoked twice,
11719 once for preprocessing only and once for actual compilation
11720 of the preprocessed input.
11721 This option may be useful in conjunction with the @option{-B} or
11722 @option{-wrapper} options to specify an alternate preprocessor or
11723 perform additional processing of the program source between
11724 normal preprocessing and compilation.
11726 @end table
11728 @node Assembler Options
11729 @section Passing Options to the Assembler
11731 @c prevent bad page break with this line
11732 You can pass options to the assembler.
11734 @table @gcctabopt
11735 @item -Wa,@var{option}
11736 @opindex Wa
11737 Pass @var{option} as an option to the assembler.  If @var{option}
11738 contains commas, it is split into multiple options at the commas.
11740 @item -Xassembler @var{option}
11741 @opindex Xassembler
11742 Pass @var{option} as an option to the assembler.  You can use this to
11743 supply system-specific assembler options that GCC does not
11744 recognize.
11746 If you want to pass an option that takes an argument, you must use
11747 @option{-Xassembler} twice, once for the option and once for the argument.
11749 @end table
11751 @node Link Options
11752 @section Options for Linking
11753 @cindex link options
11754 @cindex options, linking
11756 These options come into play when the compiler links object files into
11757 an executable output file.  They are meaningless if the compiler is
11758 not doing a link step.
11760 @table @gcctabopt
11761 @cindex file names
11762 @item @var{object-file-name}
11763 A file name that does not end in a special recognized suffix is
11764 considered to name an object file or library.  (Object files are
11765 distinguished from libraries by the linker according to the file
11766 contents.)  If linking is done, these object files are used as input
11767 to the linker.
11769 @item -c
11770 @itemx -S
11771 @itemx -E
11772 @opindex c
11773 @opindex S
11774 @opindex E
11775 If any of these options is used, then the linker is not run, and
11776 object file names should not be used as arguments.  @xref{Overall
11777 Options}.
11779 @item -fuse-ld=bfd
11780 @opindex fuse-ld=bfd
11781 Use the @command{bfd} linker instead of the default linker.
11783 @item -fuse-ld=gold
11784 @opindex fuse-ld=gold
11785 Use the @command{gold} linker instead of the default linker.
11787 @cindex Libraries
11788 @item -l@var{library}
11789 @itemx -l @var{library}
11790 @opindex l
11791 Search the library named @var{library} when linking.  (The second
11792 alternative with the library as a separate argument is only for
11793 POSIX compliance and is not recommended.)
11795 It makes a difference where in the command you write this option; the
11796 linker searches and processes libraries and object files in the order they
11797 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11798 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11799 to functions in @samp{z}, those functions may not be loaded.
11801 The linker searches a standard list of directories for the library,
11802 which is actually a file named @file{lib@var{library}.a}.  The linker
11803 then uses this file as if it had been specified precisely by name.
11805 The directories searched include several standard system directories
11806 plus any that you specify with @option{-L}.
11808 Normally the files found this way are library files---archive files
11809 whose members are object files.  The linker handles an archive file by
11810 scanning through it for members which define symbols that have so far
11811 been referenced but not defined.  But if the file that is found is an
11812 ordinary object file, it is linked in the usual fashion.  The only
11813 difference between using an @option{-l} option and specifying a file name
11814 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11815 and searches several directories.
11817 @item -lobjc
11818 @opindex lobjc
11819 You need this special case of the @option{-l} option in order to
11820 link an Objective-C or Objective-C++ program.
11822 @item -nostartfiles
11823 @opindex nostartfiles
11824 Do not use the standard system startup files when linking.
11825 The standard system libraries are used normally, unless @option{-nostdlib}
11826 or @option{-nodefaultlibs} is used.
11828 @item -nodefaultlibs
11829 @opindex nodefaultlibs
11830 Do not use the standard system libraries when linking.
11831 Only the libraries you specify are passed to the linker, and options
11832 specifying linkage of the system libraries, such as @option{-static-libgcc}
11833 or @option{-shared-libgcc}, are ignored.  
11834 The standard startup files are used normally, unless @option{-nostartfiles}
11835 is used.  
11837 The compiler may generate calls to @code{memcmp},
11838 @code{memset}, @code{memcpy} and @code{memmove}.
11839 These entries are usually resolved by entries in
11840 libc.  These entry points should be supplied through some other
11841 mechanism when this option is specified.
11843 @item -nostdlib
11844 @opindex nostdlib
11845 Do not use the standard system startup files or libraries when linking.
11846 No startup files and only the libraries you specify are passed to
11847 the linker, and options specifying linkage of the system libraries, such as
11848 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11850 The compiler may generate calls to @code{memcmp}, @code{memset},
11851 @code{memcpy} and @code{memmove}.
11852 These entries are usually resolved by entries in
11853 libc.  These entry points should be supplied through some other
11854 mechanism when this option is specified.
11856 @cindex @option{-lgcc}, use with @option{-nostdlib}
11857 @cindex @option{-nostdlib} and unresolved references
11858 @cindex unresolved references and @option{-nostdlib}
11859 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11860 @cindex @option{-nodefaultlibs} and unresolved references
11861 @cindex unresolved references and @option{-nodefaultlibs}
11862 One of the standard libraries bypassed by @option{-nostdlib} and
11863 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11864 which GCC uses to overcome shortcomings of particular machines, or special
11865 needs for some languages.
11866 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11867 Collection (GCC) Internals},
11868 for more discussion of @file{libgcc.a}.)
11869 In most cases, you need @file{libgcc.a} even when you want to avoid
11870 other standard libraries.  In other words, when you specify @option{-nostdlib}
11871 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11872 This ensures that you have no unresolved references to internal GCC
11873 library subroutines.
11874 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11875 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11876 GNU Compiler Collection (GCC) Internals}.)
11878 @item -pie
11879 @opindex pie
11880 Produce a dynamically linked position independent executable on targets
11881 that support it.  For predictable results, you must also specify the same
11882 set of options used for compilation (@option{-fpie}, @option{-fPIE},
11883 or model suboptions) when you specify this linker option.
11885 @item -no-pie
11886 @opindex no-pie
11887 Don't produce a dynamically linked position independent executable.
11889 @item -static-pie
11890 @opindex static-pie
11891 Produce a static position independent executable on targets that support
11892 it.  A static position independent executable is similar to a static
11893 executable, but can be loaded at any address without a dynamic linker.
11894 For predictable results, you must also specify the same set of options
11895 used for compilation (@option{-fpie}, @option{-fPIE}, or model
11896 suboptions) when you specify this linker option.
11898 @item -pthread
11899 @opindex pthread
11900 Link with the POSIX threads library.  This option is supported on 
11901 GNU/Linux targets, most other Unix derivatives, and also on 
11902 x86 Cygwin and MinGW targets.  On some targets this option also sets 
11903 flags for the preprocessor, so it should be used consistently for both
11904 compilation and linking.
11906 @item -rdynamic
11907 @opindex rdynamic
11908 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11909 that support it. This instructs the linker to add all symbols, not
11910 only used ones, to the dynamic symbol table. This option is needed
11911 for some uses of @code{dlopen} or to allow obtaining backtraces
11912 from within a program.
11914 @item -s
11915 @opindex s
11916 Remove all symbol table and relocation information from the executable.
11918 @item -static
11919 @opindex static
11920 On systems that support dynamic linking, this overrides @option{-pie}
11921 and prevents linking with the shared libraries.  On other systems, this
11922 option has no effect.
11924 @item -shared
11925 @opindex shared
11926 Produce a shared object which can then be linked with other objects to
11927 form an executable.  Not all systems support this option.  For predictable
11928 results, you must also specify the same set of options used for compilation
11929 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11930 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11931 needs to build supplementary stub code for constructors to work.  On
11932 multi-libbed systems, @samp{gcc -shared} must select the correct support
11933 libraries to link against.  Failing to supply the correct flags may lead
11934 to subtle defects.  Supplying them in cases where they are not necessary
11935 is innocuous.}
11937 @item -shared-libgcc
11938 @itemx -static-libgcc
11939 @opindex shared-libgcc
11940 @opindex static-libgcc
11941 On systems that provide @file{libgcc} as a shared library, these options
11942 force the use of either the shared or static version, respectively.
11943 If no shared version of @file{libgcc} was built when the compiler was
11944 configured, these options have no effect.
11946 There are several situations in which an application should use the
11947 shared @file{libgcc} instead of the static version.  The most common
11948 of these is when the application wishes to throw and catch exceptions
11949 across different shared libraries.  In that case, each of the libraries
11950 as well as the application itself should use the shared @file{libgcc}.
11952 Therefore, the G++ and driver automatically adds @option{-shared-libgcc}
11953  whenever you build a shared library or a main executable, because C++
11954  programs typically use exceptions, so this is the right thing to do.
11956 If, instead, you use the GCC driver to create shared libraries, you may
11957 find that they are not always linked with the shared @file{libgcc}.
11958 If GCC finds, at its configuration time, that you have a non-GNU linker
11959 or a GNU linker that does not support option @option{--eh-frame-hdr},
11960 it links the shared version of @file{libgcc} into shared libraries
11961 by default.  Otherwise, it takes advantage of the linker and optimizes
11962 away the linking with the shared version of @file{libgcc}, linking with
11963 the static version of libgcc by default.  This allows exceptions to
11964 propagate through such shared libraries, without incurring relocation
11965 costs at library load time.
11967 However, if a library or main executable is supposed to throw or catch
11968 exceptions, you must link it using the G++ driver, as appropriate
11969 for the languages used in the program, or using the option
11970 @option{-shared-libgcc}, such that it is linked with the shared
11971 @file{libgcc}.
11973 @item -static-libasan
11974 @opindex static-libasan
11975 When the @option{-fsanitize=address} option is used to link a program,
11976 the GCC driver automatically links against @option{libasan}.  If
11977 @file{libasan} is available as a shared library, and the @option{-static}
11978 option is not used, then this links against the shared version of
11979 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11980 driver to link @file{libasan} statically, without necessarily linking
11981 other libraries statically.
11983 @item -static-libtsan
11984 @opindex static-libtsan
11985 When the @option{-fsanitize=thread} option is used to link a program,
11986 the GCC driver automatically links against @option{libtsan}.  If
11987 @file{libtsan} is available as a shared library, and the @option{-static}
11988 option is not used, then this links against the shared version of
11989 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11990 driver to link @file{libtsan} statically, without necessarily linking
11991 other libraries statically.
11993 @item -static-liblsan
11994 @opindex static-liblsan
11995 When the @option{-fsanitize=leak} option is used to link a program,
11996 the GCC driver automatically links against @option{liblsan}.  If
11997 @file{liblsan} is available as a shared library, and the @option{-static}
11998 option is not used, then this links against the shared version of
11999 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
12000 driver to link @file{liblsan} statically, without necessarily linking
12001 other libraries statically.
12003 @item -static-libubsan
12004 @opindex static-libubsan
12005 When the @option{-fsanitize=undefined} option is used to link a program,
12006 the GCC driver automatically links against @option{libubsan}.  If
12007 @file{libubsan} is available as a shared library, and the @option{-static}
12008 option is not used, then this links against the shared version of
12009 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
12010 driver to link @file{libubsan} statically, without necessarily linking
12011 other libraries statically.
12013 @item -static-libmpx
12014 @opindex static-libmpx
12015 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
12016 used to link a program, the GCC driver automatically links against
12017 @file{libmpx}.  If @file{libmpx} is available as a shared library,
12018 and the @option{-static} option is not used, then this links against
12019 the shared version of @file{libmpx}.  The @option{-static-libmpx}
12020 option directs the GCC driver to link @file{libmpx} statically,
12021 without necessarily linking other libraries statically.
12023 @item -static-libmpxwrappers
12024 @opindex static-libmpxwrappers
12025 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
12026 to link a program without also using @option{-fno-chkp-use-wrappers}, the
12027 GCC driver automatically links against @file{libmpxwrappers}.  If
12028 @file{libmpxwrappers} is available as a shared library, and the
12029 @option{-static} option is not used, then this links against the shared
12030 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
12031 option directs the GCC driver to link @file{libmpxwrappers} statically,
12032 without necessarily linking other libraries statically.
12034 @item -static-libstdc++
12035 @opindex static-libstdc++
12036 When the @command{g++} program is used to link a C++ program, it
12037 normally automatically links against @option{libstdc++}.  If
12038 @file{libstdc++} is available as a shared library, and the
12039 @option{-static} option is not used, then this links against the
12040 shared version of @file{libstdc++}.  That is normally fine.  However, it
12041 is sometimes useful to freeze the version of @file{libstdc++} used by
12042 the program without going all the way to a fully static link.  The
12043 @option{-static-libstdc++} option directs the @command{g++} driver to
12044 link @file{libstdc++} statically, without necessarily linking other
12045 libraries statically.
12047 @item -symbolic
12048 @opindex symbolic
12049 Bind references to global symbols when building a shared object.  Warn
12050 about any unresolved references (unless overridden by the link editor
12051 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
12052 this option.
12054 @item -T @var{script}
12055 @opindex T
12056 @cindex linker script
12057 Use @var{script} as the linker script.  This option is supported by most
12058 systems using the GNU linker.  On some targets, such as bare-board
12059 targets without an operating system, the @option{-T} option may be required
12060 when linking to avoid references to undefined symbols.
12062 @item -Xlinker @var{option}
12063 @opindex Xlinker
12064 Pass @var{option} as an option to the linker.  You can use this to
12065 supply system-specific linker options that GCC does not recognize.
12067 If you want to pass an option that takes a separate argument, you must use
12068 @option{-Xlinker} twice, once for the option and once for the argument.
12069 For example, to pass @option{-assert definitions}, you must write
12070 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
12071 @option{-Xlinker "-assert definitions"}, because this passes the entire
12072 string as a single argument, which is not what the linker expects.
12074 When using the GNU linker, it is usually more convenient to pass
12075 arguments to linker options using the @option{@var{option}=@var{value}}
12076 syntax than as separate arguments.  For example, you can specify
12077 @option{-Xlinker -Map=output.map} rather than
12078 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
12079 this syntax for command-line options.
12081 @item -Wl,@var{option}
12082 @opindex Wl
12083 Pass @var{option} as an option to the linker.  If @var{option} contains
12084 commas, it is split into multiple options at the commas.  You can use this
12085 syntax to pass an argument to the option.
12086 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
12087 linker.  When using the GNU linker, you can also get the same effect with
12088 @option{-Wl,-Map=output.map}.
12090 @item -u @var{symbol}
12091 @opindex u
12092 Pretend the symbol @var{symbol} is undefined, to force linking of
12093 library modules to define it.  You can use @option{-u} multiple times with
12094 different symbols to force loading of additional library modules.
12096 @item -z @var{keyword}
12097 @opindex z
12098 @option{-z} is passed directly on to the linker along with the keyword
12099 @var{keyword}. See the section in the documentation of your linker for
12100 permitted values and their meanings.
12101 @end table
12103 @node Directory Options
12104 @section Options for Directory Search
12105 @cindex directory options
12106 @cindex options, directory search
12107 @cindex search path
12109 These options specify directories to search for header files, for
12110 libraries and for parts of the compiler:
12112 @table @gcctabopt
12113 @include cppdiropts.texi
12115 @item -iplugindir=@var{dir}
12116 @opindex iplugindir=
12117 Set the directory to search for plugins that are passed
12118 by @option{-fplugin=@var{name}} instead of
12119 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
12120 to be used by the user, but only passed by the driver.
12122 @item -L@var{dir}
12123 @opindex L
12124 Add directory @var{dir} to the list of directories to be searched
12125 for @option{-l}.
12127 @item -B@var{prefix}
12128 @opindex B
12129 This option specifies where to find the executables, libraries,
12130 include files, and data files of the compiler itself.
12132 The compiler driver program runs one or more of the subprograms
12133 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
12134 @var{prefix} as a prefix for each program it tries to run, both with and
12135 without @samp{@var{machine}/@var{version}/} for the corresponding target
12136 machine and compiler version.
12138 For each subprogram to be run, the compiler driver first tries the
12139 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
12140 is not specified, the driver tries two standard prefixes, 
12141 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
12142 those results in a file name that is found, the unmodified program
12143 name is searched for using the directories specified in your
12144 @env{PATH} environment variable.
12146 The compiler checks to see if the path provided by @option{-B}
12147 refers to a directory, and if necessary it adds a directory
12148 separator character at the end of the path.
12150 @option{-B} prefixes that effectively specify directory names also apply
12151 to libraries in the linker, because the compiler translates these
12152 options into @option{-L} options for the linker.  They also apply to
12153 include files in the preprocessor, because the compiler translates these
12154 options into @option{-isystem} options for the preprocessor.  In this case,
12155 the compiler appends @samp{include} to the prefix.
12157 The runtime support file @file{libgcc.a} can also be searched for using
12158 the @option{-B} prefix, if needed.  If it is not found there, the two
12159 standard prefixes above are tried, and that is all.  The file is left
12160 out of the link if it is not found by those means.
12162 Another way to specify a prefix much like the @option{-B} prefix is to use
12163 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
12164 Variables}.
12166 As a special kludge, if the path provided by @option{-B} is
12167 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
12168 9, then it is replaced by @file{[dir/]include}.  This is to help
12169 with boot-strapping the compiler.
12171 @item -no-canonical-prefixes
12172 @opindex no-canonical-prefixes
12173 Do not expand any symbolic links, resolve references to @samp{/../}
12174 or @samp{/./}, or make the path absolute when generating a relative
12175 prefix.
12177 @item --sysroot=@var{dir}
12178 @opindex sysroot
12179 Use @var{dir} as the logical root directory for headers and libraries.
12180 For example, if the compiler normally searches for headers in
12181 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
12182 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
12184 If you use both this option and the @option{-isysroot} option, then
12185 the @option{--sysroot} option applies to libraries, but the
12186 @option{-isysroot} option applies to header files.
12188 The GNU linker (beginning with version 2.16) has the necessary support
12189 for this option.  If your linker does not support this option, the
12190 header file aspect of @option{--sysroot} still works, but the
12191 library aspect does not.
12193 @item --no-sysroot-suffix
12194 @opindex no-sysroot-suffix
12195 For some targets, a suffix is added to the root directory specified
12196 with @option{--sysroot}, depending on the other options used, so that
12197 headers may for example be found in
12198 @file{@var{dir}/@var{suffix}/usr/include} instead of
12199 @file{@var{dir}/usr/include}.  This option disables the addition of
12200 such a suffix.
12202 @end table
12204 @node Code Gen Options
12205 @section Options for Code Generation Conventions
12206 @cindex code generation conventions
12207 @cindex options, code generation
12208 @cindex run-time options
12210 These machine-independent options control the interface conventions
12211 used in code generation.
12213 Most of them have both positive and negative forms; the negative form
12214 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
12215 one of the forms is listed---the one that is not the default.  You
12216 can figure out the other form by either removing @samp{no-} or adding
12219 @table @gcctabopt
12220 @item -fstack-reuse=@var{reuse-level}
12221 @opindex fstack_reuse
12222 This option controls stack space reuse for user declared local/auto variables
12223 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
12224 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
12225 local variables and temporaries, @samp{named_vars} enables the reuse only for
12226 user defined local variables with names, and @samp{none} disables stack reuse
12227 completely. The default value is @samp{all}. The option is needed when the
12228 program extends the lifetime of a scoped local variable or a compiler generated
12229 temporary beyond the end point defined by the language.  When a lifetime of
12230 a variable ends, and if the variable lives in memory, the optimizing compiler
12231 has the freedom to reuse its stack space with other temporaries or scoped
12232 local variables whose live range does not overlap with it. Legacy code extending
12233 local lifetime is likely to break with the stack reuse optimization.
12235 For example,
12237 @smallexample
12238    int *p;
12239    @{
12240      int local1;
12242      p = &local1;
12243      local1 = 10;
12244      ....
12245    @}
12246    @{
12247       int local2;
12248       local2 = 20;
12249       ...
12250    @}
12252    if (*p == 10)  // out of scope use of local1
12253      @{
12255      @}
12256 @end smallexample
12258 Another example:
12259 @smallexample
12261    struct A
12262    @{
12263        A(int k) : i(k), j(k) @{ @}
12264        int i;
12265        int j;
12266    @};
12268    A *ap;
12270    void foo(const A& ar)
12271    @{
12272       ap = &ar;
12273    @}
12275    void bar()
12276    @{
12277       foo(A(10)); // temp object's lifetime ends when foo returns
12279       @{
12280         A a(20);
12281         ....
12282       @}
12283       ap->i+= 10;  // ap references out of scope temp whose space
12284                    // is reused with a. What is the value of ap->i?
12285    @}
12287 @end smallexample
12289 The lifetime of a compiler generated temporary is well defined by the C++
12290 standard. When a lifetime of a temporary ends, and if the temporary lives
12291 in memory, the optimizing compiler has the freedom to reuse its stack
12292 space with other temporaries or scoped local variables whose live range
12293 does not overlap with it. However some of the legacy code relies on
12294 the behavior of older compilers in which temporaries' stack space is
12295 not reused, the aggressive stack reuse can lead to runtime errors. This
12296 option is used to control the temporary stack reuse optimization.
12298 @item -ftrapv
12299 @opindex ftrapv
12300 This option generates traps for signed overflow on addition, subtraction,
12301 multiplication operations.
12302 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12303 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12304 @option{-fwrapv} being effective.  Note that only active options override, so
12305 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12306 results in @option{-ftrapv} being effective.
12308 @item -fwrapv
12309 @opindex fwrapv
12310 This option instructs the compiler to assume that signed arithmetic
12311 overflow of addition, subtraction and multiplication wraps around
12312 using twos-complement representation.  This flag enables some optimizations
12313 and disables others.
12314 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
12315 @option{-ftrapv} @option{-fwrapv} on the command-line results in
12316 @option{-fwrapv} being effective.  Note that only active options override, so
12317 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
12318 results in @option{-ftrapv} being effective.
12320 @item -fexceptions
12321 @opindex fexceptions
12322 Enable exception handling.  Generates extra code needed to propagate
12323 exceptions.  For some targets, this implies GCC generates frame
12324 unwind information for all functions, which can produce significant data
12325 size overhead, although it does not affect execution.  If you do not
12326 specify this option, GCC enables it by default for languages like
12327 C++ that normally require exception handling, and disables it for
12328 languages like C that do not normally require it.  However, you may need
12329 to enable this option when compiling C code that needs to interoperate
12330 properly with exception handlers written in C++.  You may also wish to
12331 disable this option if you are compiling older C++ programs that don't
12332 use exception handling.
12334 @item -fnon-call-exceptions
12335 @opindex fnon-call-exceptions
12336 Generate code that allows trapping instructions to throw exceptions.
12337 Note that this requires platform-specific runtime support that does
12338 not exist everywhere.  Moreover, it only allows @emph{trapping}
12339 instructions to throw exceptions, i.e.@: memory references or floating-point
12340 instructions.  It does not allow exceptions to be thrown from
12341 arbitrary signal handlers such as @code{SIGALRM}.
12343 @item -fdelete-dead-exceptions
12344 @opindex fdelete-dead-exceptions
12345 Consider that instructions that may throw exceptions but don't otherwise
12346 contribute to the execution of the program can be optimized away.
12347 This option is enabled by default for the Ada front end, as permitted by
12348 the Ada language specification.
12349 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
12351 @item -funwind-tables
12352 @opindex funwind-tables
12353 Similar to @option{-fexceptions}, except that it just generates any needed
12354 static data, but does not affect the generated code in any other way.
12355 You normally do not need to enable this option; instead, a language processor
12356 that needs this handling enables it on your behalf.
12358 @item -fasynchronous-unwind-tables
12359 @opindex fasynchronous-unwind-tables
12360 Generate unwind table in DWARF format, if supported by target machine.  The
12361 table is exact at each instruction boundary, so it can be used for stack
12362 unwinding from asynchronous events (such as debugger or garbage collector).
12364 @item -fno-gnu-unique
12365 @opindex fno-gnu-unique
12366 On systems with recent GNU assembler and C library, the C++ compiler
12367 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
12368 of template static data members and static local variables in inline
12369 functions are unique even in the presence of @code{RTLD_LOCAL}; this
12370 is necessary to avoid problems with a library used by two different
12371 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
12372 therefore disagreeing with the other one about the binding of the
12373 symbol.  But this causes @code{dlclose} to be ignored for affected
12374 DSOs; if your program relies on reinitialization of a DSO via
12375 @code{dlclose} and @code{dlopen}, you can use
12376 @option{-fno-gnu-unique}.
12378 @item -fpcc-struct-return
12379 @opindex fpcc-struct-return
12380 Return ``short'' @code{struct} and @code{union} values in memory like
12381 longer ones, rather than in registers.  This convention is less
12382 efficient, but it has the advantage of allowing intercallability between
12383 GCC-compiled files and files compiled with other compilers, particularly
12384 the Portable C Compiler (pcc).
12386 The precise convention for returning structures in memory depends
12387 on the target configuration macros.
12389 Short structures and unions are those whose size and alignment match
12390 that of some integer type.
12392 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12393 switch is not binary compatible with code compiled with the
12394 @option{-freg-struct-return} switch.
12395 Use it to conform to a non-default application binary interface.
12397 @item -freg-struct-return
12398 @opindex freg-struct-return
12399 Return @code{struct} and @code{union} values in registers when possible.
12400 This is more efficient for small structures than
12401 @option{-fpcc-struct-return}.
12403 If you specify neither @option{-fpcc-struct-return} nor
12404 @option{-freg-struct-return}, GCC defaults to whichever convention is
12405 standard for the target.  If there is no standard convention, GCC
12406 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12407 the principal compiler.  In those cases, we can choose the standard, and
12408 we chose the more efficient register return alternative.
12410 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12411 switch is not binary compatible with code compiled with the
12412 @option{-fpcc-struct-return} switch.
12413 Use it to conform to a non-default application binary interface.
12415 @item -fshort-enums
12416 @opindex fshort-enums
12417 Allocate to an @code{enum} type only as many bytes as it needs for the
12418 declared range of possible values.  Specifically, the @code{enum} type
12419 is equivalent to the smallest integer type that has enough room.
12421 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12422 code that is not binary compatible with code generated without that switch.
12423 Use it to conform to a non-default application binary interface.
12425 @item -fshort-wchar
12426 @opindex fshort-wchar
12427 Override the underlying type for @code{wchar_t} to be @code{short
12428 unsigned int} instead of the default for the target.  This option is
12429 useful for building programs to run under WINE@.
12431 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12432 code that is not binary compatible with code generated without that switch.
12433 Use it to conform to a non-default application binary interface.
12435 @item -fno-common
12436 @opindex fno-common
12437 @cindex tentative definitions
12438 In C code, this option controls the placement of global variables 
12439 defined without an initializer, known as @dfn{tentative definitions} 
12440 in the C standard.  Tentative definitions are distinct from declarations 
12441 of a variable with the @code{extern} keyword, which do not allocate storage.
12443 Unix C compilers have traditionally allocated storage for
12444 uninitialized global variables in a common block.  This allows the
12445 linker to resolve all tentative definitions of the same variable
12446 in different compilation units to the same object, or to a non-tentative
12447 definition.  
12448 This is the behavior specified by @option{-fcommon}, and is the default for 
12449 GCC on most targets.  
12450 On the other hand, this behavior is not required by ISO
12451 C, and on some targets may carry a speed or code size penalty on
12452 variable references.
12454 The @option{-fno-common} option specifies that the compiler should instead
12455 place uninitialized global variables in the data section of the object file.
12456 This inhibits the merging of tentative definitions by the linker so
12457 you get a multiple-definition error if the same 
12458 variable is defined in more than one compilation unit.
12459 Compiling with @option{-fno-common} is useful on targets for which
12460 it provides better performance, or if you wish to verify that the
12461 program will work on other systems that always treat uninitialized
12462 variable definitions this way.
12464 @item -fno-ident
12465 @opindex fno-ident
12466 Ignore the @code{#ident} directive.
12468 @item -finhibit-size-directive
12469 @opindex finhibit-size-directive
12470 Don't output a @code{.size} assembler directive, or anything else that
12471 would cause trouble if the function is split in the middle, and the
12472 two halves are placed at locations far apart in memory.  This option is
12473 used when compiling @file{crtstuff.c}; you should not need to use it
12474 for anything else.
12476 @item -fverbose-asm
12477 @opindex fverbose-asm
12478 Put extra commentary information in the generated assembly code to
12479 make it more readable.  This option is generally only of use to those
12480 who actually need to read the generated assembly code (perhaps while
12481 debugging the compiler itself).
12483 @option{-fno-verbose-asm}, the default, causes the
12484 extra information to be omitted and is useful when comparing two assembler
12485 files.
12487 The added comments include:
12489 @itemize @bullet
12491 @item
12492 information on the compiler version and command-line options,
12494 @item
12495 the source code lines associated with the assembly instructions,
12496 in the form FILENAME:LINENUMBER:CONTENT OF LINE,
12498 @item
12499 hints on which high-level expressions correspond to
12500 the various assembly instruction operands.
12502 @end itemize
12504 For example, given this C source file:
12506 @smallexample
12507 int test (int n)
12509   int i;
12510   int total = 0;
12512   for (i = 0; i < n; i++)
12513     total += i * i;
12515   return total;
12517 @end smallexample
12519 compiling to (x86_64) assembly via @option{-S} and emitting the result
12520 direct to stdout via @option{-o} @option{-}
12522 @smallexample
12523 gcc -S test.c -fverbose-asm -Os -o -
12524 @end smallexample
12526 gives output similar to this:
12528 @smallexample
12529         .file   "test.c"
12530 # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu)
12531   [...snip...]
12532 # options passed:
12533   [...snip...]
12535         .text
12536         .globl  test
12537         .type   test, @@function
12538 test:
12539 .LFB0:
12540         .cfi_startproc
12541 # test.c:4:   int total = 0;
12542         xorl    %eax, %eax      # <retval>
12543 # test.c:6:   for (i = 0; i < n; i++)
12544         xorl    %edx, %edx      # i
12545 .L2:
12546 # test.c:6:   for (i = 0; i < n; i++)
12547         cmpl    %edi, %edx      # n, i
12548         jge     .L5     #,
12549 # test.c:7:     total += i * i;
12550         movl    %edx, %ecx      # i, tmp92
12551         imull   %edx, %ecx      # i, tmp92
12552 # test.c:6:   for (i = 0; i < n; i++)
12553         incl    %edx    # i
12554 # test.c:7:     total += i * i;
12555         addl    %ecx, %eax      # tmp92, <retval>
12556         jmp     .L2     #
12557 .L5:
12558 # test.c:10: @}
12559         ret
12560         .cfi_endproc
12561 .LFE0:
12562         .size   test, .-test
12563         .ident  "GCC: (GNU) 7.0.0 20160809 (experimental)"
12564         .section        .note.GNU-stack,"",@@progbits
12565 @end smallexample
12567 The comments are intended for humans rather than machines and hence the
12568 precise format of the comments is subject to change.
12570 @item -frecord-gcc-switches
12571 @opindex frecord-gcc-switches
12572 This switch causes the command line used to invoke the
12573 compiler to be recorded into the object file that is being created.
12574 This switch is only implemented on some targets and the exact format
12575 of the recording is target and binary file format dependent, but it
12576 usually takes the form of a section containing ASCII text.  This
12577 switch is related to the @option{-fverbose-asm} switch, but that
12578 switch only records information in the assembler output file as
12579 comments, so it never reaches the object file.
12580 See also @option{-grecord-gcc-switches} for another
12581 way of storing compiler options into the object file.
12583 @item -fpic
12584 @opindex fpic
12585 @cindex global offset table
12586 @cindex PIC
12587 Generate position-independent code (PIC) suitable for use in a shared
12588 library, if supported for the target machine.  Such code accesses all
12589 constant addresses through a global offset table (GOT)@.  The dynamic
12590 loader resolves the GOT entries when the program starts (the dynamic
12591 loader is not part of GCC; it is part of the operating system).  If
12592 the GOT size for the linked executable exceeds a machine-specific
12593 maximum size, you get an error message from the linker indicating that
12594 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12595 instead.  (These maximums are 8k on the SPARC, 28k on AArch64 and 32k
12596 on the m68k and RS/6000.  The x86 has no such limit.)
12598 Position-independent code requires special support, and therefore works
12599 only on certain machines.  For the x86, GCC supports PIC for System V
12600 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12601 position-independent.
12603 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12604 are defined to 1.
12606 @item -fPIC
12607 @opindex fPIC
12608 If supported for the target machine, emit position-independent code,
12609 suitable for dynamic linking and avoiding any limit on the size of the
12610 global offset table.  This option makes a difference on AArch64, m68k,
12611 PowerPC and SPARC@.
12613 Position-independent code requires special support, and therefore works
12614 only on certain machines.
12616 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12617 are defined to 2.
12619 @item -fpie
12620 @itemx -fPIE
12621 @opindex fpie
12622 @opindex fPIE
12623 These options are similar to @option{-fpic} and @option{-fPIC}, but
12624 generated position independent code can be only linked into executables.
12625 Usually these options are used when @option{-pie} GCC option is
12626 used during linking.
12628 @option{-fpie} and @option{-fPIE} both define the macros
12629 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
12630 for @option{-fpie} and 2 for @option{-fPIE}.
12632 @item -fno-plt
12633 @opindex fno-plt
12634 Do not use the PLT for external function calls in position-independent code.
12635 Instead, load the callee address at call sites from the GOT and branch to it.
12636 This leads to more efficient code by eliminating PLT stubs and exposing
12637 GOT loads to optimizations.  On architectures such as 32-bit x86 where
12638 PLT stubs expect the GOT pointer in a specific register, this gives more
12639 register allocation freedom to the compiler.
12640 Lazy binding requires use of the PLT; 
12641 with @option{-fno-plt} all external symbols are resolved at load time.
12643 Alternatively, the function attribute @code{noplt} can be used to avoid calls
12644 through the PLT for specific external functions.
12646 In position-dependent code, a few targets also convert calls to
12647 functions that are marked to not use the PLT to use the GOT instead.
12649 @item -fno-jump-tables
12650 @opindex fno-jump-tables
12651 Do not use jump tables for switch statements even where it would be
12652 more efficient than other code generation strategies.  This option is
12653 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12654 building code that forms part of a dynamic linker and cannot
12655 reference the address of a jump table.  On some targets, jump tables
12656 do not require a GOT and this option is not needed.
12658 @item -ffixed-@var{reg}
12659 @opindex ffixed
12660 Treat the register named @var{reg} as a fixed register; generated code
12661 should never refer to it (except perhaps as a stack pointer, frame
12662 pointer or in some other fixed role).
12664 @var{reg} must be the name of a register.  The register names accepted
12665 are machine-specific and are defined in the @code{REGISTER_NAMES}
12666 macro in the machine description macro file.
12668 This flag does not have a negative form, because it specifies a
12669 three-way choice.
12671 @item -fcall-used-@var{reg}
12672 @opindex fcall-used
12673 Treat the register named @var{reg} as an allocable register that is
12674 clobbered by function calls.  It may be allocated for temporaries or
12675 variables that do not live across a call.  Functions compiled this way
12676 do not save and restore the register @var{reg}.
12678 It is an error to use this flag with the frame pointer or stack pointer.
12679 Use of this flag for other registers that have fixed pervasive roles in
12680 the machine's execution model produces disastrous results.
12682 This flag does not have a negative form, because it specifies a
12683 three-way choice.
12685 @item -fcall-saved-@var{reg}
12686 @opindex fcall-saved
12687 Treat the register named @var{reg} as an allocable register saved by
12688 functions.  It may be allocated even for temporaries or variables that
12689 live across a call.  Functions compiled this way save and restore
12690 the register @var{reg} if they use it.
12692 It is an error to use this flag with the frame pointer or stack pointer.
12693 Use of this flag for other registers that have fixed pervasive roles in
12694 the machine's execution model produces disastrous results.
12696 A different sort of disaster results from the use of this flag for
12697 a register in which function values may be returned.
12699 This flag does not have a negative form, because it specifies a
12700 three-way choice.
12702 @item -fpack-struct[=@var{n}]
12703 @opindex fpack-struct
12704 Without a value specified, pack all structure members together without
12705 holes.  When a value is specified (which must be a small power of two), pack
12706 structure members according to this value, representing the maximum
12707 alignment (that is, objects with default alignment requirements larger than
12708 this are output potentially unaligned at the next fitting location.
12710 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12711 code that is not binary compatible with code generated without that switch.
12712 Additionally, it makes the code suboptimal.
12713 Use it to conform to a non-default application binary interface.
12715 @item -fleading-underscore
12716 @opindex fleading-underscore
12717 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12718 change the way C symbols are represented in the object file.  One use
12719 is to help link with legacy assembly code.
12721 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12722 generate code that is not binary compatible with code generated without that
12723 switch.  Use it to conform to a non-default application binary interface.
12724 Not all targets provide complete support for this switch.
12726 @item -ftls-model=@var{model}
12727 @opindex ftls-model
12728 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12729 The @var{model} argument should be one of @samp{global-dynamic},
12730 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
12731 Note that the choice is subject to optimization: the compiler may use
12732 a more efficient model for symbols not visible outside of the translation
12733 unit, or if @option{-fpic} is not given on the command line.
12735 The default without @option{-fpic} is @samp{initial-exec}; with
12736 @option{-fpic} the default is @samp{global-dynamic}.
12738 @item -ftrampolines
12739 @opindex ftrampolines
12740 For targets that normally need trampolines for nested functions, always
12741 generate them instead of using descriptors.  Otherwise, for targets that
12742 do not need them, like for example HP-PA or IA-64, do nothing.
12744 A trampoline is a small piece of code that is created at run time on the
12745 stack when the address of a nested function is taken, and is used to call
12746 the nested function indirectly.  Therefore, it requires the stack to be
12747 made executable in order for the program to work properly.
12749 @option{-fno-trampolines} is enabled by default on a language by language
12750 basis to let the compiler avoid generating them, if it computes that this
12751 is safe, and replace them with descriptors.  Descriptors are made up of data
12752 only, but the generated code must be prepared to deal with them.  As of this
12753 writing, @option{-fno-trampolines} is enabled by default only for Ada.
12755 Moreover, code compiled with @option{-ftrampolines} and code compiled with
12756 @option{-fno-trampolines} are not binary compatible if nested functions are
12757 present.  This option must therefore be used on a program-wide basis and be
12758 manipulated with extreme care.
12760 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
12761 @opindex fvisibility
12762 Set the default ELF image symbol visibility to the specified option---all
12763 symbols are marked with this unless overridden within the code.
12764 Using this feature can very substantially improve linking and
12765 load times of shared object libraries, produce more optimized
12766 code, provide near-perfect API export and prevent symbol clashes.
12767 It is @strong{strongly} recommended that you use this in any shared objects
12768 you distribute.
12770 Despite the nomenclature, @samp{default} always means public; i.e.,
12771 available to be linked against from outside the shared object.
12772 @samp{protected} and @samp{internal} are pretty useless in real-world
12773 usage so the only other commonly used option is @samp{hidden}.
12774 The default if @option{-fvisibility} isn't specified is
12775 @samp{default}, i.e., make every symbol public.
12777 A good explanation of the benefits offered by ensuring ELF
12778 symbols have the correct visibility is given by ``How To Write
12779 Shared Libraries'' by Ulrich Drepper (which can be found at
12780 @w{@uref{https://www.akkadia.org/drepper/}})---however a superior
12781 solution made possible by this option to marking things hidden when
12782 the default is public is to make the default hidden and mark things
12783 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
12784 and @code{__attribute__ ((visibility("default")))} instead of
12785 @code{__declspec(dllexport)} you get almost identical semantics with
12786 identical syntax.  This is a great boon to those working with
12787 cross-platform projects.
12789 For those adding visibility support to existing code, you may find
12790 @code{#pragma GCC visibility} of use.  This works by you enclosing
12791 the declarations you wish to set visibility for with (for example)
12792 @code{#pragma GCC visibility push(hidden)} and
12793 @code{#pragma GCC visibility pop}.
12794 Bear in mind that symbol visibility should be viewed @strong{as
12795 part of the API interface contract} and thus all new code should
12796 always specify visibility when it is not the default; i.e., declarations
12797 only for use within the local DSO should @strong{always} be marked explicitly
12798 as hidden as so to avoid PLT indirection overheads---making this
12799 abundantly clear also aids readability and self-documentation of the code.
12800 Note that due to ISO C++ specification requirements, @code{operator new} and
12801 @code{operator delete} must always be of default visibility.
12803 Be aware that headers from outside your project, in particular system
12804 headers and headers from any other library you use, may not be
12805 expecting to be compiled with visibility other than the default.  You
12806 may need to explicitly say @code{#pragma GCC visibility push(default)}
12807 before including any such headers.
12809 @code{extern} declarations are not affected by @option{-fvisibility}, so
12810 a lot of code can be recompiled with @option{-fvisibility=hidden} with
12811 no modifications.  However, this means that calls to @code{extern}
12812 functions with no explicit visibility use the PLT, so it is more
12813 effective to use @code{__attribute ((visibility))} and/or
12814 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
12815 declarations should be treated as hidden.
12817 Note that @option{-fvisibility} does affect C++ vague linkage
12818 entities. This means that, for instance, an exception class that is
12819 be thrown between DSOs must be explicitly marked with default
12820 visibility so that the @samp{type_info} nodes are unified between
12821 the DSOs.
12823 An overview of these techniques, their benefits and how to use them
12824 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
12826 @item -fstrict-volatile-bitfields
12827 @opindex fstrict-volatile-bitfields
12828 This option should be used if accesses to volatile bit-fields (or other
12829 structure fields, although the compiler usually honors those types
12830 anyway) should use a single access of the width of the
12831 field's type, aligned to a natural alignment if possible.  For
12832 example, targets with memory-mapped peripheral registers might require
12833 all such accesses to be 16 bits wide; with this flag you can
12834 declare all peripheral bit-fields as @code{unsigned short} (assuming short
12835 is 16 bits on these targets) to force GCC to use 16-bit accesses
12836 instead of, perhaps, a more efficient 32-bit access.
12838 If this option is disabled, the compiler uses the most efficient
12839 instruction.  In the previous example, that might be a 32-bit load
12840 instruction, even though that accesses bytes that do not contain
12841 any portion of the bit-field, or memory-mapped registers unrelated to
12842 the one being updated.
12844 In some cases, such as when the @code{packed} attribute is applied to a 
12845 structure field, it may not be possible to access the field with a single
12846 read or write that is correctly aligned for the target machine.  In this
12847 case GCC falls back to generating multiple accesses rather than code that 
12848 will fault or truncate the result at run time.
12850 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
12851 not allowed to touch non bit-field members.  It is therefore recommended
12852 to define all bits of the field's type as bit-field members.
12854 The default value of this option is determined by the application binary
12855 interface for the target processor.
12857 @item -fsync-libcalls
12858 @opindex fsync-libcalls
12859 This option controls whether any out-of-line instance of the @code{__sync}
12860 family of functions may be used to implement the C++11 @code{__atomic}
12861 family of functions.
12863 The default value of this option is enabled, thus the only useful form
12864 of the option is @option{-fno-sync-libcalls}.  This option is used in
12865 the implementation of the @file{libatomic} runtime library.
12867 @end table
12869 @node Developer Options
12870 @section GCC Developer Options
12871 @cindex developer options
12872 @cindex debugging GCC
12873 @cindex debug dump options
12874 @cindex dump options
12875 @cindex compilation statistics
12877 This section describes command-line options that are primarily of
12878 interest to GCC developers, including options to support compiler
12879 testing and investigation of compiler bugs and compile-time
12880 performance problems.  This includes options that produce debug dumps
12881 at various points in the compilation; that print statistics such as
12882 memory use and execution time; and that print information about GCC's
12883 configuration, such as where it searches for libraries.  You should
12884 rarely need to use any of these options for ordinary compilation and
12885 linking tasks.
12887 @table @gcctabopt
12889 @item -d@var{letters}
12890 @itemx -fdump-rtl-@var{pass}
12891 @itemx -fdump-rtl-@var{pass}=@var{filename}
12892 @opindex d
12893 @opindex fdump-rtl-@var{pass}
12894 Says to make debugging dumps during compilation at times specified by
12895 @var{letters}.  This is used for debugging the RTL-based passes of the
12896 compiler.  The file names for most of the dumps are made by appending
12897 a pass number and a word to the @var{dumpname}, and the files are
12898 created in the directory of the output file.  In case of
12899 @option{=@var{filename}} option, the dump is output on the given file
12900 instead of the pass numbered dump files.  Note that the pass number is
12901 assigned as passes are registered into the pass manager.  Most passes
12902 are registered in the order that they will execute and for these passes
12903 the number corresponds to the pass execution order.  However, passes
12904 registered by plugins, passes specific to compilation targets, or
12905 passes that are otherwise registered after all the other passes are
12906 numbered higher than a pass named "final", even if they are executed
12907 earlier.  @var{dumpname} is generated from the name of the output
12908 file if explicitly specified and not an executable, otherwise it is
12909 the basename of the source file.  
12911 Some @option{-d@var{letters}} switches have different meaning when
12912 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
12913 for information about preprocessor-specific dump options.
12915 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
12916 @option{-d} option @var{letters}.  Here are the possible
12917 letters for use in @var{pass} and @var{letters}, and their meanings:
12919 @table @gcctabopt
12921 @item -fdump-rtl-alignments
12922 @opindex fdump-rtl-alignments
12923 Dump after branch alignments have been computed.
12925 @item -fdump-rtl-asmcons
12926 @opindex fdump-rtl-asmcons
12927 Dump after fixing rtl statements that have unsatisfied in/out constraints.
12929 @item -fdump-rtl-auto_inc_dec
12930 @opindex fdump-rtl-auto_inc_dec
12931 Dump after auto-inc-dec discovery.  This pass is only run on
12932 architectures that have auto inc or auto dec instructions.
12934 @item -fdump-rtl-barriers
12935 @opindex fdump-rtl-barriers
12936 Dump after cleaning up the barrier instructions.
12938 @item -fdump-rtl-bbpart
12939 @opindex fdump-rtl-bbpart
12940 Dump after partitioning hot and cold basic blocks.
12942 @item -fdump-rtl-bbro
12943 @opindex fdump-rtl-bbro
12944 Dump after block reordering.
12946 @item -fdump-rtl-btl1
12947 @itemx -fdump-rtl-btl2
12948 @opindex fdump-rtl-btl2
12949 @opindex fdump-rtl-btl2
12950 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
12951 after the two branch
12952 target load optimization passes.
12954 @item -fdump-rtl-bypass
12955 @opindex fdump-rtl-bypass
12956 Dump after jump bypassing and control flow optimizations.
12958 @item -fdump-rtl-combine
12959 @opindex fdump-rtl-combine
12960 Dump after the RTL instruction combination pass.
12962 @item -fdump-rtl-compgotos
12963 @opindex fdump-rtl-compgotos
12964 Dump after duplicating the computed gotos.
12966 @item -fdump-rtl-ce1
12967 @itemx -fdump-rtl-ce2
12968 @itemx -fdump-rtl-ce3
12969 @opindex fdump-rtl-ce1
12970 @opindex fdump-rtl-ce2
12971 @opindex fdump-rtl-ce3
12972 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
12973 @option{-fdump-rtl-ce3} enable dumping after the three
12974 if conversion passes.
12976 @item -fdump-rtl-cprop_hardreg
12977 @opindex fdump-rtl-cprop_hardreg
12978 Dump after hard register copy propagation.
12980 @item -fdump-rtl-csa
12981 @opindex fdump-rtl-csa
12982 Dump after combining stack adjustments.
12984 @item -fdump-rtl-cse1
12985 @itemx -fdump-rtl-cse2
12986 @opindex fdump-rtl-cse1
12987 @opindex fdump-rtl-cse2
12988 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
12989 the two common subexpression elimination passes.
12991 @item -fdump-rtl-dce
12992 @opindex fdump-rtl-dce
12993 Dump after the standalone dead code elimination passes.
12995 @item -fdump-rtl-dbr
12996 @opindex fdump-rtl-dbr
12997 Dump after delayed branch scheduling.
12999 @item -fdump-rtl-dce1
13000 @itemx -fdump-rtl-dce2
13001 @opindex fdump-rtl-dce1
13002 @opindex fdump-rtl-dce2
13003 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
13004 the two dead store elimination passes.
13006 @item -fdump-rtl-eh
13007 @opindex fdump-rtl-eh
13008 Dump after finalization of EH handling code.
13010 @item -fdump-rtl-eh_ranges
13011 @opindex fdump-rtl-eh_ranges
13012 Dump after conversion of EH handling range regions.
13014 @item -fdump-rtl-expand
13015 @opindex fdump-rtl-expand
13016 Dump after RTL generation.
13018 @item -fdump-rtl-fwprop1
13019 @itemx -fdump-rtl-fwprop2
13020 @opindex fdump-rtl-fwprop1
13021 @opindex fdump-rtl-fwprop2
13022 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
13023 dumping after the two forward propagation passes.
13025 @item -fdump-rtl-gcse1
13026 @itemx -fdump-rtl-gcse2
13027 @opindex fdump-rtl-gcse1
13028 @opindex fdump-rtl-gcse2
13029 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
13030 after global common subexpression elimination.
13032 @item -fdump-rtl-init-regs
13033 @opindex fdump-rtl-init-regs
13034 Dump after the initialization of the registers.
13036 @item -fdump-rtl-initvals
13037 @opindex fdump-rtl-initvals
13038 Dump after the computation of the initial value sets.
13040 @item -fdump-rtl-into_cfglayout
13041 @opindex fdump-rtl-into_cfglayout
13042 Dump after converting to cfglayout mode.
13044 @item -fdump-rtl-ira
13045 @opindex fdump-rtl-ira
13046 Dump after iterated register allocation.
13048 @item -fdump-rtl-jump
13049 @opindex fdump-rtl-jump
13050 Dump after the second jump optimization.
13052 @item -fdump-rtl-loop2
13053 @opindex fdump-rtl-loop2
13054 @option{-fdump-rtl-loop2} enables dumping after the rtl
13055 loop optimization passes.
13057 @item -fdump-rtl-mach
13058 @opindex fdump-rtl-mach
13059 Dump after performing the machine dependent reorganization pass, if that
13060 pass exists.
13062 @item -fdump-rtl-mode_sw
13063 @opindex fdump-rtl-mode_sw
13064 Dump after removing redundant mode switches.
13066 @item -fdump-rtl-rnreg
13067 @opindex fdump-rtl-rnreg
13068 Dump after register renumbering.
13070 @item -fdump-rtl-outof_cfglayout
13071 @opindex fdump-rtl-outof_cfglayout
13072 Dump after converting from cfglayout mode.
13074 @item -fdump-rtl-peephole2
13075 @opindex fdump-rtl-peephole2
13076 Dump after the peephole pass.
13078 @item -fdump-rtl-postreload
13079 @opindex fdump-rtl-postreload
13080 Dump after post-reload optimizations.
13082 @item -fdump-rtl-pro_and_epilogue
13083 @opindex fdump-rtl-pro_and_epilogue
13084 Dump after generating the function prologues and epilogues.
13086 @item -fdump-rtl-sched1
13087 @itemx -fdump-rtl-sched2
13088 @opindex fdump-rtl-sched1
13089 @opindex fdump-rtl-sched2
13090 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
13091 after the basic block scheduling passes.
13093 @item -fdump-rtl-ree
13094 @opindex fdump-rtl-ree
13095 Dump after sign/zero extension elimination.
13097 @item -fdump-rtl-seqabstr
13098 @opindex fdump-rtl-seqabstr
13099 Dump after common sequence discovery.
13101 @item -fdump-rtl-shorten
13102 @opindex fdump-rtl-shorten
13103 Dump after shortening branches.
13105 @item -fdump-rtl-sibling
13106 @opindex fdump-rtl-sibling
13107 Dump after sibling call optimizations.
13109 @item -fdump-rtl-split1
13110 @itemx -fdump-rtl-split2
13111 @itemx -fdump-rtl-split3
13112 @itemx -fdump-rtl-split4
13113 @itemx -fdump-rtl-split5
13114 @opindex fdump-rtl-split1
13115 @opindex fdump-rtl-split2
13116 @opindex fdump-rtl-split3
13117 @opindex fdump-rtl-split4
13118 @opindex fdump-rtl-split5
13119 These options enable dumping after five rounds of
13120 instruction splitting.
13122 @item -fdump-rtl-sms
13123 @opindex fdump-rtl-sms
13124 Dump after modulo scheduling.  This pass is only run on some
13125 architectures.
13127 @item -fdump-rtl-stack
13128 @opindex fdump-rtl-stack
13129 Dump after conversion from GCC's ``flat register file'' registers to the
13130 x87's stack-like registers.  This pass is only run on x86 variants.
13132 @item -fdump-rtl-subreg1
13133 @itemx -fdump-rtl-subreg2
13134 @opindex fdump-rtl-subreg1
13135 @opindex fdump-rtl-subreg2
13136 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
13137 the two subreg expansion passes.
13139 @item -fdump-rtl-unshare
13140 @opindex fdump-rtl-unshare
13141 Dump after all rtl has been unshared.
13143 @item -fdump-rtl-vartrack
13144 @opindex fdump-rtl-vartrack
13145 Dump after variable tracking.
13147 @item -fdump-rtl-vregs
13148 @opindex fdump-rtl-vregs
13149 Dump after converting virtual registers to hard registers.
13151 @item -fdump-rtl-web
13152 @opindex fdump-rtl-web
13153 Dump after live range splitting.
13155 @item -fdump-rtl-regclass
13156 @itemx -fdump-rtl-subregs_of_mode_init
13157 @itemx -fdump-rtl-subregs_of_mode_finish
13158 @itemx -fdump-rtl-dfinit
13159 @itemx -fdump-rtl-dfinish
13160 @opindex fdump-rtl-regclass
13161 @opindex fdump-rtl-subregs_of_mode_init
13162 @opindex fdump-rtl-subregs_of_mode_finish
13163 @opindex fdump-rtl-dfinit
13164 @opindex fdump-rtl-dfinish
13165 These dumps are defined but always produce empty files.
13167 @item -da
13168 @itemx -fdump-rtl-all
13169 @opindex da
13170 @opindex fdump-rtl-all
13171 Produce all the dumps listed above.
13173 @item -dA
13174 @opindex dA
13175 Annotate the assembler output with miscellaneous debugging information.
13177 @item -dD
13178 @opindex dD
13179 Dump all macro definitions, at the end of preprocessing, in addition to
13180 normal output.
13182 @item -dH
13183 @opindex dH
13184 Produce a core dump whenever an error occurs.
13186 @item -dp
13187 @opindex dp
13188 Annotate the assembler output with a comment indicating which
13189 pattern and alternative is used.  The length of each instruction is
13190 also printed.
13192 @item -dP
13193 @opindex dP
13194 Dump the RTL in the assembler output as a comment before each instruction.
13195 Also turns on @option{-dp} annotation.
13197 @item -dx
13198 @opindex dx
13199 Just generate RTL for a function instead of compiling it.  Usually used
13200 with @option{-fdump-rtl-expand}.
13201 @end table
13203 @item -fdump-noaddr
13204 @opindex fdump-noaddr
13205 When doing debugging dumps, suppress address output.  This makes it more
13206 feasible to use diff on debugging dumps for compiler invocations with
13207 different compiler binaries and/or different
13208 text / bss / data / heap / stack / dso start locations.
13210 @item -freport-bug
13211 @opindex freport-bug
13212 Collect and dump debug information into a temporary file if an
13213 internal compiler error (ICE) occurs.
13215 @item -fdump-unnumbered
13216 @opindex fdump-unnumbered
13217 When doing debugging dumps, suppress instruction numbers and address output.
13218 This makes it more feasible to use diff on debugging dumps for compiler
13219 invocations with different options, in particular with and without
13220 @option{-g}.
13222 @item -fdump-unnumbered-links
13223 @opindex fdump-unnumbered-links
13224 When doing debugging dumps (see @option{-d} option above), suppress
13225 instruction numbers for the links to the previous and next instructions
13226 in a sequence.
13228 @item -fdump-ipa-@var{switch}
13229 @opindex fdump-ipa
13230 Control the dumping at various stages of inter-procedural analysis
13231 language tree to a file.  The file name is generated by appending a
13232 switch specific suffix to the source file name, and the file is created
13233 in the same directory as the output file.  The following dumps are
13234 possible:
13236 @table @samp
13237 @item all
13238 Enables all inter-procedural analysis dumps.
13240 @item cgraph
13241 Dumps information about call-graph optimization, unused function removal,
13242 and inlining decisions.
13244 @item inline
13245 Dump after function inlining.
13247 @end table
13249 @item -fdump-lang-all
13250 @itemx -fdump-lang-@var{switch}
13251 @itemx -fdump-lang-@var{switch}-@var{options}
13252 @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename}
13253 @opindex fdump-lang-all
13254 @opindex fdump-lang
13255 Control the dumping of language-specific information.  The @var{options}
13256 and @var{filename} portions behave as described in the
13257 @option{-fdump-tree} option.  The following @var{switch} values are
13258 accepted:
13260 @table @samp
13261 @item all
13263 Enable all language-specific dumps.
13265 @item class
13266 Dump class hierarchy information.  Virtual table information is emitted
13267 unless '@option{slim}' is specified.  This option is applicable to C++ only.
13269 @item raw
13270 Dump the raw internal tree data.  This option is applicable to C++ only.
13272 @end table
13274 @item -fdump-passes
13275 @opindex fdump-passes
13276 Print on @file{stderr} the list of optimization passes that are turned
13277 on and off by the current command-line options.
13279 @item -fdump-statistics-@var{option}
13280 @opindex fdump-statistics
13281 Enable and control dumping of pass statistics in a separate file.  The
13282 file name is generated by appending a suffix ending in
13283 @samp{.statistics} to the source file name, and the file is created in
13284 the same directory as the output file.  If the @samp{-@var{option}}
13285 form is used, @samp{-stats} causes counters to be summed over the
13286 whole compilation unit while @samp{-details} dumps every event as
13287 the passes generate them.  The default with no option is to sum
13288 counters for each function compiled.
13290 @item -fdump-tree-all
13291 @itemx -fdump-tree-@var{switch}
13292 @itemx -fdump-tree-@var{switch}-@var{options}
13293 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
13294 @opindex fdump-tree-all
13295 @opindex fdump-tree
13296 Control the dumping at various stages of processing the intermediate
13297 language tree to a file.  The file name is generated by appending a
13298 switch-specific suffix to the source file name, and the file is
13299 created in the same directory as the output file. In case of
13300 @option{=@var{filename}} option, the dump is output on the given file
13301 instead of the auto named dump files.  If the @samp{-@var{options}}
13302 form is used, @var{options} is a list of @samp{-} separated options
13303 which control the details of the dump.  Not all options are applicable
13304 to all dumps; those that are not meaningful are ignored.  The
13305 following options are available
13307 @table @samp
13308 @item address
13309 Print the address of each node.  Usually this is not meaningful as it
13310 changes according to the environment and source file.  Its primary use
13311 is for tying up a dump file with a debug environment.
13312 @item asmname
13313 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
13314 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
13315 use working backward from mangled names in the assembly file.
13316 @item slim
13317 When dumping front-end intermediate representations, inhibit dumping
13318 of members of a scope or body of a function merely because that scope
13319 has been reached.  Only dump such items when they are directly reachable
13320 by some other path.
13322 When dumping pretty-printed trees, this option inhibits dumping the
13323 bodies of control structures.
13325 When dumping RTL, print the RTL in slim (condensed) form instead of
13326 the default LISP-like representation.
13327 @item raw
13328 Print a raw representation of the tree.  By default, trees are
13329 pretty-printed into a C-like representation.
13330 @item details
13331 Enable more detailed dumps (not honored by every dump option). Also
13332 include information from the optimization passes.
13333 @item stats
13334 Enable dumping various statistics about the pass (not honored by every dump
13335 option).
13336 @item blocks
13337 Enable showing basic block boundaries (disabled in raw dumps).
13338 @item graph
13339 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
13340 dump a representation of the control flow graph suitable for viewing with
13341 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
13342 the file is pretty-printed as a subgraph, so that GraphViz can render them
13343 all in a single plot.
13345 This option currently only works for RTL dumps, and the RTL is always
13346 dumped in slim form.
13347 @item vops
13348 Enable showing virtual operands for every statement.
13349 @item lineno
13350 Enable showing line numbers for statements.
13351 @item uid
13352 Enable showing the unique ID (@code{DECL_UID}) for each variable.
13353 @item verbose
13354 Enable showing the tree dump for each statement.
13355 @item eh
13356 Enable showing the EH region number holding each statement.
13357 @item scev
13358 Enable showing scalar evolution analysis details.
13359 @item optimized
13360 Enable showing optimization information (only available in certain
13361 passes).
13362 @item missed
13363 Enable showing missed optimization information (only available in certain
13364 passes).
13365 @item note
13366 Enable other detailed optimization information (only available in
13367 certain passes).
13368 @item =@var{filename}
13369 Instead of an auto named dump file, output into the given file
13370 name. The file names @file{stdout} and @file{stderr} are treated
13371 specially and are considered already open standard streams. For
13372 example,
13374 @smallexample
13375 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
13376      -fdump-tree-pre=/dev/stderr file.c
13377 @end smallexample
13379 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
13380 output on to @file{stderr}. If two conflicting dump filenames are
13381 given for the same pass, then the latter option overrides the earlier
13382 one.
13384 @item all
13385 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
13386 and @option{lineno}.
13388 @item optall
13389 Turn on all optimization options, i.e., @option{optimized},
13390 @option{missed}, and @option{note}.
13391 @end table
13393 To determine what tree dumps are available or find the dump for a pass
13394 of interest follow the steps below.
13396 @enumerate
13397 @item
13398 Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output
13399 look for a code that corresponds to the pass you are interested in.
13400 For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and
13401 @code{tree-vrp2} correspond to the three Value Range Propagation passes.
13402 The number at the end distinguishes distinct invocations of the same pass.
13403 @item
13404 To enable the creation of the dump file, append the pass code to
13405 the @option{-fdump-} option prefix and invoke GCC with it.  For example,
13406 to enable the dump from the Early Value Range Propagation pass, invoke
13407 GCC with the @option{-fdump-tree-evrp} option.  Optionally, you may
13408 specify the name of the dump file.  If you don't specify one, GCC
13409 creates as described below.
13410 @item
13411 Find the pass dump in a file whose name is composed of three components
13412 separated by a period: the name of the source file GCC was invoked to
13413 compile, a numeric suffix indicating the pass number followed by the
13414 letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes),
13415 and finally the pass code.  For example, the Early VRP pass dump might
13416 be in a file named @file{myfile.c.038t.evrp} in the current working
13417 directory.  Note that the numeric codes are not stable and may change
13418 from one version of GCC to another.
13419 @end enumerate
13421 @item -fopt-info
13422 @itemx -fopt-info-@var{options}
13423 @itemx -fopt-info-@var{options}=@var{filename}
13424 @opindex fopt-info
13425 Controls optimization dumps from various optimization passes. If the
13426 @samp{-@var{options}} form is used, @var{options} is a list of
13427 @samp{-} separated option keywords to select the dump details and
13428 optimizations.  
13430 The @var{options} can be divided into two groups: options describing the
13431 verbosity of the dump, and options describing which optimizations
13432 should be included. The options from both the groups can be freely
13433 mixed as they are non-overlapping. However, in case of any conflicts,
13434 the later options override the earlier options on the command
13435 line. 
13437 The following options control the dump verbosity:
13439 @table @samp
13440 @item optimized
13441 Print information when an optimization is successfully applied. It is
13442 up to a pass to decide which information is relevant. For example, the
13443 vectorizer passes print the source location of loops which are
13444 successfully vectorized.
13445 @item missed
13446 Print information about missed optimizations. Individual passes
13447 control which information to include in the output. 
13448 @item note
13449 Print verbose information about optimizations, such as certain
13450 transformations, more detailed messages about decisions etc.
13451 @item all
13452 Print detailed optimization information. This includes
13453 @samp{optimized}, @samp{missed}, and @samp{note}.
13454 @end table
13456 One or more of the following option keywords can be used to describe a
13457 group of optimizations:
13459 @table @samp
13460 @item ipa
13461 Enable dumps from all interprocedural optimizations.
13462 @item loop
13463 Enable dumps from all loop optimizations.
13464 @item inline
13465 Enable dumps from all inlining optimizations.
13466 @item omp
13467 Enable dumps from all OMP (Offloading and Multi Processing) optimizations.
13468 @item vec
13469 Enable dumps from all vectorization optimizations.
13470 @item optall
13471 Enable dumps from all optimizations. This is a superset of
13472 the optimization groups listed above.
13473 @end table
13475 If @var{options} is
13476 omitted, it defaults to @samp{optimized-optall}, which means to dump all
13477 info about successful optimizations from all the passes.  
13479 If the @var{filename} is provided, then the dumps from all the
13480 applicable optimizations are concatenated into the @var{filename}.
13481 Otherwise the dump is output onto @file{stderr}. Though multiple
13482 @option{-fopt-info} options are accepted, only one of them can include
13483 a @var{filename}. If other filenames are provided then all but the
13484 first such option are ignored.
13486 Note that the output @var{filename} is overwritten
13487 in case of multiple translation units. If a combined output from
13488 multiple translation units is desired, @file{stderr} should be used
13489 instead.
13491 In the following example, the optimization info is output to
13492 @file{stderr}:
13494 @smallexample
13495 gcc -O3 -fopt-info
13496 @end smallexample
13498 This example:
13499 @smallexample
13500 gcc -O3 -fopt-info-missed=missed.all
13501 @end smallexample
13503 @noindent
13504 outputs missed optimization report from all the passes into
13505 @file{missed.all}, and this one:
13507 @smallexample
13508 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
13509 @end smallexample
13511 @noindent
13512 prints information about missed optimization opportunities from
13513 vectorization passes on @file{stderr}.  
13514 Note that @option{-fopt-info-vec-missed} is equivalent to 
13515 @option{-fopt-info-missed-vec}.  The order of the optimization group
13516 names and message types listed after @option{-fopt-info} does not matter.
13518 As another example,
13519 @smallexample
13520 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
13521 @end smallexample
13523 @noindent
13524 outputs information about missed optimizations as well as
13525 optimized locations from all the inlining passes into
13526 @file{inline.txt}.
13528 Finally, consider:
13530 @smallexample
13531 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
13532 @end smallexample
13534 @noindent
13535 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
13536 in conflict since only one output file is allowed. In this case, only
13537 the first option takes effect and the subsequent options are
13538 ignored. Thus only @file{vec.miss} is produced which contains
13539 dumps from the vectorizer about missed opportunities.
13541 @item -fsched-verbose=@var{n}
13542 @opindex fsched-verbose
13543 On targets that use instruction scheduling, this option controls the
13544 amount of debugging output the scheduler prints to the dump files.
13546 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
13547 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
13548 For @var{n} greater than one, it also output basic block probabilities,
13549 detailed ready list information and unit/insn info.  For @var{n} greater
13550 than two, it includes RTL at abort point, control-flow and regions info.
13551 And for @var{n} over four, @option{-fsched-verbose} also includes
13552 dependence info.
13556 @item -fenable-@var{kind}-@var{pass}
13557 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
13558 @opindex fdisable-
13559 @opindex fenable-
13561 This is a set of options that are used to explicitly disable/enable
13562 optimization passes.  These options are intended for use for debugging GCC.
13563 Compiler users should use regular options for enabling/disabling
13564 passes instead.
13566 @table @gcctabopt
13568 @item -fdisable-ipa-@var{pass}
13569 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
13570 statically invoked in the compiler multiple times, the pass name should be
13571 appended with a sequential number starting from 1.
13573 @item -fdisable-rtl-@var{pass}
13574 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
13575 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13576 statically invoked in the compiler multiple times, the pass name should be
13577 appended with a sequential number starting from 1.  @var{range-list} is a 
13578 comma-separated list of function ranges or assembler names.  Each range is a number
13579 pair separated by a colon.  The range is inclusive in both ends.  If the range
13580 is trivial, the number pair can be simplified as a single number.  If the
13581 function's call graph node's @var{uid} falls within one of the specified ranges,
13582 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
13583 function header of a dump file, and the pass names can be dumped by using
13584 option @option{-fdump-passes}.
13586 @item -fdisable-tree-@var{pass}
13587 @itemx -fdisable-tree-@var{pass}=@var{range-list}
13588 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
13589 option arguments.
13591 @item -fenable-ipa-@var{pass}
13592 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
13593 statically invoked in the compiler multiple times, the pass name should be
13594 appended with a sequential number starting from 1.
13596 @item -fenable-rtl-@var{pass}
13597 @itemx -fenable-rtl-@var{pass}=@var{range-list}
13598 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
13599 description and examples.
13601 @item -fenable-tree-@var{pass}
13602 @itemx -fenable-tree-@var{pass}=@var{range-list}
13603 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
13604 of option arguments.
13606 @end table
13608 Here are some examples showing uses of these options.
13610 @smallexample
13612 # disable ccp1 for all functions
13613    -fdisable-tree-ccp1
13614 # disable complete unroll for function whose cgraph node uid is 1
13615    -fenable-tree-cunroll=1
13616 # disable gcse2 for functions at the following ranges [1,1],
13617 # [300,400], and [400,1000]
13618 # disable gcse2 for functions foo and foo2
13619    -fdisable-rtl-gcse2=foo,foo2
13620 # disable early inlining
13621    -fdisable-tree-einline
13622 # disable ipa inlining
13623    -fdisable-ipa-inline
13624 # enable tree full unroll
13625    -fenable-tree-unroll
13627 @end smallexample
13629 @item -fchecking
13630 @itemx -fchecking=@var{n}
13631 @opindex fchecking
13632 @opindex fno-checking
13633 Enable internal consistency checking.  The default depends on
13634 the compiler configuration.  @option{-fchecking=2} enables further
13635 internal consistency checking that might affect code generation.
13637 @item -frandom-seed=@var{string}
13638 @opindex frandom-seed
13639 This option provides a seed that GCC uses in place of
13640 random numbers in generating certain symbol names
13641 that have to be different in every compiled file.  It is also used to
13642 place unique stamps in coverage data files and the object files that
13643 produce them.  You can use the @option{-frandom-seed} option to produce
13644 reproducibly identical object files.
13646 The @var{string} can either be a number (decimal, octal or hex) or an
13647 arbitrary string (in which case it's converted to a number by
13648 computing CRC32).
13650 The @var{string} should be different for every file you compile.
13652 @item -save-temps
13653 @itemx -save-temps=cwd
13654 @opindex save-temps
13655 Store the usual ``temporary'' intermediate files permanently; place them
13656 in the current directory and name them based on the source file.  Thus,
13657 compiling @file{foo.c} with @option{-c -save-temps} produces files
13658 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
13659 preprocessed @file{foo.i} output file even though the compiler now
13660 normally uses an integrated preprocessor.
13662 When used in combination with the @option{-x} command-line option,
13663 @option{-save-temps} is sensible enough to avoid over writing an
13664 input source file with the same extension as an intermediate file.
13665 The corresponding intermediate file may be obtained by renaming the
13666 source file before using @option{-save-temps}.
13668 If you invoke GCC in parallel, compiling several different source
13669 files that share a common base name in different subdirectories or the
13670 same source file compiled for multiple output destinations, it is
13671 likely that the different parallel compilers will interfere with each
13672 other, and overwrite the temporary files.  For instance:
13674 @smallexample
13675 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
13676 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
13677 @end smallexample
13679 may result in @file{foo.i} and @file{foo.o} being written to
13680 simultaneously by both compilers.
13682 @item -save-temps=obj
13683 @opindex save-temps=obj
13684 Store the usual ``temporary'' intermediate files permanently.  If the
13685 @option{-o} option is used, the temporary files are based on the
13686 object file.  If the @option{-o} option is not used, the
13687 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
13689 For example:
13691 @smallexample
13692 gcc -save-temps=obj -c foo.c
13693 gcc -save-temps=obj -c bar.c -o dir/xbar.o
13694 gcc -save-temps=obj foobar.c -o dir2/yfoobar
13695 @end smallexample
13697 @noindent
13698 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
13699 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
13700 @file{dir2/yfoobar.o}.
13702 @item -time@r{[}=@var{file}@r{]}
13703 @opindex time
13704 Report the CPU time taken by each subprocess in the compilation
13705 sequence.  For C source files, this is the compiler proper and assembler
13706 (plus the linker if linking is done).
13708 Without the specification of an output file, the output looks like this:
13710 @smallexample
13711 # cc1 0.12 0.01
13712 # as 0.00 0.01
13713 @end smallexample
13715 The first number on each line is the ``user time'', that is time spent
13716 executing the program itself.  The second number is ``system time'',
13717 time spent executing operating system routines on behalf of the program.
13718 Both numbers are in seconds.
13720 With the specification of an output file, the output is appended to the
13721 named file, and it looks like this:
13723 @smallexample
13724 0.12 0.01 cc1 @var{options}
13725 0.00 0.01 as @var{options}
13726 @end smallexample
13728 The ``user time'' and the ``system time'' are moved before the program
13729 name, and the options passed to the program are displayed, so that one
13730 can later tell what file was being compiled, and with which options.
13732 @item -fdump-final-insns@r{[}=@var{file}@r{]}
13733 @opindex fdump-final-insns
13734 Dump the final internal representation (RTL) to @var{file}.  If the
13735 optional argument is omitted (or if @var{file} is @code{.}), the name
13736 of the dump file is determined by appending @code{.gkd} to the
13737 compilation output file name.
13739 @item -fcompare-debug@r{[}=@var{opts}@r{]}
13740 @opindex fcompare-debug
13741 @opindex fno-compare-debug
13742 If no error occurs during compilation, run the compiler a second time,
13743 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
13744 passed to the second compilation.  Dump the final internal
13745 representation in both compilations, and print an error if they differ.
13747 If the equal sign is omitted, the default @option{-gtoggle} is used.
13749 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
13750 and nonzero, implicitly enables @option{-fcompare-debug}.  If
13751 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
13752 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
13753 is used.
13755 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
13756 is equivalent to @option{-fno-compare-debug}, which disables the dumping
13757 of the final representation and the second compilation, preventing even
13758 @env{GCC_COMPARE_DEBUG} from taking effect.
13760 To verify full coverage during @option{-fcompare-debug} testing, set
13761 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
13762 which GCC rejects as an invalid option in any actual compilation
13763 (rather than preprocessing, assembly or linking).  To get just a
13764 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
13765 not overridden} will do.
13767 @item -fcompare-debug-second
13768 @opindex fcompare-debug-second
13769 This option is implicitly passed to the compiler for the second
13770 compilation requested by @option{-fcompare-debug}, along with options to
13771 silence warnings, and omitting other options that would cause
13772 side-effect compiler outputs to files or to the standard output.  Dump
13773 files and preserved temporary files are renamed so as to contain the
13774 @code{.gk} additional extension during the second compilation, to avoid
13775 overwriting those generated by the first.
13777 When this option is passed to the compiler driver, it causes the
13778 @emph{first} compilation to be skipped, which makes it useful for little
13779 other than debugging the compiler proper.
13781 @item -gtoggle
13782 @opindex gtoggle
13783 Turn off generation of debug info, if leaving out this option
13784 generates it, or turn it on at level 2 otherwise.  The position of this
13785 argument in the command line does not matter; it takes effect after all
13786 other options are processed, and it does so only once, no matter how
13787 many times it is given.  This is mainly intended to be used with
13788 @option{-fcompare-debug}.
13790 @item -fvar-tracking-assignments-toggle
13791 @opindex fvar-tracking-assignments-toggle
13792 @opindex fno-var-tracking-assignments-toggle
13793 Toggle @option{-fvar-tracking-assignments}, in the same way that
13794 @option{-gtoggle} toggles @option{-g}.
13796 @item -Q
13797 @opindex Q
13798 Makes the compiler print out each function name as it is compiled, and
13799 print some statistics about each pass when it finishes.
13801 @item -ftime-report
13802 @opindex ftime-report
13803 Makes the compiler print some statistics about the time consumed by each
13804 pass when it finishes.
13806 @item -ftime-report-details
13807 @opindex ftime-report-details
13808 Record the time consumed by infrastructure parts separately for each pass.
13810 @item -fira-verbose=@var{n}
13811 @opindex fira-verbose
13812 Control the verbosity of the dump file for the integrated register allocator.
13813 The default value is 5.  If the value @var{n} is greater or equal to 10,
13814 the dump output is sent to stderr using the same format as @var{n} minus 10.
13816 @item -flto-report
13817 @opindex flto-report
13818 Prints a report with internal details on the workings of the link-time
13819 optimizer.  The contents of this report vary from version to version.
13820 It is meant to be useful to GCC developers when processing object
13821 files in LTO mode (via @option{-flto}).
13823 Disabled by default.
13825 @item -flto-report-wpa
13826 @opindex flto-report-wpa
13827 Like @option{-flto-report}, but only print for the WPA phase of Link
13828 Time Optimization.
13830 @item -fmem-report
13831 @opindex fmem-report
13832 Makes the compiler print some statistics about permanent memory
13833 allocation when it finishes.
13835 @item -fmem-report-wpa
13836 @opindex fmem-report-wpa
13837 Makes the compiler print some statistics about permanent memory
13838 allocation for the WPA phase only.
13840 @item -fpre-ipa-mem-report
13841 @opindex fpre-ipa-mem-report
13842 @item -fpost-ipa-mem-report
13843 @opindex fpost-ipa-mem-report
13844 Makes the compiler print some statistics about permanent memory
13845 allocation before or after interprocedural optimization.
13847 @item -fprofile-report
13848 @opindex fprofile-report
13849 Makes the compiler print some statistics about consistency of the
13850 (estimated) profile and effect of individual passes.
13852 @item -fstack-usage
13853 @opindex fstack-usage
13854 Makes the compiler output stack usage information for the program, on a
13855 per-function basis.  The filename for the dump is made by appending
13856 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
13857 the output file, if explicitly specified and it is not an executable,
13858 otherwise it is the basename of the source file.  An entry is made up
13859 of three fields:
13861 @itemize
13862 @item
13863 The name of the function.
13864 @item
13865 A number of bytes.
13866 @item
13867 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
13868 @end itemize
13870 The qualifier @code{static} means that the function manipulates the stack
13871 statically: a fixed number of bytes are allocated for the frame on function
13872 entry and released on function exit; no stack adjustments are otherwise made
13873 in the function.  The second field is this fixed number of bytes.
13875 The qualifier @code{dynamic} means that the function manipulates the stack
13876 dynamically: in addition to the static allocation described above, stack
13877 adjustments are made in the body of the function, for example to push/pop
13878 arguments around function calls.  If the qualifier @code{bounded} is also
13879 present, the amount of these adjustments is bounded at compile time and
13880 the second field is an upper bound of the total amount of stack used by
13881 the function.  If it is not present, the amount of these adjustments is
13882 not bounded at compile time and the second field only represents the
13883 bounded part.
13885 @item -fstats
13886 @opindex fstats
13887 Emit statistics about front-end processing at the end of the compilation.
13888 This option is supported only by the C++ front end, and
13889 the information is generally only useful to the G++ development team.
13891 @item -fdbg-cnt-list
13892 @opindex fdbg-cnt-list
13893 Print the name and the counter upper bound for all debug counters.
13896 @item -fdbg-cnt=@var{counter-value-list}
13897 @opindex fdbg-cnt
13898 Set the internal debug counter upper bound.  @var{counter-value-list}
13899 is a comma-separated list of @var{name}:@var{value} pairs
13900 which sets the upper bound of each debug counter @var{name} to @var{value}.
13901 All debug counters have the initial upper bound of @code{UINT_MAX};
13902 thus @code{dbg_cnt} returns true always unless the upper bound
13903 is set by this option.
13904 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
13905 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
13907 @item -print-file-name=@var{library}
13908 @opindex print-file-name
13909 Print the full absolute name of the library file @var{library} that
13910 would be used when linking---and don't do anything else.  With this
13911 option, GCC does not compile or link anything; it just prints the
13912 file name.
13914 @item -print-multi-directory
13915 @opindex print-multi-directory
13916 Print the directory name corresponding to the multilib selected by any
13917 other switches present in the command line.  This directory is supposed
13918 to exist in @env{GCC_EXEC_PREFIX}.
13920 @item -print-multi-lib
13921 @opindex print-multi-lib
13922 Print the mapping from multilib directory names to compiler switches
13923 that enable them.  The directory name is separated from the switches by
13924 @samp{;}, and each switch starts with an @samp{@@} instead of the
13925 @samp{-}, without spaces between multiple switches.  This is supposed to
13926 ease shell processing.
13928 @item -print-multi-os-directory
13929 @opindex print-multi-os-directory
13930 Print the path to OS libraries for the selected
13931 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
13932 present in the @file{lib} subdirectory and no multilibs are used, this is
13933 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
13934 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
13935 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
13936 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
13938 @item -print-multiarch
13939 @opindex print-multiarch
13940 Print the path to OS libraries for the selected multiarch,
13941 relative to some @file{lib} subdirectory.
13943 @item -print-prog-name=@var{program}
13944 @opindex print-prog-name
13945 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
13947 @item -print-libgcc-file-name
13948 @opindex print-libgcc-file-name
13949 Same as @option{-print-file-name=libgcc.a}.
13951 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
13952 but you do want to link with @file{libgcc.a}.  You can do:
13954 @smallexample
13955 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
13956 @end smallexample
13958 @item -print-search-dirs
13959 @opindex print-search-dirs
13960 Print the name of the configured installation directory and a list of
13961 program and library directories @command{gcc} searches---and don't do anything else.
13963 This is useful when @command{gcc} prints the error message
13964 @samp{installation problem, cannot exec cpp0: No such file or directory}.
13965 To resolve this you either need to put @file{cpp0} and the other compiler
13966 components where @command{gcc} expects to find them, or you can set the environment
13967 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
13968 Don't forget the trailing @samp{/}.
13969 @xref{Environment Variables}.
13971 @item -print-sysroot
13972 @opindex print-sysroot
13973 Print the target sysroot directory that is used during
13974 compilation.  This is the target sysroot specified either at configure
13975 time or using the @option{--sysroot} option, possibly with an extra
13976 suffix that depends on compilation options.  If no target sysroot is
13977 specified, the option prints nothing.
13979 @item -print-sysroot-headers-suffix
13980 @opindex print-sysroot-headers-suffix
13981 Print the suffix added to the target sysroot when searching for
13982 headers, or give an error if the compiler is not configured with such
13983 a suffix---and don't do anything else.
13985 @item -dumpmachine
13986 @opindex dumpmachine
13987 Print the compiler's target machine (for example,
13988 @samp{i686-pc-linux-gnu})---and don't do anything else.
13990 @item -dumpversion
13991 @opindex dumpversion
13992 Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do
13993 anything else.  This is the compiler version used in filesystem paths,
13994 specs, can be depending on how the compiler has been configured just
13995 a single number (major version), two numbers separated by dot (major and
13996 minor version) or three numbers separated by dots (major, minor and patchlevel
13997 version).
13999 @item -dumpfullversion
14000 @opindex dumpfullversion
14001 Print the full compiler version, always 3 numbers separated by dots,
14002 major, minor and patchlevel version.
14004 @item -dumpspecs
14005 @opindex dumpspecs
14006 Print the compiler's built-in specs---and don't do anything else.  (This
14007 is used when GCC itself is being built.)  @xref{Spec Files}.
14008 @end table
14010 @node Submodel Options
14011 @section Machine-Dependent Options
14012 @cindex submodel options
14013 @cindex specifying hardware config
14014 @cindex hardware models and configurations, specifying
14015 @cindex target-dependent options
14016 @cindex machine-dependent options
14018 Each target machine supported by GCC can have its own options---for
14019 example, to allow you to compile for a particular processor variant or
14020 ABI, or to control optimizations specific to that machine.  By
14021 convention, the names of machine-specific options start with
14022 @samp{-m}.
14024 Some configurations of the compiler also support additional target-specific
14025 options, usually for compatibility with other compilers on the same
14026 platform.
14028 @c This list is ordered alphanumerically by subsection name.
14029 @c It should be the same order and spelling as these options are listed
14030 @c in Machine Dependent Options
14032 @menu
14033 * AArch64 Options::
14034 * Adapteva Epiphany Options::
14035 * ARC Options::
14036 * ARM Options::
14037 * AVR Options::
14038 * Blackfin Options::
14039 * C6X Options::
14040 * CRIS Options::
14041 * CR16 Options::
14042 * Darwin Options::
14043 * DEC Alpha Options::
14044 * FR30 Options::
14045 * FT32 Options::
14046 * FRV Options::
14047 * GNU/Linux Options::
14048 * H8/300 Options::
14049 * HPPA Options::
14050 * IA-64 Options::
14051 * LM32 Options::
14052 * M32C Options::
14053 * M32R/D Options::
14054 * M680x0 Options::
14055 * MCore Options::
14056 * MeP Options::
14057 * MicroBlaze Options::
14058 * MIPS Options::
14059 * MMIX Options::
14060 * MN10300 Options::
14061 * Moxie Options::
14062 * MSP430 Options::
14063 * NDS32 Options::
14064 * Nios II Options::
14065 * Nvidia PTX Options::
14066 * PDP-11 Options::
14067 * picoChip Options::
14068 * PowerPC Options::
14069 * RISC-V Options::
14070 * RL78 Options::
14071 * RS/6000 and PowerPC Options::
14072 * RX Options::
14073 * S/390 and zSeries Options::
14074 * Score Options::
14075 * SH Options::
14076 * Solaris 2 Options::
14077 * SPARC Options::
14078 * SPU Options::
14079 * System V Options::
14080 * TILE-Gx Options::
14081 * TILEPro Options::
14082 * V850 Options::
14083 * VAX Options::
14084 * Visium Options::
14085 * VMS Options::
14086 * VxWorks Options::
14087 * x86 Options::
14088 * x86 Windows Options::
14089 * Xstormy16 Options::
14090 * Xtensa Options::
14091 * zSeries Options::
14092 @end menu
14094 @node AArch64 Options
14095 @subsection AArch64 Options
14096 @cindex AArch64 Options
14098 These options are defined for AArch64 implementations:
14100 @table @gcctabopt
14102 @item -mabi=@var{name}
14103 @opindex mabi
14104 Generate code for the specified data model.  Permissible values
14105 are @samp{ilp32} for SysV-like data model where int, long int and pointers
14106 are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits,
14107 but long int and pointers are 64 bits.
14109 The default depends on the specific target configuration.  Note that
14110 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
14111 entire program with the same ABI, and link with a compatible set of libraries.
14113 @item -mbig-endian
14114 @opindex mbig-endian
14115 Generate big-endian code.  This is the default when GCC is configured for an
14116 @samp{aarch64_be-*-*} target.
14118 @item -mgeneral-regs-only
14119 @opindex mgeneral-regs-only
14120 Generate code which uses only the general-purpose registers.  This will prevent
14121 the compiler from using floating-point and Advanced SIMD registers but will not
14122 impose any restrictions on the assembler.
14124 @item -mlittle-endian
14125 @opindex mlittle-endian
14126 Generate little-endian code.  This is the default when GCC is configured for an
14127 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
14129 @item -mcmodel=tiny
14130 @opindex mcmodel=tiny
14131 Generate code for the tiny code model.  The program and its statically defined
14132 symbols must be within 1MB of each other.  Programs can be statically or
14133 dynamically linked.
14135 @item -mcmodel=small
14136 @opindex mcmodel=small
14137 Generate code for the small code model.  The program and its statically defined
14138 symbols must be within 4GB of each other.  Programs can be statically or
14139 dynamically linked.  This is the default code model.
14141 @item -mcmodel=large
14142 @opindex mcmodel=large
14143 Generate code for the large code model.  This makes no assumptions about
14144 addresses and sizes of sections.  Programs can be statically linked only.
14146 @item -mstrict-align
14147 @opindex mstrict-align
14148 Avoid generating memory accesses that may not be aligned on a natural object
14149 boundary as described in the architecture specification.
14151 @item -momit-leaf-frame-pointer
14152 @itemx -mno-omit-leaf-frame-pointer
14153 @opindex momit-leaf-frame-pointer
14154 @opindex mno-omit-leaf-frame-pointer
14155 Omit or keep the frame pointer in leaf functions.  The former behavior is the
14156 default.
14158 @item -mtls-dialect=desc
14159 @opindex mtls-dialect=desc
14160 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
14161 of TLS variables.  This is the default.
14163 @item -mtls-dialect=traditional
14164 @opindex mtls-dialect=traditional
14165 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
14166 of TLS variables.
14168 @item -mtls-size=@var{size}
14169 @opindex mtls-size
14170 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
14171 This option requires binutils 2.26 or newer.
14173 @item -mfix-cortex-a53-835769
14174 @itemx -mno-fix-cortex-a53-835769
14175 @opindex mfix-cortex-a53-835769
14176 @opindex mno-fix-cortex-a53-835769
14177 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
14178 This involves inserting a NOP instruction between memory instructions and
14179 64-bit integer multiply-accumulate instructions.
14181 @item -mfix-cortex-a53-843419
14182 @itemx -mno-fix-cortex-a53-843419
14183 @opindex mfix-cortex-a53-843419
14184 @opindex mno-fix-cortex-a53-843419
14185 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
14186 This erratum workaround is made at link time and this will only pass the
14187 corresponding flag to the linker.
14189 @item -mlow-precision-recip-sqrt
14190 @item -mno-low-precision-recip-sqrt
14191 @opindex mlow-precision-recip-sqrt
14192 @opindex mno-low-precision-recip-sqrt
14193 Enable or disable the reciprocal square root approximation.
14194 This option only has an effect if @option{-ffast-math} or
14195 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14196 precision of reciprocal square root results to about 16 bits for
14197 single precision and to 32 bits for double precision.
14199 @item -mlow-precision-sqrt
14200 @item -mno-low-precision-sqrt
14201 @opindex -mlow-precision-sqrt
14202 @opindex -mno-low-precision-sqrt
14203 Enable or disable the square root approximation.
14204 This option only has an effect if @option{-ffast-math} or
14205 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14206 precision of square root results to about 16 bits for
14207 single precision and to 32 bits for double precision.
14208 If enabled, it implies @option{-mlow-precision-recip-sqrt}.
14210 @item -mlow-precision-div
14211 @item -mno-low-precision-div
14212 @opindex -mlow-precision-div
14213 @opindex -mno-low-precision-div
14214 Enable or disable the division approximation.
14215 This option only has an effect if @option{-ffast-math} or
14216 @option{-funsafe-math-optimizations} is used as well.  Enabling this reduces
14217 precision of division results to about 16 bits for
14218 single precision and to 32 bits for double precision.
14220 @item -march=@var{name}
14221 @opindex march
14222 Specify the name of the target architecture and, optionally, one or
14223 more feature modifiers.  This option has the form
14224 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
14226 The permissible values for @var{arch} are @samp{armv8-a},
14227 @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a} or @var{native}.
14229 The value @samp{armv8.3-a} implies @samp{armv8.2-a} and enables compiler
14230 support for the ARMv8.3-A architecture extensions.
14232 The value @samp{armv8.2-a} implies @samp{armv8.1-a} and enables compiler
14233 support for the ARMv8.2-A architecture extensions.
14235 The value @samp{armv8.1-a} implies @samp{armv8-a} and enables compiler
14236 support for the ARMv8.1-A architecture extension.  In particular, it
14237 enables the @samp{+crc}, @samp{+lse}, and @samp{+rdma} features.
14239 The value @samp{native} is available on native AArch64 GNU/Linux and
14240 causes the compiler to pick the architecture of the host system.  This
14241 option has no effect if the compiler is unable to recognize the
14242 architecture of the host system,
14244 The permissible values for @var{feature} are listed in the sub-section
14245 on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14246 Feature Modifiers}.  Where conflicting feature modifiers are
14247 specified, the right-most feature is used.
14249 GCC uses @var{name} to determine what kind of instructions it can emit
14250 when generating assembly code.  If @option{-march} is specified
14251 without either of @option{-mtune} or @option{-mcpu} also being
14252 specified, the code is tuned to perform well across a range of target
14253 processors implementing the target architecture.
14255 @item -mtune=@var{name}
14256 @opindex mtune
14257 Specify the name of the target processor for which GCC should tune the
14258 performance of the code.  Permissible values for this option are:
14259 @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
14260 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
14261 @samp{exynos-m1}, @samp{falkor}, @samp{qdf24xx},
14262 @samp{xgene1}, @samp{vulcan}, @samp{thunderx},
14263 @samp{thunderxt88}, @samp{thunderxt88p1}, @samp{thunderxt81},
14264 @samp{thunderxt83}, @samp{thunderx2t99}, @samp{cortex-a57.cortex-a53},
14265 @samp{cortex-a72.cortex-a53}, @samp{cortex-a73.cortex-a35},
14266 @samp{cortex-a73.cortex-a53}, @samp{cortex-a75.cortex-a55},
14267 @samp{native}.
14269 The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
14270 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53},
14271 @samp{cortex-a75.cortex-a55} specify that GCC should tune for a
14272 big.LITTLE system.
14274 Additionally on native AArch64 GNU/Linux systems the value
14275 @samp{native} tunes performance to the host system.  This option has no effect
14276 if the compiler is unable to recognize the processor of the host system.
14278 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
14279 are specified, the code is tuned to perform well across a range
14280 of target processors.
14282 This option cannot be suffixed by feature modifiers.
14284 @item -mcpu=@var{name}
14285 @opindex mcpu
14286 Specify the name of the target processor, optionally suffixed by one
14287 or more feature modifiers.  This option has the form
14288 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
14289 the permissible values for @var{cpu} are the same as those available
14290 for @option{-mtune}.  The permissible values for @var{feature} are
14291 documented in the sub-section on
14292 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
14293 Feature Modifiers}.  Where conflicting feature modifiers are
14294 specified, the right-most feature is used.
14296 GCC uses @var{name} to determine what kind of instructions it can emit when
14297 generating assembly code (as if by @option{-march}) and to determine
14298 the target processor for which to tune for performance (as if
14299 by @option{-mtune}).  Where this option is used in conjunction
14300 with @option{-march} or @option{-mtune}, those options take precedence
14301 over the appropriate part of this option.
14303 @item -moverride=@var{string}
14304 @opindex moverride
14305 Override tuning decisions made by the back-end in response to a
14306 @option{-mtune=} switch.  The syntax, semantics, and accepted values
14307 for @var{string} in this option are not guaranteed to be consistent
14308 across releases.
14310 This option is only intended to be useful when developing GCC.
14312 @item -mpc-relative-literal-loads
14313 @itemx -mno-pc-relative-literal-loads
14314 @opindex mpc-relative-literal-loads
14315 @opindex mno-pc-relative-literal-loads
14316 Enable or disable PC-relative literal loads.  With this option literal pools are
14317 accessed using a single instruction and emitted after each function.  This
14318 limits the maximum size of functions to 1MB.  This is enabled by default for
14319 @option{-mcmodel=tiny}.
14321 @item -msign-return-address=@var{scope}
14322 @opindex msign-return-address
14323 Select the function scope on which return address signing will be applied.
14324 Permissible values are @samp{none}, which disables return address signing,
14325 @samp{non-leaf}, which enables pointer signing for functions which are not leaf
14326 functions, and @samp{all}, which enables pointer signing for all functions.  The
14327 default value is @samp{none}.
14329 @end table
14331 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
14332 @anchor{aarch64-feature-modifiers}
14333 @cindex @option{-march} feature modifiers
14334 @cindex @option{-mcpu} feature modifiers
14335 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
14336 the following and their inverses @option{no@var{feature}}:
14338 @table @samp
14339 @item crc
14340 Enable CRC extension.  This is on by default for
14341 @option{-march=armv8.1-a}.
14342 @item crypto
14343 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
14344 instructions.
14345 @item fp
14346 Enable floating-point instructions.  This is on by default for all possible
14347 values for options @option{-march} and @option{-mcpu}.
14348 @item simd
14349 Enable Advanced SIMD instructions.  This also enables floating-point
14350 instructions.  This is on by default for all possible values for options
14351 @option{-march} and @option{-mcpu}.
14352 @item lse
14353 Enable Large System Extension instructions.  This is on by default for
14354 @option{-march=armv8.1-a}.
14355 @item rdma
14356 Enable Round Double Multiply Accumulate instructions.  This is on by default
14357 for @option{-march=armv8.1-a}.
14358 @item fp16
14359 Enable FP16 extension.  This also enables floating-point instructions.
14360 @item rcpc
14361 Enable the RcPc extension.  This does not change code generation from GCC,
14362 but is passed on to the assembler, enabling inline asm statements to use
14363 instructions from the RcPc extension.
14365 @end table
14367 Feature @option{crypto} implies @option{simd}, which implies @option{fp}.
14368 Conversely, @option{nofp} implies @option{nosimd}, which implies
14369 @option{nocrypto}.
14371 @node Adapteva Epiphany Options
14372 @subsection Adapteva Epiphany Options
14374 These @samp{-m} options are defined for Adapteva Epiphany:
14376 @table @gcctabopt
14377 @item -mhalf-reg-file
14378 @opindex mhalf-reg-file
14379 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
14380 That allows code to run on hardware variants that lack these registers.
14382 @item -mprefer-short-insn-regs
14383 @opindex mprefer-short-insn-regs
14384 Preferentially allocate registers that allow short instruction generation.
14385 This can result in increased instruction count, so this may either reduce or
14386 increase overall code size.
14388 @item -mbranch-cost=@var{num}
14389 @opindex mbranch-cost
14390 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14391 This cost is only a heuristic and is not guaranteed to produce
14392 consistent results across releases.
14394 @item -mcmove
14395 @opindex mcmove
14396 Enable the generation of conditional moves.
14398 @item -mnops=@var{num}
14399 @opindex mnops
14400 Emit @var{num} NOPs before every other generated instruction.
14402 @item -mno-soft-cmpsf
14403 @opindex mno-soft-cmpsf
14404 For single-precision floating-point comparisons, emit an @code{fsub} instruction
14405 and test the flags.  This is faster than a software comparison, but can
14406 get incorrect results in the presence of NaNs, or when two different small
14407 numbers are compared such that their difference is calculated as zero.
14408 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
14409 software comparisons.
14411 @item -mstack-offset=@var{num}
14412 @opindex mstack-offset
14413 Set the offset between the top of the stack and the stack pointer.
14414 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
14415 can be used by leaf functions without stack allocation.
14416 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
14417 Note also that this option changes the ABI; compiling a program with a
14418 different stack offset than the libraries have been compiled with
14419 generally does not work.
14420 This option can be useful if you want to evaluate if a different stack
14421 offset would give you better code, but to actually use a different stack
14422 offset to build working programs, it is recommended to configure the
14423 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
14425 @item -mno-round-nearest
14426 @opindex mno-round-nearest
14427 Make the scheduler assume that the rounding mode has been set to
14428 truncating.  The default is @option{-mround-nearest}.
14430 @item -mlong-calls
14431 @opindex mlong-calls
14432 If not otherwise specified by an attribute, assume all calls might be beyond
14433 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
14434 function address into a register before performing a (otherwise direct) call.
14435 This is the default.
14437 @item -mshort-calls
14438 @opindex short-calls
14439 If not otherwise specified by an attribute, assume all direct calls are
14440 in the range of the @code{b} / @code{bl} instructions, so use these instructions
14441 for direct calls.  The default is @option{-mlong-calls}.
14443 @item -msmall16
14444 @opindex msmall16
14445 Assume addresses can be loaded as 16-bit unsigned values.  This does not
14446 apply to function addresses for which @option{-mlong-calls} semantics
14447 are in effect.
14449 @item -mfp-mode=@var{mode}
14450 @opindex mfp-mode
14451 Set the prevailing mode of the floating-point unit.
14452 This determines the floating-point mode that is provided and expected
14453 at function call and return time.  Making this mode match the mode you
14454 predominantly need at function start can make your programs smaller and
14455 faster by avoiding unnecessary mode switches.
14457 @var{mode} can be set to one the following values:
14459 @table @samp
14460 @item caller
14461 Any mode at function entry is valid, and retained or restored when
14462 the function returns, and when it calls other functions.
14463 This mode is useful for compiling libraries or other compilation units
14464 you might want to incorporate into different programs with different
14465 prevailing FPU modes, and the convenience of being able to use a single
14466 object file outweighs the size and speed overhead for any extra
14467 mode switching that might be needed, compared with what would be needed
14468 with a more specific choice of prevailing FPU mode.
14470 @item truncate
14471 This is the mode used for floating-point calculations with
14472 truncating (i.e.@: round towards zero) rounding mode.  That includes
14473 conversion from floating point to integer.
14475 @item round-nearest
14476 This is the mode used for floating-point calculations with
14477 round-to-nearest-or-even rounding mode.
14479 @item int
14480 This is the mode used to perform integer calculations in the FPU, e.g.@:
14481 integer multiply, or integer multiply-and-accumulate.
14482 @end table
14484 The default is @option{-mfp-mode=caller}
14486 @item -mnosplit-lohi
14487 @itemx -mno-postinc
14488 @itemx -mno-postmodify
14489 @opindex mnosplit-lohi
14490 @opindex mno-postinc
14491 @opindex mno-postmodify
14492 Code generation tweaks that disable, respectively, splitting of 32-bit
14493 loads, generation of post-increment addresses, and generation of
14494 post-modify addresses.  The defaults are @option{msplit-lohi},
14495 @option{-mpost-inc}, and @option{-mpost-modify}.
14497 @item -mnovect-double
14498 @opindex mno-vect-double
14499 Change the preferred SIMD mode to SImode.  The default is
14500 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
14502 @item -max-vect-align=@var{num}
14503 @opindex max-vect-align
14504 The maximum alignment for SIMD vector mode types.
14505 @var{num} may be 4 or 8.  The default is 8.
14506 Note that this is an ABI change, even though many library function
14507 interfaces are unaffected if they don't use SIMD vector modes
14508 in places that affect size and/or alignment of relevant types.
14510 @item -msplit-vecmove-early
14511 @opindex msplit-vecmove-early
14512 Split vector moves into single word moves before reload.  In theory this
14513 can give better register allocation, but so far the reverse seems to be
14514 generally the case.
14516 @item -m1reg-@var{reg}
14517 @opindex m1reg-
14518 Specify a register to hold the constant @minus{}1, which makes loading small negative
14519 constants and certain bitmasks faster.
14520 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
14521 which specify use of that register as a fixed register,
14522 and @samp{none}, which means that no register is used for this
14523 purpose.  The default is @option{-m1reg-none}.
14525 @end table
14527 @node ARC Options
14528 @subsection ARC Options
14529 @cindex ARC options
14531 The following options control the architecture variant for which code
14532 is being compiled:
14534 @c architecture variants
14535 @table @gcctabopt
14537 @item -mbarrel-shifter
14538 @opindex mbarrel-shifter
14539 Generate instructions supported by barrel shifter.  This is the default
14540 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
14542 @item -mcpu=@var{cpu}
14543 @opindex mcpu
14544 Set architecture type, register usage, and instruction scheduling
14545 parameters for @var{cpu}.  There are also shortcut alias options
14546 available for backward compatibility and convenience.  Supported
14547 values for @var{cpu} are
14549 @table @samp
14550 @opindex mA6
14551 @opindex mARC600
14552 @item arc600
14553 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
14555 @item arc601
14556 @opindex mARC601
14557 Compile for ARC601.  Alias: @option{-mARC601}.
14559 @item arc700
14560 @opindex mA7
14561 @opindex mARC700
14562 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
14563 This is the default when configured with @option{--with-cpu=arc700}@.
14565 @item arcem
14566 Compile for ARC EM.
14568 @item archs
14569 Compile for ARC HS.
14571 @item em
14572 Compile for ARC EM CPU with no hardware extensions.
14574 @item em4
14575 Compile for ARC EM4 CPU.
14577 @item em4_dmips
14578 Compile for ARC EM4 DMIPS CPU.
14580 @item em4_fpus
14581 Compile for ARC EM4 DMIPS CPU with the single-precision floating-point
14582 extension.
14584 @item em4_fpuda
14585 Compile for ARC EM4 DMIPS CPU with single-precision floating-point and
14586 double assist instructions.
14588 @item hs
14589 Compile for ARC HS CPU with no hardware extensions except the atomic
14590 instructions.
14592 @item hs34
14593 Compile for ARC HS34 CPU.
14595 @item hs38
14596 Compile for ARC HS38 CPU.
14598 @item hs38_linux
14599 Compile for ARC HS38 CPU with all hardware extensions on.
14601 @item arc600_norm
14602 Compile for ARC 600 CPU with @code{norm} instructions enabled.
14604 @item arc600_mul32x16
14605 Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply 
14606 instructions enabled.
14608 @item arc600_mul64
14609 Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family 
14610 instructions enabled.
14612 @item arc601_norm
14613 Compile for ARC 601 CPU with @code{norm} instructions enabled.
14615 @item arc601_mul32x16
14616 Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply
14617 instructions enabled.
14619 @item arc601_mul64
14620 Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family
14621 instructions enabled.
14623 @item nps400
14624 Compile for ARC 700 on NPS400 chip.
14626 @end table
14628 @item -mdpfp
14629 @opindex mdpfp
14630 @itemx -mdpfp-compact
14631 @opindex mdpfp-compact
14632 Generate double-precision FPX instructions, tuned for the compact
14633 implementation.
14635 @item -mdpfp-fast
14636 @opindex mdpfp-fast
14637 Generate double-precision FPX instructions, tuned for the fast
14638 implementation.
14640 @item -mno-dpfp-lrsr
14641 @opindex mno-dpfp-lrsr
14642 Disable @code{lr} and @code{sr} instructions from using FPX extension
14643 aux registers.
14645 @item -mea
14646 @opindex mea
14647 Generate extended arithmetic instructions.  Currently only
14648 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
14649 supported.  This is always enabled for @option{-mcpu=ARC700}.
14651 @item -mno-mpy
14652 @opindex mno-mpy
14653 Do not generate @code{mpy}-family instructions for ARC700.  This option is
14654 deprecated.
14656 @item -mmul32x16
14657 @opindex mmul32x16
14658 Generate 32x16-bit multiply and multiply-accumulate instructions.
14660 @item -mmul64
14661 @opindex mmul64
14662 Generate @code{mul64} and @code{mulu64} instructions.  
14663 Only valid for @option{-mcpu=ARC600}.
14665 @item -mnorm
14666 @opindex mnorm
14667 Generate @code{norm} instructions.  This is the default if @option{-mcpu=ARC700}
14668 is in effect.
14670 @item -mspfp
14671 @opindex mspfp
14672 @itemx -mspfp-compact
14673 @opindex mspfp-compact
14674 Generate single-precision FPX instructions, tuned for the compact
14675 implementation.
14677 @item -mspfp-fast
14678 @opindex mspfp-fast
14679 Generate single-precision FPX instructions, tuned for the fast
14680 implementation.
14682 @item -msimd
14683 @opindex msimd
14684 Enable generation of ARC SIMD instructions via target-specific
14685 builtins.  Only valid for @option{-mcpu=ARC700}.
14687 @item -msoft-float
14688 @opindex msoft-float
14689 This option ignored; it is provided for compatibility purposes only.
14690 Software floating-point code is emitted by default, and this default
14691 can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or
14692 @option{-mspfp-fast} for single precision, and @option{-mdpfp},
14693 @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision.
14695 @item -mswap
14696 @opindex mswap
14697 Generate @code{swap} instructions.
14699 @item -matomic
14700 @opindex matomic
14701 This enables use of the locked load/store conditional extension to implement
14702 atomic memory built-in functions.  Not available for ARC 6xx or ARC
14703 EM cores.
14705 @item -mdiv-rem
14706 @opindex mdiv-rem
14707 Enable @code{div} and @code{rem} instructions for ARCv2 cores.
14709 @item -mcode-density
14710 @opindex mcode-density
14711 Enable code density instructions for ARC EM.  
14712 This option is on by default for ARC HS.
14714 @item -mll64
14715 @opindex mll64
14716 Enable double load/store operations for ARC HS cores.
14718 @item -mtp-regno=@var{regno}
14719 @opindex mtp-regno
14720 Specify thread pointer register number.
14722 @item -mmpy-option=@var{multo}
14723 @opindex mmpy-option
14724 Compile ARCv2 code with a multiplier design option.  You can specify 
14725 the option using either a string or numeric value for @var{multo}.  
14726 @samp{wlh1} is the default value.  The recognized values are:
14728 @table @samp
14729 @item 0
14730 @itemx none
14731 No multiplier available.
14733 @item 1
14734 @itemx w
14735 16x16 multiplier, fully pipelined.
14736 The following instructions are enabled: @code{mpyw} and @code{mpyuw}.
14738 @item 2
14739 @itemx wlh1
14740 32x32 multiplier, fully
14741 pipelined (1 stage).  The following instructions are additionally
14742 enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14744 @item 3
14745 @itemx wlh2
14746 32x32 multiplier, fully pipelined
14747 (2 stages).  The following instructions are additionally enabled: @code{mpy},
14748 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14750 @item 4
14751 @itemx wlh3
14752 Two 16x16 multipliers, blocking,
14753 sequential.  The following instructions are additionally enabled: @code{mpy},
14754 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14756 @item 5
14757 @itemx wlh4
14758 One 16x16 multiplier, blocking,
14759 sequential.  The following instructions are additionally enabled: @code{mpy},
14760 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14762 @item 6
14763 @itemx wlh5
14764 One 32x4 multiplier, blocking,
14765 sequential.  The following instructions are additionally enabled: @code{mpy},
14766 @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}.
14768 @item 7
14769 @itemx plus_dmpy
14770 ARC HS SIMD support.
14772 @item 8
14773 @itemx plus_macd
14774 ARC HS SIMD support.
14776 @item 9
14777 @itemx plus_qmacw
14778 ARC HS SIMD support.
14780 @end table
14782 This option is only available for ARCv2 cores@.
14784 @item -mfpu=@var{fpu}
14785 @opindex mfpu
14786 Enables support for specific floating-point hardware extensions for ARCv2
14787 cores.  Supported values for @var{fpu} are:
14789 @table @samp
14791 @item fpus
14792 Enables support for single-precision floating-point hardware
14793 extensions@.
14795 @item fpud
14796 Enables support for double-precision floating-point hardware
14797 extensions.  The single-precision floating-point extension is also
14798 enabled.  Not available for ARC EM@.
14800 @item fpuda
14801 Enables support for double-precision floating-point hardware
14802 extensions using double-precision assist instructions.  The single-precision
14803 floating-point extension is also enabled.  This option is
14804 only available for ARC EM@.
14806 @item fpuda_div
14807 Enables support for double-precision floating-point hardware
14808 extensions using double-precision assist instructions.
14809 The single-precision floating-point, square-root, and divide 
14810 extensions are also enabled.  This option is
14811 only available for ARC EM@.
14813 @item fpuda_fma
14814 Enables support for double-precision floating-point hardware
14815 extensions using double-precision assist instructions.
14816 The single-precision floating-point and fused multiply and add 
14817 hardware extensions are also enabled.  This option is
14818 only available for ARC EM@.
14820 @item fpuda_all
14821 Enables support for double-precision floating-point hardware
14822 extensions using double-precision assist instructions.
14823 All single-precision floating-point hardware extensions are also
14824 enabled.  This option is only available for ARC EM@.
14826 @item fpus_div
14827 Enables support for single-precision floating-point, square-root and divide 
14828 hardware extensions@.
14830 @item fpud_div
14831 Enables support for double-precision floating-point, square-root and divide 
14832 hardware extensions.  This option
14833 includes option @samp{fpus_div}. Not available for ARC EM@.
14835 @item fpus_fma
14836 Enables support for single-precision floating-point and 
14837 fused multiply and add hardware extensions@.
14839 @item fpud_fma
14840 Enables support for double-precision floating-point and 
14841 fused multiply and add hardware extensions.  This option
14842 includes option @samp{fpus_fma}.  Not available for ARC EM@.
14844 @item fpus_all
14845 Enables support for all single-precision floating-point hardware
14846 extensions@.
14848 @item fpud_all
14849 Enables support for all single- and double-precision floating-point
14850 hardware extensions.  Not available for ARC EM@.
14852 @end table
14854 @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count}
14855 @opindex mirq-ctrl-saved
14856 Specifies general-purposes registers that the processor automatically
14857 saves/restores on interrupt entry and exit.  @var{register-range} is
14858 specified as two registers separated by a dash.  The register range
14859 always starts with @code{r0}, the upper limit is @code{fp} register.
14860 @var{blink} and @var{lp_count} are optional.  This option is only
14861 valid for ARC EM and ARC HS cores.
14863 @item -mrgf-banked-regs=@var{number}
14864 @opindex mrgf-banked-regs
14865 Specifies the number of registers replicated in second register bank
14866 on entry to fast interrupt.  Fast interrupts are interrupts with the
14867 highest priority level P0.  These interrupts save only PC and STATUS32
14868 registers to avoid memory transactions during interrupt entry and exit
14869 sequences.  Use this option when you are using fast interrupts in an
14870 ARC V2 family processor.  Permitted values are 4, 8, 16, and 32.
14872 @item -mlpc-width=@var{width}
14873 @opindex mlpc-width
14874 Specify the width of the @code{lp_count} register.  Valid values for
14875 @var{width} are 8, 16, 20, 24, 28 and 32 bits.  The default width is
14876 fixed to 32 bits.  If the width is less than 32, the compiler does not
14877 attempt to transform loops in your program to use the zero-delay loop
14878 mechanism unless it is known that the @code{lp_count} register can
14879 hold the required loop-counter value.  Depending on the width
14880 specified, the compiler and run-time library might continue to use the
14881 loop mechanism for various needs.  This option defines macro
14882 @code{__ARC_LPC_WIDTH__} with the value of @var{width}.
14884 @end table
14886 The following options are passed through to the assembler, and also
14887 define preprocessor macro symbols.
14889 @c Flags used by the assembler, but for which we define preprocessor
14890 @c macro symbols as well.
14891 @table @gcctabopt
14892 @item -mdsp-packa
14893 @opindex mdsp-packa
14894 Passed down to the assembler to enable the DSP Pack A extensions.
14895 Also sets the preprocessor symbol @code{__Xdsp_packa}.  This option is
14896 deprecated.
14898 @item -mdvbf
14899 @opindex mdvbf
14900 Passed down to the assembler to enable the dual Viterbi butterfly
14901 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.  This
14902 option is deprecated.
14904 @c ARC700 4.10 extension instruction
14905 @item -mlock
14906 @opindex mlock
14907 Passed down to the assembler to enable the locked load/store
14908 conditional extension.  Also sets the preprocessor symbol
14909 @code{__Xlock}.
14911 @item -mmac-d16
14912 @opindex mmac-d16
14913 Passed down to the assembler.  Also sets the preprocessor symbol
14914 @code{__Xxmac_d16}.  This option is deprecated.
14916 @item -mmac-24
14917 @opindex mmac-24
14918 Passed down to the assembler.  Also sets the preprocessor symbol
14919 @code{__Xxmac_24}.  This option is deprecated.
14921 @c ARC700 4.10 extension instruction
14922 @item -mrtsc
14923 @opindex mrtsc
14924 Passed down to the assembler to enable the 64-bit time-stamp counter
14925 extension instruction.  Also sets the preprocessor symbol
14926 @code{__Xrtsc}.  This option is deprecated.
14928 @c ARC700 4.10 extension instruction
14929 @item -mswape
14930 @opindex mswape
14931 Passed down to the assembler to enable the swap byte ordering
14932 extension instruction.  Also sets the preprocessor symbol
14933 @code{__Xswape}.
14935 @item -mtelephony
14936 @opindex mtelephony
14937 Passed down to the assembler to enable dual- and single-operand
14938 instructions for telephony.  Also sets the preprocessor symbol
14939 @code{__Xtelephony}.  This option is deprecated.
14941 @item -mxy
14942 @opindex mxy
14943 Passed down to the assembler to enable the XY memory extension.  Also
14944 sets the preprocessor symbol @code{__Xxy}.
14946 @end table
14948 The following options control how the assembly code is annotated:
14950 @c Assembly annotation options
14951 @table @gcctabopt
14952 @item -misize
14953 @opindex misize
14954 Annotate assembler instructions with estimated addresses.
14956 @item -mannotate-align
14957 @opindex mannotate-align
14958 Explain what alignment considerations lead to the decision to make an
14959 instruction short or long.
14961 @end table
14963 The following options are passed through to the linker:
14965 @c options passed through to the linker
14966 @table @gcctabopt
14967 @item -marclinux
14968 @opindex marclinux
14969 Passed through to the linker, to specify use of the @code{arclinux} emulation.
14970 This option is enabled by default in tool chains built for
14971 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
14972 when profiling is not requested.
14974 @item -marclinux_prof
14975 @opindex marclinux_prof
14976 Passed through to the linker, to specify use of the
14977 @code{arclinux_prof} emulation.  This option is enabled by default in
14978 tool chains built for @w{@code{arc-linux-uclibc}} and
14979 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
14981 @end table
14983 The following options control the semantics of generated code:
14985 @c semantically relevant code generation options
14986 @table @gcctabopt
14987 @item -mlong-calls
14988 @opindex mlong-calls
14989 Generate calls as register indirect calls, thus providing access
14990 to the full 32-bit address range.
14992 @item -mmedium-calls
14993 @opindex mmedium-calls
14994 Don't use less than 25-bit addressing range for calls, which is the
14995 offset available for an unconditional branch-and-link
14996 instruction.  Conditional execution of function calls is suppressed, to
14997 allow use of the 25-bit range, rather than the 21-bit range with
14998 conditional branch-and-link.  This is the default for tool chains built
14999 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
15001 @item -G @var{num}
15002 @opindex G
15003 Put definitions of externally-visible data in a small data section if
15004 that data is no bigger than @var{num} bytes.  The default value of
15005 @var{num} is 4 for any ARC configuration, or 8 when we have double
15006 load/store operations.
15008 @item -mno-sdata
15009 @opindex mno-sdata
15010 Do not generate sdata references.  This is the default for tool chains
15011 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
15012 targets.
15014 @item -mvolatile-cache
15015 @opindex mvolatile-cache
15016 Use ordinarily cached memory accesses for volatile references.  This is the
15017 default.
15019 @item -mno-volatile-cache
15020 @opindex mno-volatile-cache
15021 Enable cache bypass for volatile references.
15023 @end table
15025 The following options fine tune code generation:
15026 @c code generation tuning options
15027 @table @gcctabopt
15028 @item -malign-call
15029 @opindex malign-call
15030 Do alignment optimizations for call instructions.
15032 @item -mauto-modify-reg
15033 @opindex mauto-modify-reg
15034 Enable the use of pre/post modify with register displacement.
15036 @item -mbbit-peephole
15037 @opindex mbbit-peephole
15038 Enable bbit peephole2.
15040 @item -mno-brcc
15041 @opindex mno-brcc
15042 This option disables a target-specific pass in @file{arc_reorg} to
15043 generate compare-and-branch (@code{br@var{cc}}) instructions.  
15044 It has no effect on
15045 generation of these instructions driven by the combiner pass.
15047 @item -mcase-vector-pcrel
15048 @opindex mcase-vector-pcrel
15049 Use PC-relative switch case tables to enable case table shortening.
15050 This is the default for @option{-Os}.
15052 @item -mcompact-casesi
15053 @opindex mcompact-casesi
15054 Enable compact @code{casesi} pattern.  This is the default for @option{-Os},
15055 and only available for ARCv1 cores.
15057 @item -mno-cond-exec
15058 @opindex mno-cond-exec
15059 Disable the ARCompact-specific pass to generate conditional 
15060 execution instructions.
15062 Due to delay slot scheduling and interactions between operand numbers,
15063 literal sizes, instruction lengths, and the support for conditional execution,
15064 the target-independent pass to generate conditional execution is often lacking,
15065 so the ARC port has kept a special pass around that tries to find more
15066 conditional execution generation opportunities after register allocation,
15067 branch shortening, and delay slot scheduling have been done.  This pass
15068 generally, but not always, improves performance and code size, at the cost of
15069 extra compilation time, which is why there is an option to switch it off.
15070 If you have a problem with call instructions exceeding their allowable
15071 offset range because they are conditionalized, you should consider using
15072 @option{-mmedium-calls} instead.
15074 @item -mearly-cbranchsi
15075 @opindex mearly-cbranchsi
15076 Enable pre-reload use of the @code{cbranchsi} pattern.
15078 @item -mexpand-adddi
15079 @opindex mexpand-adddi
15080 Expand @code{adddi3} and @code{subdi3} at RTL generation time into
15081 @code{add.f}, @code{adc} etc.  This option is deprecated.
15083 @item -mindexed-loads
15084 @opindex mindexed-loads
15085 Enable the use of indexed loads.  This can be problematic because some
15086 optimizers then assume that indexed stores exist, which is not
15087 the case.
15089 @opindex mlra
15090 Enable Local Register Allocation.  This is still experimental for ARC,
15091 so by default the compiler uses standard reload
15092 (i.e. @option{-mno-lra}).
15094 @item -mlra-priority-none
15095 @opindex mlra-priority-none
15096 Don't indicate any priority for target registers.
15098 @item -mlra-priority-compact
15099 @opindex mlra-priority-compact
15100 Indicate target register priority for r0..r3 / r12..r15.
15102 @item -mlra-priority-noncompact
15103 @opindex mlra-priority-noncompact
15104 Reduce target register priority for r0..r3 / r12..r15.
15106 @item -mno-millicode
15107 @opindex mno-millicode
15108 When optimizing for size (using @option{-Os}), prologues and epilogues
15109 that have to save or restore a large number of registers are often
15110 shortened by using call to a special function in libgcc; this is
15111 referred to as a @emph{millicode} call.  As these calls can pose
15112 performance issues, and/or cause linking issues when linking in a
15113 nonstandard way, this option is provided to turn off millicode call
15114 generation.
15116 @item -mmixed-code
15117 @opindex mmixed-code
15118 Tweak register allocation to help 16-bit instruction generation.
15119 This generally has the effect of decreasing the average instruction size
15120 while increasing the instruction count.
15122 @item -mq-class
15123 @opindex mq-class
15124 Enable @samp{q} instruction alternatives.
15125 This is the default for @option{-Os}.
15127 @item -mRcq
15128 @opindex mRcq
15129 Enable @samp{Rcq} constraint handling.  
15130 Most short code generation depends on this.
15131 This is the default.
15133 @item -mRcw
15134 @opindex mRcw
15135 Enable @samp{Rcw} constraint handling.  
15136 Most ccfsm condexec mostly depends on this.
15137 This is the default.
15139 @item -msize-level=@var{level}
15140 @opindex msize-level
15141 Fine-tune size optimization with regards to instruction lengths and alignment.
15142 The recognized values for @var{level} are:
15143 @table @samp
15144 @item 0
15145 No size optimization.  This level is deprecated and treated like @samp{1}.
15147 @item 1
15148 Short instructions are used opportunistically.
15150 @item 2
15151 In addition, alignment of loops and of code after barriers are dropped.
15153 @item 3
15154 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
15156 @end table
15158 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
15159 the behavior when this is not set is equivalent to level @samp{1}.
15161 @item -mtune=@var{cpu}
15162 @opindex mtune
15163 Set instruction scheduling parameters for @var{cpu}, overriding any implied
15164 by @option{-mcpu=}.
15166 Supported values for @var{cpu} are
15168 @table @samp
15169 @item ARC600
15170 Tune for ARC600 CPU.
15172 @item ARC601
15173 Tune for ARC601 CPU.
15175 @item ARC700
15176 Tune for ARC700 CPU with standard multiplier block.
15178 @item ARC700-xmac
15179 Tune for ARC700 CPU with XMAC block.
15181 @item ARC725D
15182 Tune for ARC725D CPU.
15184 @item ARC750D
15185 Tune for ARC750D CPU.
15187 @end table
15189 @item -mmultcost=@var{num}
15190 @opindex mmultcost
15191 Cost to assume for a multiply instruction, with @samp{4} being equal to a
15192 normal instruction.
15194 @item -munalign-prob-threshold=@var{probability}
15195 @opindex munalign-prob-threshold
15196 Set probability threshold for unaligning branches.
15197 When tuning for @samp{ARC700} and optimizing for speed, branches without
15198 filled delay slot are preferably emitted unaligned and long, unless
15199 profiling indicates that the probability for the branch to be taken
15200 is below @var{probability}.  @xref{Cross-profiling}.
15201 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
15203 @end table
15205 The following options are maintained for backward compatibility, but
15206 are now deprecated and will be removed in a future release:
15208 @c Deprecated options
15209 @table @gcctabopt
15211 @item -margonaut
15212 @opindex margonaut
15213 Obsolete FPX.
15215 @item -mbig-endian
15216 @opindex mbig-endian
15217 @itemx -EB
15218 @opindex EB
15219 Compile code for big-endian targets.  Use of these options is now
15220 deprecated.  Big-endian code is supported by configuring GCC to build
15221 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets,
15222 for which big endian is the default.
15224 @item -mlittle-endian
15225 @opindex mlittle-endian
15226 @itemx -EL
15227 @opindex EL
15228 Compile code for little-endian targets.  Use of these options is now
15229 deprecated.  Little-endian code is supported by configuring GCC to build 
15230 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets,
15231 for which little endian is the default.
15233 @item -mbarrel_shifter
15234 @opindex mbarrel_shifter
15235 Replaced by @option{-mbarrel-shifter}.
15237 @item -mdpfp_compact
15238 @opindex mdpfp_compact
15239 Replaced by @option{-mdpfp-compact}.
15241 @item -mdpfp_fast
15242 @opindex mdpfp_fast
15243 Replaced by @option{-mdpfp-fast}.
15245 @item -mdsp_packa
15246 @opindex mdsp_packa
15247 Replaced by @option{-mdsp-packa}.
15249 @item -mEA
15250 @opindex mEA
15251 Replaced by @option{-mea}.
15253 @item -mmac_24
15254 @opindex mmac_24
15255 Replaced by @option{-mmac-24}.
15257 @item -mmac_d16
15258 @opindex mmac_d16
15259 Replaced by @option{-mmac-d16}.
15261 @item -mspfp_compact
15262 @opindex mspfp_compact
15263 Replaced by @option{-mspfp-compact}.
15265 @item -mspfp_fast
15266 @opindex mspfp_fast
15267 Replaced by @option{-mspfp-fast}.
15269 @item -mtune=@var{cpu}
15270 @opindex mtune
15271 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
15272 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
15273 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively.
15275 @item -multcost=@var{num}
15276 @opindex multcost
15277 Replaced by @option{-mmultcost}.
15279 @end table
15281 @node ARM Options
15282 @subsection ARM Options
15283 @cindex ARM options
15285 These @samp{-m} options are defined for the ARM port:
15287 @table @gcctabopt
15288 @item -mabi=@var{name}
15289 @opindex mabi
15290 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
15291 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
15293 @item -mapcs-frame
15294 @opindex mapcs-frame
15295 Generate a stack frame that is compliant with the ARM Procedure Call
15296 Standard for all functions, even if this is not strictly necessary for
15297 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
15298 with this option causes the stack frames not to be generated for
15299 leaf functions.  The default is @option{-mno-apcs-frame}.
15300 This option is deprecated.
15302 @item -mapcs
15303 @opindex mapcs
15304 This is a synonym for @option{-mapcs-frame} and is deprecated.
15306 @ignore
15307 @c not currently implemented
15308 @item -mapcs-stack-check
15309 @opindex mapcs-stack-check
15310 Generate code to check the amount of stack space available upon entry to
15311 every function (that actually uses some stack space).  If there is
15312 insufficient space available then either the function
15313 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
15314 called, depending upon the amount of stack space required.  The runtime
15315 system is required to provide these functions.  The default is
15316 @option{-mno-apcs-stack-check}, since this produces smaller code.
15318 @c not currently implemented
15319 @item -mapcs-reentrant
15320 @opindex mapcs-reentrant
15321 Generate reentrant, position-independent code.  The default is
15322 @option{-mno-apcs-reentrant}.
15323 @end ignore
15325 @item -mthumb-interwork
15326 @opindex mthumb-interwork
15327 Generate code that supports calling between the ARM and Thumb
15328 instruction sets.  Without this option, on pre-v5 architectures, the
15329 two instruction sets cannot be reliably used inside one program.  The
15330 default is @option{-mno-thumb-interwork}, since slightly larger code
15331 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
15332 configurations this option is meaningless.
15334 @item -mno-sched-prolog
15335 @opindex mno-sched-prolog
15336 Prevent the reordering of instructions in the function prologue, or the
15337 merging of those instruction with the instructions in the function's
15338 body.  This means that all functions start with a recognizable set
15339 of instructions (or in fact one of a choice from a small set of
15340 different function prologues), and this information can be used to
15341 locate the start of functions inside an executable piece of code.  The
15342 default is @option{-msched-prolog}.
15344 @item -mfloat-abi=@var{name}
15345 @opindex mfloat-abi
15346 Specifies which floating-point ABI to use.  Permissible values
15347 are: @samp{soft}, @samp{softfp} and @samp{hard}.
15349 Specifying @samp{soft} causes GCC to generate output containing
15350 library calls for floating-point operations.
15351 @samp{softfp} allows the generation of code using hardware floating-point
15352 instructions, but still uses the soft-float calling conventions.
15353 @samp{hard} allows generation of floating-point instructions
15354 and uses FPU-specific calling conventions.
15356 The default depends on the specific target configuration.  Note that
15357 the hard-float and soft-float ABIs are not link-compatible; you must
15358 compile your entire program with the same ABI, and link with a
15359 compatible set of libraries.
15361 @item -mlittle-endian
15362 @opindex mlittle-endian
15363 Generate code for a processor running in little-endian mode.  This is
15364 the default for all standard configurations.
15366 @item -mbig-endian
15367 @opindex mbig-endian
15368 Generate code for a processor running in big-endian mode; the default is
15369 to compile code for a little-endian processor.
15371 @item -mbe8
15372 @itemx -mbe32
15373 @opindex mbe8
15374 When linking a big-endian image select between BE8 and BE32 formats.
15375 The option has no effect for little-endian images and is ignored.  The
15376 default is dependent on the selected target architecture.  For ARMv6
15377 and later architectures the default is BE8, for older architectures
15378 the default is BE32.  BE32 format has been deprecated by ARM.
15380 @item -march=@var{name}@r{[}+extension@dots{}@r{]}
15381 @opindex march
15382 This specifies the name of the target ARM architecture.  GCC uses this
15383 name to determine what kind of instructions it can emit when generating
15384 assembly code.  This option can be used in conjunction with or instead
15385 of the @option{-mcpu=} option.
15387 Permissible names are:
15388 @samp{armv4t},
15389 @samp{armv5t}, @samp{armv5te},
15390 @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2},
15391 @samp{armv6z}, @samp{armv6zk},
15392 @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, 
15393 @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a},
15394 @samp{armv7-r},
15395 @samp{armv8-r},
15396 @samp{armv6-m}, @samp{armv6s-m},
15397 @samp{armv7-m}, @samp{armv7e-m},
15398 @samp{armv8-m.base}, @samp{armv8-m.main},
15399 @samp{iwmmxt} and @samp{iwmmxt2}.
15401 Additionally, the following architectures, which lack support for the
15402 Thumb exection state, are recognized but support is deprecated:
15403 @samp{armv2}, @samp{armv2a}, @samp{armv3}, @samp{armv3m},
15404 @samp{armv4}, @samp{armv5} and @samp{armv5e}.
15406 Many of the architectures support extensions.  These can be added by
15407 appending @samp{+@var{extension}} to the architecture name.  Extension
15408 options are processed in order and capabilities accumulate.  An extension
15409 will also enable any necessary base extensions
15410 upon which it depends.  For example, the @samp{+crypto} extension
15411 will always enable the @samp{+simd} extension.  The exception to the
15412 additive construction is for extensions that are prefixed with
15413 @samp{+no@dots{}}: these extensions disable the specified option and
15414 any other extensions that may depend on the presence of that
15415 extension.
15417 For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to
15418 writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is
15419 entirely disabled by the @samp{+nofp} option that follows it.
15421 Most extension names are generically named, but have an effect that is
15422 dependent upon the architecture to which it is applied.  For example,
15423 the @samp{+simd} option can be applied to both @samp{armv7-a} and
15424 @samp{armv8-a} architectures, but will enable the original ARMv7
15425 Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-a
15426 variant for @samp{armv8-a}.
15428 The table below lists the supported extensions for each architecture.
15429 Architectures not mentioned do not support any extensions.
15431 @table @samp
15432 @item  armv5e
15433 @itemx armv5te
15434 @itemx armv6
15435 @itemx armv6j
15436 @itemx armv6k
15437 @itemx armv6kz
15438 @itemx armv6t2
15439 @itemx armv6z
15440 @itemx armv6zk
15441 @table @samp
15442 @item +fp
15443 The VFPv2 floating-point instructions.  The extension @samp{+vfpv2} can be
15444 used as an alias for this extension.
15446 @item +nofp
15447 Disable the floating-point instructions.
15448 @end table
15450 @item armv7
15451 The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures.
15452 @table @samp
15453 @item +fp
15454 The VFPv3 floating-point instructions, with 16 double-precision
15455 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15456 for this extension.  Note that floating-point is not supported by the
15457 base ARMv7-M architecture, but is compatible with both the ARMv7-A and
15458 ARMv7-R architectures.
15460 @item +nofp
15461 Disable the floating-point instructions.
15462 @end table
15464 @item armv7-a
15465 @table @samp
15466 @item +fp
15467 The VFPv3 floating-point instructions, with 16 double-precision
15468 registers.  The extension @samp{+vfpv3-d16} can be used as an alias
15469 for this extension.
15471 @item +simd
15472 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15473 The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases
15474 for this extension.
15476 @item +vfpv3
15477 The VFPv3 floating-point instructions, with 32 double-precision
15478 registers.
15480 @item +vfpv3-d16-fp16
15481 The VFPv3 floating-point instructions, with 16 double-precision
15482 registers and the half-precision floating-point conversion operations.
15484 @item +vfpv3-fp16
15485 The VFPv3 floating-point instructions, with 32 double-precision
15486 registers and the half-precision floating-point conversion operations.
15488 @item +vfpv4-d16
15489 The VFPv4 floating-point instructions, with 16 double-precision
15490 registers.
15492 @item +vfpv4
15493 The VFPv4 floating-point instructions, with 32 double-precision
15494 registers.
15496 @item +neon-fp16
15497 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15498 the half-precision floating-point conversion operations.
15500 @item +neon-vfpv4
15501 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.
15503 @item +nosimd
15504 Disable the Advanced SIMD instructions (does not disable floating point).
15506 @item +nofp
15507 Disable the floating-point and Advanced SIMD instructions.
15508 @end table
15510 @item armv7ve
15511 The extended version of the ARMv7-A architecture with support for
15512 virtualization.
15513 @table @samp
15514 @item +fp
15515 The VFPv4 floating-point instructions, with 16 double-precision registers.
15516 The extension @samp{+vfpv4-d16} can be used as an alias for this extension.
15518 @item +simd
15519 The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions.  The
15520 extension @samp{+neon-vfpv4} can be used as an alias for this extension.
15522 @item +vfpv3-d16
15523 The VFPv3 floating-point instructions, with 16 double-precision
15524 registers.
15526 @item +vfpv3
15527 The VFPv3 floating-point instructions, with 32 double-precision
15528 registers.
15530 @item +vfpv3-d16-fp16
15531 The VFPv3 floating-point instructions, with 16 double-precision
15532 registers and the half-precision floating-point conversion operations.
15534 @item +vfpv3-fp16
15535 The VFPv3 floating-point instructions, with 32 double-precision
15536 registers and the half-precision floating-point conversion operations.
15538 @item +vfpv4-d16
15539 The VFPv4 floating-point instructions, with 16 double-precision
15540 registers.
15542 @item +vfpv4
15543 The VFPv4 floating-point instructions, with 32 double-precision
15544 registers.
15546 @item +neon
15547 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions.
15548 The extension @samp{+neon-vfpv3} can be used as an alias for this extension.
15550 @item +neon-fp16
15551 The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with
15552 the half-precision floating-point conversion operations.
15554 @item +nosimd
15555 Disable the Advanced SIMD instructions (does not disable floating point).
15557 @item +nofp
15558 Disable the floating-point and Advanced SIMD instructions.
15559 @end table
15561 @item armv8-a
15562 @table @samp
15563 @item +crc
15564 The Cyclic Redundancy Check (CRC) instructions.
15565 @item +simd
15566 The ARMv8 Advanced SIMD and floating-point instructions.
15567 @item +crypto
15568 The cryptographic instructions.
15569 @item +nocrypto
15570 Disable the cryptographic isntructions.
15571 @item +nofp
15572 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15573 @end table
15575 @item armv8.1-a
15576 @table @samp
15577 @item +simd
15578 The ARMv8.1 Advanced SIMD and floating-point instructions.
15580 @item +crypto
15581 The cryptographic instructions.  This also enables the Advanced SIMD and
15582 floating-point instructions.
15584 @item +nocrypto
15585 Disable the cryptographic isntructions.
15587 @item +nofp
15588 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15589 @end table
15591 @item armv8.2-a
15592 @table @samp
15593 @item +fp16
15594 The half-precision floating-point data processing instructions.
15595 This also enables the Advanced SIMD and floating-point instructions.
15597 @item +simd
15598 The ARMv8.1 Advanced SIMD and floating-point instructions.
15600 @item +crypto
15601 The cryptographic instructions.  This also enables the Advanced SIMD and
15602 floating-point instructions.
15604 @item +nocrypto
15605 Disable the cryptographic extension.
15607 @item +nofp
15608 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15609 @end table
15611 @item armv7-r
15612 @table @samp
15613 @item +fp.sp
15614 The single-precision VFPv3 floating-point instructions.  The extension
15615 @samp{+vfpv3xd} can be used as an alias for this extension.
15617 @item +fp
15618 The VFPv3 floating-point instructions with 16 double-precision registers.
15619 The extension +vfpv3-d16 can be used as an alias for this extension.
15621 @item +nofp
15622 Disable the floating-point extension.
15624 @item +idiv
15625 The ARM-state integer division instructions.
15627 @item +noidiv
15628 Disable the ARM-state integer division extension.
15629 @end table
15631 @item armv7e-m
15632 @table @samp
15633 @item +fp
15634 The single-precision VFPv4 floating-point instructions.
15636 @item +fpv5
15637 The single-precision FPv5 floating-point instructions.
15639 @item +fp.dp
15640 The single- and double-precision FPv5 floating-point instructions.
15642 @item +nofp
15643 Disable the floating-point extensions.
15644 @end table
15646 @item  armv8-m.main
15647 @table @samp
15648 @item +dsp
15649 The DSP instructions.
15651 @item +nodsp
15652 Disable the DSP extension.
15654 @item +fp
15655 The single-precision floating-point instructions.
15657 @item +fp.dp
15658 The single- and double-precision floating-point instructions.
15660 @item +nofp
15661 Disable the floating-point extension.
15662 @end table
15664 @item armv8-r
15665 @table @samp
15666 @item +crc
15667 The Cyclic Redundancy Check (CRC) instructions.
15668 @item +fp.sp
15669 The single-precision FPv5 floating-point instructions.
15670 @item +simd
15671 The ARMv8 Advanced SIMD and floating-point instructions.
15672 @item +crypto
15673 The cryptographic instructions.
15674 @item +nocrypto
15675 Disable the cryptographic isntructions.
15676 @item +nofp
15677 Disable the floating-point, Advanced SIMD and cryptographic instructions.
15678 @end table
15680 @end table
15682 @option{-march=native} causes the compiler to auto-detect the architecture
15683 of the build computer.  At present, this feature is only supported on
15684 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15685 is unsuccessful the option has no effect.
15687 @item -mtune=@var{name}
15688 @opindex mtune
15689 This option specifies the name of the target ARM processor for
15690 which GCC should tune the performance of the code.
15691 For some ARM implementations better performance can be obtained by using
15692 this option.
15693 Permissible names are: @samp{arm2}, @samp{arm250},
15694 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
15695 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
15696 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
15697 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
15698 @samp{arm720},
15699 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
15700 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
15701 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
15702 @samp{strongarm1110},
15703 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
15704 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
15705 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
15706 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
15707 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
15708 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
15709 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
15710 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
15711 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
15712 @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55},
15713 @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75},
15714 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7},
15715 @samp{cortex-r8}, @samp{cortex-r52},
15716 @samp{cortex-m33},
15717 @samp{cortex-m23},
15718 @samp{cortex-m7},
15719 @samp{cortex-m4},
15720 @samp{cortex-m3},
15721 @samp{cortex-m1},
15722 @samp{cortex-m0},
15723 @samp{cortex-m0plus},
15724 @samp{cortex-m1.small-multiply},
15725 @samp{cortex-m0.small-multiply},
15726 @samp{cortex-m0plus.small-multiply},
15727 @samp{exynos-m1},
15728 @samp{marvell-pj4},
15729 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
15730 @samp{fa526}, @samp{fa626},
15731 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
15732 @samp{xgene1}.
15734 Additionally, this option can specify that GCC should tune the performance
15735 of the code for a big.LITTLE system.  Permissible names are:
15736 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
15737 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15738 @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53},
15739 @samp{cortex-a75.cortex-a55}.
15741 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
15742 performance for a blend of processors within architecture @var{arch}.
15743 The aim is to generate code that run well on the current most popular
15744 processors, balancing between optimizations that benefit some CPUs in the
15745 range, and avoiding performance pitfalls of other CPUs.  The effects of
15746 this option may change in future GCC versions as CPU models come and go.
15748 @option{-mtune} permits the same extension options as @option{-mcpu}, but
15749 the extension options do not affect the tuning of the generated code.
15751 @option{-mtune=native} causes the compiler to auto-detect the CPU
15752 of the build computer.  At present, this feature is only supported on
15753 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
15754 unsuccessful the option has no effect.
15756 @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]}
15757 @opindex mcpu
15758 This specifies the name of the target ARM processor.  GCC uses this name
15759 to derive the name of the target ARM architecture (as if specified
15760 by @option{-march}) and the ARM processor type for which to tune for
15761 performance (as if specified by @option{-mtune}).  Where this option
15762 is used in conjunction with @option{-march} or @option{-mtune},
15763 those options take precedence over the appropriate part of this option.
15765 Many of the supported CPUs implement optional architectural
15766 extensions.  Where this is so the architectural extensions are
15767 normally enabled by default.  If implementations that lack the
15768 extension exist, then the extension syntax can be used to disable
15769 those extensions that have been omitted.  For floating-point and
15770 Advanced SIMD (Neon) instructions, the settings of the options
15771 @option{-mfloat-abi} and @option{-mfpu} must also be considered:
15772 floating-point and Advanced SIMD instructions will only be used if
15773 @option{-mfloat-abi} is not set to @samp{soft}; and any setting of
15774 @option{-mfpu} other than @samp{auto} will override the available
15775 floating-point and SIMD extension instructions.
15777 For example, @samp{cortex-a9} can be found in three major
15778 configurations: integer only, with just a floating-point unit or with
15779 floating-point and Advanced SIMD.  The default is to enable all the
15780 instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can
15781 be used to disable just the SIMD or both the SIMD and floating-point
15782 instructions respectively.
15784 Permissible names for this option are the same as those for
15785 @option{-mtune}.
15787 The following extension options are common to the listed CPUs:
15789 @table @samp
15790 @item  +nofp
15791 Disables the floating-point instructions on @samp{arm9e},
15792 @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e},
15793 @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s},
15794 @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8},
15795 @samp{cortex-m4}, @samp{cortex-m7} and @samp{cortex-m33}.
15796 Disables the floating-point and SIMD instructions on
15797 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7},
15798 @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12},
15799 @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7},
15800 @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35},
15801 @samp{cortex-a53} and @samp{cortex-a55}.
15803 @item +nofp.dp
15804 Disables the double-precision component of the floating-point instructions
15805 on @samp{cortex-r5}, @samp{cortex-r52} and @samp{cortex-m7}.
15807 @item +nosimd
15808 Disables the SIMD (but not floating-point) instructions on
15809 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}
15810 and @samp{cortex-a9}.
15812 @item +crypto
15813 Enables the cryptographic instructions on @samp{cortex-a32},
15814 @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57},
15815 @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1},
15816 @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53},
15817 @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and
15818 @samp{cortex-a75.cortex-a55}.
15819 @end table
15821 Additionally the @samp{generic-armv7-a} pseudo target defaults to
15822 VFPv3 with 16 double-precision registers.  It supports the following
15823 extension options: @samp{vfpv3-d16}, @samp{vfpv3},
15824 @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, @samp{vfpv4-d16},
15825 @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, @samp{neon-fp16},
15826 @samp{neon-vfpv4}.  The meanings are the same as for the extensions to
15827 @option{-march=armv7-a}.
15829 @option{-mcpu=generic-@var{arch}} is also permissible, and is
15830 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
15831 See @option{-mtune} for more information.
15833 @option{-mcpu=native} causes the compiler to auto-detect the CPU
15834 of the build computer.  At present, this feature is only supported on
15835 GNU/Linux, and not all architectures are recognized.  If the auto-detect
15836 is unsuccessful the option has no effect.
15838 @item -mfpu=@var{name}
15839 @opindex mfpu
15840 This specifies what floating-point hardware (or hardware emulation) is
15841 available on the target.  Permissible names are: @samp{auto}, @samp{vfpv2},
15842 @samp{vfpv3},
15843 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
15844 @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4},
15845 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
15846 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
15847 @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}.
15848 Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp}
15849 is an alias for @samp{vfpv2}.
15851 The setting @samp{auto} is the default and is special.  It causes the
15852 compiler to select the floating-point and Advanced SIMD instructions
15853 based on the settings of @option{-mcpu} and @option{-march}.
15855 If the selected floating-point hardware includes the NEON extension
15856 (e.g. @option{-mfpu=neon}), note that floating-point
15857 operations are not generated by GCC's auto-vectorization pass unless
15858 @option{-funsafe-math-optimizations} is also specified.  This is
15859 because NEON hardware does not fully implement the IEEE 754 standard for
15860 floating-point arithmetic (in particular denormal values are treated as
15861 zero), so the use of NEON instructions may lead to a loss of precision.
15863 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}).
15865 @item -mfp16-format=@var{name}
15866 @opindex mfp16-format
15867 Specify the format of the @code{__fp16} half-precision floating-point type.
15868 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
15869 the default is @samp{none}, in which case the @code{__fp16} type is not
15870 defined.  @xref{Half-Precision}, for more information.
15872 @item -mstructure-size-boundary=@var{n}
15873 @opindex mstructure-size-boundary
15874 The sizes of all structures and unions are rounded up to a multiple
15875 of the number of bits set by this option.  Permissible values are 8, 32
15876 and 64.  The default value varies for different toolchains.  For the COFF
15877 targeted toolchain the default value is 8.  A value of 64 is only allowed
15878 if the underlying ABI supports it.
15880 Specifying a larger number can produce faster, more efficient code, but
15881 can also increase the size of the program.  Different values are potentially
15882 incompatible.  Code compiled with one value cannot necessarily expect to
15883 work with code or libraries compiled with another value, if they exchange
15884 information using structures or unions.
15886 This option is deprecated.
15888 @item -mabort-on-noreturn
15889 @opindex mabort-on-noreturn
15890 Generate a call to the function @code{abort} at the end of a
15891 @code{noreturn} function.  It is executed if the function tries to
15892 return.
15894 @item -mlong-calls
15895 @itemx -mno-long-calls
15896 @opindex mlong-calls
15897 @opindex mno-long-calls
15898 Tells the compiler to perform function calls by first loading the
15899 address of the function into a register and then performing a subroutine
15900 call on this register.  This switch is needed if the target function
15901 lies outside of the 64-megabyte addressing range of the offset-based
15902 version of subroutine call instruction.
15904 Even if this switch is enabled, not all function calls are turned
15905 into long calls.  The heuristic is that static functions, functions
15906 that have the @code{short_call} attribute, functions that are inside
15907 the scope of a @code{#pragma no_long_calls} directive, and functions whose
15908 definitions have already been compiled within the current compilation
15909 unit are not turned into long calls.  The exceptions to this rule are
15910 that weak function definitions, functions with the @code{long_call}
15911 attribute or the @code{section} attribute, and functions that are within
15912 the scope of a @code{#pragma long_calls} directive are always
15913 turned into long calls.
15915 This feature is not enabled by default.  Specifying
15916 @option{-mno-long-calls} restores the default behavior, as does
15917 placing the function calls within the scope of a @code{#pragma
15918 long_calls_off} directive.  Note these switches have no effect on how
15919 the compiler generates code to handle function calls via function
15920 pointers.
15922 @item -msingle-pic-base
15923 @opindex msingle-pic-base
15924 Treat the register used for PIC addressing as read-only, rather than
15925 loading it in the prologue for each function.  The runtime system is
15926 responsible for initializing this register with an appropriate value
15927 before execution begins.
15929 @item -mpic-register=@var{reg}
15930 @opindex mpic-register
15931 Specify the register to be used for PIC addressing.
15932 For standard PIC base case, the default is any suitable register
15933 determined by compiler.  For single PIC base case, the default is
15934 @samp{R9} if target is EABI based or stack-checking is enabled,
15935 otherwise the default is @samp{R10}.
15937 @item -mpic-data-is-text-relative
15938 @opindex mpic-data-is-text-relative
15939 Assume that the displacement between the text and data segments is fixed
15940 at static link time.  This permits using PC-relative addressing
15941 operations to access data known to be in the data segment.  For
15942 non-VxWorks RTP targets, this option is enabled by default.  When
15943 disabled on such targets, it will enable @option{-msingle-pic-base} by
15944 default.
15946 @item -mpoke-function-name
15947 @opindex mpoke-function-name
15948 Write the name of each function into the text section, directly
15949 preceding the function prologue.  The generated code is similar to this:
15951 @smallexample
15952      t0
15953          .ascii "arm_poke_function_name", 0
15954          .align
15955      t1
15956          .word 0xff000000 + (t1 - t0)
15957      arm_poke_function_name
15958          mov     ip, sp
15959          stmfd   sp!, @{fp, ip, lr, pc@}
15960          sub     fp, ip, #4
15961 @end smallexample
15963 When performing a stack backtrace, code can inspect the value of
15964 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
15965 location @code{pc - 12} and the top 8 bits are set, then we know that
15966 there is a function name embedded immediately preceding this location
15967 and has length @code{((pc[-3]) & 0xff000000)}.
15969 @item -mthumb
15970 @itemx -marm
15971 @opindex marm
15972 @opindex mthumb
15974 Select between generating code that executes in ARM and Thumb
15975 states.  The default for most configurations is to generate code
15976 that executes in ARM state, but the default can be changed by
15977 configuring GCC with the @option{--with-mode=}@var{state}
15978 configure option.
15980 You can also override the ARM and Thumb mode for each function
15981 by using the @code{target("thumb")} and @code{target("arm")} function attributes
15982 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
15984 @item -mtpcs-frame
15985 @opindex mtpcs-frame
15986 Generate a stack frame that is compliant with the Thumb Procedure Call
15987 Standard for all non-leaf functions.  (A leaf function is one that does
15988 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
15990 @item -mtpcs-leaf-frame
15991 @opindex mtpcs-leaf-frame
15992 Generate a stack frame that is compliant with the Thumb Procedure Call
15993 Standard for all leaf functions.  (A leaf function is one that does
15994 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
15996 @item -mcallee-super-interworking
15997 @opindex mcallee-super-interworking
15998 Gives all externally visible functions in the file being compiled an ARM
15999 instruction set header which switches to Thumb mode before executing the
16000 rest of the function.  This allows these functions to be called from
16001 non-interworking code.  This option is not valid in AAPCS configurations
16002 because interworking is enabled by default.
16004 @item -mcaller-super-interworking
16005 @opindex mcaller-super-interworking
16006 Allows calls via function pointers (including virtual functions) to
16007 execute correctly regardless of whether the target code has been
16008 compiled for interworking or not.  There is a small overhead in the cost
16009 of executing a function pointer if this option is enabled.  This option
16010 is not valid in AAPCS configurations because interworking is enabled
16011 by default.
16013 @item -mtp=@var{name}
16014 @opindex mtp
16015 Specify the access model for the thread local storage pointer.  The valid
16016 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
16017 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
16018 (supported in the arm6k architecture), and @samp{auto}, which uses the
16019 best available method for the selected processor.  The default setting is
16020 @samp{auto}.
16022 @item -mtls-dialect=@var{dialect}
16023 @opindex mtls-dialect
16024 Specify the dialect to use for accessing thread local storage.  Two
16025 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
16026 @samp{gnu} dialect selects the original GNU scheme for supporting
16027 local and global dynamic TLS models.  The @samp{gnu2} dialect
16028 selects the GNU descriptor scheme, which provides better performance
16029 for shared libraries.  The GNU descriptor scheme is compatible with
16030 the original scheme, but does require new assembler, linker and
16031 library support.  Initial and local exec TLS models are unaffected by
16032 this option and always use the original scheme.
16034 @item -mword-relocations
16035 @opindex mword-relocations
16036 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
16037 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
16038 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
16039 is specified.
16041 @item -mfix-cortex-m3-ldrd
16042 @opindex mfix-cortex-m3-ldrd
16043 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
16044 with overlapping destination and base registers are used.  This option avoids
16045 generating these instructions.  This option is enabled by default when
16046 @option{-mcpu=cortex-m3} is specified.
16048 @item -munaligned-access
16049 @itemx -mno-unaligned-access
16050 @opindex munaligned-access
16051 @opindex mno-unaligned-access
16052 Enables (or disables) reading and writing of 16- and 32- bit values
16053 from addresses that are not 16- or 32- bit aligned.  By default
16054 unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for
16055 ARMv8-M Baseline architectures, and enabled for all other
16056 architectures.  If unaligned access is not enabled then words in packed
16057 data structures are accessed a byte at a time.
16059 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
16060 generated object file to either true or false, depending upon the
16061 setting of this option.  If unaligned access is enabled then the
16062 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
16063 defined.
16065 @item -mneon-for-64bits
16066 @opindex mneon-for-64bits
16067 Enables using Neon to handle scalar 64-bits operations. This is
16068 disabled by default since the cost of moving data from core registers
16069 to Neon is high.
16071 @item -mslow-flash-data
16072 @opindex mslow-flash-data
16073 Assume loading data from flash is slower than fetching instruction.
16074 Therefore literal load is minimized for better performance.
16075 This option is only supported when compiling for ARMv7 M-profile and
16076 off by default.
16078 @item -masm-syntax-unified
16079 @opindex masm-syntax-unified
16080 Assume inline assembler is using unified asm syntax.  The default is
16081 currently off which implies divided syntax.  This option has no impact
16082 on Thumb2. However, this may change in future releases of GCC.
16083 Divided syntax should be considered deprecated.
16085 @item -mrestrict-it
16086 @opindex mrestrict-it
16087 Restricts generation of IT blocks to conform to the rules of ARMv8.
16088 IT blocks can only contain a single 16-bit instruction from a select
16089 set of instructions. This option is on by default for ARMv8 Thumb mode.
16091 @item -mprint-tune-info
16092 @opindex mprint-tune-info
16093 Print CPU tuning information as comment in assembler file.  This is
16094 an option used only for regression testing of the compiler and not
16095 intended for ordinary use in compiling code.  This option is disabled
16096 by default.
16098 @item -mpure-code
16099 @opindex mpure-code
16100 Do not allow constant data to be placed in code sections.
16101 Additionally, when compiling for ELF object format give all text sections the
16102 ELF processor-specific section attribute @code{SHF_ARM_PURECODE}.  This option
16103 is only available when generating non-pic code for M-profile targets with the
16104 MOVT instruction.
16106 @item -mcmse
16107 @opindex mcmse
16108 Generate secure code as per the "ARMv8-M Security Extensions: Requirements on
16109 Development Tools Engineering Specification", which can be found on
16110 @url{http://infocenter.arm.com/help/topic/com.arm.doc.ecm0359818/ECM0359818_armv8m_security_extensions_reqs_on_dev_tools_1_0.pdf}.
16111 @end table
16113 @node AVR Options
16114 @subsection AVR Options
16115 @cindex AVR Options
16117 These options are defined for AVR implementations:
16119 @table @gcctabopt
16120 @item -mmcu=@var{mcu}
16121 @opindex mmcu
16122 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
16124 The default for this option is@tie{}@samp{avr2}.
16126 GCC supports the following AVR devices and ISAs:
16128 @include avr-mmcu.texi
16130 @item -mabsdata
16131 @opindex mabsdata
16133 Assume that all data in static storage can be accessed by LDS / STS
16134 instructions.  This option has only an effect on reduced Tiny devices like
16135 ATtiny40.  See also the @code{absdata}
16136 @ref{AVR Variable Attributes,variable attribute}.
16138 @item -maccumulate-args
16139 @opindex maccumulate-args
16140 Accumulate outgoing function arguments and acquire/release the needed
16141 stack space for outgoing function arguments once in function
16142 prologue/epilogue.  Without this option, outgoing arguments are pushed
16143 before calling a function and popped afterwards.
16145 Popping the arguments after the function call can be expensive on
16146 AVR so that accumulating the stack space might lead to smaller
16147 executables because arguments need not be removed from the
16148 stack after such a function call.
16150 This option can lead to reduced code size for functions that perform
16151 several calls to functions that get their arguments on the stack like
16152 calls to printf-like functions.
16154 @item -mbranch-cost=@var{cost}
16155 @opindex mbranch-cost
16156 Set the branch costs for conditional branch instructions to
16157 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
16158 integers. The default branch cost is 0.
16160 @item -mcall-prologues
16161 @opindex mcall-prologues
16162 Functions prologues/epilogues are expanded as calls to appropriate
16163 subroutines.  Code size is smaller.
16165 @item -mgas-isr-prologues
16166 @opindex mgas-isr-prologues
16167 Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo
16168 instruction supported by GNU Binutils.
16169 If this option is on, the feature can still be disabled for individual
16170 ISRs by means of the @ref{AVR Function Attributes,,@code{no_gccisr}}
16171 function attribute.  This feature is activated per default
16172 if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}),
16173 and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,PR21683}}.
16175 @item -mint8
16176 @opindex mint8
16177 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
16178 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
16179 and @code{long long} is 4 bytes.  Please note that this option does not
16180 conform to the C standards, but it results in smaller code
16181 size.
16183 @item -mn-flash=@var{num}
16184 @opindex mn-flash
16185 Assume that the flash memory has a size of 
16186 @var{num} times 64@tie{}KiB.
16188 @item -mno-interrupts
16189 @opindex mno-interrupts
16190 Generated code is not compatible with hardware interrupts.
16191 Code size is smaller.
16193 @item -mrelax
16194 @opindex mrelax
16195 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
16196 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
16197 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
16198 the assembler's command line and the @option{--relax} option to the
16199 linker's command line.
16201 Jump relaxing is performed by the linker because jump offsets are not
16202 known before code is located. Therefore, the assembler code generated by the
16203 compiler is the same, but the instructions in the executable may
16204 differ from instructions in the assembler code.
16206 Relaxing must be turned on if linker stubs are needed, see the
16207 section on @code{EIND} and linker stubs below.
16209 @item -mrmw
16210 @opindex mrmw
16211 Assume that the device supports the Read-Modify-Write
16212 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
16214 @item -mshort-calls
16215 @opindex mshort-calls
16217 Assume that @code{RJMP} and @code{RCALL} can target the whole
16218 program memory.
16220 This option is used internally for multilib selection.  It is
16221 not an optimization option, and you don't need to set it by hand.
16223 @item -msp8
16224 @opindex msp8
16225 Treat the stack pointer register as an 8-bit register,
16226 i.e.@: assume the high byte of the stack pointer is zero.
16227 In general, you don't need to set this option by hand.
16229 This option is used internally by the compiler to select and
16230 build multilibs for architectures @code{avr2} and @code{avr25}.
16231 These architectures mix devices with and without @code{SPH}.
16232 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
16233 the compiler driver adds or removes this option from the compiler
16234 proper's command line, because the compiler then knows if the device
16235 or architecture has an 8-bit stack pointer and thus no @code{SPH}
16236 register or not.
16238 @item -mstrict-X
16239 @opindex mstrict-X
16240 Use address register @code{X} in a way proposed by the hardware.  This means
16241 that @code{X} is only used in indirect, post-increment or
16242 pre-decrement addressing.
16244 Without this option, the @code{X} register may be used in the same way
16245 as @code{Y} or @code{Z} which then is emulated by additional
16246 instructions.  
16247 For example, loading a value with @code{X+const} addressing with a
16248 small non-negative @code{const < 64} to a register @var{Rn} is
16249 performed as
16251 @example
16252 adiw r26, const   ; X += const
16253 ld   @var{Rn}, X        ; @var{Rn} = *X
16254 sbiw r26, const   ; X -= const
16255 @end example
16257 @item -mtiny-stack
16258 @opindex mtiny-stack
16259 Only change the lower 8@tie{}bits of the stack pointer.
16261 @item -mfract-convert-truncate
16262 @opindex mfract-convert-truncate
16263 Allow to use truncation instead of rounding towards zero for fractional fixed-point types.
16265 @item -nodevicelib
16266 @opindex nodevicelib
16267 Don't link against AVR-LibC's device specific library @code{lib<mcu>.a}.
16269 @item -Waddr-space-convert
16270 @opindex Waddr-space-convert
16271 Warn about conversions between address spaces in the case where the
16272 resulting address space is not contained in the incoming address space.
16274 @item -Wmisspelled-isr
16275 @opindex Wmisspelled-isr
16276 Warn if the ISR is misspelled, i.e. without __vector prefix.
16277 Enabled by default.
16278 @end table
16280 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
16281 @cindex @code{EIND}
16282 Pointers in the implementation are 16@tie{}bits wide.
16283 The address of a function or label is represented as word address so
16284 that indirect jumps and calls can target any code address in the
16285 range of 64@tie{}Ki words.
16287 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
16288 bytes of program memory space, there is a special function register called
16289 @code{EIND} that serves as most significant part of the target address
16290 when @code{EICALL} or @code{EIJMP} instructions are used.
16292 Indirect jumps and calls on these devices are handled as follows by
16293 the compiler and are subject to some limitations:
16295 @itemize @bullet
16297 @item
16298 The compiler never sets @code{EIND}.
16300 @item
16301 The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP}
16302 instructions or might read @code{EIND} directly in order to emulate an
16303 indirect call/jump by means of a @code{RET} instruction.
16305 @item
16306 The compiler assumes that @code{EIND} never changes during the startup
16307 code or during the application. In particular, @code{EIND} is not
16308 saved/restored in function or interrupt service routine
16309 prologue/epilogue.
16311 @item
16312 For indirect calls to functions and computed goto, the linker
16313 generates @emph{stubs}. Stubs are jump pads sometimes also called
16314 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
16315 The stub contains a direct jump to the desired address.
16317 @item
16318 Linker relaxation must be turned on so that the linker generates
16319 the stubs correctly in all situations. See the compiler option
16320 @option{-mrelax} and the linker option @option{--relax}.
16321 There are corner cases where the linker is supposed to generate stubs
16322 but aborts without relaxation and without a helpful error message.
16324 @item
16325 The default linker script is arranged for code with @code{EIND = 0}.
16326 If code is supposed to work for a setup with @code{EIND != 0}, a custom
16327 linker script has to be used in order to place the sections whose
16328 name start with @code{.trampolines} into the segment where @code{EIND}
16329 points to.
16331 @item
16332 The startup code from libgcc never sets @code{EIND}.
16333 Notice that startup code is a blend of code from libgcc and AVR-LibC.
16334 For the impact of AVR-LibC on @code{EIND}, see the
16335 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
16337 @item
16338 It is legitimate for user-specific startup code to set up @code{EIND}
16339 early, for example by means of initialization code located in
16340 section @code{.init3}. Such code runs prior to general startup code
16341 that initializes RAM and calls constructors, but after the bit
16342 of startup code from AVR-LibC that sets @code{EIND} to the segment
16343 where the vector table is located.
16344 @example
16345 #include <avr/io.h>
16347 static void
16348 __attribute__((section(".init3"),naked,used,no_instrument_function))
16349 init3_set_eind (void)
16351   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
16352                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
16354 @end example
16356 @noindent
16357 The @code{__trampolines_start} symbol is defined in the linker script.
16359 @item
16360 Stubs are generated automatically by the linker if
16361 the following two conditions are met:
16362 @itemize @minus
16364 @item The address of a label is taken by means of the @code{gs} modifier
16365 (short for @emph{generate stubs}) like so:
16366 @example
16367 LDI r24, lo8(gs(@var{func}))
16368 LDI r25, hi8(gs(@var{func}))
16369 @end example
16370 @item The final location of that label is in a code segment
16371 @emph{outside} the segment where the stubs are located.
16372 @end itemize
16374 @item
16375 The compiler emits such @code{gs} modifiers for code labels in the
16376 following situations:
16377 @itemize @minus
16378 @item Taking address of a function or code label.
16379 @item Computed goto.
16380 @item If prologue-save function is used, see @option{-mcall-prologues}
16381 command-line option.
16382 @item Switch/case dispatch tables. If you do not want such dispatch
16383 tables you can specify the @option{-fno-jump-tables} command-line option.
16384 @item C and C++ constructors/destructors called during startup/shutdown.
16385 @item If the tools hit a @code{gs()} modifier explained above.
16386 @end itemize
16388 @item
16389 Jumping to non-symbolic addresses like so is @emph{not} supported:
16391 @example
16392 int main (void)
16394     /* Call function at word address 0x2 */
16395     return ((int(*)(void)) 0x2)();
16397 @end example
16399 Instead, a stub has to be set up, i.e.@: the function has to be called
16400 through a symbol (@code{func_4} in the example):
16402 @example
16403 int main (void)
16405     extern int func_4 (void);
16407     /* Call function at byte address 0x4 */
16408     return func_4();
16410 @end example
16412 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
16413 Alternatively, @code{func_4} can be defined in the linker script.
16414 @end itemize
16416 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
16417 @cindex @code{RAMPD}
16418 @cindex @code{RAMPX}
16419 @cindex @code{RAMPY}
16420 @cindex @code{RAMPZ}
16421 Some AVR devices support memories larger than the 64@tie{}KiB range
16422 that can be accessed with 16-bit pointers.  To access memory locations
16423 outside this 64@tie{}KiB range, the content of a @code{RAMP}
16424 register is used as high part of the address:
16425 The @code{X}, @code{Y}, @code{Z} address register is concatenated
16426 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
16427 register, respectively, to get a wide address. Similarly,
16428 @code{RAMPD} is used together with direct addressing.
16430 @itemize
16431 @item
16432 The startup code initializes the @code{RAMP} special function
16433 registers with zero.
16435 @item
16436 If a @ref{AVR Named Address Spaces,named address space} other than
16437 generic or @code{__flash} is used, then @code{RAMPZ} is set
16438 as needed before the operation.
16440 @item
16441 If the device supports RAM larger than 64@tie{}KiB and the compiler
16442 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
16443 is reset to zero after the operation.
16445 @item
16446 If the device comes with a specific @code{RAMP} register, the ISR
16447 prologue/epilogue saves/restores that SFR and initializes it with
16448 zero in case the ISR code might (implicitly) use it.
16450 @item
16451 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
16452 If you use inline assembler to read from locations outside the
16453 16-bit address range and change one of the @code{RAMP} registers,
16454 you must reset it to zero after the access.
16456 @end itemize
16458 @subsubsection AVR Built-in Macros
16460 GCC defines several built-in macros so that the user code can test
16461 for the presence or absence of features.  Almost any of the following
16462 built-in macros are deduced from device capabilities and thus
16463 triggered by the @option{-mmcu=} command-line option.
16465 For even more AVR-specific built-in macros see
16466 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
16468 @table @code
16470 @item __AVR_ARCH__
16471 Build-in macro that resolves to a decimal number that identifies the
16472 architecture and depends on the @option{-mmcu=@var{mcu}} option.
16473 Possible values are:
16475 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
16476 @code{4}, @code{5}, @code{51}, @code{6}
16478 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
16479 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
16481 respectively and
16483 @code{100},
16484 @code{102}, @code{103}, @code{104},
16485 @code{105}, @code{106}, @code{107}
16487 for @var{mcu}=@code{avrtiny},
16488 @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4},
16489 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
16490 If @var{mcu} specifies a device, this built-in macro is set
16491 accordingly. For example, with @option{-mmcu=atmega8} the macro is
16492 defined to @code{4}.
16494 @item __AVR_@var{Device}__
16495 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
16496 the device's name. For example, @option{-mmcu=atmega8} defines the
16497 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
16498 @code{__AVR_ATtiny261A__}, etc.
16500 The built-in macros' names follow
16501 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
16502 the device name as from the AVR user manual. The difference between
16503 @var{Device} in the built-in macro and @var{device} in
16504 @option{-mmcu=@var{device}} is that the latter is always lowercase.
16506 If @var{device} is not a device but only a core architecture like
16507 @samp{avr51}, this macro is not defined.
16509 @item __AVR_DEVICE_NAME__
16510 Setting @option{-mmcu=@var{device}} defines this built-in macro to
16511 the device's name. For example, with @option{-mmcu=atmega8} the macro
16512 is defined to @code{atmega8}.
16514 If @var{device} is not a device but only a core architecture like
16515 @samp{avr51}, this macro is not defined.
16517 @item __AVR_XMEGA__
16518 The device / architecture belongs to the XMEGA family of devices.
16520 @item __AVR_HAVE_ELPM__
16521 The device has the @code{ELPM} instruction.
16523 @item __AVR_HAVE_ELPMX__
16524 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
16525 R@var{n},Z+} instructions.
16527 @item __AVR_HAVE_MOVW__
16528 The device has the @code{MOVW} instruction to perform 16-bit
16529 register-register moves.
16531 @item __AVR_HAVE_LPMX__
16532 The device has the @code{LPM R@var{n},Z} and
16533 @code{LPM R@var{n},Z+} instructions.
16535 @item __AVR_HAVE_MUL__
16536 The device has a hardware multiplier. 
16538 @item __AVR_HAVE_JMP_CALL__
16539 The device has the @code{JMP} and @code{CALL} instructions.
16540 This is the case for devices with more than 8@tie{}KiB of program
16541 memory.
16543 @item __AVR_HAVE_EIJMP_EICALL__
16544 @itemx __AVR_3_BYTE_PC__
16545 The device has the @code{EIJMP} and @code{EICALL} instructions.
16546 This is the case for devices with more than 128@tie{}KiB of program memory.
16547 This also means that the program counter
16548 (PC) is 3@tie{}bytes wide.
16550 @item __AVR_2_BYTE_PC__
16551 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
16552 with up to 128@tie{}KiB of program memory.
16554 @item __AVR_HAVE_8BIT_SP__
16555 @itemx __AVR_HAVE_16BIT_SP__
16556 The stack pointer (SP) register is treated as 8-bit respectively
16557 16-bit register by the compiler.
16558 The definition of these macros is affected by @option{-mtiny-stack}.
16560 @item __AVR_HAVE_SPH__
16561 @itemx __AVR_SP8__
16562 The device has the SPH (high part of stack pointer) special function
16563 register or has an 8-bit stack pointer, respectively.
16564 The definition of these macros is affected by @option{-mmcu=} and
16565 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
16566 by @option{-msp8}.
16568 @item __AVR_HAVE_RAMPD__
16569 @itemx __AVR_HAVE_RAMPX__
16570 @itemx __AVR_HAVE_RAMPY__
16571 @itemx __AVR_HAVE_RAMPZ__
16572 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
16573 @code{RAMPZ} special function register, respectively.
16575 @item __NO_INTERRUPTS__
16576 This macro reflects the @option{-mno-interrupts} command-line option.
16578 @item __AVR_ERRATA_SKIP__
16579 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
16580 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
16581 instructions because of a hardware erratum.  Skip instructions are
16582 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
16583 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
16584 set.
16586 @item __AVR_ISA_RMW__
16587 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
16589 @item __AVR_SFR_OFFSET__=@var{offset}
16590 Instructions that can address I/O special function registers directly
16591 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
16592 address as if addressed by an instruction to access RAM like @code{LD}
16593 or @code{STS}. This offset depends on the device architecture and has
16594 to be subtracted from the RAM address in order to get the
16595 respective I/O@tie{}address.
16597 @item __AVR_SHORT_CALLS__
16598 The @option{-mshort-calls} command line option is set.
16600 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
16601 Some devices support reading from flash memory by means of @code{LD*}
16602 instructions.  The flash memory is seen in the data address space
16603 at an offset of @code{__AVR_PM_BASE_ADDRESS__}.  If this macro
16604 is not defined, this feature is not available.  If defined,
16605 the address space is linear and there is no need to put
16606 @code{.rodata} into RAM.  This is handled by the default linker
16607 description file, and is currently available for
16608 @code{avrtiny} and @code{avrxmega3}.  Even more convenient,
16609 there is no need to use address spaces like @code{__flash} or
16610 features like attribute @code{progmem} and @code{pgm_read_*}.
16612 @item __WITH_AVRLIBC__
16613 The compiler is configured to be used together with AVR-Libc.
16614 See the @option{--with-avrlibc} configure option.
16616 @end table
16618 @node Blackfin Options
16619 @subsection Blackfin Options
16620 @cindex Blackfin Options
16622 @table @gcctabopt
16623 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
16624 @opindex mcpu=
16625 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
16626 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
16627 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
16628 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
16629 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
16630 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
16631 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
16632 @samp{bf561}, @samp{bf592}.
16634 The optional @var{sirevision} specifies the silicon revision of the target
16635 Blackfin processor.  Any workarounds available for the targeted silicon revision
16636 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
16637 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
16638 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
16639 hexadecimal digits representing the major and minor numbers in the silicon
16640 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
16641 is not defined.  If @var{sirevision} is @samp{any}, the
16642 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
16643 If this optional @var{sirevision} is not used, GCC assumes the latest known
16644 silicon revision of the targeted Blackfin processor.
16646 GCC defines a preprocessor macro for the specified @var{cpu}.
16647 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
16648 provided by libgloss to be linked in if @option{-msim} is not given.
16650 Without this option, @samp{bf532} is used as the processor by default.
16652 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
16653 only the preprocessor macro is defined.
16655 @item -msim
16656 @opindex msim
16657 Specifies that the program will be run on the simulator.  This causes
16658 the simulator BSP provided by libgloss to be linked in.  This option
16659 has effect only for @samp{bfin-elf} toolchain.
16660 Certain other options, such as @option{-mid-shared-library} and
16661 @option{-mfdpic}, imply @option{-msim}.
16663 @item -momit-leaf-frame-pointer
16664 @opindex momit-leaf-frame-pointer
16665 Don't keep the frame pointer in a register for leaf functions.  This
16666 avoids the instructions to save, set up and restore frame pointers and
16667 makes an extra register available in leaf functions.  The option
16668 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
16669 which might make debugging harder.
16671 @item -mspecld-anomaly
16672 @opindex mspecld-anomaly
16673 When enabled, the compiler ensures that the generated code does not
16674 contain speculative loads after jump instructions. If this option is used,
16675 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
16677 @item -mno-specld-anomaly
16678 @opindex mno-specld-anomaly
16679 Don't generate extra code to prevent speculative loads from occurring.
16681 @item -mcsync-anomaly
16682 @opindex mcsync-anomaly
16683 When enabled, the compiler ensures that the generated code does not
16684 contain CSYNC or SSYNC instructions too soon after conditional branches.
16685 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
16687 @item -mno-csync-anomaly
16688 @opindex mno-csync-anomaly
16689 Don't generate extra code to prevent CSYNC or SSYNC instructions from
16690 occurring too soon after a conditional branch.
16692 @item -mlow-64k
16693 @opindex mlow-64k
16694 When enabled, the compiler is free to take advantage of the knowledge that
16695 the entire program fits into the low 64k of memory.
16697 @item -mno-low-64k
16698 @opindex mno-low-64k
16699 Assume that the program is arbitrarily large.  This is the default.
16701 @item -mstack-check-l1
16702 @opindex mstack-check-l1
16703 Do stack checking using information placed into L1 scratchpad memory by the
16704 uClinux kernel.
16706 @item -mid-shared-library
16707 @opindex mid-shared-library
16708 Generate code that supports shared libraries via the library ID method.
16709 This allows for execute in place and shared libraries in an environment
16710 without virtual memory management.  This option implies @option{-fPIC}.
16711 With a @samp{bfin-elf} target, this option implies @option{-msim}.
16713 @item -mno-id-shared-library
16714 @opindex mno-id-shared-library
16715 Generate code that doesn't assume ID-based shared libraries are being used.
16716 This is the default.
16718 @item -mleaf-id-shared-library
16719 @opindex mleaf-id-shared-library
16720 Generate code that supports shared libraries via the library ID method,
16721 but assumes that this library or executable won't link against any other
16722 ID shared libraries.  That allows the compiler to use faster code for jumps
16723 and calls.
16725 @item -mno-leaf-id-shared-library
16726 @opindex mno-leaf-id-shared-library
16727 Do not assume that the code being compiled won't link against any ID shared
16728 libraries.  Slower code is generated for jump and call insns.
16730 @item -mshared-library-id=n
16731 @opindex mshared-library-id
16732 Specifies the identification number of the ID-based shared library being
16733 compiled.  Specifying a value of 0 generates more compact code; specifying
16734 other values forces the allocation of that number to the current
16735 library but is no more space- or time-efficient than omitting this option.
16737 @item -msep-data
16738 @opindex msep-data
16739 Generate code that allows the data segment to be located in a different
16740 area of memory from the text segment.  This allows for execute in place in
16741 an environment without virtual memory management by eliminating relocations
16742 against the text section.
16744 @item -mno-sep-data
16745 @opindex mno-sep-data
16746 Generate code that assumes that the data segment follows the text segment.
16747 This is the default.
16749 @item -mlong-calls
16750 @itemx -mno-long-calls
16751 @opindex mlong-calls
16752 @opindex mno-long-calls
16753 Tells the compiler to perform function calls by first loading the
16754 address of the function into a register and then performing a subroutine
16755 call on this register.  This switch is needed if the target function
16756 lies outside of the 24-bit addressing range of the offset-based
16757 version of subroutine call instruction.
16759 This feature is not enabled by default.  Specifying
16760 @option{-mno-long-calls} restores the default behavior.  Note these
16761 switches have no effect on how the compiler generates code to handle
16762 function calls via function pointers.
16764 @item -mfast-fp
16765 @opindex mfast-fp
16766 Link with the fast floating-point library. This library relaxes some of
16767 the IEEE floating-point standard's rules for checking inputs against
16768 Not-a-Number (NAN), in the interest of performance.
16770 @item -minline-plt
16771 @opindex minline-plt
16772 Enable inlining of PLT entries in function calls to functions that are
16773 not known to bind locally.  It has no effect without @option{-mfdpic}.
16775 @item -mmulticore
16776 @opindex mmulticore
16777 Build a standalone application for multicore Blackfin processors. 
16778 This option causes proper start files and link scripts supporting 
16779 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
16780 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
16782 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
16783 selects the one-application-per-core programming model.  Without
16784 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
16785 programming model is used. In this model, the main function of Core B
16786 should be named as @code{coreb_main}.
16788 If this option is not used, the single-core application programming
16789 model is used.
16791 @item -mcorea
16792 @opindex mcorea
16793 Build a standalone application for Core A of BF561 when using
16794 the one-application-per-core programming model. Proper start files
16795 and link scripts are used to support Core A, and the macro
16796 @code{__BFIN_COREA} is defined.
16797 This option can only be used in conjunction with @option{-mmulticore}.
16799 @item -mcoreb
16800 @opindex mcoreb
16801 Build a standalone application for Core B of BF561 when using
16802 the one-application-per-core programming model. Proper start files
16803 and link scripts are used to support Core B, and the macro
16804 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
16805 should be used instead of @code{main}. 
16806 This option can only be used in conjunction with @option{-mmulticore}.
16808 @item -msdram
16809 @opindex msdram
16810 Build a standalone application for SDRAM. Proper start files and
16811 link scripts are used to put the application into SDRAM, and the macro
16812 @code{__BFIN_SDRAM} is defined.
16813 The loader should initialize SDRAM before loading the application.
16815 @item -micplb
16816 @opindex micplb
16817 Assume that ICPLBs are enabled at run time.  This has an effect on certain
16818 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
16819 are enabled; for standalone applications the default is off.
16820 @end table
16822 @node C6X Options
16823 @subsection C6X Options
16824 @cindex C6X Options
16826 @table @gcctabopt
16827 @item -march=@var{name}
16828 @opindex march
16829 This specifies the name of the target architecture.  GCC uses this
16830 name to determine what kind of instructions it can emit when generating
16831 assembly code.  Permissible names are: @samp{c62x},
16832 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
16834 @item -mbig-endian
16835 @opindex mbig-endian
16836 Generate code for a big-endian target.
16838 @item -mlittle-endian
16839 @opindex mlittle-endian
16840 Generate code for a little-endian target.  This is the default.
16842 @item -msim
16843 @opindex msim
16844 Choose startup files and linker script suitable for the simulator.
16846 @item -msdata=default
16847 @opindex msdata=default
16848 Put small global and static data in the @code{.neardata} section,
16849 which is pointed to by register @code{B14}.  Put small uninitialized
16850 global and static data in the @code{.bss} section, which is adjacent
16851 to the @code{.neardata} section.  Put small read-only data into the
16852 @code{.rodata} section.  The corresponding sections used for large
16853 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
16855 @item -msdata=all
16856 @opindex msdata=all
16857 Put all data, not just small objects, into the sections reserved for
16858 small data, and use addressing relative to the @code{B14} register to
16859 access them.
16861 @item -msdata=none
16862 @opindex msdata=none
16863 Make no use of the sections reserved for small data, and use absolute
16864 addresses to access all data.  Put all initialized global and static
16865 data in the @code{.fardata} section, and all uninitialized data in the
16866 @code{.far} section.  Put all constant data into the @code{.const}
16867 section.
16868 @end table
16870 @node CRIS Options
16871 @subsection CRIS Options
16872 @cindex CRIS Options
16874 These options are defined specifically for the CRIS ports.
16876 @table @gcctabopt
16877 @item -march=@var{architecture-type}
16878 @itemx -mcpu=@var{architecture-type}
16879 @opindex march
16880 @opindex mcpu
16881 Generate code for the specified architecture.  The choices for
16882 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
16883 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
16884 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
16885 @samp{v10}.
16887 @item -mtune=@var{architecture-type}
16888 @opindex mtune
16889 Tune to @var{architecture-type} everything applicable about the generated
16890 code, except for the ABI and the set of available instructions.  The
16891 choices for @var{architecture-type} are the same as for
16892 @option{-march=@var{architecture-type}}.
16894 @item -mmax-stack-frame=@var{n}
16895 @opindex mmax-stack-frame
16896 Warn when the stack frame of a function exceeds @var{n} bytes.
16898 @item -metrax4
16899 @itemx -metrax100
16900 @opindex metrax4
16901 @opindex metrax100
16902 The options @option{-metrax4} and @option{-metrax100} are synonyms for
16903 @option{-march=v3} and @option{-march=v8} respectively.
16905 @item -mmul-bug-workaround
16906 @itemx -mno-mul-bug-workaround
16907 @opindex mmul-bug-workaround
16908 @opindex mno-mul-bug-workaround
16909 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
16910 models where it applies.  This option is active by default.
16912 @item -mpdebug
16913 @opindex mpdebug
16914 Enable CRIS-specific verbose debug-related information in the assembly
16915 code.  This option also has the effect of turning off the @samp{#NO_APP}
16916 formatted-code indicator to the assembler at the beginning of the
16917 assembly file.
16919 @item -mcc-init
16920 @opindex mcc-init
16921 Do not use condition-code results from previous instruction; always emit
16922 compare and test instructions before use of condition codes.
16924 @item -mno-side-effects
16925 @opindex mno-side-effects
16926 Do not emit instructions with side effects in addressing modes other than
16927 post-increment.
16929 @item -mstack-align
16930 @itemx -mno-stack-align
16931 @itemx -mdata-align
16932 @itemx -mno-data-align
16933 @itemx -mconst-align
16934 @itemx -mno-const-align
16935 @opindex mstack-align
16936 @opindex mno-stack-align
16937 @opindex mdata-align
16938 @opindex mno-data-align
16939 @opindex mconst-align
16940 @opindex mno-const-align
16941 These options (@samp{no-} options) arrange (eliminate arrangements) for the
16942 stack frame, individual data and constants to be aligned for the maximum
16943 single data access size for the chosen CPU model.  The default is to
16944 arrange for 32-bit alignment.  ABI details such as structure layout are
16945 not affected by these options.
16947 @item -m32-bit
16948 @itemx -m16-bit
16949 @itemx -m8-bit
16950 @opindex m32-bit
16951 @opindex m16-bit
16952 @opindex m8-bit
16953 Similar to the stack- data- and const-align options above, these options
16954 arrange for stack frame, writable data and constants to all be 32-bit,
16955 16-bit or 8-bit aligned.  The default is 32-bit alignment.
16957 @item -mno-prologue-epilogue
16958 @itemx -mprologue-epilogue
16959 @opindex mno-prologue-epilogue
16960 @opindex mprologue-epilogue
16961 With @option{-mno-prologue-epilogue}, the normal function prologue and
16962 epilogue which set up the stack frame are omitted and no return
16963 instructions or return sequences are generated in the code.  Use this
16964 option only together with visual inspection of the compiled code: no
16965 warnings or errors are generated when call-saved registers must be saved,
16966 or storage for local variables needs to be allocated.
16968 @item -mno-gotplt
16969 @itemx -mgotplt
16970 @opindex mno-gotplt
16971 @opindex mgotplt
16972 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
16973 instruction sequences that load addresses for functions from the PLT part
16974 of the GOT rather than (traditional on other architectures) calls to the
16975 PLT@.  The default is @option{-mgotplt}.
16977 @item -melf
16978 @opindex melf
16979 Legacy no-op option only recognized with the cris-axis-elf and
16980 cris-axis-linux-gnu targets.
16982 @item -mlinux
16983 @opindex mlinux
16984 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
16986 @item -sim
16987 @opindex sim
16988 This option, recognized for the cris-axis-elf, arranges
16989 to link with input-output functions from a simulator library.  Code,
16990 initialized data and zero-initialized data are allocated consecutively.
16992 @item -sim2
16993 @opindex sim2
16994 Like @option{-sim}, but pass linker options to locate initialized data at
16995 0x40000000 and zero-initialized data at 0x80000000.
16996 @end table
16998 @node CR16 Options
16999 @subsection CR16 Options
17000 @cindex CR16 Options
17002 These options are defined specifically for the CR16 ports.
17004 @table @gcctabopt
17006 @item -mmac
17007 @opindex mmac
17008 Enable the use of multiply-accumulate instructions. Disabled by default.
17010 @item -mcr16cplus
17011 @itemx -mcr16c
17012 @opindex mcr16cplus
17013 @opindex mcr16c
17014 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
17015 is default.
17017 @item -msim
17018 @opindex msim
17019 Links the library libsim.a which is in compatible with simulator. Applicable
17020 to ELF compiler only.
17022 @item -mint32
17023 @opindex mint32
17024 Choose integer type as 32-bit wide.
17026 @item -mbit-ops
17027 @opindex mbit-ops
17028 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
17030 @item -mdata-model=@var{model}
17031 @opindex mdata-model
17032 Choose a data model. The choices for @var{model} are @samp{near},
17033 @samp{far} or @samp{medium}. @samp{medium} is default.
17034 However, @samp{far} is not valid with @option{-mcr16c}, as the
17035 CR16C architecture does not support the far data model.
17036 @end table
17038 @node Darwin Options
17039 @subsection Darwin Options
17040 @cindex Darwin options
17042 These options are defined for all architectures running the Darwin operating
17043 system.
17045 FSF GCC on Darwin does not create ``fat'' object files; it creates
17046 an object file for the single architecture that GCC was built to
17047 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
17048 @option{-arch} options are used; it does so by running the compiler or
17049 linker multiple times and joining the results together with
17050 @file{lipo}.
17052 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
17053 @samp{i686}) is determined by the flags that specify the ISA
17054 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
17055 @option{-force_cpusubtype_ALL} option can be used to override this.
17057 The Darwin tools vary in their behavior when presented with an ISA
17058 mismatch.  The assembler, @file{as}, only permits instructions to
17059 be used that are valid for the subtype of the file it is generating,
17060 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
17061 The linker for shared libraries, @file{/usr/bin/libtool}, fails
17062 and prints an error if asked to create a shared library with a less
17063 restrictive subtype than its input files (for instance, trying to put
17064 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
17065 for executables, @command{ld}, quietly gives the executable the most
17066 restrictive subtype of any of its input files.
17068 @table @gcctabopt
17069 @item -F@var{dir}
17070 @opindex F
17071 Add the framework directory @var{dir} to the head of the list of
17072 directories to be searched for header files.  These directories are
17073 interleaved with those specified by @option{-I} options and are
17074 scanned in a left-to-right order.
17076 A framework directory is a directory with frameworks in it.  A
17077 framework is a directory with a @file{Headers} and/or
17078 @file{PrivateHeaders} directory contained directly in it that ends
17079 in @file{.framework}.  The name of a framework is the name of this
17080 directory excluding the @file{.framework}.  Headers associated with
17081 the framework are found in one of those two directories, with
17082 @file{Headers} being searched first.  A subframework is a framework
17083 directory that is in a framework's @file{Frameworks} directory.
17084 Includes of subframework headers can only appear in a header of a
17085 framework that contains the subframework, or in a sibling subframework
17086 header.  Two subframeworks are siblings if they occur in the same
17087 framework.  A subframework should not have the same name as a
17088 framework; a warning is issued if this is violated.  Currently a
17089 subframework cannot have subframeworks; in the future, the mechanism
17090 may be extended to support this.  The standard frameworks can be found
17091 in @file{/System/Library/Frameworks} and
17092 @file{/Library/Frameworks}.  An example include looks like
17093 @code{#include <Framework/header.h>}, where @file{Framework} denotes
17094 the name of the framework and @file{header.h} is found in the
17095 @file{PrivateHeaders} or @file{Headers} directory.
17097 @item -iframework@var{dir}
17098 @opindex iframework
17099 Like @option{-F} except the directory is a treated as a system
17100 directory.  The main difference between this @option{-iframework} and
17101 @option{-F} is that with @option{-iframework} the compiler does not
17102 warn about constructs contained within header files found via
17103 @var{dir}.  This option is valid only for the C family of languages.
17105 @item -gused
17106 @opindex gused
17107 Emit debugging information for symbols that are used.  For stabs
17108 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
17109 This is by default ON@.
17111 @item -gfull
17112 @opindex gfull
17113 Emit debugging information for all symbols and types.
17115 @item -mmacosx-version-min=@var{version}
17116 The earliest version of MacOS X that this executable will run on
17117 is @var{version}.  Typical values of @var{version} include @code{10.1},
17118 @code{10.2}, and @code{10.3.9}.
17120 If the compiler was built to use the system's headers by default,
17121 then the default for this option is the system version on which the
17122 compiler is running, otherwise the default is to make choices that
17123 are compatible with as many systems and code bases as possible.
17125 @item -mkernel
17126 @opindex mkernel
17127 Enable kernel development mode.  The @option{-mkernel} option sets
17128 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
17129 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
17130 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
17131 applicable.  This mode also sets @option{-mno-altivec},
17132 @option{-msoft-float}, @option{-fno-builtin} and
17133 @option{-mlong-branch} for PowerPC targets.
17135 @item -mone-byte-bool
17136 @opindex mone-byte-bool
17137 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
17138 By default @code{sizeof(bool)} is @code{4} when compiling for
17139 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
17140 option has no effect on x86.
17142 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
17143 to generate code that is not binary compatible with code generated
17144 without that switch.  Using this switch may require recompiling all
17145 other modules in a program, including system libraries.  Use this
17146 switch to conform to a non-default data model.
17148 @item -mfix-and-continue
17149 @itemx -ffix-and-continue
17150 @itemx -findirect-data
17151 @opindex mfix-and-continue
17152 @opindex ffix-and-continue
17153 @opindex findirect-data
17154 Generate code suitable for fast turnaround development, such as to
17155 allow GDB to dynamically load @file{.o} files into already-running
17156 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
17157 are provided for backwards compatibility.
17159 @item -all_load
17160 @opindex all_load
17161 Loads all members of static archive libraries.
17162 See man ld(1) for more information.
17164 @item -arch_errors_fatal
17165 @opindex arch_errors_fatal
17166 Cause the errors having to do with files that have the wrong architecture
17167 to be fatal.
17169 @item -bind_at_load
17170 @opindex bind_at_load
17171 Causes the output file to be marked such that the dynamic linker will
17172 bind all undefined references when the file is loaded or launched.
17174 @item -bundle
17175 @opindex bundle
17176 Produce a Mach-o bundle format file.
17177 See man ld(1) for more information.
17179 @item -bundle_loader @var{executable}
17180 @opindex bundle_loader
17181 This option specifies the @var{executable} that will load the build
17182 output file being linked.  See man ld(1) for more information.
17184 @item -dynamiclib
17185 @opindex dynamiclib
17186 When passed this option, GCC produces a dynamic library instead of
17187 an executable when linking, using the Darwin @file{libtool} command.
17189 @item -force_cpusubtype_ALL
17190 @opindex force_cpusubtype_ALL
17191 This causes GCC's output file to have the @samp{ALL} subtype, instead of
17192 one controlled by the @option{-mcpu} or @option{-march} option.
17194 @item -allowable_client  @var{client_name}
17195 @itemx -client_name
17196 @itemx -compatibility_version
17197 @itemx -current_version
17198 @itemx -dead_strip
17199 @itemx -dependency-file
17200 @itemx -dylib_file
17201 @itemx -dylinker_install_name
17202 @itemx -dynamic
17203 @itemx -exported_symbols_list
17204 @itemx -filelist
17205 @need 800
17206 @itemx -flat_namespace
17207 @itemx -force_flat_namespace
17208 @itemx -headerpad_max_install_names
17209 @itemx -image_base
17210 @itemx -init
17211 @itemx -install_name
17212 @itemx -keep_private_externs
17213 @itemx -multi_module
17214 @itemx -multiply_defined
17215 @itemx -multiply_defined_unused
17216 @need 800
17217 @itemx -noall_load
17218 @itemx -no_dead_strip_inits_and_terms
17219 @itemx -nofixprebinding
17220 @itemx -nomultidefs
17221 @itemx -noprebind
17222 @itemx -noseglinkedit
17223 @itemx -pagezero_size
17224 @itemx -prebind
17225 @itemx -prebind_all_twolevel_modules
17226 @itemx -private_bundle
17227 @need 800
17228 @itemx -read_only_relocs
17229 @itemx -sectalign
17230 @itemx -sectobjectsymbols
17231 @itemx -whyload
17232 @itemx -seg1addr
17233 @itemx -sectcreate
17234 @itemx -sectobjectsymbols
17235 @itemx -sectorder
17236 @itemx -segaddr
17237 @itemx -segs_read_only_addr
17238 @need 800
17239 @itemx -segs_read_write_addr
17240 @itemx -seg_addr_table
17241 @itemx -seg_addr_table_filename
17242 @itemx -seglinkedit
17243 @itemx -segprot
17244 @itemx -segs_read_only_addr
17245 @itemx -segs_read_write_addr
17246 @itemx -single_module
17247 @itemx -static
17248 @itemx -sub_library
17249 @need 800
17250 @itemx -sub_umbrella
17251 @itemx -twolevel_namespace
17252 @itemx -umbrella
17253 @itemx -undefined
17254 @itemx -unexported_symbols_list
17255 @itemx -weak_reference_mismatches
17256 @itemx -whatsloaded
17257 @opindex allowable_client
17258 @opindex client_name
17259 @opindex compatibility_version
17260 @opindex current_version
17261 @opindex dead_strip
17262 @opindex dependency-file
17263 @opindex dylib_file
17264 @opindex dylinker_install_name
17265 @opindex dynamic
17266 @opindex exported_symbols_list
17267 @opindex filelist
17268 @opindex flat_namespace
17269 @opindex force_flat_namespace
17270 @opindex headerpad_max_install_names
17271 @opindex image_base
17272 @opindex init
17273 @opindex install_name
17274 @opindex keep_private_externs
17275 @opindex multi_module
17276 @opindex multiply_defined
17277 @opindex multiply_defined_unused
17278 @opindex noall_load
17279 @opindex no_dead_strip_inits_and_terms
17280 @opindex nofixprebinding
17281 @opindex nomultidefs
17282 @opindex noprebind
17283 @opindex noseglinkedit
17284 @opindex pagezero_size
17285 @opindex prebind
17286 @opindex prebind_all_twolevel_modules
17287 @opindex private_bundle
17288 @opindex read_only_relocs
17289 @opindex sectalign
17290 @opindex sectobjectsymbols
17291 @opindex whyload
17292 @opindex seg1addr
17293 @opindex sectcreate
17294 @opindex sectobjectsymbols
17295 @opindex sectorder
17296 @opindex segaddr
17297 @opindex segs_read_only_addr
17298 @opindex segs_read_write_addr
17299 @opindex seg_addr_table
17300 @opindex seg_addr_table_filename
17301 @opindex seglinkedit
17302 @opindex segprot
17303 @opindex segs_read_only_addr
17304 @opindex segs_read_write_addr
17305 @opindex single_module
17306 @opindex static
17307 @opindex sub_library
17308 @opindex sub_umbrella
17309 @opindex twolevel_namespace
17310 @opindex umbrella
17311 @opindex undefined
17312 @opindex unexported_symbols_list
17313 @opindex weak_reference_mismatches
17314 @opindex whatsloaded
17315 These options are passed to the Darwin linker.  The Darwin linker man page
17316 describes them in detail.
17317 @end table
17319 @node DEC Alpha Options
17320 @subsection DEC Alpha Options
17322 These @samp{-m} options are defined for the DEC Alpha implementations:
17324 @table @gcctabopt
17325 @item -mno-soft-float
17326 @itemx -msoft-float
17327 @opindex mno-soft-float
17328 @opindex msoft-float
17329 Use (do not use) the hardware floating-point instructions for
17330 floating-point operations.  When @option{-msoft-float} is specified,
17331 functions in @file{libgcc.a} are used to perform floating-point
17332 operations.  Unless they are replaced by routines that emulate the
17333 floating-point operations, or compiled in such a way as to call such
17334 emulations routines, these routines issue floating-point
17335 operations.   If you are compiling for an Alpha without floating-point
17336 operations, you must ensure that the library is built so as not to call
17337 them.
17339 Note that Alpha implementations without floating-point operations are
17340 required to have floating-point registers.
17342 @item -mfp-reg
17343 @itemx -mno-fp-regs
17344 @opindex mfp-reg
17345 @opindex mno-fp-regs
17346 Generate code that uses (does not use) the floating-point register set.
17347 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
17348 register set is not used, floating-point operands are passed in integer
17349 registers as if they were integers and floating-point results are passed
17350 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
17351 so any function with a floating-point argument or return value called by code
17352 compiled with @option{-mno-fp-regs} must also be compiled with that
17353 option.
17355 A typical use of this option is building a kernel that does not use,
17356 and hence need not save and restore, any floating-point registers.
17358 @item -mieee
17359 @opindex mieee
17360 The Alpha architecture implements floating-point hardware optimized for
17361 maximum performance.  It is mostly compliant with the IEEE floating-point
17362 standard.  However, for full compliance, software assistance is
17363 required.  This option generates code fully IEEE-compliant code
17364 @emph{except} that the @var{inexact-flag} is not maintained (see below).
17365 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
17366 defined during compilation.  The resulting code is less efficient but is
17367 able to correctly support denormalized numbers and exceptional IEEE
17368 values such as not-a-number and plus/minus infinity.  Other Alpha
17369 compilers call this option @option{-ieee_with_no_inexact}.
17371 @item -mieee-with-inexact
17372 @opindex mieee-with-inexact
17373 This is like @option{-mieee} except the generated code also maintains
17374 the IEEE @var{inexact-flag}.  Turning on this option causes the
17375 generated code to implement fully-compliant IEEE math.  In addition to
17376 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
17377 macro.  On some Alpha implementations the resulting code may execute
17378 significantly slower than the code generated by default.  Since there is
17379 very little code that depends on the @var{inexact-flag}, you should
17380 normally not specify this option.  Other Alpha compilers call this
17381 option @option{-ieee_with_inexact}.
17383 @item -mfp-trap-mode=@var{trap-mode}
17384 @opindex mfp-trap-mode
17385 This option controls what floating-point related traps are enabled.
17386 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
17387 The trap mode can be set to one of four values:
17389 @table @samp
17390 @item n
17391 This is the default (normal) setting.  The only traps that are enabled
17392 are the ones that cannot be disabled in software (e.g., division by zero
17393 trap).
17395 @item u
17396 In addition to the traps enabled by @samp{n}, underflow traps are enabled
17397 as well.
17399 @item su
17400 Like @samp{u}, but the instructions are marked to be safe for software
17401 completion (see Alpha architecture manual for details).
17403 @item sui
17404 Like @samp{su}, but inexact traps are enabled as well.
17405 @end table
17407 @item -mfp-rounding-mode=@var{rounding-mode}
17408 @opindex mfp-rounding-mode
17409 Selects the IEEE rounding mode.  Other Alpha compilers call this option
17410 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
17413 @table @samp
17414 @item n
17415 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
17416 the nearest machine number or towards the even machine number in case
17417 of a tie.
17419 @item m
17420 Round towards minus infinity.
17422 @item c
17423 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
17425 @item d
17426 Dynamic rounding mode.  A field in the floating-point control register
17427 (@var{fpcr}, see Alpha architecture reference manual) controls the
17428 rounding mode in effect.  The C library initializes this register for
17429 rounding towards plus infinity.  Thus, unless your program modifies the
17430 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
17431 @end table
17433 @item -mtrap-precision=@var{trap-precision}
17434 @opindex mtrap-precision
17435 In the Alpha architecture, floating-point traps are imprecise.  This
17436 means without software assistance it is impossible to recover from a
17437 floating trap and program execution normally needs to be terminated.
17438 GCC can generate code that can assist operating system trap handlers
17439 in determining the exact location that caused a floating-point trap.
17440 Depending on the requirements of an application, different levels of
17441 precisions can be selected:
17443 @table @samp
17444 @item p
17445 Program precision.  This option is the default and means a trap handler
17446 can only identify which program caused a floating-point exception.
17448 @item f
17449 Function precision.  The trap handler can determine the function that
17450 caused a floating-point exception.
17452 @item i
17453 Instruction precision.  The trap handler can determine the exact
17454 instruction that caused a floating-point exception.
17455 @end table
17457 Other Alpha compilers provide the equivalent options called
17458 @option{-scope_safe} and @option{-resumption_safe}.
17460 @item -mieee-conformant
17461 @opindex mieee-conformant
17462 This option marks the generated code as IEEE conformant.  You must not
17463 use this option unless you also specify @option{-mtrap-precision=i} and either
17464 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
17465 is to emit the line @samp{.eflag 48} in the function prologue of the
17466 generated assembly file.
17468 @item -mbuild-constants
17469 @opindex mbuild-constants
17470 Normally GCC examines a 32- or 64-bit integer constant to
17471 see if it can construct it from smaller constants in two or three
17472 instructions.  If it cannot, it outputs the constant as a literal and
17473 generates code to load it from the data segment at run time.
17475 Use this option to require GCC to construct @emph{all} integer constants
17476 using code, even if it takes more instructions (the maximum is six).
17478 You typically use this option to build a shared library dynamic
17479 loader.  Itself a shared library, it must relocate itself in memory
17480 before it can find the variables and constants in its own data segment.
17482 @item -mbwx
17483 @itemx -mno-bwx
17484 @itemx -mcix
17485 @itemx -mno-cix
17486 @itemx -mfix
17487 @itemx -mno-fix
17488 @itemx -mmax
17489 @itemx -mno-max
17490 @opindex mbwx
17491 @opindex mno-bwx
17492 @opindex mcix
17493 @opindex mno-cix
17494 @opindex mfix
17495 @opindex mno-fix
17496 @opindex mmax
17497 @opindex mno-max
17498 Indicate whether GCC should generate code to use the optional BWX,
17499 CIX, FIX and MAX instruction sets.  The default is to use the instruction
17500 sets supported by the CPU type specified via @option{-mcpu=} option or that
17501 of the CPU on which GCC was built if none is specified.
17503 @item -mfloat-vax
17504 @itemx -mfloat-ieee
17505 @opindex mfloat-vax
17506 @opindex mfloat-ieee
17507 Generate code that uses (does not use) VAX F and G floating-point
17508 arithmetic instead of IEEE single and double precision.
17510 @item -mexplicit-relocs
17511 @itemx -mno-explicit-relocs
17512 @opindex mexplicit-relocs
17513 @opindex mno-explicit-relocs
17514 Older Alpha assemblers provided no way to generate symbol relocations
17515 except via assembler macros.  Use of these macros does not allow
17516 optimal instruction scheduling.  GNU binutils as of version 2.12
17517 supports a new syntax that allows the compiler to explicitly mark
17518 which relocations should apply to which instructions.  This option
17519 is mostly useful for debugging, as GCC detects the capabilities of
17520 the assembler when it is built and sets the default accordingly.
17522 @item -msmall-data
17523 @itemx -mlarge-data
17524 @opindex msmall-data
17525 @opindex mlarge-data
17526 When @option{-mexplicit-relocs} is in effect, static data is
17527 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
17528 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
17529 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
17530 16-bit relocations off of the @code{$gp} register.  This limits the
17531 size of the small data area to 64KB, but allows the variables to be
17532 directly accessed via a single instruction.
17534 The default is @option{-mlarge-data}.  With this option the data area
17535 is limited to just below 2GB@.  Programs that require more than 2GB of
17536 data must use @code{malloc} or @code{mmap} to allocate the data in the
17537 heap instead of in the program's data segment.
17539 When generating code for shared libraries, @option{-fpic} implies
17540 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
17542 @item -msmall-text
17543 @itemx -mlarge-text
17544 @opindex msmall-text
17545 @opindex mlarge-text
17546 When @option{-msmall-text} is used, the compiler assumes that the
17547 code of the entire program (or shared library) fits in 4MB, and is
17548 thus reachable with a branch instruction.  When @option{-msmall-data}
17549 is used, the compiler can assume that all local symbols share the
17550 same @code{$gp} value, and thus reduce the number of instructions
17551 required for a function call from 4 to 1.
17553 The default is @option{-mlarge-text}.
17555 @item -mcpu=@var{cpu_type}
17556 @opindex mcpu
17557 Set the instruction set and instruction scheduling parameters for
17558 machine type @var{cpu_type}.  You can specify either the @samp{EV}
17559 style name or the corresponding chip number.  GCC supports scheduling
17560 parameters for the EV4, EV5 and EV6 family of processors and
17561 chooses the default values for the instruction set from the processor
17562 you specify.  If you do not specify a processor type, GCC defaults
17563 to the processor on which the compiler was built.
17565 Supported values for @var{cpu_type} are
17567 @table @samp
17568 @item ev4
17569 @itemx ev45
17570 @itemx 21064
17571 Schedules as an EV4 and has no instruction set extensions.
17573 @item ev5
17574 @itemx 21164
17575 Schedules as an EV5 and has no instruction set extensions.
17577 @item ev56
17578 @itemx 21164a
17579 Schedules as an EV5 and supports the BWX extension.
17581 @item pca56
17582 @itemx 21164pc
17583 @itemx 21164PC
17584 Schedules as an EV5 and supports the BWX and MAX extensions.
17586 @item ev6
17587 @itemx 21264
17588 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
17590 @item ev67
17591 @itemx 21264a
17592 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
17593 @end table
17595 Native toolchains also support the value @samp{native},
17596 which selects the best architecture option for the host processor.
17597 @option{-mcpu=native} has no effect if GCC does not recognize
17598 the processor.
17600 @item -mtune=@var{cpu_type}
17601 @opindex mtune
17602 Set only the instruction scheduling parameters for machine type
17603 @var{cpu_type}.  The instruction set is not changed.
17605 Native toolchains also support the value @samp{native},
17606 which selects the best architecture option for the host processor.
17607 @option{-mtune=native} has no effect if GCC does not recognize
17608 the processor.
17610 @item -mmemory-latency=@var{time}
17611 @opindex mmemory-latency
17612 Sets the latency the scheduler should assume for typical memory
17613 references as seen by the application.  This number is highly
17614 dependent on the memory access patterns used by the application
17615 and the size of the external cache on the machine.
17617 Valid options for @var{time} are
17619 @table @samp
17620 @item @var{number}
17621 A decimal number representing clock cycles.
17623 @item L1
17624 @itemx L2
17625 @itemx L3
17626 @itemx main
17627 The compiler contains estimates of the number of clock cycles for
17628 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
17629 (also called Dcache, Scache, and Bcache), as well as to main memory.
17630 Note that L3 is only valid for EV5.
17632 @end table
17633 @end table
17635 @node FR30 Options
17636 @subsection FR30 Options
17637 @cindex FR30 Options
17639 These options are defined specifically for the FR30 port.
17641 @table @gcctabopt
17643 @item -msmall-model
17644 @opindex msmall-model
17645 Use the small address space model.  This can produce smaller code, but
17646 it does assume that all symbolic values and addresses fit into a
17647 20-bit range.
17649 @item -mno-lsim
17650 @opindex mno-lsim
17651 Assume that runtime support has been provided and so there is no need
17652 to include the simulator library (@file{libsim.a}) on the linker
17653 command line.
17655 @end table
17657 @node FT32 Options
17658 @subsection FT32 Options
17659 @cindex FT32 Options
17661 These options are defined specifically for the FT32 port.
17663 @table @gcctabopt
17665 @item -msim
17666 @opindex msim
17667 Specifies that the program will be run on the simulator.  This causes
17668 an alternate runtime startup and library to be linked.
17669 You must not use this option when generating programs that will run on
17670 real hardware; you must provide your own runtime library for whatever
17671 I/O functions are needed.
17673 @item -mlra
17674 @opindex mlra
17675 Enable Local Register Allocation.  This is still experimental for FT32,
17676 so by default the compiler uses standard reload.
17678 @item -mnodiv
17679 @opindex mnodiv
17680 Do not use div and mod instructions.
17682 @end table
17684 @node FRV Options
17685 @subsection FRV Options
17686 @cindex FRV Options
17688 @table @gcctabopt
17689 @item -mgpr-32
17690 @opindex mgpr-32
17692 Only use the first 32 general-purpose registers.
17694 @item -mgpr-64
17695 @opindex mgpr-64
17697 Use all 64 general-purpose registers.
17699 @item -mfpr-32
17700 @opindex mfpr-32
17702 Use only the first 32 floating-point registers.
17704 @item -mfpr-64
17705 @opindex mfpr-64
17707 Use all 64 floating-point registers.
17709 @item -mhard-float
17710 @opindex mhard-float
17712 Use hardware instructions for floating-point operations.
17714 @item -msoft-float
17715 @opindex msoft-float
17717 Use library routines for floating-point operations.
17719 @item -malloc-cc
17720 @opindex malloc-cc
17722 Dynamically allocate condition code registers.
17724 @item -mfixed-cc
17725 @opindex mfixed-cc
17727 Do not try to dynamically allocate condition code registers, only
17728 use @code{icc0} and @code{fcc0}.
17730 @item -mdword
17731 @opindex mdword
17733 Change ABI to use double word insns.
17735 @item -mno-dword
17736 @opindex mno-dword
17738 Do not use double word instructions.
17740 @item -mdouble
17741 @opindex mdouble
17743 Use floating-point double instructions.
17745 @item -mno-double
17746 @opindex mno-double
17748 Do not use floating-point double instructions.
17750 @item -mmedia
17751 @opindex mmedia
17753 Use media instructions.
17755 @item -mno-media
17756 @opindex mno-media
17758 Do not use media instructions.
17760 @item -mmuladd
17761 @opindex mmuladd
17763 Use multiply and add/subtract instructions.
17765 @item -mno-muladd
17766 @opindex mno-muladd
17768 Do not use multiply and add/subtract instructions.
17770 @item -mfdpic
17771 @opindex mfdpic
17773 Select the FDPIC ABI, which uses function descriptors to represent
17774 pointers to functions.  Without any PIC/PIE-related options, it
17775 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
17776 assumes GOT entries and small data are within a 12-bit range from the
17777 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
17778 are computed with 32 bits.
17779 With a @samp{bfin-elf} target, this option implies @option{-msim}.
17781 @item -minline-plt
17782 @opindex minline-plt
17784 Enable inlining of PLT entries in function calls to functions that are
17785 not known to bind locally.  It has no effect without @option{-mfdpic}.
17786 It's enabled by default if optimizing for speed and compiling for
17787 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
17788 optimization option such as @option{-O3} or above is present in the
17789 command line.
17791 @item -mTLS
17792 @opindex mTLS
17794 Assume a large TLS segment when generating thread-local code.
17796 @item -mtls
17797 @opindex mtls
17799 Do not assume a large TLS segment when generating thread-local code.
17801 @item -mgprel-ro
17802 @opindex mgprel-ro
17804 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
17805 that is known to be in read-only sections.  It's enabled by default,
17806 except for @option{-fpic} or @option{-fpie}: even though it may help
17807 make the global offset table smaller, it trades 1 instruction for 4.
17808 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
17809 one of which may be shared by multiple symbols, and it avoids the need
17810 for a GOT entry for the referenced symbol, so it's more likely to be a
17811 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
17813 @item -multilib-library-pic
17814 @opindex multilib-library-pic
17816 Link with the (library, not FD) pic libraries.  It's implied by
17817 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
17818 @option{-fpic} without @option{-mfdpic}.  You should never have to use
17819 it explicitly.
17821 @item -mlinked-fp
17822 @opindex mlinked-fp
17824 Follow the EABI requirement of always creating a frame pointer whenever
17825 a stack frame is allocated.  This option is enabled by default and can
17826 be disabled with @option{-mno-linked-fp}.
17828 @item -mlong-calls
17829 @opindex mlong-calls
17831 Use indirect addressing to call functions outside the current
17832 compilation unit.  This allows the functions to be placed anywhere
17833 within the 32-bit address space.
17835 @item -malign-labels
17836 @opindex malign-labels
17838 Try to align labels to an 8-byte boundary by inserting NOPs into the
17839 previous packet.  This option only has an effect when VLIW packing
17840 is enabled.  It doesn't create new packets; it merely adds NOPs to
17841 existing ones.
17843 @item -mlibrary-pic
17844 @opindex mlibrary-pic
17846 Generate position-independent EABI code.
17848 @item -macc-4
17849 @opindex macc-4
17851 Use only the first four media accumulator registers.
17853 @item -macc-8
17854 @opindex macc-8
17856 Use all eight media accumulator registers.
17858 @item -mpack
17859 @opindex mpack
17861 Pack VLIW instructions.
17863 @item -mno-pack
17864 @opindex mno-pack
17866 Do not pack VLIW instructions.
17868 @item -mno-eflags
17869 @opindex mno-eflags
17871 Do not mark ABI switches in e_flags.
17873 @item -mcond-move
17874 @opindex mcond-move
17876 Enable the use of conditional-move instructions (default).
17878 This switch is mainly for debugging the compiler and will likely be removed
17879 in a future version.
17881 @item -mno-cond-move
17882 @opindex mno-cond-move
17884 Disable the use of conditional-move instructions.
17886 This switch is mainly for debugging the compiler and will likely be removed
17887 in a future version.
17889 @item -mscc
17890 @opindex mscc
17892 Enable the use of conditional set instructions (default).
17894 This switch is mainly for debugging the compiler and will likely be removed
17895 in a future version.
17897 @item -mno-scc
17898 @opindex mno-scc
17900 Disable the use of conditional set instructions.
17902 This switch is mainly for debugging the compiler and will likely be removed
17903 in a future version.
17905 @item -mcond-exec
17906 @opindex mcond-exec
17908 Enable the use of conditional execution (default).
17910 This switch is mainly for debugging the compiler and will likely be removed
17911 in a future version.
17913 @item -mno-cond-exec
17914 @opindex mno-cond-exec
17916 Disable the use of conditional execution.
17918 This switch is mainly for debugging the compiler and will likely be removed
17919 in a future version.
17921 @item -mvliw-branch
17922 @opindex mvliw-branch
17924 Run a pass to pack branches into VLIW instructions (default).
17926 This switch is mainly for debugging the compiler and will likely be removed
17927 in a future version.
17929 @item -mno-vliw-branch
17930 @opindex mno-vliw-branch
17932 Do not run a pass to pack branches into VLIW instructions.
17934 This switch is mainly for debugging the compiler and will likely be removed
17935 in a future version.
17937 @item -mmulti-cond-exec
17938 @opindex mmulti-cond-exec
17940 Enable optimization of @code{&&} and @code{||} in conditional execution
17941 (default).
17943 This switch is mainly for debugging the compiler and will likely be removed
17944 in a future version.
17946 @item -mno-multi-cond-exec
17947 @opindex mno-multi-cond-exec
17949 Disable optimization of @code{&&} and @code{||} in conditional execution.
17951 This switch is mainly for debugging the compiler and will likely be removed
17952 in a future version.
17954 @item -mnested-cond-exec
17955 @opindex mnested-cond-exec
17957 Enable nested conditional execution optimizations (default).
17959 This switch is mainly for debugging the compiler and will likely be removed
17960 in a future version.
17962 @item -mno-nested-cond-exec
17963 @opindex mno-nested-cond-exec
17965 Disable nested conditional execution optimizations.
17967 This switch is mainly for debugging the compiler and will likely be removed
17968 in a future version.
17970 @item -moptimize-membar
17971 @opindex moptimize-membar
17973 This switch removes redundant @code{membar} instructions from the
17974 compiler-generated code.  It is enabled by default.
17976 @item -mno-optimize-membar
17977 @opindex mno-optimize-membar
17979 This switch disables the automatic removal of redundant @code{membar}
17980 instructions from the generated code.
17982 @item -mtomcat-stats
17983 @opindex mtomcat-stats
17985 Cause gas to print out tomcat statistics.
17987 @item -mcpu=@var{cpu}
17988 @opindex mcpu
17990 Select the processor type for which to generate code.  Possible values are
17991 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
17992 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
17994 @end table
17996 @node GNU/Linux Options
17997 @subsection GNU/Linux Options
17999 These @samp{-m} options are defined for GNU/Linux targets:
18001 @table @gcctabopt
18002 @item -mglibc
18003 @opindex mglibc
18004 Use the GNU C library.  This is the default except
18005 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
18006 @samp{*-*-linux-*android*} targets.
18008 @item -muclibc
18009 @opindex muclibc
18010 Use uClibc C library.  This is the default on
18011 @samp{*-*-linux-*uclibc*} targets.
18013 @item -mmusl
18014 @opindex mmusl
18015 Use the musl C library.  This is the default on
18016 @samp{*-*-linux-*musl*} targets.
18018 @item -mbionic
18019 @opindex mbionic
18020 Use Bionic C library.  This is the default on
18021 @samp{*-*-linux-*android*} targets.
18023 @item -mandroid
18024 @opindex mandroid
18025 Compile code compatible with Android platform.  This is the default on
18026 @samp{*-*-linux-*android*} targets.
18028 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
18029 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
18030 this option makes the GCC driver pass Android-specific options to the linker.
18031 Finally, this option causes the preprocessor macro @code{__ANDROID__}
18032 to be defined.
18034 @item -tno-android-cc
18035 @opindex tno-android-cc
18036 Disable compilation effects of @option{-mandroid}, i.e., do not enable
18037 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
18038 @option{-fno-rtti} by default.
18040 @item -tno-android-ld
18041 @opindex tno-android-ld
18042 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
18043 linking options to the linker.
18045 @end table
18047 @node H8/300 Options
18048 @subsection H8/300 Options
18050 These @samp{-m} options are defined for the H8/300 implementations:
18052 @table @gcctabopt
18053 @item -mrelax
18054 @opindex mrelax
18055 Shorten some address references at link time, when possible; uses the
18056 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
18057 ld, Using ld}, for a fuller description.
18059 @item -mh
18060 @opindex mh
18061 Generate code for the H8/300H@.
18063 @item -ms
18064 @opindex ms
18065 Generate code for the H8S@.
18067 @item -mn
18068 @opindex mn
18069 Generate code for the H8S and H8/300H in the normal mode.  This switch
18070 must be used either with @option{-mh} or @option{-ms}.
18072 @item -ms2600
18073 @opindex ms2600
18074 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
18076 @item -mexr
18077 @opindex mexr
18078 Extended registers are stored on stack before execution of function
18079 with monitor attribute. Default option is @option{-mexr}.
18080 This option is valid only for H8S targets.
18082 @item -mno-exr
18083 @opindex mno-exr
18084 Extended registers are not stored on stack before execution of function 
18085 with monitor attribute. Default option is @option{-mno-exr}. 
18086 This option is valid only for H8S targets.
18088 @item -mint32
18089 @opindex mint32
18090 Make @code{int} data 32 bits by default.
18092 @item -malign-300
18093 @opindex malign-300
18094 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
18095 The default for the H8/300H and H8S is to align longs and floats on
18096 4-byte boundaries.
18097 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
18098 This option has no effect on the H8/300.
18099 @end table
18101 @node HPPA Options
18102 @subsection HPPA Options
18103 @cindex HPPA Options
18105 These @samp{-m} options are defined for the HPPA family of computers:
18107 @table @gcctabopt
18108 @item -march=@var{architecture-type}
18109 @opindex march
18110 Generate code for the specified architecture.  The choices for
18111 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
18112 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
18113 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
18114 architecture option for your machine.  Code compiled for lower numbered
18115 architectures runs on higher numbered architectures, but not the
18116 other way around.
18118 @item -mpa-risc-1-0
18119 @itemx -mpa-risc-1-1
18120 @itemx -mpa-risc-2-0
18121 @opindex mpa-risc-1-0
18122 @opindex mpa-risc-1-1
18123 @opindex mpa-risc-2-0
18124 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
18126 @item -mcaller-copies
18127 @opindex mcaller-copies
18128 The caller copies function arguments passed by hidden reference.  This
18129 option should be used with care as it is not compatible with the default
18130 32-bit runtime.  However, only aggregates larger than eight bytes are
18131 passed by hidden reference and the option provides better compatibility
18132 with OpenMP.
18134 @item -mjump-in-delay
18135 @opindex mjump-in-delay
18136 This option is ignored and provided for compatibility purposes only.
18138 @item -mdisable-fpregs
18139 @opindex mdisable-fpregs
18140 Prevent floating-point registers from being used in any manner.  This is
18141 necessary for compiling kernels that perform lazy context switching of
18142 floating-point registers.  If you use this option and attempt to perform
18143 floating-point operations, the compiler aborts.
18145 @item -mdisable-indexing
18146 @opindex mdisable-indexing
18147 Prevent the compiler from using indexing address modes.  This avoids some
18148 rather obscure problems when compiling MIG generated code under MACH@.
18150 @item -mno-space-regs
18151 @opindex mno-space-regs
18152 Generate code that assumes the target has no space registers.  This allows
18153 GCC to generate faster indirect calls and use unscaled index address modes.
18155 Such code is suitable for level 0 PA systems and kernels.
18157 @item -mfast-indirect-calls
18158 @opindex mfast-indirect-calls
18159 Generate code that assumes calls never cross space boundaries.  This
18160 allows GCC to emit code that performs faster indirect calls.
18162 This option does not work in the presence of shared libraries or nested
18163 functions.
18165 @item -mfixed-range=@var{register-range}
18166 @opindex mfixed-range
18167 Generate code treating the given register range as fixed registers.
18168 A fixed register is one that the register allocator cannot use.  This is
18169 useful when compiling kernel code.  A register range is specified as
18170 two registers separated by a dash.  Multiple register ranges can be
18171 specified separated by a comma.
18173 @item -mlong-load-store
18174 @opindex mlong-load-store
18175 Generate 3-instruction load and store sequences as sometimes required by
18176 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
18177 the HP compilers.
18179 @item -mportable-runtime
18180 @opindex mportable-runtime
18181 Use the portable calling conventions proposed by HP for ELF systems.
18183 @item -mgas
18184 @opindex mgas
18185 Enable the use of assembler directives only GAS understands.
18187 @item -mschedule=@var{cpu-type}
18188 @opindex mschedule
18189 Schedule code according to the constraints for the machine type
18190 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
18191 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
18192 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
18193 proper scheduling option for your machine.  The default scheduling is
18194 @samp{8000}.
18196 @item -mlinker-opt
18197 @opindex mlinker-opt
18198 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
18199 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
18200 linkers in which they give bogus error messages when linking some programs.
18202 @item -msoft-float
18203 @opindex msoft-float
18204 Generate output containing library calls for floating point.
18205 @strong{Warning:} the requisite libraries are not available for all HPPA
18206 targets.  Normally the facilities of the machine's usual C compiler are
18207 used, but this cannot be done directly in cross-compilation.  You must make
18208 your own arrangements to provide suitable library functions for
18209 cross-compilation.
18211 @option{-msoft-float} changes the calling convention in the output file;
18212 therefore, it is only useful if you compile @emph{all} of a program with
18213 this option.  In particular, you need to compile @file{libgcc.a}, the
18214 library that comes with GCC, with @option{-msoft-float} in order for
18215 this to work.
18217 @item -msio
18218 @opindex msio
18219 Generate the predefine, @code{_SIO}, for server IO@.  The default is
18220 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
18221 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
18222 options are available under HP-UX and HI-UX@.
18224 @item -mgnu-ld
18225 @opindex mgnu-ld
18226 Use options specific to GNU @command{ld}.
18227 This passes @option{-shared} to @command{ld} when
18228 building a shared library.  It is the default when GCC is configured,
18229 explicitly or implicitly, with the GNU linker.  This option does not
18230 affect which @command{ld} is called; it only changes what parameters
18231 are passed to that @command{ld}.
18232 The @command{ld} that is called is determined by the
18233 @option{--with-ld} configure option, GCC's program search path, and
18234 finally by the user's @env{PATH}.  The linker used by GCC can be printed
18235 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
18236 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18238 @item -mhp-ld
18239 @opindex mhp-ld
18240 Use options specific to HP @command{ld}.
18241 This passes @option{-b} to @command{ld} when building
18242 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
18243 links.  It is the default when GCC is configured, explicitly or
18244 implicitly, with the HP linker.  This option does not affect
18245 which @command{ld} is called; it only changes what parameters are passed to that
18246 @command{ld}.
18247 The @command{ld} that is called is determined by the @option{--with-ld}
18248 configure option, GCC's program search path, and finally by the user's
18249 @env{PATH}.  The linker used by GCC can be printed using @samp{which
18250 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
18251 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
18253 @item -mlong-calls
18254 @opindex mno-long-calls
18255 Generate code that uses long call sequences.  This ensures that a call
18256 is always able to reach linker generated stubs.  The default is to generate
18257 long calls only when the distance from the call site to the beginning
18258 of the function or translation unit, as the case may be, exceeds a
18259 predefined limit set by the branch type being used.  The limits for
18260 normal calls are 7,600,000 and 240,000 bytes, respectively for the
18261 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
18262 240,000 bytes.
18264 Distances are measured from the beginning of functions when using the
18265 @option{-ffunction-sections} option, or when using the @option{-mgas}
18266 and @option{-mno-portable-runtime} options together under HP-UX with
18267 the SOM linker.
18269 It is normally not desirable to use this option as it degrades
18270 performance.  However, it may be useful in large applications,
18271 particularly when partial linking is used to build the application.
18273 The types of long calls used depends on the capabilities of the
18274 assembler and linker, and the type of code being generated.  The
18275 impact on systems that support long absolute calls, and long pic
18276 symbol-difference or pc-relative calls should be relatively small.
18277 However, an indirect call is used on 32-bit ELF systems in pic code
18278 and it is quite long.
18280 @item -munix=@var{unix-std}
18281 @opindex march
18282 Generate compiler predefines and select a startfile for the specified
18283 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
18284 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
18285 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
18286 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
18287 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
18288 and later.
18290 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
18291 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
18292 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
18293 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
18294 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
18295 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
18297 It is @emph{important} to note that this option changes the interfaces
18298 for various library routines.  It also affects the operational behavior
18299 of the C library.  Thus, @emph{extreme} care is needed in using this
18300 option.
18302 Library code that is intended to operate with more than one UNIX
18303 standard must test, set and restore the variable @code{__xpg4_extended_mask}
18304 as appropriate.  Most GNU software doesn't provide this capability.
18306 @item -nolibdld
18307 @opindex nolibdld
18308 Suppress the generation of link options to search libdld.sl when the
18309 @option{-static} option is specified on HP-UX 10 and later.
18311 @item -static
18312 @opindex static
18313 The HP-UX implementation of setlocale in libc has a dependency on
18314 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
18315 when the @option{-static} option is specified, special link options
18316 are needed to resolve this dependency.
18318 On HP-UX 10 and later, the GCC driver adds the necessary options to
18319 link with libdld.sl when the @option{-static} option is specified.
18320 This causes the resulting binary to be dynamic.  On the 64-bit port,
18321 the linkers generate dynamic binaries by default in any case.  The
18322 @option{-nolibdld} option can be used to prevent the GCC driver from
18323 adding these link options.
18325 @item -threads
18326 @opindex threads
18327 Add support for multithreading with the @dfn{dce thread} library
18328 under HP-UX@.  This option sets flags for both the preprocessor and
18329 linker.
18330 @end table
18332 @node IA-64 Options
18333 @subsection IA-64 Options
18334 @cindex IA-64 Options
18336 These are the @samp{-m} options defined for the Intel IA-64 architecture.
18338 @table @gcctabopt
18339 @item -mbig-endian
18340 @opindex mbig-endian
18341 Generate code for a big-endian target.  This is the default for HP-UX@.
18343 @item -mlittle-endian
18344 @opindex mlittle-endian
18345 Generate code for a little-endian target.  This is the default for AIX5
18346 and GNU/Linux.
18348 @item -mgnu-as
18349 @itemx -mno-gnu-as
18350 @opindex mgnu-as
18351 @opindex mno-gnu-as
18352 Generate (or don't) code for the GNU assembler.  This is the default.
18353 @c Also, this is the default if the configure option @option{--with-gnu-as}
18354 @c is used.
18356 @item -mgnu-ld
18357 @itemx -mno-gnu-ld
18358 @opindex mgnu-ld
18359 @opindex mno-gnu-ld
18360 Generate (or don't) code for the GNU linker.  This is the default.
18361 @c Also, this is the default if the configure option @option{--with-gnu-ld}
18362 @c is used.
18364 @item -mno-pic
18365 @opindex mno-pic
18366 Generate code that does not use a global pointer register.  The result
18367 is not position independent code, and violates the IA-64 ABI@.
18369 @item -mvolatile-asm-stop
18370 @itemx -mno-volatile-asm-stop
18371 @opindex mvolatile-asm-stop
18372 @opindex mno-volatile-asm-stop
18373 Generate (or don't) a stop bit immediately before and after volatile asm
18374 statements.
18376 @item -mregister-names
18377 @itemx -mno-register-names
18378 @opindex mregister-names
18379 @opindex mno-register-names
18380 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
18381 the stacked registers.  This may make assembler output more readable.
18383 @item -mno-sdata
18384 @itemx -msdata
18385 @opindex mno-sdata
18386 @opindex msdata
18387 Disable (or enable) optimizations that use the small data section.  This may
18388 be useful for working around optimizer bugs.
18390 @item -mconstant-gp
18391 @opindex mconstant-gp
18392 Generate code that uses a single constant global pointer value.  This is
18393 useful when compiling kernel code.
18395 @item -mauto-pic
18396 @opindex mauto-pic
18397 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
18398 This is useful when compiling firmware code.
18400 @item -minline-float-divide-min-latency
18401 @opindex minline-float-divide-min-latency
18402 Generate code for inline divides of floating-point values
18403 using the minimum latency algorithm.
18405 @item -minline-float-divide-max-throughput
18406 @opindex minline-float-divide-max-throughput
18407 Generate code for inline divides of floating-point values
18408 using the maximum throughput algorithm.
18410 @item -mno-inline-float-divide
18411 @opindex mno-inline-float-divide
18412 Do not generate inline code for divides of floating-point values.
18414 @item -minline-int-divide-min-latency
18415 @opindex minline-int-divide-min-latency
18416 Generate code for inline divides of integer values
18417 using the minimum latency algorithm.
18419 @item -minline-int-divide-max-throughput
18420 @opindex minline-int-divide-max-throughput
18421 Generate code for inline divides of integer values
18422 using the maximum throughput algorithm.
18424 @item -mno-inline-int-divide
18425 @opindex mno-inline-int-divide
18426 Do not generate inline code for divides of integer values.
18428 @item -minline-sqrt-min-latency
18429 @opindex minline-sqrt-min-latency
18430 Generate code for inline square roots
18431 using the minimum latency algorithm.
18433 @item -minline-sqrt-max-throughput
18434 @opindex minline-sqrt-max-throughput
18435 Generate code for inline square roots
18436 using the maximum throughput algorithm.
18438 @item -mno-inline-sqrt
18439 @opindex mno-inline-sqrt
18440 Do not generate inline code for @code{sqrt}.
18442 @item -mfused-madd
18443 @itemx -mno-fused-madd
18444 @opindex mfused-madd
18445 @opindex mno-fused-madd
18446 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
18447 instructions.  The default is to use these instructions.
18449 @item -mno-dwarf2-asm
18450 @itemx -mdwarf2-asm
18451 @opindex mno-dwarf2-asm
18452 @opindex mdwarf2-asm
18453 Don't (or do) generate assembler code for the DWARF line number debugging
18454 info.  This may be useful when not using the GNU assembler.
18456 @item -mearly-stop-bits
18457 @itemx -mno-early-stop-bits
18458 @opindex mearly-stop-bits
18459 @opindex mno-early-stop-bits
18460 Allow stop bits to be placed earlier than immediately preceding the
18461 instruction that triggered the stop bit.  This can improve instruction
18462 scheduling, but does not always do so.
18464 @item -mfixed-range=@var{register-range}
18465 @opindex mfixed-range
18466 Generate code treating the given register range as fixed registers.
18467 A fixed register is one that the register allocator cannot use.  This is
18468 useful when compiling kernel code.  A register range is specified as
18469 two registers separated by a dash.  Multiple register ranges can be
18470 specified separated by a comma.
18472 @item -mtls-size=@var{tls-size}
18473 @opindex mtls-size
18474 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
18477 @item -mtune=@var{cpu-type}
18478 @opindex mtune
18479 Tune the instruction scheduling for a particular CPU, Valid values are
18480 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
18481 and @samp{mckinley}.
18483 @item -milp32
18484 @itemx -mlp64
18485 @opindex milp32
18486 @opindex mlp64
18487 Generate code for a 32-bit or 64-bit environment.
18488 The 32-bit environment sets int, long and pointer to 32 bits.
18489 The 64-bit environment sets int to 32 bits and long and pointer
18490 to 64 bits.  These are HP-UX specific flags.
18492 @item -mno-sched-br-data-spec
18493 @itemx -msched-br-data-spec
18494 @opindex mno-sched-br-data-spec
18495 @opindex msched-br-data-spec
18496 (Dis/En)able data speculative scheduling before reload.
18497 This results in generation of @code{ld.a} instructions and
18498 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18499 The default setting is disabled.
18501 @item -msched-ar-data-spec
18502 @itemx -mno-sched-ar-data-spec
18503 @opindex msched-ar-data-spec
18504 @opindex mno-sched-ar-data-spec
18505 (En/Dis)able data speculative scheduling after reload.
18506 This results in generation of @code{ld.a} instructions and
18507 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
18508 The default setting is enabled.
18510 @item -mno-sched-control-spec
18511 @itemx -msched-control-spec
18512 @opindex mno-sched-control-spec
18513 @opindex msched-control-spec
18514 (Dis/En)able control speculative scheduling.  This feature is
18515 available only during region scheduling (i.e.@: before reload).
18516 This results in generation of the @code{ld.s} instructions and
18517 the corresponding check instructions @code{chk.s}.
18518 The default setting is disabled.
18520 @item -msched-br-in-data-spec
18521 @itemx -mno-sched-br-in-data-spec
18522 @opindex msched-br-in-data-spec
18523 @opindex mno-sched-br-in-data-spec
18524 (En/Dis)able speculative scheduling of the instructions that
18525 are dependent on the data speculative loads before reload.
18526 This is effective only with @option{-msched-br-data-spec} enabled.
18527 The default setting is enabled.
18529 @item -msched-ar-in-data-spec
18530 @itemx -mno-sched-ar-in-data-spec
18531 @opindex msched-ar-in-data-spec
18532 @opindex mno-sched-ar-in-data-spec
18533 (En/Dis)able speculative scheduling of the instructions that
18534 are dependent on the data speculative loads after reload.
18535 This is effective only with @option{-msched-ar-data-spec} enabled.
18536 The default setting is enabled.
18538 @item -msched-in-control-spec
18539 @itemx -mno-sched-in-control-spec
18540 @opindex msched-in-control-spec
18541 @opindex mno-sched-in-control-spec
18542 (En/Dis)able speculative scheduling of the instructions that
18543 are dependent on the control speculative loads.
18544 This is effective only with @option{-msched-control-spec} enabled.
18545 The default setting is enabled.
18547 @item -mno-sched-prefer-non-data-spec-insns
18548 @itemx -msched-prefer-non-data-spec-insns
18549 @opindex mno-sched-prefer-non-data-spec-insns
18550 @opindex msched-prefer-non-data-spec-insns
18551 If enabled, data-speculative instructions are chosen for schedule
18552 only if there are no other choices at the moment.  This makes
18553 the use of the data speculation much more conservative.
18554 The default setting is disabled.
18556 @item -mno-sched-prefer-non-control-spec-insns
18557 @itemx -msched-prefer-non-control-spec-insns
18558 @opindex mno-sched-prefer-non-control-spec-insns
18559 @opindex msched-prefer-non-control-spec-insns
18560 If enabled, control-speculative instructions are chosen for schedule
18561 only if there are no other choices at the moment.  This makes
18562 the use of the control speculation much more conservative.
18563 The default setting is disabled.
18565 @item -mno-sched-count-spec-in-critical-path
18566 @itemx -msched-count-spec-in-critical-path
18567 @opindex mno-sched-count-spec-in-critical-path
18568 @opindex msched-count-spec-in-critical-path
18569 If enabled, speculative dependencies are considered during
18570 computation of the instructions priorities.  This makes the use of the
18571 speculation a bit more conservative.
18572 The default setting is disabled.
18574 @item -msched-spec-ldc
18575 @opindex msched-spec-ldc
18576 Use a simple data speculation check.  This option is on by default.
18578 @item -msched-control-spec-ldc
18579 @opindex msched-spec-ldc
18580 Use a simple check for control speculation.  This option is on by default.
18582 @item -msched-stop-bits-after-every-cycle
18583 @opindex msched-stop-bits-after-every-cycle
18584 Place a stop bit after every cycle when scheduling.  This option is on
18585 by default.
18587 @item -msched-fp-mem-deps-zero-cost
18588 @opindex msched-fp-mem-deps-zero-cost
18589 Assume that floating-point stores and loads are not likely to cause a conflict
18590 when placed into the same instruction group.  This option is disabled by
18591 default.
18593 @item -msel-sched-dont-check-control-spec
18594 @opindex msel-sched-dont-check-control-spec
18595 Generate checks for control speculation in selective scheduling.
18596 This flag is disabled by default.
18598 @item -msched-max-memory-insns=@var{max-insns}
18599 @opindex msched-max-memory-insns
18600 Limit on the number of memory insns per instruction group, giving lower
18601 priority to subsequent memory insns attempting to schedule in the same
18602 instruction group. Frequently useful to prevent cache bank conflicts.
18603 The default value is 1.
18605 @item -msched-max-memory-insns-hard-limit
18606 @opindex msched-max-memory-insns-hard-limit
18607 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
18608 disallowing more than that number in an instruction group.
18609 Otherwise, the limit is ``soft'', meaning that non-memory operations
18610 are preferred when the limit is reached, but memory operations may still
18611 be scheduled.
18613 @end table
18615 @node LM32 Options
18616 @subsection LM32 Options
18617 @cindex LM32 options
18619 These @option{-m} options are defined for the LatticeMico32 architecture:
18621 @table @gcctabopt
18622 @item -mbarrel-shift-enabled
18623 @opindex mbarrel-shift-enabled
18624 Enable barrel-shift instructions.
18626 @item -mdivide-enabled
18627 @opindex mdivide-enabled
18628 Enable divide and modulus instructions.
18630 @item -mmultiply-enabled
18631 @opindex multiply-enabled
18632 Enable multiply instructions.
18634 @item -msign-extend-enabled
18635 @opindex msign-extend-enabled
18636 Enable sign extend instructions.
18638 @item -muser-enabled
18639 @opindex muser-enabled
18640 Enable user-defined instructions.
18642 @end table
18644 @node M32C Options
18645 @subsection M32C Options
18646 @cindex M32C options
18648 @table @gcctabopt
18649 @item -mcpu=@var{name}
18650 @opindex mcpu=
18651 Select the CPU for which code is generated.  @var{name} may be one of
18652 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
18653 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
18654 the M32C/80 series.
18656 @item -msim
18657 @opindex msim
18658 Specifies that the program will be run on the simulator.  This causes
18659 an alternate runtime library to be linked in which supports, for
18660 example, file I/O@.  You must not use this option when generating
18661 programs that will run on real hardware; you must provide your own
18662 runtime library for whatever I/O functions are needed.
18664 @item -memregs=@var{number}
18665 @opindex memregs=
18666 Specifies the number of memory-based pseudo-registers GCC uses
18667 during code generation.  These pseudo-registers are used like real
18668 registers, so there is a tradeoff between GCC's ability to fit the
18669 code into available registers, and the performance penalty of using
18670 memory instead of registers.  Note that all modules in a program must
18671 be compiled with the same value for this option.  Because of that, you
18672 must not use this option with GCC's default runtime libraries.
18674 @end table
18676 @node M32R/D Options
18677 @subsection M32R/D Options
18678 @cindex M32R/D options
18680 These @option{-m} options are defined for Renesas M32R/D architectures:
18682 @table @gcctabopt
18683 @item -m32r2
18684 @opindex m32r2
18685 Generate code for the M32R/2@.
18687 @item -m32rx
18688 @opindex m32rx
18689 Generate code for the M32R/X@.
18691 @item -m32r
18692 @opindex m32r
18693 Generate code for the M32R@.  This is the default.
18695 @item -mmodel=small
18696 @opindex mmodel=small
18697 Assume all objects live in the lower 16MB of memory (so that their addresses
18698 can be loaded with the @code{ld24} instruction), and assume all subroutines
18699 are reachable with the @code{bl} instruction.
18700 This is the default.
18702 The addressability of a particular object can be set with the
18703 @code{model} attribute.
18705 @item -mmodel=medium
18706 @opindex mmodel=medium
18707 Assume objects may be anywhere in the 32-bit address space (the compiler
18708 generates @code{seth/add3} instructions to load their addresses), and
18709 assume all subroutines are reachable with the @code{bl} instruction.
18711 @item -mmodel=large
18712 @opindex mmodel=large
18713 Assume objects may be anywhere in the 32-bit address space (the compiler
18714 generates @code{seth/add3} instructions to load their addresses), and
18715 assume subroutines may not be reachable with the @code{bl} instruction
18716 (the compiler generates the much slower @code{seth/add3/jl}
18717 instruction sequence).
18719 @item -msdata=none
18720 @opindex msdata=none
18721 Disable use of the small data area.  Variables are put into
18722 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
18723 @code{section} attribute has been specified).
18724 This is the default.
18726 The small data area consists of sections @code{.sdata} and @code{.sbss}.
18727 Objects may be explicitly put in the small data area with the
18728 @code{section} attribute using one of these sections.
18730 @item -msdata=sdata
18731 @opindex msdata=sdata
18732 Put small global and static data in the small data area, but do not
18733 generate special code to reference them.
18735 @item -msdata=use
18736 @opindex msdata=use
18737 Put small global and static data in the small data area, and generate
18738 special instructions to reference them.
18740 @item -G @var{num}
18741 @opindex G
18742 @cindex smaller data references
18743 Put global and static objects less than or equal to @var{num} bytes
18744 into the small data or BSS sections instead of the normal data or BSS
18745 sections.  The default value of @var{num} is 8.
18746 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
18747 for this option to have any effect.
18749 All modules should be compiled with the same @option{-G @var{num}} value.
18750 Compiling with different values of @var{num} may or may not work; if it
18751 doesn't the linker gives an error message---incorrect code is not
18752 generated.
18754 @item -mdebug
18755 @opindex mdebug
18756 Makes the M32R-specific code in the compiler display some statistics
18757 that might help in debugging programs.
18759 @item -malign-loops
18760 @opindex malign-loops
18761 Align all loops to a 32-byte boundary.
18763 @item -mno-align-loops
18764 @opindex mno-align-loops
18765 Do not enforce a 32-byte alignment for loops.  This is the default.
18767 @item -missue-rate=@var{number}
18768 @opindex missue-rate=@var{number}
18769 Issue @var{number} instructions per cycle.  @var{number} can only be 1
18770 or 2.
18772 @item -mbranch-cost=@var{number}
18773 @opindex mbranch-cost=@var{number}
18774 @var{number} can only be 1 or 2.  If it is 1 then branches are
18775 preferred over conditional code, if it is 2, then the opposite applies.
18777 @item -mflush-trap=@var{number}
18778 @opindex mflush-trap=@var{number}
18779 Specifies the trap number to use to flush the cache.  The default is
18780 12.  Valid numbers are between 0 and 15 inclusive.
18782 @item -mno-flush-trap
18783 @opindex mno-flush-trap
18784 Specifies that the cache cannot be flushed by using a trap.
18786 @item -mflush-func=@var{name}
18787 @opindex mflush-func=@var{name}
18788 Specifies the name of the operating system function to call to flush
18789 the cache.  The default is @samp{_flush_cache}, but a function call
18790 is only used if a trap is not available.
18792 @item -mno-flush-func
18793 @opindex mno-flush-func
18794 Indicates that there is no OS function for flushing the cache.
18796 @end table
18798 @node M680x0 Options
18799 @subsection M680x0 Options
18800 @cindex M680x0 options
18802 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
18803 The default settings depend on which architecture was selected when
18804 the compiler was configured; the defaults for the most common choices
18805 are given below.
18807 @table @gcctabopt
18808 @item -march=@var{arch}
18809 @opindex march
18810 Generate code for a specific M680x0 or ColdFire instruction set
18811 architecture.  Permissible values of @var{arch} for M680x0
18812 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
18813 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
18814 architectures are selected according to Freescale's ISA classification
18815 and the permissible values are: @samp{isaa}, @samp{isaaplus},
18816 @samp{isab} and @samp{isac}.
18818 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
18819 code for a ColdFire target.  The @var{arch} in this macro is one of the
18820 @option{-march} arguments given above.
18822 When used together, @option{-march} and @option{-mtune} select code
18823 that runs on a family of similar processors but that is optimized
18824 for a particular microarchitecture.
18826 @item -mcpu=@var{cpu}
18827 @opindex mcpu
18828 Generate code for a specific M680x0 or ColdFire processor.
18829 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
18830 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
18831 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
18832 below, which also classifies the CPUs into families:
18834 @multitable @columnfractions 0.20 0.80
18835 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
18836 @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}
18837 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
18838 @item @samp{5206e} @tab @samp{5206e}
18839 @item @samp{5208} @tab @samp{5207} @samp{5208}
18840 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
18841 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
18842 @item @samp{5216} @tab @samp{5214} @samp{5216}
18843 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
18844 @item @samp{5225} @tab @samp{5224} @samp{5225}
18845 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
18846 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
18847 @item @samp{5249} @tab @samp{5249}
18848 @item @samp{5250} @tab @samp{5250}
18849 @item @samp{5271} @tab @samp{5270} @samp{5271}
18850 @item @samp{5272} @tab @samp{5272}
18851 @item @samp{5275} @tab @samp{5274} @samp{5275}
18852 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
18853 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
18854 @item @samp{5307} @tab @samp{5307}
18855 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
18856 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
18857 @item @samp{5407} @tab @samp{5407}
18858 @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}
18859 @end multitable
18861 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
18862 @var{arch} is compatible with @var{cpu}.  Other combinations of
18863 @option{-mcpu} and @option{-march} are rejected.
18865 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
18866 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
18867 where the value of @var{family} is given by the table above.
18869 @item -mtune=@var{tune}
18870 @opindex mtune
18871 Tune the code for a particular microarchitecture within the
18872 constraints set by @option{-march} and @option{-mcpu}.
18873 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
18874 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
18875 and @samp{cpu32}.  The ColdFire microarchitectures
18876 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
18878 You can also use @option{-mtune=68020-40} for code that needs
18879 to run relatively well on 68020, 68030 and 68040 targets.
18880 @option{-mtune=68020-60} is similar but includes 68060 targets
18881 as well.  These two options select the same tuning decisions as
18882 @option{-m68020-40} and @option{-m68020-60} respectively.
18884 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
18885 when tuning for 680x0 architecture @var{arch}.  It also defines
18886 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
18887 option is used.  If GCC is tuning for a range of architectures,
18888 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
18889 it defines the macros for every architecture in the range.
18891 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
18892 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
18893 of the arguments given above.
18895 @item -m68000
18896 @itemx -mc68000
18897 @opindex m68000
18898 @opindex mc68000
18899 Generate output for a 68000.  This is the default
18900 when the compiler is configured for 68000-based systems.
18901 It is equivalent to @option{-march=68000}.
18903 Use this option for microcontrollers with a 68000 or EC000 core,
18904 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
18906 @item -m68010
18907 @opindex m68010
18908 Generate output for a 68010.  This is the default
18909 when the compiler is configured for 68010-based systems.
18910 It is equivalent to @option{-march=68010}.
18912 @item -m68020
18913 @itemx -mc68020
18914 @opindex m68020
18915 @opindex mc68020
18916 Generate output for a 68020.  This is the default
18917 when the compiler is configured for 68020-based systems.
18918 It is equivalent to @option{-march=68020}.
18920 @item -m68030
18921 @opindex m68030
18922 Generate output for a 68030.  This is the default when the compiler is
18923 configured for 68030-based systems.  It is equivalent to
18924 @option{-march=68030}.
18926 @item -m68040
18927 @opindex m68040
18928 Generate output for a 68040.  This is the default when the compiler is
18929 configured for 68040-based systems.  It is equivalent to
18930 @option{-march=68040}.
18932 This option inhibits the use of 68881/68882 instructions that have to be
18933 emulated by software on the 68040.  Use this option if your 68040 does not
18934 have code to emulate those instructions.
18936 @item -m68060
18937 @opindex m68060
18938 Generate output for a 68060.  This is the default when the compiler is
18939 configured for 68060-based systems.  It is equivalent to
18940 @option{-march=68060}.
18942 This option inhibits the use of 68020 and 68881/68882 instructions that
18943 have to be emulated by software on the 68060.  Use this option if your 68060
18944 does not have code to emulate those instructions.
18946 @item -mcpu32
18947 @opindex mcpu32
18948 Generate output for a CPU32.  This is the default
18949 when the compiler is configured for CPU32-based systems.
18950 It is equivalent to @option{-march=cpu32}.
18952 Use this option for microcontrollers with a
18953 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
18954 68336, 68340, 68341, 68349 and 68360.
18956 @item -m5200
18957 @opindex m5200
18958 Generate output for a 520X ColdFire CPU@.  This is the default
18959 when the compiler is configured for 520X-based systems.
18960 It is equivalent to @option{-mcpu=5206}, and is now deprecated
18961 in favor of that option.
18963 Use this option for microcontroller with a 5200 core, including
18964 the MCF5202, MCF5203, MCF5204 and MCF5206.
18966 @item -m5206e
18967 @opindex m5206e
18968 Generate output for a 5206e ColdFire CPU@.  The option is now
18969 deprecated in favor of the equivalent @option{-mcpu=5206e}.
18971 @item -m528x
18972 @opindex m528x
18973 Generate output for a member of the ColdFire 528X family.
18974 The option is now deprecated in favor of the equivalent
18975 @option{-mcpu=528x}.
18977 @item -m5307
18978 @opindex m5307
18979 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
18980 in favor of the equivalent @option{-mcpu=5307}.
18982 @item -m5407
18983 @opindex m5407
18984 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
18985 in favor of the equivalent @option{-mcpu=5407}.
18987 @item -mcfv4e
18988 @opindex mcfv4e
18989 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
18990 This includes use of hardware floating-point instructions.
18991 The option is equivalent to @option{-mcpu=547x}, and is now
18992 deprecated in favor of that option.
18994 @item -m68020-40
18995 @opindex m68020-40
18996 Generate output for a 68040, without using any of the new instructions.
18997 This results in code that can run relatively efficiently on either a
18998 68020/68881 or a 68030 or a 68040.  The generated code does use the
18999 68881 instructions that are emulated on the 68040.
19001 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
19003 @item -m68020-60
19004 @opindex m68020-60
19005 Generate output for a 68060, without using any of the new instructions.
19006 This results in code that can run relatively efficiently on either a
19007 68020/68881 or a 68030 or a 68040.  The generated code does use the
19008 68881 instructions that are emulated on the 68060.
19010 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
19012 @item -mhard-float
19013 @itemx -m68881
19014 @opindex mhard-float
19015 @opindex m68881
19016 Generate floating-point instructions.  This is the default for 68020
19017 and above, and for ColdFire devices that have an FPU@.  It defines the
19018 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
19019 on ColdFire targets.
19021 @item -msoft-float
19022 @opindex msoft-float
19023 Do not generate floating-point instructions; use library calls instead.
19024 This is the default for 68000, 68010, and 68832 targets.  It is also
19025 the default for ColdFire devices that have no FPU.
19027 @item -mdiv
19028 @itemx -mno-div
19029 @opindex mdiv
19030 @opindex mno-div
19031 Generate (do not generate) ColdFire hardware divide and remainder
19032 instructions.  If @option{-march} is used without @option{-mcpu},
19033 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
19034 architectures.  Otherwise, the default is taken from the target CPU
19035 (either the default CPU, or the one specified by @option{-mcpu}).  For
19036 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
19037 @option{-mcpu=5206e}.
19039 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
19041 @item -mshort
19042 @opindex mshort
19043 Consider type @code{int} to be 16 bits wide, like @code{short int}.
19044 Additionally, parameters passed on the stack are also aligned to a
19045 16-bit boundary even on targets whose API mandates promotion to 32-bit.
19047 @item -mno-short
19048 @opindex mno-short
19049 Do not consider type @code{int} to be 16 bits wide.  This is the default.
19051 @item -mnobitfield
19052 @itemx -mno-bitfield
19053 @opindex mnobitfield
19054 @opindex mno-bitfield
19055 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
19056 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
19058 @item -mbitfield
19059 @opindex mbitfield
19060 Do use the bit-field instructions.  The @option{-m68020} option implies
19061 @option{-mbitfield}.  This is the default if you use a configuration
19062 designed for a 68020.
19064 @item -mrtd
19065 @opindex mrtd
19066 Use a different function-calling convention, in which functions
19067 that take a fixed number of arguments return with the @code{rtd}
19068 instruction, which pops their arguments while returning.  This
19069 saves one instruction in the caller since there is no need to pop
19070 the arguments there.
19072 This calling convention is incompatible with the one normally
19073 used on Unix, so you cannot use it if you need to call libraries
19074 compiled with the Unix compiler.
19076 Also, you must provide function prototypes for all functions that
19077 take variable numbers of arguments (including @code{printf});
19078 otherwise incorrect code is generated for calls to those
19079 functions.
19081 In addition, seriously incorrect code results if you call a
19082 function with too many arguments.  (Normally, extra arguments are
19083 harmlessly ignored.)
19085 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
19086 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
19088 @item -mno-rtd
19089 @opindex mno-rtd
19090 Do not use the calling conventions selected by @option{-mrtd}.
19091 This is the default.
19093 @item -malign-int
19094 @itemx -mno-align-int
19095 @opindex malign-int
19096 @opindex mno-align-int
19097 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
19098 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
19099 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
19100 Aligning variables on 32-bit boundaries produces code that runs somewhat
19101 faster on processors with 32-bit busses at the expense of more memory.
19103 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
19104 aligns structures containing the above types differently than
19105 most published application binary interface specifications for the m68k.
19107 @item -mpcrel
19108 @opindex mpcrel
19109 Use the pc-relative addressing mode of the 68000 directly, instead of
19110 using a global offset table.  At present, this option implies @option{-fpic},
19111 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
19112 not presently supported with @option{-mpcrel}, though this could be supported for
19113 68020 and higher processors.
19115 @item -mno-strict-align
19116 @itemx -mstrict-align
19117 @opindex mno-strict-align
19118 @opindex mstrict-align
19119 Do not (do) assume that unaligned memory references are handled by
19120 the system.
19122 @item -msep-data
19123 Generate code that allows the data segment to be located in a different
19124 area of memory from the text segment.  This allows for execute-in-place in
19125 an environment without virtual memory management.  This option implies
19126 @option{-fPIC}.
19128 @item -mno-sep-data
19129 Generate code that assumes that the data segment follows the text segment.
19130 This is the default.
19132 @item -mid-shared-library
19133 Generate code that supports shared libraries via the library ID method.
19134 This allows for execute-in-place and shared libraries in an environment
19135 without virtual memory management.  This option implies @option{-fPIC}.
19137 @item -mno-id-shared-library
19138 Generate code that doesn't assume ID-based shared libraries are being used.
19139 This is the default.
19141 @item -mshared-library-id=n
19142 Specifies the identification number of the ID-based shared library being
19143 compiled.  Specifying a value of 0 generates more compact code; specifying
19144 other values forces the allocation of that number to the current
19145 library, but is no more space- or time-efficient than omitting this option.
19147 @item -mxgot
19148 @itemx -mno-xgot
19149 @opindex mxgot
19150 @opindex mno-xgot
19151 When generating position-independent code for ColdFire, generate code
19152 that works if the GOT has more than 8192 entries.  This code is
19153 larger and slower than code generated without this option.  On M680x0
19154 processors, this option is not needed; @option{-fPIC} suffices.
19156 GCC normally uses a single instruction to load values from the GOT@.
19157 While this is relatively efficient, it only works if the GOT
19158 is smaller than about 64k.  Anything larger causes the linker
19159 to report an error such as:
19161 @cindex relocation truncated to fit (ColdFire)
19162 @smallexample
19163 relocation truncated to fit: R_68K_GOT16O foobar
19164 @end smallexample
19166 If this happens, you should recompile your code with @option{-mxgot}.
19167 It should then work with very large GOTs.  However, code generated with
19168 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
19169 the value of a global symbol.
19171 Note that some linkers, including newer versions of the GNU linker,
19172 can create multiple GOTs and sort GOT entries.  If you have such a linker,
19173 you should only need to use @option{-mxgot} when compiling a single
19174 object file that accesses more than 8192 GOT entries.  Very few do.
19176 These options have no effect unless GCC is generating
19177 position-independent code.
19179 @item -mlong-jump-table-offsets
19180 @opindex mlong-jump-table-offsets
19181 Use 32-bit offsets in @code{switch} tables.  The default is to use
19182 16-bit offsets.
19184 @end table
19186 @node MCore Options
19187 @subsection MCore Options
19188 @cindex MCore options
19190 These are the @samp{-m} options defined for the Motorola M*Core
19191 processors.
19193 @table @gcctabopt
19195 @item -mhardlit
19196 @itemx -mno-hardlit
19197 @opindex mhardlit
19198 @opindex mno-hardlit
19199 Inline constants into the code stream if it can be done in two
19200 instructions or less.
19202 @item -mdiv
19203 @itemx -mno-div
19204 @opindex mdiv
19205 @opindex mno-div
19206 Use the divide instruction.  (Enabled by default).
19208 @item -mrelax-immediate
19209 @itemx -mno-relax-immediate
19210 @opindex mrelax-immediate
19211 @opindex mno-relax-immediate
19212 Allow arbitrary-sized immediates in bit operations.
19214 @item -mwide-bitfields
19215 @itemx -mno-wide-bitfields
19216 @opindex mwide-bitfields
19217 @opindex mno-wide-bitfields
19218 Always treat bit-fields as @code{int}-sized.
19220 @item -m4byte-functions
19221 @itemx -mno-4byte-functions
19222 @opindex m4byte-functions
19223 @opindex mno-4byte-functions
19224 Force all functions to be aligned to a 4-byte boundary.
19226 @item -mcallgraph-data
19227 @itemx -mno-callgraph-data
19228 @opindex mcallgraph-data
19229 @opindex mno-callgraph-data
19230 Emit callgraph information.
19232 @item -mslow-bytes
19233 @itemx -mno-slow-bytes
19234 @opindex mslow-bytes
19235 @opindex mno-slow-bytes
19236 Prefer word access when reading byte quantities.
19238 @item -mlittle-endian
19239 @itemx -mbig-endian
19240 @opindex mlittle-endian
19241 @opindex mbig-endian
19242 Generate code for a little-endian target.
19244 @item -m210
19245 @itemx -m340
19246 @opindex m210
19247 @opindex m340
19248 Generate code for the 210 processor.
19250 @item -mno-lsim
19251 @opindex mno-lsim
19252 Assume that runtime support has been provided and so omit the
19253 simulator library (@file{libsim.a)} from the linker command line.
19255 @item -mstack-increment=@var{size}
19256 @opindex mstack-increment
19257 Set the maximum amount for a single stack increment operation.  Large
19258 values can increase the speed of programs that contain functions
19259 that need a large amount of stack space, but they can also trigger a
19260 segmentation fault if the stack is extended too much.  The default
19261 value is 0x1000.
19263 @end table
19265 @node MeP Options
19266 @subsection MeP Options
19267 @cindex MeP options
19269 @table @gcctabopt
19271 @item -mabsdiff
19272 @opindex mabsdiff
19273 Enables the @code{abs} instruction, which is the absolute difference
19274 between two registers.
19276 @item -mall-opts
19277 @opindex mall-opts
19278 Enables all the optional instructions---average, multiply, divide, bit
19279 operations, leading zero, absolute difference, min/max, clip, and
19280 saturation.
19283 @item -maverage
19284 @opindex maverage
19285 Enables the @code{ave} instruction, which computes the average of two
19286 registers.
19288 @item -mbased=@var{n}
19289 @opindex mbased=
19290 Variables of size @var{n} bytes or smaller are placed in the
19291 @code{.based} section by default.  Based variables use the @code{$tp}
19292 register as a base register, and there is a 128-byte limit to the
19293 @code{.based} section.
19295 @item -mbitops
19296 @opindex mbitops
19297 Enables the bit operation instructions---bit test (@code{btstm}), set
19298 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
19299 test-and-set (@code{tas}).
19301 @item -mc=@var{name}
19302 @opindex mc=
19303 Selects which section constant data is placed in.  @var{name} may
19304 be @samp{tiny}, @samp{near}, or @samp{far}.
19306 @item -mclip
19307 @opindex mclip
19308 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
19309 useful unless you also provide @option{-mminmax}.
19311 @item -mconfig=@var{name}
19312 @opindex mconfig=
19313 Selects one of the built-in core configurations.  Each MeP chip has
19314 one or more modules in it; each module has a core CPU and a variety of
19315 coprocessors, optional instructions, and peripherals.  The
19316 @code{MeP-Integrator} tool, not part of GCC, provides these
19317 configurations through this option; using this option is the same as
19318 using all the corresponding command-line options.  The default
19319 configuration is @samp{default}.
19321 @item -mcop
19322 @opindex mcop
19323 Enables the coprocessor instructions.  By default, this is a 32-bit
19324 coprocessor.  Note that the coprocessor is normally enabled via the
19325 @option{-mconfig=} option.
19327 @item -mcop32
19328 @opindex mcop32
19329 Enables the 32-bit coprocessor's instructions.
19331 @item -mcop64
19332 @opindex mcop64
19333 Enables the 64-bit coprocessor's instructions.
19335 @item -mivc2
19336 @opindex mivc2
19337 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
19339 @item -mdc
19340 @opindex mdc
19341 Causes constant variables to be placed in the @code{.near} section.
19343 @item -mdiv
19344 @opindex mdiv
19345 Enables the @code{div} and @code{divu} instructions.
19347 @item -meb
19348 @opindex meb
19349 Generate big-endian code.
19351 @item -mel
19352 @opindex mel
19353 Generate little-endian code.
19355 @item -mio-volatile
19356 @opindex mio-volatile
19357 Tells the compiler that any variable marked with the @code{io}
19358 attribute is to be considered volatile.
19360 @item -ml
19361 @opindex ml
19362 Causes variables to be assigned to the @code{.far} section by default.
19364 @item -mleadz
19365 @opindex mleadz
19366 Enables the @code{leadz} (leading zero) instruction.
19368 @item -mm
19369 @opindex mm
19370 Causes variables to be assigned to the @code{.near} section by default.
19372 @item -mminmax
19373 @opindex mminmax
19374 Enables the @code{min} and @code{max} instructions.
19376 @item -mmult
19377 @opindex mmult
19378 Enables the multiplication and multiply-accumulate instructions.
19380 @item -mno-opts
19381 @opindex mno-opts
19382 Disables all the optional instructions enabled by @option{-mall-opts}.
19384 @item -mrepeat
19385 @opindex mrepeat
19386 Enables the @code{repeat} and @code{erepeat} instructions, used for
19387 low-overhead looping.
19389 @item -ms
19390 @opindex ms
19391 Causes all variables to default to the @code{.tiny} section.  Note
19392 that there is a 65536-byte limit to this section.  Accesses to these
19393 variables use the @code{%gp} base register.
19395 @item -msatur
19396 @opindex msatur
19397 Enables the saturation instructions.  Note that the compiler does not
19398 currently generate these itself, but this option is included for
19399 compatibility with other tools, like @code{as}.
19401 @item -msdram
19402 @opindex msdram
19403 Link the SDRAM-based runtime instead of the default ROM-based runtime.
19405 @item -msim
19406 @opindex msim
19407 Link the simulator run-time libraries.
19409 @item -msimnovec
19410 @opindex msimnovec
19411 Link the simulator runtime libraries, excluding built-in support
19412 for reset and exception vectors and tables.
19414 @item -mtf
19415 @opindex mtf
19416 Causes all functions to default to the @code{.far} section.  Without
19417 this option, functions default to the @code{.near} section.
19419 @item -mtiny=@var{n}
19420 @opindex mtiny=
19421 Variables that are @var{n} bytes or smaller are allocated to the
19422 @code{.tiny} section.  These variables use the @code{$gp} base
19423 register.  The default for this option is 4, but note that there's a
19424 65536-byte limit to the @code{.tiny} section.
19426 @end table
19428 @node MicroBlaze Options
19429 @subsection MicroBlaze Options
19430 @cindex MicroBlaze Options
19432 @table @gcctabopt
19434 @item -msoft-float
19435 @opindex msoft-float
19436 Use software emulation for floating point (default).
19438 @item -mhard-float
19439 @opindex mhard-float
19440 Use hardware floating-point instructions.
19442 @item -mmemcpy
19443 @opindex mmemcpy
19444 Do not optimize block moves, use @code{memcpy}.
19446 @item -mno-clearbss
19447 @opindex mno-clearbss
19448 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
19450 @item -mcpu=@var{cpu-type}
19451 @opindex mcpu=
19452 Use features of, and schedule code for, the given CPU.
19453 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
19454 where @var{X} is a major version, @var{YY} is the minor version, and
19455 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
19456 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
19458 @item -mxl-soft-mul
19459 @opindex mxl-soft-mul
19460 Use software multiply emulation (default).
19462 @item -mxl-soft-div
19463 @opindex mxl-soft-div
19464 Use software emulation for divides (default).
19466 @item -mxl-barrel-shift
19467 @opindex mxl-barrel-shift
19468 Use the hardware barrel shifter.
19470 @item -mxl-pattern-compare
19471 @opindex mxl-pattern-compare
19472 Use pattern compare instructions.
19474 @item -msmall-divides
19475 @opindex msmall-divides
19476 Use table lookup optimization for small signed integer divisions.
19478 @item -mxl-stack-check
19479 @opindex mxl-stack-check
19480 This option is deprecated.  Use @option{-fstack-check} instead.
19482 @item -mxl-gp-opt
19483 @opindex mxl-gp-opt
19484 Use GP-relative @code{.sdata}/@code{.sbss} sections.
19486 @item -mxl-multiply-high
19487 @opindex mxl-multiply-high
19488 Use multiply high instructions for high part of 32x32 multiply.
19490 @item -mxl-float-convert
19491 @opindex mxl-float-convert
19492 Use hardware floating-point conversion instructions.
19494 @item -mxl-float-sqrt
19495 @opindex mxl-float-sqrt
19496 Use hardware floating-point square root instruction.
19498 @item -mbig-endian
19499 @opindex mbig-endian
19500 Generate code for a big-endian target.
19502 @item -mlittle-endian
19503 @opindex mlittle-endian
19504 Generate code for a little-endian target.
19506 @item -mxl-reorder
19507 @opindex mxl-reorder
19508 Use reorder instructions (swap and byte reversed load/store).
19510 @item -mxl-mode-@var{app-model}
19511 Select application model @var{app-model}.  Valid models are
19512 @table @samp
19513 @item executable
19514 normal executable (default), uses startup code @file{crt0.o}.
19516 @item xmdstub
19517 for use with Xilinx Microprocessor Debugger (XMD) based
19518 software intrusive debug agent called xmdstub. This uses startup file
19519 @file{crt1.o} and sets the start address of the program to 0x800.
19521 @item bootstrap
19522 for applications that are loaded using a bootloader.
19523 This model uses startup file @file{crt2.o} which does not contain a processor
19524 reset vector handler. This is suitable for transferring control on a
19525 processor reset to the bootloader rather than the application.
19527 @item novectors
19528 for applications that do not require any of the
19529 MicroBlaze vectors. This option may be useful for applications running
19530 within a monitoring application. This model uses @file{crt3.o} as a startup file.
19531 @end table
19533 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
19534 @option{-mxl-mode-@var{app-model}}.
19536 @end table
19538 @node MIPS Options
19539 @subsection MIPS Options
19540 @cindex MIPS options
19542 @table @gcctabopt
19544 @item -EB
19545 @opindex EB
19546 Generate big-endian code.
19548 @item -EL
19549 @opindex EL
19550 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
19551 configurations.
19553 @item -march=@var{arch}
19554 @opindex march
19555 Generate code that runs on @var{arch}, which can be the name of a
19556 generic MIPS ISA, or the name of a particular processor.
19557 The ISA names are:
19558 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
19559 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
19560 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
19561 @samp{mips64r5} and @samp{mips64r6}.
19562 The processor names are:
19563 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
19564 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
19565 @samp{5kc}, @samp{5kf},
19566 @samp{20kc},
19567 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
19568 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
19569 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
19570 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
19571 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
19572 @samp{i6400},
19573 @samp{interaptiv},
19574 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
19575 @samp{m4k},
19576 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
19577 @samp{m5100}, @samp{m5101},
19578 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
19579 @samp{orion},
19580 @samp{p5600},
19581 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
19582 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
19583 @samp{rm7000}, @samp{rm9000},
19584 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
19585 @samp{sb1},
19586 @samp{sr71000},
19587 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
19588 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
19589 @samp{xlr} and @samp{xlp}.
19590 The special value @samp{from-abi} selects the
19591 most compatible architecture for the selected ABI (that is,
19592 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
19594 The native Linux/GNU toolchain also supports the value @samp{native},
19595 which selects the best architecture option for the host processor.
19596 @option{-march=native} has no effect if GCC does not recognize
19597 the processor.
19599 In processor names, a final @samp{000} can be abbreviated as @samp{k}
19600 (for example, @option{-march=r2k}).  Prefixes are optional, and
19601 @samp{vr} may be written @samp{r}.
19603 Names of the form @samp{@var{n}f2_1} refer to processors with
19604 FPUs clocked at half the rate of the core, names of the form
19605 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
19606 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
19607 processors with FPUs clocked a ratio of 3:2 with respect to the core.
19608 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
19609 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
19610 accepted as synonyms for @samp{@var{n}f1_1}.
19612 GCC defines two macros based on the value of this option.  The first
19613 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
19614 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
19615 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
19616 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
19617 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
19619 Note that the @code{_MIPS_ARCH} macro uses the processor names given
19620 above.  In other words, it has the full prefix and does not
19621 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
19622 the macro names the resolved architecture (either @code{"mips1"} or
19623 @code{"mips3"}).  It names the default architecture when no
19624 @option{-march} option is given.
19626 @item -mtune=@var{arch}
19627 @opindex mtune
19628 Optimize for @var{arch}.  Among other things, this option controls
19629 the way instructions are scheduled, and the perceived cost of arithmetic
19630 operations.  The list of @var{arch} values is the same as for
19631 @option{-march}.
19633 When this option is not used, GCC optimizes for the processor
19634 specified by @option{-march}.  By using @option{-march} and
19635 @option{-mtune} together, it is possible to generate code that
19636 runs on a family of processors, but optimize the code for one
19637 particular member of that family.
19639 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
19640 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
19641 @option{-march} ones described above.
19643 @item -mips1
19644 @opindex mips1
19645 Equivalent to @option{-march=mips1}.
19647 @item -mips2
19648 @opindex mips2
19649 Equivalent to @option{-march=mips2}.
19651 @item -mips3
19652 @opindex mips3
19653 Equivalent to @option{-march=mips3}.
19655 @item -mips4
19656 @opindex mips4
19657 Equivalent to @option{-march=mips4}.
19659 @item -mips32
19660 @opindex mips32
19661 Equivalent to @option{-march=mips32}.
19663 @item -mips32r3
19664 @opindex mips32r3
19665 Equivalent to @option{-march=mips32r3}.
19667 @item -mips32r5
19668 @opindex mips32r5
19669 Equivalent to @option{-march=mips32r5}.
19671 @item -mips32r6
19672 @opindex mips32r6
19673 Equivalent to @option{-march=mips32r6}.
19675 @item -mips64
19676 @opindex mips64
19677 Equivalent to @option{-march=mips64}.
19679 @item -mips64r2
19680 @opindex mips64r2
19681 Equivalent to @option{-march=mips64r2}.
19683 @item -mips64r3
19684 @opindex mips64r3
19685 Equivalent to @option{-march=mips64r3}.
19687 @item -mips64r5
19688 @opindex mips64r5
19689 Equivalent to @option{-march=mips64r5}.
19691 @item -mips64r6
19692 @opindex mips64r6
19693 Equivalent to @option{-march=mips64r6}.
19695 @item -mips16
19696 @itemx -mno-mips16
19697 @opindex mips16
19698 @opindex mno-mips16
19699 Generate (do not generate) MIPS16 code.  If GCC is targeting a
19700 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
19702 MIPS16 code generation can also be controlled on a per-function basis
19703 by means of @code{mips16} and @code{nomips16} attributes.
19704 @xref{Function Attributes}, for more information.
19706 @item -mflip-mips16
19707 @opindex mflip-mips16
19708 Generate MIPS16 code on alternating functions.  This option is provided
19709 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
19710 not intended for ordinary use in compiling user code.
19712 @item -minterlink-compressed
19713 @item -mno-interlink-compressed
19714 @opindex minterlink-compressed
19715 @opindex mno-interlink-compressed
19716 Require (do not require) that code using the standard (uncompressed) MIPS ISA
19717 be link-compatible with MIPS16 and microMIPS code, and vice versa.
19719 For example, code using the standard ISA encoding cannot jump directly
19720 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
19721 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
19722 knows that the target of the jump is not compressed.
19724 @item -minterlink-mips16
19725 @itemx -mno-interlink-mips16
19726 @opindex minterlink-mips16
19727 @opindex mno-interlink-mips16
19728 Aliases of @option{-minterlink-compressed} and
19729 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
19730 and are retained for backwards compatibility.
19732 @item -mabi=32
19733 @itemx -mabi=o64
19734 @itemx -mabi=n32
19735 @itemx -mabi=64
19736 @itemx -mabi=eabi
19737 @opindex mabi=32
19738 @opindex mabi=o64
19739 @opindex mabi=n32
19740 @opindex mabi=64
19741 @opindex mabi=eabi
19742 Generate code for the given ABI@.
19744 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
19745 generates 64-bit code when you select a 64-bit architecture, but you
19746 can use @option{-mgp32} to get 32-bit code instead.
19748 For information about the O64 ABI, see
19749 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
19751 GCC supports a variant of the o32 ABI in which floating-point registers
19752 are 64 rather than 32 bits wide.  You can select this combination with
19753 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
19754 and @code{mfhc1} instructions and is therefore only supported for
19755 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
19757 The register assignments for arguments and return values remain the
19758 same, but each scalar value is passed in a single 64-bit register
19759 rather than a pair of 32-bit registers.  For example, scalar
19760 floating-point values are returned in @samp{$f0} only, not a
19761 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
19762 remains the same in that the even-numbered double-precision registers
19763 are saved.
19765 Two additional variants of the o32 ABI are supported to enable
19766 a transition from 32-bit to 64-bit registers.  These are FPXX
19767 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
19768 The FPXX extension mandates that all code must execute correctly
19769 when run using 32-bit or 64-bit registers.  The code can be interlinked
19770 with either FP32 or FP64, but not both.
19771 The FP64A extension is similar to the FP64 extension but forbids the
19772 use of odd-numbered single-precision registers.  This can be used
19773 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
19774 processors and allows both FP32 and FP64A code to interlink and
19775 run in the same process without changing FPU modes.
19777 @item -mabicalls
19778 @itemx -mno-abicalls
19779 @opindex mabicalls
19780 @opindex mno-abicalls
19781 Generate (do not generate) code that is suitable for SVR4-style
19782 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
19783 systems.
19785 @item -mshared
19786 @itemx -mno-shared
19787 Generate (do not generate) code that is fully position-independent,
19788 and that can therefore be linked into shared libraries.  This option
19789 only affects @option{-mabicalls}.
19791 All @option{-mabicalls} code has traditionally been position-independent,
19792 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
19793 as an extension, the GNU toolchain allows executables to use absolute
19794 accesses for locally-binding symbols.  It can also use shorter GP
19795 initialization sequences and generate direct calls to locally-defined
19796 functions.  This mode is selected by @option{-mno-shared}.
19798 @option{-mno-shared} depends on binutils 2.16 or higher and generates
19799 objects that can only be linked by the GNU linker.  However, the option
19800 does not affect the ABI of the final executable; it only affects the ABI
19801 of relocatable objects.  Using @option{-mno-shared} generally makes
19802 executables both smaller and quicker.
19804 @option{-mshared} is the default.
19806 @item -mplt
19807 @itemx -mno-plt
19808 @opindex mplt
19809 @opindex mno-plt
19810 Assume (do not assume) that the static and dynamic linkers
19811 support PLTs and copy relocations.  This option only affects
19812 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
19813 has no effect without @option{-msym32}.
19815 You can make @option{-mplt} the default by configuring
19816 GCC with @option{--with-mips-plt}.  The default is
19817 @option{-mno-plt} otherwise.
19819 @item -mxgot
19820 @itemx -mno-xgot
19821 @opindex mxgot
19822 @opindex mno-xgot
19823 Lift (do not lift) the usual restrictions on the size of the global
19824 offset table.
19826 GCC normally uses a single instruction to load values from the GOT@.
19827 While this is relatively efficient, it only works if the GOT
19828 is smaller than about 64k.  Anything larger causes the linker
19829 to report an error such as:
19831 @cindex relocation truncated to fit (MIPS)
19832 @smallexample
19833 relocation truncated to fit: R_MIPS_GOT16 foobar
19834 @end smallexample
19836 If this happens, you should recompile your code with @option{-mxgot}.
19837 This works with very large GOTs, although the code is also
19838 less efficient, since it takes three instructions to fetch the
19839 value of a global symbol.
19841 Note that some linkers can create multiple GOTs.  If you have such a
19842 linker, you should only need to use @option{-mxgot} when a single object
19843 file accesses more than 64k's worth of GOT entries.  Very few do.
19845 These options have no effect unless GCC is generating position
19846 independent code.
19848 @item -mgp32
19849 @opindex mgp32
19850 Assume that general-purpose registers are 32 bits wide.
19852 @item -mgp64
19853 @opindex mgp64
19854 Assume that general-purpose registers are 64 bits wide.
19856 @item -mfp32
19857 @opindex mfp32
19858 Assume that floating-point registers are 32 bits wide.
19860 @item -mfp64
19861 @opindex mfp64
19862 Assume that floating-point registers are 64 bits wide.
19864 @item -mfpxx
19865 @opindex mfpxx
19866 Do not assume the width of floating-point registers.
19868 @item -mhard-float
19869 @opindex mhard-float
19870 Use floating-point coprocessor instructions.
19872 @item -msoft-float
19873 @opindex msoft-float
19874 Do not use floating-point coprocessor instructions.  Implement
19875 floating-point calculations using library calls instead.
19877 @item -mno-float
19878 @opindex mno-float
19879 Equivalent to @option{-msoft-float}, but additionally asserts that the
19880 program being compiled does not perform any floating-point operations.
19881 This option is presently supported only by some bare-metal MIPS
19882 configurations, where it may select a special set of libraries
19883 that lack all floating-point support (including, for example, the
19884 floating-point @code{printf} formats).  
19885 If code compiled with @option{-mno-float} accidentally contains
19886 floating-point operations, it is likely to suffer a link-time
19887 or run-time failure.
19889 @item -msingle-float
19890 @opindex msingle-float
19891 Assume that the floating-point coprocessor only supports single-precision
19892 operations.
19894 @item -mdouble-float
19895 @opindex mdouble-float
19896 Assume that the floating-point coprocessor supports double-precision
19897 operations.  This is the default.
19899 @item -modd-spreg
19900 @itemx -mno-odd-spreg
19901 @opindex modd-spreg
19902 @opindex mno-odd-spreg
19903 Enable the use of odd-numbered single-precision floating-point registers
19904 for the o32 ABI.  This is the default for processors that are known to
19905 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
19906 is set by default.
19908 @item -mabs=2008
19909 @itemx -mabs=legacy
19910 @opindex mabs=2008
19911 @opindex mabs=legacy
19912 These options control the treatment of the special not-a-number (NaN)
19913 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
19914 @code{neg.@i{fmt}} machine instructions.
19916 By default or when @option{-mabs=legacy} is used the legacy
19917 treatment is selected.  In this case these instructions are considered
19918 arithmetic and avoided where correct operation is required and the
19919 input operand might be a NaN.  A longer sequence of instructions that
19920 manipulate the sign bit of floating-point datum manually is used
19921 instead unless the @option{-ffinite-math-only} option has also been
19922 specified.
19924 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
19925 this case these instructions are considered non-arithmetic and therefore
19926 operating correctly in all cases, including in particular where the
19927 input operand is a NaN.  These instructions are therefore always used
19928 for the respective operations.
19930 @item -mnan=2008
19931 @itemx -mnan=legacy
19932 @opindex mnan=2008
19933 @opindex mnan=legacy
19934 These options control the encoding of the special not-a-number (NaN)
19935 IEEE 754 floating-point data.
19937 The @option{-mnan=legacy} option selects the legacy encoding.  In this
19938 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
19939 significand field being 0, whereas signaling NaNs (sNaNs) are denoted
19940 by the first bit of their trailing significand field being 1.
19942 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
19943 this case qNaNs are denoted by the first bit of their trailing
19944 significand field being 1, whereas sNaNs are denoted by the first bit of
19945 their trailing significand field being 0.
19947 The default is @option{-mnan=legacy} unless GCC has been configured with
19948 @option{--with-nan=2008}.
19950 @item -mllsc
19951 @itemx -mno-llsc
19952 @opindex mllsc
19953 @opindex mno-llsc
19954 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
19955 implement atomic memory built-in functions.  When neither option is
19956 specified, GCC uses the instructions if the target architecture
19957 supports them.
19959 @option{-mllsc} is useful if the runtime environment can emulate the
19960 instructions and @option{-mno-llsc} can be useful when compiling for
19961 nonstandard ISAs.  You can make either option the default by
19962 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
19963 respectively.  @option{--with-llsc} is the default for some
19964 configurations; see the installation documentation for details.
19966 @item -mdsp
19967 @itemx -mno-dsp
19968 @opindex mdsp
19969 @opindex mno-dsp
19970 Use (do not use) revision 1 of the MIPS DSP ASE@.
19971 @xref{MIPS DSP Built-in Functions}.  This option defines the
19972 preprocessor macro @code{__mips_dsp}.  It also defines
19973 @code{__mips_dsp_rev} to 1.
19975 @item -mdspr2
19976 @itemx -mno-dspr2
19977 @opindex mdspr2
19978 @opindex mno-dspr2
19979 Use (do not use) revision 2 of the MIPS DSP ASE@.
19980 @xref{MIPS DSP Built-in Functions}.  This option defines the
19981 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
19982 It also defines @code{__mips_dsp_rev} to 2.
19984 @item -msmartmips
19985 @itemx -mno-smartmips
19986 @opindex msmartmips
19987 @opindex mno-smartmips
19988 Use (do not use) the MIPS SmartMIPS ASE.
19990 @item -mpaired-single
19991 @itemx -mno-paired-single
19992 @opindex mpaired-single
19993 @opindex mno-paired-single
19994 Use (do not use) paired-single floating-point instructions.
19995 @xref{MIPS Paired-Single Support}.  This option requires
19996 hardware floating-point support to be enabled.
19998 @item -mdmx
19999 @itemx -mno-mdmx
20000 @opindex mdmx
20001 @opindex mno-mdmx
20002 Use (do not use) MIPS Digital Media Extension instructions.
20003 This option can only be used when generating 64-bit code and requires
20004 hardware floating-point support to be enabled.
20006 @item -mips3d
20007 @itemx -mno-mips3d
20008 @opindex mips3d
20009 @opindex mno-mips3d
20010 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
20011 The option @option{-mips3d} implies @option{-mpaired-single}.
20013 @item -mmicromips
20014 @itemx -mno-micromips
20015 @opindex mmicromips
20016 @opindex mno-mmicromips
20017 Generate (do not generate) microMIPS code.
20019 MicroMIPS code generation can also be controlled on a per-function basis
20020 by means of @code{micromips} and @code{nomicromips} attributes.
20021 @xref{Function Attributes}, for more information.
20023 @item -mmt
20024 @itemx -mno-mt
20025 @opindex mmt
20026 @opindex mno-mt
20027 Use (do not use) MT Multithreading instructions.
20029 @item -mmcu
20030 @itemx -mno-mcu
20031 @opindex mmcu
20032 @opindex mno-mcu
20033 Use (do not use) the MIPS MCU ASE instructions.
20035 @item -meva
20036 @itemx -mno-eva
20037 @opindex meva
20038 @opindex mno-eva
20039 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
20041 @item -mvirt
20042 @itemx -mno-virt
20043 @opindex mvirt
20044 @opindex mno-virt
20045 Use (do not use) the MIPS Virtualization (VZ) instructions.
20047 @item -mxpa
20048 @itemx -mno-xpa
20049 @opindex mxpa
20050 @opindex mno-xpa
20051 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
20053 @item -mlong64
20054 @opindex mlong64
20055 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
20056 an explanation of the default and the way that the pointer size is
20057 determined.
20059 @item -mlong32
20060 @opindex mlong32
20061 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
20063 The default size of @code{int}s, @code{long}s and pointers depends on
20064 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
20065 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
20066 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
20067 or the same size as integer registers, whichever is smaller.
20069 @item -msym32
20070 @itemx -mno-sym32
20071 @opindex msym32
20072 @opindex mno-sym32
20073 Assume (do not assume) that all symbols have 32-bit values, regardless
20074 of the selected ABI@.  This option is useful in combination with
20075 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
20076 to generate shorter and faster references to symbolic addresses.
20078 @item -G @var{num}
20079 @opindex G
20080 Put definitions of externally-visible data in a small data section
20081 if that data is no bigger than @var{num} bytes.  GCC can then generate
20082 more efficient accesses to the data; see @option{-mgpopt} for details.
20084 The default @option{-G} option depends on the configuration.
20086 @item -mlocal-sdata
20087 @itemx -mno-local-sdata
20088 @opindex mlocal-sdata
20089 @opindex mno-local-sdata
20090 Extend (do not extend) the @option{-G} behavior to local data too,
20091 such as to static variables in C@.  @option{-mlocal-sdata} is the
20092 default for all configurations.
20094 If the linker complains that an application is using too much small data,
20095 you might want to try rebuilding the less performance-critical parts with
20096 @option{-mno-local-sdata}.  You might also want to build large
20097 libraries with @option{-mno-local-sdata}, so that the libraries leave
20098 more room for the main program.
20100 @item -mextern-sdata
20101 @itemx -mno-extern-sdata
20102 @opindex mextern-sdata
20103 @opindex mno-extern-sdata
20104 Assume (do not assume) that externally-defined data is in
20105 a small data section if the size of that data is within the @option{-G} limit.
20106 @option{-mextern-sdata} is the default for all configurations.
20108 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
20109 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
20110 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
20111 is placed in a small data section.  If @var{Var} is defined by another
20112 module, you must either compile that module with a high-enough
20113 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
20114 definition.  If @var{Var} is common, you must link the application
20115 with a high-enough @option{-G} setting.
20117 The easiest way of satisfying these restrictions is to compile
20118 and link every module with the same @option{-G} option.  However,
20119 you may wish to build a library that supports several different
20120 small data limits.  You can do this by compiling the library with
20121 the highest supported @option{-G} setting and additionally using
20122 @option{-mno-extern-sdata} to stop the library from making assumptions
20123 about externally-defined data.
20125 @item -mgpopt
20126 @itemx -mno-gpopt
20127 @opindex mgpopt
20128 @opindex mno-gpopt
20129 Use (do not use) GP-relative accesses for symbols that are known to be
20130 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
20131 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
20132 configurations.
20134 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
20135 might not hold the value of @code{_gp}.  For example, if the code is
20136 part of a library that might be used in a boot monitor, programs that
20137 call boot monitor routines pass an unknown value in @code{$gp}.
20138 (In such situations, the boot monitor itself is usually compiled
20139 with @option{-G0}.)
20141 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
20142 @option{-mno-extern-sdata}.
20144 @item -membedded-data
20145 @itemx -mno-embedded-data
20146 @opindex membedded-data
20147 @opindex mno-embedded-data
20148 Allocate variables to the read-only data section first if possible, then
20149 next in the small data section if possible, otherwise in data.  This gives
20150 slightly slower code than the default, but reduces the amount of RAM required
20151 when executing, and thus may be preferred for some embedded systems.
20153 @item -muninit-const-in-rodata
20154 @itemx -mno-uninit-const-in-rodata
20155 @opindex muninit-const-in-rodata
20156 @opindex mno-uninit-const-in-rodata
20157 Put uninitialized @code{const} variables in the read-only data section.
20158 This option is only meaningful in conjunction with @option{-membedded-data}.
20160 @item -mcode-readable=@var{setting}
20161 @opindex mcode-readable
20162 Specify whether GCC may generate code that reads from executable sections.
20163 There are three possible settings:
20165 @table @gcctabopt
20166 @item -mcode-readable=yes
20167 Instructions may freely access executable sections.  This is the
20168 default setting.
20170 @item -mcode-readable=pcrel
20171 MIPS16 PC-relative load instructions can access executable sections,
20172 but other instructions must not do so.  This option is useful on 4KSc
20173 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
20174 It is also useful on processors that can be configured to have a dual
20175 instruction/data SRAM interface and that, like the M4K, automatically
20176 redirect PC-relative loads to the instruction RAM.
20178 @item -mcode-readable=no
20179 Instructions must not access executable sections.  This option can be
20180 useful on targets that are configured to have a dual instruction/data
20181 SRAM interface but that (unlike the M4K) do not automatically redirect
20182 PC-relative loads to the instruction RAM.
20183 @end table
20185 @item -msplit-addresses
20186 @itemx -mno-split-addresses
20187 @opindex msplit-addresses
20188 @opindex mno-split-addresses
20189 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
20190 relocation operators.  This option has been superseded by
20191 @option{-mexplicit-relocs} but is retained for backwards compatibility.
20193 @item -mexplicit-relocs
20194 @itemx -mno-explicit-relocs
20195 @opindex mexplicit-relocs
20196 @opindex mno-explicit-relocs
20197 Use (do not use) assembler relocation operators when dealing with symbolic
20198 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
20199 is to use assembler macros instead.
20201 @option{-mexplicit-relocs} is the default if GCC was configured
20202 to use an assembler that supports relocation operators.
20204 @item -mcheck-zero-division
20205 @itemx -mno-check-zero-division
20206 @opindex mcheck-zero-division
20207 @opindex mno-check-zero-division
20208 Trap (do not trap) on integer division by zero.
20210 The default is @option{-mcheck-zero-division}.
20212 @item -mdivide-traps
20213 @itemx -mdivide-breaks
20214 @opindex mdivide-traps
20215 @opindex mdivide-breaks
20216 MIPS systems check for division by zero by generating either a
20217 conditional trap or a break instruction.  Using traps results in
20218 smaller code, but is only supported on MIPS II and later.  Also, some
20219 versions of the Linux kernel have a bug that prevents trap from
20220 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
20221 allow conditional traps on architectures that support them and
20222 @option{-mdivide-breaks} to force the use of breaks.
20224 The default is usually @option{-mdivide-traps}, but this can be
20225 overridden at configure time using @option{--with-divide=breaks}.
20226 Divide-by-zero checks can be completely disabled using
20227 @option{-mno-check-zero-division}.
20229 @item -mload-store-pairs
20230 @itemx -mno-load-store-pairs
20231 @opindex mload-store-pairs
20232 @opindex mno-load-store-pairs
20233 Enable (disable) an optimization that pairs consecutive load or store
20234 instructions to enable load/store bonding.  This option is enabled by
20235 default but only takes effect when the selected architecture is known
20236 to support bonding.
20238 @item -mmemcpy
20239 @itemx -mno-memcpy
20240 @opindex mmemcpy
20241 @opindex mno-memcpy
20242 Force (do not force) the use of @code{memcpy} for non-trivial block
20243 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
20244 most constant-sized copies.
20246 @item -mlong-calls
20247 @itemx -mno-long-calls
20248 @opindex mlong-calls
20249 @opindex mno-long-calls
20250 Disable (do not disable) use of the @code{jal} instruction.  Calling
20251 functions using @code{jal} is more efficient but requires the caller
20252 and callee to be in the same 256 megabyte segment.
20254 This option has no effect on abicalls code.  The default is
20255 @option{-mno-long-calls}.
20257 @item -mmad
20258 @itemx -mno-mad
20259 @opindex mmad
20260 @opindex mno-mad
20261 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
20262 instructions, as provided by the R4650 ISA@.
20264 @item -mimadd
20265 @itemx -mno-imadd
20266 @opindex mimadd
20267 @opindex mno-imadd
20268 Enable (disable) use of the @code{madd} and @code{msub} integer
20269 instructions.  The default is @option{-mimadd} on architectures
20270 that support @code{madd} and @code{msub} except for the 74k 
20271 architecture where it was found to generate slower code.
20273 @item -mfused-madd
20274 @itemx -mno-fused-madd
20275 @opindex mfused-madd
20276 @opindex mno-fused-madd
20277 Enable (disable) use of the floating-point multiply-accumulate
20278 instructions, when they are available.  The default is
20279 @option{-mfused-madd}.
20281 On the R8000 CPU when multiply-accumulate instructions are used,
20282 the intermediate product is calculated to infinite precision
20283 and is not subject to the FCSR Flush to Zero bit.  This may be
20284 undesirable in some circumstances.  On other processors the result
20285 is numerically identical to the equivalent computation using
20286 separate multiply, add, subtract and negate instructions.
20288 @item -nocpp
20289 @opindex nocpp
20290 Tell the MIPS assembler to not run its preprocessor over user
20291 assembler files (with a @samp{.s} suffix) when assembling them.
20293 @item -mfix-24k
20294 @item -mno-fix-24k
20295 @opindex mfix-24k
20296 @opindex mno-fix-24k
20297 Work around the 24K E48 (lost data on stores during refill) errata.
20298 The workarounds are implemented by the assembler rather than by GCC@.
20300 @item -mfix-r4000
20301 @itemx -mno-fix-r4000
20302 @opindex mfix-r4000
20303 @opindex mno-fix-r4000
20304 Work around certain R4000 CPU errata:
20305 @itemize @minus
20306 @item
20307 A double-word or a variable shift may give an incorrect result if executed
20308 immediately after starting an integer division.
20309 @item
20310 A double-word or a variable shift may give an incorrect result if executed
20311 while an integer multiplication is in progress.
20312 @item
20313 An integer division may give an incorrect result if started in a delay slot
20314 of a taken branch or a jump.
20315 @end itemize
20317 @item -mfix-r4400
20318 @itemx -mno-fix-r4400
20319 @opindex mfix-r4400
20320 @opindex mno-fix-r4400
20321 Work around certain R4400 CPU errata:
20322 @itemize @minus
20323 @item
20324 A double-word or a variable shift may give an incorrect result if executed
20325 immediately after starting an integer division.
20326 @end itemize
20328 @item -mfix-r10000
20329 @itemx -mno-fix-r10000
20330 @opindex mfix-r10000
20331 @opindex mno-fix-r10000
20332 Work around certain R10000 errata:
20333 @itemize @minus
20334 @item
20335 @code{ll}/@code{sc} sequences may not behave atomically on revisions
20336 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
20337 @end itemize
20339 This option can only be used if the target architecture supports
20340 branch-likely instructions.  @option{-mfix-r10000} is the default when
20341 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
20342 otherwise.
20344 @item -mfix-rm7000
20345 @itemx -mno-fix-rm7000
20346 @opindex mfix-rm7000
20347 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
20348 workarounds are implemented by the assembler rather than by GCC@.
20350 @item -mfix-vr4120
20351 @itemx -mno-fix-vr4120
20352 @opindex mfix-vr4120
20353 Work around certain VR4120 errata:
20354 @itemize @minus
20355 @item
20356 @code{dmultu} does not always produce the correct result.
20357 @item
20358 @code{div} and @code{ddiv} do not always produce the correct result if one
20359 of the operands is negative.
20360 @end itemize
20361 The workarounds for the division errata rely on special functions in
20362 @file{libgcc.a}.  At present, these functions are only provided by
20363 the @code{mips64vr*-elf} configurations.
20365 Other VR4120 errata require a NOP to be inserted between certain pairs of
20366 instructions.  These errata are handled by the assembler, not by GCC itself.
20368 @item -mfix-vr4130
20369 @opindex mfix-vr4130
20370 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
20371 workarounds are implemented by the assembler rather than by GCC,
20372 although GCC avoids using @code{mflo} and @code{mfhi} if the
20373 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
20374 instructions are available instead.
20376 @item -mfix-sb1
20377 @itemx -mno-fix-sb1
20378 @opindex mfix-sb1
20379 Work around certain SB-1 CPU core errata.
20380 (This flag currently works around the SB-1 revision 2
20381 ``F1'' and ``F2'' floating-point errata.)
20383 @item -mr10k-cache-barrier=@var{setting}
20384 @opindex mr10k-cache-barrier
20385 Specify whether GCC should insert cache barriers to avoid the
20386 side-effects of speculation on R10K processors.
20388 In common with many processors, the R10K tries to predict the outcome
20389 of a conditional branch and speculatively executes instructions from
20390 the ``taken'' branch.  It later aborts these instructions if the
20391 predicted outcome is wrong.  However, on the R10K, even aborted
20392 instructions can have side effects.
20394 This problem only affects kernel stores and, depending on the system,
20395 kernel loads.  As an example, a speculatively-executed store may load
20396 the target memory into cache and mark the cache line as dirty, even if
20397 the store itself is later aborted.  If a DMA operation writes to the
20398 same area of memory before the ``dirty'' line is flushed, the cached
20399 data overwrites the DMA-ed data.  See the R10K processor manual
20400 for a full description, including other potential problems.
20402 One workaround is to insert cache barrier instructions before every memory
20403 access that might be speculatively executed and that might have side
20404 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
20405 controls GCC's implementation of this workaround.  It assumes that
20406 aborted accesses to any byte in the following regions does not have
20407 side effects:
20409 @enumerate
20410 @item
20411 the memory occupied by the current function's stack frame;
20413 @item
20414 the memory occupied by an incoming stack argument;
20416 @item
20417 the memory occupied by an object with a link-time-constant address.
20418 @end enumerate
20420 It is the kernel's responsibility to ensure that speculative
20421 accesses to these regions are indeed safe.
20423 If the input program contains a function declaration such as:
20425 @smallexample
20426 void foo (void);
20427 @end smallexample
20429 then the implementation of @code{foo} must allow @code{j foo} and
20430 @code{jal foo} to be executed speculatively.  GCC honors this
20431 restriction for functions it compiles itself.  It expects non-GCC
20432 functions (such as hand-written assembly code) to do the same.
20434 The option has three forms:
20436 @table @gcctabopt
20437 @item -mr10k-cache-barrier=load-store
20438 Insert a cache barrier before a load or store that might be
20439 speculatively executed and that might have side effects even
20440 if aborted.
20442 @item -mr10k-cache-barrier=store
20443 Insert a cache barrier before a store that might be speculatively
20444 executed and that might have side effects even if aborted.
20446 @item -mr10k-cache-barrier=none
20447 Disable the insertion of cache barriers.  This is the default setting.
20448 @end table
20450 @item -mflush-func=@var{func}
20451 @itemx -mno-flush-func
20452 @opindex mflush-func
20453 Specifies the function to call to flush the I and D caches, or to not
20454 call any such function.  If called, the function must take the same
20455 arguments as the common @code{_flush_func}, that is, the address of the
20456 memory range for which the cache is being flushed, the size of the
20457 memory range, and the number 3 (to flush both caches).  The default
20458 depends on the target GCC was configured for, but commonly is either
20459 @code{_flush_func} or @code{__cpu_flush}.
20461 @item mbranch-cost=@var{num}
20462 @opindex mbranch-cost
20463 Set the cost of branches to roughly @var{num} ``simple'' instructions.
20464 This cost is only a heuristic and is not guaranteed to produce
20465 consistent results across releases.  A zero cost redundantly selects
20466 the default, which is based on the @option{-mtune} setting.
20468 @item -mbranch-likely
20469 @itemx -mno-branch-likely
20470 @opindex mbranch-likely
20471 @opindex mno-branch-likely
20472 Enable or disable use of Branch Likely instructions, regardless of the
20473 default for the selected architecture.  By default, Branch Likely
20474 instructions may be generated if they are supported by the selected
20475 architecture.  An exception is for the MIPS32 and MIPS64 architectures
20476 and processors that implement those architectures; for those, Branch
20477 Likely instructions are not be generated by default because the MIPS32
20478 and MIPS64 architectures specifically deprecate their use.
20480 @item -mcompact-branches=never
20481 @itemx -mcompact-branches=optimal
20482 @itemx -mcompact-branches=always
20483 @opindex mcompact-branches=never
20484 @opindex mcompact-branches=optimal
20485 @opindex mcompact-branches=always
20486 These options control which form of branches will be generated.  The
20487 default is @option{-mcompact-branches=optimal}.
20489 The @option{-mcompact-branches=never} option ensures that compact branch
20490 instructions will never be generated.
20492 The @option{-mcompact-branches=always} option ensures that a compact
20493 branch instruction will be generated if available.  If a compact branch
20494 instruction is not available, a delay slot form of the branch will be
20495 used instead.
20497 This option is supported from MIPS Release 6 onwards.
20499 The @option{-mcompact-branches=optimal} option will cause a delay slot
20500 branch to be used if one is available in the current ISA and the delay
20501 slot is successfully filled.  If the delay slot is not filled, a compact
20502 branch will be chosen if one is available.
20504 @item -mfp-exceptions
20505 @itemx -mno-fp-exceptions
20506 @opindex mfp-exceptions
20507 Specifies whether FP exceptions are enabled.  This affects how
20508 FP instructions are scheduled for some processors.
20509 The default is that FP exceptions are
20510 enabled.
20512 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
20513 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
20514 FP pipe.
20516 @item -mvr4130-align
20517 @itemx -mno-vr4130-align
20518 @opindex mvr4130-align
20519 The VR4130 pipeline is two-way superscalar, but can only issue two
20520 instructions together if the first one is 8-byte aligned.  When this
20521 option is enabled, GCC aligns pairs of instructions that it
20522 thinks should execute in parallel.
20524 This option only has an effect when optimizing for the VR4130.
20525 It normally makes code faster, but at the expense of making it bigger.
20526 It is enabled by default at optimization level @option{-O3}.
20528 @item -msynci
20529 @itemx -mno-synci
20530 @opindex msynci
20531 Enable (disable) generation of @code{synci} instructions on
20532 architectures that support it.  The @code{synci} instructions (if
20533 enabled) are generated when @code{__builtin___clear_cache} is
20534 compiled.
20536 This option defaults to @option{-mno-synci}, but the default can be
20537 overridden by configuring GCC with @option{--with-synci}.
20539 When compiling code for single processor systems, it is generally safe
20540 to use @code{synci}.  However, on many multi-core (SMP) systems, it
20541 does not invalidate the instruction caches on all cores and may lead
20542 to undefined behavior.
20544 @item -mrelax-pic-calls
20545 @itemx -mno-relax-pic-calls
20546 @opindex mrelax-pic-calls
20547 Try to turn PIC calls that are normally dispatched via register
20548 @code{$25} into direct calls.  This is only possible if the linker can
20549 resolve the destination at link time and if the destination is within
20550 range for a direct call.
20552 @option{-mrelax-pic-calls} is the default if GCC was configured to use
20553 an assembler and a linker that support the @code{.reloc} assembly
20554 directive and @option{-mexplicit-relocs} is in effect.  With
20555 @option{-mno-explicit-relocs}, this optimization can be performed by the
20556 assembler and the linker alone without help from the compiler.
20558 @item -mmcount-ra-address
20559 @itemx -mno-mcount-ra-address
20560 @opindex mmcount-ra-address
20561 @opindex mno-mcount-ra-address
20562 Emit (do not emit) code that allows @code{_mcount} to modify the
20563 calling function's return address.  When enabled, this option extends
20564 the usual @code{_mcount} interface with a new @var{ra-address}
20565 parameter, which has type @code{intptr_t *} and is passed in register
20566 @code{$12}.  @code{_mcount} can then modify the return address by
20567 doing both of the following:
20568 @itemize
20569 @item
20570 Returning the new address in register @code{$31}.
20571 @item
20572 Storing the new address in @code{*@var{ra-address}},
20573 if @var{ra-address} is nonnull.
20574 @end itemize
20576 The default is @option{-mno-mcount-ra-address}.
20578 @item -mframe-header-opt
20579 @itemx -mno-frame-header-opt
20580 @opindex mframe-header-opt
20581 Enable (disable) frame header optimization in the o32 ABI.  When using the
20582 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
20583 function to write out register arguments.  When enabled, this optimization
20584 will suppress the allocation of the frame header if it can be determined that
20585 it is unused.
20587 This optimization is off by default at all optimization levels.
20589 @item -mlxc1-sxc1
20590 @itemx -mno-lxc1-sxc1
20591 @opindex mlxc1-sxc1
20592 When applicable, enable (disable) the generation of @code{lwxc1},
20593 @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions.  Enabled by default.
20595 @item -mmadd4
20596 @itemx -mno-madd4
20597 @opindex mmadd4
20598 When applicable, enable (disable) the generation of 4-operand @code{madd.s},
20599 @code{madd.d} and related instructions.  Enabled by default.
20601 @end table
20603 @node MMIX Options
20604 @subsection MMIX Options
20605 @cindex MMIX Options
20607 These options are defined for the MMIX:
20609 @table @gcctabopt
20610 @item -mlibfuncs
20611 @itemx -mno-libfuncs
20612 @opindex mlibfuncs
20613 @opindex mno-libfuncs
20614 Specify that intrinsic library functions are being compiled, passing all
20615 values in registers, no matter the size.
20617 @item -mepsilon
20618 @itemx -mno-epsilon
20619 @opindex mepsilon
20620 @opindex mno-epsilon
20621 Generate floating-point comparison instructions that compare with respect
20622 to the @code{rE} epsilon register.
20624 @item -mabi=mmixware
20625 @itemx -mabi=gnu
20626 @opindex mabi=mmixware
20627 @opindex mabi=gnu
20628 Generate code that passes function parameters and return values that (in
20629 the called function) are seen as registers @code{$0} and up, as opposed to
20630 the GNU ABI which uses global registers @code{$231} and up.
20632 @item -mzero-extend
20633 @itemx -mno-zero-extend
20634 @opindex mzero-extend
20635 @opindex mno-zero-extend
20636 When reading data from memory in sizes shorter than 64 bits, use (do not
20637 use) zero-extending load instructions by default, rather than
20638 sign-extending ones.
20640 @item -mknuthdiv
20641 @itemx -mno-knuthdiv
20642 @opindex mknuthdiv
20643 @opindex mno-knuthdiv
20644 Make the result of a division yielding a remainder have the same sign as
20645 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
20646 remainder follows the sign of the dividend.  Both methods are
20647 arithmetically valid, the latter being almost exclusively used.
20649 @item -mtoplevel-symbols
20650 @itemx -mno-toplevel-symbols
20651 @opindex mtoplevel-symbols
20652 @opindex mno-toplevel-symbols
20653 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
20654 code can be used with the @code{PREFIX} assembly directive.
20656 @item -melf
20657 @opindex melf
20658 Generate an executable in the ELF format, rather than the default
20659 @samp{mmo} format used by the @command{mmix} simulator.
20661 @item -mbranch-predict
20662 @itemx -mno-branch-predict
20663 @opindex mbranch-predict
20664 @opindex mno-branch-predict
20665 Use (do not use) the probable-branch instructions, when static branch
20666 prediction indicates a probable branch.
20668 @item -mbase-addresses
20669 @itemx -mno-base-addresses
20670 @opindex mbase-addresses
20671 @opindex mno-base-addresses
20672 Generate (do not generate) code that uses @emph{base addresses}.  Using a
20673 base address automatically generates a request (handled by the assembler
20674 and the linker) for a constant to be set up in a global register.  The
20675 register is used for one or more base address requests within the range 0
20676 to 255 from the value held in the register.  The generally leads to short
20677 and fast code, but the number of different data items that can be
20678 addressed is limited.  This means that a program that uses lots of static
20679 data may require @option{-mno-base-addresses}.
20681 @item -msingle-exit
20682 @itemx -mno-single-exit
20683 @opindex msingle-exit
20684 @opindex mno-single-exit
20685 Force (do not force) generated code to have a single exit point in each
20686 function.
20687 @end table
20689 @node MN10300 Options
20690 @subsection MN10300 Options
20691 @cindex MN10300 options
20693 These @option{-m} options are defined for Matsushita MN10300 architectures:
20695 @table @gcctabopt
20696 @item -mmult-bug
20697 @opindex mmult-bug
20698 Generate code to avoid bugs in the multiply instructions for the MN10300
20699 processors.  This is the default.
20701 @item -mno-mult-bug
20702 @opindex mno-mult-bug
20703 Do not generate code to avoid bugs in the multiply instructions for the
20704 MN10300 processors.
20706 @item -mam33
20707 @opindex mam33
20708 Generate code using features specific to the AM33 processor.
20710 @item -mno-am33
20711 @opindex mno-am33
20712 Do not generate code using features specific to the AM33 processor.  This
20713 is the default.
20715 @item -mam33-2
20716 @opindex mam33-2
20717 Generate code using features specific to the AM33/2.0 processor.
20719 @item -mam34
20720 @opindex mam34
20721 Generate code using features specific to the AM34 processor.
20723 @item -mtune=@var{cpu-type}
20724 @opindex mtune
20725 Use the timing characteristics of the indicated CPU type when
20726 scheduling instructions.  This does not change the targeted processor
20727 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
20728 @samp{am33-2} or @samp{am34}.
20730 @item -mreturn-pointer-on-d0
20731 @opindex mreturn-pointer-on-d0
20732 When generating a function that returns a pointer, return the pointer
20733 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
20734 only in @code{a0}, and attempts to call such functions without a prototype
20735 result in errors.  Note that this option is on by default; use
20736 @option{-mno-return-pointer-on-d0} to disable it.
20738 @item -mno-crt0
20739 @opindex mno-crt0
20740 Do not link in the C run-time initialization object file.
20742 @item -mrelax
20743 @opindex mrelax
20744 Indicate to the linker that it should perform a relaxation optimization pass
20745 to shorten branches, calls and absolute memory addresses.  This option only
20746 has an effect when used on the command line for the final link step.
20748 This option makes symbolic debugging impossible.
20750 @item -mliw
20751 @opindex mliw
20752 Allow the compiler to generate @emph{Long Instruction Word}
20753 instructions if the target is the @samp{AM33} or later.  This is the
20754 default.  This option defines the preprocessor macro @code{__LIW__}.
20756 @item -mnoliw
20757 @opindex mnoliw
20758 Do not allow the compiler to generate @emph{Long Instruction Word}
20759 instructions.  This option defines the preprocessor macro
20760 @code{__NO_LIW__}.
20762 @item -msetlb
20763 @opindex msetlb
20764 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
20765 instructions if the target is the @samp{AM33} or later.  This is the
20766 default.  This option defines the preprocessor macro @code{__SETLB__}.
20768 @item -mnosetlb
20769 @opindex mnosetlb
20770 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
20771 instructions.  This option defines the preprocessor macro
20772 @code{__NO_SETLB__}.
20774 @end table
20776 @node Moxie Options
20777 @subsection Moxie Options
20778 @cindex Moxie Options
20780 @table @gcctabopt
20782 @item -meb
20783 @opindex meb
20784 Generate big-endian code.  This is the default for @samp{moxie-*-*}
20785 configurations.
20787 @item -mel
20788 @opindex mel
20789 Generate little-endian code.
20791 @item -mmul.x
20792 @opindex mmul.x
20793 Generate mul.x and umul.x instructions.  This is the default for
20794 @samp{moxiebox-*-*} configurations.
20796 @item -mno-crt0
20797 @opindex mno-crt0
20798 Do not link in the C run-time initialization object file.
20800 @end table
20802 @node MSP430 Options
20803 @subsection MSP430 Options
20804 @cindex MSP430 Options
20806 These options are defined for the MSP430:
20808 @table @gcctabopt
20810 @item -masm-hex
20811 @opindex masm-hex
20812 Force assembly output to always use hex constants.  Normally such
20813 constants are signed decimals, but this option is available for
20814 testsuite and/or aesthetic purposes.
20816 @item -mmcu=
20817 @opindex mmcu=
20818 Select the MCU to target.  This is used to create a C preprocessor
20819 symbol based upon the MCU name, converted to upper case and pre- and
20820 post-fixed with @samp{__}.  This in turn is used by the
20821 @file{msp430.h} header file to select an MCU-specific supplementary
20822 header file.
20824 The option also sets the ISA to use.  If the MCU name is one that is
20825 known to only support the 430 ISA then that is selected, otherwise the
20826 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
20827 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
20828 name selects the 430X ISA.
20830 In addition an MCU-specific linker script is added to the linker
20831 command line.  The script's name is the name of the MCU with
20832 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
20833 command line defines the C preprocessor symbol @code{__XXX__} and
20834 cause the linker to search for a script called @file{xxx.ld}.
20836 This option is also passed on to the assembler.
20838 @item -mwarn-mcu
20839 @itemx -mno-warn-mcu
20840 @opindex mwarn-mcu
20841 @opindex mno-warn-mcu
20842 This option enables or disables warnings about conflicts between the
20843 MCU name specified by the @option{-mmcu} option and the ISA set by the
20844 @option{-mcpu} option and/or the hardware multiply support set by the
20845 @option{-mhwmult} option.  It also toggles warnings about unrecognized
20846 MCU names.  This option is on by default.
20848 @item -mcpu=
20849 @opindex mcpu=
20850 Specifies the ISA to use.  Accepted values are @samp{msp430},
20851 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
20852 @option{-mmcu=} option should be used to select the ISA.
20854 @item -msim
20855 @opindex msim
20856 Link to the simulator runtime libraries and linker script.  Overrides
20857 any scripts that would be selected by the @option{-mmcu=} option.
20859 @item -mlarge
20860 @opindex mlarge
20861 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
20863 @item -msmall
20864 @opindex msmall
20865 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
20867 @item -mrelax
20868 @opindex mrelax
20869 This option is passed to the assembler and linker, and allows the
20870 linker to perform certain optimizations that cannot be done until
20871 the final link.
20873 @item mhwmult=
20874 @opindex mhwmult=
20875 Describes the type of hardware multiply supported by the target.
20876 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
20877 for the original 16-bit-only multiply supported by early MCUs.
20878 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
20879 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
20880 A value of @samp{auto} can also be given.  This tells GCC to deduce
20881 the hardware multiply support based upon the MCU name provided by the
20882 @option{-mmcu} option.  If no @option{-mmcu} option is specified or if
20883 the MCU name is not recognized then no hardware multiply support is
20884 assumed.  @code{auto} is the default setting.
20886 Hardware multiplies are normally performed by calling a library
20887 routine.  This saves space in the generated code.  When compiling at
20888 @option{-O3} or higher however the hardware multiplier is invoked
20889 inline.  This makes for bigger, but faster code.
20891 The hardware multiply routines disable interrupts whilst running and
20892 restore the previous interrupt state when they finish.  This makes
20893 them safe to use inside interrupt handlers as well as in normal code.
20895 @item -minrt
20896 @opindex minrt
20897 Enable the use of a minimum runtime environment - no static
20898 initializers or constructors.  This is intended for memory-constrained
20899 devices.  The compiler includes special symbols in some objects
20900 that tell the linker and runtime which code fragments are required.
20902 @item -mcode-region=
20903 @itemx -mdata-region=
20904 @opindex mcode-region
20905 @opindex mdata-region
20906 These options tell the compiler where to place functions and data that
20907 do not have one of the @code{lower}, @code{upper}, @code{either} or
20908 @code{section} attributes.  Possible values are @code{lower},
20909 @code{upper}, @code{either} or @code{any}.  The first three behave
20910 like the corresponding attribute.  The fourth possible value -
20911 @code{any} - is the default.  It leaves placement entirely up to the
20912 linker script and how it assigns the standard sections
20913 (@code{.text}, @code{.data}, etc) to the memory regions.
20915 @item -msilicon-errata=
20916 @opindex msilicon-errata
20917 This option passes on a request to assembler to enable the fixes for
20918 the named silicon errata.
20920 @item -msilicon-errata-warn=
20921 @opindex msilicon-errata-warn
20922 This option passes on a request to the assembler to enable warning
20923 messages when a silicon errata might need to be applied.
20925 @end table
20927 @node NDS32 Options
20928 @subsection NDS32 Options
20929 @cindex NDS32 Options
20931 These options are defined for NDS32 implementations:
20933 @table @gcctabopt
20935 @item -mbig-endian
20936 @opindex mbig-endian
20937 Generate code in big-endian mode.
20939 @item -mlittle-endian
20940 @opindex mlittle-endian
20941 Generate code in little-endian mode.
20943 @item -mreduced-regs
20944 @opindex mreduced-regs
20945 Use reduced-set registers for register allocation.
20947 @item -mfull-regs
20948 @opindex mfull-regs
20949 Use full-set registers for register allocation.
20951 @item -mcmov
20952 @opindex mcmov
20953 Generate conditional move instructions.
20955 @item -mno-cmov
20956 @opindex mno-cmov
20957 Do not generate conditional move instructions.
20959 @item -mperf-ext
20960 @opindex mperf-ext
20961 Generate performance extension instructions.
20963 @item -mno-perf-ext
20964 @opindex mno-perf-ext
20965 Do not generate performance extension instructions.
20967 @item -mv3push
20968 @opindex mv3push
20969 Generate v3 push25/pop25 instructions.
20971 @item -mno-v3push
20972 @opindex mno-v3push
20973 Do not generate v3 push25/pop25 instructions.
20975 @item -m16-bit
20976 @opindex m16-bit
20977 Generate 16-bit instructions.
20979 @item -mno-16-bit
20980 @opindex mno-16-bit
20981 Do not generate 16-bit instructions.
20983 @item -misr-vector-size=@var{num}
20984 @opindex misr-vector-size
20985 Specify the size of each interrupt vector, which must be 4 or 16.
20987 @item -mcache-block-size=@var{num}
20988 @opindex mcache-block-size
20989 Specify the size of each cache block,
20990 which must be a power of 2 between 4 and 512.
20992 @item -march=@var{arch}
20993 @opindex march
20994 Specify the name of the target architecture.
20996 @item -mcmodel=@var{code-model}
20997 @opindex mcmodel
20998 Set the code model to one of
20999 @table @asis
21000 @item @samp{small}
21001 All the data and read-only data segments must be within 512KB addressing space.
21002 The text segment must be within 16MB addressing space.
21003 @item @samp{medium}
21004 The data segment must be within 512KB while the read-only data segment can be
21005 within 4GB addressing space.  The text segment should be still within 16MB
21006 addressing space.
21007 @item @samp{large}
21008 All the text and data segments can be within 4GB addressing space.
21009 @end table
21011 @item -mctor-dtor
21012 @opindex mctor-dtor
21013 Enable constructor/destructor feature.
21015 @item -mrelax
21016 @opindex mrelax
21017 Guide linker to relax instructions.
21019 @end table
21021 @node Nios II Options
21022 @subsection Nios II Options
21023 @cindex Nios II options
21024 @cindex Altera Nios II options
21026 These are the options defined for the Altera Nios II processor.
21028 @table @gcctabopt
21030 @item -G @var{num}
21031 @opindex G
21032 @cindex smaller data references
21033 Put global and static objects less than or equal to @var{num} bytes
21034 into the small data or BSS sections instead of the normal data or BSS
21035 sections.  The default value of @var{num} is 8.
21037 @item -mgpopt=@var{option}
21038 @item -mgpopt
21039 @itemx -mno-gpopt
21040 @opindex mgpopt
21041 @opindex mno-gpopt
21042 Generate (do not generate) GP-relative accesses.  The following 
21043 @var{option} names are recognized:
21045 @table @samp
21047 @item none
21048 Do not generate GP-relative accesses.
21050 @item local
21051 Generate GP-relative accesses for small data objects that are not 
21052 external, weak, or uninitialized common symbols.  
21053 Also use GP-relative addressing for objects that
21054 have been explicitly placed in a small data section via a @code{section}
21055 attribute.
21057 @item global
21058 As for @samp{local}, but also generate GP-relative accesses for
21059 small data objects that are external, weak, or common.  If you use this option,
21060 you must ensure that all parts of your program (including libraries) are
21061 compiled with the same @option{-G} setting.
21063 @item data
21064 Generate GP-relative accesses for all data objects in the program.  If you
21065 use this option, the entire data and BSS segments
21066 of your program must fit in 64K of memory and you must use an appropriate
21067 linker script to allocate them within the addressable range of the
21068 global pointer.
21070 @item all
21071 Generate GP-relative addresses for function pointers as well as data
21072 pointers.  If you use this option, the entire text, data, and BSS segments
21073 of your program must fit in 64K of memory and you must use an appropriate
21074 linker script to allocate them within the addressable range of the
21075 global pointer.
21077 @end table
21079 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
21080 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
21082 The default is @option{-mgpopt} except when @option{-fpic} or
21083 @option{-fPIC} is specified to generate position-independent code.
21084 Note that the Nios II ABI does not permit GP-relative accesses from
21085 shared libraries.
21087 You may need to specify @option{-mno-gpopt} explicitly when building
21088 programs that include large amounts of small data, including large
21089 GOT data sections.  In this case, the 16-bit offset for GP-relative
21090 addressing may not be large enough to allow access to the entire 
21091 small data section.
21093 @item -mel
21094 @itemx -meb
21095 @opindex mel
21096 @opindex meb
21097 Generate little-endian (default) or big-endian (experimental) code,
21098 respectively.
21100 @item -march=@var{arch}
21101 @opindex march
21102 This specifies the name of the target Nios II architecture.  GCC uses this
21103 name to determine what kind of instructions it can emit when generating
21104 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
21106 The preprocessor macro @code{__nios2_arch__} is available to programs,
21107 with value 1 or 2, indicating the targeted ISA level.
21109 @item -mbypass-cache
21110 @itemx -mno-bypass-cache
21111 @opindex mno-bypass-cache
21112 @opindex mbypass-cache
21113 Force all load and store instructions to always bypass cache by 
21114 using I/O variants of the instructions. The default is not to
21115 bypass the cache.
21117 @item -mno-cache-volatile 
21118 @itemx -mcache-volatile       
21119 @opindex mcache-volatile 
21120 @opindex mno-cache-volatile
21121 Volatile memory access bypass the cache using the I/O variants of 
21122 the load and store instructions. The default is not to bypass the cache.
21124 @item -mno-fast-sw-div
21125 @itemx -mfast-sw-div
21126 @opindex mno-fast-sw-div
21127 @opindex mfast-sw-div
21128 Do not use table-based fast divide for small numbers. The default 
21129 is to use the fast divide at @option{-O3} and above.
21131 @item -mno-hw-mul
21132 @itemx -mhw-mul
21133 @itemx -mno-hw-mulx
21134 @itemx -mhw-mulx
21135 @itemx -mno-hw-div
21136 @itemx -mhw-div
21137 @opindex mno-hw-mul
21138 @opindex mhw-mul
21139 @opindex mno-hw-mulx
21140 @opindex mhw-mulx
21141 @opindex mno-hw-div
21142 @opindex mhw-div
21143 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
21144 instructions by the compiler. The default is to emit @code{mul}
21145 and not emit @code{div} and @code{mulx}.
21147 @item -mbmx
21148 @itemx -mno-bmx
21149 @itemx -mcdx
21150 @itemx -mno-cdx
21151 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
21152 CDX (code density) instructions.  Enabling these instructions also
21153 requires @option{-march=r2}.  Since these instructions are optional
21154 extensions to the R2 architecture, the default is not to emit them.
21156 @item -mcustom-@var{insn}=@var{N}
21157 @itemx -mno-custom-@var{insn}
21158 @opindex mcustom-@var{insn}
21159 @opindex mno-custom-@var{insn}
21160 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
21161 custom instruction with encoding @var{N} when generating code that uses 
21162 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
21163 instruction 253 for single-precision floating-point add operations instead
21164 of the default behavior of using a library call.
21166 The following values of @var{insn} are supported.  Except as otherwise
21167 noted, floating-point operations are expected to be implemented with
21168 normal IEEE 754 semantics and correspond directly to the C operators or the
21169 equivalent GCC built-in functions (@pxref{Other Builtins}).
21171 Single-precision floating point:
21172 @table @asis
21174 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
21175 Binary arithmetic operations.
21177 @item @samp{fnegs}
21178 Unary negation.
21180 @item @samp{fabss}
21181 Unary absolute value.
21183 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
21184 Comparison operations.
21186 @item @samp{fmins}, @samp{fmaxs}
21187 Floating-point minimum and maximum.  These instructions are only
21188 generated if @option{-ffinite-math-only} is specified.
21190 @item @samp{fsqrts}
21191 Unary square root operation.
21193 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
21194 Floating-point trigonometric and exponential functions.  These instructions
21195 are only generated if @option{-funsafe-math-optimizations} is also specified.
21197 @end table
21199 Double-precision floating point:
21200 @table @asis
21202 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
21203 Binary arithmetic operations.
21205 @item @samp{fnegd}
21206 Unary negation.
21208 @item @samp{fabsd}
21209 Unary absolute value.
21211 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
21212 Comparison operations.
21214 @item @samp{fmind}, @samp{fmaxd}
21215 Double-precision minimum and maximum.  These instructions are only
21216 generated if @option{-ffinite-math-only} is specified.
21218 @item @samp{fsqrtd}
21219 Unary square root operation.
21221 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
21222 Double-precision trigonometric and exponential functions.  These instructions
21223 are only generated if @option{-funsafe-math-optimizations} is also specified.
21225 @end table
21227 Conversions:
21228 @table @asis
21229 @item @samp{fextsd}
21230 Conversion from single precision to double precision.
21232 @item @samp{ftruncds}
21233 Conversion from double precision to single precision.
21235 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
21236 Conversion from floating point to signed or unsigned integer types, with
21237 truncation towards zero.
21239 @item @samp{round}
21240 Conversion from single-precision floating point to signed integer,
21241 rounding to the nearest integer and ties away from zero.
21242 This corresponds to the @code{__builtin_lroundf} function when
21243 @option{-fno-math-errno} is used.
21245 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
21246 Conversion from signed or unsigned integer types to floating-point types.
21248 @end table
21250 In addition, all of the following transfer instructions for internal
21251 registers X and Y must be provided to use any of the double-precision
21252 floating-point instructions.  Custom instructions taking two
21253 double-precision source operands expect the first operand in the
21254 64-bit register X.  The other operand (or only operand of a unary
21255 operation) is given to the custom arithmetic instruction with the
21256 least significant half in source register @var{src1} and the most
21257 significant half in @var{src2}.  A custom instruction that returns a
21258 double-precision result returns the most significant 32 bits in the
21259 destination register and the other half in 32-bit register Y.  
21260 GCC automatically generates the necessary code sequences to write
21261 register X and/or read register Y when double-precision floating-point
21262 instructions are used.
21264 @table @asis
21266 @item @samp{fwrx}
21267 Write @var{src1} into the least significant half of X and @var{src2} into
21268 the most significant half of X.
21270 @item @samp{fwry}
21271 Write @var{src1} into Y.
21273 @item @samp{frdxhi}, @samp{frdxlo}
21274 Read the most or least (respectively) significant half of X and store it in
21275 @var{dest}.
21277 @item @samp{frdy}
21278 Read the value of Y and store it into @var{dest}.
21279 @end table
21281 Note that you can gain more local control over generation of Nios II custom
21282 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
21283 and @code{target("no-custom-@var{insn}")} function attributes
21284 (@pxref{Function Attributes})
21285 or pragmas (@pxref{Function Specific Option Pragmas}).
21287 @item -mcustom-fpu-cfg=@var{name}
21288 @opindex mcustom-fpu-cfg
21290 This option enables a predefined, named set of custom instruction encodings
21291 (see @option{-mcustom-@var{insn}} above).  
21292 Currently, the following sets are defined:
21294 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
21295 @gccoptlist{-mcustom-fmuls=252 @gol
21296 -mcustom-fadds=253 @gol
21297 -mcustom-fsubs=254 @gol
21298 -fsingle-precision-constant}
21300 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
21301 @gccoptlist{-mcustom-fmuls=252 @gol
21302 -mcustom-fadds=253 @gol
21303 -mcustom-fsubs=254 @gol
21304 -mcustom-fdivs=255 @gol
21305 -fsingle-precision-constant}
21307 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
21308 @gccoptlist{-mcustom-floatus=243 @gol
21309 -mcustom-fixsi=244 @gol
21310 -mcustom-floatis=245 @gol
21311 -mcustom-fcmpgts=246 @gol
21312 -mcustom-fcmples=249 @gol
21313 -mcustom-fcmpeqs=250 @gol
21314 -mcustom-fcmpnes=251 @gol
21315 -mcustom-fmuls=252 @gol
21316 -mcustom-fadds=253 @gol
21317 -mcustom-fsubs=254 @gol
21318 -mcustom-fdivs=255 @gol
21319 -fsingle-precision-constant}
21321 Custom instruction assignments given by individual
21322 @option{-mcustom-@var{insn}=} options override those given by
21323 @option{-mcustom-fpu-cfg=}, regardless of the
21324 order of the options on the command line.
21326 Note that you can gain more local control over selection of a FPU
21327 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
21328 function attribute (@pxref{Function Attributes})
21329 or pragma (@pxref{Function Specific Option Pragmas}).
21331 @end table
21333 These additional @samp{-m} options are available for the Altera Nios II
21334 ELF (bare-metal) target:
21336 @table @gcctabopt
21338 @item -mhal
21339 @opindex mhal
21340 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
21341 startup and termination code, and is typically used in conjunction with
21342 @option{-msys-crt0=} to specify the location of the alternate startup code
21343 provided by the HAL BSP.
21345 @item -msmallc
21346 @opindex msmallc
21347 Link with a limited version of the C library, @option{-lsmallc}, rather than
21348 Newlib.
21350 @item -msys-crt0=@var{startfile}
21351 @opindex msys-crt0
21352 @var{startfile} is the file name of the startfile (crt0) to use 
21353 when linking.  This option is only useful in conjunction with @option{-mhal}.
21355 @item -msys-lib=@var{systemlib}
21356 @opindex msys-lib
21357 @var{systemlib} is the library name of the library that provides
21358 low-level system calls required by the C library,
21359 e.g. @code{read} and @code{write}.
21360 This option is typically used to link with a library provided by a HAL BSP.
21362 @end table
21364 @node Nvidia PTX Options
21365 @subsection Nvidia PTX Options
21366 @cindex Nvidia PTX options
21367 @cindex nvptx options
21369 These options are defined for Nvidia PTX:
21371 @table @gcctabopt
21373 @item -m32
21374 @itemx -m64
21375 @opindex m32
21376 @opindex m64
21377 Generate code for 32-bit or 64-bit ABI.
21379 @item -mmainkernel
21380 @opindex mmainkernel
21381 Link in code for a __main kernel.  This is for stand-alone instead of
21382 offloading execution.
21384 @item -moptimize
21385 @opindex moptimize
21386 Apply partitioned execution optimizations.  This is the default when any
21387 level of optimization is selected.
21389 @item -msoft-stack
21390 @opindex msoft-stack
21391 Generate code that does not use @code{.local} memory
21392 directly for stack storage. Instead, a per-warp stack pointer is
21393 maintained explicitly. This enables variable-length stack allocation (with
21394 variable-length arrays or @code{alloca}), and when global memory is used for
21395 underlying storage, makes it possible to access automatic variables from other
21396 threads, or with atomic instructions. This code generation variant is used
21397 for OpenMP offloading, but the option is exposed on its own for the purpose
21398 of testing the compiler; to generate code suitable for linking into programs
21399 using OpenMP offloading, use option @option{-mgomp}.
21401 @item -muniform-simt
21402 @opindex muniform-simt
21403 Switch to code generation variant that allows to execute all threads in each
21404 warp, while maintaining memory state and side effects as if only one thread
21405 in each warp was active outside of OpenMP SIMD regions.  All atomic operations
21406 and calls to runtime (malloc, free, vprintf) are conditionally executed (iff
21407 current lane index equals the master lane index), and the register being
21408 assigned is copied via a shuffle instruction from the master lane.  Outside of
21409 SIMD regions lane 0 is the master; inside, each thread sees itself as the
21410 master.  Shared memory array @code{int __nvptx_uni[]} stores all-zeros or
21411 all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD
21412 regions).  Each thread can bitwise-and the bitmask at position @code{tid.y}
21413 with current lane index to compute the master lane index.
21415 @item -mgomp
21416 @opindex mgomp
21417 Generate code for use in OpenMP offloading: enables @option{-msoft-stack} and
21418 @option{-muniform-simt} options, and selects corresponding multilib variant.
21420 @end table
21422 @node PDP-11 Options
21423 @subsection PDP-11 Options
21424 @cindex PDP-11 Options
21426 These options are defined for the PDP-11:
21428 @table @gcctabopt
21429 @item -mfpu
21430 @opindex mfpu
21431 Use hardware FPP floating point.  This is the default.  (FIS floating
21432 point on the PDP-11/40 is not supported.)
21434 @item -msoft-float
21435 @opindex msoft-float
21436 Do not use hardware floating point.
21438 @item -mac0
21439 @opindex mac0
21440 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
21442 @item -mno-ac0
21443 @opindex mno-ac0
21444 Return floating-point results in memory.  This is the default.
21446 @item -m40
21447 @opindex m40
21448 Generate code for a PDP-11/40.
21450 @item -m45
21451 @opindex m45
21452 Generate code for a PDP-11/45.  This is the default.
21454 @item -m10
21455 @opindex m10
21456 Generate code for a PDP-11/10.
21458 @item -mbcopy-builtin
21459 @opindex mbcopy-builtin
21460 Use inline @code{movmemhi} patterns for copying memory.  This is the
21461 default.
21463 @item -mbcopy
21464 @opindex mbcopy
21465 Do not use inline @code{movmemhi} patterns for copying memory.
21467 @item -mint16
21468 @itemx -mno-int32
21469 @opindex mint16
21470 @opindex mno-int32
21471 Use 16-bit @code{int}.  This is the default.
21473 @item -mint32
21474 @itemx -mno-int16
21475 @opindex mint32
21476 @opindex mno-int16
21477 Use 32-bit @code{int}.
21479 @item -mfloat64
21480 @itemx -mno-float32
21481 @opindex mfloat64
21482 @opindex mno-float32
21483 Use 64-bit @code{float}.  This is the default.
21485 @item -mfloat32
21486 @itemx -mno-float64
21487 @opindex mfloat32
21488 @opindex mno-float64
21489 Use 32-bit @code{float}.
21491 @item -mabshi
21492 @opindex mabshi
21493 Use @code{abshi2} pattern.  This is the default.
21495 @item -mno-abshi
21496 @opindex mno-abshi
21497 Do not use @code{abshi2} pattern.
21499 @item -mbranch-expensive
21500 @opindex mbranch-expensive
21501 Pretend that branches are expensive.  This is for experimenting with
21502 code generation only.
21504 @item -mbranch-cheap
21505 @opindex mbranch-cheap
21506 Do not pretend that branches are expensive.  This is the default.
21508 @item -munix-asm
21509 @opindex munix-asm
21510 Use Unix assembler syntax.  This is the default when configured for
21511 @samp{pdp11-*-bsd}.
21513 @item -mdec-asm
21514 @opindex mdec-asm
21515 Use DEC assembler syntax.  This is the default when configured for any
21516 PDP-11 target other than @samp{pdp11-*-bsd}.
21517 @end table
21519 @node picoChip Options
21520 @subsection picoChip Options
21521 @cindex picoChip options
21523 These @samp{-m} options are defined for picoChip implementations:
21525 @table @gcctabopt
21527 @item -mae=@var{ae_type}
21528 @opindex mcpu
21529 Set the instruction set, register set, and instruction scheduling
21530 parameters for array element type @var{ae_type}.  Supported values
21531 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
21533 @option{-mae=ANY} selects a completely generic AE type.  Code
21534 generated with this option runs on any of the other AE types.  The
21535 code is not as efficient as it would be if compiled for a specific
21536 AE type, and some types of operation (e.g., multiplication) do not
21537 work properly on all types of AE.
21539 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
21540 for compiled code, and is the default.
21542 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
21543 option may suffer from poor performance of byte (char) manipulation,
21544 since the DSP AE does not provide hardware support for byte load/stores.
21546 @item -msymbol-as-address
21547 Enable the compiler to directly use a symbol name as an address in a
21548 load/store instruction, without first loading it into a
21549 register.  Typically, the use of this option generates larger
21550 programs, which run faster than when the option isn't used.  However, the
21551 results vary from program to program, so it is left as a user option,
21552 rather than being permanently enabled.
21554 @item -mno-inefficient-warnings
21555 Disables warnings about the generation of inefficient code.  These
21556 warnings can be generated, for example, when compiling code that
21557 performs byte-level memory operations on the MAC AE type.  The MAC AE has
21558 no hardware support for byte-level memory operations, so all byte
21559 load/stores must be synthesized from word load/store operations.  This is
21560 inefficient and a warning is generated to indicate
21561 that you should rewrite the code to avoid byte operations, or to target
21562 an AE type that has the necessary hardware support.  This option disables
21563 these warnings.
21565 @end table
21567 @node PowerPC Options
21568 @subsection PowerPC Options
21569 @cindex PowerPC options
21571 These are listed under @xref{RS/6000 and PowerPC Options}.
21573 @node RISC-V Options
21574 @subsection RISC-V Options
21575 @cindex RISC-V Options
21577 These command-line options are defined for RISC-V targets:
21579 @table @gcctabopt
21580 @item -mbranch-cost=@var{n}
21581 @opindex mbranch-cost
21582 Set the cost of branches to roughly @var{n} instructions.
21584 @item -mmemcpy
21585 @itemx -mno-memcpy
21586 @opindex mmemcpy
21587 Don't optimize block moves.
21589 @item -mplt
21590 @itemx -mno-plt
21591 @opindex plt
21592 When generating PIC code, allow the use of PLTs. Ignored for non-PIC.
21594 @item -mabi=@var{ABI-string}
21595 @opindex mabi
21596 Specify integer and floating-point calling convention.  This defaults to the
21597 natural calling convention: e.g.@ LP64 for RV64I, ILP32 for RV32I, LP64D for
21598 RV64G.
21600 @item -mfdiv
21601 @itemx -mno-fdiv
21602 @opindex mfdiv
21603 Use hardware floating-point divide and square root instructions.  This requires
21604 the F or D extensions for floating-point registers.
21606 @item -mdiv
21607 @itemx -mno-div
21608 @opindex mdiv
21609 Use hardware instructions for integer division.  This requires the M extension.
21611 @item -march=@var{ISA-string}
21612 @opindex march
21613 Generate code for given RISC-V ISA (e.g.@ @samp{rv64im}).  ISA strings must be
21614 lower-case.  Examples include @samp{rv64i}, @samp{rv32g}, and @samp{rv32imaf}.
21616 @item -mtune=@var{processor-string}
21617 @opindex mtune
21618 Optimize the output for the given processor, specified by microarchitecture
21619 name.
21621 @item -msmall-data-limit=@var{n}
21622 @opindex msmall-data-limit
21623 Put global and static data smaller than @var{n} bytes into a special section
21624 (on some targets).
21626 @item -msave-restore
21627 @itemx -mno-save-restore
21628 @opindex msave-restore
21629 Use smaller but slower prologue and epilogue code.
21631 @item -mstrict-align
21632 @itemx -mno-strict-align
21633 @opindex mstrict-align
21634 Do not generate unaligned memory accesses.
21636 @item -mcmodel=@var{code-model}
21637 @opindex mcmodel
21638 Specify the code model.
21640 @end table
21642 @node RL78 Options
21643 @subsection RL78 Options
21644 @cindex RL78 Options
21646 @table @gcctabopt
21648 @item -msim
21649 @opindex msim
21650 Links in additional target libraries to support operation within a
21651 simulator.
21653 @item -mmul=none
21654 @itemx -mmul=g10
21655 @itemx -mmul=g13
21656 @itemx -mmul=g14
21657 @itemx -mmul=rl78
21658 @opindex mmul
21659 Specifies the type of hardware multiplication and division support to
21660 be used.  The simplest is @code{none}, which uses software for both
21661 multiplication and division.  This is the default.  The @code{g13}
21662 value is for the hardware multiply/divide peripheral found on the
21663 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
21664 the multiplication and division instructions supported by the RL78/G14
21665 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
21666 the value @code{mg10} is an alias for @code{none}.
21668 In addition a C preprocessor macro is defined, based upon the setting
21669 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
21670 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
21672 @item -mcpu=g10
21673 @itemx -mcpu=g13
21674 @itemx -mcpu=g14
21675 @itemx -mcpu=rl78
21676 @opindex mcpu
21677 Specifies the RL78 core to target.  The default is the G14 core, also
21678 known as an S3 core or just RL78.  The G13 or S2 core does not have
21679 multiply or divide instructions, instead it uses a hardware peripheral
21680 for these operations.  The G10 or S1 core does not have register
21681 banks, so it uses a different calling convention.
21683 If this option is set it also selects the type of hardware multiply
21684 support to use, unless this is overridden by an explicit
21685 @option{-mmul=none} option on the command line.  Thus specifying
21686 @option{-mcpu=g13} enables the use of the G13 hardware multiply
21687 peripheral and specifying @option{-mcpu=g10} disables the use of
21688 hardware multiplications altogether.
21690 Note, although the RL78/G14 core is the default target, specifying
21691 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
21692 change the behavior of the toolchain since it also enables G14
21693 hardware multiply support.  If these options are not specified on the
21694 command line then software multiplication routines will be used even
21695 though the code targets the RL78 core.  This is for backwards
21696 compatibility with older toolchains which did not have hardware
21697 multiply and divide support.
21699 In addition a C preprocessor macro is defined, based upon the setting
21700 of this option.  Possible values are: @code{__RL78_G10__},
21701 @code{__RL78_G13__} or @code{__RL78_G14__}.
21703 @item -mg10
21704 @itemx -mg13
21705 @itemx -mg14
21706 @itemx -mrl78
21707 @opindex mg10
21708 @opindex mg13
21709 @opindex mg14
21710 @opindex mrl78
21711 These are aliases for the corresponding @option{-mcpu=} option.  They
21712 are provided for backwards compatibility.
21714 @item -mallregs
21715 @opindex mallregs
21716 Allow the compiler to use all of the available registers.  By default
21717 registers @code{r24..r31} are reserved for use in interrupt handlers.
21718 With this option enabled these registers can be used in ordinary
21719 functions as well.
21721 @item -m64bit-doubles
21722 @itemx -m32bit-doubles
21723 @opindex m64bit-doubles
21724 @opindex m32bit-doubles
21725 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
21726 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
21727 @option{-m32bit-doubles}.
21729 @item -msave-mduc-in-interrupts
21730 @item -mno-save-mduc-in-interrupts
21731 @opindex msave-mduc-in-interrupts
21732 @opindex mno-save-mduc-in-interrupts
21733 Specifies that interrupt handler functions should preserve the
21734 MDUC registers.  This is only necessary if normal code might use
21735 the MDUC registers, for example because it performs multiplication
21736 and division operations.  The default is to ignore the MDUC registers
21737 as this makes the interrupt handlers faster.  The target option -mg13
21738 needs to be passed for this to work as this feature is only available
21739 on the G13 target (S2 core).  The MDUC registers will only be saved
21740 if the interrupt handler performs a multiplication or division
21741 operation or it calls another function.
21743 @end table
21745 @node RS/6000 and PowerPC Options
21746 @subsection IBM RS/6000 and PowerPC Options
21747 @cindex RS/6000 and PowerPC Options
21748 @cindex IBM RS/6000 and PowerPC Options
21750 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
21751 @table @gcctabopt
21752 @item -mpowerpc-gpopt
21753 @itemx -mno-powerpc-gpopt
21754 @itemx -mpowerpc-gfxopt
21755 @itemx -mno-powerpc-gfxopt
21756 @need 800
21757 @itemx -mpowerpc64
21758 @itemx -mno-powerpc64
21759 @itemx -mmfcrf
21760 @itemx -mno-mfcrf
21761 @itemx -mpopcntb
21762 @itemx -mno-popcntb
21763 @itemx -mpopcntd
21764 @itemx -mno-popcntd
21765 @itemx -mfprnd
21766 @itemx -mno-fprnd
21767 @need 800
21768 @itemx -mcmpb
21769 @itemx -mno-cmpb
21770 @itemx -mmfpgpr
21771 @itemx -mno-mfpgpr
21772 @itemx -mhard-dfp
21773 @itemx -mno-hard-dfp
21774 @opindex mpowerpc-gpopt
21775 @opindex mno-powerpc-gpopt
21776 @opindex mpowerpc-gfxopt
21777 @opindex mno-powerpc-gfxopt
21778 @opindex mpowerpc64
21779 @opindex mno-powerpc64
21780 @opindex mmfcrf
21781 @opindex mno-mfcrf
21782 @opindex mpopcntb
21783 @opindex mno-popcntb
21784 @opindex mpopcntd
21785 @opindex mno-popcntd
21786 @opindex mfprnd
21787 @opindex mno-fprnd
21788 @opindex mcmpb
21789 @opindex mno-cmpb
21790 @opindex mmfpgpr
21791 @opindex mno-mfpgpr
21792 @opindex mhard-dfp
21793 @opindex mno-hard-dfp
21794 You use these options to specify which instructions are available on the
21795 processor you are using.  The default value of these options is
21796 determined when configuring GCC@.  Specifying the
21797 @option{-mcpu=@var{cpu_type}} overrides the specification of these
21798 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
21799 rather than the options listed above.
21801 Specifying @option{-mpowerpc-gpopt} allows
21802 GCC to use the optional PowerPC architecture instructions in the
21803 General Purpose group, including floating-point square root.  Specifying
21804 @option{-mpowerpc-gfxopt} allows GCC to
21805 use the optional PowerPC architecture instructions in the Graphics
21806 group, including floating-point select.
21808 The @option{-mmfcrf} option allows GCC to generate the move from
21809 condition register field instruction implemented on the POWER4
21810 processor and other processors that support the PowerPC V2.01
21811 architecture.
21812 The @option{-mpopcntb} option allows GCC to generate the popcount and
21813 double-precision FP reciprocal estimate instruction implemented on the
21814 POWER5 processor and other processors that support the PowerPC V2.02
21815 architecture.
21816 The @option{-mpopcntd} option allows GCC to generate the popcount
21817 instruction implemented on the POWER7 processor and other processors
21818 that support the PowerPC V2.06 architecture.
21819 The @option{-mfprnd} option allows GCC to generate the FP round to
21820 integer instructions implemented on the POWER5+ processor and other
21821 processors that support the PowerPC V2.03 architecture.
21822 The @option{-mcmpb} option allows GCC to generate the compare bytes
21823 instruction implemented on the POWER6 processor and other processors
21824 that support the PowerPC V2.05 architecture.
21825 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
21826 general-purpose register instructions implemented on the POWER6X
21827 processor and other processors that support the extended PowerPC V2.05
21828 architecture.
21829 The @option{-mhard-dfp} option allows GCC to generate the decimal
21830 floating-point instructions implemented on some POWER processors.
21832 The @option{-mpowerpc64} option allows GCC to generate the additional
21833 64-bit instructions that are found in the full PowerPC64 architecture
21834 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
21835 @option{-mno-powerpc64}.
21837 @item -mcpu=@var{cpu_type}
21838 @opindex mcpu
21839 Set architecture type, register usage, and
21840 instruction scheduling parameters for machine type @var{cpu_type}.
21841 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
21842 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
21843 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
21844 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
21845 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
21846 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
21847 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
21848 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
21849 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
21850 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
21851 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
21852 and @samp{rs64}.
21854 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
21855 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
21856 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
21857 architecture machine types, with an appropriate, generic processor
21858 model assumed for scheduling purposes.
21860 The other options specify a specific processor.  Code generated under
21861 those options runs best on that processor, and may not run at all on
21862 others.
21864 The @option{-mcpu} options automatically enable or disable the
21865 following options:
21867 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
21868 -mpopcntb -mpopcntd  -mpowerpc64 @gol
21869 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
21870 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
21871 -mcrypto -mdirect-move -mhtm -mpower8-fusion -mpower8-vector @gol
21872 -mquad-memory -mquad-memory-atomic -mfloat128 -mfloat128-hardware}
21874 The particular options set for any particular CPU varies between
21875 compiler versions, depending on what setting seems to produce optimal
21876 code for that CPU; it doesn't necessarily reflect the actual hardware's
21877 capabilities.  If you wish to set an individual option to a particular
21878 value, you may specify it after the @option{-mcpu} option, like
21879 @option{-mcpu=970 -mno-altivec}.
21881 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
21882 not enabled or disabled by the @option{-mcpu} option at present because
21883 AIX does not have full support for these options.  You may still
21884 enable or disable them individually if you're sure it'll work in your
21885 environment.
21887 @item -mtune=@var{cpu_type}
21888 @opindex mtune
21889 Set the instruction scheduling parameters for machine type
21890 @var{cpu_type}, but do not set the architecture type or register usage,
21891 as @option{-mcpu=@var{cpu_type}} does.  The same
21892 values for @var{cpu_type} are used for @option{-mtune} as for
21893 @option{-mcpu}.  If both are specified, the code generated uses the
21894 architecture and registers set by @option{-mcpu}, but the
21895 scheduling parameters set by @option{-mtune}.
21897 @item -mcmodel=small
21898 @opindex mcmodel=small
21899 Generate PowerPC64 code for the small model: The TOC is limited to
21900 64k.
21902 @item -mcmodel=medium
21903 @opindex mcmodel=medium
21904 Generate PowerPC64 code for the medium model: The TOC and other static
21905 data may be up to a total of 4G in size.  This is the default for 64-bit
21906 Linux.
21908 @item -mcmodel=large
21909 @opindex mcmodel=large
21910 Generate PowerPC64 code for the large model: The TOC may be up to 4G
21911 in size.  Other data and code is only limited by the 64-bit address
21912 space.
21914 @item -maltivec
21915 @itemx -mno-altivec
21916 @opindex maltivec
21917 @opindex mno-altivec
21918 Generate code that uses (does not use) AltiVec instructions, and also
21919 enable the use of built-in functions that allow more direct access to
21920 the AltiVec instruction set.  You may also need to set
21921 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
21922 enhancements.
21924 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
21925 @option{-maltivec=be}, the element order for AltiVec intrinsics such
21926 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
21927 match array element order corresponding to the endianness of the
21928 target.  That is, element zero identifies the leftmost element in a
21929 vector register when targeting a big-endian platform, and identifies
21930 the rightmost element in a vector register when targeting a
21931 little-endian platform.
21933 @item -maltivec=be
21934 @opindex maltivec=be
21935 Generate AltiVec instructions using big-endian element order,
21936 regardless of whether the target is big- or little-endian.  This is
21937 the default when targeting a big-endian platform.
21939 The element order is used to interpret element numbers in AltiVec
21940 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21941 @code{vec_insert}.  By default, these match array element order
21942 corresponding to the endianness for the target.
21944 @item -maltivec=le
21945 @opindex maltivec=le
21946 Generate AltiVec instructions using little-endian element order,
21947 regardless of whether the target is big- or little-endian.  This is
21948 the default when targeting a little-endian platform.  This option is
21949 currently ignored when targeting a big-endian platform.
21951 The element order is used to interpret element numbers in AltiVec
21952 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
21953 @code{vec_insert}.  By default, these match array element order
21954 corresponding to the endianness for the target.
21956 @item -mvrsave
21957 @itemx -mno-vrsave
21958 @opindex mvrsave
21959 @opindex mno-vrsave
21960 Generate VRSAVE instructions when generating AltiVec code.
21962 @item -msecure-plt
21963 @opindex msecure-plt
21964 Generate code that allows @command{ld} and @command{ld.so}
21965 to build executables and shared
21966 libraries with non-executable @code{.plt} and @code{.got} sections.
21967 This is a PowerPC
21968 32-bit SYSV ABI option.
21970 @item -mbss-plt
21971 @opindex mbss-plt
21972 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
21973 fills in, and
21974 requires @code{.plt} and @code{.got}
21975 sections that are both writable and executable.
21976 This is a PowerPC 32-bit SYSV ABI option.
21978 @item -misel
21979 @itemx -mno-isel
21980 @opindex misel
21981 @opindex mno-isel
21982 This switch enables or disables the generation of ISEL instructions.
21984 @item -misel=@var{yes/no}
21985 This switch has been deprecated.  Use @option{-misel} and
21986 @option{-mno-isel} instead.
21988 @item -mspe
21989 @itemx -mno-spe
21990 @opindex mspe
21991 @opindex mno-spe
21992 This switch enables or disables the generation of SPE simd
21993 instructions.
21995 @item -mpaired
21996 @itemx -mno-paired
21997 @opindex mpaired
21998 @opindex mno-paired
21999 This switch enables or disables the generation of PAIRED simd
22000 instructions.
22002 @item -mspe=@var{yes/no}
22003 This option has been deprecated.  Use @option{-mspe} and
22004 @option{-mno-spe} instead.
22006 @item -mvsx
22007 @itemx -mno-vsx
22008 @opindex mvsx
22009 @opindex mno-vsx
22010 Generate code that uses (does not use) vector/scalar (VSX)
22011 instructions, and also enable the use of built-in functions that allow
22012 more direct access to the VSX instruction set.
22014 @item -mcrypto
22015 @itemx -mno-crypto
22016 @opindex mcrypto
22017 @opindex mno-crypto
22018 Enable the use (disable) of the built-in functions that allow direct
22019 access to the cryptographic instructions that were added in version
22020 2.07 of the PowerPC ISA.
22022 @item -mdirect-move
22023 @itemx -mno-direct-move
22024 @opindex mdirect-move
22025 @opindex mno-direct-move
22026 Generate code that uses (does not use) the instructions to move data
22027 between the general purpose registers and the vector/scalar (VSX)
22028 registers that were added in version 2.07 of the PowerPC ISA.
22030 @item -mhtm
22031 @itemx -mno-htm
22032 @opindex mhtm
22033 @opindex mno-htm
22034 Enable (disable) the use of the built-in functions that allow direct
22035 access to the Hardware Transactional Memory (HTM) instructions that
22036 were added in version 2.07 of the PowerPC ISA.
22038 @item -mpower8-fusion
22039 @itemx -mno-power8-fusion
22040 @opindex mpower8-fusion
22041 @opindex mno-power8-fusion
22042 Generate code that keeps (does not keeps) some integer operations
22043 adjacent so that the instructions can be fused together on power8 and
22044 later processors.
22046 @item -mpower8-vector
22047 @itemx -mno-power8-vector
22048 @opindex mpower8-vector
22049 @opindex mno-power8-vector
22050 Generate code that uses (does not use) the vector and scalar
22051 instructions that were added in version 2.07 of the PowerPC ISA.  Also
22052 enable the use of built-in functions that allow more direct access to
22053 the vector instructions.
22055 @item -mquad-memory
22056 @itemx -mno-quad-memory
22057 @opindex mquad-memory
22058 @opindex mno-quad-memory
22059 Generate code that uses (does not use) the non-atomic quad word memory
22060 instructions.  The @option{-mquad-memory} option requires use of
22061 64-bit mode.
22063 @item -mquad-memory-atomic
22064 @itemx -mno-quad-memory-atomic
22065 @opindex mquad-memory-atomic
22066 @opindex mno-quad-memory-atomic
22067 Generate code that uses (does not use) the atomic quad word memory
22068 instructions.  The @option{-mquad-memory-atomic} option requires use of
22069 64-bit mode.
22071 @item -mfloat128
22072 @itemx -mno-float128
22073 @opindex mfloat128
22074 @opindex mno-float128
22075 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
22076 and use either software emulation for IEEE 128-bit floating point or
22077 hardware instructions.
22079 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7},
22080 @option{-mcpu=power8}), or @option{-mcpu=power9} must be enabled to
22081 use the IEEE 128-bit floating point support.  The IEEE 128-bit
22082 floating point support only works on PowerPC Linux systems.
22084 The default for @option{-mfloat128} is enabled on PowerPC Linux
22085 systems using the VSX instruction set, and disabled on other systems.
22087 If you use the ISA 3.0 instruction set (@option{-mpower9-vector} or
22088 @option{-mcpu=power9}) on a 64-bit system, the IEEE 128-bit floating
22089 point support will also enable the generation of ISA 3.0 IEEE 128-bit
22090 floating point instructions.  Otherwise, if you do not specify to
22091 generate ISA 3.0 instructions or you are targeting a 32-bit big endian
22092 system, IEEE 128-bit floating point will be done with software
22093 emulation.
22095 @item -mfloat128-hardware
22096 @itemx -mno-float128-hardware
22097 @opindex mfloat128-hardware
22098 @opindex mno-float128-hardware
22099 Enable/disable using ISA 3.0 hardware instructions to support the
22100 @var{__float128} data type.
22102 The default for @option{-mfloat128-hardware} is enabled on PowerPC
22103 Linux systems using the ISA 3.0 instruction set, and disabled on other
22104 systems.
22106 @item -mfloat-gprs=@var{yes/single/double/no}
22107 @itemx -mfloat-gprs
22108 @opindex mfloat-gprs
22109 This switch enables or disables the generation of floating-point
22110 operations on the general-purpose registers for architectures that
22111 support it.
22113 The argument @samp{yes} or @samp{single} enables the use of
22114 single-precision floating-point operations.
22116 The argument @samp{double} enables the use of single and
22117 double-precision floating-point operations.
22119 The argument @samp{no} disables floating-point operations on the
22120 general-purpose registers.
22122 This option is currently only available on the MPC854x.
22124 @item -m32
22125 @itemx -m64
22126 @opindex m32
22127 @opindex m64
22128 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
22129 targets (including GNU/Linux).  The 32-bit environment sets int, long
22130 and pointer to 32 bits and generates code that runs on any PowerPC
22131 variant.  The 64-bit environment sets int to 32 bits and long and
22132 pointer to 64 bits, and generates code for PowerPC64, as for
22133 @option{-mpowerpc64}.
22135 @item -mfull-toc
22136 @itemx -mno-fp-in-toc
22137 @itemx -mno-sum-in-toc
22138 @itemx -mminimal-toc
22139 @opindex mfull-toc
22140 @opindex mno-fp-in-toc
22141 @opindex mno-sum-in-toc
22142 @opindex mminimal-toc
22143 Modify generation of the TOC (Table Of Contents), which is created for
22144 every executable file.  The @option{-mfull-toc} option is selected by
22145 default.  In that case, GCC allocates at least one TOC entry for
22146 each unique non-automatic variable reference in your program.  GCC
22147 also places floating-point constants in the TOC@.  However, only
22148 16,384 entries are available in the TOC@.
22150 If you receive a linker error message that saying you have overflowed
22151 the available TOC space, you can reduce the amount of TOC space used
22152 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
22153 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
22154 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
22155 generate code to calculate the sum of an address and a constant at
22156 run time instead of putting that sum into the TOC@.  You may specify one
22157 or both of these options.  Each causes GCC to produce very slightly
22158 slower and larger code at the expense of conserving TOC space.
22160 If you still run out of space in the TOC even when you specify both of
22161 these options, specify @option{-mminimal-toc} instead.  This option causes
22162 GCC to make only one TOC entry for every file.  When you specify this
22163 option, GCC produces code that is slower and larger but which
22164 uses extremely little TOC space.  You may wish to use this option
22165 only on files that contain less frequently-executed code.
22167 @item -maix64
22168 @itemx -maix32
22169 @opindex maix64
22170 @opindex maix32
22171 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
22172 @code{long} type, and the infrastructure needed to support them.
22173 Specifying @option{-maix64} implies @option{-mpowerpc64},
22174 while @option{-maix32} disables the 64-bit ABI and
22175 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
22177 @item -mxl-compat
22178 @itemx -mno-xl-compat
22179 @opindex mxl-compat
22180 @opindex mno-xl-compat
22181 Produce code that conforms more closely to IBM XL compiler semantics
22182 when using AIX-compatible ABI@.  Pass floating-point arguments to
22183 prototyped functions beyond the register save area (RSA) on the stack
22184 in addition to argument FPRs.  Do not assume that most significant
22185 double in 128-bit long double value is properly rounded when comparing
22186 values and converting to double.  Use XL symbol names for long double
22187 support routines.
22189 The AIX calling convention was extended but not initially documented to
22190 handle an obscure K&R C case of calling a function that takes the
22191 address of its arguments with fewer arguments than declared.  IBM XL
22192 compilers access floating-point arguments that do not fit in the
22193 RSA from the stack when a subroutine is compiled without
22194 optimization.  Because always storing floating-point arguments on the
22195 stack is inefficient and rarely needed, this option is not enabled by
22196 default and only is necessary when calling subroutines compiled by IBM
22197 XL compilers without optimization.
22199 @item -mpe
22200 @opindex mpe
22201 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
22202 application written to use message passing with special startup code to
22203 enable the application to run.  The system must have PE installed in the
22204 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
22205 must be overridden with the @option{-specs=} option to specify the
22206 appropriate directory location.  The Parallel Environment does not
22207 support threads, so the @option{-mpe} option and the @option{-pthread}
22208 option are incompatible.
22210 @item -malign-natural
22211 @itemx -malign-power
22212 @opindex malign-natural
22213 @opindex malign-power
22214 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
22215 @option{-malign-natural} overrides the ABI-defined alignment of larger
22216 types, such as floating-point doubles, on their natural size-based boundary.
22217 The option @option{-malign-power} instructs GCC to follow the ABI-specified
22218 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
22220 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
22221 is not supported.
22223 @item -msoft-float
22224 @itemx -mhard-float
22225 @opindex msoft-float
22226 @opindex mhard-float
22227 Generate code that does not use (uses) the floating-point register set.
22228 Software floating-point emulation is provided if you use the
22229 @option{-msoft-float} option, and pass the option to GCC when linking.
22231 @item -msingle-float
22232 @itemx -mdouble-float
22233 @opindex msingle-float
22234 @opindex mdouble-float
22235 Generate code for single- or double-precision floating-point operations.
22236 @option{-mdouble-float} implies @option{-msingle-float}.
22238 @item -msimple-fpu
22239 @opindex msimple-fpu
22240 Do not generate @code{sqrt} and @code{div} instructions for hardware
22241 floating-point unit.
22243 @item -mfpu=@var{name}
22244 @opindex mfpu
22245 Specify type of floating-point unit.  Valid values for @var{name} are
22246 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
22247 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
22248 @samp{sp_full} (equivalent to @option{-msingle-float}),
22249 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
22251 @item -mxilinx-fpu
22252 @opindex mxilinx-fpu
22253 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
22255 @item -mmultiple
22256 @itemx -mno-multiple
22257 @opindex mmultiple
22258 @opindex mno-multiple
22259 Generate code that uses (does not use) the load multiple word
22260 instructions and the store multiple word instructions.  These
22261 instructions are generated by default on POWER systems, and not
22262 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
22263 PowerPC systems, since those instructions do not work when the
22264 processor is in little-endian mode.  The exceptions are PPC740 and
22265 PPC750 which permit these instructions in little-endian mode.
22267 @item -mstring
22268 @itemx -mno-string
22269 @opindex mstring
22270 @opindex mno-string
22271 Generate code that uses (does not use) the load string instructions
22272 and the store string word instructions to save multiple registers and
22273 do small block moves.  These instructions are generated by default on
22274 POWER systems, and not generated on PowerPC systems.  Do not use
22275 @option{-mstring} on little-endian PowerPC systems, since those
22276 instructions do not work when the processor is in little-endian mode.
22277 The exceptions are PPC740 and PPC750 which permit these instructions
22278 in little-endian mode.
22280 @item -mupdate
22281 @itemx -mno-update
22282 @opindex mupdate
22283 @opindex mno-update
22284 Generate code that uses (does not use) the load or store instructions
22285 that update the base register to the address of the calculated memory
22286 location.  These instructions are generated by default.  If you use
22287 @option{-mno-update}, there is a small window between the time that the
22288 stack pointer is updated and the address of the previous frame is
22289 stored, which means code that walks the stack frame across interrupts or
22290 signals may get corrupted data.
22292 @item -mavoid-indexed-addresses
22293 @itemx -mno-avoid-indexed-addresses
22294 @opindex mavoid-indexed-addresses
22295 @opindex mno-avoid-indexed-addresses
22296 Generate code that tries to avoid (not avoid) the use of indexed load
22297 or store instructions. These instructions can incur a performance
22298 penalty on Power6 processors in certain situations, such as when
22299 stepping through large arrays that cross a 16M boundary.  This option
22300 is enabled by default when targeting Power6 and disabled otherwise.
22302 @item -mfused-madd
22303 @itemx -mno-fused-madd
22304 @opindex mfused-madd
22305 @opindex mno-fused-madd
22306 Generate code that uses (does not use) the floating-point multiply and
22307 accumulate instructions.  These instructions are generated by default
22308 if hardware floating point is used.  The machine-dependent
22309 @option{-mfused-madd} option is now mapped to the machine-independent
22310 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
22311 mapped to @option{-ffp-contract=off}.
22313 @item -mmulhw
22314 @itemx -mno-mulhw
22315 @opindex mmulhw
22316 @opindex mno-mulhw
22317 Generate code that uses (does not use) the half-word multiply and
22318 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
22319 These instructions are generated by default when targeting those
22320 processors.
22322 @item -mdlmzb
22323 @itemx -mno-dlmzb
22324 @opindex mdlmzb
22325 @opindex mno-dlmzb
22326 Generate code that uses (does not use) the string-search @samp{dlmzb}
22327 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
22328 generated by default when targeting those processors.
22330 @item -mno-bit-align
22331 @itemx -mbit-align
22332 @opindex mno-bit-align
22333 @opindex mbit-align
22334 On System V.4 and embedded PowerPC systems do not (do) force structures
22335 and unions that contain bit-fields to be aligned to the base type of the
22336 bit-field.
22338 For example, by default a structure containing nothing but 8
22339 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
22340 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
22341 the structure is aligned to a 1-byte boundary and is 1 byte in
22342 size.
22344 @item -mno-strict-align
22345 @itemx -mstrict-align
22346 @opindex mno-strict-align
22347 @opindex mstrict-align
22348 On System V.4 and embedded PowerPC systems do not (do) assume that
22349 unaligned memory references are handled by the system.
22351 @item -mrelocatable
22352 @itemx -mno-relocatable
22353 @opindex mrelocatable
22354 @opindex mno-relocatable
22355 Generate code that allows (does not allow) a static executable to be
22356 relocated to a different address at run time.  A simple embedded
22357 PowerPC system loader should relocate the entire contents of
22358 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
22359 a table of 32-bit addresses generated by this option.  For this to
22360 work, all objects linked together must be compiled with
22361 @option{-mrelocatable} or @option{-mrelocatable-lib}.
22362 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
22364 @item -mrelocatable-lib
22365 @itemx -mno-relocatable-lib
22366 @opindex mrelocatable-lib
22367 @opindex mno-relocatable-lib
22368 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
22369 @code{.fixup} section to allow static executables to be relocated at
22370 run time, but @option{-mrelocatable-lib} does not use the smaller stack
22371 alignment of @option{-mrelocatable}.  Objects compiled with
22372 @option{-mrelocatable-lib} may be linked with objects compiled with
22373 any combination of the @option{-mrelocatable} options.
22375 @item -mno-toc
22376 @itemx -mtoc
22377 @opindex mno-toc
22378 @opindex mtoc
22379 On System V.4 and embedded PowerPC systems do not (do) assume that
22380 register 2 contains a pointer to a global area pointing to the addresses
22381 used in the program.
22383 @item -mlittle
22384 @itemx -mlittle-endian
22385 @opindex mlittle
22386 @opindex mlittle-endian
22387 On System V.4 and embedded PowerPC systems compile code for the
22388 processor in little-endian mode.  The @option{-mlittle-endian} option is
22389 the same as @option{-mlittle}.
22391 @item -mbig
22392 @itemx -mbig-endian
22393 @opindex mbig
22394 @opindex mbig-endian
22395 On System V.4 and embedded PowerPC systems compile code for the
22396 processor in big-endian mode.  The @option{-mbig-endian} option is
22397 the same as @option{-mbig}.
22399 @item -mdynamic-no-pic
22400 @opindex mdynamic-no-pic
22401 On Darwin and Mac OS X systems, compile code so that it is not
22402 relocatable, but that its external references are relocatable.  The
22403 resulting code is suitable for applications, but not shared
22404 libraries.
22406 @item -msingle-pic-base
22407 @opindex msingle-pic-base
22408 Treat the register used for PIC addressing as read-only, rather than
22409 loading it in the prologue for each function.  The runtime system is
22410 responsible for initializing this register with an appropriate value
22411 before execution begins.
22413 @item -mprioritize-restricted-insns=@var{priority}
22414 @opindex mprioritize-restricted-insns
22415 This option controls the priority that is assigned to
22416 dispatch-slot restricted instructions during the second scheduling
22417 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
22418 or @samp{2} to assign no, highest, or second-highest (respectively) 
22419 priority to dispatch-slot restricted
22420 instructions.
22422 @item -msched-costly-dep=@var{dependence_type}
22423 @opindex msched-costly-dep
22424 This option controls which dependences are considered costly
22425 by the target during instruction scheduling.  The argument
22426 @var{dependence_type} takes one of the following values:
22428 @table @asis
22429 @item @samp{no}
22430 No dependence is costly.
22432 @item @samp{all}
22433 All dependences are costly.
22435 @item @samp{true_store_to_load}
22436 A true dependence from store to load is costly.
22438 @item @samp{store_to_load}
22439 Any dependence from store to load is costly.
22441 @item @var{number}
22442 Any dependence for which the latency is greater than or equal to 
22443 @var{number} is costly.
22444 @end table
22446 @item -minsert-sched-nops=@var{scheme}
22447 @opindex minsert-sched-nops
22448 This option controls which NOP insertion scheme is used during
22449 the second scheduling pass.  The argument @var{scheme} takes one of the
22450 following values:
22452 @table @asis
22453 @item @samp{no}
22454 Don't insert NOPs.
22456 @item @samp{pad}
22457 Pad with NOPs any dispatch group that has vacant issue slots,
22458 according to the scheduler's grouping.
22460 @item @samp{regroup_exact}
22461 Insert NOPs to force costly dependent insns into
22462 separate groups.  Insert exactly as many NOPs as needed to force an insn
22463 to a new group, according to the estimated processor grouping.
22465 @item @var{number}
22466 Insert NOPs to force costly dependent insns into
22467 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
22468 @end table
22470 @item -mcall-sysv
22471 @opindex mcall-sysv
22472 On System V.4 and embedded PowerPC systems compile code using calling
22473 conventions that adhere to the March 1995 draft of the System V
22474 Application Binary Interface, PowerPC processor supplement.  This is the
22475 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
22477 @item -mcall-sysv-eabi
22478 @itemx -mcall-eabi
22479 @opindex mcall-sysv-eabi
22480 @opindex mcall-eabi
22481 Specify both @option{-mcall-sysv} and @option{-meabi} options.
22483 @item -mcall-sysv-noeabi
22484 @opindex mcall-sysv-noeabi
22485 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
22487 @item -mcall-aixdesc
22488 @opindex m
22489 On System V.4 and embedded PowerPC systems compile code for the AIX
22490 operating system.
22492 @item -mcall-linux
22493 @opindex mcall-linux
22494 On System V.4 and embedded PowerPC systems compile code for the
22495 Linux-based GNU system.
22497 @item -mcall-freebsd
22498 @opindex mcall-freebsd
22499 On System V.4 and embedded PowerPC systems compile code for the
22500 FreeBSD operating system.
22502 @item -mcall-netbsd
22503 @opindex mcall-netbsd
22504 On System V.4 and embedded PowerPC systems compile code for the
22505 NetBSD operating system.
22507 @item -mcall-openbsd
22508 @opindex mcall-netbsd
22509 On System V.4 and embedded PowerPC systems compile code for the
22510 OpenBSD operating system.
22512 @item -maix-struct-return
22513 @opindex maix-struct-return
22514 Return all structures in memory (as specified by the AIX ABI)@.
22516 @item -msvr4-struct-return
22517 @opindex msvr4-struct-return
22518 Return structures smaller than 8 bytes in registers (as specified by the
22519 SVR4 ABI)@.
22521 @item -mabi=@var{abi-type}
22522 @opindex mabi
22523 Extend the current ABI with a particular extension, or remove such extension.
22524 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
22525 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
22526 @samp{elfv1}, @samp{elfv2}@.
22528 @item -mabi=spe
22529 @opindex mabi=spe
22530 Extend the current ABI with SPE ABI extensions.  This does not change
22531 the default ABI, instead it adds the SPE ABI extensions to the current
22532 ABI@.
22534 @item -mabi=no-spe
22535 @opindex mabi=no-spe
22536 Disable Book-E SPE ABI extensions for the current ABI@.
22538 @item -mabi=ibmlongdouble
22539 @opindex mabi=ibmlongdouble
22540 Change the current ABI to use IBM extended-precision long double.
22541 This is a PowerPC 32-bit SYSV ABI option.
22543 @item -mabi=ieeelongdouble
22544 @opindex mabi=ieeelongdouble
22545 Change the current ABI to use IEEE extended-precision long double.
22546 This is a PowerPC 32-bit Linux ABI option.
22548 @item -mabi=elfv1
22549 @opindex mabi=elfv1
22550 Change the current ABI to use the ELFv1 ABI.
22551 This is the default ABI for big-endian PowerPC 64-bit Linux.
22552 Overriding the default ABI requires special system support and is
22553 likely to fail in spectacular ways.
22555 @item -mabi=elfv2
22556 @opindex mabi=elfv2
22557 Change the current ABI to use the ELFv2 ABI.
22558 This is the default ABI for little-endian PowerPC 64-bit Linux.
22559 Overriding the default ABI requires special system support and is
22560 likely to fail in spectacular ways.
22562 @item -mgnu-attribute
22563 @itemx -mno-gnu-attribute
22564 @opindex mgnu-attribute
22565 @opindex mno-gnu-attribute
22566 Emit .gnu_attribute assembly directives to set tag/value pairs in a
22567 .gnu.attributes section that specify ABI variations in function
22568 parameters or return values.
22570 @item -mprototype
22571 @itemx -mno-prototype
22572 @opindex mprototype
22573 @opindex mno-prototype
22574 On System V.4 and embedded PowerPC systems assume that all calls to
22575 variable argument functions are properly prototyped.  Otherwise, the
22576 compiler must insert an instruction before every non-prototyped call to
22577 set or clear bit 6 of the condition code register (@code{CR}) to
22578 indicate whether floating-point values are passed in the floating-point
22579 registers in case the function takes variable arguments.  With
22580 @option{-mprototype}, only calls to prototyped variable argument functions
22581 set or clear the bit.
22583 @item -msim
22584 @opindex msim
22585 On embedded PowerPC systems, assume that the startup module is called
22586 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
22587 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
22588 configurations.
22590 @item -mmvme
22591 @opindex mmvme
22592 On embedded PowerPC systems, assume that the startup module is called
22593 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
22594 @file{libc.a}.
22596 @item -mads
22597 @opindex mads
22598 On embedded PowerPC systems, assume that the startup module is called
22599 @file{crt0.o} and the standard C libraries are @file{libads.a} and
22600 @file{libc.a}.
22602 @item -myellowknife
22603 @opindex myellowknife
22604 On embedded PowerPC systems, assume that the startup module is called
22605 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
22606 @file{libc.a}.
22608 @item -mvxworks
22609 @opindex mvxworks
22610 On System V.4 and embedded PowerPC systems, specify that you are
22611 compiling for a VxWorks system.
22613 @item -memb
22614 @opindex memb
22615 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
22616 header to indicate that @samp{eabi} extended relocations are used.
22618 @item -meabi
22619 @itemx -mno-eabi
22620 @opindex meabi
22621 @opindex mno-eabi
22622 On System V.4 and embedded PowerPC systems do (do not) adhere to the
22623 Embedded Applications Binary Interface (EABI), which is a set of
22624 modifications to the System V.4 specifications.  Selecting @option{-meabi}
22625 means that the stack is aligned to an 8-byte boundary, a function
22626 @code{__eabi} is called from @code{main} to set up the EABI
22627 environment, and the @option{-msdata} option can use both @code{r2} and
22628 @code{r13} to point to two separate small data areas.  Selecting
22629 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
22630 no EABI initialization function is called from @code{main}, and the
22631 @option{-msdata} option only uses @code{r13} to point to a single
22632 small data area.  The @option{-meabi} option is on by default if you
22633 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
22635 @item -msdata=eabi
22636 @opindex msdata=eabi
22637 On System V.4 and embedded PowerPC systems, put small initialized
22638 @code{const} global and static data in the @code{.sdata2} section, which
22639 is pointed to by register @code{r2}.  Put small initialized
22640 non-@code{const} global and static data in the @code{.sdata} section,
22641 which is pointed to by register @code{r13}.  Put small uninitialized
22642 global and static data in the @code{.sbss} section, which is adjacent to
22643 the @code{.sdata} section.  The @option{-msdata=eabi} option is
22644 incompatible with the @option{-mrelocatable} option.  The
22645 @option{-msdata=eabi} option also sets the @option{-memb} option.
22647 @item -msdata=sysv
22648 @opindex msdata=sysv
22649 On System V.4 and embedded PowerPC systems, put small global and static
22650 data in the @code{.sdata} section, which is pointed to by register
22651 @code{r13}.  Put small uninitialized global and static data in the
22652 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
22653 The @option{-msdata=sysv} option is incompatible with the
22654 @option{-mrelocatable} option.
22656 @item -msdata=default
22657 @itemx -msdata
22658 @opindex msdata=default
22659 @opindex msdata
22660 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
22661 compile code the same as @option{-msdata=eabi}, otherwise compile code the
22662 same as @option{-msdata=sysv}.
22664 @item -msdata=data
22665 @opindex msdata=data
22666 On System V.4 and embedded PowerPC systems, put small global
22667 data in the @code{.sdata} section.  Put small uninitialized global
22668 data in the @code{.sbss} section.  Do not use register @code{r13}
22669 to address small data however.  This is the default behavior unless
22670 other @option{-msdata} options are used.
22672 @item -msdata=none
22673 @itemx -mno-sdata
22674 @opindex msdata=none
22675 @opindex mno-sdata
22676 On embedded PowerPC systems, put all initialized global and static data
22677 in the @code{.data} section, and all uninitialized data in the
22678 @code{.bss} section.
22680 @item -mblock-move-inline-limit=@var{num}
22681 @opindex mblock-move-inline-limit
22682 Inline all block moves (such as calls to @code{memcpy} or structure
22683 copies) less than or equal to @var{num} bytes.  The minimum value for
22684 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
22685 targets.  The default value is target-specific.
22687 @item -G @var{num}
22688 @opindex G
22689 @cindex smaller data references (PowerPC)
22690 @cindex .sdata/.sdata2 references (PowerPC)
22691 On embedded PowerPC systems, put global and static items less than or
22692 equal to @var{num} bytes into the small data or BSS sections instead of
22693 the normal data or BSS section.  By default, @var{num} is 8.  The
22694 @option{-G @var{num}} switch is also passed to the linker.
22695 All modules should be compiled with the same @option{-G @var{num}} value.
22697 @item -mregnames
22698 @itemx -mno-regnames
22699 @opindex mregnames
22700 @opindex mno-regnames
22701 On System V.4 and embedded PowerPC systems do (do not) emit register
22702 names in the assembly language output using symbolic forms.
22704 @item -mlongcall
22705 @itemx -mno-longcall
22706 @opindex mlongcall
22707 @opindex mno-longcall
22708 By default assume that all calls are far away so that a longer and more
22709 expensive calling sequence is required.  This is required for calls
22710 farther than 32 megabytes (33,554,432 bytes) from the current location.
22711 A short call is generated if the compiler knows
22712 the call cannot be that far away.  This setting can be overridden by
22713 the @code{shortcall} function attribute, or by @code{#pragma
22714 longcall(0)}.
22716 Some linkers are capable of detecting out-of-range calls and generating
22717 glue code on the fly.  On these systems, long calls are unnecessary and
22718 generate slower code.  As of this writing, the AIX linker can do this,
22719 as can the GNU linker for PowerPC/64.  It is planned to add this feature
22720 to the GNU linker for 32-bit PowerPC systems as well.
22722 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
22723 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
22724 addresses represent the callee and the branch island.  The
22725 Darwin/PPC linker prefers the first address and generates a @code{bl
22726 callee} if the PPC @code{bl} instruction reaches the callee directly;
22727 otherwise, the linker generates @code{bl L42} to call the branch
22728 island.  The branch island is appended to the body of the
22729 calling function; it computes the full 32-bit address of the callee
22730 and jumps to it.
22732 On Mach-O (Darwin) systems, this option directs the compiler emit to
22733 the glue for every direct call, and the Darwin linker decides whether
22734 to use or discard it.
22736 In the future, GCC may ignore all longcall specifications
22737 when the linker is known to generate glue.
22739 @item -mtls-markers
22740 @itemx -mno-tls-markers
22741 @opindex mtls-markers
22742 @opindex mno-tls-markers
22743 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
22744 specifying the function argument.  The relocation allows the linker to
22745 reliably associate function call with argument setup instructions for
22746 TLS optimization, which in turn allows GCC to better schedule the
22747 sequence.
22749 @item -mrecip
22750 @itemx -mno-recip
22751 @opindex mrecip
22752 This option enables use of the reciprocal estimate and
22753 reciprocal square root estimate instructions with additional
22754 Newton-Raphson steps to increase precision instead of doing a divide or
22755 square root and divide for floating-point arguments.  You should use
22756 the @option{-ffast-math} option when using @option{-mrecip} (or at
22757 least @option{-funsafe-math-optimizations},
22758 @option{-ffinite-math-only}, @option{-freciprocal-math} and
22759 @option{-fno-trapping-math}).  Note that while the throughput of the
22760 sequence is generally higher than the throughput of the non-reciprocal
22761 instruction, the precision of the sequence can be decreased by up to 2
22762 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
22763 roots.
22765 @item -mrecip=@var{opt}
22766 @opindex mrecip=opt
22767 This option controls which reciprocal estimate instructions
22768 may be used.  @var{opt} is a comma-separated list of options, which may
22769 be preceded by a @code{!} to invert the option:
22771 @table @samp
22773 @item all
22774 Enable all estimate instructions.
22776 @item default 
22777 Enable the default instructions, equivalent to @option{-mrecip}.
22779 @item none 
22780 Disable all estimate instructions, equivalent to @option{-mno-recip}.
22782 @item div 
22783 Enable the reciprocal approximation instructions for both 
22784 single and double precision.
22786 @item divf 
22787 Enable the single-precision reciprocal approximation instructions.
22789 @item divd 
22790 Enable the double-precision reciprocal approximation instructions.
22792 @item rsqrt 
22793 Enable the reciprocal square root approximation instructions for both
22794 single and double precision.
22796 @item rsqrtf 
22797 Enable the single-precision reciprocal square root approximation instructions.
22799 @item rsqrtd 
22800 Enable the double-precision reciprocal square root approximation instructions.
22802 @end table
22804 So, for example, @option{-mrecip=all,!rsqrtd} enables
22805 all of the reciprocal estimate instructions, except for the
22806 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
22807 which handle the double-precision reciprocal square root calculations.
22809 @item -mrecip-precision
22810 @itemx -mno-recip-precision
22811 @opindex mrecip-precision
22812 Assume (do not assume) that the reciprocal estimate instructions
22813 provide higher-precision estimates than is mandated by the PowerPC
22814 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
22815 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
22816 The double-precision square root estimate instructions are not generated by
22817 default on low-precision machines, since they do not provide an
22818 estimate that converges after three steps.
22820 @item -mveclibabi=@var{type}
22821 @opindex mveclibabi
22822 Specifies the ABI type to use for vectorizing intrinsics using an
22823 external library.  The only type supported at present is @samp{mass},
22824 which specifies to use IBM's Mathematical Acceleration Subsystem
22825 (MASS) libraries for vectorizing intrinsics using external libraries.
22826 GCC currently emits calls to @code{acosd2}, @code{acosf4},
22827 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
22828 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
22829 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
22830 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
22831 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
22832 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
22833 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
22834 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
22835 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
22836 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
22837 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
22838 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
22839 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
22840 for power7.  Both @option{-ftree-vectorize} and
22841 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
22842 libraries must be specified at link time.
22844 @item -mfriz
22845 @itemx -mno-friz
22846 @opindex mfriz
22847 Generate (do not generate) the @code{friz} instruction when the
22848 @option{-funsafe-math-optimizations} option is used to optimize
22849 rounding of floating-point values to 64-bit integer and back to floating
22850 point.  The @code{friz} instruction does not return the same value if
22851 the floating-point number is too large to fit in an integer.
22853 @item -mpointers-to-nested-functions
22854 @itemx -mno-pointers-to-nested-functions
22855 @opindex mpointers-to-nested-functions
22856 Generate (do not generate) code to load up the static chain register
22857 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
22858 systems where a function pointer points to a 3-word descriptor giving
22859 the function address, TOC value to be loaded in register @code{r2}, and
22860 static chain value to be loaded in register @code{r11}.  The
22861 @option{-mpointers-to-nested-functions} is on by default.  You cannot
22862 call through pointers to nested functions or pointers
22863 to functions compiled in other languages that use the static chain if
22864 you use @option{-mno-pointers-to-nested-functions}.
22866 @item -msave-toc-indirect
22867 @itemx -mno-save-toc-indirect
22868 @opindex msave-toc-indirect
22869 Generate (do not generate) code to save the TOC value in the reserved
22870 stack location in the function prologue if the function calls through
22871 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
22872 saved in the prologue, it is saved just before the call through the
22873 pointer.  The @option{-mno-save-toc-indirect} option is the default.
22875 @item -mcompat-align-parm
22876 @itemx -mno-compat-align-parm
22877 @opindex mcompat-align-parm
22878 Generate (do not generate) code to pass structure parameters with a
22879 maximum alignment of 64 bits, for compatibility with older versions
22880 of GCC.
22882 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
22883 structure parameter on a 128-bit boundary when that structure contained
22884 a member requiring 128-bit alignment.  This is corrected in more
22885 recent versions of GCC.  This option may be used to generate code
22886 that is compatible with functions compiled with older versions of
22887 GCC.
22889 The @option{-mno-compat-align-parm} option is the default.
22891 @item -mstack-protector-guard=@var{guard}
22892 @itemx -mstack-protector-guard-reg=@var{reg}
22893 @itemx -mstack-protector-guard-offset=@var{offset}
22894 @itemx -mstack-protector-guard-symbol=@var{symbol}
22895 @opindex mstack-protector-guard
22896 @opindex mstack-protector-guard-reg
22897 @opindex mstack-protector-guard-offset
22898 @opindex mstack-protector-guard-symbol
22899 Generate stack protection code using canary at @var{guard}.  Supported
22900 locations are @samp{global} for global canary or @samp{tls} for per-thread
22901 canary in the TLS block (the default with GNU libc version 2.4 or later).
22903 With the latter choice the options
22904 @option{-mstack-protector-guard-reg=@var{reg}} and
22905 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
22906 which register to use as base register for reading the canary, and from what
22907 offset from that base register. The default for those is as specified in the
22908 relevant ABI.  @option{-mstack-protector-guard-symbol=@var{symbol}} overrides
22909 the offset with a symbol reference to a canary in the TLS block.
22910 @end table
22912 @node RX Options
22913 @subsection RX Options
22914 @cindex RX Options
22916 These command-line options are defined for RX targets:
22918 @table @gcctabopt
22919 @item -m64bit-doubles
22920 @itemx -m32bit-doubles
22921 @opindex m64bit-doubles
22922 @opindex m32bit-doubles
22923 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
22924 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
22925 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
22926 works on 32-bit values, which is why the default is
22927 @option{-m32bit-doubles}.
22929 @item -fpu
22930 @itemx -nofpu
22931 @opindex fpu
22932 @opindex nofpu
22933 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
22934 floating-point hardware.  The default is enabled for the RX600
22935 series and disabled for the RX200 series.
22937 Floating-point instructions are only generated for 32-bit floating-point 
22938 values, however, so the FPU hardware is not used for doubles if the
22939 @option{-m64bit-doubles} option is used.
22941 @emph{Note} If the @option{-fpu} option is enabled then
22942 @option{-funsafe-math-optimizations} is also enabled automatically.
22943 This is because the RX FPU instructions are themselves unsafe.
22945 @item -mcpu=@var{name}
22946 @opindex mcpu
22947 Selects the type of RX CPU to be targeted.  Currently three types are
22948 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
22949 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
22951 The only difference between @samp{RX600} and @samp{RX610} is that the
22952 @samp{RX610} does not support the @code{MVTIPL} instruction.
22954 The @samp{RX200} series does not have a hardware floating-point unit
22955 and so @option{-nofpu} is enabled by default when this type is
22956 selected.
22958 @item -mbig-endian-data
22959 @itemx -mlittle-endian-data
22960 @opindex mbig-endian-data
22961 @opindex mlittle-endian-data
22962 Store data (but not code) in the big-endian format.  The default is
22963 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
22964 format.
22966 @item -msmall-data-limit=@var{N}
22967 @opindex msmall-data-limit
22968 Specifies the maximum size in bytes of global and static variables
22969 which can be placed into the small data area.  Using the small data
22970 area can lead to smaller and faster code, but the size of area is
22971 limited and it is up to the programmer to ensure that the area does
22972 not overflow.  Also when the small data area is used one of the RX's
22973 registers (usually @code{r13}) is reserved for use pointing to this
22974 area, so it is no longer available for use by the compiler.  This
22975 could result in slower and/or larger code if variables are pushed onto
22976 the stack instead of being held in this register.
22978 Note, common variables (variables that have not been initialized) and
22979 constants are not placed into the small data area as they are assigned
22980 to other sections in the output executable.
22982 The default value is zero, which disables this feature.  Note, this
22983 feature is not enabled by default with higher optimization levels
22984 (@option{-O2} etc) because of the potentially detrimental effects of
22985 reserving a register.  It is up to the programmer to experiment and
22986 discover whether this feature is of benefit to their program.  See the
22987 description of the @option{-mpid} option for a description of how the
22988 actual register to hold the small data area pointer is chosen.
22990 @item -msim
22991 @itemx -mno-sim
22992 @opindex msim
22993 @opindex mno-sim
22994 Use the simulator runtime.  The default is to use the libgloss
22995 board-specific runtime.
22997 @item -mas100-syntax
22998 @itemx -mno-as100-syntax
22999 @opindex mas100-syntax
23000 @opindex mno-as100-syntax
23001 When generating assembler output use a syntax that is compatible with
23002 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
23003 assembler, but it has some restrictions so it is not generated by default.
23005 @item -mmax-constant-size=@var{N}
23006 @opindex mmax-constant-size
23007 Specifies the maximum size, in bytes, of a constant that can be used as
23008 an operand in a RX instruction.  Although the RX instruction set does
23009 allow constants of up to 4 bytes in length to be used in instructions,
23010 a longer value equates to a longer instruction.  Thus in some
23011 circumstances it can be beneficial to restrict the size of constants
23012 that are used in instructions.  Constants that are too big are instead
23013 placed into a constant pool and referenced via register indirection.
23015 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
23016 or 4 means that constants of any size are allowed.
23018 @item -mrelax
23019 @opindex mrelax
23020 Enable linker relaxation.  Linker relaxation is a process whereby the
23021 linker attempts to reduce the size of a program by finding shorter
23022 versions of various instructions.  Disabled by default.
23024 @item -mint-register=@var{N}
23025 @opindex mint-register
23026 Specify the number of registers to reserve for fast interrupt handler
23027 functions.  The value @var{N} can be between 0 and 4.  A value of 1
23028 means that register @code{r13} is reserved for the exclusive use
23029 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
23030 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
23031 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
23032 A value of 0, the default, does not reserve any registers.
23034 @item -msave-acc-in-interrupts
23035 @opindex msave-acc-in-interrupts
23036 Specifies that interrupt handler functions should preserve the
23037 accumulator register.  This is only necessary if normal code might use
23038 the accumulator register, for example because it performs 64-bit
23039 multiplications.  The default is to ignore the accumulator as this
23040 makes the interrupt handlers faster.
23042 @item -mpid
23043 @itemx -mno-pid
23044 @opindex mpid
23045 @opindex mno-pid
23046 Enables the generation of position independent data.  When enabled any
23047 access to constant data is done via an offset from a base address
23048 held in a register.  This allows the location of constant data to be
23049 determined at run time without requiring the executable to be
23050 relocated, which is a benefit to embedded applications with tight
23051 memory constraints.  Data that can be modified is not affected by this
23052 option.
23054 Note, using this feature reserves a register, usually @code{r13}, for
23055 the constant data base address.  This can result in slower and/or
23056 larger code, especially in complicated functions.
23058 The actual register chosen to hold the constant data base address
23059 depends upon whether the @option{-msmall-data-limit} and/or the
23060 @option{-mint-register} command-line options are enabled.  Starting
23061 with register @code{r13} and proceeding downwards, registers are
23062 allocated first to satisfy the requirements of @option{-mint-register},
23063 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
23064 is possible for the small data area register to be @code{r8} if both
23065 @option{-mint-register=4} and @option{-mpid} are specified on the
23066 command line.
23068 By default this feature is not enabled.  The default can be restored
23069 via the @option{-mno-pid} command-line option.
23071 @item -mno-warn-multiple-fast-interrupts
23072 @itemx -mwarn-multiple-fast-interrupts
23073 @opindex mno-warn-multiple-fast-interrupts
23074 @opindex mwarn-multiple-fast-interrupts
23075 Prevents GCC from issuing a warning message if it finds more than one
23076 fast interrupt handler when it is compiling a file.  The default is to
23077 issue a warning for each extra fast interrupt handler found, as the RX
23078 only supports one such interrupt.
23080 @item -mallow-string-insns
23081 @itemx -mno-allow-string-insns
23082 @opindex mallow-string-insns
23083 @opindex mno-allow-string-insns
23084 Enables or disables the use of the string manipulation instructions
23085 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
23086 @code{SWHILE} and also the @code{RMPA} instruction.  These
23087 instructions may prefetch data, which is not safe to do if accessing
23088 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
23089 for more information).
23091 The default is to allow these instructions, but it is not possible for
23092 GCC to reliably detect all circumstances where a string instruction
23093 might be used to access an I/O register, so their use cannot be
23094 disabled automatically.  Instead it is reliant upon the programmer to
23095 use the @option{-mno-allow-string-insns} option if their program
23096 accesses I/O space.
23098 When the instructions are enabled GCC defines the C preprocessor
23099 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
23100 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
23102 @item -mjsr
23103 @itemx -mno-jsr
23104 @opindex mjsr
23105 @opindex mno-jsr
23106 Use only (or not only) @code{JSR} instructions to access functions.
23107 This option can be used when code size exceeds the range of @code{BSR}
23108 instructions.  Note that @option{-mno-jsr} does not mean to not use
23109 @code{JSR} but instead means that any type of branch may be used.
23110 @end table
23112 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
23113 has special significance to the RX port when used with the
23114 @code{interrupt} function attribute.  This attribute indicates a
23115 function intended to process fast interrupts.  GCC ensures
23116 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
23117 and/or @code{r13} and only provided that the normal use of the
23118 corresponding registers have been restricted via the
23119 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
23120 options.
23122 @node S/390 and zSeries Options
23123 @subsection S/390 and zSeries Options
23124 @cindex S/390 and zSeries Options
23126 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
23128 @table @gcctabopt
23129 @item -mhard-float
23130 @itemx -msoft-float
23131 @opindex mhard-float
23132 @opindex msoft-float
23133 Use (do not use) the hardware floating-point instructions and registers
23134 for floating-point operations.  When @option{-msoft-float} is specified,
23135 functions in @file{libgcc.a} are used to perform floating-point
23136 operations.  When @option{-mhard-float} is specified, the compiler
23137 generates IEEE floating-point instructions.  This is the default.
23139 @item -mhard-dfp
23140 @itemx -mno-hard-dfp
23141 @opindex mhard-dfp
23142 @opindex mno-hard-dfp
23143 Use (do not use) the hardware decimal-floating-point instructions for
23144 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
23145 specified, functions in @file{libgcc.a} are used to perform
23146 decimal-floating-point operations.  When @option{-mhard-dfp} is
23147 specified, the compiler generates decimal-floating-point hardware
23148 instructions.  This is the default for @option{-march=z9-ec} or higher.
23150 @item -mlong-double-64
23151 @itemx -mlong-double-128
23152 @opindex mlong-double-64
23153 @opindex mlong-double-128
23154 These switches control the size of @code{long double} type. A size
23155 of 64 bits makes the @code{long double} type equivalent to the @code{double}
23156 type. This is the default.
23158 @item -mbackchain
23159 @itemx -mno-backchain
23160 @opindex mbackchain
23161 @opindex mno-backchain
23162 Store (do not store) the address of the caller's frame as backchain pointer
23163 into the callee's stack frame.
23164 A backchain may be needed to allow debugging using tools that do not understand
23165 DWARF call frame information.
23166 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
23167 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
23168 the backchain is placed into the topmost word of the 96/160 byte register
23169 save area.
23171 In general, code compiled with @option{-mbackchain} is call-compatible with
23172 code compiled with @option{-mmo-backchain}; however, use of the backchain
23173 for debugging purposes usually requires that the whole binary is built with
23174 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
23175 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23176 to build a linux kernel use @option{-msoft-float}.
23178 The default is to not maintain the backchain.
23180 @item -mpacked-stack
23181 @itemx -mno-packed-stack
23182 @opindex mpacked-stack
23183 @opindex mno-packed-stack
23184 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
23185 specified, the compiler uses the all fields of the 96/160 byte register save
23186 area only for their default purpose; unused fields still take up stack space.
23187 When @option{-mpacked-stack} is specified, register save slots are densely
23188 packed at the top of the register save area; unused space is reused for other
23189 purposes, allowing for more efficient use of the available stack space.
23190 However, when @option{-mbackchain} is also in effect, the topmost word of
23191 the save area is always used to store the backchain, and the return address
23192 register is always saved two words below the backchain.
23194 As long as the stack frame backchain is not used, code generated with
23195 @option{-mpacked-stack} is call-compatible with code generated with
23196 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
23197 S/390 or zSeries generated code that uses the stack frame backchain at run
23198 time, not just for debugging purposes.  Such code is not call-compatible
23199 with code compiled with @option{-mpacked-stack}.  Also, note that the
23200 combination of @option{-mbackchain},
23201 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
23202 to build a linux kernel use @option{-msoft-float}.
23204 The default is to not use the packed stack layout.
23206 @item -msmall-exec
23207 @itemx -mno-small-exec
23208 @opindex msmall-exec
23209 @opindex mno-small-exec
23210 Generate (or do not generate) code using the @code{bras} instruction
23211 to do subroutine calls.
23212 This only works reliably if the total executable size does not
23213 exceed 64k.  The default is to use the @code{basr} instruction instead,
23214 which does not have this limitation.
23216 @item -m64
23217 @itemx -m31
23218 @opindex m64
23219 @opindex m31
23220 When @option{-m31} is specified, generate code compliant to the
23221 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
23222 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
23223 particular to generate 64-bit instructions.  For the @samp{s390}
23224 targets, the default is @option{-m31}, while the @samp{s390x}
23225 targets default to @option{-m64}.
23227 @item -mzarch
23228 @itemx -mesa
23229 @opindex mzarch
23230 @opindex mesa
23231 When @option{-mzarch} is specified, generate code using the
23232 instructions available on z/Architecture.
23233 When @option{-mesa} is specified, generate code using the
23234 instructions available on ESA/390.  Note that @option{-mesa} is
23235 not possible with @option{-m64}.
23236 When generating code compliant to the GNU/Linux for S/390 ABI,
23237 the default is @option{-mesa}.  When generating code compliant
23238 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
23240 @item -mhtm
23241 @itemx -mno-htm
23242 @opindex mhtm
23243 @opindex mno-htm
23244 The @option{-mhtm} option enables a set of builtins making use of
23245 instructions available with the transactional execution facility
23246 introduced with the IBM zEnterprise EC12 machine generation
23247 @ref{S/390 System z Built-in Functions}.
23248 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
23250 @item -mvx
23251 @itemx -mno-vx
23252 @opindex mvx
23253 @opindex mno-vx
23254 When @option{-mvx} is specified, generate code using the instructions
23255 available with the vector extension facility introduced with the IBM
23256 z13 machine generation.
23257 This option changes the ABI for some vector type values with regard to
23258 alignment and calling conventions.  In case vector type values are
23259 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
23260 command will be added to mark the resulting binary with the ABI used.
23261 @option{-mvx} is enabled by default when using @option{-march=z13}.
23263 @item -mzvector
23264 @itemx -mno-zvector
23265 @opindex mzvector
23266 @opindex mno-zvector
23267 The @option{-mzvector} option enables vector language extensions and
23268 builtins using instructions available with the vector extension
23269 facility introduced with the IBM z13 machine generation.
23270 This option adds support for @samp{vector} to be used as a keyword to
23271 define vector type variables and arguments.  @samp{vector} is only
23272 available when GNU extensions are enabled.  It will not be expanded
23273 when requesting strict standard compliance e.g. with @option{-std=c99}.
23274 In addition to the GCC low-level builtins @option{-mzvector} enables
23275 a set of builtins added for compatibility with AltiVec-style
23276 implementations like Power and Cell.  In order to make use of these
23277 builtins the header file @file{vecintrin.h} needs to be included.
23278 @option{-mzvector} is disabled by default.
23280 @item -mmvcle
23281 @itemx -mno-mvcle
23282 @opindex mmvcle
23283 @opindex mno-mvcle
23284 Generate (or do not generate) code using the @code{mvcle} instruction
23285 to perform block moves.  When @option{-mno-mvcle} is specified,
23286 use a @code{mvc} loop instead.  This is the default unless optimizing for
23287 size.
23289 @item -mdebug
23290 @itemx -mno-debug
23291 @opindex mdebug
23292 @opindex mno-debug
23293 Print (or do not print) additional debug information when compiling.
23294 The default is to not print debug information.
23296 @item -march=@var{cpu-type}
23297 @opindex march
23298 Generate code that runs on @var{cpu-type}, which is the name of a
23299 system representing a certain processor type.  Possible values for
23300 @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6},
23301 @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8},
23302 @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, and
23303 @samp{native}.
23305 The default is @option{-march=z900}.  @samp{g5}/@samp{arch3} and
23306 @samp{g6} are deprecated and will be removed with future releases.
23308 Specifying @samp{native} as cpu type can be used to select the best
23309 architecture option for the host processor.
23310 @option{-march=native} has no effect if GCC does not recognize the
23311 processor.
23313 @item -mtune=@var{cpu-type}
23314 @opindex mtune
23315 Tune to @var{cpu-type} everything applicable about the generated code,
23316 except for the ABI and the set of available instructions.
23317 The list of @var{cpu-type} values is the same as for @option{-march}.
23318 The default is the value used for @option{-march}.
23320 @item -mtpf-trace
23321 @itemx -mno-tpf-trace
23322 @opindex mtpf-trace
23323 @opindex mno-tpf-trace
23324 Generate code that adds (does not add) in TPF OS specific branches to trace
23325 routines in the operating system.  This option is off by default, even
23326 when compiling for the TPF OS@.
23328 @item -mfused-madd
23329 @itemx -mno-fused-madd
23330 @opindex mfused-madd
23331 @opindex mno-fused-madd
23332 Generate code that uses (does not use) the floating-point multiply and
23333 accumulate instructions.  These instructions are generated by default if
23334 hardware floating point is used.
23336 @item -mwarn-framesize=@var{framesize}
23337 @opindex mwarn-framesize
23338 Emit a warning if the current function exceeds the given frame size.  Because
23339 this is a compile-time check it doesn't need to be a real problem when the program
23340 runs.  It is intended to identify functions that most probably cause
23341 a stack overflow.  It is useful to be used in an environment with limited stack
23342 size e.g.@: the linux kernel.
23344 @item -mwarn-dynamicstack
23345 @opindex mwarn-dynamicstack
23346 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
23347 arrays.  This is generally a bad idea with a limited stack size.
23349 @item -mstack-guard=@var{stack-guard}
23350 @itemx -mstack-size=@var{stack-size}
23351 @opindex mstack-guard
23352 @opindex mstack-size
23353 If these options are provided the S/390 back end emits additional instructions in
23354 the function prologue that trigger a trap if the stack size is @var{stack-guard}
23355 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
23356 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
23357 the frame size of the compiled function is chosen.
23358 These options are intended to be used to help debugging stack overflow problems.
23359 The additionally emitted code causes only little overhead and hence can also be
23360 used in production-like systems without greater performance degradation.  The given
23361 values have to be exact powers of 2 and @var{stack-size} has to be greater than
23362 @var{stack-guard} without exceeding 64k.
23363 In order to be efficient the extra code makes the assumption that the stack starts
23364 at an address aligned to the value given by @var{stack-size}.
23365 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
23367 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
23368 @opindex mhotpatch
23369 If the hotpatch option is enabled, a ``hot-patching'' function
23370 prologue is generated for all functions in the compilation unit.
23371 The funtion label is prepended with the given number of two-byte
23372 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
23373 the label, 2 * @var{post-halfwords} bytes are appended, using the
23374 largest NOP like instructions the architecture allows (maximum
23375 1000000).
23377 If both arguments are zero, hotpatching is disabled.
23379 This option can be overridden for individual functions with the
23380 @code{hotpatch} attribute.
23381 @end table
23383 @node Score Options
23384 @subsection Score Options
23385 @cindex Score Options
23387 These options are defined for Score implementations:
23389 @table @gcctabopt
23390 @item -meb
23391 @opindex meb
23392 Compile code for big-endian mode.  This is the default.
23394 @item -mel
23395 @opindex mel
23396 Compile code for little-endian mode.
23398 @item -mnhwloop
23399 @opindex mnhwloop
23400 Disable generation of @code{bcnz} instructions.
23402 @item -muls
23403 @opindex muls
23404 Enable generation of unaligned load and store instructions.
23406 @item -mmac
23407 @opindex mmac
23408 Enable the use of multiply-accumulate instructions. Disabled by default.
23410 @item -mscore5
23411 @opindex mscore5
23412 Specify the SCORE5 as the target architecture.
23414 @item -mscore5u
23415 @opindex mscore5u
23416 Specify the SCORE5U of the target architecture.
23418 @item -mscore7
23419 @opindex mscore7
23420 Specify the SCORE7 as the target architecture. This is the default.
23422 @item -mscore7d
23423 @opindex mscore7d
23424 Specify the SCORE7D as the target architecture.
23425 @end table
23427 @node SH Options
23428 @subsection SH Options
23430 These @samp{-m} options are defined for the SH implementations:
23432 @table @gcctabopt
23433 @item -m1
23434 @opindex m1
23435 Generate code for the SH1.
23437 @item -m2
23438 @opindex m2
23439 Generate code for the SH2.
23441 @item -m2e
23442 Generate code for the SH2e.
23444 @item -m2a-nofpu
23445 @opindex m2a-nofpu
23446 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
23447 that the floating-point unit is not used.
23449 @item -m2a-single-only
23450 @opindex m2a-single-only
23451 Generate code for the SH2a-FPU, in such a way that no double-precision
23452 floating-point operations are used.
23454 @item -m2a-single
23455 @opindex m2a-single
23456 Generate code for the SH2a-FPU assuming the floating-point unit is in
23457 single-precision mode by default.
23459 @item -m2a
23460 @opindex m2a
23461 Generate code for the SH2a-FPU assuming the floating-point unit is in
23462 double-precision mode by default.
23464 @item -m3
23465 @opindex m3
23466 Generate code for the SH3.
23468 @item -m3e
23469 @opindex m3e
23470 Generate code for the SH3e.
23472 @item -m4-nofpu
23473 @opindex m4-nofpu
23474 Generate code for the SH4 without a floating-point unit.
23476 @item -m4-single-only
23477 @opindex m4-single-only
23478 Generate code for the SH4 with a floating-point unit that only
23479 supports single-precision arithmetic.
23481 @item -m4-single
23482 @opindex m4-single
23483 Generate code for the SH4 assuming the floating-point unit is in
23484 single-precision mode by default.
23486 @item -m4
23487 @opindex m4
23488 Generate code for the SH4.
23490 @item -m4-100
23491 @opindex m4-100
23492 Generate code for SH4-100.
23494 @item -m4-100-nofpu
23495 @opindex m4-100-nofpu
23496 Generate code for SH4-100 in such a way that the
23497 floating-point unit is not used.
23499 @item -m4-100-single
23500 @opindex m4-100-single
23501 Generate code for SH4-100 assuming the floating-point unit is in
23502 single-precision mode by default.
23504 @item -m4-100-single-only
23505 @opindex m4-100-single-only
23506 Generate code for SH4-100 in such a way that no double-precision
23507 floating-point operations are used.
23509 @item -m4-200
23510 @opindex m4-200
23511 Generate code for SH4-200.
23513 @item -m4-200-nofpu
23514 @opindex m4-200-nofpu
23515 Generate code for SH4-200 without in such a way that the
23516 floating-point unit is not used.
23518 @item -m4-200-single
23519 @opindex m4-200-single
23520 Generate code for SH4-200 assuming the floating-point unit is in
23521 single-precision mode by default.
23523 @item -m4-200-single-only
23524 @opindex m4-200-single-only
23525 Generate code for SH4-200 in such a way that no double-precision
23526 floating-point operations are used.
23528 @item -m4-300
23529 @opindex m4-300
23530 Generate code for SH4-300.
23532 @item -m4-300-nofpu
23533 @opindex m4-300-nofpu
23534 Generate code for SH4-300 without in such a way that the
23535 floating-point unit is not used.
23537 @item -m4-300-single
23538 @opindex m4-300-single
23539 Generate code for SH4-300 in such a way that no double-precision
23540 floating-point operations are used.
23542 @item -m4-300-single-only
23543 @opindex m4-300-single-only
23544 Generate code for SH4-300 in such a way that no double-precision
23545 floating-point operations are used.
23547 @item -m4-340
23548 @opindex m4-340
23549 Generate code for SH4-340 (no MMU, no FPU).
23551 @item -m4-500
23552 @opindex m4-500
23553 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
23554 assembler.
23556 @item -m4a-nofpu
23557 @opindex m4a-nofpu
23558 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
23559 floating-point unit is not used.
23561 @item -m4a-single-only
23562 @opindex m4a-single-only
23563 Generate code for the SH4a, in such a way that no double-precision
23564 floating-point operations are used.
23566 @item -m4a-single
23567 @opindex m4a-single
23568 Generate code for the SH4a assuming the floating-point unit is in
23569 single-precision mode by default.
23571 @item -m4a
23572 @opindex m4a
23573 Generate code for the SH4a.
23575 @item -m4al
23576 @opindex m4al
23577 Same as @option{-m4a-nofpu}, except that it implicitly passes
23578 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
23579 instructions at the moment.
23581 @item -mb
23582 @opindex mb
23583 Compile code for the processor in big-endian mode.
23585 @item -ml
23586 @opindex ml
23587 Compile code for the processor in little-endian mode.
23589 @item -mdalign
23590 @opindex mdalign
23591 Align doubles at 64-bit boundaries.  Note that this changes the calling
23592 conventions, and thus some functions from the standard C library do
23593 not work unless you recompile it first with @option{-mdalign}.
23595 @item -mrelax
23596 @opindex mrelax
23597 Shorten some address references at link time, when possible; uses the
23598 linker option @option{-relax}.
23600 @item -mbigtable
23601 @opindex mbigtable
23602 Use 32-bit offsets in @code{switch} tables.  The default is to use
23603 16-bit offsets.
23605 @item -mbitops
23606 @opindex mbitops
23607 Enable the use of bit manipulation instructions on SH2A.
23609 @item -mfmovd
23610 @opindex mfmovd
23611 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
23612 alignment constraints.
23614 @item -mrenesas
23615 @opindex mrenesas
23616 Comply with the calling conventions defined by Renesas.
23618 @item -mno-renesas
23619 @opindex mno-renesas
23620 Comply with the calling conventions defined for GCC before the Renesas
23621 conventions were available.  This option is the default for all
23622 targets of the SH toolchain.
23624 @item -mnomacsave
23625 @opindex mnomacsave
23626 Mark the @code{MAC} register as call-clobbered, even if
23627 @option{-mrenesas} is given.
23629 @item -mieee
23630 @itemx -mno-ieee
23631 @opindex mieee
23632 @opindex mno-ieee
23633 Control the IEEE compliance of floating-point comparisons, which affects the
23634 handling of cases where the result of a comparison is unordered.  By default
23635 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
23636 enabled @option{-mno-ieee} is implicitly set, which results in faster
23637 floating-point greater-equal and less-equal comparisons.  The implicit settings
23638 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
23640 @item -minline-ic_invalidate
23641 @opindex minline-ic_invalidate
23642 Inline code to invalidate instruction cache entries after setting up
23643 nested function trampolines.
23644 This option has no effect if @option{-musermode} is in effect and the selected
23645 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
23646 instruction.
23647 If the selected code generation option does not allow the use of the @code{icbi}
23648 instruction, and @option{-musermode} is not in effect, the inlined code
23649 manipulates the instruction cache address array directly with an associative
23650 write.  This not only requires privileged mode at run time, but it also
23651 fails if the cache line had been mapped via the TLB and has become unmapped.
23653 @item -misize
23654 @opindex misize
23655 Dump instruction size and location in the assembly code.
23657 @item -mpadstruct
23658 @opindex mpadstruct
23659 This option is deprecated.  It pads structures to multiple of 4 bytes,
23660 which is incompatible with the SH ABI@.
23662 @item -matomic-model=@var{model}
23663 @opindex matomic-model=@var{model}
23664 Sets the model of atomic operations and additional parameters as a comma
23665 separated list.  For details on the atomic built-in functions see
23666 @ref{__atomic Builtins}.  The following models and parameters are supported:
23668 @table @samp
23670 @item none
23671 Disable compiler generated atomic sequences and emit library calls for atomic
23672 operations.  This is the default if the target is not @code{sh*-*-linux*}.
23674 @item soft-gusa
23675 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
23676 built-in functions.  The generated atomic sequences require additional support
23677 from the interrupt/exception handling code of the system and are only suitable
23678 for SH3* and SH4* single-core systems.  This option is enabled by default when
23679 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
23680 this option also partially utilizes the hardware atomic instructions
23681 @code{movli.l} and @code{movco.l} to create more efficient code, unless
23682 @samp{strict} is specified.  
23684 @item soft-tcb
23685 Generate software atomic sequences that use a variable in the thread control
23686 block.  This is a variation of the gUSA sequences which can also be used on
23687 SH1* and SH2* targets.  The generated atomic sequences require additional
23688 support from the interrupt/exception handling code of the system and are only
23689 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
23690 parameter has to be specified as well.
23692 @item soft-imask
23693 Generate software atomic sequences that temporarily disable interrupts by
23694 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
23695 in privileged mode and is only suitable for single-core systems.  Additional
23696 support from the interrupt/exception handling code of the system is not
23697 required.  This model is enabled by default when the target is
23698 @code{sh*-*-linux*} and SH1* or SH2*.
23700 @item hard-llcs
23701 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
23702 instructions only.  This is only available on SH4A and is suitable for
23703 multi-core systems.  Since the hardware instructions support only 32 bit atomic
23704 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
23705 Code compiled with this option is also compatible with other software
23706 atomic model interrupt/exception handling systems if executed on an SH4A
23707 system.  Additional support from the interrupt/exception handling code of the
23708 system is not required for this model.
23710 @item gbr-offset=
23711 This parameter specifies the offset in bytes of the variable in the thread
23712 control block structure that should be used by the generated atomic sequences
23713 when the @samp{soft-tcb} model has been selected.  For other models this
23714 parameter is ignored.  The specified value must be an integer multiple of four
23715 and in the range 0-1020.
23717 @item strict
23718 This parameter prevents mixed usage of multiple atomic models, even if they
23719 are compatible, and makes the compiler generate atomic sequences of the
23720 specified model only.
23722 @end table
23724 @item -mtas
23725 @opindex mtas
23726 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
23727 Notice that depending on the particular hardware and software configuration
23728 this can degrade overall performance due to the operand cache line flushes
23729 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
23730 processors the @code{tas.b} instruction must be used with caution since it
23731 can result in data corruption for certain cache configurations.
23733 @item -mprefergot
23734 @opindex mprefergot
23735 When generating position-independent code, emit function calls using
23736 the Global Offset Table instead of the Procedure Linkage Table.
23738 @item -musermode
23739 @itemx -mno-usermode
23740 @opindex musermode
23741 @opindex mno-usermode
23742 Don't allow (allow) the compiler generating privileged mode code.  Specifying
23743 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
23744 inlined code would not work in user mode.  @option{-musermode} is the default
23745 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
23746 @option{-musermode} has no effect, since there is no user mode.
23748 @item -multcost=@var{number}
23749 @opindex multcost=@var{number}
23750 Set the cost to assume for a multiply insn.
23752 @item -mdiv=@var{strategy}
23753 @opindex mdiv=@var{strategy}
23754 Set the division strategy to be used for integer division operations.
23755 @var{strategy} can be one of: 
23757 @table @samp
23759 @item call-div1
23760 Calls a library function that uses the single-step division instruction
23761 @code{div1} to perform the operation.  Division by zero calculates an
23762 unspecified result and does not trap.  This is the default except for SH4,
23763 SH2A and SHcompact.
23765 @item call-fp
23766 Calls a library function that performs the operation in double precision
23767 floating point.  Division by zero causes a floating-point exception.  This is
23768 the default for SHcompact with FPU.  Specifying this for targets that do not
23769 have a double precision FPU defaults to @code{call-div1}.
23771 @item call-table
23772 Calls a library function that uses a lookup table for small divisors and
23773 the @code{div1} instruction with case distinction for larger divisors.  Division
23774 by zero calculates an unspecified result and does not trap.  This is the default
23775 for SH4.  Specifying this for targets that do not have dynamic shift
23776 instructions defaults to @code{call-div1}.
23778 @end table
23780 When a division strategy has not been specified the default strategy is
23781 selected based on the current target.  For SH2A the default strategy is to
23782 use the @code{divs} and @code{divu} instructions instead of library function
23783 calls.
23785 @item -maccumulate-outgoing-args
23786 @opindex maccumulate-outgoing-args
23787 Reserve space once for outgoing arguments in the function prologue rather
23788 than around each call.  Generally beneficial for performance and size.  Also
23789 needed for unwinding to avoid changing the stack frame around conditional code.
23791 @item -mdivsi3_libfunc=@var{name}
23792 @opindex mdivsi3_libfunc=@var{name}
23793 Set the name of the library function used for 32-bit signed division to
23794 @var{name}.
23795 This only affects the name used in the @samp{call} division strategies, and
23796 the compiler still expects the same sets of input/output/clobbered registers as
23797 if this option were not present.
23799 @item -mfixed-range=@var{register-range}
23800 @opindex mfixed-range
23801 Generate code treating the given register range as fixed registers.
23802 A fixed register is one that the register allocator can not use.  This is
23803 useful when compiling kernel code.  A register range is specified as
23804 two registers separated by a dash.  Multiple register ranges can be
23805 specified separated by a comma.
23807 @item -mbranch-cost=@var{num}
23808 @opindex mbranch-cost=@var{num}
23809 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
23810 make the compiler try to generate more branch-free code if possible.  
23811 If not specified the value is selected depending on the processor type that
23812 is being compiled for.
23814 @item -mzdcbranch
23815 @itemx -mno-zdcbranch
23816 @opindex mzdcbranch
23817 @opindex mno-zdcbranch
23818 Assume (do not assume) that zero displacement conditional branch instructions
23819 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
23820 compiler prefers zero displacement branch code sequences.  This is
23821 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
23822 disabled by specifying @option{-mno-zdcbranch}.
23824 @item -mcbranch-force-delay-slot
23825 @opindex mcbranch-force-delay-slot
23826 Force the usage of delay slots for conditional branches, which stuffs the delay
23827 slot with a @code{nop} if a suitable instruction cannot be found.  By default
23828 this option is disabled.  It can be enabled to work around hardware bugs as
23829 found in the original SH7055.
23831 @item -mfused-madd
23832 @itemx -mno-fused-madd
23833 @opindex mfused-madd
23834 @opindex mno-fused-madd
23835 Generate code that uses (does not use) the floating-point multiply and
23836 accumulate instructions.  These instructions are generated by default
23837 if hardware floating point is used.  The machine-dependent
23838 @option{-mfused-madd} option is now mapped to the machine-independent
23839 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
23840 mapped to @option{-ffp-contract=off}.
23842 @item -mfsca
23843 @itemx -mno-fsca
23844 @opindex mfsca
23845 @opindex mno-fsca
23846 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
23847 and cosine approximations.  The option @option{-mfsca} must be used in
23848 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
23849 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
23850 approximations even if @option{-funsafe-math-optimizations} is in effect.
23852 @item -mfsrra
23853 @itemx -mno-fsrra
23854 @opindex mfsrra
23855 @opindex mno-fsrra
23856 Allow or disallow the compiler to emit the @code{fsrra} instruction for
23857 reciprocal square root approximations.  The option @option{-mfsrra} must be used
23858 in combination with @option{-funsafe-math-optimizations} and
23859 @option{-ffinite-math-only}.  It is enabled by default when generating code for
23860 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
23861 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
23862 in effect.
23864 @item -mpretend-cmove
23865 @opindex mpretend-cmove
23866 Prefer zero-displacement conditional branches for conditional move instruction
23867 patterns.  This can result in faster code on the SH4 processor.
23869 @item -mfdpic
23870 @opindex fdpic
23871 Generate code using the FDPIC ABI.
23873 @end table
23875 @node Solaris 2 Options
23876 @subsection Solaris 2 Options
23877 @cindex Solaris 2 options
23879 These @samp{-m} options are supported on Solaris 2:
23881 @table @gcctabopt
23882 @item -mclear-hwcap
23883 @opindex mclear-hwcap
23884 @option{-mclear-hwcap} tells the compiler to remove the hardware
23885 capabilities generated by the Solaris assembler.  This is only necessary
23886 when object files use ISA extensions not supported by the current
23887 machine, but check at runtime whether or not to use them.
23889 @item -mimpure-text
23890 @opindex mimpure-text
23891 @option{-mimpure-text}, used in addition to @option{-shared}, tells
23892 the compiler to not pass @option{-z text} to the linker when linking a
23893 shared object.  Using this option, you can link position-dependent
23894 code into a shared object.
23896 @option{-mimpure-text} suppresses the ``relocations remain against
23897 allocatable but non-writable sections'' linker error message.
23898 However, the necessary relocations trigger copy-on-write, and the
23899 shared object is not actually shared across processes.  Instead of
23900 using @option{-mimpure-text}, you should compile all source code with
23901 @option{-fpic} or @option{-fPIC}.
23903 @end table
23905 These switches are supported in addition to the above on Solaris 2:
23907 @table @gcctabopt
23908 @item -pthreads
23909 @opindex pthreads
23910 This is a synonym for @option{-pthread}.
23911 @end table
23913 @node SPARC Options
23914 @subsection SPARC Options
23915 @cindex SPARC options
23917 These @samp{-m} options are supported on the SPARC:
23919 @table @gcctabopt
23920 @item -mno-app-regs
23921 @itemx -mapp-regs
23922 @opindex mno-app-regs
23923 @opindex mapp-regs
23924 Specify @option{-mapp-regs} to generate output using the global registers
23925 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
23926 global register 1, each global register 2 through 4 is then treated as an
23927 allocable register that is clobbered by function calls.  This is the default.
23929 To be fully SVR4 ABI-compliant at the cost of some performance loss,
23930 specify @option{-mno-app-regs}.  You should compile libraries and system
23931 software with this option.
23933 @item -mflat
23934 @itemx -mno-flat
23935 @opindex mflat
23936 @opindex mno-flat
23937 With @option{-mflat}, the compiler does not generate save/restore instructions
23938 and uses a ``flat'' or single register window model.  This model is compatible
23939 with the regular register window model.  The local registers and the input
23940 registers (0--5) are still treated as ``call-saved'' registers and are
23941 saved on the stack as needed.
23943 With @option{-mno-flat} (the default), the compiler generates save/restore
23944 instructions (except for leaf functions).  This is the normal operating mode.
23946 @item -mfpu
23947 @itemx -mhard-float
23948 @opindex mfpu
23949 @opindex mhard-float
23950 Generate output containing floating-point instructions.  This is the
23951 default.
23953 @item -mno-fpu
23954 @itemx -msoft-float
23955 @opindex mno-fpu
23956 @opindex msoft-float
23957 Generate output containing library calls for floating point.
23958 @strong{Warning:} the requisite libraries are not available for all SPARC
23959 targets.  Normally the facilities of the machine's usual C compiler are
23960 used, but this cannot be done directly in cross-compilation.  You must make
23961 your own arrangements to provide suitable library functions for
23962 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
23963 @samp{sparclite-*-*} do provide software floating-point support.
23965 @option{-msoft-float} changes the calling convention in the output file;
23966 therefore, it is only useful if you compile @emph{all} of a program with
23967 this option.  In particular, you need to compile @file{libgcc.a}, the
23968 library that comes with GCC, with @option{-msoft-float} in order for
23969 this to work.
23971 @item -mhard-quad-float
23972 @opindex mhard-quad-float
23973 Generate output containing quad-word (long double) floating-point
23974 instructions.
23976 @item -msoft-quad-float
23977 @opindex msoft-quad-float
23978 Generate output containing library calls for quad-word (long double)
23979 floating-point instructions.  The functions called are those specified
23980 in the SPARC ABI@.  This is the default.
23982 As of this writing, there are no SPARC implementations that have hardware
23983 support for the quad-word floating-point instructions.  They all invoke
23984 a trap handler for one of these instructions, and then the trap handler
23985 emulates the effect of the instruction.  Because of the trap handler overhead,
23986 this is much slower than calling the ABI library routines.  Thus the
23987 @option{-msoft-quad-float} option is the default.
23989 @item -mno-unaligned-doubles
23990 @itemx -munaligned-doubles
23991 @opindex mno-unaligned-doubles
23992 @opindex munaligned-doubles
23993 Assume that doubles have 8-byte alignment.  This is the default.
23995 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
23996 alignment only if they are contained in another type, or if they have an
23997 absolute address.  Otherwise, it assumes they have 4-byte alignment.
23998 Specifying this option avoids some rare compatibility problems with code
23999 generated by other compilers.  It is not the default because it results
24000 in a performance loss, especially for floating-point code.
24002 @item -muser-mode
24003 @itemx -mno-user-mode
24004 @opindex muser-mode
24005 @opindex mno-user-mode
24006 Do not generate code that can only run in supervisor mode.  This is relevant
24007 only for the @code{casa} instruction emitted for the LEON3 processor.  This
24008 is the default.
24010 @item -mfaster-structs
24011 @itemx -mno-faster-structs
24012 @opindex mfaster-structs
24013 @opindex mno-faster-structs
24014 With @option{-mfaster-structs}, the compiler assumes that structures
24015 should have 8-byte alignment.  This enables the use of pairs of
24016 @code{ldd} and @code{std} instructions for copies in structure
24017 assignment, in place of twice as many @code{ld} and @code{st} pairs.
24018 However, the use of this changed alignment directly violates the SPARC
24019 ABI@.  Thus, it's intended only for use on targets where the developer
24020 acknowledges that their resulting code is not directly in line with
24021 the rules of the ABI@.
24023 @item -mstd-struct-return
24024 @itemx -mno-std-struct-return
24025 @opindex mstd-struct-return
24026 @opindex mno-std-struct-return
24027 With @option{-mstd-struct-return}, the compiler generates checking code
24028 in functions returning structures or unions to detect size mismatches
24029 between the two sides of function calls, as per the 32-bit ABI@.
24031 The default is @option{-mno-std-struct-return}.  This option has no effect
24032 in 64-bit mode.
24034 @item -mlra
24035 @itemx -mno-lra
24036 @opindex mlra
24037 @opindex mno-lra
24038 Enable Local Register Allocation.  This is the default for SPARC since GCC 7
24039 so @option{-mno-lra} needs to be passed to get old Reload.
24041 @item -mcpu=@var{cpu_type}
24042 @opindex mcpu
24043 Set the instruction set, register set, and instruction scheduling parameters
24044 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24045 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
24046 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
24047 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
24048 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
24049 @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and @samp{m8}.
24051 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
24052 which selects the best architecture option for the host processor.
24053 @option{-mcpu=native} has no effect if GCC does not recognize
24054 the processor.
24056 Default instruction scheduling parameters are used for values that select
24057 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
24058 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
24060 Here is a list of each supported architecture and their supported
24061 implementations.
24063 @table @asis
24064 @item v7
24065 cypress, leon3v7
24067 @item v8
24068 supersparc, hypersparc, leon, leon3
24070 @item sparclite
24071 f930, f934, sparclite86x
24073 @item sparclet
24074 tsc701
24076 @item v9
24077 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4,
24078 niagara7, m8
24079 @end table
24081 By default (unless configured otherwise), GCC generates code for the V7
24082 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
24083 additionally optimizes it for the Cypress CY7C602 chip, as used in the
24084 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
24085 SPARCStation 1, 2, IPX etc.
24087 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
24088 architecture.  The only difference from V7 code is that the compiler emits
24089 the integer multiply and integer divide instructions which exist in SPARC-V8
24090 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
24091 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
24092 2000 series.
24094 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
24095 the SPARC architecture.  This adds the integer multiply, integer divide step
24096 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
24097 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
24098 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
24099 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
24100 MB86934 chip, which is the more recent SPARClite with FPU@.
24102 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
24103 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
24104 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
24105 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
24106 optimizes it for the TEMIC SPARClet chip.
24108 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
24109 architecture.  This adds 64-bit integer and floating-point move instructions,
24110 3 additional floating-point condition code registers and conditional move
24111 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
24112 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
24113 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
24114 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
24115 @option{-mcpu=niagara}, the compiler additionally optimizes it for
24116 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
24117 additionally optimizes it for Sun UltraSPARC T2 chips. With
24118 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
24119 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
24120 additionally optimizes it for Sun UltraSPARC T4 chips.  With
24121 @option{-mcpu=niagara7}, the compiler additionally optimizes it for
24122 Oracle SPARC M7 chips.  With @option{-mcpu=m8}, the compiler
24123 additionally optimizes it for Oracle M8 chips.
24125 @item -mtune=@var{cpu_type}
24126 @opindex mtune
24127 Set the instruction scheduling parameters for machine type
24128 @var{cpu_type}, but do not set the instruction set or register set that the
24129 option @option{-mcpu=@var{cpu_type}} does.
24131 The same values for @option{-mcpu=@var{cpu_type}} can be used for
24132 @option{-mtune=@var{cpu_type}}, but the only useful values are those
24133 that select a particular CPU implementation.  Those are
24134 @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon},
24135 @samp{leon3}, @samp{leon3v7}, @samp{f930}, @samp{f934},
24136 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
24137 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3},
24138 @samp{niagara4}, @samp{niagara7} and @samp{m8}.  With native Solaris
24139 and GNU/Linux toolchains, @samp{native} can also be used.
24141 @item -mv8plus
24142 @itemx -mno-v8plus
24143 @opindex mv8plus
24144 @opindex mno-v8plus
24145 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
24146 difference from the V8 ABI is that the global and out registers are
24147 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
24148 mode for all SPARC-V9 processors.
24150 @item -mvis
24151 @itemx -mno-vis
24152 @opindex mvis
24153 @opindex mno-vis
24154 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
24155 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
24157 @item -mvis2
24158 @itemx -mno-vis2
24159 @opindex mvis2
24160 @opindex mno-vis2
24161 With @option{-mvis2}, GCC generates code that takes advantage of
24162 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
24163 default is @option{-mvis2} when targeting a cpu that supports such
24164 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
24165 also sets @option{-mvis}.
24167 @item -mvis3
24168 @itemx -mno-vis3
24169 @opindex mvis3
24170 @opindex mno-vis3
24171 With @option{-mvis3}, GCC generates code that takes advantage of
24172 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
24173 default is @option{-mvis3} when targeting a cpu that supports such
24174 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
24175 also sets @option{-mvis2} and @option{-mvis}.
24177 @item -mvis4
24178 @itemx -mno-vis4
24179 @opindex mvis4
24180 @opindex mno-vis4
24181 With @option{-mvis4}, GCC generates code that takes advantage of
24182 version 4.0 of the UltraSPARC Visual Instruction Set extensions.  The
24183 default is @option{-mvis4} when targeting a cpu that supports such
24184 instructions, such as niagara-7 and later.  Setting @option{-mvis4}
24185 also sets @option{-mvis3}, @option{-mvis2} and @option{-mvis}.
24187 @item -mvis4b
24188 @itemx -mno-vis4b
24189 @opindex mvis4b
24190 @opindex mno-vis4b
24191 With @option{-mvis4b}, GCC generates code that takes advantage of
24192 version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus
24193 the additional VIS instructions introduced in the Oracle SPARC
24194 Architecture 2017.  The default is @option{-mvis4b} when targeting a
24195 cpu that supports such instructions, such as m8 and later.  Setting
24196 @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3},
24197 @option{-mvis2} and @option{-mvis}.
24199 @item -mcbcond
24200 @itemx -mno-cbcond
24201 @opindex mcbcond
24202 @opindex mno-cbcond
24203 With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC
24204 Compare-and-Branch-on-Condition instructions.  The default is @option{-mcbcond}
24205 when targeting a CPU that supports such instructions, such as Niagara-4 and
24206 later.
24208 @item -mfmaf
24209 @itemx -mno-fmaf
24210 @opindex mfmaf
24211 @opindex mno-fmaf
24212 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
24213 Fused Multiply-Add Floating-point instructions.  The default is @option{-mfmaf}
24214 when targeting a CPU that supports such instructions, such as Niagara-3 and
24215 later.
24217 @item -mfsmuld
24218 @itemx -mno-fsmuld
24219 @opindex mfsmuld
24220 @opindex mno-fsmuld
24221 With @option{-mfsmuld}, GCC generates code that takes advantage of the
24222 Floating-point Multiply Single to Double (FsMULd) instruction.  The default is
24223 @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8
24224 or V9 with FPU except @option{-mcpu=leon}.
24226 @item -mpopc
24227 @itemx -mno-popc
24228 @opindex mpopc
24229 @opindex mno-popc
24230 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
24231 Population Count instruction.  The default is @option{-mpopc}
24232 when targeting a CPU that supports such an instruction, such as Niagara-2 and
24233 later.
24235 @item -msubxc
24236 @itemx -mno-subxc
24237 @opindex msubxc
24238 @opindex mno-subxc
24239 With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC
24240 Subtract-Extended-with-Carry instruction.  The default is @option{-msubxc}
24241 when targeting a CPU that supports such an instruction, such as Niagara-7 and
24242 later.
24244 @item -mfix-at697f
24245 @opindex mfix-at697f
24246 Enable the documented workaround for the single erratum of the Atmel AT697F
24247 processor (which corresponds to erratum #13 of the AT697E processor).
24249 @item -mfix-ut699
24250 @opindex mfix-ut699
24251 Enable the documented workarounds for the floating-point errata and the data
24252 cache nullify errata of the UT699 processor.
24254 @item -mfix-ut700
24255 @opindex mfix-ut700
24256 Enable the documented workaround for the back-to-back store errata of
24257 the UT699E/UT700 processor.
24259 @item -mfix-gr712rc
24260 @opindex mfix-gr712rc
24261 Enable the documented workaround for the back-to-back store errata of
24262 the GR712RC processor.
24263 @end table
24265 These @samp{-m} options are supported in addition to the above
24266 on SPARC-V9 processors in 64-bit environments:
24268 @table @gcctabopt
24269 @item -m32
24270 @itemx -m64
24271 @opindex m32
24272 @opindex m64
24273 Generate code for a 32-bit or 64-bit environment.
24274 The 32-bit environment sets int, long and pointer to 32 bits.
24275 The 64-bit environment sets int to 32 bits and long and pointer
24276 to 64 bits.
24278 @item -mcmodel=@var{which}
24279 @opindex mcmodel
24280 Set the code model to one of
24282 @table @samp
24283 @item medlow
24284 The Medium/Low code model: 64-bit addresses, programs
24285 must be linked in the low 32 bits of memory.  Programs can be statically
24286 or dynamically linked.
24288 @item medmid
24289 The Medium/Middle code model: 64-bit addresses, programs
24290 must be linked in the low 44 bits of memory, the text and data segments must
24291 be less than 2GB in size and the data segment must be located within 2GB of
24292 the text segment.
24294 @item medany
24295 The Medium/Anywhere code model: 64-bit addresses, programs
24296 may be linked anywhere in memory, the text and data segments must be less
24297 than 2GB in size and the data segment must be located within 2GB of the
24298 text segment.
24300 @item embmedany
24301 The Medium/Anywhere code model for embedded systems:
24302 64-bit addresses, the text and data segments must be less than 2GB in
24303 size, both starting anywhere in memory (determined at link time).  The
24304 global register %g4 points to the base of the data segment.  Programs
24305 are statically linked and PIC is not supported.
24306 @end table
24308 @item -mmemory-model=@var{mem-model}
24309 @opindex mmemory-model
24310 Set the memory model in force on the processor to one of
24312 @table @samp
24313 @item default
24314 The default memory model for the processor and operating system.
24316 @item rmo
24317 Relaxed Memory Order
24319 @item pso
24320 Partial Store Order
24322 @item tso
24323 Total Store Order
24325 @item sc
24326 Sequential Consistency
24327 @end table
24329 These memory models are formally defined in Appendix D of the SPARC-V9
24330 architecture manual, as set in the processor's @code{PSTATE.MM} field.
24332 @item -mstack-bias
24333 @itemx -mno-stack-bias
24334 @opindex mstack-bias
24335 @opindex mno-stack-bias
24336 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
24337 frame pointer if present, are offset by @minus{}2047 which must be added back
24338 when making stack frame references.  This is the default in 64-bit mode.
24339 Otherwise, assume no such offset is present.
24340 @end table
24342 @node SPU Options
24343 @subsection SPU Options
24344 @cindex SPU options
24346 These @samp{-m} options are supported on the SPU:
24348 @table @gcctabopt
24349 @item -mwarn-reloc
24350 @itemx -merror-reloc
24351 @opindex mwarn-reloc
24352 @opindex merror-reloc
24354 The loader for SPU does not handle dynamic relocations.  By default, GCC
24355 gives an error when it generates code that requires a dynamic
24356 relocation.  @option{-mno-error-reloc} disables the error,
24357 @option{-mwarn-reloc} generates a warning instead.
24359 @item -msafe-dma
24360 @itemx -munsafe-dma
24361 @opindex msafe-dma
24362 @opindex munsafe-dma
24364 Instructions that initiate or test completion of DMA must not be
24365 reordered with respect to loads and stores of the memory that is being
24366 accessed.
24367 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
24368 memory accesses, but that can lead to inefficient code in places where the
24369 memory is known to not change.  Rather than mark the memory as volatile,
24370 you can use @option{-msafe-dma} to tell the compiler to treat
24371 the DMA instructions as potentially affecting all memory.  
24373 @item -mbranch-hints
24374 @opindex mbranch-hints
24376 By default, GCC generates a branch hint instruction to avoid
24377 pipeline stalls for always-taken or probably-taken branches.  A hint
24378 is not generated closer than 8 instructions away from its branch.
24379 There is little reason to disable them, except for debugging purposes,
24380 or to make an object a little bit smaller.
24382 @item -msmall-mem
24383 @itemx -mlarge-mem
24384 @opindex msmall-mem
24385 @opindex mlarge-mem
24387 By default, GCC generates code assuming that addresses are never larger
24388 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
24389 a full 32-bit address.
24391 @item -mstdmain
24392 @opindex mstdmain
24394 By default, GCC links against startup code that assumes the SPU-style
24395 main function interface (which has an unconventional parameter list).
24396 With @option{-mstdmain}, GCC links your program against startup
24397 code that assumes a C99-style interface to @code{main}, including a
24398 local copy of @code{argv} strings.
24400 @item -mfixed-range=@var{register-range}
24401 @opindex mfixed-range
24402 Generate code treating the given register range as fixed registers.
24403 A fixed register is one that the register allocator cannot use.  This is
24404 useful when compiling kernel code.  A register range is specified as
24405 two registers separated by a dash.  Multiple register ranges can be
24406 specified separated by a comma.
24408 @item -mea32
24409 @itemx -mea64
24410 @opindex mea32
24411 @opindex mea64
24412 Compile code assuming that pointers to the PPU address space accessed
24413 via the @code{__ea} named address space qualifier are either 32 or 64
24414 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
24415 all object code in an executable must be compiled with the same setting.
24417 @item -maddress-space-conversion
24418 @itemx -mno-address-space-conversion
24419 @opindex maddress-space-conversion
24420 @opindex mno-address-space-conversion
24421 Allow/disallow treating the @code{__ea} address space as superset
24422 of the generic address space.  This enables explicit type casts
24423 between @code{__ea} and generic pointer as well as implicit
24424 conversions of generic pointers to @code{__ea} pointers.  The
24425 default is to allow address space pointer conversions.
24427 @item -mcache-size=@var{cache-size}
24428 @opindex mcache-size
24429 This option controls the version of libgcc that the compiler links to an
24430 executable and selects a software-managed cache for accessing variables
24431 in the @code{__ea} address space with a particular cache size.  Possible
24432 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
24433 and @samp{128}.  The default cache size is 64KB.
24435 @item -matomic-updates
24436 @itemx -mno-atomic-updates
24437 @opindex matomic-updates
24438 @opindex mno-atomic-updates
24439 This option controls the version of libgcc that the compiler links to an
24440 executable and selects whether atomic updates to the software-managed
24441 cache of PPU-side variables are used.  If you use atomic updates, changes
24442 to a PPU variable from SPU code using the @code{__ea} named address space
24443 qualifier do not interfere with changes to other PPU variables residing
24444 in the same cache line from PPU code.  If you do not use atomic updates,
24445 such interference may occur; however, writing back cache lines is
24446 more efficient.  The default behavior is to use atomic updates.
24448 @item -mdual-nops
24449 @itemx -mdual-nops=@var{n}
24450 @opindex mdual-nops
24451 By default, GCC inserts NOPs to increase dual issue when it expects
24452 it to increase performance.  @var{n} can be a value from 0 to 10.  A
24453 smaller @var{n} inserts fewer NOPs.  10 is the default, 0 is the
24454 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
24456 @item -mhint-max-nops=@var{n}
24457 @opindex mhint-max-nops
24458 Maximum number of NOPs to insert for a branch hint.  A branch hint must
24459 be at least 8 instructions away from the branch it is affecting.  GCC
24460 inserts up to @var{n} NOPs to enforce this, otherwise it does not
24461 generate the branch hint.
24463 @item -mhint-max-distance=@var{n}
24464 @opindex mhint-max-distance
24465 The encoding of the branch hint instruction limits the hint to be within
24466 256 instructions of the branch it is affecting.  By default, GCC makes
24467 sure it is within 125.
24469 @item -msafe-hints
24470 @opindex msafe-hints
24471 Work around a hardware bug that causes the SPU to stall indefinitely.
24472 By default, GCC inserts the @code{hbrp} instruction to make sure
24473 this stall won't happen.
24475 @end table
24477 @node System V Options
24478 @subsection Options for System V
24480 These additional options are available on System V Release 4 for
24481 compatibility with other compilers on those systems:
24483 @table @gcctabopt
24484 @item -G
24485 @opindex G
24486 Create a shared object.
24487 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
24489 @item -Qy
24490 @opindex Qy
24491 Identify the versions of each tool used by the compiler, in a
24492 @code{.ident} assembler directive in the output.
24494 @item -Qn
24495 @opindex Qn
24496 Refrain from adding @code{.ident} directives to the output file (this is
24497 the default).
24499 @item -YP,@var{dirs}
24500 @opindex YP
24501 Search the directories @var{dirs}, and no others, for libraries
24502 specified with @option{-l}.
24504 @item -Ym,@var{dir}
24505 @opindex Ym
24506 Look in the directory @var{dir} to find the M4 preprocessor.
24507 The assembler uses this option.
24508 @c This is supposed to go with a -Yd for predefined M4 macro files, but
24509 @c the generic assembler that comes with Solaris takes just -Ym.
24510 @end table
24512 @node TILE-Gx Options
24513 @subsection TILE-Gx Options
24514 @cindex TILE-Gx options
24516 These @samp{-m} options are supported on the TILE-Gx:
24518 @table @gcctabopt
24519 @item -mcmodel=small
24520 @opindex mcmodel=small
24521 Generate code for the small model.  The distance for direct calls is
24522 limited to 500M in either direction.  PC-relative addresses are 32
24523 bits.  Absolute addresses support the full address range.
24525 @item -mcmodel=large
24526 @opindex mcmodel=large
24527 Generate code for the large model.  There is no limitation on call
24528 distance, pc-relative addresses, or absolute addresses.
24530 @item -mcpu=@var{name}
24531 @opindex mcpu
24532 Selects the type of CPU to be targeted.  Currently the only supported
24533 type is @samp{tilegx}.
24535 @item -m32
24536 @itemx -m64
24537 @opindex m32
24538 @opindex m64
24539 Generate code for a 32-bit or 64-bit environment.  The 32-bit
24540 environment sets int, long, and pointer to 32 bits.  The 64-bit
24541 environment sets int to 32 bits and long and pointer to 64 bits.
24543 @item -mbig-endian
24544 @itemx -mlittle-endian
24545 @opindex mbig-endian
24546 @opindex mlittle-endian
24547 Generate code in big/little endian mode, respectively.
24548 @end table
24550 @node TILEPro Options
24551 @subsection TILEPro Options
24552 @cindex TILEPro options
24554 These @samp{-m} options are supported on the TILEPro:
24556 @table @gcctabopt
24557 @item -mcpu=@var{name}
24558 @opindex mcpu
24559 Selects the type of CPU to be targeted.  Currently the only supported
24560 type is @samp{tilepro}.
24562 @item -m32
24563 @opindex m32
24564 Generate code for a 32-bit environment, which sets int, long, and
24565 pointer to 32 bits.  This is the only supported behavior so the flag
24566 is essentially ignored.
24567 @end table
24569 @node V850 Options
24570 @subsection V850 Options
24571 @cindex V850 Options
24573 These @samp{-m} options are defined for V850 implementations:
24575 @table @gcctabopt
24576 @item -mlong-calls
24577 @itemx -mno-long-calls
24578 @opindex mlong-calls
24579 @opindex mno-long-calls
24580 Treat all calls as being far away (near).  If calls are assumed to be
24581 far away, the compiler always loads the function's address into a
24582 register, and calls indirect through the pointer.
24584 @item -mno-ep
24585 @itemx -mep
24586 @opindex mno-ep
24587 @opindex mep
24588 Do not optimize (do optimize) basic blocks that use the same index
24589 pointer 4 or more times to copy pointer into the @code{ep} register, and
24590 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
24591 option is on by default if you optimize.
24593 @item -mno-prolog-function
24594 @itemx -mprolog-function
24595 @opindex mno-prolog-function
24596 @opindex mprolog-function
24597 Do not use (do use) external functions to save and restore registers
24598 at the prologue and epilogue of a function.  The external functions
24599 are slower, but use less code space if more than one function saves
24600 the same number of registers.  The @option{-mprolog-function} option
24601 is on by default if you optimize.
24603 @item -mspace
24604 @opindex mspace
24605 Try to make the code as small as possible.  At present, this just turns
24606 on the @option{-mep} and @option{-mprolog-function} options.
24608 @item -mtda=@var{n}
24609 @opindex mtda
24610 Put static or global variables whose size is @var{n} bytes or less into
24611 the tiny data area that register @code{ep} points to.  The tiny data
24612 area can hold up to 256 bytes in total (128 bytes for byte references).
24614 @item -msda=@var{n}
24615 @opindex msda
24616 Put static or global variables whose size is @var{n} bytes or less into
24617 the small data area that register @code{gp} points to.  The small data
24618 area can hold up to 64 kilobytes.
24620 @item -mzda=@var{n}
24621 @opindex mzda
24622 Put static or global variables whose size is @var{n} bytes or less into
24623 the first 32 kilobytes of memory.
24625 @item -mv850
24626 @opindex mv850
24627 Specify that the target processor is the V850.
24629 @item -mv850e3v5
24630 @opindex mv850e3v5
24631 Specify that the target processor is the V850E3V5.  The preprocessor
24632 constant @code{__v850e3v5__} is defined if this option is used.
24634 @item -mv850e2v4
24635 @opindex mv850e2v4
24636 Specify that the target processor is the V850E3V5.  This is an alias for
24637 the @option{-mv850e3v5} option.
24639 @item -mv850e2v3
24640 @opindex mv850e2v3
24641 Specify that the target processor is the V850E2V3.  The preprocessor
24642 constant @code{__v850e2v3__} is defined if this option is used.
24644 @item -mv850e2
24645 @opindex mv850e2
24646 Specify that the target processor is the V850E2.  The preprocessor
24647 constant @code{__v850e2__} is defined if this option is used.
24649 @item -mv850e1
24650 @opindex mv850e1
24651 Specify that the target processor is the V850E1.  The preprocessor
24652 constants @code{__v850e1__} and @code{__v850e__} are defined if
24653 this option is used.
24655 @item -mv850es
24656 @opindex mv850es
24657 Specify that the target processor is the V850ES.  This is an alias for
24658 the @option{-mv850e1} option.
24660 @item -mv850e
24661 @opindex mv850e
24662 Specify that the target processor is the V850E@.  The preprocessor
24663 constant @code{__v850e__} is defined if this option is used.
24665 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
24666 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
24667 are defined then a default target processor is chosen and the
24668 relevant @samp{__v850*__} preprocessor constant is defined.
24670 The preprocessor constants @code{__v850} and @code{__v851__} are always
24671 defined, regardless of which processor variant is the target.
24673 @item -mdisable-callt
24674 @itemx -mno-disable-callt
24675 @opindex mdisable-callt
24676 @opindex mno-disable-callt
24677 This option suppresses generation of the @code{CALLT} instruction for the
24678 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
24679 architecture.
24681 This option is enabled by default when the RH850 ABI is
24682 in use (see @option{-mrh850-abi}), and disabled by default when the
24683 GCC ABI is in use.  If @code{CALLT} instructions are being generated
24684 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
24686 @item -mrelax
24687 @itemx -mno-relax
24688 @opindex mrelax
24689 @opindex mno-relax
24690 Pass on (or do not pass on) the @option{-mrelax} command-line option
24691 to the assembler.
24693 @item -mlong-jumps
24694 @itemx -mno-long-jumps
24695 @opindex mlong-jumps
24696 @opindex mno-long-jumps
24697 Disable (or re-enable) the generation of PC-relative jump instructions.
24699 @item -msoft-float
24700 @itemx -mhard-float
24701 @opindex msoft-float
24702 @opindex mhard-float
24703 Disable (or re-enable) the generation of hardware floating point
24704 instructions.  This option is only significant when the target
24705 architecture is @samp{V850E2V3} or higher.  If hardware floating point
24706 instructions are being generated then the C preprocessor symbol
24707 @code{__FPU_OK__} is defined, otherwise the symbol
24708 @code{__NO_FPU__} is defined.
24710 @item -mloop
24711 @opindex mloop
24712 Enables the use of the e3v5 LOOP instruction.  The use of this
24713 instruction is not enabled by default when the e3v5 architecture is
24714 selected because its use is still experimental.
24716 @item -mrh850-abi
24717 @itemx -mghs
24718 @opindex mrh850-abi
24719 @opindex mghs
24720 Enables support for the RH850 version of the V850 ABI.  This is the
24721 default.  With this version of the ABI the following rules apply:
24723 @itemize
24724 @item
24725 Integer sized structures and unions are returned via a memory pointer
24726 rather than a register.
24728 @item
24729 Large structures and unions (more than 8 bytes in size) are passed by
24730 value.
24732 @item
24733 Functions are aligned to 16-bit boundaries.
24735 @item
24736 The @option{-m8byte-align} command-line option is supported.
24738 @item
24739 The @option{-mdisable-callt} command-line option is enabled by
24740 default.  The @option{-mno-disable-callt} command-line option is not
24741 supported.
24742 @end itemize
24744 When this version of the ABI is enabled the C preprocessor symbol
24745 @code{__V850_RH850_ABI__} is defined.
24747 @item -mgcc-abi
24748 @opindex mgcc-abi
24749 Enables support for the old GCC version of the V850 ABI.  With this
24750 version of the ABI the following rules apply:
24752 @itemize
24753 @item
24754 Integer sized structures and unions are returned in register @code{r10}.
24756 @item
24757 Large structures and unions (more than 8 bytes in size) are passed by
24758 reference.
24760 @item
24761 Functions are aligned to 32-bit boundaries, unless optimizing for
24762 size.
24764 @item
24765 The @option{-m8byte-align} command-line option is not supported.
24767 @item
24768 The @option{-mdisable-callt} command-line option is supported but not
24769 enabled by default.
24770 @end itemize
24772 When this version of the ABI is enabled the C preprocessor symbol
24773 @code{__V850_GCC_ABI__} is defined.
24775 @item -m8byte-align
24776 @itemx -mno-8byte-align
24777 @opindex m8byte-align
24778 @opindex mno-8byte-align
24779 Enables support for @code{double} and @code{long long} types to be
24780 aligned on 8-byte boundaries.  The default is to restrict the
24781 alignment of all objects to at most 4-bytes.  When
24782 @option{-m8byte-align} is in effect the C preprocessor symbol
24783 @code{__V850_8BYTE_ALIGN__} is defined.
24785 @item -mbig-switch
24786 @opindex mbig-switch
24787 Generate code suitable for big switch tables.  Use this option only if
24788 the assembler/linker complain about out of range branches within a switch
24789 table.
24791 @item -mapp-regs
24792 @opindex mapp-regs
24793 This option causes r2 and r5 to be used in the code generated by
24794 the compiler.  This setting is the default.
24796 @item -mno-app-regs
24797 @opindex mno-app-regs
24798 This option causes r2 and r5 to be treated as fixed registers.
24800 @end table
24802 @node VAX Options
24803 @subsection VAX Options
24804 @cindex VAX options
24806 These @samp{-m} options are defined for the VAX:
24808 @table @gcctabopt
24809 @item -munix
24810 @opindex munix
24811 Do not output certain jump instructions (@code{aobleq} and so on)
24812 that the Unix assembler for the VAX cannot handle across long
24813 ranges.
24815 @item -mgnu
24816 @opindex mgnu
24817 Do output those jump instructions, on the assumption that the
24818 GNU assembler is being used.
24820 @item -mg
24821 @opindex mg
24822 Output code for G-format floating-point numbers instead of D-format.
24823 @end table
24825 @node Visium Options
24826 @subsection Visium Options
24827 @cindex Visium options
24829 @table @gcctabopt
24831 @item -mdebug
24832 @opindex mdebug
24833 A program which performs file I/O and is destined to run on an MCM target
24834 should be linked with this option.  It causes the libraries libc.a and
24835 libdebug.a to be linked.  The program should be run on the target under
24836 the control of the GDB remote debugging stub.
24838 @item -msim
24839 @opindex msim
24840 A program which performs file I/O and is destined to run on the simulator
24841 should be linked with option.  This causes libraries libc.a and libsim.a to
24842 be linked.
24844 @item -mfpu
24845 @itemx -mhard-float
24846 @opindex mfpu
24847 @opindex mhard-float
24848 Generate code containing floating-point instructions.  This is the
24849 default.
24851 @item -mno-fpu
24852 @itemx -msoft-float
24853 @opindex mno-fpu
24854 @opindex msoft-float
24855 Generate code containing library calls for floating-point.
24857 @option{-msoft-float} changes the calling convention in the output file;
24858 therefore, it is only useful if you compile @emph{all} of a program with
24859 this option.  In particular, you need to compile @file{libgcc.a}, the
24860 library that comes with GCC, with @option{-msoft-float} in order for
24861 this to work.
24863 @item -mcpu=@var{cpu_type}
24864 @opindex mcpu
24865 Set the instruction set, register set, and instruction scheduling parameters
24866 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
24867 @samp{mcm}, @samp{gr5} and @samp{gr6}.
24869 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
24871 By default (unless configured otherwise), GCC generates code for the GR5
24872 variant of the Visium architecture.  
24874 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
24875 architecture.  The only difference from GR5 code is that the compiler will
24876 generate block move instructions.
24878 @item -mtune=@var{cpu_type}
24879 @opindex mtune
24880 Set the instruction scheduling parameters for machine type @var{cpu_type},
24881 but do not set the instruction set or register set that the option
24882 @option{-mcpu=@var{cpu_type}} would.
24884 @item -msv-mode
24885 @opindex msv-mode
24886 Generate code for the supervisor mode, where there are no restrictions on
24887 the access to general registers.  This is the default.
24889 @item -muser-mode
24890 @opindex muser-mode
24891 Generate code for the user mode, where the access to some general registers
24892 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
24893 mode; on the GR6, only registers r29 to r31 are affected.
24894 @end table
24896 @node VMS Options
24897 @subsection VMS Options
24899 These @samp{-m} options are defined for the VMS implementations:
24901 @table @gcctabopt
24902 @item -mvms-return-codes
24903 @opindex mvms-return-codes
24904 Return VMS condition codes from @code{main}. The default is to return POSIX-style
24905 condition (e.g.@ error) codes.
24907 @item -mdebug-main=@var{prefix}
24908 @opindex mdebug-main=@var{prefix}
24909 Flag the first routine whose name starts with @var{prefix} as the main
24910 routine for the debugger.
24912 @item -mmalloc64
24913 @opindex mmalloc64
24914 Default to 64-bit memory allocation routines.
24916 @item -mpointer-size=@var{size}
24917 @opindex mpointer-size=@var{size}
24918 Set the default size of pointers. Possible options for @var{size} are
24919 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
24920 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
24921 The later option disables @code{pragma pointer_size}.
24922 @end table
24924 @node VxWorks Options
24925 @subsection VxWorks Options
24926 @cindex VxWorks Options
24928 The options in this section are defined for all VxWorks targets.
24929 Options specific to the target hardware are listed with the other
24930 options for that target.
24932 @table @gcctabopt
24933 @item -mrtp
24934 @opindex mrtp
24935 GCC can generate code for both VxWorks kernels and real time processes
24936 (RTPs).  This option switches from the former to the latter.  It also
24937 defines the preprocessor macro @code{__RTP__}.
24939 @item -non-static
24940 @opindex non-static
24941 Link an RTP executable against shared libraries rather than static
24942 libraries.  The options @option{-static} and @option{-shared} can
24943 also be used for RTPs (@pxref{Link Options}); @option{-static}
24944 is the default.
24946 @item -Bstatic
24947 @itemx -Bdynamic
24948 @opindex Bstatic
24949 @opindex Bdynamic
24950 These options are passed down to the linker.  They are defined for
24951 compatibility with Diab.
24953 @item -Xbind-lazy
24954 @opindex Xbind-lazy
24955 Enable lazy binding of function calls.  This option is equivalent to
24956 @option{-Wl,-z,now} and is defined for compatibility with Diab.
24958 @item -Xbind-now
24959 @opindex Xbind-now
24960 Disable lazy binding of function calls.  This option is the default and
24961 is defined for compatibility with Diab.
24962 @end table
24964 @node x86 Options
24965 @subsection x86 Options
24966 @cindex x86 Options
24968 These @samp{-m} options are defined for the x86 family of computers.
24970 @table @gcctabopt
24972 @item -march=@var{cpu-type}
24973 @opindex march
24974 Generate instructions for the machine type @var{cpu-type}.  In contrast to
24975 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
24976 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
24977 to generate code that may not run at all on processors other than the one
24978 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
24979 @option{-mtune=@var{cpu-type}}.
24981 The choices for @var{cpu-type} are:
24983 @table @samp
24984 @item native
24985 This selects the CPU to generate code for at compilation time by determining
24986 the processor type of the compiling machine.  Using @option{-march=native}
24987 enables all instruction subsets supported by the local machine (hence
24988 the result might not run on different machines).  Using @option{-mtune=native}
24989 produces code optimized for the local machine under the constraints
24990 of the selected instruction set.  
24992 @item i386
24993 Original Intel i386 CPU@.
24995 @item i486
24996 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
24998 @item i586
24999 @itemx pentium
25000 Intel Pentium CPU with no MMX support.
25002 @item lakemont
25003 Intel Lakemont MCU, based on Intel Pentium CPU.
25005 @item pentium-mmx
25006 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
25008 @item pentiumpro
25009 Intel Pentium Pro CPU@.
25011 @item i686
25012 When used with @option{-march}, the Pentium Pro
25013 instruction set is used, so the code runs on all i686 family chips.
25014 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
25016 @item pentium2
25017 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
25018 support.
25020 @item pentium3
25021 @itemx pentium3m
25022 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
25023 set support.
25025 @item pentium-m
25026 Intel Pentium M; low-power version of Intel Pentium III CPU
25027 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
25029 @item pentium4
25030 @itemx pentium4m
25031 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
25033 @item prescott
25034 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
25035 set support.
25037 @item nocona
25038 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
25039 SSE2 and SSE3 instruction set support.
25041 @item core2
25042 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
25043 instruction set support.
25045 @item nehalem
25046 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25047 SSE4.1, SSE4.2 and POPCNT instruction set support.
25049 @item westmere
25050 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25051 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
25053 @item sandybridge
25054 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25055 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
25057 @item ivybridge
25058 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
25059 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
25060 instruction set support.
25062 @item haswell
25063 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25064 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25065 BMI, BMI2 and F16C instruction set support.
25067 @item broadwell
25068 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25069 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25070 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
25072 @item skylake
25073 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25074 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25075 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
25076 XSAVES instruction set support.
25078 @item bonnell
25079 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
25080 instruction set support.
25082 @item silvermont
25083 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
25084 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
25086 @item knl
25087 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25088 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25089 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
25090 AVX512CD instruction set support.
25092 @item skylake-avx512
25093 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
25094 SSSE3, SSE4.1, SSE4.2, POPCNT, PKU, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
25095 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
25096 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
25098 @item k6
25099 AMD K6 CPU with MMX instruction set support.
25101 @item k6-2
25102 @itemx k6-3
25103 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
25105 @item athlon
25106 @itemx athlon-tbird
25107 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
25108 support.
25110 @item athlon-4
25111 @itemx athlon-xp
25112 @itemx athlon-mp
25113 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
25114 instruction set support.
25116 @item k8
25117 @itemx opteron
25118 @itemx athlon64
25119 @itemx athlon-fx
25120 Processors based on the AMD K8 core with x86-64 instruction set support,
25121 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
25122 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
25123 instruction set extensions.)
25125 @item k8-sse3
25126 @itemx opteron-sse3
25127 @itemx athlon64-sse3
25128 Improved versions of AMD K8 cores with SSE3 instruction set support.
25130 @item amdfam10
25131 @itemx barcelona
25132 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
25133 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
25134 instruction set extensions.)
25136 @item bdver1
25137 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
25138 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
25139 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
25140 @item bdver2
25141 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25142 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
25143 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
25144 extensions.)
25145 @item bdver3
25146 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25147 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
25148 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
25149 64-bit instruction set extensions.
25150 @item bdver4
25151 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
25152 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
25153 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
25154 SSE4.2, ABM and 64-bit instruction set extensions.
25156 @item znver1
25157 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
25158 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
25159 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
25160 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
25161 instruction set extensions.
25163 @item btver1
25164 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
25165 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
25166 instruction set extensions.)
25168 @item btver2
25169 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
25170 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
25171 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
25173 @item winchip-c6
25174 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
25175 set support.
25177 @item winchip2
25178 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
25179 instruction set support.
25181 @item c3
25182 VIA C3 CPU with MMX and 3DNow!@: instruction set support.
25183 (No scheduling is implemented for this chip.)
25185 @item c3-2
25186 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
25187 (No scheduling is implemented for this chip.)
25189 @item c7
25190 VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25191 (No scheduling is implemented for this chip.)
25193 @item samuel-2
25194 VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support.
25195 (No scheduling is implemented for this chip.)
25197 @item nehemiah
25198 VIA Eden Nehemiah CPU with MMX and SSE instruction set support.
25199 (No scheduling is implemented for this chip.)
25201 @item esther
25202 VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support.
25203 (No scheduling is implemented for this chip.)
25205 @item eden-x2
25206 VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support.
25207 (No scheduling is implemented for this chip.)
25209 @item eden-x4
25210 VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2,
25211 AVX and AVX2 instruction set support.
25212 (No scheduling is implemented for this chip.)
25214 @item nano
25215 Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25216 instruction set support.
25217 (No scheduling is implemented for this chip.)
25219 @item nano-1000
25220 VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25221 instruction set support.
25222 (No scheduling is implemented for this chip.)
25224 @item nano-2000
25225 VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3
25226 instruction set support.
25227 (No scheduling is implemented for this chip.)
25229 @item nano-3000
25230 VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25231 instruction set support.
25232 (No scheduling is implemented for this chip.)
25234 @item nano-x2
25235 VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25236 instruction set support.
25237 (No scheduling is implemented for this chip.)
25239 @item nano-x4
25240 VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1
25241 instruction set support.
25242 (No scheduling is implemented for this chip.)
25244 @item geode
25245 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
25246 @end table
25248 @item -mtune=@var{cpu-type}
25249 @opindex mtune
25250 Tune to @var{cpu-type} everything applicable about the generated code, except
25251 for the ABI and the set of available instructions.  
25252 While picking a specific @var{cpu-type} schedules things appropriately
25253 for that particular chip, the compiler does not generate any code that
25254 cannot run on the default machine type unless you use a
25255 @option{-march=@var{cpu-type}} option.
25256 For example, if GCC is configured for i686-pc-linux-gnu
25257 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
25258 but still runs on i686 machines.
25260 The choices for @var{cpu-type} are the same as for @option{-march}.
25261 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
25263 @table @samp
25264 @item generic
25265 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
25266 If you know the CPU on which your code will run, then you should use
25267 the corresponding @option{-mtune} or @option{-march} option instead of
25268 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
25269 of your application will have, then you should use this option.
25271 As new processors are deployed in the marketplace, the behavior of this
25272 option will change.  Therefore, if you upgrade to a newer version of
25273 GCC, code generation controlled by this option will change to reflect
25274 the processors
25275 that are most common at the time that version of GCC is released.
25277 There is no @option{-march=generic} option because @option{-march}
25278 indicates the instruction set the compiler can use, and there is no
25279 generic instruction set applicable to all processors.  In contrast,
25280 @option{-mtune} indicates the processor (or, in this case, collection of
25281 processors) for which the code is optimized.
25283 @item intel
25284 Produce code optimized for the most current Intel processors, which are
25285 Haswell and Silvermont for this version of GCC.  If you know the CPU
25286 on which your code will run, then you should use the corresponding
25287 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
25288 But, if you want your application performs better on both Haswell and
25289 Silvermont, then you should use this option.
25291 As new Intel processors are deployed in the marketplace, the behavior of
25292 this option will change.  Therefore, if you upgrade to a newer version of
25293 GCC, code generation controlled by this option will change to reflect
25294 the most current Intel processors at the time that version of GCC is
25295 released.
25297 There is no @option{-march=intel} option because @option{-march} indicates
25298 the instruction set the compiler can use, and there is no common
25299 instruction set applicable to all processors.  In contrast,
25300 @option{-mtune} indicates the processor (or, in this case, collection of
25301 processors) for which the code is optimized.
25302 @end table
25304 @item -mcpu=@var{cpu-type}
25305 @opindex mcpu
25306 A deprecated synonym for @option{-mtune}.
25308 @item -mfpmath=@var{unit}
25309 @opindex mfpmath
25310 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
25311 for @var{unit} are:
25313 @table @samp
25314 @item 387
25315 Use the standard 387 floating-point coprocessor present on the majority of chips and
25316 emulated otherwise.  Code compiled with this option runs almost everywhere.
25317 The temporary results are computed in 80-bit precision instead of the precision
25318 specified by the type, resulting in slightly different results compared to most
25319 of other chips.  See @option{-ffloat-store} for more detailed description.
25321 This is the default choice for non-Darwin x86-32 targets.
25323 @item sse
25324 Use scalar floating-point instructions present in the SSE instruction set.
25325 This instruction set is supported by Pentium III and newer chips,
25326 and in the AMD line
25327 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
25328 instruction set supports only single-precision arithmetic, thus the double and
25329 extended-precision arithmetic are still done using 387.  A later version, present
25330 only in Pentium 4 and AMD x86-64 chips, supports double-precision
25331 arithmetic too.
25333 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
25334 or @option{-msse2} switches to enable SSE extensions and make this option
25335 effective.  For the x86-64 compiler, these extensions are enabled by default.
25337 The resulting code should be considerably faster in the majority of cases and avoid
25338 the numerical instability problems of 387 code, but may break some existing
25339 code that expects temporaries to be 80 bits.
25341 This is the default choice for the x86-64 compiler, Darwin x86-32 targets,
25342 and the default choice for x86-32 targets with the SSE2 instruction set
25343 when @option{-ffast-math} is enabled.
25345 @item sse,387
25346 @itemx sse+387
25347 @itemx both
25348 Attempt to utilize both instruction sets at once.  This effectively doubles the
25349 amount of available registers, and on chips with separate execution units for
25350 387 and SSE the execution resources too.  Use this option with care, as it is
25351 still experimental, because the GCC register allocator does not model separate
25352 functional units well, resulting in unstable performance.
25353 @end table
25355 @item -masm=@var{dialect}
25356 @opindex masm=@var{dialect}
25357 Output assembly instructions using selected @var{dialect}.  Also affects
25358 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
25359 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
25360 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
25361 not support @samp{intel}.
25363 @item -mieee-fp
25364 @itemx -mno-ieee-fp
25365 @opindex mieee-fp
25366 @opindex mno-ieee-fp
25367 Control whether or not the compiler uses IEEE floating-point
25368 comparisons.  These correctly handle the case where the result of a
25369 comparison is unordered.
25371 @item -m80387
25372 @item -mhard-float
25373 @opindex 80387
25374 @opindex mhard-float
25375 Generate output containing 80387 instructions for floating point.
25377 @item -mno-80387
25378 @item -msoft-float
25379 @opindex no-80387
25380 @opindex msoft-float
25381 Generate output containing library calls for floating point.
25383 @strong{Warning:} the requisite libraries are not part of GCC@.
25384 Normally the facilities of the machine's usual C compiler are used, but
25385 this cannot be done directly in cross-compilation.  You must make your
25386 own arrangements to provide suitable library functions for
25387 cross-compilation.
25389 On machines where a function returns floating-point results in the 80387
25390 register stack, some floating-point opcodes may be emitted even if
25391 @option{-msoft-float} is used.
25393 @item -mno-fp-ret-in-387
25394 @opindex mno-fp-ret-in-387
25395 Do not use the FPU registers for return values of functions.
25397 The usual calling convention has functions return values of types
25398 @code{float} and @code{double} in an FPU register, even if there
25399 is no FPU@.  The idea is that the operating system should emulate
25400 an FPU@.
25402 The option @option{-mno-fp-ret-in-387} causes such values to be returned
25403 in ordinary CPU registers instead.
25405 @item -mno-fancy-math-387
25406 @opindex mno-fancy-math-387
25407 Some 387 emulators do not support the @code{sin}, @code{cos} and
25408 @code{sqrt} instructions for the 387.  Specify this option to avoid
25409 generating those instructions.  This option is the default on
25410 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
25411 indicates that the target CPU always has an FPU and so the
25412 instruction does not need emulation.  These
25413 instructions are not generated unless you also use the
25414 @option{-funsafe-math-optimizations} switch.
25416 @item -malign-double
25417 @itemx -mno-align-double
25418 @opindex malign-double
25419 @opindex mno-align-double
25420 Control whether GCC aligns @code{double}, @code{long double}, and
25421 @code{long long} variables on a two-word boundary or a one-word
25422 boundary.  Aligning @code{double} variables on a two-word boundary
25423 produces code that runs somewhat faster on a Pentium at the
25424 expense of more memory.
25426 On x86-64, @option{-malign-double} is enabled by default.
25428 @strong{Warning:} if you use the @option{-malign-double} switch,
25429 structures containing the above types are aligned differently than
25430 the published application binary interface specifications for the x86-32
25431 and are not binary compatible with structures in code compiled
25432 without that switch.
25434 @item -m96bit-long-double
25435 @itemx -m128bit-long-double
25436 @opindex m96bit-long-double
25437 @opindex m128bit-long-double
25438 These switches control the size of @code{long double} type.  The x86-32
25439 application binary interface specifies the size to be 96 bits,
25440 so @option{-m96bit-long-double} is the default in 32-bit mode.
25442 Modern architectures (Pentium and newer) prefer @code{long double}
25443 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
25444 conforming to the ABI, this is not possible.  So specifying
25445 @option{-m128bit-long-double} aligns @code{long double}
25446 to a 16-byte boundary by padding the @code{long double} with an additional
25447 32-bit zero.
25449 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
25450 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
25452 Notice that neither of these options enable any extra precision over the x87
25453 standard of 80 bits for a @code{long double}.
25455 @strong{Warning:} if you override the default value for your target ABI, this
25456 changes the size of 
25457 structures and arrays containing @code{long double} variables,
25458 as well as modifying the function calling convention for functions taking
25459 @code{long double}.  Hence they are not binary-compatible
25460 with code compiled without that switch.
25462 @item -mlong-double-64
25463 @itemx -mlong-double-80
25464 @itemx -mlong-double-128
25465 @opindex mlong-double-64
25466 @opindex mlong-double-80
25467 @opindex mlong-double-128
25468 These switches control the size of @code{long double} type. A size
25469 of 64 bits makes the @code{long double} type equivalent to the @code{double}
25470 type. This is the default for 32-bit Bionic C library.  A size
25471 of 128 bits makes the @code{long double} type equivalent to the
25472 @code{__float128} type. This is the default for 64-bit Bionic C library.
25474 @strong{Warning:} if you override the default value for your target ABI, this
25475 changes the size of
25476 structures and arrays containing @code{long double} variables,
25477 as well as modifying the function calling convention for functions taking
25478 @code{long double}.  Hence they are not binary-compatible
25479 with code compiled without that switch.
25481 @item -malign-data=@var{type}
25482 @opindex malign-data
25483 Control how GCC aligns variables.  Supported values for @var{type} are
25484 @samp{compat} uses increased alignment value compatible uses GCC 4.8
25485 and earlier, @samp{abi} uses alignment value as specified by the
25486 psABI, and @samp{cacheline} uses increased alignment value to match
25487 the cache line size.  @samp{compat} is the default.
25489 @item -mlarge-data-threshold=@var{threshold}
25490 @opindex mlarge-data-threshold
25491 When @option{-mcmodel=medium} is specified, data objects larger than
25492 @var{threshold} are placed in the large data section.  This value must be the
25493 same across all objects linked into the binary, and defaults to 65535.
25495 @item -mrtd
25496 @opindex mrtd
25497 Use a different function-calling convention, in which functions that
25498 take a fixed number of arguments return with the @code{ret @var{num}}
25499 instruction, which pops their arguments while returning.  This saves one
25500 instruction in the caller since there is no need to pop the arguments
25501 there.
25503 You can specify that an individual function is called with this calling
25504 sequence with the function attribute @code{stdcall}.  You can also
25505 override the @option{-mrtd} option by using the function attribute
25506 @code{cdecl}.  @xref{Function Attributes}.
25508 @strong{Warning:} this calling convention is incompatible with the one
25509 normally used on Unix, so you cannot use it if you need to call
25510 libraries compiled with the Unix compiler.
25512 Also, you must provide function prototypes for all functions that
25513 take variable numbers of arguments (including @code{printf});
25514 otherwise incorrect code is generated for calls to those
25515 functions.
25517 In addition, seriously incorrect code results if you call a
25518 function with too many arguments.  (Normally, extra arguments are
25519 harmlessly ignored.)
25521 @item -mregparm=@var{num}
25522 @opindex mregparm
25523 Control how many registers are used to pass integer arguments.  By
25524 default, no registers are used to pass arguments, and at most 3
25525 registers can be used.  You can control this behavior for a specific
25526 function by using the function attribute @code{regparm}.
25527 @xref{Function Attributes}.
25529 @strong{Warning:} if you use this switch, and
25530 @var{num} is nonzero, then you must build all modules with the same
25531 value, including any libraries.  This includes the system libraries and
25532 startup modules.
25534 @item -msseregparm
25535 @opindex msseregparm
25536 Use SSE register passing conventions for float and double arguments
25537 and return values.  You can control this behavior for a specific
25538 function by using the function attribute @code{sseregparm}.
25539 @xref{Function Attributes}.
25541 @strong{Warning:} if you use this switch then you must build all
25542 modules with the same value, including any libraries.  This includes
25543 the system libraries and startup modules.
25545 @item -mvect8-ret-in-mem
25546 @opindex mvect8-ret-in-mem
25547 Return 8-byte vectors in memory instead of MMX registers.  This is the
25548 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
25549 Studio compilers until version 12.  Later compiler versions (starting
25550 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
25551 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
25552 you need to remain compatible with existing code produced by those
25553 previous compiler versions or older versions of GCC@.
25555 @item -mpc32
25556 @itemx -mpc64
25557 @itemx -mpc80
25558 @opindex mpc32
25559 @opindex mpc64
25560 @opindex mpc80
25562 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
25563 is specified, the significands of results of floating-point operations are
25564 rounded to 24 bits (single precision); @option{-mpc64} rounds the
25565 significands of results of floating-point operations to 53 bits (double
25566 precision) and @option{-mpc80} rounds the significands of results of
25567 floating-point operations to 64 bits (extended double precision), which is
25568 the default.  When this option is used, floating-point operations in higher
25569 precisions are not available to the programmer without setting the FPU
25570 control word explicitly.
25572 Setting the rounding of floating-point operations to less than the default
25573 80 bits can speed some programs by 2% or more.  Note that some mathematical
25574 libraries assume that extended-precision (80-bit) floating-point operations
25575 are enabled by default; routines in such libraries could suffer significant
25576 loss of accuracy, typically through so-called ``catastrophic cancellation'',
25577 when this option is used to set the precision to less than extended precision.
25579 @item -mstackrealign
25580 @opindex mstackrealign
25581 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
25582 option generates an alternate prologue and epilogue that realigns the
25583 run-time stack if necessary.  This supports mixing legacy codes that keep
25584 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
25585 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
25586 applicable to individual functions.
25588 @item -mpreferred-stack-boundary=@var{num}
25589 @opindex mpreferred-stack-boundary
25590 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
25591 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
25592 the default is 4 (16 bytes or 128 bits).
25594 @strong{Warning:} When generating code for the x86-64 architecture with
25595 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
25596 used to keep the stack boundary aligned to 8 byte boundary.  Since
25597 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
25598 intended to be used in controlled environment where stack space is
25599 important limitation.  This option leads to wrong code when functions
25600 compiled with 16 byte stack alignment (such as functions from a standard
25601 library) are called with misaligned stack.  In this case, SSE
25602 instructions may lead to misaligned memory access traps.  In addition,
25603 variable arguments are handled incorrectly for 16 byte aligned
25604 objects (including x87 long double and __int128), leading to wrong
25605 results.  You must build all modules with
25606 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
25607 includes the system libraries and startup modules.
25609 @item -mincoming-stack-boundary=@var{num}
25610 @opindex mincoming-stack-boundary
25611 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
25612 boundary.  If @option{-mincoming-stack-boundary} is not specified,
25613 the one specified by @option{-mpreferred-stack-boundary} is used.
25615 On Pentium and Pentium Pro, @code{double} and @code{long double} values
25616 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
25617 suffer significant run time performance penalties.  On Pentium III, the
25618 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
25619 properly if it is not 16-byte aligned.
25621 To ensure proper alignment of this values on the stack, the stack boundary
25622 must be as aligned as that required by any value stored on the stack.
25623 Further, every function must be generated such that it keeps the stack
25624 aligned.  Thus calling a function compiled with a higher preferred
25625 stack boundary from a function compiled with a lower preferred stack
25626 boundary most likely misaligns the stack.  It is recommended that
25627 libraries that use callbacks always use the default setting.
25629 This extra alignment does consume extra stack space, and generally
25630 increases code size.  Code that is sensitive to stack space usage, such
25631 as embedded systems and operating system kernels, may want to reduce the
25632 preferred alignment to @option{-mpreferred-stack-boundary=2}.
25634 @need 200
25635 @item -mmmx
25636 @opindex mmmx
25637 @need 200
25638 @itemx -msse
25639 @opindex msse
25640 @need 200
25641 @itemx -msse2
25642 @opindex msse2
25643 @need 200
25644 @itemx -msse3
25645 @opindex msse3
25646 @need 200
25647 @itemx -mssse3
25648 @opindex mssse3
25649 @need 200
25650 @itemx -msse4
25651 @opindex msse4
25652 @need 200
25653 @itemx -msse4a
25654 @opindex msse4a
25655 @need 200
25656 @itemx -msse4.1
25657 @opindex msse4.1
25658 @need 200
25659 @itemx -msse4.2
25660 @opindex msse4.2
25661 @need 200
25662 @itemx -mavx
25663 @opindex mavx
25664 @need 200
25665 @itemx -mavx2
25666 @opindex mavx2
25667 @need 200
25668 @itemx -mavx512f
25669 @opindex mavx512f
25670 @need 200
25671 @itemx -mavx512pf
25672 @opindex mavx512pf
25673 @need 200
25674 @itemx -mavx512er
25675 @opindex mavx512er
25676 @need 200
25677 @itemx -mavx512cd
25678 @opindex mavx512cd
25679 @need 200
25680 @itemx -mavx512vl
25681 @opindex mavx512vl
25682 @need 200
25683 @itemx -mavx512bw
25684 @opindex mavx512bw
25685 @need 200
25686 @itemx -mavx512dq
25687 @opindex mavx512dq
25688 @need 200
25689 @itemx -mavx512ifma
25690 @opindex mavx512ifma
25691 @need 200
25692 @itemx -mavx512vbmi
25693 @opindex mavx512vbmi
25694 @need 200
25695 @itemx -msha
25696 @opindex msha
25697 @need 200
25698 @itemx -maes
25699 @opindex maes
25700 @need 200
25701 @itemx -mpclmul
25702 @opindex mpclmul
25703 @need 200
25704 @itemx -mclfushopt
25705 @opindex mclfushopt
25706 @need 200
25707 @itemx -mfsgsbase
25708 @opindex mfsgsbase
25709 @need 200
25710 @itemx -mrdrnd
25711 @opindex mrdrnd
25712 @need 200
25713 @itemx -mf16c
25714 @opindex mf16c
25715 @need 200
25716 @itemx -mfma
25717 @opindex mfma
25718 @need 200
25719 @itemx -mfma4
25720 @opindex mfma4
25721 @need 200
25722 @itemx -mprefetchwt1
25723 @opindex mprefetchwt1
25724 @need 200
25725 @itemx -mxop
25726 @opindex mxop
25727 @need 200
25728 @itemx -mlwp
25729 @opindex mlwp
25730 @need 200
25731 @itemx -m3dnow
25732 @opindex m3dnow
25733 @need 200
25734 @itemx -m3dnowa
25735 @opindex m3dnowa
25736 @need 200
25737 @itemx -mpopcnt
25738 @opindex mpopcnt
25739 @need 200
25740 @itemx -mabm
25741 @opindex mabm
25742 @need 200
25743 @itemx -mbmi
25744 @opindex mbmi
25745 @need 200
25746 @itemx -mbmi2
25747 @need 200
25748 @itemx -mlzcnt
25749 @opindex mlzcnt
25750 @need 200
25751 @itemx -mfxsr
25752 @opindex mfxsr
25753 @need 200
25754 @itemx -mxsave
25755 @opindex mxsave
25756 @need 200
25757 @itemx -mxsaveopt
25758 @opindex mxsaveopt
25759 @need 200
25760 @itemx -mxsavec
25761 @opindex mxsavec
25762 @need 200
25763 @itemx -mxsaves
25764 @opindex mxsaves
25765 @need 200
25766 @itemx -mrtm
25767 @opindex mrtm
25768 @need 200
25769 @itemx -mtbm
25770 @opindex mtbm
25771 @need 200
25772 @itemx -mmpx
25773 @opindex mmpx
25774 @need 200
25775 @itemx -mmwaitx
25776 @opindex mmwaitx
25777 @need 200
25778 @itemx -mclzero
25779 @opindex mclzero
25780 @itemx -mpku
25781 @opindex mpku
25782 These switches enable the use of instructions in the MMX, SSE,
25783 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
25784 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
25785 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
25786 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX, PKU, 3DNow!@: or enhanced 3DNow!@:
25787 extended instruction sets.  Each has a corresponding @option{-mno-} option
25788 to disable use of these instructions.
25790 These extensions are also available as built-in functions: see
25791 @ref{x86 Built-in Functions}, for details of the functions enabled and
25792 disabled by these switches.
25794 To generate SSE/SSE2 instructions automatically from floating-point
25795 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
25797 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
25798 generates new AVX instructions or AVX equivalence for all SSEx instructions
25799 when needed.
25801 These options enable GCC to use these extended instructions in
25802 generated code, even without @option{-mfpmath=sse}.  Applications that
25803 perform run-time CPU detection must compile separate files for each
25804 supported architecture, using the appropriate flags.  In particular,
25805 the file containing the CPU detection code should be compiled without
25806 these options.
25808 @item -mdump-tune-features
25809 @opindex mdump-tune-features
25810 This option instructs GCC to dump the names of the x86 performance 
25811 tuning features and default settings. The names can be used in 
25812 @option{-mtune-ctrl=@var{feature-list}}.
25814 @item -mtune-ctrl=@var{feature-list}
25815 @opindex mtune-ctrl=@var{feature-list}
25816 This option is used to do fine grain control of x86 code generation features.
25817 @var{feature-list} is a comma separated list of @var{feature} names. See also
25818 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
25819 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
25820 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
25821 developers. Using it may lead to code paths not covered by testing and can
25822 potentially result in compiler ICEs or runtime errors.
25824 @item -mno-default
25825 @opindex mno-default
25826 This option instructs GCC to turn off all tunable features. See also 
25827 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
25829 @item -mcld
25830 @opindex mcld
25831 This option instructs GCC to emit a @code{cld} instruction in the prologue
25832 of functions that use string instructions.  String instructions depend on
25833 the DF flag to select between autoincrement or autodecrement mode.  While the
25834 ABI specifies the DF flag to be cleared on function entry, some operating
25835 systems violate this specification by not clearing the DF flag in their
25836 exception dispatchers.  The exception handler can be invoked with the DF flag
25837 set, which leads to wrong direction mode when string instructions are used.
25838 This option can be enabled by default on 32-bit x86 targets by configuring
25839 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
25840 instructions can be suppressed with the @option{-mno-cld} compiler option
25841 in this case.
25843 @item -mvzeroupper
25844 @opindex mvzeroupper
25845 This option instructs GCC to emit a @code{vzeroupper} instruction
25846 before a transfer of control flow out of the function to minimize
25847 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
25848 intrinsics.
25850 @item -mprefer-avx128
25851 @opindex mprefer-avx128
25852 This option instructs GCC to use 128-bit AVX instructions instead of
25853 256-bit AVX instructions in the auto-vectorizer.
25855 @item -mcx16
25856 @opindex mcx16
25857 This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit
25858 code to implement compare-and-exchange operations on 16-byte aligned 128-bit
25859 objects.  This is useful for atomic updates of data structures exceeding one
25860 machine word in size.  The compiler uses this instruction to implement
25861 @ref{__sync Builtins}.  However, for @ref{__atomic Builtins} operating on
25862 128-bit integers, a library call is always used.
25864 @item -msahf
25865 @opindex msahf
25866 This option enables generation of @code{SAHF} instructions in 64-bit code.
25867 Early Intel Pentium 4 CPUs with Intel 64 support,
25868 prior to the introduction of Pentium 4 G1 step in December 2005,
25869 lacked the @code{LAHF} and @code{SAHF} instructions
25870 which are supported by AMD64.
25871 These are load and store instructions, respectively, for certain status flags.
25872 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
25873 @code{drem}, and @code{remainder} built-in functions;
25874 see @ref{Other Builtins} for details.
25876 @item -mmovbe
25877 @opindex mmovbe
25878 This option enables use of the @code{movbe} instruction to implement
25879 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
25881 @item -mcrc32
25882 @opindex mcrc32
25883 This option enables built-in functions @code{__builtin_ia32_crc32qi},
25884 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
25885 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
25887 @item -mrecip
25888 @opindex mrecip
25889 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
25890 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
25891 with an additional Newton-Raphson step
25892 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
25893 (and their vectorized
25894 variants) for single-precision floating-point arguments.  These instructions
25895 are generated only when @option{-funsafe-math-optimizations} is enabled
25896 together with @option{-ffinite-math-only} and @option{-fno-trapping-math}.
25897 Note that while the throughput of the sequence is higher than the throughput
25898 of the non-reciprocal instruction, the precision of the sequence can be
25899 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
25901 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
25902 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
25903 combination), and doesn't need @option{-mrecip}.
25905 Also note that GCC emits the above sequence with additional Newton-Raphson step
25906 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
25907 already with @option{-ffast-math} (or the above option combination), and
25908 doesn't need @option{-mrecip}.
25910 @item -mrecip=@var{opt}
25911 @opindex mrecip=opt
25912 This option controls which reciprocal estimate instructions
25913 may be used.  @var{opt} is a comma-separated list of options, which may
25914 be preceded by a @samp{!} to invert the option:
25916 @table @samp
25917 @item all
25918 Enable all estimate instructions.
25920 @item default
25921 Enable the default instructions, equivalent to @option{-mrecip}.
25923 @item none
25924 Disable all estimate instructions, equivalent to @option{-mno-recip}.
25926 @item div
25927 Enable the approximation for scalar division.
25929 @item vec-div
25930 Enable the approximation for vectorized division.
25932 @item sqrt
25933 Enable the approximation for scalar square root.
25935 @item vec-sqrt
25936 Enable the approximation for vectorized square root.
25937 @end table
25939 So, for example, @option{-mrecip=all,!sqrt} enables
25940 all of the reciprocal approximations, except for square root.
25942 @item -mveclibabi=@var{type}
25943 @opindex mveclibabi
25944 Specifies the ABI type to use for vectorizing intrinsics using an
25945 external library.  Supported values for @var{type} are @samp{svml} 
25946 for the Intel short
25947 vector math library and @samp{acml} for the AMD math core library.
25948 To use this option, both @option{-ftree-vectorize} and
25949 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
25950 ABI-compatible library must be specified at link time.
25952 GCC currently emits calls to @code{vmldExp2},
25953 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
25954 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
25955 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
25956 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
25957 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
25958 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
25959 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
25960 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
25961 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
25962 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
25963 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
25964 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
25965 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
25966 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
25967 when @option{-mveclibabi=acml} is used.  
25969 @item -mabi=@var{name}
25970 @opindex mabi
25971 Generate code for the specified calling convention.  Permissible values
25972 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
25973 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
25974 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
25975 You can control this behavior for specific functions by
25976 using the function attributes @code{ms_abi} and @code{sysv_abi}.
25977 @xref{Function Attributes}.
25979 @item -mcall-ms2sysv-xlogues
25980 @opindex mcall-ms2sysv-xlogues
25981 @opindex mno-call-ms2sysv-xlogues
25982 Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a
25983 System V ABI function must consider RSI, RDI and XMM6-15 as clobbered.  By
25984 default, the code for saving and restoring these registers is emitted inline,
25985 resulting in fairly lengthy prologues and epilogues.  Using
25986 @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that
25987 use stubs in the static portion of libgcc to perform these saves and restores,
25988 thus reducing function size at the cost of a few extra instructions.
25990 @item -mtls-dialect=@var{type}
25991 @opindex mtls-dialect
25992 Generate code to access thread-local storage using the @samp{gnu} or
25993 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
25994 @samp{gnu2} is more efficient, but it may add compile- and run-time
25995 requirements that cannot be satisfied on all systems.
25997 @item -mpush-args
25998 @itemx -mno-push-args
25999 @opindex mpush-args
26000 @opindex mno-push-args
26001 Use PUSH operations to store outgoing parameters.  This method is shorter
26002 and usually equally fast as method using SUB/MOV operations and is enabled
26003 by default.  In some cases disabling it may improve performance because of
26004 improved scheduling and reduced dependencies.
26006 @item -maccumulate-outgoing-args
26007 @opindex maccumulate-outgoing-args
26008 If enabled, the maximum amount of space required for outgoing arguments is
26009 computed in the function prologue.  This is faster on most modern CPUs
26010 because of reduced dependencies, improved scheduling and reduced stack usage
26011 when the preferred stack boundary is not equal to 2.  The drawback is a notable
26012 increase in code size.  This switch implies @option{-mno-push-args}.
26014 @item -mthreads
26015 @opindex mthreads
26016 Support thread-safe exception handling on MinGW.  Programs that rely
26017 on thread-safe exception handling must compile and link all code with the
26018 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
26019 @option{-D_MT}; when linking, it links in a special thread helper library
26020 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
26022 @item -mms-bitfields
26023 @itemx -mno-ms-bitfields
26024 @opindex mms-bitfields
26025 @opindex mno-ms-bitfields
26027 Enable/disable bit-field layout compatible with the native Microsoft
26028 Windows compiler.  
26030 If @code{packed} is used on a structure, or if bit-fields are used,
26031 it may be that the Microsoft ABI lays out the structure differently
26032 than the way GCC normally does.  Particularly when moving packed
26033 data between functions compiled with GCC and the native Microsoft compiler
26034 (either via function call or as data in a file), it may be necessary to access
26035 either format.
26037 This option is enabled by default for Microsoft Windows
26038 targets.  This behavior can also be controlled locally by use of variable
26039 or type attributes.  For more information, see @ref{x86 Variable Attributes}
26040 and @ref{x86 Type Attributes}.
26042 The Microsoft structure layout algorithm is fairly simple with the exception
26043 of the bit-field packing.  
26044 The padding and alignment of members of structures and whether a bit-field 
26045 can straddle a storage-unit boundary are determine by these rules:
26047 @enumerate
26048 @item Structure members are stored sequentially in the order in which they are
26049 declared: the first member has the lowest memory address and the last member
26050 the highest.
26052 @item Every data object has an alignment requirement.  The alignment requirement
26053 for all data except structures, unions, and arrays is either the size of the
26054 object or the current packing size (specified with either the
26055 @code{aligned} attribute or the @code{pack} pragma),
26056 whichever is less.  For structures, unions, and arrays,
26057 the alignment requirement is the largest alignment requirement of its members.
26058 Every object is allocated an offset so that:
26060 @smallexample
26061 offset % alignment_requirement == 0
26062 @end smallexample
26064 @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation
26065 unit if the integral types are the same size and if the next bit-field fits
26066 into the current allocation unit without crossing the boundary imposed by the
26067 common alignment requirements of the bit-fields.
26068 @end enumerate
26070 MSVC interprets zero-length bit-fields in the following ways:
26072 @enumerate
26073 @item If a zero-length bit-field is inserted between two bit-fields that
26074 are normally coalesced, the bit-fields are not coalesced.
26076 For example:
26078 @smallexample
26079 struct
26080  @{
26081    unsigned long bf_1 : 12;
26082    unsigned long : 0;
26083    unsigned long bf_2 : 12;
26084  @} t1;
26085 @end smallexample
26087 @noindent
26088 The size of @code{t1} is 8 bytes with the zero-length bit-field.  If the
26089 zero-length bit-field were removed, @code{t1}'s size would be 4 bytes.
26091 @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the
26092 alignment of the zero-length bit-field is greater than the member that follows it,
26093 @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field.
26095 For example:
26097 @smallexample
26098 struct
26099  @{
26100    char foo : 4;
26101    short : 0;
26102    char bar;
26103  @} t2;
26105 struct
26106  @{
26107    char foo : 4;
26108    short : 0;
26109    double bar;
26110  @} t3;
26111 @end smallexample
26113 @noindent
26114 For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1.
26115 Accordingly, the size of @code{t2} is 4.  For @code{t3}, the zero-length
26116 bit-field does not affect the alignment of @code{bar} or, as a result, the size
26117 of the structure.
26119 Taking this into account, it is important to note the following:
26121 @enumerate
26122 @item If a zero-length bit-field follows a normal bit-field, the type of the
26123 zero-length bit-field may affect the alignment of the structure as whole. For
26124 example, @code{t2} has a size of 4 bytes, since the zero-length bit-field follows a
26125 normal bit-field, and is of type short.
26127 @item Even if a zero-length bit-field is not followed by a normal bit-field, it may
26128 still affect the alignment of the structure:
26130 @smallexample
26131 struct
26132  @{
26133    char foo : 6;
26134    long : 0;
26135  @} t4;
26136 @end smallexample
26138 @noindent
26139 Here, @code{t4} takes up 4 bytes.
26140 @end enumerate
26142 @item Zero-length bit-fields following non-bit-field members are ignored:
26144 @smallexample
26145 struct
26146  @{
26147    char foo;
26148    long : 0;
26149    char bar;
26150  @} t5;
26151 @end smallexample
26153 @noindent
26154 Here, @code{t5} takes up 2 bytes.
26155 @end enumerate
26158 @item -mno-align-stringops
26159 @opindex mno-align-stringops
26160 Do not align the destination of inlined string operations.  This switch reduces
26161 code size and improves performance in case the destination is already aligned,
26162 but GCC doesn't know about it.
26164 @item -minline-all-stringops
26165 @opindex minline-all-stringops
26166 By default GCC inlines string operations only when the destination is 
26167 known to be aligned to least a 4-byte boundary.  
26168 This enables more inlining and increases code
26169 size, but may improve performance of code that depends on fast
26170 @code{memcpy}, @code{strlen},
26171 and @code{memset} for short lengths.
26173 @item -minline-stringops-dynamically
26174 @opindex minline-stringops-dynamically
26175 For string operations of unknown size, use run-time checks with
26176 inline code for small blocks and a library call for large blocks.
26178 @item -mstringop-strategy=@var{alg}
26179 @opindex mstringop-strategy=@var{alg}
26180 Override the internal decision heuristic for the particular algorithm to use
26181 for inlining string operations.  The allowed values for @var{alg} are:
26183 @table @samp
26184 @item rep_byte
26185 @itemx rep_4byte
26186 @itemx rep_8byte
26187 Expand using i386 @code{rep} prefix of the specified size.
26189 @item byte_loop
26190 @itemx loop
26191 @itemx unrolled_loop
26192 Expand into an inline loop.
26194 @item libcall
26195 Always use a library call.
26196 @end table
26198 @item -mmemcpy-strategy=@var{strategy}
26199 @opindex mmemcpy-strategy=@var{strategy}
26200 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
26201 should be inlined and what inline algorithm to use when the expected size
26202 of the copy operation is known. @var{strategy} 
26203 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
26204 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
26205 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
26206 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
26207 in the list must be specified in increasing order.  The minimal byte size for 
26208 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
26209 preceding range.
26211 @item -mmemset-strategy=@var{strategy}
26212 @opindex mmemset-strategy=@var{strategy}
26213 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
26214 @code{__builtin_memset} expansion.
26216 @item -momit-leaf-frame-pointer
26217 @opindex momit-leaf-frame-pointer
26218 Don't keep the frame pointer in a register for leaf functions.  This
26219 avoids the instructions to save, set up, and restore frame pointers and
26220 makes an extra register available in leaf functions.  The option
26221 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
26222 which might make debugging harder.
26224 @item -mtls-direct-seg-refs
26225 @itemx -mno-tls-direct-seg-refs
26226 @opindex mtls-direct-seg-refs
26227 Controls whether TLS variables may be accessed with offsets from the
26228 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
26229 or whether the thread base pointer must be added.  Whether or not this
26230 is valid depends on the operating system, and whether it maps the
26231 segment to cover the entire TLS area.
26233 For systems that use the GNU C Library, the default is on.
26235 @item -msse2avx
26236 @itemx -mno-sse2avx
26237 @opindex msse2avx
26238 Specify that the assembler should encode SSE instructions with VEX
26239 prefix.  The option @option{-mavx} turns this on by default.
26241 @item -mfentry
26242 @itemx -mno-fentry
26243 @opindex mfentry
26244 If profiling is active (@option{-pg}), put the profiling
26245 counter call before the prologue.
26246 Note: On x86 architectures the attribute @code{ms_hook_prologue}
26247 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
26249 @item -mrecord-mcount
26250 @itemx -mno-record-mcount
26251 @opindex mrecord-mcount
26252 If profiling is active (@option{-pg}), generate a __mcount_loc section
26253 that contains pointers to each profiling call. This is useful for
26254 automatically patching and out calls.
26256 @item -mnop-mcount
26257 @itemx -mno-nop-mcount
26258 @opindex mnop-mcount
26259 If profiling is active (@option{-pg}), generate the calls to
26260 the profiling functions as NOPs. This is useful when they
26261 should be patched in later dynamically. This is likely only
26262 useful together with @option{-mrecord-mcount}.
26264 @item -mskip-rax-setup
26265 @itemx -mno-skip-rax-setup
26266 @opindex mskip-rax-setup
26267 When generating code for the x86-64 architecture with SSE extensions
26268 disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX
26269 register when there are no variable arguments passed in vector registers.
26271 @strong{Warning:} Since RAX register is used to avoid unnecessarily
26272 saving vector registers on stack when passing variable arguments, the
26273 impacts of this option are callees may waste some stack space,
26274 misbehave or jump to a random location.  GCC 4.4 or newer don't have
26275 those issues, regardless the RAX register value.
26277 @item -m8bit-idiv
26278 @itemx -mno-8bit-idiv
26279 @opindex m8bit-idiv
26280 On some processors, like Intel Atom, 8-bit unsigned integer divide is
26281 much faster than 32-bit/64-bit integer divide.  This option generates a
26282 run-time check.  If both dividend and divisor are within range of 0
26283 to 255, 8-bit unsigned integer divide is used instead of
26284 32-bit/64-bit integer divide.
26286 @item -mavx256-split-unaligned-load
26287 @itemx -mavx256-split-unaligned-store
26288 @opindex mavx256-split-unaligned-load
26289 @opindex mavx256-split-unaligned-store
26290 Split 32-byte AVX unaligned load and store.
26292 @item -mstack-protector-guard=@var{guard}
26293 @itemx -mstack-protector-guard-reg=@var{reg}
26294 @itemx -mstack-protector-guard-offset=@var{offset}
26295 @opindex mstack-protector-guard
26296 @opindex mstack-protector-guard-reg
26297 @opindex mstack-protector-guard-offset
26298 Generate stack protection code using canary at @var{guard}.  Supported
26299 locations are @samp{global} for global canary or @samp{tls} for per-thread
26300 canary in the TLS block (the default).  This option has effect only when
26301 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
26303 With the latter choice the options
26304 @option{-mstack-protector-guard-reg=@var{reg}} and
26305 @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify
26306 which segment register (@code{%fs} or @code{%gs}) to use as base register
26307 for reading the canary, and from what offset from that base register.
26308 The default for those is as specified in the relevant ABI.
26310 @item -mmitigate-rop
26311 @opindex mmitigate-rop
26312 Try to avoid generating code sequences that contain unintended return
26313 opcodes, to mitigate against certain forms of attack. At the moment,
26314 this option is limited in what it can do and should not be relied
26315 on to provide serious protection.
26317 @item -mgeneral-regs-only
26318 @opindex mgeneral-regs-only
26319 Generate code that uses only the general-purpose registers.  This
26320 prevents the compiler from using floating-point, vector, mask and bound
26321 registers.
26323 @end table
26325 These @samp{-m} switches are supported in addition to the above
26326 on x86-64 processors in 64-bit environments.
26328 @table @gcctabopt
26329 @item -m32
26330 @itemx -m64
26331 @itemx -mx32
26332 @itemx -m16
26333 @itemx -miamcu
26334 @opindex m32
26335 @opindex m64
26336 @opindex mx32
26337 @opindex m16
26338 @opindex miamcu
26339 Generate code for a 16-bit, 32-bit or 64-bit environment.
26340 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
26341 to 32 bits, and
26342 generates code that runs on any i386 system.
26344 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
26345 types to 64 bits, and generates code for the x86-64 architecture.
26346 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
26347 and @option{-mdynamic-no-pic} options.
26349 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
26350 to 32 bits, and
26351 generates code for the x86-64 architecture.
26353 The @option{-m16} option is the same as @option{-m32}, except for that
26354 it outputs the @code{.code16gcc} assembly directive at the beginning of
26355 the assembly output so that the binary can run in 16-bit mode.
26357 The @option{-miamcu} option generates code which conforms to Intel MCU
26358 psABI.  It requires the @option{-m32} option to be turned on.
26360 @item -mno-red-zone
26361 @opindex mno-red-zone
26362 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
26363 by the x86-64 ABI; it is a 128-byte area beyond the location of the
26364 stack pointer that is not modified by signal or interrupt handlers
26365 and therefore can be used for temporary data without adjusting the stack
26366 pointer.  The flag @option{-mno-red-zone} disables this red zone.
26368 @item -mcmodel=small
26369 @opindex mcmodel=small
26370 Generate code for the small code model: the program and its symbols must
26371 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
26372 Programs can be statically or dynamically linked.  This is the default
26373 code model.
26375 @item -mcmodel=kernel
26376 @opindex mcmodel=kernel
26377 Generate code for the kernel code model.  The kernel runs in the
26378 negative 2 GB of the address space.
26379 This model has to be used for Linux kernel code.
26381 @item -mcmodel=medium
26382 @opindex mcmodel=medium
26383 Generate code for the medium model: the program is linked in the lower 2
26384 GB of the address space.  Small symbols are also placed there.  Symbols
26385 with sizes larger than @option{-mlarge-data-threshold} are put into
26386 large data or BSS sections and can be located above 2GB.  Programs can
26387 be statically or dynamically linked.
26389 @item -mcmodel=large
26390 @opindex mcmodel=large
26391 Generate code for the large model.  This model makes no assumptions
26392 about addresses and sizes of sections.
26394 @item -maddress-mode=long
26395 @opindex maddress-mode=long
26396 Generate code for long address mode.  This is only supported for 64-bit
26397 and x32 environments.  It is the default address mode for 64-bit
26398 environments.
26400 @item -maddress-mode=short
26401 @opindex maddress-mode=short
26402 Generate code for short address mode.  This is only supported for 32-bit
26403 and x32 environments.  It is the default address mode for 32-bit and
26404 x32 environments.
26405 @end table
26407 @node x86 Windows Options
26408 @subsection x86 Windows Options
26409 @cindex x86 Windows Options
26410 @cindex Windows Options for x86
26412 These additional options are available for Microsoft Windows targets:
26414 @table @gcctabopt
26415 @item -mconsole
26416 @opindex mconsole
26417 This option
26418 specifies that a console application is to be generated, by
26419 instructing the linker to set the PE header subsystem type
26420 required for console applications.
26421 This option is available for Cygwin and MinGW targets and is
26422 enabled by default on those targets.
26424 @item -mdll
26425 @opindex mdll
26426 This option is available for Cygwin and MinGW targets.  It
26427 specifies that a DLL---a dynamic link library---is to be
26428 generated, enabling the selection of the required runtime
26429 startup object and entry point.
26431 @item -mnop-fun-dllimport
26432 @opindex mnop-fun-dllimport
26433 This option is available for Cygwin and MinGW targets.  It
26434 specifies that the @code{dllimport} attribute should be ignored.
26436 @item -mthread
26437 @opindex mthread
26438 This option is available for MinGW targets. It specifies
26439 that MinGW-specific thread support is to be used.
26441 @item -municode
26442 @opindex municode
26443 This option is available for MinGW-w64 targets.  It causes
26444 the @code{UNICODE} preprocessor macro to be predefined, and
26445 chooses Unicode-capable runtime startup code.
26447 @item -mwin32
26448 @opindex mwin32
26449 This option is available for Cygwin and MinGW targets.  It
26450 specifies that the typical Microsoft Windows predefined macros are to
26451 be set in the pre-processor, but does not influence the choice
26452 of runtime library/startup code.
26454 @item -mwindows
26455 @opindex mwindows
26456 This option is available for Cygwin and MinGW targets.  It
26457 specifies that a GUI application is to be generated by
26458 instructing the linker to set the PE header subsystem type
26459 appropriately.
26461 @item -fno-set-stack-executable
26462 @opindex fno-set-stack-executable
26463 This option is available for MinGW targets. It specifies that
26464 the executable flag for the stack used by nested functions isn't
26465 set. This is necessary for binaries running in kernel mode of
26466 Microsoft Windows, as there the User32 API, which is used to set executable
26467 privileges, isn't available.
26469 @item -fwritable-relocated-rdata
26470 @opindex fno-writable-relocated-rdata
26471 This option is available for MinGW and Cygwin targets.  It specifies
26472 that relocated-data in read-only section is put into the @code{.data}
26473 section.  This is a necessary for older runtimes not supporting
26474 modification of @code{.rdata} sections for pseudo-relocation.
26476 @item -mpe-aligned-commons
26477 @opindex mpe-aligned-commons
26478 This option is available for Cygwin and MinGW targets.  It
26479 specifies that the GNU extension to the PE file format that
26480 permits the correct alignment of COMMON variables should be
26481 used when generating code.  It is enabled by default if
26482 GCC detects that the target assembler found during configuration
26483 supports the feature.
26484 @end table
26486 See also under @ref{x86 Options} for standard options.
26488 @node Xstormy16 Options
26489 @subsection Xstormy16 Options
26490 @cindex Xstormy16 Options
26492 These options are defined for Xstormy16:
26494 @table @gcctabopt
26495 @item -msim
26496 @opindex msim
26497 Choose startup files and linker script suitable for the simulator.
26498 @end table
26500 @node Xtensa Options
26501 @subsection Xtensa Options
26502 @cindex Xtensa Options
26504 These options are supported for Xtensa targets:
26506 @table @gcctabopt
26507 @item -mconst16
26508 @itemx -mno-const16
26509 @opindex mconst16
26510 @opindex mno-const16
26511 Enable or disable use of @code{CONST16} instructions for loading
26512 constant values.  The @code{CONST16} instruction is currently not a
26513 standard option from Tensilica.  When enabled, @code{CONST16}
26514 instructions are always used in place of the standard @code{L32R}
26515 instructions.  The use of @code{CONST16} is enabled by default only if
26516 the @code{L32R} instruction is not available.
26518 @item -mfused-madd
26519 @itemx -mno-fused-madd
26520 @opindex mfused-madd
26521 @opindex mno-fused-madd
26522 Enable or disable use of fused multiply/add and multiply/subtract
26523 instructions in the floating-point option.  This has no effect if the
26524 floating-point option is not also enabled.  Disabling fused multiply/add
26525 and multiply/subtract instructions forces the compiler to use separate
26526 instructions for the multiply and add/subtract operations.  This may be
26527 desirable in some cases where strict IEEE 754-compliant results are
26528 required: the fused multiply add/subtract instructions do not round the
26529 intermediate result, thereby producing results with @emph{more} bits of
26530 precision than specified by the IEEE standard.  Disabling fused multiply
26531 add/subtract instructions also ensures that the program output is not
26532 sensitive to the compiler's ability to combine multiply and add/subtract
26533 operations.
26535 @item -mserialize-volatile
26536 @itemx -mno-serialize-volatile
26537 @opindex mserialize-volatile
26538 @opindex mno-serialize-volatile
26539 When this option is enabled, GCC inserts @code{MEMW} instructions before
26540 @code{volatile} memory references to guarantee sequential consistency.
26541 The default is @option{-mserialize-volatile}.  Use
26542 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
26544 @item -mforce-no-pic
26545 @opindex mforce-no-pic
26546 For targets, like GNU/Linux, where all user-mode Xtensa code must be
26547 position-independent code (PIC), this option disables PIC for compiling
26548 kernel code.
26550 @item -mtext-section-literals
26551 @itemx -mno-text-section-literals
26552 @opindex mtext-section-literals
26553 @opindex mno-text-section-literals
26554 These options control the treatment of literal pools.  The default is
26555 @option{-mno-text-section-literals}, which places literals in a separate
26556 section in the output file.  This allows the literal pool to be placed
26557 in a data RAM/ROM, and it also allows the linker to combine literal
26558 pools from separate object files to remove redundant literals and
26559 improve code size.  With @option{-mtext-section-literals}, the literals
26560 are interspersed in the text section in order to keep them as close as
26561 possible to their references.  This may be necessary for large assembly
26562 files.  Literals for each function are placed right before that function.
26564 @item -mauto-litpools
26565 @itemx -mno-auto-litpools
26566 @opindex mauto-litpools
26567 @opindex mno-auto-litpools
26568 These options control the treatment of literal pools.  The default is
26569 @option{-mno-auto-litpools}, which places literals in a separate
26570 section in the output file unless @option{-mtext-section-literals} is
26571 used.  With @option{-mauto-litpools} the literals are interspersed in
26572 the text section by the assembler.  Compiler does not produce explicit
26573 @code{.literal} directives and loads literals into registers with
26574 @code{MOVI} instructions instead of @code{L32R} to let the assembler
26575 do relaxation and place literals as necessary.  This option allows
26576 assembler to create several literal pools per function and assemble
26577 very big functions, which may not be possible with
26578 @option{-mtext-section-literals}.
26580 @item -mtarget-align
26581 @itemx -mno-target-align
26582 @opindex mtarget-align
26583 @opindex mno-target-align
26584 When this option is enabled, GCC instructs the assembler to
26585 automatically align instructions to reduce branch penalties at the
26586 expense of some code density.  The assembler attempts to widen density
26587 instructions to align branch targets and the instructions following call
26588 instructions.  If there are not enough preceding safe density
26589 instructions to align a target, no widening is performed.  The
26590 default is @option{-mtarget-align}.  These options do not affect the
26591 treatment of auto-aligned instructions like @code{LOOP}, which the
26592 assembler always aligns, either by widening density instructions or
26593 by inserting NOP instructions.
26595 @item -mlongcalls
26596 @itemx -mno-longcalls
26597 @opindex mlongcalls
26598 @opindex mno-longcalls
26599 When this option is enabled, GCC instructs the assembler to translate
26600 direct calls to indirect calls unless it can determine that the target
26601 of a direct call is in the range allowed by the call instruction.  This
26602 translation typically occurs for calls to functions in other source
26603 files.  Specifically, the assembler translates a direct @code{CALL}
26604 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
26605 The default is @option{-mno-longcalls}.  This option should be used in
26606 programs where the call target can potentially be out of range.  This
26607 option is implemented in the assembler, not the compiler, so the
26608 assembly code generated by GCC still shows direct call
26609 instructions---look at the disassembled object code to see the actual
26610 instructions.  Note that the assembler uses an indirect call for
26611 every cross-file call, not just those that really are out of range.
26612 @end table
26614 @node zSeries Options
26615 @subsection zSeries Options
26616 @cindex zSeries options
26618 These are listed under @xref{S/390 and zSeries Options}.
26621 @c man end
26623 @node Spec Files
26624 @section Specifying Subprocesses and the Switches to Pass to Them
26625 @cindex Spec Files
26627 @command{gcc} is a driver program.  It performs its job by invoking a
26628 sequence of other programs to do the work of compiling, assembling and
26629 linking.  GCC interprets its command-line parameters and uses these to
26630 deduce which programs it should invoke, and which command-line options
26631 it ought to place on their command lines.  This behavior is controlled
26632 by @dfn{spec strings}.  In most cases there is one spec string for each
26633 program that GCC can invoke, but a few programs have multiple spec
26634 strings to control their behavior.  The spec strings built into GCC can
26635 be overridden by using the @option{-specs=} command-line switch to specify
26636 a spec file.
26638 @dfn{Spec files} are plain-text files that are used to construct spec
26639 strings.  They consist of a sequence of directives separated by blank
26640 lines.  The type of directive is determined by the first non-whitespace
26641 character on the line, which can be one of the following:
26643 @table @code
26644 @item %@var{command}
26645 Issues a @var{command} to the spec file processor.  The commands that can
26646 appear here are:
26648 @table @code
26649 @item %include <@var{file}>
26650 @cindex @code{%include}
26651 Search for @var{file} and insert its text at the current point in the
26652 specs file.
26654 @item %include_noerr <@var{file}>
26655 @cindex @code{%include_noerr}
26656 Just like @samp{%include}, but do not generate an error message if the include
26657 file cannot be found.
26659 @item %rename @var{old_name} @var{new_name}
26660 @cindex @code{%rename}
26661 Rename the spec string @var{old_name} to @var{new_name}.
26663 @end table
26665 @item *[@var{spec_name}]:
26666 This tells the compiler to create, override or delete the named spec
26667 string.  All lines after this directive up to the next directive or
26668 blank line are considered to be the text for the spec string.  If this
26669 results in an empty string then the spec is deleted.  (Or, if the
26670 spec did not exist, then nothing happens.)  Otherwise, if the spec
26671 does not currently exist a new spec is created.  If the spec does
26672 exist then its contents are overridden by the text of this
26673 directive, unless the first character of that text is the @samp{+}
26674 character, in which case the text is appended to the spec.
26676 @item [@var{suffix}]:
26677 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
26678 and up to the next directive or blank line are considered to make up the
26679 spec string for the indicated suffix.  When the compiler encounters an
26680 input file with the named suffix, it processes the spec string in
26681 order to work out how to compile that file.  For example:
26683 @smallexample
26684 .ZZ:
26685 z-compile -input %i
26686 @end smallexample
26688 This says that any input file whose name ends in @samp{.ZZ} should be
26689 passed to the program @samp{z-compile}, which should be invoked with the
26690 command-line switch @option{-input} and with the result of performing the
26691 @samp{%i} substitution.  (See below.)
26693 As an alternative to providing a spec string, the text following a
26694 suffix directive can be one of the following:
26696 @table @code
26697 @item @@@var{language}
26698 This says that the suffix is an alias for a known @var{language}.  This is
26699 similar to using the @option{-x} command-line switch to GCC to specify a
26700 language explicitly.  For example:
26702 @smallexample
26703 .ZZ:
26704 @@c++
26705 @end smallexample
26707 Says that .ZZ files are, in fact, C++ source files.
26709 @item #@var{name}
26710 This causes an error messages saying:
26712 @smallexample
26713 @var{name} compiler not installed on this system.
26714 @end smallexample
26715 @end table
26717 GCC already has an extensive list of suffixes built into it.
26718 This directive adds an entry to the end of the list of suffixes, but
26719 since the list is searched from the end backwards, it is effectively
26720 possible to override earlier entries using this technique.
26722 @end table
26724 GCC has the following spec strings built into it.  Spec files can
26725 override these strings or create their own.  Note that individual
26726 targets can also add their own spec strings to this list.
26728 @smallexample
26729 asm          Options to pass to the assembler
26730 asm_final    Options to pass to the assembler post-processor
26731 cpp          Options to pass to the C preprocessor
26732 cc1          Options to pass to the C compiler
26733 cc1plus      Options to pass to the C++ compiler
26734 endfile      Object files to include at the end of the link
26735 link         Options to pass to the linker
26736 lib          Libraries to include on the command line to the linker
26737 libgcc       Decides which GCC support library to pass to the linker
26738 linker       Sets the name of the linker
26739 predefines   Defines to be passed to the C preprocessor
26740 signed_char  Defines to pass to CPP to say whether @code{char} is signed
26741              by default
26742 startfile    Object files to include at the start of the link
26743 @end smallexample
26745 Here is a small example of a spec file:
26747 @smallexample
26748 %rename lib                 old_lib
26750 *lib:
26751 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
26752 @end smallexample
26754 This example renames the spec called @samp{lib} to @samp{old_lib} and
26755 then overrides the previous definition of @samp{lib} with a new one.
26756 The new definition adds in some extra command-line options before
26757 including the text of the old definition.
26759 @dfn{Spec strings} are a list of command-line options to be passed to their
26760 corresponding program.  In addition, the spec strings can contain
26761 @samp{%}-prefixed sequences to substitute variable text or to
26762 conditionally insert text into the command line.  Using these constructs
26763 it is possible to generate quite complex command lines.
26765 Here is a table of all defined @samp{%}-sequences for spec
26766 strings.  Note that spaces are not generated automatically around the
26767 results of expanding these sequences.  Therefore you can concatenate them
26768 together or combine them with constant text in a single argument.
26770 @table @code
26771 @item %%
26772 Substitute one @samp{%} into the program name or argument.
26774 @item %i
26775 Substitute the name of the input file being processed.
26777 @item %b
26778 Substitute the basename of the input file being processed.
26779 This is the substring up to (and not including) the last period
26780 and not including the directory.
26782 @item %B
26783 This is the same as @samp{%b}, but include the file suffix (text after
26784 the last period).
26786 @item %d
26787 Marks the argument containing or following the @samp{%d} as a
26788 temporary file name, so that that file is deleted if GCC exits
26789 successfully.  Unlike @samp{%g}, this contributes no text to the
26790 argument.
26792 @item %g@var{suffix}
26793 Substitute a file name that has suffix @var{suffix} and is chosen
26794 once per compilation, and mark the argument in the same way as
26795 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
26796 name is now chosen in a way that is hard to predict even when previously
26797 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
26798 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
26799 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
26800 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
26801 was simply substituted with a file name chosen once per compilation,
26802 without regard to any appended suffix (which was therefore treated
26803 just like ordinary text), making such attacks more likely to succeed.
26805 @item %u@var{suffix}
26806 Like @samp{%g}, but generates a new temporary file name
26807 each time it appears instead of once per compilation.
26809 @item %U@var{suffix}
26810 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
26811 new one if there is no such last file name.  In the absence of any
26812 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
26813 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
26814 involves the generation of two distinct file names, one
26815 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
26816 simply substituted with a file name chosen for the previous @samp{%u},
26817 without regard to any appended suffix.
26819 @item %j@var{suffix}
26820 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
26821 writable, and if @option{-save-temps} is not used; 
26822 otherwise, substitute the name
26823 of a temporary file, just like @samp{%u}.  This temporary file is not
26824 meant for communication between processes, but rather as a junk
26825 disposal mechanism.
26827 @item %|@var{suffix}
26828 @itemx %m@var{suffix}
26829 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
26830 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
26831 all.  These are the two most common ways to instruct a program that it
26832 should read from standard input or write to standard output.  If you
26833 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
26834 construct: see for example @file{f/lang-specs.h}.
26836 @item %.@var{SUFFIX}
26837 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
26838 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
26839 terminated by the next space or %.
26841 @item %w
26842 Marks the argument containing or following the @samp{%w} as the
26843 designated output file of this compilation.  This puts the argument
26844 into the sequence of arguments that @samp{%o} substitutes.
26846 @item %o
26847 Substitutes the names of all the output files, with spaces
26848 automatically placed around them.  You should write spaces
26849 around the @samp{%o} as well or the results are undefined.
26850 @samp{%o} is for use in the specs for running the linker.
26851 Input files whose names have no recognized suffix are not compiled
26852 at all, but they are included among the output files, so they are
26853 linked.
26855 @item %O
26856 Substitutes the suffix for object files.  Note that this is
26857 handled specially when it immediately follows @samp{%g, %u, or %U},
26858 because of the need for those to form complete file names.  The
26859 handling is such that @samp{%O} is treated exactly as if it had already
26860 been substituted, except that @samp{%g, %u, and %U} do not currently
26861 support additional @var{suffix} characters following @samp{%O} as they do
26862 following, for example, @samp{.o}.
26864 @item %p
26865 Substitutes the standard macro predefinitions for the
26866 current target machine.  Use this when running @command{cpp}.
26868 @item %P
26869 Like @samp{%p}, but puts @samp{__} before and after the name of each
26870 predefined macro, except for macros that start with @samp{__} or with
26871 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
26874 @item %I
26875 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
26876 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
26877 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
26878 and @option{-imultilib} as necessary.
26880 @item %s
26881 Current argument is the name of a library or startup file of some sort.
26882 Search for that file in a standard list of directories and substitute
26883 the full name found.  The current working directory is included in the
26884 list of directories scanned.
26886 @item %T
26887 Current argument is the name of a linker script.  Search for that file
26888 in the current list of directories to scan for libraries. If the file
26889 is located insert a @option{--script} option into the command line
26890 followed by the full path name found.  If the file is not found then
26891 generate an error message.  Note: the current working directory is not
26892 searched.
26894 @item %e@var{str}
26895 Print @var{str} as an error message.  @var{str} is terminated by a newline.
26896 Use this when inconsistent options are detected.
26898 @item %(@var{name})
26899 Substitute the contents of spec string @var{name} at this point.
26901 @item %x@{@var{option}@}
26902 Accumulate an option for @samp{%X}.
26904 @item %X
26905 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
26906 spec string.
26908 @item %Y
26909 Output the accumulated assembler options specified by @option{-Wa}.
26911 @item %Z
26912 Output the accumulated preprocessor options specified by @option{-Wp}.
26914 @item %a
26915 Process the @code{asm} spec.  This is used to compute the
26916 switches to be passed to the assembler.
26918 @item %A
26919 Process the @code{asm_final} spec.  This is a spec string for
26920 passing switches to an assembler post-processor, if such a program is
26921 needed.
26923 @item %l
26924 Process the @code{link} spec.  This is the spec for computing the
26925 command line passed to the linker.  Typically it makes use of the
26926 @samp{%L %G %S %D and %E} sequences.
26928 @item %D
26929 Dump out a @option{-L} option for each directory that GCC believes might
26930 contain startup files.  If the target supports multilibs then the
26931 current multilib directory is prepended to each of these paths.
26933 @item %L
26934 Process the @code{lib} spec.  This is a spec string for deciding which
26935 libraries are included on the command line to the linker.
26937 @item %G
26938 Process the @code{libgcc} spec.  This is a spec string for deciding
26939 which GCC support library is included on the command line to the linker.
26941 @item %S
26942 Process the @code{startfile} spec.  This is a spec for deciding which
26943 object files are the first ones passed to the linker.  Typically
26944 this might be a file named @file{crt0.o}.
26946 @item %E
26947 Process the @code{endfile} spec.  This is a spec string that specifies
26948 the last object files that are passed to the linker.
26950 @item %C
26951 Process the @code{cpp} spec.  This is used to construct the arguments
26952 to be passed to the C preprocessor.
26954 @item %1
26955 Process the @code{cc1} spec.  This is used to construct the options to be
26956 passed to the actual C compiler (@command{cc1}).
26958 @item %2
26959 Process the @code{cc1plus} spec.  This is used to construct the options to be
26960 passed to the actual C++ compiler (@command{cc1plus}).
26962 @item %*
26963 Substitute the variable part of a matched option.  See below.
26964 Note that each comma in the substituted string is replaced by
26965 a single space.
26967 @item %<S
26968 Remove all occurrences of @code{-S} from the command line.  Note---this
26969 command is position dependent.  @samp{%} commands in the spec string
26970 before this one see @code{-S}, @samp{%} commands in the spec string
26971 after this one do not.
26973 @item %:@var{function}(@var{args})
26974 Call the named function @var{function}, passing it @var{args}.
26975 @var{args} is first processed as a nested spec string, then split
26976 into an argument vector in the usual fashion.  The function returns
26977 a string which is processed as if it had appeared literally as part
26978 of the current spec.
26980 The following built-in spec functions are provided:
26982 @table @code
26983 @item @code{getenv}
26984 The @code{getenv} spec function takes two arguments: an environment
26985 variable name and a string.  If the environment variable is not
26986 defined, a fatal error is issued.  Otherwise, the return value is the
26987 value of the environment variable concatenated with the string.  For
26988 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
26990 @smallexample
26991 %:getenv(TOPDIR /include)
26992 @end smallexample
26994 expands to @file{/path/to/top/include}.
26996 @item @code{if-exists}
26997 The @code{if-exists} spec function takes one argument, an absolute
26998 pathname to a file.  If the file exists, @code{if-exists} returns the
26999 pathname.  Here is a small example of its usage:
27001 @smallexample
27002 *startfile:
27003 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
27004 @end smallexample
27006 @item @code{if-exists-else}
27007 The @code{if-exists-else} spec function is similar to the @code{if-exists}
27008 spec function, except that it takes two arguments.  The first argument is
27009 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
27010 returns the pathname.  If it does not exist, it returns the second argument.
27011 This way, @code{if-exists-else} can be used to select one file or another,
27012 based on the existence of the first.  Here is a small example of its usage:
27014 @smallexample
27015 *startfile:
27016 crt0%O%s %:if-exists(crti%O%s) \
27017 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
27018 @end smallexample
27020 @item @code{replace-outfile}
27021 The @code{replace-outfile} spec function takes two arguments.  It looks for the
27022 first argument in the outfiles array and replaces it with the second argument.  Here
27023 is a small example of its usage:
27025 @smallexample
27026 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
27027 @end smallexample
27029 @item @code{remove-outfile}
27030 The @code{remove-outfile} spec function takes one argument.  It looks for the
27031 first argument in the outfiles array and removes it.  Here is a small example
27032 its usage:
27034 @smallexample
27035 %:remove-outfile(-lm)
27036 @end smallexample
27038 @item @code{pass-through-libs}
27039 The @code{pass-through-libs} spec function takes any number of arguments.  It
27040 finds any @option{-l} options and any non-options ending in @file{.a} (which it
27041 assumes are the names of linker input library archive files) and returns a
27042 result containing all the found arguments each prepended by
27043 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
27044 intended to be passed to the LTO linker plugin.
27046 @smallexample
27047 %:pass-through-libs(%G %L %G)
27048 @end smallexample
27050 @item @code{print-asm-header}
27051 The @code{print-asm-header} function takes no arguments and simply
27052 prints a banner like:
27054 @smallexample
27055 Assembler options
27056 =================
27058 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
27059 @end smallexample
27061 It is used to separate compiler options from assembler options
27062 in the @option{--target-help} output.
27063 @end table
27065 @item %@{S@}
27066 Substitutes the @code{-S} switch, if that switch is given to GCC@.
27067 If that switch is not specified, this substitutes nothing.  Note that
27068 the leading dash is omitted when specifying this option, and it is
27069 automatically inserted if the substitution is performed.  Thus the spec
27070 string @samp{%@{foo@}} matches the command-line option @option{-foo}
27071 and outputs the command-line option @option{-foo}.
27073 @item %W@{S@}
27074 Like %@{@code{S}@} but mark last argument supplied within as a file to be
27075 deleted on failure.
27077 @item %@{S*@}
27078 Substitutes all the switches specified to GCC whose names start
27079 with @code{-S}, but which also take an argument.  This is used for
27080 switches like @option{-o}, @option{-D}, @option{-I}, etc.
27081 GCC considers @option{-o foo} as being
27082 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
27083 text, including the space.  Thus two arguments are generated.
27085 @item %@{S*&T*@}
27086 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
27087 (the order of @code{S} and @code{T} in the spec is not significant).
27088 There can be any number of ampersand-separated variables; for each the
27089 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
27091 @item %@{S:X@}
27092 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
27094 @item %@{!S:X@}
27095 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
27097 @item %@{S*:X@}
27098 Substitutes @code{X} if one or more switches whose names start with
27099 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
27100 once, no matter how many such switches appeared.  However, if @code{%*}
27101 appears somewhere in @code{X}, then @code{X} is substituted once
27102 for each matching switch, with the @code{%*} replaced by the part of
27103 that switch matching the @code{*}.
27105 If @code{%*} appears as the last part of a spec sequence then a space
27106 is added after the end of the last substitution.  If there is more
27107 text in the sequence, however, then a space is not generated.  This
27108 allows the @code{%*} substitution to be used as part of a larger
27109 string.  For example, a spec string like this:
27111 @smallexample
27112 %@{mcu=*:--script=%*/memory.ld@}
27113 @end smallexample
27115 @noindent
27116 when matching an option like @option{-mcu=newchip} produces:
27118 @smallexample
27119 --script=newchip/memory.ld
27120 @end smallexample
27122 @item %@{.S:X@}
27123 Substitutes @code{X}, if processing a file with suffix @code{S}.
27125 @item %@{!.S:X@}
27126 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
27128 @item %@{,S:X@}
27129 Substitutes @code{X}, if processing a file for language @code{S}.
27131 @item %@{!,S:X@}
27132 Substitutes @code{X}, if not processing a file for language @code{S}.
27134 @item %@{S|P:X@}
27135 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
27136 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
27137 @code{*} sequences as well, although they have a stronger binding than
27138 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
27139 alternatives must be starred, and only the first matching alternative
27140 is substituted.
27142 For example, a spec string like this:
27144 @smallexample
27145 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
27146 @end smallexample
27148 @noindent
27149 outputs the following command-line options from the following input
27150 command-line options:
27152 @smallexample
27153 fred.c        -foo -baz
27154 jim.d         -bar -boggle
27155 -d fred.c     -foo -baz -boggle
27156 -d jim.d      -bar -baz -boggle
27157 @end smallexample
27159 @item %@{S:X; T:Y; :D@}
27161 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
27162 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
27163 be as many clauses as you need.  This may be combined with @code{.},
27164 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
27167 @end table
27169 The switch matching text @code{S} in a @samp{%@{S@}}, @samp{%@{S:X@}}
27170 or similar construct can use a backslash to ignore the special meaning
27171 of the character following it, thus allowing literal matching of a
27172 character that is otherwise specially treated.  For example,
27173 @samp{%@{std=iso9899\:1999:X@}} substitutes @code{X} if the
27174 @option{-std=iso9899:1999} option is given.
27176 The conditional text @code{X} in a @samp{%@{S:X@}} or similar
27177 construct may contain other nested @samp{%} constructs or spaces, or
27178 even newlines.  They are processed as usual, as described above.
27179 Trailing white space in @code{X} is ignored.  White space may also
27180 appear anywhere on the left side of the colon in these constructs,
27181 except between @code{.} or @code{*} and the corresponding word.
27183 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
27184 handled specifically in these constructs.  If another value of
27185 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
27186 @option{-W} switch is found later in the command line, the earlier
27187 switch value is ignored, except with @{@code{S}*@} where @code{S} is
27188 just one letter, which passes all matching options.
27190 The character @samp{|} at the beginning of the predicate text is used to
27191 indicate that a command should be piped to the following command, but
27192 only if @option{-pipe} is specified.
27194 It is built into GCC which switches take arguments and which do not.
27195 (You might think it would be useful to generalize this to allow each
27196 compiler's spec to say which switches take arguments.  But this cannot
27197 be done in a consistent fashion.  GCC cannot even decide which input
27198 files have been specified without knowing which switches take arguments,
27199 and it must know which input files to compile in order to tell which
27200 compilers to run).
27202 GCC also knows implicitly that arguments starting in @option{-l} are to be
27203 treated as compiler output files, and passed to the linker in their
27204 proper position among the other output files.
27206 @node Environment Variables
27207 @section Environment Variables Affecting GCC
27208 @cindex environment variables
27210 @c man begin ENVIRONMENT
27211 This section describes several environment variables that affect how GCC
27212 operates.  Some of them work by specifying directories or prefixes to use
27213 when searching for various kinds of files.  Some are used to specify other
27214 aspects of the compilation environment.
27216 Note that you can also specify places to search using options such as
27217 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
27218 take precedence over places specified using environment variables, which
27219 in turn take precedence over those specified by the configuration of GCC@.
27220 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
27221 GNU Compiler Collection (GCC) Internals}.
27223 @table @env
27224 @item LANG
27225 @itemx LC_CTYPE
27226 @c @itemx LC_COLLATE
27227 @itemx LC_MESSAGES
27228 @c @itemx LC_MONETARY
27229 @c @itemx LC_NUMERIC
27230 @c @itemx LC_TIME
27231 @itemx LC_ALL
27232 @findex LANG
27233 @findex LC_CTYPE
27234 @c @findex LC_COLLATE
27235 @findex LC_MESSAGES
27236 @c @findex LC_MONETARY
27237 @c @findex LC_NUMERIC
27238 @c @findex LC_TIME
27239 @findex LC_ALL
27240 @cindex locale
27241 These environment variables control the way that GCC uses
27242 localization information which allows GCC to work with different
27243 national conventions.  GCC inspects the locale categories
27244 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
27245 so.  These locale categories can be set to any value supported by your
27246 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
27247 Kingdom encoded in UTF-8.
27249 The @env{LC_CTYPE} environment variable specifies character
27250 classification.  GCC uses it to determine the character boundaries in
27251 a string; this is needed for some multibyte encodings that contain quote
27252 and escape characters that are otherwise interpreted as a string
27253 end or escape.
27255 The @env{LC_MESSAGES} environment variable specifies the language to
27256 use in diagnostic messages.
27258 If the @env{LC_ALL} environment variable is set, it overrides the value
27259 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
27260 and @env{LC_MESSAGES} default to the value of the @env{LANG}
27261 environment variable.  If none of these variables are set, GCC
27262 defaults to traditional C English behavior.
27264 @item TMPDIR
27265 @findex TMPDIR
27266 If @env{TMPDIR} is set, it specifies the directory to use for temporary
27267 files.  GCC uses temporary files to hold the output of one stage of
27268 compilation which is to be used as input to the next stage: for example,
27269 the output of the preprocessor, which is the input to the compiler
27270 proper.
27272 @item GCC_COMPARE_DEBUG
27273 @findex GCC_COMPARE_DEBUG
27274 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
27275 @option{-fcompare-debug} to the compiler driver.  See the documentation
27276 of this option for more details.
27278 @item GCC_EXEC_PREFIX
27279 @findex GCC_EXEC_PREFIX
27280 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
27281 names of the subprograms executed by the compiler.  No slash is added
27282 when this prefix is combined with the name of a subprogram, but you can
27283 specify a prefix that ends with a slash if you wish.
27285 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
27286 an appropriate prefix to use based on the pathname it is invoked with.
27288 If GCC cannot find the subprogram using the specified prefix, it
27289 tries looking in the usual places for the subprogram.
27291 The default value of @env{GCC_EXEC_PREFIX} is
27292 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
27293 the installed compiler. In many cases @var{prefix} is the value
27294 of @code{prefix} when you ran the @file{configure} script.
27296 Other prefixes specified with @option{-B} take precedence over this prefix.
27298 This prefix is also used for finding files such as @file{crt0.o} that are
27299 used for linking.
27301 In addition, the prefix is used in an unusual way in finding the
27302 directories to search for header files.  For each of the standard
27303 directories whose name normally begins with @samp{/usr/local/lib/gcc}
27304 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
27305 replacing that beginning with the specified prefix to produce an
27306 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
27307 @file{foo/bar} just before it searches the standard directory 
27308 @file{/usr/local/lib/bar}.
27309 If a standard directory begins with the configured
27310 @var{prefix} then the value of @var{prefix} is replaced by
27311 @env{GCC_EXEC_PREFIX} when looking for header files.
27313 @item COMPILER_PATH
27314 @findex COMPILER_PATH
27315 The value of @env{COMPILER_PATH} is a colon-separated list of
27316 directories, much like @env{PATH}.  GCC tries the directories thus
27317 specified when searching for subprograms, if it cannot find the
27318 subprograms using @env{GCC_EXEC_PREFIX}.
27320 @item LIBRARY_PATH
27321 @findex LIBRARY_PATH
27322 The value of @env{LIBRARY_PATH} is a colon-separated list of
27323 directories, much like @env{PATH}.  When configured as a native compiler,
27324 GCC tries the directories thus specified when searching for special
27325 linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}.  Linking
27326 using GCC also uses these directories when searching for ordinary
27327 libraries for the @option{-l} option (but directories specified with
27328 @option{-L} come first).
27330 @item LANG
27331 @findex LANG
27332 @cindex locale definition
27333 This variable is used to pass locale information to the compiler.  One way in
27334 which this information is used is to determine the character set to be used
27335 when character literals, string literals and comments are parsed in C and C++.
27336 When the compiler is configured to allow multibyte characters,
27337 the following values for @env{LANG} are recognized:
27339 @table @samp
27340 @item C-JIS
27341 Recognize JIS characters.
27342 @item C-SJIS
27343 Recognize SJIS characters.
27344 @item C-EUCJP
27345 Recognize EUCJP characters.
27346 @end table
27348 If @env{LANG} is not defined, or if it has some other value, then the
27349 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
27350 recognize and translate multibyte characters.
27351 @end table
27353 @noindent
27354 Some additional environment variables affect the behavior of the
27355 preprocessor.
27357 @include cppenv.texi
27359 @c man end
27361 @node Precompiled Headers
27362 @section Using Precompiled Headers
27363 @cindex precompiled headers
27364 @cindex speed of compilation
27366 Often large projects have many header files that are included in every
27367 source file.  The time the compiler takes to process these header files
27368 over and over again can account for nearly all of the time required to
27369 build the project.  To make builds faster, GCC allows you to
27370 @dfn{precompile} a header file.
27372 To create a precompiled header file, simply compile it as you would any
27373 other file, if necessary using the @option{-x} option to make the driver
27374 treat it as a C or C++ header file.  You may want to use a
27375 tool like @command{make} to keep the precompiled header up-to-date when
27376 the headers it contains change.
27378 A precompiled header file is searched for when @code{#include} is
27379 seen in the compilation.  As it searches for the included file
27380 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
27381 compiler looks for a precompiled header in each directory just before it
27382 looks for the include file in that directory.  The name searched for is
27383 the name specified in the @code{#include} with @samp{.gch} appended.  If
27384 the precompiled header file cannot be used, it is ignored.
27386 For instance, if you have @code{#include "all.h"}, and you have
27387 @file{all.h.gch} in the same directory as @file{all.h}, then the
27388 precompiled header file is used if possible, and the original
27389 header is used otherwise.
27391 Alternatively, you might decide to put the precompiled header file in a
27392 directory and use @option{-I} to ensure that directory is searched
27393 before (or instead of) the directory containing the original header.
27394 Then, if you want to check that the precompiled header file is always
27395 used, you can put a file of the same name as the original header in this
27396 directory containing an @code{#error} command.
27398 This also works with @option{-include}.  So yet another way to use
27399 precompiled headers, good for projects not designed with precompiled
27400 header files in mind, is to simply take most of the header files used by
27401 a project, include them from another header file, precompile that header
27402 file, and @option{-include} the precompiled header.  If the header files
27403 have guards against multiple inclusion, they are skipped because
27404 they've already been included (in the precompiled header).
27406 If you need to precompile the same header file for different
27407 languages, targets, or compiler options, you can instead make a
27408 @emph{directory} named like @file{all.h.gch}, and put each precompiled
27409 header in the directory, perhaps using @option{-o}.  It doesn't matter
27410 what you call the files in the directory; every precompiled header in
27411 the directory is considered.  The first precompiled header
27412 encountered in the directory that is valid for this compilation is
27413 used; they're searched in no particular order.
27415 There are many other possibilities, limited only by your imagination,
27416 good sense, and the constraints of your build system.
27418 A precompiled header file can be used only when these conditions apply:
27420 @itemize
27421 @item
27422 Only one precompiled header can be used in a particular compilation.
27424 @item
27425 A precompiled header cannot be used once the first C token is seen.  You
27426 can have preprocessor directives before a precompiled header; you cannot
27427 include a precompiled header from inside another header.
27429 @item
27430 The precompiled header file must be produced for the same language as
27431 the current compilation.  You cannot use a C precompiled header for a C++
27432 compilation.
27434 @item
27435 The precompiled header file must have been produced by the same compiler
27436 binary as the current compilation is using.
27438 @item
27439 Any macros defined before the precompiled header is included must
27440 either be defined in the same way as when the precompiled header was
27441 generated, or must not affect the precompiled header, which usually
27442 means that they don't appear in the precompiled header at all.
27444 The @option{-D} option is one way to define a macro before a
27445 precompiled header is included; using a @code{#define} can also do it.
27446 There are also some options that define macros implicitly, like
27447 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
27448 defined this way.
27450 @item If debugging information is output when using the precompiled
27451 header, using @option{-g} or similar, the same kind of debugging information
27452 must have been output when building the precompiled header.  However,
27453 a precompiled header built using @option{-g} can be used in a compilation
27454 when no debugging information is being output.
27456 @item The same @option{-m} options must generally be used when building
27457 and using the precompiled header.  @xref{Submodel Options},
27458 for any cases where this rule is relaxed.
27460 @item Each of the following options must be the same when building and using
27461 the precompiled header:
27463 @gccoptlist{-fexceptions}
27465 @item
27466 Some other command-line options starting with @option{-f},
27467 @option{-p}, or @option{-O} must be defined in the same way as when
27468 the precompiled header was generated.  At present, it's not clear
27469 which options are safe to change and which are not; the safest choice
27470 is to use exactly the same options when generating and using the
27471 precompiled header.  The following are known to be safe:
27473 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
27474 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
27475 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
27476 -pedantic-errors}
27478 @end itemize
27480 For all of these except the last, the compiler automatically
27481 ignores the precompiled header if the conditions aren't met.  If you
27482 find an option combination that doesn't work and doesn't cause the
27483 precompiled header to be ignored, please consider filing a bug report,
27484 see @ref{Bugs}.
27486 If you do use differing options when generating and using the
27487 precompiled header, the actual behavior is a mixture of the
27488 behavior for the options.  For instance, if you use @option{-g} to
27489 generate the precompiled header but not when using it, you may or may
27490 not get debugging information for routines in the precompiled header.